aws-sdk-bedrockagentruntime 1.47.0 → 1.49.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockagentruntime/client.rb +299 -3
- data/lib/aws-sdk-bedrockagentruntime/client_api.rb +62 -0
- data/lib/aws-sdk-bedrockagentruntime/types.rb +298 -31
- data/lib/aws-sdk-bedrockagentruntime.rb +1 -1
- data/sig/client.rbs +248 -5
- data/sig/types.rbs +49 -1
- metadata +2 -2
@@ -23,6 +23,9 @@ module Aws::BedrockAgentRuntime
|
|
23
23
|
ActionGroupName = Shapes::StringShape.new(name: 'ActionGroupName')
|
24
24
|
ActionGroupOutputString = Shapes::StringShape.new(name: 'ActionGroupOutputString')
|
25
25
|
ActionGroupSignature = Shapes::StringShape.new(name: 'ActionGroupSignature')
|
26
|
+
ActionGroupSignatureParams = Shapes::MapShape.new(name: 'ActionGroupSignatureParams')
|
27
|
+
ActionGroupSignatureParamsKeyString = Shapes::StringShape.new(name: 'ActionGroupSignatureParamsKeyString')
|
28
|
+
ActionGroupSignatureParamsValueString = Shapes::StringShape.new(name: 'ActionGroupSignatureParamsValueString')
|
26
29
|
ActionInvocationType = Shapes::StringShape.new(name: 'ActionInvocationType')
|
27
30
|
AdditionalModelRequestFields = Shapes::MapShape.new(name: 'AdditionalModelRequestFields')
|
28
31
|
AdditionalModelRequestFieldsKey = Shapes::StringShape.new(name: 'AdditionalModelRequestFieldsKey')
|
@@ -31,6 +34,7 @@ module Aws::BedrockAgentRuntime
|
|
31
34
|
AgentActionGroups = Shapes::ListShape.new(name: 'AgentActionGroups')
|
32
35
|
AgentAliasArn = Shapes::StringShape.new(name: 'AgentAliasArn')
|
33
36
|
AgentAliasId = Shapes::StringShape.new(name: 'AgentAliasId')
|
37
|
+
AgentCollaboration = Shapes::StringShape.new(name: 'AgentCollaboration')
|
34
38
|
AgentCollaboratorInputPayload = Shapes::StructureShape.new(name: 'AgentCollaboratorInputPayload')
|
35
39
|
AgentCollaboratorInvocationInput = Shapes::StructureShape.new(name: 'AgentCollaboratorInvocationInput')
|
36
40
|
AgentCollaboratorInvocationOutput = Shapes::StructureShape.new(name: 'AgentCollaboratorInvocationOutput')
|
@@ -71,6 +75,11 @@ module Aws::BedrockAgentRuntime
|
|
71
75
|
Citations = Shapes::ListShape.new(name: 'Citations')
|
72
76
|
CodeInterpreterInvocationInput = Shapes::StructureShape.new(name: 'CodeInterpreterInvocationInput')
|
73
77
|
CodeInterpreterInvocationOutput = Shapes::StructureShape.new(name: 'CodeInterpreterInvocationOutput')
|
78
|
+
CollaborationInstruction = Shapes::StringShape.new(name: 'CollaborationInstruction')
|
79
|
+
Collaborator = Shapes::StructureShape.new(name: 'Collaborator')
|
80
|
+
CollaboratorConfiguration = Shapes::StructureShape.new(name: 'CollaboratorConfiguration')
|
81
|
+
CollaboratorConfigurations = Shapes::ListShape.new(name: 'CollaboratorConfigurations')
|
82
|
+
Collaborators = Shapes::ListShape.new(name: 'Collaborators')
|
74
83
|
ConfirmationState = Shapes::StringShape.new(name: 'ConfirmationState')
|
75
84
|
ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
|
76
85
|
ContentBlock = Shapes::UnionShape.new(name: 'ContentBlock')
|
@@ -209,6 +218,11 @@ module Aws::BedrockAgentRuntime
|
|
209
218
|
Identifier = Shapes::StringShape.new(name: 'Identifier')
|
210
219
|
ImageBlock = Shapes::StructureShape.new(name: 'ImageBlock')
|
211
220
|
ImageFormat = Shapes::StringShape.new(name: 'ImageFormat')
|
221
|
+
ImageInput = Shapes::StructureShape.new(name: 'ImageInput')
|
222
|
+
ImageInputFormat = Shapes::StringShape.new(name: 'ImageInputFormat')
|
223
|
+
ImageInputSource = Shapes::UnionShape.new(name: 'ImageInputSource')
|
224
|
+
ImageInputSourceBytesBlob = Shapes::BlobShape.new(name: 'ImageInputSourceBytesBlob')
|
225
|
+
ImageInputs = Shapes::ListShape.new(name: 'ImageInputs')
|
212
226
|
ImageSource = Shapes::UnionShape.new(name: 'ImageSource')
|
213
227
|
ImageSourceBytesBlob = Shapes::BlobShape.new(name: 'ImageSourceBytesBlob')
|
214
228
|
ImplicitFilterConfiguration = Shapes::StructureShape.new(name: 'ImplicitFilterConfiguration')
|
@@ -360,6 +374,7 @@ module Aws::BedrockAgentRuntime
|
|
360
374
|
RawResponse = Shapes::StructureShape.new(name: 'RawResponse')
|
361
375
|
ReasoningContentBlock = Shapes::UnionShape.new(name: 'ReasoningContentBlock')
|
362
376
|
ReasoningTextBlock = Shapes::StructureShape.new(name: 'ReasoningTextBlock')
|
377
|
+
RelayConversationHistory = Shapes::StringShape.new(name: 'RelayConversationHistory')
|
363
378
|
RepromptResponse = Shapes::StructureShape.new(name: 'RepromptResponse')
|
364
379
|
RequestBody = Shapes::StructureShape.new(name: 'RequestBody')
|
365
380
|
RequireConfirmation = Shapes::StringShape.new(name: 'RequireConfirmation')
|
@@ -459,6 +474,7 @@ module Aws::BedrockAgentRuntime
|
|
459
474
|
StreamingConfigurationsApplyGuardrailIntervalInteger = Shapes::IntegerShape.new(name: 'StreamingConfigurationsApplyGuardrailIntervalInteger')
|
460
475
|
String = Shapes::StringShape.new(name: 'String')
|
461
476
|
SummaryText = Shapes::StringShape.new(name: 'SummaryText')
|
477
|
+
SyntheticTimestamp_date_time = Shapes::TimestampShape.new(name: 'SyntheticTimestamp_date_time', timestampFormat: "iso8601")
|
462
478
|
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
463
479
|
TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
|
464
480
|
TagResourceRequest = Shapes::StructureShape.new(name: 'TagResourceRequest')
|
@@ -530,6 +546,9 @@ module Aws::BedrockAgentRuntime
|
|
530
546
|
ActionGroupInvocationOutput.add_member(:text, Shapes::ShapeRef.new(shape: ActionGroupOutputString, location_name: "text"))
|
531
547
|
ActionGroupInvocationOutput.struct_class = Types::ActionGroupInvocationOutput
|
532
548
|
|
549
|
+
ActionGroupSignatureParams.key = Shapes::ShapeRef.new(shape: ActionGroupSignatureParamsKeyString)
|
550
|
+
ActionGroupSignatureParams.value = Shapes::ShapeRef.new(shape: ActionGroupSignatureParamsValueString)
|
551
|
+
|
533
552
|
AdditionalModelRequestFields.key = Shapes::ShapeRef.new(shape: AdditionalModelRequestFieldsKey)
|
534
553
|
AdditionalModelRequestFields.value = Shapes::ShapeRef.new(shape: AdditionalModelRequestFieldsValue)
|
535
554
|
|
@@ -539,6 +558,7 @@ module Aws::BedrockAgentRuntime
|
|
539
558
|
AgentActionGroup.add_member(:description, Shapes::ShapeRef.new(shape: ResourceDescription, location_name: "description"))
|
540
559
|
AgentActionGroup.add_member(:function_schema, Shapes::ShapeRef.new(shape: FunctionSchema, location_name: "functionSchema"))
|
541
560
|
AgentActionGroup.add_member(:parent_action_group_signature, Shapes::ShapeRef.new(shape: ActionGroupSignature, location_name: "parentActionGroupSignature"))
|
561
|
+
AgentActionGroup.add_member(:parent_action_group_signature_params, Shapes::ShapeRef.new(shape: ActionGroupSignatureParams, location_name: "parentActionGroupSignatureParams"))
|
542
562
|
AgentActionGroup.struct_class = Types::AgentActionGroup
|
543
563
|
|
544
564
|
AgentActionGroups.member = Shapes::ShapeRef.new(shape: AgentActionGroup)
|
@@ -665,6 +685,29 @@ module Aws::BedrockAgentRuntime
|
|
665
685
|
CodeInterpreterInvocationOutput.add_member(:files, Shapes::ShapeRef.new(shape: Files, location_name: "files"))
|
666
686
|
CodeInterpreterInvocationOutput.struct_class = Types::CodeInterpreterInvocationOutput
|
667
687
|
|
688
|
+
Collaborator.add_member(:action_groups, Shapes::ShapeRef.new(shape: AgentActionGroups, location_name: "actionGroups"))
|
689
|
+
Collaborator.add_member(:agent_collaboration, Shapes::ShapeRef.new(shape: AgentCollaboration, location_name: "agentCollaboration"))
|
690
|
+
Collaborator.add_member(:agent_name, Shapes::ShapeRef.new(shape: Name, location_name: "agentName"))
|
691
|
+
Collaborator.add_member(:collaborator_configurations, Shapes::ShapeRef.new(shape: CollaboratorConfigurations, location_name: "collaboratorConfigurations"))
|
692
|
+
Collaborator.add_member(:customer_encryption_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "customerEncryptionKeyArn"))
|
693
|
+
Collaborator.add_member(:foundation_model, Shapes::ShapeRef.new(shape: ModelIdentifier, required: true, location_name: "foundationModel"))
|
694
|
+
Collaborator.add_member(:guardrail_configuration, Shapes::ShapeRef.new(shape: GuardrailConfigurationWithArn, location_name: "guardrailConfiguration"))
|
695
|
+
Collaborator.add_member(:idle_session_ttl_in_seconds, Shapes::ShapeRef.new(shape: SessionTTL, location_name: "idleSessionTTLInSeconds"))
|
696
|
+
Collaborator.add_member(:instruction, Shapes::ShapeRef.new(shape: Instruction, required: true, location_name: "instruction"))
|
697
|
+
Collaborator.add_member(:knowledge_bases, Shapes::ShapeRef.new(shape: KnowledgeBases, location_name: "knowledgeBases"))
|
698
|
+
Collaborator.add_member(:prompt_override_configuration, Shapes::ShapeRef.new(shape: PromptOverrideConfiguration, location_name: "promptOverrideConfiguration"))
|
699
|
+
Collaborator.struct_class = Types::Collaborator
|
700
|
+
|
701
|
+
CollaboratorConfiguration.add_member(:agent_alias_arn, Shapes::ShapeRef.new(shape: AgentAliasArn, location_name: "agentAliasArn"))
|
702
|
+
CollaboratorConfiguration.add_member(:collaborator_instruction, Shapes::ShapeRef.new(shape: CollaborationInstruction, required: true, location_name: "collaboratorInstruction"))
|
703
|
+
CollaboratorConfiguration.add_member(:collaborator_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "collaboratorName"))
|
704
|
+
CollaboratorConfiguration.add_member(:relay_conversation_history, Shapes::ShapeRef.new(shape: RelayConversationHistory, location_name: "relayConversationHistory"))
|
705
|
+
CollaboratorConfiguration.struct_class = Types::CollaboratorConfiguration
|
706
|
+
|
707
|
+
CollaboratorConfigurations.member = Shapes::ShapeRef.new(shape: CollaboratorConfiguration)
|
708
|
+
|
709
|
+
Collaborators.member = Shapes::ShapeRef.new(shape: Collaborator)
|
710
|
+
|
668
711
|
ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: NonBlankString, location_name: "message"))
|
669
712
|
ConflictException.struct_class = Types::ConflictException
|
670
713
|
|
@@ -677,6 +720,7 @@ module Aws::BedrockAgentRuntime
|
|
677
720
|
ContentBlocks.member = Shapes::ShapeRef.new(shape: ContentBlock)
|
678
721
|
|
679
722
|
ContentBody.add_member(:body, Shapes::ShapeRef.new(shape: String, location_name: "body"))
|
723
|
+
ContentBody.add_member(:images, Shapes::ShapeRef.new(shape: ImageInputs, location_name: "images"))
|
680
724
|
ContentBody.struct_class = Types::ContentBody
|
681
725
|
|
682
726
|
ContentMap.key = Shapes::ShapeRef.new(shape: String)
|
@@ -1071,6 +1115,18 @@ module Aws::BedrockAgentRuntime
|
|
1071
1115
|
ImageBlock.add_member(:source, Shapes::ShapeRef.new(shape: ImageSource, required: true, location_name: "source"))
|
1072
1116
|
ImageBlock.struct_class = Types::ImageBlock
|
1073
1117
|
|
1118
|
+
ImageInput.add_member(:format, Shapes::ShapeRef.new(shape: ImageInputFormat, required: true, location_name: "format"))
|
1119
|
+
ImageInput.add_member(:source, Shapes::ShapeRef.new(shape: ImageInputSource, required: true, location_name: "source"))
|
1120
|
+
ImageInput.struct_class = Types::ImageInput
|
1121
|
+
|
1122
|
+
ImageInputSource.add_member(:bytes, Shapes::ShapeRef.new(shape: ImageInputSourceBytesBlob, location_name: "bytes"))
|
1123
|
+
ImageInputSource.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
1124
|
+
ImageInputSource.add_member_subclass(:bytes, Types::ImageInputSource::Bytes)
|
1125
|
+
ImageInputSource.add_member_subclass(:unknown, Types::ImageInputSource::Unknown)
|
1126
|
+
ImageInputSource.struct_class = Types::ImageInputSource
|
1127
|
+
|
1128
|
+
ImageInputs.member = Shapes::ShapeRef.new(shape: ImageInput)
|
1129
|
+
|
1074
1130
|
ImageSource.add_member(:bytes, Shapes::ShapeRef.new(shape: ImageSourceBytesBlob, location_name: "bytes"))
|
1075
1131
|
ImageSource.add_member(:s3_location, Shapes::ShapeRef.new(shape: S3Location, location_name: "s3Location"))
|
1076
1132
|
ImageSource.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
@@ -1126,6 +1182,7 @@ module Aws::BedrockAgentRuntime
|
|
1126
1182
|
InlineBedrockModelConfigurations.add_member(:performance_config, Shapes::ShapeRef.new(shape: PerformanceConfiguration, location_name: "performanceConfig"))
|
1127
1183
|
InlineBedrockModelConfigurations.struct_class = Types::InlineBedrockModelConfigurations
|
1128
1184
|
|
1185
|
+
InlineSessionState.add_member(:conversation_history, Shapes::ShapeRef.new(shape: ConversationHistory, location_name: "conversationHistory"))
|
1129
1186
|
InlineSessionState.add_member(:files, Shapes::ShapeRef.new(shape: InputFiles, location_name: "files"))
|
1130
1187
|
InlineSessionState.add_member(:invocation_id, Shapes::ShapeRef.new(shape: String, location_name: "invocationId"))
|
1131
1188
|
InlineSessionState.add_member(:prompt_session_attributes, Shapes::ShapeRef.new(shape: PromptSessionAttributesMap, location_name: "promptSessionAttributes"))
|
@@ -1240,7 +1297,10 @@ module Aws::BedrockAgentRuntime
|
|
1240
1297
|
InvokeFlowResponse[:payload_member] = InvokeFlowResponse.member(:response_stream)
|
1241
1298
|
|
1242
1299
|
InvokeInlineAgentRequest.add_member(:action_groups, Shapes::ShapeRef.new(shape: AgentActionGroups, location_name: "actionGroups"))
|
1300
|
+
InvokeInlineAgentRequest.add_member(:agent_collaboration, Shapes::ShapeRef.new(shape: AgentCollaboration, location_name: "agentCollaboration"))
|
1243
1301
|
InvokeInlineAgentRequest.add_member(:bedrock_model_configurations, Shapes::ShapeRef.new(shape: InlineBedrockModelConfigurations, location_name: "bedrockModelConfigurations"))
|
1302
|
+
InvokeInlineAgentRequest.add_member(:collaborator_configurations, Shapes::ShapeRef.new(shape: CollaboratorConfigurations, location_name: "collaboratorConfigurations"))
|
1303
|
+
InvokeInlineAgentRequest.add_member(:collaborators, Shapes::ShapeRef.new(shape: Collaborators, location_name: "collaborators"))
|
1244
1304
|
InvokeInlineAgentRequest.add_member(:customer_encryption_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "customerEncryptionKeyArn"))
|
1245
1305
|
InvokeInlineAgentRequest.add_member(:enable_trace, Shapes::ShapeRef.new(shape: Boolean, location_name: "enableTrace"))
|
1246
1306
|
InvokeInlineAgentRequest.add_member(:end_session, Shapes::ShapeRef.new(shape: Boolean, location_name: "endSession"))
|
@@ -1530,6 +1590,7 @@ module Aws::BedrockAgentRuntime
|
|
1530
1590
|
|
1531
1591
|
PromptConfiguration.add_member(:additional_model_request_fields, Shapes::ShapeRef.new(shape: Document, location_name: "additionalModelRequestFields"))
|
1532
1592
|
PromptConfiguration.add_member(:base_prompt_template, Shapes::ShapeRef.new(shape: BasePromptTemplate, location_name: "basePromptTemplate"))
|
1593
|
+
PromptConfiguration.add_member(:foundation_model, Shapes::ShapeRef.new(shape: ModelIdentifier, location_name: "foundationModel"))
|
1533
1594
|
PromptConfiguration.add_member(:inference_configuration, Shapes::ShapeRef.new(shape: InferenceConfiguration, location_name: "inferenceConfiguration"))
|
1534
1595
|
PromptConfiguration.add_member(:parser_mode, Shapes::ShapeRef.new(shape: CreationMode, location_name: "parserMode"))
|
1535
1596
|
PromptConfiguration.add_member(:prompt_creation_mode, Shapes::ShapeRef.new(shape: CreationMode, location_name: "promptCreationMode"))
|
@@ -1959,6 +2020,7 @@ module Aws::BedrockAgentRuntime
|
|
1959
2020
|
TracePart.add_member(:agent_version, Shapes::ShapeRef.new(shape: AgentVersion, location_name: "agentVersion"))
|
1960
2021
|
TracePart.add_member(:caller_chain, Shapes::ShapeRef.new(shape: CallerChain, location_name: "callerChain"))
|
1961
2022
|
TracePart.add_member(:collaborator_name, Shapes::ShapeRef.new(shape: Name, location_name: "collaboratorName"))
|
2023
|
+
TracePart.add_member(:event_time, Shapes::ShapeRef.new(shape: SyntheticTimestamp_date_time, location_name: "eventTime"))
|
1962
2024
|
TracePart.add_member(:session_id, Shapes::ShapeRef.new(shape: SessionId, location_name: "sessionId"))
|
1963
2025
|
TracePart.add_member(:trace, Shapes::ShapeRef.new(shape: Trace, location_name: "trace"))
|
1964
2026
|
TracePart.struct_class = Types::TracePart
|
@@ -205,28 +205,57 @@ module Aws::BedrockAgentRuntime
|
|
205
205
|
# @return [Types::FunctionSchema]
|
206
206
|
#
|
207
207
|
# @!attribute [rw] parent_action_group_signature
|
208
|
-
#
|
209
|
-
#
|
210
|
-
# `
|
211
|
-
#
|
212
|
-
#
|
213
|
-
#
|
214
|
-
#
|
215
|
-
#
|
216
|
-
#
|
217
|
-
#
|
208
|
+
# Specify a built-in or computer use action for this action group. If
|
209
|
+
# you specify a value, you must leave the `description`, `apiSchema`,
|
210
|
+
# and `actionGroupExecutor` fields empty for this action group.
|
211
|
+
#
|
212
|
+
# * To allow your agent to request the user for additional information
|
213
|
+
# when trying to complete a task, set this field to
|
214
|
+
# `AMAZON.UserInput`.
|
215
|
+
#
|
216
|
+
# * To allow your agent to generate, run, and troubleshoot code when
|
217
|
+
# trying to complete a task, set this field to
|
218
|
+
# `AMAZON.CodeInterpreter`.
|
219
|
+
#
|
220
|
+
# * To allow your agent to use an Anthropic computer use tool, specify
|
221
|
+
# one of the following values.
|
222
|
+
#
|
223
|
+
# Computer use is a new Anthropic Claude model capability (in beta)
|
224
|
+
# available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet
|
225
|
+
# v2 only. When operating computer use functionality, we recommend
|
226
|
+
# taking additional security precautions, such as executing computer
|
227
|
+
# actions in virtual environments with restricted data access and
|
228
|
+
# limited internet connectivity. For more information, see
|
229
|
+
# [Configure an Amazon Bedrock Agent to complete tasks with computer
|
230
|
+
# use tools][1].
|
218
231
|
#
|
219
|
-
#
|
220
|
-
#
|
221
|
-
# information to complete the API request, it will invoke this action
|
222
|
-
# group instead and return an [Observation][1] reprompting the user
|
223
|
-
# for more information.
|
232
|
+
# * `ANTHROPIC.Computer` - Gives the agent permission to use the
|
233
|
+
# mouse and keyboard and take screenshots.
|
224
234
|
#
|
235
|
+
# * `ANTHROPIC.TextEditor` - Gives the agent permission to view,
|
236
|
+
# create and edit files.
|
225
237
|
#
|
238
|
+
# * `ANTHROPIC.Bash` - Gives the agent permission to run commands in
|
239
|
+
# a bash shell.
|
226
240
|
#
|
227
|
-
#
|
241
|
+
#
|
242
|
+
#
|
243
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html
|
228
244
|
# @return [String]
|
229
245
|
#
|
246
|
+
# @!attribute [rw] parent_action_group_signature_params
|
247
|
+
# The configuration settings for a computer use action.
|
248
|
+
#
|
249
|
+
# Computer use is a new Anthropic Claude model capability (in beta)
|
250
|
+
# available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For
|
251
|
+
# more information, see [Configure an Amazon Bedrock Agent to complete
|
252
|
+
# tasks with computer use tools][1].
|
253
|
+
#
|
254
|
+
#
|
255
|
+
#
|
256
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html
|
257
|
+
# @return [Hash<String,String>]
|
258
|
+
#
|
230
259
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgentActionGroup AWS API Documentation
|
231
260
|
#
|
232
261
|
class AgentActionGroup < Struct.new(
|
@@ -235,7 +264,8 @@ module Aws::BedrockAgentRuntime
|
|
235
264
|
:api_schema,
|
236
265
|
:description,
|
237
266
|
:function_schema,
|
238
|
-
:parent_action_group_signature
|
267
|
+
:parent_action_group_signature,
|
268
|
+
:parent_action_group_signature_params)
|
239
269
|
SENSITIVE = [:action_group_name, :description]
|
240
270
|
include Aws::Structure
|
241
271
|
end
|
@@ -849,6 +879,117 @@ module Aws::BedrockAgentRuntime
|
|
849
879
|
include Aws::Structure
|
850
880
|
end
|
851
881
|
|
882
|
+
# List of inline collaborators.
|
883
|
+
#
|
884
|
+
# @!attribute [rw] action_groups
|
885
|
+
# List of action groups with each action group defining tasks the
|
886
|
+
# inline collaborator agent needs to carry out.
|
887
|
+
# @return [Array<Types::AgentActionGroup>]
|
888
|
+
#
|
889
|
+
# @!attribute [rw] agent_collaboration
|
890
|
+
# Defines how the inline supervisor agent handles information across
|
891
|
+
# multiple collaborator agents to coordinate a final response.
|
892
|
+
# @return [String]
|
893
|
+
#
|
894
|
+
# @!attribute [rw] agent_name
|
895
|
+
# Name of the inline collaborator agent which must be the same name as
|
896
|
+
# specified for `collaboratorName`.
|
897
|
+
# @return [String]
|
898
|
+
#
|
899
|
+
# @!attribute [rw] collaborator_configurations
|
900
|
+
# Settings of the collaborator agent.
|
901
|
+
# @return [Array<Types::CollaboratorConfiguration>]
|
902
|
+
#
|
903
|
+
# @!attribute [rw] customer_encryption_key_arn
|
904
|
+
# The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the
|
905
|
+
# inline collaborator.
|
906
|
+
# @return [String]
|
907
|
+
#
|
908
|
+
# @!attribute [rw] foundation_model
|
909
|
+
# The foundation model used by the inline collaborator agent.
|
910
|
+
# @return [String]
|
911
|
+
#
|
912
|
+
# @!attribute [rw] guardrail_configuration
|
913
|
+
# Details of the guardwrail associated with the inline collaborator.
|
914
|
+
# @return [Types::GuardrailConfigurationWithArn]
|
915
|
+
#
|
916
|
+
# @!attribute [rw] idle_session_ttl_in_seconds
|
917
|
+
# The number of seconds for which the Amazon Bedrock keeps information
|
918
|
+
# about the user's conversation with the inline collaborator agent.
|
919
|
+
#
|
920
|
+
# A user interaction remains active for the amount of time specified.
|
921
|
+
# If no conversation occurs during this time, the session expires and
|
922
|
+
# Amazon Bedrock deletes any data provided before the timeout.
|
923
|
+
# @return [Integer]
|
924
|
+
#
|
925
|
+
# @!attribute [rw] instruction
|
926
|
+
# Instruction that tell the inline collaborator agent what it should
|
927
|
+
# do and how it should interact with users.
|
928
|
+
# @return [String]
|
929
|
+
#
|
930
|
+
# @!attribute [rw] knowledge_bases
|
931
|
+
# Knowledge base associated with the inline collaborator agent.
|
932
|
+
# @return [Array<Types::KnowledgeBase>]
|
933
|
+
#
|
934
|
+
# @!attribute [rw] prompt_override_configuration
|
935
|
+
# Contains configurations to override prompt templates in different
|
936
|
+
# parts of an inline collaborator sequence. For more information, see
|
937
|
+
# [Advanced prompts][1].
|
938
|
+
#
|
939
|
+
#
|
940
|
+
#
|
941
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
|
942
|
+
# @return [Types::PromptOverrideConfiguration]
|
943
|
+
#
|
944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Collaborator AWS API Documentation
|
945
|
+
#
|
946
|
+
class Collaborator < Struct.new(
|
947
|
+
:action_groups,
|
948
|
+
:agent_collaboration,
|
949
|
+
:agent_name,
|
950
|
+
:collaborator_configurations,
|
951
|
+
:customer_encryption_key_arn,
|
952
|
+
:foundation_model,
|
953
|
+
:guardrail_configuration,
|
954
|
+
:idle_session_ttl_in_seconds,
|
955
|
+
:instruction,
|
956
|
+
:knowledge_bases,
|
957
|
+
:prompt_override_configuration)
|
958
|
+
SENSITIVE = [:agent_name, :instruction, :prompt_override_configuration]
|
959
|
+
include Aws::Structure
|
960
|
+
end
|
961
|
+
|
962
|
+
# Settings of an inline collaborator agent.
|
963
|
+
#
|
964
|
+
# @!attribute [rw] agent_alias_arn
|
965
|
+
# The Amazon Resource Name (ARN) of the inline collaborator agent.
|
966
|
+
# @return [String]
|
967
|
+
#
|
968
|
+
# @!attribute [rw] collaborator_instruction
|
969
|
+
# Instructions that tell the inline collaborator agent what it should
|
970
|
+
# do and how it should interact with users.
|
971
|
+
# @return [String]
|
972
|
+
#
|
973
|
+
# @!attribute [rw] collaborator_name
|
974
|
+
# Name of the inline collaborator agent which must be the same name as
|
975
|
+
# specified for `agentName`.
|
976
|
+
# @return [String]
|
977
|
+
#
|
978
|
+
# @!attribute [rw] relay_conversation_history
|
979
|
+
# A relay conversation history for the inline collaborator agent.
|
980
|
+
# @return [String]
|
981
|
+
#
|
982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/CollaboratorConfiguration AWS API Documentation
|
983
|
+
#
|
984
|
+
class CollaboratorConfiguration < Struct.new(
|
985
|
+
:agent_alias_arn,
|
986
|
+
:collaborator_instruction,
|
987
|
+
:collaborator_name,
|
988
|
+
:relay_conversation_history)
|
989
|
+
SENSITIVE = [:collaborator_instruction, :collaborator_name]
|
990
|
+
include Aws::Structure
|
991
|
+
end
|
992
|
+
|
852
993
|
# There was a conflict performing an operation. Resolve the conflict and
|
853
994
|
# retry your request.
|
854
995
|
#
|
@@ -902,10 +1043,23 @@ module Aws::BedrockAgentRuntime
|
|
902
1043
|
# The body of the API response.
|
903
1044
|
# @return [String]
|
904
1045
|
#
|
1046
|
+
# @!attribute [rw] images
|
1047
|
+
# Lists details, including format and source, for the image in the
|
1048
|
+
# response from the function call. You can specify only one image and
|
1049
|
+
# the function in the `returnControlInvocationResults` must be a
|
1050
|
+
# computer use action. For more information, see [Configure an Amazon
|
1051
|
+
# Bedrock Agent to complete tasks with computer use tools][1].
|
1052
|
+
#
|
1053
|
+
#
|
1054
|
+
#
|
1055
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html
|
1056
|
+
# @return [Array<Types::ImageInput>]
|
1057
|
+
#
|
905
1058
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ContentBody AWS API Documentation
|
906
1059
|
#
|
907
1060
|
class ContentBody < Struct.new(
|
908
|
-
:body
|
1061
|
+
:body,
|
1062
|
+
:images)
|
909
1063
|
SENSITIVE = []
|
910
1064
|
include Aws::Structure
|
911
1065
|
end
|
@@ -1975,10 +2129,18 @@ module Aws::BedrockAgentRuntime
|
|
1975
2129
|
# @return [String]
|
1976
2130
|
#
|
1977
2131
|
# @!attribute [rw] response_body
|
1978
|
-
# The response from the function call using the parameters. The
|
1979
|
-
#
|
1980
|
-
#
|
1981
|
-
#
|
2132
|
+
# The response from the function call using the parameters. The
|
2133
|
+
# response might be returned directly or from the Lambda function.
|
2134
|
+
# Specify `TEXT` or `IMAGES`. The key of the object is the content
|
2135
|
+
# type. You can only specify one type. If you specify `IMAGES`, you
|
2136
|
+
# can specify only one image. You can specify images only when the
|
2137
|
+
# function in the `returnControlInvocationResults` is a computer use
|
2138
|
+
# action. For more information, see [Configure an Amazon Bedrock Agent
|
2139
|
+
# to complete tasks with computer use tools][1].
|
2140
|
+
#
|
2141
|
+
#
|
2142
|
+
#
|
2143
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html
|
1982
2144
|
# @return [Hash<String,Types::ContentBody>]
|
1983
2145
|
#
|
1984
2146
|
# @!attribute [rw] response_state
|
@@ -2667,6 +2829,57 @@ module Aws::BedrockAgentRuntime
|
|
2667
2829
|
include Aws::Structure
|
2668
2830
|
end
|
2669
2831
|
|
2832
|
+
# Details about an image in the result from a function in the action
|
2833
|
+
# group invocation. You can specify images only when the function is a
|
2834
|
+
# computer use action. For more information, see [Configure an Amazon
|
2835
|
+
# Bedrock Agent to complete tasks with computer use tools][1].
|
2836
|
+
#
|
2837
|
+
#
|
2838
|
+
#
|
2839
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html
|
2840
|
+
#
|
2841
|
+
# @!attribute [rw] format
|
2842
|
+
# The type of image in the result.
|
2843
|
+
# @return [String]
|
2844
|
+
#
|
2845
|
+
# @!attribute [rw] source
|
2846
|
+
# The source of the image in the result.
|
2847
|
+
# @return [Types::ImageInputSource]
|
2848
|
+
#
|
2849
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ImageInput AWS API Documentation
|
2850
|
+
#
|
2851
|
+
class ImageInput < Struct.new(
|
2852
|
+
:format,
|
2853
|
+
:source)
|
2854
|
+
SENSITIVE = []
|
2855
|
+
include Aws::Structure
|
2856
|
+
end
|
2857
|
+
|
2858
|
+
# Details about the source of an input image in the result from a
|
2859
|
+
# function in the action group invocation.
|
2860
|
+
#
|
2861
|
+
# @note ImageInputSource is a union - when making an API calls you must set exactly one of the members.
|
2862
|
+
#
|
2863
|
+
# @note ImageInputSource is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ImageInputSource corresponding to the set member.
|
2864
|
+
#
|
2865
|
+
# @!attribute [rw] bytes
|
2866
|
+
# The raw image bytes for the image. If you use an Amazon Web Services
|
2867
|
+
# SDK, you don't need to encode the image bytes in base64.
|
2868
|
+
# @return [String]
|
2869
|
+
#
|
2870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ImageInputSource AWS API Documentation
|
2871
|
+
#
|
2872
|
+
class ImageInputSource < Struct.new(
|
2873
|
+
:bytes,
|
2874
|
+
:unknown)
|
2875
|
+
SENSITIVE = []
|
2876
|
+
include Aws::Structure
|
2877
|
+
include Aws::Structure::Union
|
2878
|
+
|
2879
|
+
class Bytes < ImageInputSource; end
|
2880
|
+
class Unknown < ImageInputSource; end
|
2881
|
+
end
|
2882
|
+
|
2670
2883
|
# The source for an image.
|
2671
2884
|
#
|
2672
2885
|
# @note ImageSource is a union - when making an API calls you must set exactly one of the members.
|
@@ -2918,6 +3131,10 @@ module Aws::BedrockAgentRuntime
|
|
2918
3131
|
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html
|
2919
3132
|
# [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html
|
2920
3133
|
#
|
3134
|
+
# @!attribute [rw] conversation_history
|
3135
|
+
# Contains the conversation history that persist across sessions.
|
3136
|
+
# @return [Types::ConversationHistory]
|
3137
|
+
#
|
2921
3138
|
# @!attribute [rw] files
|
2922
3139
|
# Contains information about the files used by code interpreter.
|
2923
3140
|
# @return [Array<Types::InputFile>]
|
@@ -2962,6 +3179,7 @@ module Aws::BedrockAgentRuntime
|
|
2962
3179
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InlineSessionState AWS API Documentation
|
2963
3180
|
#
|
2964
3181
|
class InlineSessionState < Struct.new(
|
3182
|
+
:conversation_history,
|
2965
3183
|
:files,
|
2966
3184
|
:invocation_id,
|
2967
3185
|
:prompt_session_attributes,
|
@@ -3479,10 +3697,29 @@ module Aws::BedrockAgentRuntime
|
|
3479
3697
|
# the inline agent needs to carry out.
|
3480
3698
|
# @return [Array<Types::AgentActionGroup>]
|
3481
3699
|
#
|
3700
|
+
# @!attribute [rw] agent_collaboration
|
3701
|
+
# Defines how the inline collaborator agent handles information across
|
3702
|
+
# multiple collaborator agents to coordinate a final response. The
|
3703
|
+
# inline collaborator agent can also be the supervisor.
|
3704
|
+
# @return [String]
|
3705
|
+
#
|
3482
3706
|
# @!attribute [rw] bedrock_model_configurations
|
3483
3707
|
# Model settings for the request.
|
3484
3708
|
# @return [Types::InlineBedrockModelConfigurations]
|
3485
3709
|
#
|
3710
|
+
# @!attribute [rw] collaborator_configurations
|
3711
|
+
# Settings for an inline agent collaborator called with
|
3712
|
+
# [InvokeInlineAgent][1].
|
3713
|
+
#
|
3714
|
+
#
|
3715
|
+
#
|
3716
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeInlineAgent.html
|
3717
|
+
# @return [Array<Types::CollaboratorConfiguration>]
|
3718
|
+
#
|
3719
|
+
# @!attribute [rw] collaborators
|
3720
|
+
# List of collaborator inline agents.
|
3721
|
+
# @return [Array<Types::Collaborator>]
|
3722
|
+
#
|
3486
3723
|
# @!attribute [rw] customer_encryption_key_arn
|
3487
3724
|
# The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to
|
3488
3725
|
# use to encrypt your inline agent.
|
@@ -3587,7 +3824,10 @@ module Aws::BedrockAgentRuntime
|
|
3587
3824
|
#
|
3588
3825
|
class InvokeInlineAgentRequest < Struct.new(
|
3589
3826
|
:action_groups,
|
3827
|
+
:agent_collaboration,
|
3590
3828
|
:bedrock_model_configurations,
|
3829
|
+
:collaborator_configurations,
|
3830
|
+
:collaborators,
|
3591
3831
|
:customer_encryption_key_arn,
|
3592
3832
|
:enable_trace,
|
3593
3833
|
:end_session,
|
@@ -4984,6 +5224,10 @@ module Aws::BedrockAgentRuntime
|
|
4984
5224
|
# [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts-configure.html
|
4985
5225
|
# @return [String]
|
4986
5226
|
#
|
5227
|
+
# @!attribute [rw] foundation_model
|
5228
|
+
# The foundation model to use.
|
5229
|
+
# @return [String]
|
5230
|
+
#
|
4987
5231
|
# @!attribute [rw] inference_configuration
|
4988
5232
|
# Contains inference parameters to use when the agent invokes a
|
4989
5233
|
# foundation model in the part of the agent sequence defined by the
|
@@ -5040,6 +5284,7 @@ module Aws::BedrockAgentRuntime
|
|
5040
5284
|
class PromptConfiguration < Struct.new(
|
5041
5285
|
:additional_model_request_fields,
|
5042
5286
|
:base_prompt_template,
|
5287
|
+
:foundation_model,
|
5043
5288
|
:inference_configuration,
|
5044
5289
|
:parser_mode,
|
5045
5290
|
:prompt_creation_mode,
|
@@ -5676,9 +5921,12 @@ module Aws::BedrockAgentRuntime
|
|
5676
5921
|
# @return [Types::FilterAttribute]
|
5677
5922
|
#
|
5678
5923
|
# @!attribute [rw] not_equals
|
5679
|
-
# Knowledge base data sources
|
5680
|
-
#
|
5681
|
-
#
|
5924
|
+
# Knowledge base data sources are returned when:
|
5925
|
+
#
|
5926
|
+
# * It contains a metadata attribute whose name matches the `key` and
|
5927
|
+
# whose value doesn't match the `value` in this object.
|
5928
|
+
#
|
5929
|
+
# * The key is not present in the document.
|
5682
5930
|
#
|
5683
5931
|
# The following example would return data sources that don't contain
|
5684
5932
|
# an `animal` attribute whose value is `cat`.
|
@@ -6067,8 +6315,10 @@ module Aws::BedrockAgentRuntime
|
|
6067
6315
|
# The type of resource that contains your data for retrieving
|
6068
6316
|
# information and generating responses.
|
6069
6317
|
#
|
6070
|
-
# If you choose to use `EXTERNAL_SOURCES`, then currently only
|
6318
|
+
# <note markdown="1"> If you choose to use `EXTERNAL_SOURCES`, then currently only
|
6071
6319
|
# Anthropic Claude 3 Sonnet models for knowledge bases are supported.
|
6320
|
+
#
|
6321
|
+
# </note>
|
6072
6322
|
# @return [String]
|
6073
6323
|
#
|
6074
6324
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateConfiguration AWS API Documentation
|
@@ -6632,14 +6882,20 @@ module Aws::BedrockAgentRuntime
|
|
6632
6882
|
#
|
6633
6883
|
# @!attribute [rw] prompt_session_attributes
|
6634
6884
|
# Contains attributes that persist across a prompt and the values of
|
6635
|
-
# those attributes.
|
6636
|
-
#
|
6637
|
-
# orchestration prompt template
|
6638
|
-
#
|
6885
|
+
# those attributes.
|
6886
|
+
#
|
6887
|
+
# * In orchestration prompt template, these attributes replace the
|
6888
|
+
# $prompt\_session\_attributes$ placeholder variable. For more
|
6889
|
+
# information, see [Prompt template placeholder variables][1].
|
6890
|
+
#
|
6891
|
+
# * In [multi-agent collaboration][2], the `promptSessionAttributes`
|
6892
|
+
# will only be used by supervisor agent when
|
6893
|
+
# $prompt\_session\_attributes$ is present in prompt template.
|
6639
6894
|
#
|
6640
6895
|
#
|
6641
6896
|
#
|
6642
6897
|
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html
|
6898
|
+
# [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-multi-agent-collaboration.html
|
6643
6899
|
# @return [Hash<String,String>]
|
6644
6900
|
#
|
6645
6901
|
# @!attribute [rw] return_control_invocation_results
|
@@ -6659,7 +6915,13 @@ module Aws::BedrockAgentRuntime
|
|
6659
6915
|
#
|
6660
6916
|
# @!attribute [rw] session_attributes
|
6661
6917
|
# Contains attributes that persist across a session and the values of
|
6662
|
-
# those attributes.
|
6918
|
+
# those attributes. If `sessionAttributes` are passed to a supervisor
|
6919
|
+
# agent in [multi-agent collaboration][1], it will be forwarded to all
|
6920
|
+
# agent collaborators.
|
6921
|
+
#
|
6922
|
+
#
|
6923
|
+
#
|
6924
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-multi-agent-collaboration.html
|
6663
6925
|
# @return [Hash<String,String>]
|
6664
6926
|
#
|
6665
6927
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/SessionState AWS API Documentation
|
@@ -7038,6 +7300,10 @@ module Aws::BedrockAgentRuntime
|
|
7038
7300
|
# The part's collaborator name.
|
7039
7301
|
# @return [String]
|
7040
7302
|
#
|
7303
|
+
# @!attribute [rw] event_time
|
7304
|
+
# The time of the trace.
|
7305
|
+
# @return [Time]
|
7306
|
+
#
|
7041
7307
|
# @!attribute [rw] session_id
|
7042
7308
|
# The unique identifier of the session with the agent.
|
7043
7309
|
# @return [String]
|
@@ -7062,6 +7328,7 @@ module Aws::BedrockAgentRuntime
|
|
7062
7328
|
:agent_version,
|
7063
7329
|
:caller_chain,
|
7064
7330
|
:collaborator_name,
|
7331
|
+
:event_time,
|
7065
7332
|
:session_id,
|
7066
7333
|
:trace,
|
7067
7334
|
:event_type)
|