Skip to content

ConverseResponse

Source code in docs_src/capo_bedrock_runtime/types/converse_response.py
class ConverseResponse(TypedDict, closed=True):
    output: "capo_bedrock_runtime.types.converse_output.ConverseOutput"
    """<p>The result from the call to <code>Converse</code>.</p>"""
    stop_reason: "capo_bedrock_runtime.types.stop_reason.StopReason"
    """<p>The reason why the model stopped generating output.</p>"""
    usage: "capo_bedrock_runtime.types.token_usage.TokenUsage"
    """<p>The total number of tokens used in the call to <code>Converse</code>. The total includes the tokens input to the model and the tokens generated by the model.</p>"""
    metrics: "capo_bedrock_runtime.types.converse_metrics.ConverseMetrics"
    """<p>Metrics for the call to <code>Converse</code>.</p>"""
    additional_model_response_fields: NotRequired["object"]
    """<p>Additional fields in the response that are unique to the model. </p>"""
    trace: NotRequired["capo_bedrock_runtime.types.converse_trace.ConverseTrace"]
    """<p>A trace object that contains information about the Guardrail behavior.</p>"""
    performance_config: NotRequired[
        "capo_bedrock_runtime.types.performance_configuration.PerformanceConfiguration"
    ]
    """<p>Model performance settings for the request.</p>"""
    service_tier: NotRequired["capo_bedrock_runtime.types.service_tier.ServiceTier"]
    """<p>Specifies the processing tier configuration used for serving the request.</p>"""

additional_model_response_fields instance-attribute

additional_model_response_fields: NotRequired[object]

Additional fields in the response that are unique to the model.

metrics instance-attribute

metrics: ConverseMetrics

Metrics for the call to Converse.

output instance-attribute

The result from the call to Converse.

performance_config instance-attribute

performance_config: NotRequired[PerformanceConfiguration]

Model performance settings for the request.

service_tier instance-attribute

service_tier: NotRequired[ServiceTier]

Specifies the processing tier configuration used for serving the request.

stop_reason instance-attribute

stop_reason: StopReason

The reason why the model stopped generating output.

trace instance-attribute

trace: NotRequired[ConverseTrace]

A trace object that contains information about the Guardrail behavior.

usage instance-attribute

usage: TokenUsage

The total number of tokens used in the call to Converse. The total includes the tokens input to the model and the tokens generated by the model.