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, AnalyzePromptEvent, ApiInvocationInput, ApiParameter, ApiRequestBody, ApiResult, Attribution, BadGatewayException, ByteContentDoc, ByteContentFile, Citation, CodeInterpreterInvocationInput, CodeInterpreterInvocationOutput, ConflictException, ContentBody, DeleteAgentMemoryRequest, DeleteAgentMemoryResponse, DependencyFailedException, ExternalSource, ExternalSourcesGenerationConfiguration, ExternalSourcesRetrieveAndGenerateConfiguration, FailureTrace, FilePart, FileSource, FilterAttribute, FinalResponse, FlowCompletionEvent, FlowInput, FlowInputContent, FlowOutputContent, FlowOutputEvent, FlowResponseStream, FlowTrace, FlowTraceCondition, FlowTraceConditionNodeResultEvent, FlowTraceEvent, FlowTraceNodeInputContent, FlowTraceNodeInputEvent, FlowTraceNodeInputField, FlowTraceNodeOutputContent, FlowTraceNodeOutputEvent, FlowTraceNodeOutputField, FunctionDefinition, FunctionInvocationInput, FunctionParameter, FunctionResult, FunctionSchema, GeneratedResponsePart, GenerationConfiguration, GetAgentMemoryRequest, GetAgentMemoryResponse, GuardrailAssessment, GuardrailConfiguration, GuardrailConfigurationWithArn, GuardrailContentFilter, GuardrailContentPolicyAssessment, GuardrailCustomWord, GuardrailManagedWord, GuardrailPiiEntityFilter, GuardrailRegexFilter, GuardrailSensitiveInformationPolicyAssessment, GuardrailTopic, GuardrailTopicPolicyAssessment, GuardrailTrace, GuardrailWordPolicyAssessment, InferenceConfig, InferenceConfiguration, InlineAgentFilePart, InlineAgentPayloadPart, InlineAgentResponseStream, InlineAgentReturnControlPayload, InlineAgentTracePart, InlineSessionState, InputFile, InputPrompt, InternalServerException, InvocationInput, InvocationInputMember, InvocationResultMember, InvokeAgentRequest, InvokeAgentResponse, InvokeFlowRequest, InvokeFlowResponse, InvokeInlineAgentRequest, InvokeInlineAgentResponse, KnowledgeBase, KnowledgeBaseConfiguration, KnowledgeBaseLookupInput, KnowledgeBaseLookupOutput, KnowledgeBaseQuery, KnowledgeBaseRetrievalConfiguration, KnowledgeBaseRetrievalResult, KnowledgeBaseRetrieveAndGenerateConfiguration, KnowledgeBaseVectorSearchConfiguration, Memory, MemorySessionSummary, Metadata, ModelInvocationInput, Observation, OptimizePromptRequest, OptimizePromptResponse, OptimizedPrompt, OptimizedPromptEvent, OptimizedPromptStream, OrchestrationConfiguration, OrchestrationModelInvocationOutput, OrchestrationTrace, OutputFile, Parameter, ParameterDetail, PayloadPart, PostProcessingModelInvocationOutput, PostProcessingParsedResponse, PostProcessingTrace, PreProcessingModelInvocationOutput, PreProcessingParsedResponse, PreProcessingTrace, PromptConfiguration, PromptOverrideConfiguration, PromptTemplate, PropertyParameters, QueryTransformationConfiguration, Rationale, RawResponse, RepromptResponse, RequestBody, ResourceNotFoundException, ResponseStream, RetrievalFilter, RetrievalResultConfluenceLocation, RetrievalResultContent, RetrievalResultLocation, RetrievalResultS3Location, RetrievalResultSalesforceLocation, RetrievalResultSharePointLocation, RetrievalResultWebLocation, RetrieveAndGenerateConfiguration, RetrieveAndGenerateInput, RetrieveAndGenerateOutput, RetrieveAndGenerateRequest, RetrieveAndGenerateResponse, RetrieveAndGenerateSessionConfiguration, RetrieveRequest, RetrieveResponse, RetrievedReference, ReturnControlPayload, S3Identifier, S3ObjectDoc, S3ObjectFile, ServiceQuotaExceededException, SessionState, Span, TextInferenceConfig, TextPrompt, TextResponsePart, ThrottlingException, Trace, TracePart, Usage, ValidationException

Instance Attribute Summary collapse

Instance Attribute Details

#agent_alias_id ⇒ String

The unique identifier of the alias of the agent.

Returns:

  • (String) 


4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4927

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

#agent_id ⇒ String

The unique identifier of the agent.

Returns:

  • (String) 


4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4927

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

#agent_version ⇒ String

The version of the agent.

Returns:

  • (String) 


4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4927

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

#and_all ⇒ Array<Types::RetrievalFilter>

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

Returns:



4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4028

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:



2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2265

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:



2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2306

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:



2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2003

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) 


2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2003

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

#completion_reason ⇒ String

The reason that the flow completed.

Returns:

  • (String) 


888
889
890
891
892
893
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 888

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:



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1013

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:



980
981
982
983
984
985
986
987
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 980

class FlowOutputEvent < 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

#document ⇒ Hash, ...

The content of the node output.

Returns:

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


931
932
933
934
935
936
937
938
939
940
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 931

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:



4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4028

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:



4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4868

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

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

#files ⇒ Array<Types::OutputFile>

Files containing intermediate response for the user.

Returns:



803
804
805
806
807
808
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 803

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:



2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2265

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:



2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2306

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:



1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1438

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

  class Functions < FunctionSchema; end
  class Unknown < FunctionSchema; end
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:



4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4028

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:



4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4028

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:



4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4868

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

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



4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4028

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) 


2032
2033
2034
2035
2036
2037
2038
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2032

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

#invocation_input ⇒ Types::InvocationInput

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

Returns:



3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3295

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:



2032
2033
2034
2035
2036
2037
2038
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2032

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:



4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4028

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:



4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4028

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:



4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4028

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 input for the pre-processing step.

  • The type is PRE_PROCESSING.

  • The text contains the prompt.

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

Returns:



3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3295

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

The foundation model output from the pre-processing step.

Returns:



3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3295

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:



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1013

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) 


980
981
982
983
984
985
986
987
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 980

class FlowOutputEvent < 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:



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1013

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) 


980
981
982
983
984
985
986
987
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 980

class FlowOutputEvent < 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:



4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4028

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:



4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4028

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

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

Returns:



3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3295

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:



3175
3176
3177
3178
3179
3180
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3175

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:



4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4028

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:



4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4868

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

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



4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4868

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

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

#pre_processing_trace ⇒ Types::PreProcessingTrace

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

Returns:



4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4868

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

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

#rationale ⇒ Types::Rationale

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

Returns:



3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 3295

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

#resource_name ⇒ String

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

Returns:

  • (String) 


463
464
465
466
467
468
469
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 463

class BadGatewayException < Struct.new(
  :message,
  :resource_name,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
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) 


2068
2069
2070
2071
2072
2073
2074
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2068

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:



2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2918

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:



4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4028

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:



4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4028

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_prompt ⇒ Types::TextPrompt

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

Returns:



2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2176

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:



1094
1095
1096
1097
1098
1099
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1094

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