Skip to main content

​
Parameters

ParameterTypeDefaultDescription
base_urlstr | NoneNoneThe base url for the OpenAI requests. If not provided, the OPENAI_BASE_URL environment variable will be used if available. Otherwise, defaults to OpenAI’s base url.
api_keystr | NoneNoneThe API key to use for authentication, if not provided, the OPENAI_API_KEY environment variable will be used if available.
openai_clientAsyncOpenAI | NoneNoneAn existing AsyncOpenAI client to use. If provided, base_url, api_key, and http_client must be None.
http_clienthttpx.AsyncClient | NoneNoneAn existing httpx.AsyncClient to use for making HTTP requests.

​
Functions

​
__init__

Create a new OpenAI provider. Parameters:
  • base_url (str | None): The base url for the OpenAI requests. If not provided, the OPENAI_BASE_URL environment variable will be used if available. Otherwise, defaults to OpenAI’s base url.
  • api_key (str | None): The API key to use for authentication, if not provided, the OPENAI_API_KEY environment variable will be used if available.
  • openai_client (AsyncOpenAI | None): An existing AsyncOpenAI client to use. If provided, base_url, api_key, and http_client must be None.
  • http_client (httpx.AsyncClient | None): An existing httpx.AsyncClient to use for making HTTP requests.

​
name

Get the provider name. Returns:
  • str: The provider name (‘openai’)

​
base_url

Get the base URL for the provider API. Returns:
  • str: The base URL for the provider API

​
client

Get the client for the provider. Returns:
  • AsyncOpenAI: The OpenAI client

​
model_profile

Get the model profile for the named model, if available. Parameters:
  • model_name (str): The name of the model
Returns:
  • ModelProfile | None: The model profile for the named model, if available
⌘I