Module: Aws::BedrockAgentRuntime::Types

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

Defined Under Namespace

Classes: APISchema, AccessDeniedException, ActionGroupExecutor, ActionGroupInvocationInput, ActionGroupInvocationOutput, AgentActionGroup, AgentCollaboratorInputPayload, AgentCollaboratorInvocationInput, AgentCollaboratorInvocationOutput, AgentCollaboratorOutputPayload, AgenticRetrieveAction, AgenticRetrieveActionDetails, AgenticRetrieveBedrockGuardrailConfiguration, AgenticRetrieveBedrockRerankingConfiguration, AgenticRetrieveBedrockRerankingModelConfiguration, AgenticRetrieveCitation, AgenticRetrieveCitationReference, AgenticRetrieveConfiguration, AgenticRetrieveFailure, AgenticRetrieveFullDocExpansionDetails, AgenticRetrieveGeneratedResponse, AgenticRetrieveGuardrailWarning, AgenticRetrieveMessage, AgenticRetrieveMessageContent, AgenticRetrievePolicyConfiguration, AgenticRetrieveRerankingConfiguration, AgenticRetrieveResponseEvent, AgenticRetrieveResultEvent, AgenticRetrieveResultItem, AgenticRetrieveSourceMetadata, AgenticRetrieveSourceRetriever, AgenticRetrieveStreamRequest, AgenticRetrieveStreamResponse, AgenticRetrieveStreamResponseOutput, AgenticRetrieveTraceEvent, AgenticRetrieveTraceEventAttributes, AgenticRetrieveTraceResultItem, AgenticRetrieveWarning, AgenticRetrieveWarningMessage, AgenticRetriever, AnalyzePromptEvent, ApiInvocationInput, ApiParameter, ApiRequestBody, ApiResult, Attribution, AudioSegment, BadGatewayException, BedrockFoundationModelConfiguration, BedrockFoundationModelModelConfiguration, 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, FoundationModelConfiguration, FunctionDefinition, FunctionInvocationInput, FunctionParameter, FunctionResult, FunctionSchema, GenerateQueryRequest, GenerateQueryResponse, GeneratedQuery, GeneratedResponsePart, GenerationConfiguration, GetAgentMemoryRequest, GetAgentMemoryResponse, GetDocumentContentRequest, GetDocumentContentResponse, 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, KnowledgeBaseRetrieverConfiguration, KnowledgeBaseVectorSearchConfiguration, ListFlowExecutionEventsRequest, ListFlowExecutionEventsResponse, ListFlowExecutionsRequest, ListFlowExecutionsResponse, ListInvocationStepsRequest, ListInvocationStepsResponse, ListInvocationsRequest, ListInvocationsResponse, ListSessionsRequest, ListSessionsResponse, ListTagsForResourceRequest, ListTagsForResourceResponse, ManagedSearchBedrockRerankingConfiguration, ManagedSearchBedrockRerankingModelConfiguration, ManagedSearchConfiguration, ManagedSearchRerankingConfiguration, 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, RetrievalContent, RetrievalFilter, RetrievalOverrides, RetrievalResultConfluenceLocation, RetrievalResultContent, RetrievalResultContentColumn, RetrievalResultCustomDocumentLocation, RetrievalResultGoogleDriveLocation, RetrievalResultKendraDocumentLocation, RetrievalResultLocation, RetrievalResultOneDriveLocation, RetrievalResultS3Location, RetrievalResultSalesforceLocation, RetrievalResultSharePointLocation, RetrievalResultSqlLocation, RetrievalResultWebLocation, RetrieveAndGenerateConfiguration, RetrieveAndGenerateInput, RetrieveAndGenerateOutput, RetrieveAndGenerateOutputEvent, RetrieveAndGenerateRequest, RetrieveAndGenerateResponse, RetrieveAndGenerateSessionConfiguration, RetrieveAndGenerateStreamRequest, RetrieveAndGenerateStreamResponse, RetrieveAndGenerateStreamResponseOutput, RetrieveRequest, RetrieveResponse, RetrievedReference, RetrieverConfiguration, 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, UserContext, ValidationException, VectorSearchBedrockRerankingConfiguration, VectorSearchBedrockRerankingModelConfiguration, VectorSearchRerankingConfiguration, VideoSegment

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

The guardrail action.

Returns:

  • (String) 


4136
4137
4138
4139
4140
4141
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4136

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

#agent_alias_arn ⇒ String

The caller’s agent alias ARN.

Returns:

  • (String) 


1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 1461

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) 


9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9943

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) 


9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9943

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:



6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 6884

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) 


9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9943

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:



8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8343

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:



4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4895

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:



4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4938

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

#attributes ⇒ Types::AgenticRetrieveTraceEventAttributes

The attributes describing the trace event details.

Returns:



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

