openai
The openai
provider supports the OpenAI /chat
endpoint, setting OpenAI-specific
default configuration options.
For Azure, we recommend using azure-openai
instead.
For all other OpenAI-compatible API providers, such as Groq, HuggingFace,
Ollama, OpenRouter, Together AI, and others, we recommend using
openai-generic
instead.
Example:
The options are passed through directly to the API, barring a few. Here’s a shorthand of the options:
Non-forwarded options
Will be used to build the Authorization
header, like so: Authorization: Bearer $api_key
Default: env.OPENAI_API_KEY
The base URL for the API.
Default: https://api.openai.com/v1
The default role for any prompts that don’t specify a role.
We don’t do any validation of this field, so you can pass any string you wish.
Default: system
Additional headers to send with the request.
Example:
Which role metadata should we forward to the API? Default: []
For example you can set this to ["foo", "bar"]
to forward the cache policy to the API.
If you do not set allowed_role_metadata
, we will not forward any role metadata to the API even if it is set in the prompt.
Then in your prompt you can use something like:
You can use the playground to see the raw curl request to see what is being sent to the API.
Forwarded options
BAML will auto construct this field for you from the prompt
BAML will auto construct this field for you based on how you call the client in your code
The model to use.
See openai docs for the list of openai models. You can pass any model name you wish, we will not check if it exists.
For all other options, see the official OpenAI API documentation.