aws-sdk-bedrockagent 1.5.0 → 1.6.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 80b73b4178615eca1840c0377574039840c5368e66123261f10a064926a327bf
4
- data.tar.gz: 73b552c48974c6e281c8b63bc21843b65a284d05203e3e2643599e82e6a634fd
3
+ metadata.gz: 4143ef9fc133a2aa9e2e22ab708a4cb72745bc76f1cd11abe0ac678d5650d6f0
4
+ data.tar.gz: cf65e144ace6118b6f5df92b22f0890281f2ae19dc8f1546a575d19e8b2b8ffa
5
5
  SHA512:
6
- metadata.gz: 61e7c6fe4dafdffbbb21589841574d19daf132a5cb86996c0077e6149e644c60ab4654195a85e1006150fde581ef40cd1b5568c12b575b3b57d46fb7a5edc1cb
7
- data.tar.gz: 33d9520e08888caab081d1055ff95448570813fa3688a949bbe88e2d3599f761d00aba1ed419fb9df7c6705e58278c9d82e18ca742bc72696cd054449b06d490
6
+ metadata.gz: 232bbcb77048085704f02652b46fcf8ff483c89c1274cfcdf5279d9911a50a077ff9427c847960517e46d5fbdd756849bd7a882898aef9df89052ef000648433
7
+ data.tar.gz: d26a5cb5f8b3a0601b0a5fd7f89c48c181a0dfdc4616cc496f56a3d75154de4fe175b1702e8981a57dfedea5e16950160acfd1ca59a9584049fa6433ed33e064
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.6.0 (2024-04-22)
5
+ ------------------
6
+
7
+ * Feature - Releasing the support for simplified configuration and return of control
8
+
4
9
  1.5.0 (2024-04-16)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.5.0
1
+ 1.6.0
@@ -681,6 +681,10 @@ module Aws::BedrockAgent
681
681
  # @option params [String] :description
682
682
  # A description of the action group.
683
683
  #
684
+ # @option params [Types::FunctionSchema] :function_schema
685
+ # Contains details about the function schema for the action group or the
686
+ # JSON or YAML-formatted payload defining the schema.
687
+ #
684
688
  # @option params [String] :parent_action_group_signature
685
689
  # To allow your agent to request the user for additional information
686
690
  # when trying to complete a task, set this field to `AMAZON.UserInput`.
@@ -704,6 +708,7 @@ module Aws::BedrockAgent
704
708
  #
705
709
  # resp = client.create_agent_action_group({
706
710
  # action_group_executor: {
711
+ # custom_control: "RETURN_CONTROL", # accepts RETURN_CONTROL
707
712
  # lambda: "LambdaArn",
708
713
  # },
709
714
  # action_group_name: "Name", # required
@@ -719,11 +724,27 @@ module Aws::BedrockAgent
719
724
  # },
720
725
  # client_token: "ClientToken",
721
726
  # description: "Description",
727
+ # function_schema: {
728
+ # functions: [
729
+ # {
730
+ # description: "FunctionDescription",
731
+ # name: "Name", # required
732
+ # parameters: {
733
+ # "Name" => {
734
+ # description: "ParameterDescription",
735
+ # required: false,
736
+ # type: "string", # required, accepts string, number, integer, boolean, array
737
+ # },
738
+ # },
739
+ # },
740
+ # ],
741
+ # },
722
742
  # parent_action_group_signature: "AMAZON.UserInput", # accepts AMAZON.UserInput
723
743
  # })
724
744
  #
725
745
  # @example Response structure
726
746
  #
747
+ # resp.agent_action_group.action_group_executor.custom_control #=> String, one of "RETURN_CONTROL"
727
748
  # resp.agent_action_group.action_group_executor.lambda #=> String
728
749
  # resp.agent_action_group.action_group_id #=> String
729
750
  # resp.agent_action_group.action_group_name #=> String
@@ -736,6 +757,13 @@ module Aws::BedrockAgent
736
757
  # resp.agent_action_group.client_token #=> String
737
758
  # resp.agent_action_group.created_at #=> Time
738
759
  # resp.agent_action_group.description #=> String
760
+ # resp.agent_action_group.function_schema.functions #=> Array
761
+ # resp.agent_action_group.function_schema.functions[0].description #=> String
762
+ # resp.agent_action_group.function_schema.functions[0].name #=> String
763
+ # resp.agent_action_group.function_schema.functions[0].parameters #=> Hash
764
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].description #=> String
765
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].required #=> Boolean
766
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].type #=> String, one of "string", "number", "integer", "boolean", "array"
739
767
  # resp.agent_action_group.parent_action_signature #=> String, one of "AMAZON.UserInput"
