Skip to content

mirascope.core.bedrock.call_response_chunk

This module contains the BedrockCallResponseChunk class.

Usage Documentation

Streams

BedrockCallResponseChunk

Bases: BaseCallResponseChunk[StreamOutputChunk | AsyncStreamOutputChunk, StopReasonType]

A convenience wrapper around the Bedrock ChatCompletionChunk streamed chunks.

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

Example:

from mirascope.core import prompt_template
from mirascope.core.bedrock import bedrock_call


@bedrock_call("anthropic.claude-3-haiku-20240307-v1:0", stream=True)
@prompt_template("Recommend a {genre} book")
def recommend_book(genre: str):
    ...


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

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: TokenUsageTypeDef | 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.