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

Inherits:
Struct
  • Object
show all
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:

Defined Under Namespace

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

Constant Summary collapse

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

Instance Attribute Summary collapse

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:



8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8749

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

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

#failure_trace ⇒ Types::FailureTrace

Contains information about the failure of the interaction.

Returns:



8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8749

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

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

#guardrail_trace ⇒ Types::GuardrailTrace

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

Returns:



8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8749

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

  class GuardrailTrace < Trace; end
  class PreProcessingTrace < Trace; end
  class OrchestrationTrace < Trace; end
  class PostProcessingTrace < Trace; end
  class RoutingClassifierTrace < Trace; end
  class FailureTrace < Trace; end
  class CustomOrchestrationTrace < 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:



8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8749

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

  class GuardrailTrace < Trace; end
  class PreProcessingTrace < Trace; end
  class OrchestrationTrace < Trace; end
  class PostProcessingTrace < Trace; end
  class RoutingClassifierTrace < Trace; end
  class FailureTrace < Trace; end
  class CustomOrchestrationTrace < 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:



8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8749

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

  class GuardrailTrace < Trace; end
  class PreProcessingTrace < Trace; end
  class OrchestrationTrace < Trace; end
  class PostProcessingTrace < Trace; end
  class RoutingClassifierTrace < Trace; end
  class FailureTrace < Trace; end
  class CustomOrchestrationTrace < 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:



8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8749

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

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

#routing_classifier_trace ⇒ Types::RoutingClassifierTrace

A routing classifier's trace.

Returns:



8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8749

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

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

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



8749
8750
8751
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8749

def unknown
  @unknown
end