Camel.models.openai model

​

OpenAIModel

class OpenAIModel(BaseModelBackend):

• model_type (Union[ModelType, str]): Model for which a backend is created, one of GPT_* series.
• model_config_dict (Optional[Dict[str, Any]], optional): A dictionary that will be fed into:obj:openai.ChatCompletion.create(). If :obj:None, :obj:ChatGPTConfig().as_dict() will be used. (default: :obj:None)
• api_key (Optional[str], optional): The API key for authenticating with the OpenAI service. (default: :obj:None)
• url (Optional[str], optional): The url to the OpenAI service. (default: :obj:None)
• token_counter (Optional[BaseTokenCounter], optional): Token counter to use for the model. If not provided, :obj:OpenAITokenCounter will be used. (default: :obj:None)
• timeout (Optional[float], optional): The timeout value in seconds for API calls. If not provided, will fall back to the MODEL_TIMEOUT environment variable or default to 180 seconds. (default: :obj:None)
• max_retries (int, optional): Maximum number of retries for API calls. (default: :obj:3)
• client (Optional[Any], optional): A custom synchronous OpenAI client instance. If provided, this client will be used instead of creating a new one. Useful for RL frameworks like AReaL or rLLM that provide OpenAI-compatible clients. The client should implement the OpenAI client interface with .chat.completions.create() and .beta.chat.completions.parse() methods. (default: :obj:None)
• async_client (Optional[Any], optional): A custom asynchronous OpenAI client instance. If provided, this client will be used instead of creating a new one. The client should implement the AsyncOpenAI client interface. (default: :obj:None) **kwargs (Any): Additional arguments to pass to the OpenAI client initialization. These can include parameters like ‘organization’, ‘default_headers’, ‘http_client’, etc. Ignored if custom clients are provided.

​

init

def __init__(
    self,
    model_type: Union[ModelType, str],
    model_config_dict: Optional[Dict[str, Any]] = None,
    api_key: Optional[str] = None,
    url: Optional[str] = None,
    token_counter: Optional[BaseTokenCounter] = None,
    timeout: Optional[float] = None,
    max_retries: int = 3,
    client: Optional[Any] = None,
    async_client: Optional[Any] = None,
    **kwargs: Any
):

​

_sanitize_config

def _sanitize_config(self, config_dict: Dict[str, Any]):

​

_adapt_messages_for_o1_models

def _adapt_messages_for_o1_models(self, messages: List[OpenAIMessage]):

• messages (List[OpenAIMessage]): Message list with the chat history in OpenAI API format.

​

token_counter

def token_counter(self):

​

_run

def _run(
    self,
    messages: List[OpenAIMessage],
    response_format: Optional[Type[BaseModel]] = None,
    tools: Optional[List[Dict[str, Any]]] = None
):

• messages (List[OpenAIMessage]): Message list with the chat history in OpenAI API format.
• response_format (Optional[Type[BaseModel]]): The format of the response.
• tools (Optional[List[Dict[str, Any]]]): The schema of the tools to use for the request.

​

_request_chat_completion

def _request_chat_completion(
    self,
    messages: List[OpenAIMessage],
    tools: Optional[List[Dict[str, Any]]] = None
):

​

_request_parse

def _request_parse(
    self,
    messages: List[OpenAIMessage],
    response_format: Type[BaseModel],
    tools: Optional[List[Dict[str, Any]]] = None
):

​

_request_stream_parse

def _request_stream_parse(
    self,
    messages: List[OpenAIMessage],
    response_format: Type[BaseModel],
    tools: Optional[List[Dict[str, Any]]] = None
):

​

stream

def stream(self):