GitHub

ToolResultSuccess

API reference for ToolResultSuccess.

The tool name succeeded with result (encoded_result is what the model sees, unless the tool's to_model_output gave model_output). preliminary: a progress value streamed before the final one.

Attributes

AttributeTypeDescription
typeLiteral['tool-result'] = 'tool-result'
idstr
nameN_co
resultS_co
encoded_resultobject
is_failureLiteral[False] = False
provider_executedbool = False
preliminarybool = False
metadataProviderMetadata = field(default_factory=_metadata)
model_outputtuple[P.ToolModelOutputPart, ...] | None = None

Functions

__init__

__init__(id, name, result, encoded_result, is_failure=False, provider_executed=False, preliminary=False, metadata=_metadata(), model_output=None) -> None
ParameterTypeDescription
idstr
nameN_co
resultS_co
encoded_resultobject
is_failureLiteral[False] = False
provider_executedbool = False
preliminarybool = False
metadataProviderMetadata = _metadata()
model_outputtuple[P.ToolModelOutputPart, ...] | None = None