Class: Aws::BedrockRuntime::Types::ConverseResponse

Inherits:

Struct

• Object
• Struct
• Aws::BedrockRuntime::Types::ConverseResponse

Defined in:

gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #additional_model_response_fields ⇒ Hash, ...

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

• #metrics ⇒ Types::ConverseMetrics

  Metrics for the call to Converse.

• #output ⇒ Types::ConverseOutput

  The result from the call to Converse.

• #performance_config ⇒ Types::PerformanceConfiguration

  Model performance settings for the request.

• #stop_reason ⇒ String

  The reason why the model stopped generating output.

• #trace ⇒ Types::ConverseTrace

  A trace object that contains information about the Guardrail behavior.

• #usage ⇒ Types::TokenUsage

  The total number of tokens used in the call to Converse.

Instance Attribute Details

#additional_model_response_fields ⇒ Hash, ...

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

Returns:

• (Hash, Array, String, Numeric, Boolean)

# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 931

class ConverseResponse < Struct.new(
  :output,
  :stop_reason,
  :usage,
  :metrics,
  :additional_model_response_fields,
  :trace,
  :performance_config)
  SENSITIVE = []
  include Aws::Structure
end

#metrics ⇒ Types::ConverseMetrics

Metrics for the call to Converse.

Returns:

• (Types::ConverseMetrics)

# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 931

class ConverseResponse < Struct.new(
  :output,
  :stop_reason,
  :usage,
  :metrics,
  :additional_model_response_fields,
  :trace,
  :performance_config)
  SENSITIVE = []
  include Aws::Structure
end

#output ⇒ Types::ConverseOutput

The result from the call to Converse.

Returns:

• (Types::ConverseOutput)

# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 931

class ConverseResponse < Struct.new(
  :output,
  :stop_reason,
  :usage,
  :metrics,
  :additional_model_response_fields,
  :trace,
  :performance_config)
  SENSITIVE = []
  include Aws::Structure
end

#performance_config ⇒ Types::PerformanceConfiguration

Model performance settings for the request.

Returns:

• (Types::PerformanceConfiguration)

# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 931

class ConverseResponse < Struct.new(
  :output,
  :stop_reason,
  :usage,
  :metrics,
  :additional_model_response_fields,
  :trace,
  :performance_config)
  SENSITIVE = []
  include Aws::Structure
end

#stop_reason ⇒ String

The reason why the model stopped generating output.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 931

class ConverseResponse < Struct.new(
  :output,
  :stop_reason,
  :usage,
  :metrics,
  :additional_model_response_fields,
  :trace,
  :performance_config)
  SENSITIVE = []
  include Aws::Structure
end

#trace ⇒ Types::ConverseTrace

A trace object that contains information about the Guardrail behavior.

Returns:

• (Types::ConverseTrace)

# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 931

class ConverseResponse < Struct.new(
  :output,
  :stop_reason,
  :usage,
  :metrics,
  :additional_model_response_fields,
  :trace,
  :performance_config)
  SENSITIVE = []
  include Aws::Structure
end

#usage ⇒ Types::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.

Returns:

• (Types::TokenUsage)

# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 931

class ConverseResponse < Struct.new(
  :output,
  :stop_reason,
  :usage,
  :metrics,
  :additional_model_response_fields,
  :trace,
  :performance_config)
  SENSITIVE = []
  include Aws::Structure
end