740
768
  # resp.agent_action_group.updated_at #=> Time
741
769
  #
@@ -1459,6 +1487,7 @@ module Aws::BedrockAgent
1459
1487
  #
1460
1488
  # @example Response structure
1461
1489
  #
1490
+ # resp.agent_action_group.action_group_executor.custom_control #=> String, one of "RETURN_CONTROL"
1462
1491
  # resp.agent_action_group.action_group_executor.lambda #=> String
1463
1492
  # resp.agent_action_group.action_group_id #=> String
1464
1493
  # resp.agent_action_group.action_group_name #=> String
@@ -1471,6 +1500,13 @@ module Aws::BedrockAgent
1471
1500
  # resp.agent_action_group.client_token #=> String
1472
1501
  # resp.agent_action_group.created_at #=> Time
1473
1502
  # resp.agent_action_group.description #=> String
1503
+ # resp.agent_action_group.function_schema.functions #=> Array
1504
+ # resp.agent_action_group.function_schema.functions[0].description #=> String
1505
+ # resp.agent_action_group.function_schema.functions[0].name #=> String
1506
+ # resp.agent_action_group.function_schema.functions[0].parameters #=> Hash
1507
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].description #=> String
1508
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].required #=> Boolean
1509
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].type #=> String, one of "string", "number", "integer", "boolean", "array"
1474
1510
  # resp.agent_action_group.parent_action_signature #=> String, one of "AMAZON.UserInput"
1475
1511
  # resp.agent_action_group.updated_at #=> Time
1476
1512
  #
@@ -2610,6 +2646,10 @@ module Aws::BedrockAgent
2610
2646
  # @option params [String] :description
2611
2647
  # Specifies a new name for the action group.
2612
2648
  #
2649
+ # @option params [Types::FunctionSchema] :function_schema
2650
+ # Contains details about the function schema for the action group or the
2651
+ # JSON or YAML-formatted payload defining the schema.
2652
+ #
2613
2653
  # @option params [String] :parent_action_group_signature
2614
2654
  # To allow your agent to request the user for additional information
2615
2655
  # when trying to complete a task, set this field to `AMAZON.UserInput`.
@@ -2633,6 +2673,7 @@ module Aws::BedrockAgent
2633
2673
  #
2634
2674
  # resp = client.update_agent_action_group({
2635
2675
  # action_group_executor: {
2676
+ # custom_control: "RETURN_CONTROL", # accepts RETURN_CONTROL
2636
2677
  # lambda: "LambdaArn",
2637
2678
  # },
2638
2679
  # action_group_id: "Id", # required
@@ -2648,11 +2689,27 @@ module Aws::BedrockAgent
2648
2689
  # },
2649
2690
  # },
2650
2691
  # description: "Description",
2692
+ # function_schema: {
2693
+ # functions: [
2694
+ # {
2695
+ # description: "FunctionDescription",
2696
+ # name: "Name", # required
2697
+ # parameters: {
2698
+ # "Name" => {
2699
+ # description: "ParameterDescription",
2700
+ # required: false,
2701
+ # type: "string", # required, accepts string, number, integer, boolean, array
2702
+ # },
2703
+ # },
2704
+ # },
2705
+ # ],
2706
+ # },
2651
2707
  # parent_action_group_signature: "AMAZON.UserInput", # accepts AMAZON.UserInput
2652
2708
  # })
2653
2709
  #
2654
2710
  # @example Response structure
2655
2711
  #
2712
+ # resp.agent_action_group.action_group_executor.custom_control #=> String, one of "RETURN_CONTROL"
2656
2713
  # resp.agent_action_group.action_group_executor.lambda #=> String
2657
2714
  # resp.agent_action_group.action_group_id #=> String
2658
2715
  # resp.agent_action_group.action_group_name #=> String
@@ -2665,6 +2722,13 @@ module Aws::BedrockAgent
2665
2722
  # resp.agent_action_group.client_token #=> String
2666
2723
  # resp.agent_action_group.created_at #=> Time
2667
2724
  # resp.agent_action_group.description #=> String
2725
+ # resp.agent_action_group.function_schema.functions #=> Array
2726
+ # resp.agent_action_group.function_schema.functions[0].description #=> String
2727
+ # resp.agent_action_group.function_schema.functions[0].name #=> String
2728
+ # resp.agent_action_group.function_schema.functions[0].parameters #=> Hash
2729
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].description #=> String
2730
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].required #=> Boolean
2731
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].type #=> String, one of "string", "number", "integer", "boolean", "array"
2668
2732
  # resp.agent_action_group.parent_action_signature #=> String, one of "AMAZON.UserInput"
