mirascope.core.anthropic.call_response_chunk

Module call_response_chunk

This module contains the AnthropicCallResponseChunk class.

Usage

Attribute FinishReason

Type: Message.__annotations__['stop_reason']

Class AnthropicCallResponseChunk

A convenience wrapper around the Anthropic ChatCompletionChunk streamed chunks.

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

Example:

from mirascope.core import prompt_template
from mirascope.core.anthropic import anthropic_call


@anthropic_call("claude-3-5-sonnet-20240620", stream=True)
def recommend_book(genre: str) -> str:
    return f"Recommend a {genre} book"


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

Bases:

BaseCallResponseChunk[MessageStreamEvent, FinishReason]

Attributes

Name	Type	Description
content	str	Returns the string content of the 0th message.
finish_reasons	list[FinishReason] \| None	Returns the finish reason of the response.
model	str \| None	Returns the name of the response model.
id	str \| None	Returns the id of the response.
usage	Usage \| MessageDeltaUsage \| None	Returns the usage of the message.
input_tokens	int \| None	Returns the number of input tokens.
cached_tokens	int \| None	Returns the number of cached tokens.
output_tokens	int \| None	Returns the number of output tokens.
cost_metadata	CostMetadata	Returns the cost metadata.
common_finish_reasons	list[types.FinishReason] \| None	Provider-agnostic finish reasons.