Class: Aws::BedrockAgentRuntime::Types::Trace

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentRuntime::Types::Trace

Defined in:

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

Overview

Note:

Trace is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Trace corresponding to the set member.

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

See Also:

• AWS API Documentation

Defined Under Namespace

Classes: CustomOrchestrationTrace, FailureTrace, GuardrailTrace, OrchestrationTrace, PostProcessingTrace, PreProcessingTrace, RoutingClassifierTrace, Unknown

Constant Summary

SENSITIVE =

[:custom_orchestration_trace, :failure_trace, :guardrail_trace, :orchestration_trace, :post_processing_trace, :pre_processing_trace, :routing_classifier_trace]

Instance Attribute Summary

• #custom_orchestration_trace ⇒ Types::CustomOrchestrationTrace

  Details about the custom orchestration step in which the agent determines the order in which actions are executed.

• #failure_trace ⇒ Types::FailureTrace

  Contains information about the failure of the interaction.

• #guardrail_trace ⇒ Types::GuardrailTrace

  The trace details for a trace defined in the Guardrail filter.

• #orchestration_trace ⇒ Types::OrchestrationTrace

  Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

• #post_processing_trace ⇒ Types::PostProcessingTrace

  Details about the post-processing step, in which the agent shapes the response..

• #pre_processing_trace ⇒ Types::PreProcessingTrace

  Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

• #routing_classifier_trace ⇒ Types::RoutingClassifierTrace

  A routing classifier's trace.

• #unknown ⇒ Object

  Returns the value of attribute unknown.

Instance Attribute Details

#custom_orchestration_trace ⇒ Types::CustomOrchestrationTrace

Details about the custom orchestration step in which the agent determines the order in which actions are executed.

Returns:

• (Types::CustomOrchestrationTrace)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10334

class Trace < Struct.new(
  :custom_orchestration_trace,
  :failure_trace,
  :guardrail_trace,
  :orchestration_trace,
  :post_processing_trace,
  :pre_processing_trace,
  :routing_classifier_trace,
  :unknown)
  SENSITIVE = [:custom_orchestration_trace, :failure_trace, :guardrail_trace, :orchestration_trace, :post_processing_trace, :pre_processing_trace, :routing_classifier_trace]
  include Aws::Structure
  include Aws::Structure::Union

  class CustomOrchestrationTrace < Trace; end
  class FailureTrace < Trace; end
  class GuardrailTrace < Trace; end
  class OrchestrationTrace < Trace; end
  class PostProcessingTrace < Trace; end
  class PreProcessingTrace < Trace; end
  class RoutingClassifierTrace < Trace; end
  class Unknown < Trace; end
end

#failure_trace ⇒ Types::FailureTrace

Contains information about the failure of the interaction.

Returns:

• (Types::FailureTrace)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10334

class Trace < Struct.new(
  :custom_orchestration_trace,
  :failure_trace,
  :guardrail_trace,
  :orchestration_trace,
  :post_processing_trace,
  :pre_processing_trace,
  :routing_classifier_trace,
  :unknown)
  SENSITIVE = [:custom_orchestration_trace, :failure_trace, :guardrail_trace, :orchestration_trace, :post_processing_trace, :pre_processing_trace, :routing_classifier_trace]
  include Aws::Structure
  include Aws::Structure::Union

  class CustomOrchestrationTrace < Trace; end
  class FailureTrace < Trace; end
  class GuardrailTrace < Trace; end
  class OrchestrationTrace < Trace; end
  class PostProcessingTrace < Trace; end
  class PreProcessingTrace < Trace; end
  class RoutingClassifierTrace < Trace; end
  class Unknown < Trace; end
end

#guardrail_trace ⇒ Types::GuardrailTrace

The trace details for a trace defined in the Guardrail filter.

Returns:

• (Types::GuardrailTrace)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10334

class Trace < Struct.new(
  :custom_orchestration_trace,
  :failure_trace,
  :guardrail_trace,
  :orchestration_trace,
  :post_processing_trace,
  :pre_processing_trace,
  :routing_classifier_trace,
  :unknown)
  SENSITIVE = [:custom_orchestration_trace, :failure_trace, :guardrail_trace, :orchestration_trace, :post_processing_trace, :pre_processing_trace, :routing_classifier_trace]
  include Aws::Structure
  include Aws::Structure::Union

  class CustomOrchestrationTrace < Trace; end
  class FailureTrace < Trace; end
  class GuardrailTrace < Trace; end
  class OrchestrationTrace < Trace; end
  class PostProcessingTrace < Trace; end
  class PreProcessingTrace < Trace; end
  class RoutingClassifierTrace < Trace; end
  class Unknown < Trace; end
