Commit graph

4 commits

Author SHA1 Message Date
Ben Browning
c4c67ac775 chore: cleanups from review feedback on openai api docs
This moves the Models section to the top of the supported APIs, along
with a brief explanation so that it's not just a bare section with
just a small code sample.

This also adjusts the MyST directives to use code fences instead of
markdown directives, as that allows word wrapping to work as normal
instead of it rendering as a single long line in the GitHub UI and
such. The actual rendered HTML content is identical, but this makes it
a bit easier to review.

And, the warning from the Responses API structured output section is
removed because we've now merged support for that.

Signed-off-by: Ben Browning <bbrownin@redhat.com>
2025-06-03 20:46:31 -04:00
Ben Browning
390ace8748
Apply suggestions from code review
Small updates to grammar and formatting.

Co-authored-by: Francisco Arceo <farceo@redhat.com>
2025-05-30 07:14:12 -04:00
Ben Browning
09ab94b8ab blacken-docs formatting for OpenAI API docs
Signed-off-by: Ben Browning <bbrownin@redhat.com>
2025-05-29 20:12:20 -04:00
Ben Browning
d8f8dba2e0 docs: Add OpenAI API compatibility page
This adds some initial content documenting our OpenAI compatible APIs
- Responses, Chat Completions, Completions, and Models - along with
instructions on how to use them via OpenAI or Llama Stack clients and
some simple examples for each.

It's not a lot of content, but it's a start so that users have some
idea how to get going as we continue to work on these APIs.

Signed-off-by: Ben Browning <bbrownin@redhat.com>
2025-05-29 20:06:03 -04:00