2669
2733
  # resp.agent_action_group.updated_at #=> Time
2670
2734
  #
@@ -3054,7 +3118,7 @@ module Aws::BedrockAgent
3054
3118
  params: params,
3055
3119
  config: config)
3056
3120
  context[:gem_name] = 'aws-sdk-bedrockagent'
3057
- context[:gem_version] = '1.5.0'
3121
+ context[:gem_version] = '1.6.0'
3058
3122
  Seahorse::Client::Request.new(handlers, context)
3059
3123
  end
3060
3124
 
@@ -64,6 +64,7 @@ module Aws::BedrockAgent
64
64
  CreateKnowledgeBaseRequest = Shapes::StructureShape.new(name: 'CreateKnowledgeBaseRequest')
65
65
  CreateKnowledgeBaseResponse = Shapes::StructureShape.new(name: 'CreateKnowledgeBaseResponse')
66
66
  CreationMode = Shapes::StringShape.new(name: 'CreationMode')
67
+ CustomControlMethod = Shapes::StringShape.new(name: 'CustomControlMethod')
67
68
  DataSource = Shapes::StructureShape.new(name: 'DataSource')
68
69
  DataSourceConfiguration = Shapes::StructureShape.new(name: 'DataSourceConfiguration')
69
70
  DataSourceStatus = Shapes::StringShape.new(name: 'DataSourceStatus')
@@ -93,6 +94,10 @@ module Aws::BedrockAgent
93
94
  FixedSizeChunkingConfiguration = Shapes::StructureShape.new(name: 'FixedSizeChunkingConfiguration')
94
95
  FixedSizeChunkingConfigurationMaxTokensInteger = Shapes::IntegerShape.new(name: 'FixedSizeChunkingConfigurationMaxTokensInteger')
95
96
  FixedSizeChunkingConfigurationOverlapPercentageInteger = Shapes::IntegerShape.new(name: 'FixedSizeChunkingConfigurationOverlapPercentageInteger')
97
+ Function = Shapes::StructureShape.new(name: 'Function')
98
+ FunctionDescription = Shapes::StringShape.new(name: 'FunctionDescription')
99
+ FunctionSchema = Shapes::UnionShape.new(name: 'FunctionSchema')
100
+ Functions = Shapes::ListShape.new(name: 'Functions')
96
101
  GetAgentActionGroupRequest = Shapes::StructureShape.new(name: 'GetAgentActionGroupRequest')
97
102
  GetAgentActionGroupResponse = Shapes::StructureShape.new(name: 'GetAgentActionGroupResponse')
98
103
  GetAgentAliasRequest = Shapes::StructureShape.new(name: 'GetAgentAliasRequest')
@@ -167,6 +172,9 @@ module Aws::BedrockAgent
167
172
  OpenSearchServerlessConfiguration = Shapes::StructureShape.new(name: 'OpenSearchServerlessConfiguration')
168
173
  OpenSearchServerlessFieldMapping = Shapes::StructureShape.new(name: 'OpenSearchServerlessFieldMapping')
169
174
  OpenSearchServerlessIndexName = Shapes::StringShape.new(name: 'OpenSearchServerlessIndexName')
175
+ ParameterDescription = Shapes::StringShape.new(name: 'ParameterDescription')
176
+ ParameterDetail = Shapes::StructureShape.new(name: 'ParameterDetail')
177
+ ParameterMap = Shapes::MapShape.new(name: 'ParameterMap')
170
178
  Payload = Shapes::StringShape.new(name: 'Payload')
171
179
  PineconeConfiguration = Shapes::StructureShape.new(name: 'PineconeConfiguration')
172
180
  PineconeConnectionString = Shapes::StringShape.new(name: 'PineconeConnectionString')
@@ -220,6 +228,7 @@ module Aws::BedrockAgent
220
228
  ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
221
229
  TopK = Shapes::IntegerShape.new(name: 'TopK')
222
230
  TopP = Shapes::FloatShape.new(name: 'TopP')
231
+ Type = Shapes::StringShape.new(name: 'Type')
223
232
  UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
224
233
  UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
225
234
  UpdateAgentActionGroupRequest = Shapes::StructureShape.new(name: 'UpdateAgentActionGroupRequest')
@@ -252,8 +261,10 @@ module Aws::BedrockAgent
252
261
  AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: NonBlankString, location_name: "message"))
