> ## Documentation Index
> Fetch the complete documentation index at: https://docs.camel-ai.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Camel.models.openai model

<a id="camel.models.openai_model" />

<a id="camel.models.openai_model.OpenAIModel" />

## OpenAIModel

```python theme={"system"}
class OpenAIModel(BaseModelBackend):
```

OpenAI API in a unified BaseModelBackend interface.

**Parameters:**

* **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.

<a id="camel.models.openai_model.OpenAIModel.__init__" />

### **init**

```python theme={"system"}
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
):
```

<a id="camel.models.openai_model.OpenAIModel._sanitize_config" />

### \_sanitize\_config

```python theme={"system"}
def _sanitize_config(self, config_dict: Dict[str, Any]):
```

Sanitize the model configuration for O1 models.

<a id="camel.models.openai_model.OpenAIModel._adapt_messages_for_o1_models" />

### \_adapt\_messages\_for\_o1\_models

```python theme={"system"}
def _adapt_messages_for_o1_models(self, messages: List[OpenAIMessage]):
```

Adjust message roles to comply with O1 model requirements by
converting 'system' or 'developer' to 'user' role.

**Parameters:**

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

**Returns:**

processed\_messages (List\[OpenAIMessage]): Return a new list of
messages to avoid mutating input.

<a id="camel.models.openai_model.OpenAIModel.token_counter" />

### token\_counter

```python theme={"system"}
def token_counter(self):
```

**Returns:**

BaseTokenCounter: The token counter following the model's
tokenization style.

<a id="camel.models.openai_model.OpenAIModel._run" />

### \_run

```python theme={"system"}
def _run(
    self,
    messages: List[OpenAIMessage],
    response_format: Optional[Type[BaseModel]] = None,
    tools: Optional[List[Dict[str, Any]]] = None
):
```

Runs inference of OpenAI chat completion.

**Parameters:**

* **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.

**Returns:**

Union\[ChatCompletion, Stream\[ChatCompletionChunk],
ChatCompletionStreamManager\[BaseModel]]:
`ChatCompletion` in the non-stream mode,
`Stream[ChatCompletionChunk]`in the stream mode,
or `ChatCompletionStreamManager[BaseModel]` for
structured output streaming.

<a id="camel.models.openai_model.OpenAIModel._request_chat_completion" />

### \_request\_chat\_completion

```python theme={"system"}
def _request_chat_completion(
    self,
    messages: List[OpenAIMessage],
    tools: Optional[List[Dict[str, Any]]] = None
):
```

<a id="camel.models.openai_model.OpenAIModel._request_parse" />

### \_request\_parse

```python theme={"system"}
def _request_parse(
    self,
    messages: List[OpenAIMessage],
    response_format: Type[BaseModel],
    tools: Optional[List[Dict[str, Any]]] = None
):
```

<a id="camel.models.openai_model.OpenAIModel._request_stream_parse" />

### \_request\_stream\_parse

```python theme={"system"}
def _request_stream_parse(
    self,
    messages: List[OpenAIMessage],
    response_format: Type[BaseModel],
    tools: Optional[List[Dict[str, Any]]] = None
):
```

Request streaming structured output parsing.

<a id="camel.models.openai_model.OpenAIModel.stream" />

### stream

```python theme={"system"}
def stream(self):
```

**Returns:**

bool: Whether the model is in stream mode.