mirascope.core.cohere.call_response
This module contains the CohereCallResponse class.
Usage
Class CohereCallResponse
A convenience wrapper around the Cohere ChatCompletion response.
When calling the Cohere API using a function decorated with cohere_call, the
response will be an CohereCallResponse instance with properties that allow for
more convenience access to commonly used attributes.
Example:
from mirascope.core import prompt_template
from mirascope.core.cohere import cohere_call
@cohere_call("command-r-plus")
def recommend_book(genre: str) -> str:
return f"Recommend a {genre} book"
response = recommend_book("fantasy") # response is an `CohereCallResponse` instance
print(response.content)Bases:
BaseCallResponse[SkipValidation[NonStreamedChatResponse], CohereTool, SkipValidation[Tool], AsyncCohereDynamicConfig | CohereDynamicConfig, SkipValidation[ChatMessage], CohereCallParams, SkipValidation[ChatMessage], CohereMessageParamConverter]Attributes
| Name | Type | Description |
|---|---|---|
| content | str | Returns the content of the chat completion for the 0th choice. |
| finish_reasons | list[str] | None | Returns the finish reasons of the response. |
| model | str | Returns the name of the response model. Cohere does not return model, so we return the model provided by the user. |
| id | str | None | Returns the id of the response. |
| usage | ApiMetaBilledUnits | None | Returns the usage of the response. |
| input_tokens | float | None | Returns the number of input tokens. |
| cached_tokens | float | None | Returns the number of cached tokens. |
| output_tokens | float | None | Returns the number of output tokens. |
| message_param | ChatMessage | Returns the assistant's response as a message parameter. |
| tools | list[CohereTool] | None | Returns the tools for the 0th choice message. |
| tool | CohereTool | None | Returns the 0th tool for the 0th choice message. |
| common_finish_reasons | list[FinishReason] | None | - |
| common_message_param | BaseMessageParam | - |
| common_user_message_param | BaseMessageParam | None | - |
| cost_metadata | CostMetadata | Get metadata required for cost calculation. |
Function tool_message_params
Returns the tool message parameters for tool call results.
Parameters
| Name | Type | Description |
|---|---|---|
| cls | Any | - |
| tools_and_outputs | Sequence[tuple[CohereTool, str]] | The sequence of tools and their outputs from which the tool message parameters should be constructed. |
Returns
| Type | Description |
|---|---|
| list[ToolResult] | The list of constructed `ToolResult` parameters. |