mirascope.core.azure.call_response

This module contains the AzureCallResponse class.

Usage Documentation

Calls

AzureCallResponse

Bases: BaseCallResponse[ChatCompletions, AzureTool, ChatCompletionsToolDefinition, AzureDynamicConfig, ChatRequestMessage, AzureCallParams, UserMessage]

A convenience wrapper around the Azure ChatCompletion response.

When calling the Azure API using a function decorated with azure_call, the response will be an AzureCallResponse instance with properties that allow for more convenience access to commonly used attributes.

Example:

from mirascope.core import prompt_template
from mirascope.core.azure import azure_call


@azure_call("gpt-4o")
@prompt_template("Recommend a {genre} book")
def recommend_book(genre: str):
    ...


response = recommend_book("fantasy")  # response is an `AzureCallResponse` 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]

Returns the finish reasons of the response.

model property

model: str

Returns the name of the response model.

id property

id: str

Returns the id of the response.

usage property

usage: CompletionsUsage | None

Returns the usage of the chat completion.

input_tokens property

input_tokens: int | None

Returns the number of input tokens.

output_tokens property

output_tokens: int | None

Returns the number of output tokens.

cost property

cost: float | None

Returns the cost of the call.

message_param property

message_param: SerializeAsAny[AssistantMessage]

Returns the assistants's response as a message parameter.

tools property

tools: list[AzureTool] | None

Returns any available tool calls as their AzureTool definition.

Raises:

Type	Description
ValidationError	if a tool call doesn't match the tool's schema.
ValueError	if the model refused to response, in which case the error message will be the refusal.

tool property

tool: AzureTool | 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.
ValueError	if the model refused to response, in which case the error message will be the refusal.

tool_message_params classmethod

tool_message_params(
    tools_and_outputs: list[tuple[AzureTool, str]]
) -> list[ToolMessage]

Returns the tool message parameters for tool call results.

Parameters:

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

Returns:

Type	Description
list[ToolMessage]	The list of constructed ChatCompletionToolMessageParam parameters.

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

@classmethod
def tool_message_params(
    cls, tools_and_outputs: list[tuple[AzureTool, str]]
) -> list[ToolMessage]:
    """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 `ChatCompletionToolMessageParam` parameters.
    """
    return [
        cls._get_tool_message(tool, output) for tool, output in tools_and_outputs
    ]