mirascope.core.cohere.call_response

This module contains the CohereCallResponse class.

Usage Documentation

Calls

CohereCallResponse

Bases: BaseCallResponse[SkipValidation[NonStreamedChatResponse], CohereTool, SkipValidation[Tool], AsyncCohereDynamicConfig | CohereDynamicConfig, SkipValidation[ChatMessage], CohereCallParams, SkipValidation[ChatMessage]]

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)

content property

content: str

Returns the content of the chat completion for the 0th choice.

finish_reasons property

finish_reasons: list[str] | None

Returns the finish reasons of the response.

model property

model: str

Returns the name of the response model.

Cohere does not return model, so we return the model provided by the user.

id property

id: str | None

Returns the id of the response.

usage property

usage: ApiMetaBilledUnits | None

Returns the usage of the response.

input_tokens property

input_tokens: float | None

Returns the number of input tokens.

output_tokens property

output_tokens: float | None

Returns the number of output tokens.

cost property

cost: float | None

Returns the cost of the response.

message_param property

message_param: ChatMessage

Returns the assistant's response as a message parameter.

tools property

tools: list[CohereTool] | None

Returns the tools for the 0th choice message.

Raises:

Type	Description
ValidationError	if a tool call doesn't match the tool's schema.

tool property

tool: CohereTool | None

Returns the 0th tool for the 0th choice message.

Raises:

Type	Description
ValidationError	if the tool call doesn't match the tool's schema.

tool_message_params classmethod

tool_message_params(
    tools_and_outputs: list[tuple[CohereTool, str]]
) -> list[ToolResult]

Returns the tool message parameters for tool call results.

Parameters:

Name	Type	Description	Default
tools_and_outputs	list[tuple[CohereTool, str]]	The list of tools and their outputs from which the tool message parameters should be constructed.	required

Returns:

Type	Description
list[ToolResult]	The list of constructed ToolResult parameters.

Source code in mirascope/core/cohere/call_response.py

@classmethod
def tool_message_params(
    cls,
    tools_and_outputs: list[tuple[CohereTool, str]],
) -> list[ToolResult]:
    """Returns the tool message parameters for tool call results.

    Args:
        tools_and_outputs: The list of tools and their outputs from which the tool
            message parameters should be constructed.

    Returns:
        The list of constructed `ToolResult` parameters.
    """
    return [
        ToolResult(
            call=tool.tool_call,
            outputs=[{"output": output}],
        )
        for tool, output in tools_and_outputs
    ]