253
262
  AccessDeniedException.struct_class = Types::AccessDeniedException
254
263
 
264
+ ActionGroupExecutor.add_member(:custom_control, Shapes::ShapeRef.new(shape: CustomControlMethod, location_name: "customControl"))
255
265
  ActionGroupExecutor.add_member(:lambda, Shapes::ShapeRef.new(shape: LambdaArn, location_name: "lambda"))
256
266
  ActionGroupExecutor.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
267
+ ActionGroupExecutor.add_member_subclass(:custom_control, Types::ActionGroupExecutor::CustomControl)
257
268
  ActionGroupExecutor.add_member_subclass(:lambda, Types::ActionGroupExecutor::Lambda)
258
269
  ActionGroupExecutor.add_member_subclass(:unknown, Types::ActionGroupExecutor::Unknown)
259
270
  ActionGroupExecutor.struct_class = Types::ActionGroupExecutor
@@ -297,6 +308,7 @@ module Aws::BedrockAgent
297
308
  AgentActionGroup.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken"))
298
309
  AgentActionGroup.add_member(:created_at, Shapes::ShapeRef.new(shape: DateTimestamp, required: true, location_name: "createdAt"))
299
310
  AgentActionGroup.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description"))
311
+ AgentActionGroup.add_member(:function_schema, Shapes::ShapeRef.new(shape: FunctionSchema, location_name: "functionSchema"))
300
312
  AgentActionGroup.add_member(:parent_action_signature, Shapes::ShapeRef.new(shape: ActionGroupSignature, location_name: "parentActionSignature"))
301
313
  AgentActionGroup.add_member(:updated_at, Shapes::ShapeRef.new(shape: DateTimestamp, required: true, location_name: "updatedAt"))
302
314
  AgentActionGroup.struct_class = Types::AgentActionGroup
@@ -417,6 +429,7 @@ module Aws::BedrockAgent
417
429
  CreateAgentActionGroupRequest.add_member(:api_schema, Shapes::ShapeRef.new(shape: APISchema, location_name: "apiSchema"))
418
430
  CreateAgentActionGroupRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
419
431
  CreateAgentActionGroupRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description"))
432
+ CreateAgentActionGroupRequest.add_member(:function_schema, Shapes::ShapeRef.new(shape: FunctionSchema, location_name: "functionSchema"))
420
433
  CreateAgentActionGroupRequest.add_member(:parent_action_group_signature, Shapes::ShapeRef.new(shape: ActionGroupSignature, location_name: "parentActionGroupSignature"))
421
434
  CreateAgentActionGroupRequest.struct_class = Types::CreateAgentActionGroupRequest
422
435
 
@@ -563,6 +576,19 @@ module Aws::BedrockAgent
563
576
  FixedSizeChunkingConfiguration.add_member(:overlap_percentage, Shapes::ShapeRef.new(shape: FixedSizeChunkingConfigurationOverlapPercentageInteger, required: true, location_name: "overlapPercentage"))
564
577
  FixedSizeChunkingConfiguration.struct_class = Types::FixedSizeChunkingConfiguration
565
578
 
579
+ Function.add_member(:description, Shapes::ShapeRef.new(shape: FunctionDescription, location_name: "description"))
580
+ Function.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
581
+ Function.add_member(:parameters, Shapes::ShapeRef.new(shape: ParameterMap, location_name: "parameters"))
582
+ Function.struct_class = Types::Function
583
+
584
+ FunctionSchema.add_member(:functions, Shapes::ShapeRef.new(shape: Functions, location_name: "functions"))
585
+ FunctionSchema.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
586
+ FunctionSchema.add_member_subclass(:functions, Types::FunctionSchema::Functions)
587
+ FunctionSchema.add_member_subclass(:unknown, Types::FunctionSchema::Unknown)
588
+ FunctionSchema.struct_class = Types::FunctionSchema
589
+
590
+ Functions.member = Shapes::ShapeRef.new(shape: Function)
591
+
566
592
  GetAgentActionGroupRequest.add_member(:action_group_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "actionGroupId"))
567
593
  GetAgentActionGroupRequest.add_member(:agent_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "agentId"))
568
594
  GetAgentActionGroupRequest.add_member(:agent_version, Shapes::ShapeRef.new(shape: Version, required: true, location: "uri", location_name: "agentVersion"))
@@ -792,6 +818,14 @@ module Aws::BedrockAgent
792
818
  OpenSearchServerlessFieldMapping.add_member(:vector_field, Shapes::ShapeRef.new(shape: FieldName, required: true, location_name: "vectorField"))
