Skip to content

mirascope.core.azure.call_response_chunk

This module contains the AzureCallResponseChunk class.

Usage Documentation

Streams

AzureCallResponseChunk

Bases: BaseCallResponseChunk[StreamingChatCompletionsUpdate, CompletionsFinishReason]

A convenience wrapper around the Azure ChatCompletionChunk streamed chunks.

When calling the Azure API using a function decorated with azure_call and stream set to True, the stream will contain AzureResponseChunk instances with properties that allow for more convenient access to commonly used attributes.

Example:

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


@azure_call("gpt-4o-mini", stream=True)
def recommend_book(genre: str) -> str:
    return f"Recommend a {genre} book"


stream = recommend_book("fantasy")  # response is an `AzureStream`
for chunk, _ in stream:
    print(chunk.content, end="", flush=True)

content property 

content: str

Returns the content for the 0th choice delta.

finish_reasons property 

finish_reasons: list[CompletionsFinishReason]

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

Returns the usage of the chat completion.

input_tokens property 

input_tokens: int

Returns the number of input tokens.

output_tokens property 

output_tokens: int

Returns the number of output tokens.