Class: Aws::BedrockAgentRuntime::Types::OrchestrationTrace

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb

Overview

Note:

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

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

Defined Under Namespace

Classes: InvocationInput, ModelInvocationInput, ModelInvocationOutput, Observation, Rationale, Unknown

Constant Summary collapse

SENSITIVE =
[:rationale, :invocation_input, :observation, :model_invocation_input, :model_invocation_output]

Instance Attribute Summary collapse

Instance Attribute Details

#invocation_inputTypes::InvocationInput

Contains information pertaining to the action group or knowledge base that is being invoked.



6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6216

class OrchestrationTrace < Struct.new(
  :rationale,
  :invocation_input,
  :observation,
  :model_invocation_input,
  :model_invocation_output,
  :unknown)
  SENSITIVE = [:rationale, :invocation_input, :observation, :model_invocation_input, :model_invocation_output]
  include Aws::Structure
  include Aws::Structure::Union

  class Rationale < OrchestrationTrace; end
  class InvocationInput < OrchestrationTrace; end
  class Observation < OrchestrationTrace; end
  class ModelInvocationInput < OrchestrationTrace; end
  class ModelInvocationOutput < OrchestrationTrace; end
  class Unknown < OrchestrationTrace; end
end

#model_invocation_inputTypes::ModelInvocationInput

The input for the orchestration step.

  • The type is ORCHESTRATION.

  • The text contains the prompt.

  • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.



6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6216

class OrchestrationTrace < Struct.new(
  :rationale,
  :invocation_input,
  :observation,
  :model_invocation_input,
  :model_invocation_output,
  :unknown)
  SENSITIVE = [:rationale, :invocation_input, :observation, :model_invocation_input, :model_invocation_output]
  include Aws::Structure
  include Aws::Structure::Union

  class Rationale < OrchestrationTrace; end
  class InvocationInput < OrchestrationTrace; end
  class Observation < OrchestrationTrace; end
  class ModelInvocationInput < OrchestrationTrace; end
  class ModelInvocationOutput < OrchestrationTrace; end
  class Unknown < OrchestrationTrace; end
end

#model_invocation_outputTypes::OrchestrationModelInvocationOutput

Contains information pertaining to the output from the foundation model that is being invoked.



6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6216

class OrchestrationTrace < Struct.new(
  :rationale,
  :invocation_input,
  :observation,
  :model_invocation_input,
  :model_invocation_output,
  :unknown)
  SENSITIVE = [:rationale, :invocation_input, :observation, :model_invocation_input, :model_invocation_output]
  include Aws::Structure
  include Aws::Structure::Union

  class Rationale < OrchestrationTrace; end
  class InvocationInput < OrchestrationTrace; end
  class Observation < OrchestrationTrace; end
  class ModelInvocationInput < OrchestrationTrace; end
  class ModelInvocationOutput < OrchestrationTrace; end
  class Unknown < OrchestrationTrace; end
end

#observationTypes::Observation

Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

Returns:



6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6216

class OrchestrationTrace < Struct.new(
  :rationale,
  :invocation_input,
  :observation,
  :model_invocation_input,
  :model_invocation_output,
  :unknown)
  SENSITIVE = [:rationale, :invocation_input, :observation, :model_invocation_input, :model_invocation_output]
  include Aws::Structure
  include Aws::Structure::Union

  class Rationale < OrchestrationTrace; end
  class InvocationInput < OrchestrationTrace; end
  class Observation < OrchestrationTrace; end
  class ModelInvocationInput < OrchestrationTrace; end
  class ModelInvocationOutput < OrchestrationTrace; end
  class Unknown < OrchestrationTrace; end
end

#rationaleTypes::Rationale

Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

Returns:



6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6216

class OrchestrationTrace < Struct.new(
  :rationale,
  :invocation_input,
  :observation,
  :model_invocation_input,
  :model_invocation_output,
  :unknown)
  SENSITIVE = [:rationale, :invocation_input, :observation, :model_invocation_input, :model_invocation_output]
  include Aws::Structure
  include Aws::Structure::Union

  class Rationale < OrchestrationTrace; end
  class InvocationInput < OrchestrationTrace; end
  class Observation < OrchestrationTrace; end
  class ModelInvocationInput < OrchestrationTrace; end
  class ModelInvocationOutput < OrchestrationTrace; end
  class Unknown < OrchestrationTrace; end
end

#unknownObject

Returns the value of attribute unknown

Returns:

  • (Object)

    the current value of unknown



6216
6217
6218
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6216

def unknown
  @unknown
end