793
819
  OpenSearchServerlessFieldMapping.struct_class = Types::OpenSearchServerlessFieldMapping
794
820
 
821
+ ParameterDetail.add_member(:description, Shapes::ShapeRef.new(shape: ParameterDescription, location_name: "description"))
822
+ ParameterDetail.add_member(:required, Shapes::ShapeRef.new(shape: Boolean, location_name: "required"))
823
+ ParameterDetail.add_member(:type, Shapes::ShapeRef.new(shape: Type, required: true, location_name: "type"))
824
+ ParameterDetail.struct_class = Types::ParameterDetail
825
+
826
+ ParameterMap.key = Shapes::ShapeRef.new(shape: Name)
827
+ ParameterMap.value = Shapes::ShapeRef.new(shape: ParameterDetail)
828
+
795
829
  PineconeConfiguration.add_member(:connection_string, Shapes::ShapeRef.new(shape: PineconeConnectionString, required: true, location_name: "connectionString"))
796
830
  PineconeConfiguration.add_member(:credentials_secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "credentialsSecretArn"))
797
831
  PineconeConfiguration.add_member(:field_mapping, Shapes::ShapeRef.new(shape: PineconeFieldMapping, required: true, location_name: "fieldMapping"))
@@ -916,6 +950,7 @@ module Aws::BedrockAgent
916
950
  UpdateAgentActionGroupRequest.add_member(:agent_version, Shapes::ShapeRef.new(shape: DraftVersion, required: true, location: "uri", location_name: "agentVersion"))
917
951
  UpdateAgentActionGroupRequest.add_member(:api_schema, Shapes::ShapeRef.new(shape: APISchema, location_name: "apiSchema"))
918
952
  UpdateAgentActionGroupRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description"))
953
+ UpdateAgentActionGroupRequest.add_member(:function_schema, Shapes::ShapeRef.new(shape: FunctionSchema, location_name: "functionSchema"))
919
954
  UpdateAgentActionGroupRequest.add_member(:parent_action_group_signature, Shapes::ShapeRef.new(shape: ActionGroupSignature, location_name: "parentActionGroupSignature"))
920
955
  UpdateAgentActionGroupRequest.struct_class = Types::UpdateAgentActionGroupRequest
921
956
 
@@ -79,6 +79,11 @@ module Aws::BedrockAgent
79
79
  #
80
80
  # @note ActionGroupExecutor is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ActionGroupExecutor corresponding to the set member.
81
81
  #
82
+ # @!attribute [rw] custom_control
83
+ # To return the action group invocation results directly in the
84
+ # `InvokeAgent` response, specify `RETURN_CONTROL`.
85
+ # @return [String]
86
+ #
82
87
  # @!attribute [rw] lambda
83
88
  # The Amazon Resource Name (ARN) of the Lambda function containing the
84
89
  # business logic that is carried out upon invoking the action.
@@ -87,12 +92,14 @@ module Aws::BedrockAgent
87
92
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ActionGroupExecutor AWS API Documentation
88
93
  #
89
94
  class ActionGroupExecutor < Struct.new(
95
+ :custom_control,
90
96
  :lambda,
91
97
  :unknown)
92
98
  SENSITIVE = []
93
99
  include Aws::Structure
94
100
  include Aws::Structure::Union
95
101
 
102
+ class CustomControl < ActionGroupExecutor; end
96
103
  class Lambda < ActionGroupExecutor; end
97
104
  class Unknown < ActionGroupExecutor; end
98
105
  end
@@ -335,6 +342,12 @@ module Aws::BedrockAgent
335
342
  # The description of the action group.
336
343
  # @return [String]
337
344
  #
345
+ # @!attribute [rw] function_schema
346
+ # Defines functions that each define parameters that the agent needs
347
+ # to invoke from the user. Each function represents an action in an
348
+ # action group.
349
+ # @return [Types::FunctionSchema]
350
+ #
338
351
  # @!attribute [rw] parent_action_signature
339
352
  # If this field is set as `AMAZON.UserInput`, the agent can request
340
353
  # the user for additional information when trying to complete a task.
@@ -369,6 +382,7 @@ module Aws::BedrockAgent
369
382
  :client_token,
370
383
  :created_at,
371
384
  :description,
385
+ :function_schema,
372
386
  :parent_action_signature,
373
387
  :updated_at)
374
388
  SENSITIVE = []
@@ -975,6 +989,11 @@ module Aws::BedrockAgent
975
989
  # A description of the action group.
