autogen.oai.client.OpenAIClient

OpenAIClient

OpenAIClient(client: Union[OpenAI, AzureOpenAI], response_format: Union[BaseModel, dict[str, Any], None] = None)

Follows the Client protocol and wraps the OpenAI client.

Parameters:

Name	Description
client	Type: Union[OpenAI, AzureOpenAI]
response_format	Type: Union[BaseModel, dict[str, Any], None] Default: None

Instance Methods

cost

cost(self, response: Union[ChatCompletion, Completion]) -> float

Calculate the cost of the response.

Parameters:

Name	Description
response	Type: Union[ChatCompletion, Completion]

create

create(self, params: dict[str, Any]) -> ChatCompletion

Create a completion for a given config using openai’s client.

Parameters:

Name	Description
params	The params for the completion. Type: dict[str, Any]

Returns:

Type	Description
ChatCompletion	The completion.

get_usage

get_usage(response: Union[ChatCompletion, Completion]) -> dict

Parameters:

Name	Description
response	Type: Union[ChatCompletion, Completion]

message_retrieval

message_retrieval(self, response: Union[ChatCompletion, Completion]) -> Union[list[str], list[ChatCompletionMessage]]

Retrieve the messages from the response.

Parameters:

Name	Description
response	The response from openai. Type: Union[ChatCompletion, Completion]

Returns:

Type	Description
Union[list[str], list[ChatCompletionMessage]]	The message from the response.