class AgenticRetrieveTraceEvent < Struct.new(
  :attributes,
  :id,
  :timestamp,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#attribution ⇒ Types::Attribution

Contains citations for a part of an agent response.

Returns:



4555
4556
4557
4558
4559
4560
4561
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4555

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) 


4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4393

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:



4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4632

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:



1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 1521

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) 


4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4632

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) 


2313
2314
2315
2316
2317
2318
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2313

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:



2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2842

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:



2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2438

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:



2728
2729
2730
2731
2732
2733
2734
2735
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2728

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:



5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 5005

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



9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9847

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) 


2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2336

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:



8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8343

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) 


4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4632

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:



9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9847

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:



8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8125

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:



8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8125

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:



2223
2224
2225
2226
2227
2228
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2223

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:



2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2438

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:



2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2438

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:



2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2438

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:



4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4895

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:



4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4938

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:



3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 3484

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 ⇒ Types::AgenticRetrieveGeneratedResponse

The generated response. Present only when generateResponse is true.

Returns:



725
726
727
728
729
730
731
732
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 725

class AgenticRetrieveResultEvent < Struct.new(
  :generated_response,
  :next_token,
  :results,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#generated_response_part ⇒ Types::GeneratedResponsePart

The generated response to the citation event.

Returns:



1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 1521

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:



8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8343

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:



8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8343

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 ⇒ Types::AgenticRetrieveGuardrailWarning

A warning from a guardrail evaluation.

Returns:



963
964
965
966
967
968
969
970
971
972
973
974
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 963

class AgenticRetrieveWarning < Struct.new(
  :guardrail,
  :message,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Guardrail < AgenticRetrieveWarning; end
  class Message < AgenticRetrieveWarning; end
  class Unknown < AgenticRetrieveWarning; end
end

#guardrail_trace ⇒ Types::GuardrailTrace

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

Returns:



9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9847

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

#id ⇒ String

The unique identifier of the trace event.

Returns:

  • (String) 


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

class AgenticRetrieveTraceEvent < Struct.new(
  :attributes,
  :id,
  :timestamp,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#image ⇒ Types::ImageBlock

The image in the invocation step.

Returns:



1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 1392

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:



8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8343

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) 


4584
4585
4586
4587
4588
4589
4590
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4584

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:



7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 7176

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:



4584
4585
4586
4587
4588
4589
4590
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4584

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

#knowledge_base ⇒ Types::KnowledgeBaseRetrieverConfiguration

Configuration for a knowledge base retriever.

Returns:



9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9111

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

  class KnowledgeBase < RetrieverConfiguration; end
  class Unknown < RetrieverConfiguration; end
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 '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:



8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8343

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:



8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8343

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:



8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8343

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



7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 7176

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:



7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 7176

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

#next_token ⇒ String

Opaque continuation token for paginated results.

Returns:

  • (String) 


725
726
727
728
729
730
731
732
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 725

class AgenticRetrieveResultEvent < Struct.new(
  :generated_response,
  :next_token,
  :results,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#node_action_event ⇒ Types::NodeActionEvent

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

Returns:



2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2438

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:



2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2842

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:



2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2438

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:



2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2842

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:



2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2438

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:



2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2438

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:



2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2842

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) 


2728
2729
2730
2731
2732
2733
2734
2735
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2728

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:



2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2438

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:



2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2842

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) 


2728
2729
2730
2731
2732
2733
2734
2735
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2728

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:



8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8343

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:



8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8343

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:



7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 7176

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:



7022
7023
7024
7025
7026
7027
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 7022

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:



8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8343

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:



9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9847

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



9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9847

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:



9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9847

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:



7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 7176

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) 


4818
4819
4820
4821
4822
4823
4824
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4818

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:



7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 7861

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) 


7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 7861

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) 


1275
1276
1277
1278
1279
1280
1281
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 1275

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

#results ⇒ Array<Types::AgenticRetrieveResultItem>

The list of retrieved result items.

Returns:



725
726
727
728
729
730
731
732
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 725

class AgenticRetrieveResultEvent < Struct.new(
  :generated_response,
  :next_token,
  :results,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#retrieved_references ⇒ Array<Types::RetrievedReference>

The retrieved references of the citation event.

Returns:



1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 1521

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:



9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9847

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



4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4421

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) 


4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4632

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:



6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 6259

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:



8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8343

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:



8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8343

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) 


702
703
704
705
706
707
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 702

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

#text_prompt ⇒ Types::TextPrompt

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

Returns:



4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 4794

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

#timestamp ⇒ Integer

The timestamp when the trace event occurred.

Returns:

  • (Integer) 


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

class AgenticRetrieveTraceEvent < Struct.new(
  :attributes,
  :id,
  :timestamp,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
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].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement

Returns:



2952
2953
2954
2955
2956
2957
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 2952

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