976
990
  # @return [String]
977
991
  #
992
+ # @!attribute [rw] function_schema
993
+ # Contains details about the function schema for the action group or
994
+ # the JSON or YAML-formatted payload defining the schema.
995
+ # @return [Types::FunctionSchema]
996
+ #
978
997
  # @!attribute [rw] parent_action_group_signature
979
998
  # To allow your agent to request the user for additional information
980
999
  # when trying to complete a task, set this field to
@@ -1003,6 +1022,7 @@ module Aws::BedrockAgent
1003
1022
  :api_schema,
1004
1023
  :client_token,
1005
1024
  :description,
1025
+ :function_schema,
1006
1026
  :parent_action_group_signature)
1007
1027
  SENSITIVE = []
1008
1028
  include Aws::Structure
@@ -1707,6 +1727,97 @@ module Aws::BedrockAgent
1707
1727
  include Aws::Structure
1708
1728
  end
1709
1729
 
1730
+ # Defines parameters that the agent needs to invoke from the user to
1731
+ # complete the function. Corresponds to an action in an action group.
1732
+ #
1733
+ # This data type is used in the following API operations:
1734
+ #
1735
+ # * [CreateAgentActionGroup request][1]
1736
+ #
1737
+ # * [CreateAgentActionGroup response][2]
1738
+ #
1739
+ # * [UpdateAgentActionGroup request][3]
1740
+ #
1741
+ # * [UpdateAgentActionGroup response][4]
1742
+ #
1743
+ # * [GetAgentActionGroup response][5]
1744
+ #
1745
+ #
1746
+ #
1747
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax
1748
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax
1749
+ # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax
1750
+ # [4]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax
1751
+ # [5]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax
1752
+ #
1753
+ # @!attribute [rw] description
1754
+ # A description of the function and its purpose.
1755
+ # @return [String]
1756
+ #
1757
+ # @!attribute [rw] name
1758
+ # A name for the function.
1759
+ # @return [String]
1760
+ #
1761
+ # @!attribute [rw] parameters
1762
+ # The parameters that the agent elicits from the user to fulfill the
1763
+ # function.
1764
+ # @return [Hash<String,Types::ParameterDetail>]
1765
+ #
1766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/Function AWS API Documentation
1767
+ #
1768
+ class Function < Struct.new(
1769
+ :description,
1770
+ :name,
1771
+ :parameters)
1772
+ SENSITIVE = []
1773
+ include Aws::Structure
1774
+ end
1775
+
1776
+ # Defines functions that each define parameters that the agent needs to
1777
+ # invoke from the user. Each function represents an action in an action
1778
+ # group.
1779
+ #
1780
+ # This data type is used in the following API operations:
1781
+ #
1782
+ # * [CreateAgentActionGroup request][1]
1783
+ #
1784
+ # * [CreateAgentActionGroup response][2]
1785
+ #
1786
+ # * [UpdateAgentActionGroup request][3]
1787
+ #
1788
+ # * [UpdateAgentActionGroup response][4]
1789
+ #
1790
+ # * [GetAgentActionGroup response][5]
1791
+ #
1792
+ #
1793
+ #
1794
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax
1795
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax
1796
+ # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax
1797
+ # [4]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax
1798
+ # [5]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax
1799
+ #
1800
+ # @note FunctionSchema is a union - when making an API calls you must set exactly one of the members.
1801
+ #
1802
+ # @note FunctionSchema is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FunctionSchema corresponding to the set member.
1803
+ #
1804
+ # @!attribute [rw] functions
1805
+ # A list of functions that each define an action in the action group.
1806
+ # @return [Array<Types::Function>]
1807
+ #
1808
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FunctionSchema AWS API Documentation
1809
+ #
1810
+ class FunctionSchema < Struct.new(
1811
+ :functions,
1812
+ :unknown)
1813
+ SENSITIVE = []
1814
+ include Aws::Structure
1815
+ include Aws::Structure::Union
1816
+
1817
+ class Functions < FunctionSchema; end
1818
+ class Unknown < FunctionSchema; end
1819
+ end
1820
+
1710
1821
  # @!attribute [rw] action_group_id
1711
1822
  # The unique identifier of the action group for which to get
1712
1823
  # information.
@@ -2022,7 +2133,7 @@ module Aws::BedrockAgent
2022
2133
  #
2023
2134
  # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_StartIngestionJob.html#API_agent_StartIngestionJob_ResponseSyntax
2024
2135
  # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetIngestionJob.html#API_agent_GetIngestionJob_ResponseSyntax
