Module: Aws::BedrockAgentRuntime::Types

Defined in:
gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb

Defined Under Namespace

Classes: AccessDeniedException, ActionGroupInvocationInput, ActionGroupInvocationOutput, ApiInvocationInput, ApiParameter, ApiRequestBody, ApiResult, Attribution, BadGatewayException, ByteContentDoc, Citation, ConflictException, ContentBody, DependencyFailedException, ExternalSource, ExternalSourcesGenerationConfiguration, ExternalSourcesRetrieveAndGenerateConfiguration, FailureTrace, FilterAttribute, FinalResponse, FunctionInvocationInput, FunctionParameter, FunctionResult, GeneratedResponsePart, GenerationConfiguration, GuardrailConfiguration, InferenceConfig, InferenceConfiguration, InternalServerException, InvocationInput, InvocationInputMember, InvocationResultMember, InvokeAgentRequest, InvokeAgentResponse, KnowledgeBaseLookupInput, KnowledgeBaseLookupOutput, KnowledgeBaseQuery, KnowledgeBaseRetrievalConfiguration, KnowledgeBaseRetrievalResult, KnowledgeBaseRetrieveAndGenerateConfiguration, KnowledgeBaseVectorSearchConfiguration, ModelInvocationInput, Observation, OrchestrationTrace, Parameter, PayloadPart, PostProcessingModelInvocationOutput, PostProcessingParsedResponse, PostProcessingTrace, PreProcessingModelInvocationOutput, PreProcessingParsedResponse, PreProcessingTrace, PromptTemplate, PropertyParameters, Rationale, RepromptResponse, RequestBody, ResourceNotFoundException, ResponseStream, RetrievalFilter, RetrievalResultContent, RetrievalResultLocation, RetrievalResultS3Location, RetrieveAndGenerateConfiguration, RetrieveAndGenerateInput, RetrieveAndGenerateOutput, RetrieveAndGenerateRequest, RetrieveAndGenerateResponse, RetrieveAndGenerateSessionConfiguration, RetrieveRequest, RetrieveResponse, RetrievedReference, ReturnControlPayload, S3ObjectDoc, ServiceQuotaExceededException, SessionState, Span, TextInferenceConfig, TextResponsePart, ThrottlingException, Trace, TracePart, ValidationException

Instance Attribute Summary collapse

Instance Attribute Details

#agent_alias_id ⇒ String

The unique identifier of the alias of the agent.

Returns:

  • (String) 


2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2635

class TracePart < Struct.new(
  :agent_alias_id,
  :agent_id,
  :agent_version,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:trace]
  include Aws::Structure
end

#agent_id ⇒ String

The unique identifier of the agent.

Returns:

  • (String) 


2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2635

class TracePart < Struct.new(
  :agent_alias_id,
  :agent_id,
  :agent_version,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:trace]
  include Aws::Structure
end

#agent_version ⇒ String

The version of the agent.

Returns:

  • (String) 


2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2635

class TracePart < Struct.new(
  :agent_alias_id,
  :agent_id,
  :agent_version,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:trace]
  include Aws::Structure
end

#and_all ⇒ Array<Types::RetrievalFilter>

Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.

Returns:



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1893

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#api_invocation_input ⇒ Types::ApiInvocationInput

Contains information about the API operation that the agent predicts should be called.

Returns:



918
919
920
921
922
923
924
925
926
927
928
929
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 918

