CohereClient

CohereClient(**kwargs)

Client for Cohere’s API.
Requires api_key or environment variable to be set

Parameters:
NameDescription
**kwargs

Static Methods

get_usage

get_usage(response) -> dict

Return usage summary of the response using RESPONSE_USAGE_KEYS.

Parameters:
NameDescription
response

Instance Methods

cost

cost(self, response) -> float
Parameters:
NameDescription
response

create

create(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

message_retrieval

message_retrieval(self, response) -> list

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.

Parameters:
NameDescription
response

parse_params

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

Loads the parameters for Cohere API from the passed in parameters and returns a validated set. Checks types, ranges, and sets defaults

Parameters:
NameDescription
paramsType: dict[str, Any]