2025
- # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJob.html#API_agent_ListIngestionJob_ResponseSyntax
2136
+ # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html#API_agent_ListIngestionJobs_ResponseSyntax
2026
2137
  #
2027
2138
  # @!attribute [rw] data_source_id
2028
2139
  # The unique identifier of the ingested data source.
@@ -2864,6 +2975,52 @@ module Aws::BedrockAgent
2864
2975
  include Aws::Structure
2865
2976
  end
2866
2977
 
2978
+ # Contains details about a parameter in a function for an action group.
2979
+ #
2980
+ # This data type is used in the following API operations:
2981
+ #
2982
+ # * [CreateAgentActionGroup request][1]
2983
+ #
2984
+ # * [CreateAgentActionGroup response][2]
2985
+ #
2986
+ # * [UpdateAgentActionGroup request][3]
2987
+ #
2988
+ # * [UpdateAgentActionGroup response][4]
2989
+ #
2990
+ # * [GetAgentActionGroup response][5]
2991
+ #
2992
+ #
2993
+ #
2994
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax
2995
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax
2996
+ # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax
2997
+ # [4]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax
2998
+ # [5]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax
2999
+ #
3000
+ # @!attribute [rw] description
3001
+ # A description of the parameter. Helps the foundation model determine
3002
+ # how to elicit the parameters from the user.
3003
+ # @return [String]
3004
+ #
3005
+ # @!attribute [rw] required
3006
+ # Whether the parameter is required for the agent to complete the
3007
+ # function for action group invocation.
3008
+ # @return [Boolean]
3009
+ #
3010
+ # @!attribute [rw] type
3011
+ # The data type of the parameter.
3012
+ # @return [String]
3013
+ #
3014
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ParameterDetail AWS API Documentation
3015
+ #
3016
+ class ParameterDetail < Struct.new(
3017
+ :description,
3018
+ :required,
3019
+ :type)
3020
+ SENSITIVE = []
3021
+ include Aws::Structure
3022
+ end
3023
+
2867
3024
  # Contains details about the storage configuration of the knowledge base
2868
3025
  # in Pinecone. For more information, see [Create a vector index in
2869
3026
  # Pinecone][1].
@@ -3509,6 +3666,11 @@ module Aws::BedrockAgent
3509
3666
  # Specifies a new name for the action group.
3510
3667
  # @return [String]
3511
3668
  #
3669
+ # @!attribute [rw] function_schema
3670
+ # Contains details about the function schema for the action group or
3671
+ # the JSON or YAML-formatted payload defining the schema.
3672
+ # @return [Types::FunctionSchema]
3673
+ #
3512
3674
  # @!attribute [rw] parent_action_group_signature
3513
3675
  # To allow your agent to request the user for additional information
3514
3676
  # when trying to complete a task, set this field to
@@ -3537,6 +3699,7 @@ module Aws::BedrockAgent
3537
3699
  :agent_version,
3538
3700
  :api_schema,
3539
3701
  :description,
3702
+ :function_schema,
3540
3703
  :parent_action_group_signature)
3541
3704
  SENSITIVE = []
3542
3705
  include Aws::Structure
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-bedrockagent/customizations'
52
52
  # @!group service
53
53
  module Aws::BedrockAgent
54
54
 
55
- GEM_VERSION = '1.5.0'
55
+ GEM_VERSION = '1.6.0'
56
56
 
57
57
  end
data/sig/client.rbs CHANGED
@@ -130,6 +130,7 @@ module Aws
130
130
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#create_agent_action_group-instance_method
131
131
  def create_agent_action_group: (
132
132
  ?action_group_executor: {
133
+ custom_control: ("RETURN_CONTROL")?,
133
134
  lambda: ::String?
134
135
  },
135
136
  action_group_name: ::String,
@@ -145,6 +146,19 @@ module Aws
145
146
  },
146
147
  ?client_token: ::String,
147
148
  ?description: ::String,
149
+ ?function_schema: {
150
+ functions: Array[
151
+ {
152
+ description: ::String?,
153
+ name: ::String,
154
+ parameters: Hash[::String, {
155
+ description: ::String?,
156
+ required: bool?,
157
+ type: ("string" | "number" | "integer" | "boolean" | "array")
158
+ }]?
159
+ },
160
+ ]?
161
+ },
148
162
  ?parent_action_group_signature: ("AMAZON.UserInput")
149
163
  ) -> _CreateAgentActionGroupResponseSuccess
