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, BadGatewayException, BedrockModelConfigurations, BedrockRerankingConfiguration, BedrockRerankingModelConfiguration, ByteContentDoc, ByteContentFile, Caller, Citation, CitationEvent, CodeInterpreterInvocationInput, CodeInterpreterInvocationOutput, ConflictException, ContentBlock, ContentBody, ConversationHistory, CustomOrchestrationTrace, CustomOrchestrationTraceEvent, DeleteAgentMemoryRequest, DeleteAgentMemoryResponse, DependencyFailedException, ExternalSource, ExternalSourcesGenerationConfiguration, ExternalSourcesRetrieveAndGenerateConfiguration, FailureTrace, FieldForReranking, FilePart, FileSource, FilterAttribute, FinalResponse, FlowCompletionEvent, FlowInput, FlowInputContent, FlowMultiTurnInputContent, FlowMultiTurnInputRequestEvent, FlowOutputContent, FlowOutputEvent, FlowResponseStream, FlowTrace, FlowTraceCondition, FlowTraceConditionNodeResultEvent, FlowTraceEvent, FlowTraceNodeInputContent, FlowTraceNodeInputEvent, FlowTraceNodeInputField, FlowTraceNodeOutputContent, FlowTraceNodeOutputEvent, FlowTraceNodeOutputField, FunctionDefinition, FunctionInvocationInput, FunctionParameter, FunctionResult, FunctionSchema, GenerateQueryRequest, GenerateQueryResponse, GeneratedQuery, GeneratedResponsePart, GenerationConfiguration, GetAgentMemoryRequest, GetAgentMemoryResponse, GuardrailAssessment, GuardrailConfiguration, GuardrailConfigurationWithArn, GuardrailContentFilter, GuardrailContentPolicyAssessment, GuardrailCustomWord, GuardrailEvent, GuardrailManagedWord, GuardrailPiiEntityFilter, GuardrailRegexFilter, GuardrailSensitiveInformationPolicyAssessment, GuardrailTopic, GuardrailTopicPolicyAssessment, GuardrailTrace, GuardrailWordPolicyAssessment, ImplicitFilterConfiguration, InferenceConfig, InferenceConfiguration, InlineAgentFilePart, InlineAgentPayloadPart, InlineAgentResponseStream, InlineAgentReturnControlPayload, InlineAgentTracePart, InlineBedrockModelConfigurations, InlineSessionState, InputFile, InputPrompt, InternalServerException, InvocationInput, InvocationInputMember, InvocationResultMember, InvokeAgentRequest, InvokeAgentResponse, InvokeFlowRequest, InvokeFlowResponse, InvokeInlineAgentRequest, InvokeInlineAgentResponse, KnowledgeBase, KnowledgeBaseConfiguration, KnowledgeBaseLookupInput, KnowledgeBaseLookupOutput, KnowledgeBaseQuery, KnowledgeBaseRetrievalConfiguration, KnowledgeBaseRetrievalResult, KnowledgeBaseRetrieveAndGenerateConfiguration, KnowledgeBaseVectorSearchConfiguration, Memory, MemorySessionSummary, Message, Metadata, MetadataAttributeSchema, MetadataConfigurationForReranking, ModelInvocationInput, ModelNotReadyException, ModelPerformanceConfiguration, Observation, OptimizePromptRequest, OptimizePromptResponse, OptimizedPrompt, OptimizedPromptEvent, OptimizedPromptStream, OrchestrationConfiguration, OrchestrationModelInvocationOutput, OrchestrationTrace, OutputFile, Parameter, ParameterDetail, PayloadPart, PerformanceConfiguration, PostProcessingModelInvocationOutput, PostProcessingParsedResponse, PostProcessingTrace, PreProcessingModelInvocationOutput, PreProcessingParsedResponse, PreProcessingTrace, PromptConfiguration, PromptOverrideConfiguration, PromptTemplate, PropertyParameters, QueryGenerationInput, QueryTransformationConfiguration, Rationale, RawResponse, 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, S3ObjectDoc, S3ObjectFile, ServiceQuotaExceededException, SessionState, Span, StreamingConfigurations, TextInferenceConfig, TextPrompt, TextResponsePart, TextToSqlConfiguration, TextToSqlKnowledgeBaseConfiguration, ThrottlingException, Trace, TracePart, TransformationConfiguration, Usage, ValidationException, VectorSearchBedrockRerankingConfiguration, VectorSearchBedrockRerankingModelConfiguration, VectorSearchRerankingConfiguration

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

