openai

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:

1
client<llm> MyClient {
2
  provider openai
3
  options {
4
    api_key env.MY_OPENAI_KEY
5
    model "gpt-3.5-turbo"
6
    headers {
7
      "X-My-Header" "my-value"
8
    }
9
  }
10
}

The role to use if the role is not in the allowed_roles. Default: "user" usually, but some models like OpenAI’s gpt-4o will use "system"

Picked the first role in allowed_roles if not “user”, otherwise “user”.

Which roles should we forward to the API? Default: ["system", "user", "assistant"] usually, but some models like OpenAI’s o1-mini will use ["user", "assistant"]

When building prompts, any role not in this list will be set to the default_role.

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:

1
client<llm> Foo {
2
  provider openai
3
  options {
4
    allowed_role_metadata: ["foo", "bar"]
5
  }
6
}
7
8
client<llm> FooWithout {
9
  provider openai
10
  options {
11
  }
12
}
13
template_string Foo() #"
14
  {{ _.role('user', foo={"type": "ephemeral"}, bar="1", cat=True) }}
15
  This will be have foo and bar, but not cat metadata. But only for Foo, not FooWithout.
16
  {{ _.role('user') }}
17
  This will have none of the role metadata for Foo or FooWithout.
18
"#

You can use the playground to see the raw curl request to see what is being sent to the API.

Whether the internal LLM client should use the streaming API. Default: <auto>

Then in your prompt you can use something like:

1
client<llm> MyClientWithoutStreaming {
2
  provider openai
3
  options {
4
    model gpt-4o
5
    api_key env.OPENAI_API_KEY
6
    supports_streaming false 
7
  }
8
}
9
10
function MyFunction() -> string {
11
  client MyClientWithoutStreaming
12
  prompt #"Write a short story"#
13
}

1
# This will be streamed from your python code perspective, 
2
# but under the hood it will call the non-streaming HTTP API
3
# and then return a streamable response with a single event
4
b.stream.MyFunction()
5
6
# This will work exactly the same as before
7
b.MyFunction()

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.