class InvocationInputMember < Struct.new(
  :api_invocation_input,
  :function_invocation_input,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ApiInvocationInput < InvocationInputMember; end
  class FunctionInvocationInput < InvocationInputMember; end
  class Unknown < InvocationInputMember; end
end

#api_result ⇒ Types::ApiResult

The result from the API response from the action group invocation.

Returns:



959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 959

class InvocationResultMember < Struct.new(
  :api_result,
  :function_result,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ApiResult < InvocationResultMember; end
  class FunctionResult < InvocationResultMember; end
  class Unknown < InvocationResultMember; end
end

#attribution ⇒ Types::Attribution

Contains citations for a part of an agent response.

Returns:



1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1517

class PayloadPart < Struct.new(
  :attribution,
  :bytes,
  :event_type)
  SENSITIVE = [:bytes]
  include Aws::Structure
end

#bytes ⇒ String

A part of the agent response in bytes.

Returns:

  • (String) 


1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1517

class PayloadPart < Struct.new(
  :attribution,
  :bytes,
  :event_type)
  SENSITIVE = [:bytes]
  include Aws::Structure
end

#equals ⇒ Types::FilterAttribute

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value matches the value in this object are returned.

Returns:



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1893

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#failure_trace ⇒ Types::FailureTrace

Contains information about the failure of the interaction.

Returns:



2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2578

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

  class FailureTrace < Trace; end
  class OrchestrationTrace < Trace; end
  class PostProcessingTrace < Trace; end
  class PreProcessingTrace < Trace; end
  class Unknown < Trace; end
end

#function_invocation_input ⇒ Types::FunctionInvocationInput

Contains information about the function that the agent predicts should be called.

Returns:



918
919
920
921
922
923
924
925
926
927
928
929
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 918

class InvocationInputMember < Struct.new(
  :api_invocation_input,
  :function_invocation_input,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ApiInvocationInput < InvocationInputMember; end
  class FunctionInvocationInput < InvocationInputMember; end
  class Unknown < InvocationInputMember; end
end

#function_result ⇒ Types::FunctionResult

The result from the function from the action group invocation.

Returns:



959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 959

class InvocationResultMember < Struct.new(
  :api_result,
  :function_result,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ApiResult < InvocationResultMember; end
  class FunctionResult < InvocationResultMember; end
  class Unknown < InvocationResultMember; end
end

#greater_than ⇒ Types::FilterAttribute

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than the value in this object are returned.

Returns:



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1893

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#greater_than_or_equals ⇒ Types::FilterAttribute

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object are returned.

Returns:



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1893

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#in ⇒ Types::FilterAttribute

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object are returned.

Returns:



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1893

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#invocation_id ⇒ String

The identifier of the action group invocation.

Returns:

  • (String) 


2304
2305
2306
2307
2308
2309
2310
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2304

class ReturnControlPayload < Struct.new(
  :invocation_id,
  :invocation_inputs,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#invocation_input ⇒ Types::InvocationInput

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

Returns:



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1464

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

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

#invocation_inputs ⇒ Array<Types::InvocationInputMember>

A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.

Returns:



2304
2305
2306
2307
2308
2309
2310
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2304

class ReturnControlPayload < Struct.new(
  :invocation_id,
  :invocation_inputs,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#less_than ⇒ Types::FilterAttribute

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than the value in this object are returned.

Returns:



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1893

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#less_than_or_equals ⇒ Types::FilterAttribute

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object are returned.

Returns:



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1893

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#message ⇒ String

Returns:

  • (String) 


21
22
23
24
25
26
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 21

class AccessDeniedException < Struct.new(
  :message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#model_invocation_input ⇒ Types::ModelInvocationInput

The input for the pre-processing step.

  • The type is PRE_PROCESSING.

  • 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.

Returns:



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1464

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

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

#model_invocation_output ⇒ Types::PreProcessingModelInvocationOutput

The foundation model output from the pre-processing step.

Returns:



1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1587

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

  class ModelInvocationInput < PostProcessingTrace; end
  class ModelInvocationOutput < PostProcessingTrace; end
  class Unknown < PostProcessingTrace; end
end

#not_equals ⇒ Types::FilterAttribute

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.

Returns:



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1893

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#not_in ⇒ Types::FilterAttribute

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object are returned.

Returns:



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1893

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#observation ⇒ Types::Observation

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

Returns:



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1464

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

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

#or_all ⇒ Array<Types::RetrievalFilter>

Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.

Returns:



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1893

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class Unknown < RetrievalFilter; 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:



2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2578

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

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



2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2578

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

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



2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2578

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

  class FailureTrace < Trace; end
  class OrchestrationTrace < Trace; end
  class PostProcessingTrace < Trace; end
  class PreProcessingTrace < Trace; end
  class Unknown < Trace; end
end

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



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1464

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

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

#resource_name ⇒ String

The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.

Returns:

  • (String) 


282
283
284
285
286
287
288
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 282

class BadGatewayException < Struct.new(
  :message,
  :resource_name,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

The unique identifier of the session with the agent.

Returns:

  • (String) 


2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2635

class TracePart < Struct.new(
  :agent_alias_id,
  :agent_id,
  :agent_version,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:trace]
  include Aws::Structure
end

#starts_with ⇒ Types::FilterAttribute

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value starts with the value in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.

Returns:



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1893

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#trace ⇒ Types::Trace

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.

Returns:



2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2635

class TracePart < Struct.new(
  :agent_alias_id,
  :agent_id,
  :agent_version,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:trace]
  include Aws::Structure
end