The guardrail action.

Returns:

  • (String) 


2159
2160
2161
2162
2163
2164
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2159

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

#agent_alias_arn ⇒ String

The caller's agent alias ARN.

Returns:

  • (String) 


693
694
695
696
697
698
699
700
701
702
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 693

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) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6204

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

#agent_id ⇒ String

The unique identifier of the agent.

Returns:

  • (String) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6204

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

#agent_version ⇒ String

The version of the agent.

Returns:

  • (String) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6204

class TracePart < Struct.new(
  :agent_alias_id,
  :agent_id,
  :agent_version,
  :caller_chain,
  :collaborator_name,
  :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:



4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4960

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:



2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2761

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:



2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2804

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:



2473
2474
2475
2476
2477
2478
2479
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2473

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) 


2473
2474
2475
2476
2477
2478
2479
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2473

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

#caller_chain ⇒ Array<Types::Caller>

The part's caller chain.

Returns:



6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6204

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

#citation ⇒ Types::Citation

The citation.

Returns:



753
754
755
756
757
758
759
760
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 753

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) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6204

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

#completion_reason ⇒ String

The reason that the flow completed.

Returns:

  • (String) 


1196
1197
1198
1199
1200
1201
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1196

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:



1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1376

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

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

#content ⇒ Types::FlowOutputContent

The content in the output.

Returns:



1296
1297
1298
1299
1300
1301
1302
1303
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1296

class FlowMultiTurnInputRequestEvent < Struct.new(
  :content,
  :node_name,
  :node_type,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
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:



6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6133

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 content of the node output.

Returns:

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


1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1244

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

  class Document < FlowInputContent; end
  class Unknown < FlowInputContent; 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:



4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4960

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

#failure_trace ⇒ Types::FailureTrace

Contains information about the failure of the interaction.

Returns:



6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6133

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:



4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4769

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:



4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4769

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:



1111
1112
1113
1114
1115
1116
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1111

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

#function_invocation_input ⇒ Types::FunctionInvocationInput

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

Returns:



2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2761

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:



2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2804

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:



1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1816

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:



753
754
755
756
757
758
759
760
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 753

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:



4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4960

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:



4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4960

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:



6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6133

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

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



4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4960

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) 


2502
2503
2504
2505
2506
2507
2508
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2502

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:



3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3975

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:



2502
2503
2504
2505
2506
2507
2508
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2502

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:



4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4960

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:



4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4960

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:



4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4960

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:



3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3975

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:



3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3975

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_input_trace ⇒ Types::FlowTraceNodeInputEvent

Contains information about the input into a node.

Returns:



1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1376

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

  class ConditionNodeResultTrace < 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) 


1296
1297
1298
1299
1300
1301
1302
1303
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1296

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

#node_output_trace ⇒ Types::FlowTraceNodeOutputEvent

Contains information about the output from a node.

Returns:



1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1376

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

  class ConditionNodeResultTrace < 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) 


1296
1297
1298
1299
1300
1301
1302
1303
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1296

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

#not_equals ⇒ Types::FilterAttribute

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

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

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

Returns:



4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4960

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:



4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4960

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:



3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3975

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:



3850
3851
3852
3853
3854
3855
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3850

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:



4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4960

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:



6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6133

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:



6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6133

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:



6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6133

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:



3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3975

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) 


2684
2685
2686
2687
2688
2689
2690
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2684

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

#resource_name ⇒ String

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

Returns:

  • (String) 


576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 576

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:



753
754
755
756
757
758
759
760
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 753

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:



6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6133

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

#session_id ⇒ String

The unique identifier of the session with the agent.

Returns:

  • (String) 


2538
2539
2540
2541
2542
2543
2544
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2538

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

#session_summary ⇒ Types::MemorySessionSummary

Contains summary of a session.

Returns:



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

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:



4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4960

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:



4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4960

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) 


836
837
838
839
840
841
842
843
844
845
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 836

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

  class Text < ContentBlock; end
  class Unknown < ContentBlock; end
end

#text_prompt ⇒ Types::TextPrompt

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

Returns:



2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2660

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:



1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1457

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