Module: Aws::BedrockAgentRuntime::Types

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

Defined Under Namespace

Classes: APISchema, AccessDeniedException, ActionGroupExecutor, ActionGroupInvocationInput, ActionGroupInvocationOutput, AgentActionGroup, AgentCollaboratorInputPayload, AgentCollaboratorInvocationInput, AgentCollaboratorInvocationOutput, AgentCollaboratorOutputPayload, AnalyzePromptEvent, ApiInvocationInput, ApiParameter, ApiRequestBody, ApiResult, Attribution, AudioSegment, BadGatewayException, BedrockModelConfigurations, BedrockRerankingConfiguration, BedrockRerankingModelConfiguration, BedrockSessionContentBlock, ByteContentDoc, ByteContentFile, Caller, Citation, CitationEvent, CodeInterpreterInvocationInput, CodeInterpreterInvocationOutput, Collaborator, CollaboratorConfiguration, ConditionResultEvent, ConflictException, ContentBlock, ContentBody, ConversationHistory, CreateInvocationRequest, CreateInvocationResponse, CreateSessionRequest, CreateSessionResponse, CustomOrchestration, CustomOrchestrationTrace, CustomOrchestrationTraceEvent, DeleteAgentMemoryRequest, DeleteAgentMemoryResponse, DeleteSessionRequest, DeleteSessionResponse, DependencyFailedException, EndSessionRequest, EndSessionResponse, ExternalSource, ExternalSourcesGenerationConfiguration, ExternalSourcesRetrieveAndGenerateConfiguration, FailureTrace, FieldForReranking, FilePart, FileSource, FilterAttribute, FinalResponse, FlowCompletionEvent, FlowExecutionContent, FlowExecutionError, FlowExecutionEvent, FlowExecutionInputEvent, FlowExecutionOutputEvent, FlowExecutionSummary, FlowFailureEvent, FlowInput, FlowInputContent, FlowInputField, FlowMultiTurnInputContent, FlowMultiTurnInputRequestEvent, FlowOutputContent, FlowOutputEvent, FlowOutputField, FlowResponseStream, FlowTrace, FlowTraceCondition, FlowTraceConditionNodeResultEvent, FlowTraceDependencyEvent, FlowTraceEvent, FlowTraceNodeActionEvent, FlowTraceNodeInputContent, FlowTraceNodeInputEvent, FlowTraceNodeInputExecutionChainItem, FlowTraceNodeInputField, FlowTraceNodeInputSource, FlowTraceNodeOutputContent, FlowTraceNodeOutputEvent, FlowTraceNodeOutputField, FlowTraceNodeOutputNext, FunctionDefinition, FunctionInvocationInput, FunctionParameter, FunctionResult, FunctionSchema, GenerateQueryRequest, GenerateQueryResponse, GeneratedQuery, GeneratedResponsePart, GenerationConfiguration, GetAgentMemoryRequest, GetAgentMemoryResponse, GetExecutionFlowSnapshotRequest, GetExecutionFlowSnapshotResponse, GetFlowExecutionRequest, GetFlowExecutionResponse, GetInvocationStepRequest, GetInvocationStepResponse, GetSessionRequest, GetSessionResponse, GuardrailAssessment, GuardrailConfiguration, GuardrailConfigurationWithArn, GuardrailContentFilter, GuardrailContentPolicyAssessment, GuardrailCustomWord, GuardrailEvent, GuardrailManagedWord, GuardrailPiiEntityFilter, GuardrailRegexFilter, GuardrailSensitiveInformationPolicyAssessment, GuardrailTopic, GuardrailTopicPolicyAssessment, GuardrailTrace, GuardrailWordPolicyAssessment, ImageBlock, ImageInput, ImageInputSource, ImageSource, ImplicitFilterConfiguration, InferenceConfig, InferenceConfiguration, InlineAgentFilePart, InlineAgentPayloadPart, InlineAgentResponseStream, InlineAgentReturnControlPayload, InlineAgentTracePart, InlineBedrockModelConfigurations, InlineSessionState, InputFile, InputImage, InputPrompt, InternalServerException, InvocationInput, InvocationInputMember, InvocationResultMember, InvocationStep, InvocationStepPayload, InvocationStepSummary, InvocationSummary, InvokeAgentRequest, InvokeAgentResponse, InvokeFlowRequest, InvokeFlowResponse, InvokeInlineAgentRequest, InvokeInlineAgentResponse, KnowledgeBase, KnowledgeBaseConfiguration, KnowledgeBaseLookupInput, KnowledgeBaseLookupOutput, KnowledgeBaseQuery, KnowledgeBaseRetrievalConfiguration, KnowledgeBaseRetrievalResult, KnowledgeBaseRetrieveAndGenerateConfiguration, KnowledgeBaseVectorSearchConfiguration, ListFlowExecutionEventsRequest, ListFlowExecutionEventsResponse, ListFlowExecutionsRequest, ListFlowExecutionsResponse, ListInvocationStepsRequest, ListInvocationStepsResponse, ListInvocationsRequest, ListInvocationsResponse, ListSessionsRequest, ListSessionsResponse, ListTagsForResourceRequest, ListTagsForResourceResponse, Memory, MemorySessionSummary, Message, Metadata, MetadataAttributeSchema, MetadataConfigurationForReranking, ModelInvocationInput, ModelNotReadyException, ModelPerformanceConfiguration, NodeActionEvent, NodeDependencyEvent, NodeExecutionContent, NodeFailureEvent, NodeInputEvent, NodeInputExecutionChainItem, NodeInputField, NodeInputSource, NodeOutputEvent, NodeOutputField, NodeOutputNext, NodeTraceElements, Observation, OptimizePromptRequest, OptimizePromptResponse, OptimizedPrompt, OptimizedPromptEvent, OptimizedPromptStream, OrchestrationConfiguration, OrchestrationExecutor, OrchestrationModelInvocationOutput, OrchestrationTrace, OutputFile, Parameter, ParameterDetail, PayloadPart, PerformanceConfiguration, PostProcessingModelInvocationOutput, PostProcessingParsedResponse, PostProcessingTrace, PreProcessingModelInvocationOutput, PreProcessingParsedResponse, PreProcessingTrace, PromptConfiguration, PromptCreationConfigurations, PromptOverrideConfiguration, PromptTemplate, PropertyParameters, PutInvocationStepRequest, PutInvocationStepResponse, QueryGenerationInput, QueryTransformationConfiguration, Rationale, RawResponse, ReasoningContentBlock, ReasoningTextBlock, RepromptResponse, RequestBody, RerankDocument, RerankQuery, RerankRequest, RerankResponse, RerankResult, RerankSource, RerankTextDocument, RerankingConfiguration, RerankingMetadataSelectiveModeConfiguration, ResourceNotFoundException, ResponseStream, RetrievalFilter, RetrievalResultConfluenceLocation, RetrievalResultContent, RetrievalResultContentColumn, RetrievalResultCustomDocumentLocation, RetrievalResultKendraDocumentLocation, RetrievalResultLocation, RetrievalResultS3Location, RetrievalResultSalesforceLocation, RetrievalResultSharePointLocation, RetrievalResultSqlLocation, RetrievalResultWebLocation, RetrieveAndGenerateConfiguration, RetrieveAndGenerateInput, RetrieveAndGenerateOutput, RetrieveAndGenerateOutputEvent, RetrieveAndGenerateRequest, RetrieveAndGenerateResponse, RetrieveAndGenerateSessionConfiguration, RetrieveAndGenerateStreamRequest, RetrieveAndGenerateStreamResponse, RetrieveAndGenerateStreamResponseOutput, RetrieveRequest, RetrieveResponse, RetrievedReference, ReturnControlPayload, ReturnControlResults, RoutingClassifierModelInvocationOutput, RoutingClassifierTrace, S3Identifier, S3Location, S3ObjectDoc, S3ObjectFile, SatisfiedCondition, ServiceQuotaExceededException, SessionState, SessionSummary, Span, StartFlowExecutionRequest, StartFlowExecutionResponse, StopFlowExecutionRequest, StopFlowExecutionResponse, StreamingConfigurations, TagResourceRequest, TagResourceResponse, TextInferenceConfig, TextPrompt, TextResponsePart, TextToSqlConfiguration, TextToSqlKnowledgeBaseConfiguration, ThrottlingException, Trace, TraceElements, TracePart, TransformationConfiguration, UntagResourceRequest, UntagResourceResponse, UpdateSessionRequest, UpdateSessionResponse, Usage, ValidationException, VectorSearchBedrockRerankingConfiguration, VectorSearchBedrockRerankingModelConfiguration, VectorSearchRerankingConfiguration, VideoSegment

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

