# ModelClient

## ``autogen.ModelClient``

Bases: `Protocol`

A client class must implement the following methods:
- create must return a response object that implements the ModelClientResponseProtocol
- cost must return the cost of the response
- get_usage must return a dict with the following keys:
  - prompt_tokens
  - completion_tokens
  - total_tokens
  - cost
  - model

This class is used to create a client that can be used by OpenAIWrapper. The response returned from create must adhere to the ModelClientResponseProtocol but can be extended however needed. The message_retrieval method must be implemented to return a list of str or a list of messages from the response.

### ``RESPONSE_USAGE_KEYS``

```python
RESPONSE_USAGE_KEYS = ['prompt_tokens', 'completion_tokens', 'total_tokens', 'cost', 'model']
```

### ``ModelClientResponseProtocol``

Bases: `Protocol`

#### ``choices``

``choices``

#### ``model``

``model``

#### ``Choice``

Bases: `Protocol`

##### ``message``

``message``

##### ``Message``

Bases: `Protocol`

###### ``content``

``content``

### ``create``

```python
create(params)
```

Source code in `autogen/oai/client.py`

|     |     |
| --- | --- |
| ```<br>324<br>``` | ```<br>def create(self, params: dict[str, Any]) -> ModelClientResponseProtocol: ...  # pragma: no cover<br>``` |

### ``message_retrieval``

```python
message_retrieval(response)
```

Retrieve and return a list of strings or a list of Choice.Message from the response.

NOTE: if a list of Choice.Message is returned, it currently needs to contain the fields of OpenAI's ChatCompletion Message object, since that is expected for function or tool calling in the rest of the codebase at the moment, unless a custom agent is being used.

Source code in `autogen/oai/client.py`

|     |     |
| --- | --- |
| ```<br>326<br>327<br>328<br>329<br>330<br>331<br>332<br>333<br>334<br>``` | ```<br>def message_retrieval(<br>    self, response: ModelClientResponseProtocol<br>) -> Union[list[str], list[ModelClient.ModelClientResponseProtocol.Choice.Message]]:<br>    """Retrieve and return a list of strings or a list of Choice.Message from the response.<br>    NOTE: if a list of Choice.Message is returned, it currently needs to contain the fields of OpenAI's ChatCompletion Message object,<br>    since that is expected for function or tool calling in the rest of the codebase at the moment, unless a custom agent is being used.<br>    """<br>    ...  # pragma: no cover<br>``` |

### ``cost``

```python
cost(response)
```

Source code in `autogen/oai/client.py`

|     |     |
| --- | --- |
| ```<br>336<br>``` | ```<br>def cost(self, response: ModelClientResponseProtocol) -> float: ...  # pragma: no cover<br>``` |

### ``get_usage``

```python
get_usage(response)
```

Return usage summary of the response using RESPONSE_USAGE_KEYS.

Source code in `autogen/oai/client.py`

|     |     |
| --- | --- |
| ```<br>338<br>339<br>340<br>341<br>``` | ```<br>@staticmethod<br>def get_usage(response: ModelClientResponseProtocol) -> dict:<br>    """Return usage summary of the response using RESPONSE_USAGE_KEYS."""<br>    ...  # pragma: no cover<br>``` |