150
164
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAgentActionGroupResponseSuccess
@@ -653,6 +667,7 @@ module Aws
653
667
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#update_agent_action_group-instance_method
654
668
  def update_agent_action_group: (
655
669
  ?action_group_executor: {
670
+ custom_control: ("RETURN_CONTROL")?,
656
671
  lambda: ::String?
657
672
  },
658
673
  action_group_id: ::String,
@@ -668,6 +683,19 @@ module Aws
668
683
  }?
669
684
  },
670
685
  ?description: ::String,
686
+ ?function_schema: {
687
+ functions: Array[
688
+ {
689
+ description: ::String?,
690
+ name: ::String,
691
+ parameters: Hash[::String, {
692
+ description: ::String?,
693
+ required: bool?,
694
+ type: ("string" | "number" | "integer" | "boolean" | "array")
695
+ }]?
696
+ },
697
+ ]?
698
+ },
671
699
  ?parent_action_group_signature: ("AMAZON.UserInput")
672
700
  ) -> _UpdateAgentActionGroupResponseSuccess
673
701
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAgentActionGroupResponseSuccess
data/sig/types.rbs CHANGED
@@ -28,10 +28,13 @@ module Aws::BedrockAgent
28
28
  end
29
29
 
30
30
  class ActionGroupExecutor
31
+ attr_accessor custom_control: ("RETURN_CONTROL")
31
32
  attr_accessor lambda: ::String
32
33
  attr_accessor unknown: untyped
33
34
  SENSITIVE: []
34
35
 
36
+ class CustomControl < ActionGroupExecutor
37
+ end
35
38
  class Lambda < ActionGroupExecutor
36
39
  end
37
40
  class Unknown < ActionGroupExecutor
@@ -80,6 +83,7 @@ module Aws::BedrockAgent
80
83
  attr_accessor client_token: ::String
81
84
  attr_accessor created_at: ::Time
82
85
  attr_accessor description: ::String
86
+ attr_accessor function_schema: Types::FunctionSchema
83
87
  attr_accessor parent_action_signature: ("AMAZON.UserInput")
84
88
  attr_accessor updated_at: ::Time
85
89
  SENSITIVE: []
@@ -216,6 +220,7 @@ module Aws::BedrockAgent
216
220
  attr_accessor api_schema: Types::APISchema
217
221
  attr_accessor client_token: ::String
218
222
  attr_accessor description: ::String
223
+ attr_accessor function_schema: Types::FunctionSchema
219
224
  attr_accessor parent_action_group_signature: ("AMAZON.UserInput")
220
225
  SENSITIVE: []
221
226
  end
@@ -411,6 +416,24 @@ module Aws::BedrockAgent
411
416
  SENSITIVE: []
412
417
  end
413
418
 
419
+ class Function
420
+ attr_accessor description: ::String
421
+ attr_accessor name: ::String
422
+ attr_accessor parameters: ::Hash[::String, Types::ParameterDetail]
423
+ SENSITIVE: []
424
+ end
425
+
426
+ class FunctionSchema
427
+ attr_accessor functions: ::Array[Types::Function]
428
+ attr_accessor unknown: untyped
429
+ SENSITIVE: []
430
+
431
+ class Functions < FunctionSchema
432
+ end
433
+ class Unknown < FunctionSchema
434
+ end
435
+ end
436
+
414
437
  class GetAgentActionGroupRequest
415
438
  attr_accessor action_group_id: ::String
416
439
  attr_accessor agent_id: ::String
@@ -724,6 +747,13 @@ module Aws::BedrockAgent
724
747
  SENSITIVE: []
725
748
  end
726
749
 
750
+ class ParameterDetail
751
+ attr_accessor description: ::String
752
+ attr_accessor required: bool
753
+ attr_accessor type: ("string" | "number" | "integer" | "boolean" | "array")
754
+ SENSITIVE: []
755
+ end
756
+
727
757
  class PineconeConfiguration
728
758
  attr_accessor connection_string: ::String
729
759
  attr_accessor credentials_secret_arn: ::String
@@ -880,6 +910,7 @@ module Aws::BedrockAgent
880
910
  attr_accessor agent_version: ::String
881
911
  attr_accessor api_schema: Types::APISchema
882
912
  attr_accessor description: ::String
913
+ attr_accessor function_schema: Types::FunctionSchema
883
914
  attr_accessor parent_action_group_signature: ("AMAZON.UserInput")
884
915
  SENSITIVE: []
885
916
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-bedrockagent
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.5.0
4
+ version: 1.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-04-16 00:00:00.000000000 Z
11
+ date: 2024-04-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core