end

#orchestration_trace ⇒ Types::OrchestrationTrace

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

Returns:

• (Types::OrchestrationTrace)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10334

class Trace < Struct.new(
  :custom_orchestration_trace,
  :failure_trace,
  :guardrail_trace,
  :orchestration_trace,
  :post_processing_trace,
  :pre_processing_trace,
  :routing_classifier_trace,
  :unknown)
  SENSITIVE = [:custom_orchestration_trace, :failure_trace, :guardrail_trace, :orchestration_trace, :post_processing_trace, :pre_processing_trace, :routing_classifier_trace]
  include Aws::Structure
  include Aws::Structure::Union

  class CustomOrchestrationTrace < Trace; end
  class FailureTrace < Trace; end
  class GuardrailTrace < Trace; end
  class OrchestrationTrace < Trace; end
  class PostProcessingTrace < Trace; end
  class PreProcessingTrace < Trace; end
  class RoutingClassifierTrace < Trace; end
  class Unknown < Trace; end
end

#post_processing_trace ⇒ Types::PostProcessingTrace

Details about the post-processing step, in which the agent shapes the response..

Returns:

• (Types::PostProcessingTrace)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10334

class Trace < Struct.new(
  :custom_orchestration_trace,
  :failure_trace,
  :guardrail_trace,
  :orchestration_trace,
  :post_processing_trace,
  :pre_processing_trace,
  :routing_classifier_trace,
  :unknown)
  SENSITIVE = [:custom_orchestration_trace, :failure_trace, :guardrail_trace, :orchestration_trace, :post_processing_trace, :pre_processing_trace, :routing_classifier_trace]
  include Aws::Structure
  include Aws::Structure::Union

  class CustomOrchestrationTrace < Trace; end
  class FailureTrace < Trace; end
  class GuardrailTrace < Trace; end
  class OrchestrationTrace < Trace; end
  class PostProcessingTrace < Trace; end
  class PreProcessingTrace < Trace; end
  class RoutingClassifierTrace < Trace; end
  class Unknown < Trace; end
end

#pre_processing_trace ⇒ Types::PreProcessingTrace

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

Returns:

• (Types::PreProcessingTrace)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10334

class Trace < Struct.new(
  :custom_orchestration_trace,
  :failure_trace,
  :guardrail_trace,
  :orchestration_trace,
  :post_processing_trace,
  :pre_processing_trace,
  :routing_classifier_trace,
  :unknown)
  SENSITIVE = [:custom_orchestration_trace, :failure_trace, :guardrail_trace, :orchestration_trace, :post_processing_trace, :pre_processing_trace, :routing_classifier_trace]
  include Aws::Structure
  include Aws::Structure::Union

  class CustomOrchestrationTrace < Trace; end
  class FailureTrace < Trace; end
  class GuardrailTrace < Trace; end
  class OrchestrationTrace < Trace; end
  class PostProcessingTrace < Trace; end
  class PreProcessingTrace < Trace; end
  class RoutingClassifierTrace < Trace; end
  class Unknown < Trace; end
end

#routing_classifier_trace ⇒ Types::RoutingClassifierTrace

A routing classifier's trace.

Returns:

• (Types::RoutingClassifierTrace)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10334

class Trace < Struct.new(
  :custom_orchestration_trace,
  :failure_trace,
  :guardrail_trace,
  :orchestration_trace,
  :post_processing_trace,
  :pre_processing_trace,
  :routing_classifier_trace,
  :unknown)
  SENSITIVE = [:custom_orchestration_trace, :failure_trace, :guardrail_trace, :orchestration_trace, :post_processing_trace, :pre_processing_trace, :routing_classifier_trace]
  include Aws::Structure
  include Aws::Structure::Union

  class CustomOrchestrationTrace < Trace; end
  class FailureTrace < Trace; end
  class GuardrailTrace < Trace; end
  class OrchestrationTrace < Trace; end
  class PostProcessingTrace < Trace; end
  class PreProcessingTrace < Trace; end
  class RoutingClassifierTrace < Trace; end
  class Unknown < Trace; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

• (Object) —

  the current value of unknown

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10334

def unknown
  @unknown
end