The guardrail action.

Returns:

  • (String) 


3397
3398
3399
3400
3401
3402
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3397

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

#agent_alias_arn ⇒ String

The caller's agent alias ARN.

Returns:

  • (String) 


805
806
807
808
809
810
811
812
813
814
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 805

class Caller < Struct.new(
  :agent_alias_arn,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AgentAliasArn < Caller; end
  class Unknown < Caller; end
end

#agent_alias_id ⇒ String

The unique identifier of the alias of the agent.

Returns:

  • (String) 


8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8930

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

#agent_id ⇒ String

The unique identifier of the agent.

Returns:

  • (String) 


8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8930

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

#agent_traces ⇒ Array<Types::TracePart>

Agent trace information for the flow execution.

Returns:



5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 5998

class NodeTraceElements < Struct.new(
  :agent_traces,
  :unknown)
  SENSITIVE = [:agent_traces]
  include Aws::Structure
  include Aws::Structure::Union

  class AgentTraces < NodeTraceElements; end
  class Unknown < NodeTraceElements; end
end

#agent_version ⇒ String

The version of the agent.

Returns:

  • (String) 


8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8930

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

#and_all ⇒ Array<Types::RetrievalFilter>

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

Returns:



7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7433

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  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 ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < 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:



4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4156

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:



4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4199

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:



3816
3817
3818
3819
3820
3821
3822
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3816

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

#bytes ⇒ String

A part of the agent response in bytes.

Returns:

  • (String) 


3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3654

class ImageInputSource < Struct.new(
  :bytes,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Bytes < ImageInputSource; end
  class Unknown < ImageInputSource; end
end

#caller_chain ⇒ Array<Types::Caller>

The part's caller chain.

Returns:



3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3893

class InlineAgentTracePart < Struct.new(
  :caller_chain,
  :collaborator_name,
  :event_time,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:collaborator_name, :trace]
  include Aws::Structure
end

#citation ⇒ Types::Citation

The citation.

Returns:



865
866
867
868
869
870
871
872
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 865

class CitationEvent < Struct.new(
  :citation,
  :generated_response_part,
  :retrieved_references,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#collaborator_name ⇒ String

The part's collaborator name.

Returns:

  • (String) 


3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3893

class InlineAgentTracePart < Struct.new(
  :caller_chain,
  :collaborator_name,
  :event_time,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:collaborator_name, :trace]
  include Aws::Structure
end

#completion_reason ⇒ String

The reason that the flow completed.

Returns:

  • (String) 


1657
1658
1659
1660
1661
1662
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1657

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

#condition_node_result_trace ⇒ Types::FlowTraceConditionNodeResultEvent

Contains information about an output from a condition node.

Returns:



2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2186

class FlowTrace < Struct.new(
  :condition_node_result_trace,
  :node_action_trace,
  :node_dependency_trace,
  :node_input_trace,
  :node_output_trace,
  :unknown)
  SENSITIVE = [:condition_node_result_trace, :node_action_trace, :node_dependency_trace, :node_input_trace, :node_output_trace]
  include Aws::Structure
  include Aws::Structure::Union

  class ConditionNodeResultTrace < FlowTrace; end
  class NodeActionTrace < FlowTrace; end
  class NodeDependencyTrace < FlowTrace; end
  class NodeInputTrace < FlowTrace; end
  class NodeOutputTrace < FlowTrace; end
  class Unknown < FlowTrace; end
end

#condition_result_event ⇒ Types::ConditionResultEvent

Contains information about a condition evaluation result during the flow execution. This event is generated when a condition node in the flow evaluates its conditions.

Returns:



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1782

class FlowExecutionEvent < Struct.new(
  :condition_result_event,
  :flow_failure_event,
  :flow_input_event,
  :flow_output_event,
  :node_action_event,
  :node_dependency_event,
  :node_failure_event,
  :node_input_event,
  :node_output_event,
  :unknown)
  SENSITIVE = [:condition_result_event, :flow_failure_event, :flow_input_event, :flow_output_event, :node_action_event, :node_dependency_event, :node_failure_event, :node_input_event, :node_output_event]
  include Aws::Structure
  include Aws::Structure::Union

  class ConditionResultEvent < FlowExecutionEvent; end
  class FlowFailureEvent < FlowExecutionEvent; end
  class FlowInputEvent < FlowExecutionEvent; end
  class FlowOutputEvent < FlowExecutionEvent; end
  class NodeActionEvent < FlowExecutionEvent; end
  class NodeDependencyEvent < FlowExecutionEvent; end
  class NodeFailureEvent < FlowExecutionEvent; end
  class NodeInputEvent < FlowExecutionEvent; end
  class NodeOutputEvent < FlowExecutionEvent; end
  class Unknown < FlowExecutionEvent; end
end

#content ⇒ Types::FlowOutputContent

The content in the output.

Returns:



2072
2073
2074
2075
2076
2077
2078
2079
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2072

class FlowMultiTurnInputRequestEvent < Struct.new(
  :content,
  :node_name,
  :node_type,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#content_blocks ⇒ Array<Types::BedrockSessionContentBlock>

The content for the invocation step.

Returns:



4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4266

class InvocationStepPayload < Struct.new(
  :content_blocks,
  :unknown)
  SENSITIVE = [:content_blocks]
  include Aws::Structure
  include Aws::Structure::Union

  class ContentBlocks < InvocationStepPayload; end
  class Unknown < InvocationStepPayload; end
end

#custom_control ⇒ String

To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL.

Returns:

  • (String) 


83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 83

class ActionGroupExecutor < Struct.new(
  :custom_control,
  :lambda,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class CustomControl < ActionGroupExecutor; end
  class Lambda < ActionGroupExecutor; end
  class Unknown < ActionGroupExecutor; end
end

#custom_orchestration_trace ⇒ Types::CustomOrchestrationTrace

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

Returns:



8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8834

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

#document ⇒ Hash, ...

The document content of the field, which can contain text or structured data.

Returns:

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


1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1680

class FlowExecutionContent < Struct.new(
  :document,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Document < FlowExecutionContent; end
  class Unknown < FlowExecutionContent; end
end

#equals ⇒ Types::FilterAttribute

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

The following example would return data sources with an animal attribute whose value is cat:

"equals": { "key": "animal", "value": "cat" }

Returns:



7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7433

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  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 ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#event_time ⇒ Time

The time of the trace.

Returns:

  • (Time) 


3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3893

class InlineAgentTracePart < Struct.new(
  :caller_chain,
  :collaborator_name,
  :event_time,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:collaborator_name, :trace]
  include Aws::Structure
end

#failure_trace ⇒ Types::FailureTrace

Contains information about the failure of the interaction.

Returns:



8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8834

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

#fields_to_exclude ⇒ Array<Types::FieldForReranking>

An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.

Returns:



7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7239

class RerankingMetadataSelectiveModeConfiguration < Struct.new(
  :fields_to_exclude,
  :fields_to_include,
  :unknown)
  SENSITIVE = [:fields_to_exclude, :fields_to_include]
  include Aws::Structure
  include Aws::Structure::Union

  class FieldsToExclude < RerankingMetadataSelectiveModeConfiguration; end
  class FieldsToInclude < RerankingMetadataSelectiveModeConfiguration; end
  class Unknown < RerankingMetadataSelectiveModeConfiguration; end
end

#fields_to_include ⇒ Array<Types::FieldForReranking>

An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.

Returns:



7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7239

class RerankingMetadataSelectiveModeConfiguration < Struct.new(
  :fields_to_exclude,
  :fields_to_include,
  :unknown)
  SENSITIVE = [:fields_to_exclude, :fields_to_include]
  include Aws::Structure
  include Aws::Structure::Union

  class FieldsToExclude < RerankingMetadataSelectiveModeConfiguration; end
  class FieldsToInclude < RerankingMetadataSelectiveModeConfiguration; end
  class Unknown < RerankingMetadataSelectiveModeConfiguration; end
end

#files ⇒ Array<Types::OutputFile>

Files containing intermediate response for the user.

Returns:



1567
1568
1569
1570
1571
1572
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1567

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

#flow_failure_event ⇒ Types::FlowFailureEvent

Contains information about a failure that occurred at the flow level during execution.

Returns:



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1782

class FlowExecutionEvent < Struct.new(
  :condition_result_event,
  :flow_failure_event,
  :flow_input_event,
  :flow_output_event,
  :node_action_event,
  :node_dependency_event,
  :node_failure_event,
  :node_input_event,
  :node_output_event,
  :unknown)
  SENSITIVE = [:condition_result_event, :flow_failure_event, :flow_input_event, :flow_output_event, :node_action_event, :node_dependency_event, :node_failure_event, :node_input_event, :node_output_event]
  include Aws::Structure
  include Aws::Structure::Union

  class ConditionResultEvent < FlowExecutionEvent; end
  class FlowFailureEvent < FlowExecutionEvent; end
  class FlowInputEvent < FlowExecutionEvent; end
  class FlowOutputEvent < FlowExecutionEvent; end
  class NodeActionEvent < FlowExecutionEvent; end
  class NodeDependencyEvent < FlowExecutionEvent; end
  class NodeFailureEvent < FlowExecutionEvent; end
  class NodeInputEvent < FlowExecutionEvent; end
  class NodeOutputEvent < FlowExecutionEvent; end
  class Unknown < FlowExecutionEvent; end
end

#flow_input_event ⇒ Types::FlowExecutionInputEvent

Contains information about the inputs provided to the flow at the start of execution.

Returns:



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1782

class FlowExecutionEvent < Struct.new(
  :condition_result_event,
  :flow_failure_event,
  :flow_input_event,
  :flow_output_event,
  :node_action_event,
  :node_dependency_event,
  :node_failure_event,
  :node_input_event,
  :node_output_event,
  :unknown)
  SENSITIVE = [:condition_result_event, :flow_failure_event, :flow_input_event, :flow_output_event, :node_action_event, :node_dependency_event, :node_failure_event, :node_input_event, :node_output_event]
  include Aws::Structure
  include Aws::Structure::Union

  class ConditionResultEvent < FlowExecutionEvent; end
  class FlowFailureEvent < FlowExecutionEvent; end
  class FlowInputEvent < FlowExecutionEvent; end
  class FlowOutputEvent < FlowExecutionEvent; end
  class NodeActionEvent < FlowExecutionEvent; end
  class NodeDependencyEvent < FlowExecutionEvent; end
  class NodeFailureEvent < FlowExecutionEvent; end
  class NodeInputEvent < FlowExecutionEvent; end
  class NodeOutputEvent < FlowExecutionEvent; end
  class Unknown < FlowExecutionEvent; end
end

#flow_output_event ⇒ Types::FlowExecutionOutputEvent

Contains information about the outputs produced by the flow at the end of execution.

Returns:



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1782

class FlowExecutionEvent < Struct.new(
  :condition_result_event,
  :flow_failure_event,
  :flow_input_event,
  :flow_output_event,
  :node_action_event,
  :node_dependency_event,
  :node_failure_event,
  :node_input_event,
  :node_output_event,
  :unknown)
  SENSITIVE = [:condition_result_event, :flow_failure_event, :flow_input_event, :flow_output_event, :node_action_event, :node_dependency_event, :node_failure_event, :node_input_event, :node_output_event]
  include Aws::Structure
  include Aws::Structure::Union

  class ConditionResultEvent < FlowExecutionEvent; end
  class FlowFailureEvent < FlowExecutionEvent; end
  class FlowInputEvent < FlowExecutionEvent; end
  class FlowOutputEvent < FlowExecutionEvent; end
  class NodeActionEvent < FlowExecutionEvent; end
  class NodeDependencyEvent < FlowExecutionEvent; end
  class NodeFailureEvent < FlowExecutionEvent; end
  class NodeInputEvent < FlowExecutionEvent; end
  class NodeOutputEvent < FlowExecutionEvent; end
  class Unknown < FlowExecutionEvent; end
end

#function_invocation_input ⇒ Types::FunctionInvocationInput

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

Returns:



4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4156

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:



4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4199

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

#functions ⇒ Array<Types::FunctionDefinition>

A list of functions that each define an action in the action group.

Returns:



2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2809

class FunctionSchema < Struct.new(
  :functions,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Functions < FunctionSchema; end
  class Unknown < FunctionSchema; end
end

#generated_response_part ⇒ Types::GeneratedResponsePart

The generated response to the citation event.

Returns:



865
866
867
868
869
870
871
872
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 865

class CitationEvent < Struct.new(
  :citation,
  :generated_response_part,
  :retrieved_references,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#greater_than ⇒ Types::FilterAttribute

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

The following example would return data sources with an year attribute whose value is greater than 1989:

"greaterThan": { "key": "year", "value": 1989 }

Returns:



7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7433

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  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 ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#greater_than_or_equals ⇒ Types::FilterAttribute

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

The following example would return data sources with an year attribute whose value is greater than or equal to 1989:

"greaterThanOrEquals": { "key": "year", "value": 1989 }

Returns:



7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7433

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  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 ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#guardrail_trace ⇒ Types::GuardrailTrace

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

Returns:



8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8834

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

#image ⇒ Types::ImageBlock

The image in the invocation step.

Returns:



736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 736

class BedrockSessionContentBlock < Struct.new(
  :image,
  :text,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Image < BedrockSessionContentBlock; end
  class Text < BedrockSessionContentBlock; end
  class Unknown < BedrockSessionContentBlock; end
end

#in ⇒ Types::FilterAttribute

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

The following example would return data sources with an animal attribute that is either cat or dog:

"in": { "key": "animal", "value": ["cat", "dog"] }

Returns:



7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7433

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  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 ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#invocation_id ⇒ String

The identifier of the action group invocation.

Returns:

  • (String) 


3845
3846
3847
3848
3849
3850
3851
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3845

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

#invocation_input ⇒ Types::InvocationInput

The classifier's invocation input.

Returns:



6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6290

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

  class InvocationInput < OrchestrationTrace; end
  class ModelInvocationInput < OrchestrationTrace; end
  class ModelInvocationOutput < 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:



3845
3846
3847
3848
3849
3850
3851
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3845

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

#lambda ⇒ String

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

Returns:

  • (String) 


83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 83

class ActionGroupExecutor < Struct.new(
  :custom_control,
  :lambda,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class CustomControl < ActionGroupExecutor; end
  class Lambda < ActionGroupExecutor; end
  class Unknown < ActionGroupExecutor; end
end

#less_than ⇒ Types::FilterAttribute

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

The following example would return data sources with an year attribute whose value is less than to 1989.

"lessThan": { "key": "year", "value": 1989 }

Returns:



7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7433

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  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 ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#less_than_or_equals ⇒ Types::FilterAttribute

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

The following example would return data sources with an year attribute whose value is less than or equal to 1989.

"lessThanOrEquals": { "key": "year", "value": 1989 }

Returns:



7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7433

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  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 ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#list_contains ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.

The following example would return data sources with an animals attribute that is a list containing a cat member (for example ["dog", "cat"]).

"listContains": { "key": "animals", "value": "cat" }

Returns:



7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7433

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  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 ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#message ⇒ String

Returns:

  • (String) 


58
59
60
61
62
63
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 58

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

#model_invocation_input ⇒ Types::ModelInvocationInput

The classifier's model invocation input.

Returns:



6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6290

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

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

#model_invocation_output ⇒ Types::RoutingClassifierModelInvocationOutput

The classifier's model invocation output.

Returns:



6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6290

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

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

#node_action_event ⇒ Types::NodeActionEvent

Contains information about an action (operation) called by a node during execution.

Returns:



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1782

class FlowExecutionEvent < Struct.new(
  :condition_result_event,
  :flow_failure_event,
  :flow_input_event,
  :flow_output_event,
  :node_action_event,
  :node_dependency_event,
  :node_failure_event,
  :node_input_event,
  :node_output_event,
  :unknown)
  SENSITIVE = [:condition_result_event, :flow_failure_event, :flow_input_event, :flow_output_event, :node_action_event, :node_dependency_event, :node_failure_event, :node_input_event, :node_output_event]
  include Aws::Structure
  include Aws::Structure::Union

  class ConditionResultEvent < FlowExecutionEvent; end
  class FlowFailureEvent < FlowExecutionEvent; end
  class FlowInputEvent < FlowExecutionEvent; end
  class FlowOutputEvent < FlowExecutionEvent; end
  class NodeActionEvent < FlowExecutionEvent; end
  class NodeDependencyEvent < FlowExecutionEvent; end
  class NodeFailureEvent < FlowExecutionEvent; end
  class NodeInputEvent < FlowExecutionEvent; end
  class NodeOutputEvent < FlowExecutionEvent; end
  class Unknown < FlowExecutionEvent; end
end

#node_action_trace ⇒ Types::FlowTraceNodeActionEvent

Contains information about an action (operation) called by a node.

Returns:



2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2186

class FlowTrace < Struct.new(
  :condition_node_result_trace,
  :node_action_trace,
  :node_dependency_trace,
  :node_input_trace,
  :node_output_trace,
  :unknown)
  SENSITIVE = [:condition_node_result_trace, :node_action_trace, :node_dependency_trace, :node_input_trace, :node_output_trace]
  include Aws::Structure
  include Aws::Structure::Union

  class ConditionNodeResultTrace < FlowTrace; end
  class NodeActionTrace < FlowTrace; end
  class NodeDependencyTrace < FlowTrace; end
  class NodeInputTrace < FlowTrace; end
  class NodeOutputTrace < FlowTrace; end
  class Unknown < FlowTrace; end
end

#node_dependency_event ⇒ Types::NodeDependencyEvent

Contains information about an internal trace of a specific node during execution.

Returns:



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1782

class FlowExecutionEvent < Struct.new(
  :condition_result_event,
  :flow_failure_event,
  :flow_input_event,
  :flow_output_event,
  :node_action_event,
  :node_dependency_event,
  :node_failure_event,
  :node_input_event,
  :node_output_event,
  :unknown)
  SENSITIVE = [:condition_result_event, :flow_failure_event, :flow_input_event, :flow_output_event, :node_action_event, :node_dependency_event, :node_failure_event, :node_input_event, :node_output_event]
  include Aws::Structure
  include Aws::Structure::Union

  class ConditionResultEvent < FlowExecutionEvent; end
  class FlowFailureEvent < FlowExecutionEvent; end
  class FlowInputEvent < FlowExecutionEvent; end
  class FlowOutputEvent < FlowExecutionEvent; end
  class NodeActionEvent < FlowExecutionEvent; end
  class NodeDependencyEvent < FlowExecutionEvent; end
  class NodeFailureEvent < FlowExecutionEvent; end
  class NodeInputEvent < FlowExecutionEvent; end
  class NodeOutputEvent < FlowExecutionEvent; end
  class Unknown < FlowExecutionEvent; end
end

#node_dependency_trace ⇒ Types::FlowTraceDependencyEvent

Contains information about an internal trace of a node.

Returns:



2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2186

class FlowTrace < Struct.new(
  :condition_node_result_trace,
  :node_action_trace,
  :node_dependency_trace,
  :node_input_trace,
  :node_output_trace,
  :unknown)
  SENSITIVE = [:condition_node_result_trace, :node_action_trace, :node_dependency_trace, :node_input_trace, :node_output_trace]
  include Aws::Structure
  include Aws::Structure::Union

  class ConditionNodeResultTrace < FlowTrace; end
  class NodeActionTrace < FlowTrace; end
  class NodeDependencyTrace < FlowTrace; end
  class NodeInputTrace < FlowTrace; end
  class NodeOutputTrace < FlowTrace; end
  class Unknown < FlowTrace; end
end

#node_failure_event ⇒ Types::NodeFailureEvent

Contains information about a failure that occurred at a specific node during execution.

Returns:



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1782

class FlowExecutionEvent < Struct.new(
  :condition_result_event,
  :flow_failure_event,
  :flow_input_event,
  :flow_output_event,
  :node_action_event,
  :node_dependency_event,
  :node_failure_event,
  :node_input_event,
  :node_output_event,
  :unknown)
  SENSITIVE = [:condition_result_event, :flow_failure_event, :flow_input_event, :flow_output_event, :node_action_event, :node_dependency_event, :node_failure_event, :node_input_event, :node_output_event]
  include Aws::Structure
  include Aws::Structure::Union

  class ConditionResultEvent < FlowExecutionEvent; end
  class FlowFailureEvent < FlowExecutionEvent; end
  class FlowInputEvent < FlowExecutionEvent; end
  class FlowOutputEvent < FlowExecutionEvent; end
  class NodeActionEvent < FlowExecutionEvent; end
  class NodeDependencyEvent < FlowExecutionEvent; end
  class NodeFailureEvent < FlowExecutionEvent; end
  class NodeInputEvent < FlowExecutionEvent; end
  class NodeOutputEvent < FlowExecutionEvent; end
  class Unknown < FlowExecutionEvent; end
end

#node_input_event ⇒ Types::NodeInputEvent

Contains information about the inputs provided to a specific node during execution.

Returns:



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1782

class FlowExecutionEvent < Struct.new(
  :condition_result_event,
  :flow_failure_event,
  :flow_input_event,
  :flow_output_event,
  :node_action_event,
  :node_dependency_event,
  :node_failure_event,
  :node_input_event,
  :node_output_event,
  :unknown)
  SENSITIVE = [:condition_result_event, :flow_failure_event, :flow_input_event, :flow_output_event, :node_action_event, :node_dependency_event, :node_failure_event, :node_input_event, :node_output_event]
  include Aws::Structure
  include Aws::Structure::Union

  class ConditionResultEvent < FlowExecutionEvent; end
  class FlowFailureEvent < FlowExecutionEvent; end
  class FlowInputEvent < FlowExecutionEvent; end
  class FlowOutputEvent < FlowExecutionEvent; end
  class NodeActionEvent < FlowExecutionEvent; end
  class NodeDependencyEvent < FlowExecutionEvent; end
  class NodeFailureEvent < FlowExecutionEvent; end
  class NodeInputEvent < FlowExecutionEvent; end
  class NodeOutputEvent < FlowExecutionEvent; end
  class Unknown < FlowExecutionEvent; end
end

#node_input_trace ⇒ Types::FlowTraceNodeInputEvent

Contains information about the input into a node.

Returns:



2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2186

class FlowTrace < Struct.new(
  :condition_node_result_trace,
  :node_action_trace,
  :node_dependency_trace,
  :node_input_trace,
  :node_output_trace,
  :unknown)
  SENSITIVE = [:condition_node_result_trace, :node_action_trace, :node_dependency_trace, :node_input_trace, :node_output_trace]
  include Aws::Structure
  include Aws::Structure::Union

  class ConditionNodeResultTrace < FlowTrace; end
  class NodeActionTrace < FlowTrace; end
  class NodeDependencyTrace < FlowTrace; end
  class NodeInputTrace < FlowTrace; end
  class NodeOutputTrace < FlowTrace; end
  class Unknown < FlowTrace; end
end

#node_name ⇒ String

The name of the flow output node that the output is from.

Returns:

  • (String) 


2072
2073
2074
2075
2076
2077
2078
2079
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2072

class FlowMultiTurnInputRequestEvent < Struct.new(
  :content,
  :node_name,
  :node_type,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#node_output_event ⇒ Types::NodeOutputEvent

Contains information about the outputs produced by a specific node during execution.

Returns:



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1782

class FlowExecutionEvent < Struct.new(
  :condition_result_event,
  :flow_failure_event,
  :flow_input_event,
  :flow_output_event,
  :node_action_event,
  :node_dependency_event,
  :node_failure_event,
  :node_input_event,
  :node_output_event,
  :unknown)
  SENSITIVE = [:condition_result_event, :flow_failure_event, :flow_input_event, :flow_output_event, :node_action_event, :node_dependency_event, :node_failure_event, :node_input_event, :node_output_event]
  include Aws::Structure
  include Aws::Structure::Union

  class ConditionResultEvent < FlowExecutionEvent; end
  class FlowFailureEvent < FlowExecutionEvent; end
  class FlowInputEvent < FlowExecutionEvent; end
  class FlowOutputEvent < FlowExecutionEvent; end
  class NodeActionEvent < FlowExecutionEvent; end
  class NodeDependencyEvent < FlowExecutionEvent; end
  class NodeFailureEvent < FlowExecutionEvent; end
  class NodeInputEvent < FlowExecutionEvent; end
  class NodeOutputEvent < FlowExecutionEvent; end
  class Unknown < FlowExecutionEvent; end
end

#node_output_trace ⇒ Types::FlowTraceNodeOutputEvent

Contains information about the output from a node.

Returns:



2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2186

class FlowTrace < Struct.new(
  :condition_node_result_trace,
  :node_action_trace,
  :node_dependency_trace,
  :node_input_trace,
  :node_output_trace,
  :unknown)
  SENSITIVE = [:condition_node_result_trace, :node_action_trace, :node_dependency_trace, :node_input_trace, :node_output_trace]
  include Aws::Structure
  include Aws::Structure::Union

  class ConditionNodeResultTrace < FlowTrace; end
  class NodeActionTrace < FlowTrace; end
  class NodeDependencyTrace < FlowTrace; end
  class NodeInputTrace < FlowTrace; end
  class NodeOutputTrace < FlowTrace; end
  class Unknown < FlowTrace; end
end

#node_type ⇒ String

The type of the node that the output is from.

Returns:

  • (String) 


2072
2073
2074
2075
2076
2077
2078
2079
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2072

class FlowMultiTurnInputRequestEvent < Struct.new(
  :content,
  :node_name,
  :node_type,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#not_equals ⇒ Types::FilterAttribute

Knowledge base data sources are returned when:

  • It contains a metadata attribute whose name matches the key and whose value doesn't match the value in this object.

  • The key is not present in the document.

The following example would return data sources that don't contain an animal attribute whose value is cat.

"notEquals": { "key": "animal", "value": "cat" }

Returns:



7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7433

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  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 ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#not_in ⇒ Types::FilterAttribute

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

The following example would return data sources whose animal attribute is neither cat nor dog.

"notIn": { "key": "animal", "value": ["cat", "dog"] }

Returns:



7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7433

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  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 ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#observation ⇒ Types::Observation

The classifier's observation.

Returns:



6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6290

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

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

#optimized_prompt ⇒ Types::OptimizedPrompt

Contains information about the optimized prompt.

Returns:



6136
6137
6138
6139
6140
6141
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6136

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

#or_all ⇒ Array<Types::RetrievalFilter>

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

Returns:



7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7433

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  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 ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < 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:



8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8834

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

#payload ⇒ String

The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.

Returns:

  • (String) 


37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 37

class APISchema < Struct.new(
  :payload,
  :s3,
  :unknown)
  SENSITIVE = [:payload]
  include Aws::Structure
  include Aws::Structure::Union

  class Payload < APISchema; end
  class S3 < APISchema; end
  class Unknown < APISchema; end
end

#post_processing_trace ⇒ Types::PostProcessingTrace

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

Returns:



8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8834

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:



8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8834

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

#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:



6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6290

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

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

#reason ⇒ String

The reason for the exception. If the reason is BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE, the model invocation service is unavailable. Retry your request.

Returns:

  • (String) 


4079
4080
4081
4082
4083
4084
4085
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4079

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

#reasoning_text ⇒ Types::ReasoningTextBlock

Contains information about the reasoning that the model used to return the content in the content block.

Returns:



6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6975

class ReasoningContentBlock < Struct.new(
  :reasoning_text,
  :redacted_content,
  :unknown)
  SENSITIVE = [:reasoning_text]
  include Aws::Structure
  include Aws::Structure::Union

  class ReasoningText < ReasoningContentBlock; end
  class RedactedContent < ReasoningContentBlock; end
  class Unknown < ReasoningContentBlock; end
end

#redacted_content ⇒ String

The content in the reasoning that was encrypted by the model provider for trust and safety reasons.

Returns:

  • (String) 


6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6975

class ReasoningContentBlock < Struct.new(
  :reasoning_text,
  :redacted_content,
  :unknown)
  SENSITIVE = [:reasoning_text]
  include Aws::Structure
  include Aws::Structure::Union

  class ReasoningText < ReasoningContentBlock; end
  class RedactedContent < ReasoningContentBlock; end
  class Unknown < ReasoningContentBlock; end
end

#resource_name ⇒ String

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

Returns:

  • (String) 


647
648
649
650
651
652
653
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 647

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

#retrieved_references ⇒ Array<Types::RetrievedReference>

The retrieved references of the citation event.

Returns:



865
866
867
868
869
870
871
872
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 865

class CitationEvent < Struct.new(
  :citation,
  :generated_response_part,
  :retrieved_references,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#routing_classifier_trace ⇒ Types::RoutingClassifierTrace

A routing classifier's trace.

Returns:



8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8834

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

#s3 ⇒ Types::S3Identifier

Contains details about the S3 object containing the OpenAPI schema for the action group.

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 37

class APISchema < Struct.new(
  :payload,
  :s3,
  :unknown)
  SENSITIVE = [:payload]
  include Aws::Structure
  include Aws::Structure::Union

  class Payload < APISchema; end
  class S3 < APISchema; end
  class Unknown < APISchema; end
end

#s3_location ⇒ Types::S3Location

The path to the Amazon S3 bucket where the image is stored.

Returns:



3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3682

class ImageSource < Struct.new(
  :bytes,
  :s3_location,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Bytes < ImageSource; end
  class S3Location < ImageSource; end
  class Unknown < ImageSource; end
end

#session_id ⇒ String

The unique identifier of the session with the agent.

Returns:

  • (String) 


3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3893

class InlineAgentTracePart < Struct.new(
  :caller_chain,
  :collaborator_name,
  :event_time,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:collaborator_name, :trace]
  include Aws::Structure
end

#session_summary ⇒ Types::MemorySessionSummary

Contains summary of a session.

Returns:



5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 5373

class Memory < Struct.new(
  :session_summary,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class SessionSummary < Memory; end
  class Unknown < Memory; end
end

#starts_with ⇒ Types::FilterAttribute

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

The following example would return data sources with an animal attribute starts with ca (for example, cat or camel).

"startsWith": { "key": "animal", "value": "ca" }

Returns:



7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7433

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  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 ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#string_contains ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:

  • A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example cat).

    "stringContains": { "key": "animal", "value": "at" }

  • A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example ["dog", "cat"]).

    "stringContains": { "key": "animals", "value": "at" }

Returns:



7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7433

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  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 ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#text ⇒ String

A text response.

Returns:

  • (String) 


736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 736

class BedrockSessionContentBlock < Struct.new(
  :image,
  :text,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Image < BedrockSessionContentBlock; end
  class Text < BedrockSessionContentBlock; end
  class Unknown < BedrockSessionContentBlock; end
end

#text_prompt ⇒ Types::TextPrompt

Contains information about the text in the prompt that was optimized.

Returns:



4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4055

class InputPrompt < Struct.new(
  :text_prompt,
  :unknown)
  SENSITIVE = [:text_prompt]
  include Aws::Structure
  include Aws::Structure::Union

  class TextPrompt < InputPrompt; end
  class Unknown < InputPrompt; 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:



2296
2297
2298
2299
2300
2301
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2296

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