mirascope.core.base.stream

Module stream

This module contains the base classes for streaming responses from LLMs.

A base class for streaming responses from LLMs.

Bases: Generic[_BaseCallResponseT, _BaseCallResponseChunkT, _UserMessageParamT, _AssistantMessageParamT, _ToolMessageParamT, _MessageParamT, _BaseToolT, _ToolSchemaT, _BaseDynamicConfigT, _BaseCallParamsT, _FinishReason], ABC

Name	Type	Description
stream	Generator[tuple[_BaseCallResponseChunkT, _BaseToolT \| None], None, None] \| AsyncGenerator[tuple[_BaseCallResponseChunkT, _BaseToolT \| None], None]	-
content	str	-
metadata	Metadata	-
tool_types	list[type[_BaseToolT]] \| None	-
call_response_type	type[_BaseCallResponseT]	-
model	str	-
prompt_template	str \| None	-
fn_args	dict[str, Any] \| None	-
dynamic_config	_BaseDynamicConfigT	-
messages	list[_MessageParamT]	-
call_params	_BaseCallParamsT	-
call_kwargs	BaseCallKwargs[_ToolSchemaT]	-
user_message_param	_UserMessageParamT \| None	-
message_param	_AssistantMessageParamT	-
input_tokens	int \| float \| None	-
cached_tokens	int \| float \| None	-
output_tokens	int \| float \| None	-
id	str \| None	-
finish_reasons	list[_FinishReason] \| None	-
start_time	float	-
end_time	float	-
provider	Provider	-
cost_metadata	CostMetadata	Returns metadata needed for cost calculation.
cost	float \| None	Calculate the cost of this streaming API call.

Returns the tool message parameters for tool call results.

Name	Type	Description
self	Any	-
tools_and_outputs	list[tuple[_BaseToolT, JsonableType]]	The list of tools and their outputs from which the tool message parameters should be constructed.

Type	Description
list[_ToolMessageParamT]	-

Constructs the call response.

Name	Type	Description
self	Any	-

Type	Description
_BaseCallResponseT	-

Name	Type	Description
TCallResponse	type[_BaseCallResponseT]	-
TStream	type[BaseStream]	-
setup_call	SameSyncAndAsyncClientSetupCall[_SameSyncAndAsyncClientT, _BaseDynamicConfigT, _AsyncBaseDynamicConfigT, _BaseCallParamsT, _ResponseT, _ResponseChunkT, _AsyncResponseT, _AsyncResponseChunkT, _BaseToolT] \| SetupCall[_SyncBaseClientT, _AsyncBaseClientT, _BaseDynamicConfigT, _AsyncBaseDynamicConfigT, _BaseCallParamsT, _ResponseT, _ResponseChunkT, _AsyncResponseT, _AsyncResponseChunkT, _BaseToolT]	-
handle_stream	HandleStream[_ResponseChunkT, _BaseCallResponseChunkT, _BaseToolT]	-
handle_stream_async	HandleStreamAsync[_AsyncResponseChunkT, _BaseCallResponseChunkT, _BaseToolT]	-