aws-sdk-bedrockagentruntime 1.5.0 → 1.6.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockagentruntime/client.rb +92 -8
- data/lib/aws-sdk-bedrockagentruntime/client_api.rb +145 -1
- data/lib/aws-sdk-bedrockagentruntime/event_streams.rb +5 -0
- data/lib/aws-sdk-bedrockagentruntime/types.rb +576 -6
- data/lib/aws-sdk-bedrockagentruntime.rb +1 -1
- data/sig/client.rbs +46 -2
- data/sig/types.rbs +137 -3
- metadata +2 -2
@@ -25,7 +25,13 @@ module Aws::BedrockAgentRuntime
|
|
25
25
|
include Aws::Structure
|
26
26
|
end
|
27
27
|
|
28
|
-
# Contains information about the action group being invoked.
|
28
|
+
# Contains information about the action group being invoked. For more
|
29
|
+
# information about the possible structures, see the InvocationInput tab
|
30
|
+
# in [OrchestrationTrace][1] in the Amazon Bedrock User Guide.
|
31
|
+
#
|
32
|
+
#
|
33
|
+
#
|
34
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/trace-orchestration.html
|
29
35
|
#
|
30
36
|
# @!attribute [rw] action_group_name
|
31
37
|
# The name of the action group.
|
@@ -35,6 +41,10 @@ module Aws::BedrockAgentRuntime
|
|
35
41
|
# The path to the API to call, based off the action group.
|
36
42
|
# @return [String]
|
37
43
|
#
|
44
|
+
# @!attribute [rw] function
|
45
|
+
# The function in the action group to call.
|
46
|
+
# @return [String]
|
47
|
+
#
|
38
48
|
# @!attribute [rw] parameters
|
39
49
|
# The parameters in the Lambda input event.
|
40
50
|
# @return [Array<Types::Parameter>]
|
@@ -52,10 +62,11 @@ module Aws::BedrockAgentRuntime
|
|
52
62
|
class ActionGroupInvocationInput < Struct.new(
|
53
63
|
:action_group_name,
|
54
64
|
:api_path,
|
65
|
+
:function,
|
55
66
|
:parameters,
|
56
67
|
:request_body,
|
57
68
|
:verb)
|
58
|
-
SENSITIVE = [:action_group_name, :api_path, :verb]
|
69
|
+
SENSITIVE = [:action_group_name, :api_path, :function, :verb]
|
59
70
|
include Aws::Structure
|
60
71
|
end
|
61
72
|
|
@@ -75,6 +86,170 @@ module Aws::BedrockAgentRuntime
|
|
75
86
|
include Aws::Structure
|
76
87
|
end
|
77
88
|
|
89
|
+
# Contains information about the API operation that the agent predicts
|
90
|
+
# should be called.
|
91
|
+
#
|
92
|
+
# This data type is used in the following API operations:
|
93
|
+
#
|
94
|
+
# * In the `returnControl` field of the [Retrieve response][1]
|
95
|
+
#
|
96
|
+
# ^
|
97
|
+
#
|
98
|
+
#
|
99
|
+
#
|
100
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
|
101
|
+
#
|
102
|
+
# @!attribute [rw] action_group
|
103
|
+
# The action group that the API operation belongs to.
|
104
|
+
# @return [String]
|
105
|
+
#
|
106
|
+
# @!attribute [rw] api_path
|
107
|
+
# The path to the API operation.
|
108
|
+
# @return [String]
|
109
|
+
#
|
110
|
+
# @!attribute [rw] http_method
|
111
|
+
# The HTTP method of the API operation.
|
112
|
+
# @return [String]
|
113
|
+
#
|
114
|
+
# @!attribute [rw] parameters
|
115
|
+
# The parameters to provide for the API request, as the agent elicited
|
116
|
+
# from the user.
|
117
|
+
# @return [Array<Types::ApiParameter>]
|
118
|
+
#
|
119
|
+
# @!attribute [rw] request_body
|
120
|
+
# The request body to provide for the API request, as the agent
|
121
|
+
# elicited from the user.
|
122
|
+
# @return [Types::ApiRequestBody]
|
123
|
+
#
|
124
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ApiInvocationInput AWS API Documentation
|
125
|
+
#
|
126
|
+
class ApiInvocationInput < Struct.new(
|
127
|
+
:action_group,
|
128
|
+
:api_path,
|
129
|
+
:http_method,
|
130
|
+
:parameters,
|
131
|
+
:request_body)
|
132
|
+
SENSITIVE = [:api_path]
|
133
|
+
include Aws::Structure
|
134
|
+
end
|
135
|
+
|
136
|
+
# Information about a parameter to provide to the API request.
|
137
|
+
#
|
138
|
+
# This data type is used in the following API operations:
|
139
|
+
#
|
140
|
+
# * [Retrieve response][1]
|
141
|
+
#
|
142
|
+
# ^
|
143
|
+
#
|
144
|
+
#
|
145
|
+
#
|
146
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
|
147
|
+
#
|
148
|
+
# @!attribute [rw] name
|
149
|
+
# The name of the parameter.
|
150
|
+
# @return [String]
|
151
|
+
#
|
152
|
+
# @!attribute [rw] type
|
153
|
+
# The data type for the parameter.
|
154
|
+
# @return [String]
|
155
|
+
#
|
156
|
+
# @!attribute [rw] value
|
157
|
+
# The value of the parameter.
|
158
|
+
# @return [String]
|
159
|
+
#
|
160
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ApiParameter AWS API Documentation
|
161
|
+
#
|
162
|
+
class ApiParameter < Struct.new(
|
163
|
+
:name,
|
164
|
+
:type,
|
165
|
+
:value)
|
166
|
+
SENSITIVE = []
|
167
|
+
include Aws::Structure
|
168
|
+
end
|
169
|
+
|
170
|
+
# The request body to provide for the API request, as the agent elicited
|
171
|
+
# from the user.
|
172
|
+
#
|
173
|
+
# This data type is used in the following API operations:
|
174
|
+
#
|
175
|
+
# * [Retrieve response][1]
|
176
|
+
#
|
177
|
+
# ^
|
178
|
+
#
|
179
|
+
#
|
180
|
+
#
|
181
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
|
182
|
+
#
|
183
|
+
# @!attribute [rw] content
|
184
|
+
# The content of the request body. The key of the object in this field
|
185
|
+
# is a media type defining the format of the request body.
|
186
|
+
# @return [Hash<String,Types::PropertyParameters>]
|
187
|
+
#
|
188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ApiRequestBody AWS API Documentation
|
189
|
+
#
|
190
|
+
class ApiRequestBody < Struct.new(
|
191
|
+
:content)
|
192
|
+
SENSITIVE = []
|
193
|
+
include Aws::Structure
|
194
|
+
end
|
195
|
+
|
196
|
+
# Contains information about the API operation that was called from the
|
197
|
+
# action group and the response body that was returned.
|
198
|
+
#
|
199
|
+
# This data type is used in the following API operations:
|
200
|
+
#
|
201
|
+
# * In the `returnControlInvocationResults` of the [Retrieve request][1]
|
202
|
+
#
|
203
|
+
# ^
|
204
|
+
#
|
205
|
+
#
|
206
|
+
#
|
207
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax
|
208
|
+
#
|
209
|
+
# @!attribute [rw] action_group
|
210
|
+
# The action group that the API operation belongs to.
|
211
|
+
# @return [String]
|
212
|
+
#
|
213
|
+
# @!attribute [rw] api_path
|
214
|
+
# The path to the API operation.
|
215
|
+
# @return [String]
|
216
|
+
#
|
217
|
+
# @!attribute [rw] http_method
|
218
|
+
# The HTTP method for the API operation.
|
219
|
+
# @return [String]
|
220
|
+
#
|
221
|
+
# @!attribute [rw] http_status_code
|
222
|
+
# http status code from API execution response (for example: 200, 400,
|
223
|
+
# 500).
|
224
|
+
# @return [Integer]
|
225
|
+
#
|
226
|
+
# @!attribute [rw] response_body
|
227
|
+
# The response body from the API operation. The key of the object is
|
228
|
+
# the content type. The response may be returned directly or from the
|
229
|
+
# Lambda function.
|
230
|
+
# @return [Hash<String,Types::ContentBody>]
|
231
|
+
#
|
232
|
+
# @!attribute [rw] response_state
|
233
|
+
# Controls the final response state returned to end user when
|
234
|
+
# API/Function execution failed. When this state is FAILURE, the
|
235
|
+
# request would fail with dependency failure exception. When this
|
236
|
+
# state is REPROMPT, the API/function response will be sent to model
|
237
|
+
# for re-prompt
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ApiResult AWS API Documentation
|
241
|
+
#
|
242
|
+
class ApiResult < Struct.new(
|
243
|
+
:action_group,
|
244
|
+
:api_path,
|
245
|
+
:http_method,
|
246
|
+
:http_status_code,
|
247
|
+
:response_body,
|
248
|
+
:response_state)
|
249
|
+
SENSITIVE = [:api_path]
|
250
|
+
include Aws::Structure
|
251
|
+
end
|
252
|
+
|
78
253
|
# Contains citations for a part of an agent response.
|
79
254
|
#
|
80
255
|
# @!attribute [rw] citations
|
@@ -111,6 +286,31 @@ module Aws::BedrockAgentRuntime
|
|
111
286
|
include Aws::Structure
|
112
287
|
end
|
113
288
|
|
289
|
+
# This property contains the document to chat with, along with its
|
290
|
+
# attributes.
|
291
|
+
#
|
292
|
+
# @!attribute [rw] content_type
|
293
|
+
# The MIME type of the document contained in the wrapper object.
|
294
|
+
# @return [String]
|
295
|
+
#
|
296
|
+
# @!attribute [rw] data
|
297
|
+
# The byte value of the file to upload, encoded as a Base-64 string.
|
298
|
+
# @return [String]
|
299
|
+
#
|
300
|
+
# @!attribute [rw] identifier
|
301
|
+
# The file name of the document contained in the wrapper object.
|
302
|
+
# @return [String]
|
303
|
+
#
|
304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ByteContentDoc AWS API Documentation
|
305
|
+
#
|
306
|
+
class ByteContentDoc < Struct.new(
|
307
|
+
:content_type,
|
308
|
+
:data,
|
309
|
+
:identifier)
|
310
|
+
SENSITIVE = [:data, :identifier]
|
311
|
+
include Aws::Structure
|
312
|
+
end
|
313
|
+
|
114
314
|
# An object containing a segment of the generated response that is based
|
115
315
|
# on a source in the knowledge base, alongside information about the
|
116
316
|
# source.
|
@@ -159,6 +359,31 @@ module Aws::BedrockAgentRuntime
|
|
159
359
|
include Aws::Structure
|
160
360
|
end
|
161
361
|
|
362
|
+
# Contains the body of the API response.
|
363
|
+
#
|
364
|
+
# This data type is used in the following API operations:
|
365
|
+
#
|
366
|
+
# * In the `returnControlInvocationResults` field of the [Retrieve
|
367
|
+
# request][1]
|
368
|
+
#
|
369
|
+
# ^
|
370
|
+
#
|
371
|
+
#
|
372
|
+
#
|
373
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax
|
374
|
+
#
|
375
|
+
# @!attribute [rw] body
|
376
|
+
# The body of the API response.
|
377
|
+
# @return [String]
|
378
|
+
#
|
379
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ContentBody AWS API Documentation
|
380
|
+
#
|
381
|
+
class ContentBody < Struct.new(
|
382
|
+
:body)
|
383
|
+
SENSITIVE = []
|
384
|
+
include Aws::Structure
|
385
|
+
end
|
386
|
+
|
162
387
|
# There was an issue with a dependency. Check the resource
|
163
388
|
# configurations and retry the request.
|
164
389
|
#
|
@@ -180,6 +405,76 @@ module Aws::BedrockAgentRuntime
|
|
180
405
|
include Aws::Structure
|
181
406
|
end
|
182
407
|
|
408
|
+
# The unique external source of the content contained in the wrapper
|
409
|
+
# object.
|
410
|
+
#
|
411
|
+
# @!attribute [rw] byte_content
|
412
|
+
# The identifier, contentType, and data of the external source wrapper
|
413
|
+
# object.
|
414
|
+
# @return [Types::ByteContentDoc]
|
415
|
+
#
|
416
|
+
# @!attribute [rw] s3_location
|
417
|
+
# The S3 location of the external source wrapper object.
|
418
|
+
# @return [Types::S3ObjectDoc]
|
419
|
+
#
|
420
|
+
# @!attribute [rw] source_type
|
421
|
+
# The source type of the external source wrapper object.
|
422
|
+
# @return [String]
|
423
|
+
#
|
424
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ExternalSource AWS API Documentation
|
425
|
+
#
|
426
|
+
class ExternalSource < Struct.new(
|
427
|
+
:byte_content,
|
428
|
+
:s3_location,
|
429
|
+
:source_type)
|
430
|
+
SENSITIVE = []
|
431
|
+
include Aws::Structure
|
432
|
+
end
|
433
|
+
|
434
|
+
# Contains the generation configuration of the external source wrapper
|
435
|
+
# object.
|
436
|
+
#
|
437
|
+
# @!attribute [rw] prompt_template
|
438
|
+
# Contain the textPromptTemplate string for the external source
|
439
|
+
# wrapper object.
|
440
|
+
# @return [Types::PromptTemplate]
|
441
|
+
#
|
442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ExternalSourcesGenerationConfiguration AWS API Documentation
|
443
|
+
#
|
444
|
+
class ExternalSourcesGenerationConfiguration < Struct.new(
|
445
|
+
:prompt_template)
|
446
|
+
SENSITIVE = []
|
447
|
+
include Aws::Structure
|
448
|
+
end
|
449
|
+
|
450
|
+
# The configurations of the external source wrapper object in the
|
451
|
+
# retrieveAndGenerate function.
|
452
|
+
#
|
453
|
+
# @!attribute [rw] generation_configuration
|
454
|
+
# The prompt used with the external source wrapper object with the
|
455
|
+
# retrieveAndGenerate function.
|
456
|
+
# @return [Types::ExternalSourcesGenerationConfiguration]
|
457
|
+
#
|
458
|
+
# @!attribute [rw] model_arn
|
459
|
+
# The modelArn used with the external source wrapper object in the
|
460
|
+
# retrieveAndGenerate function.
|
461
|
+
# @return [String]
|
462
|
+
#
|
463
|
+
# @!attribute [rw] sources
|
464
|
+
# The document used with the external source wrapper object in the
|
465
|
+
# retrieveAndGenerate function.
|
466
|
+
# @return [Array<Types::ExternalSource>]
|
467
|
+
#
|
468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ExternalSourcesRetrieveAndGenerateConfiguration AWS API Documentation
|
469
|
+
#
|
470
|
+
class ExternalSourcesRetrieveAndGenerateConfiguration < Struct.new(
|
471
|
+
:generation_configuration,
|
472
|
+
:model_arn,
|
473
|
+
:sources)
|
474
|
+
SENSITIVE = []
|
475
|
+
include Aws::Structure
|
476
|
+
end
|
477
|
+
|
183
478
|
# Contains information about the failure of the interaction.
|
184
479
|
#
|
185
480
|
# @!attribute [rw] failure_reason
|
@@ -245,6 +540,120 @@ module Aws::BedrockAgentRuntime
|
|
245
540
|
include Aws::Structure
|
246
541
|
end
|
247
542
|
|
543
|
+
# Contains information about the function that the agent predicts should
|
544
|
+
# be called.
|
545
|
+
#
|
546
|
+
# This data type is used in the following API operations:
|
547
|
+
#
|
548
|
+
# * In the `returnControl` field of the [Retrieve response][1]
|
549
|
+
#
|
550
|
+
# ^
|
551
|
+
#
|
552
|
+
#
|
553
|
+
#
|
554
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
|
555
|
+
#
|
556
|
+
# @!attribute [rw] action_group
|
557
|
+
# The action group that the function belongs to.
|
558
|
+
# @return [String]
|
559
|
+
#
|
560
|
+
# @!attribute [rw] function
|
561
|
+
# The name of the function.
|
562
|
+
# @return [String]
|
563
|
+
#
|
564
|
+
# @!attribute [rw] parameters
|
565
|
+
# A list of parameters of the function.
|
566
|
+
# @return [Array<Types::FunctionParameter>]
|
567
|
+
#
|
568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FunctionInvocationInput AWS API Documentation
|
569
|
+
#
|
570
|
+
class FunctionInvocationInput < Struct.new(
|
571
|
+
:action_group,
|
572
|
+
:function,
|
573
|
+
:parameters)
|
574
|
+
SENSITIVE = []
|
575
|
+
include Aws::Structure
|
576
|
+
end
|
577
|
+
|
578
|
+
# Contains information about a parameter of the function.
|
579
|
+
#
|
580
|
+
# This data type is used in the following API operations:
|
581
|
+
#
|
582
|
+
# * In the `returnControl` field of the [Retrieve response][1]
|
583
|
+
#
|
584
|
+
# ^
|
585
|
+
#
|
586
|
+
#
|
587
|
+
#
|
588
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
|
589
|
+
#
|
590
|
+
# @!attribute [rw] name
|
591
|
+
# The name of the parameter.
|
592
|
+
# @return [String]
|
593
|
+
#
|
594
|
+
# @!attribute [rw] type
|
595
|
+
# The data type of the parameter.
|
596
|
+
# @return [String]
|
597
|
+
#
|
598
|
+
# @!attribute [rw] value
|
599
|
+
# The value of the parameter.
|
600
|
+
# @return [String]
|
601
|
+
#
|
602
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FunctionParameter AWS API Documentation
|
603
|
+
#
|
604
|
+
class FunctionParameter < Struct.new(
|
605
|
+
:name,
|
606
|
+
:type,
|
607
|
+
:value)
|
608
|
+
SENSITIVE = []
|
609
|
+
include Aws::Structure
|
610
|
+
end
|
611
|
+
|
612
|
+
# Contains information about the function that was called from the
|
613
|
+
# action group and the response that was returned.
|
614
|
+
#
|
615
|
+
# This data type is used in the following API operations:
|
616
|
+
#
|
617
|
+
# * In the `returnControlInvocationResults` of the [Retrieve request][1]
|
618
|
+
#
|
619
|
+
# ^
|
620
|
+
#
|
621
|
+
#
|
622
|
+
#
|
623
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax
|
624
|
+
#
|
625
|
+
# @!attribute [rw] action_group
|
626
|
+
# The action group that the function belongs to.
|
627
|
+
# @return [String]
|
628
|
+
#
|
629
|
+
# @!attribute [rw] function
|
630
|
+
# The name of the function that was called.
|
631
|
+
# @return [String]
|
632
|
+
#
|
633
|
+
# @!attribute [rw] response_body
|
634
|
+
# The response from the function call using the parameters. The
|
635
|
+
# response may be returned directly or from the Lambda function.
|
636
|
+
# @return [Hash<String,Types::ContentBody>]
|
637
|
+
#
|
638
|
+
# @!attribute [rw] response_state
|
639
|
+
# Controls the final response state returned to end user when
|
640
|
+
# API/Function execution failed. When this state is FAILURE, the
|
641
|
+
# request would fail with dependency failure exception. When this
|
642
|
+
# state is REPROMPT, the API/function response will be sent to model
|
643
|
+
# for re-prompt
|
644
|
+
# @return [String]
|
645
|
+
#
|
646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FunctionResult AWS API Documentation
|
647
|
+
#
|
648
|
+
class FunctionResult < Struct.new(
|
649
|
+
:action_group,
|
650
|
+
:function,
|
651
|
+
:response_body,
|
652
|
+
:response_state)
|
653
|
+
SENSITIVE = []
|
654
|
+
include Aws::Structure
|
655
|
+
end
|
656
|
+
|
248
657
|
# Contains metadata about a part of the generated response that is
|
249
658
|
# accompanied by a citation.
|
250
659
|
#
|
@@ -402,6 +811,83 @@ module Aws::BedrockAgentRuntime
|
|
402
811
|
include Aws::Structure
|
403
812
|
end
|
404
813
|
|
814
|
+
# Contains details about the API operation or function that the agent
|
815
|
+
# predicts should be called.
|
816
|
+
#
|
817
|
+
# This data type is used in the following API operations:
|
818
|
+
#
|
819
|
+
# * In the `returnControl` field of the [Retrieve response][1]
|
820
|
+
#
|
821
|
+
# ^
|
822
|
+
#
|
823
|
+
#
|
824
|
+
#
|
825
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
|
826
|
+
#
|
827
|
+
# @note InvocationInputMember is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of InvocationInputMember corresponding to the set member.
|
828
|
+
#
|
829
|
+
# @!attribute [rw] api_invocation_input
|
830
|
+
# Contains information about the API operation that the agent predicts
|
831
|
+
# should be called.
|
832
|
+
# @return [Types::ApiInvocationInput]
|
833
|
+
#
|
834
|
+
# @!attribute [rw] function_invocation_input
|
835
|
+
# Contains information about the function that the agent predicts
|
836
|
+
# should be called.
|
837
|
+
# @return [Types::FunctionInvocationInput]
|
838
|
+
#
|
839
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InvocationInputMember AWS API Documentation
|
840
|
+
#
|
841
|
+
class InvocationInputMember < Struct.new(
|
842
|
+
:api_invocation_input,
|
843
|
+
:function_invocation_input,
|
844
|
+
:unknown)
|
845
|
+
SENSITIVE = []
|
846
|
+
include Aws::Structure
|
847
|
+
include Aws::Structure::Union
|
848
|
+
|
849
|
+
class ApiInvocationInput < InvocationInputMember; end
|
850
|
+
class FunctionInvocationInput < InvocationInputMember; end
|
851
|
+
class Unknown < InvocationInputMember; end
|
852
|
+
end
|
853
|
+
|
854
|
+
# A result from the action group invocation.
|
855
|
+
#
|
856
|
+
# This data type is used in the following API operations:
|
857
|
+
#
|
858
|
+
# * [Retrieve request][1]
|
859
|
+
#
|
860
|
+
# ^
|
861
|
+
#
|
862
|
+
#
|
863
|
+
#
|
864
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax
|
865
|
+
#
|
866
|
+
# @note InvocationResultMember is a union - when making an API calls you must set exactly one of the members.
|
867
|
+
#
|
868
|
+
# @!attribute [rw] api_result
|
869
|
+
# The result from the API response from the action group invocation.
|
870
|
+
# @return [Types::ApiResult]
|
871
|
+
#
|
872
|
+
# @!attribute [rw] function_result
|
873
|
+
# The result from the function from the action group invocation.
|
874
|
+
# @return [Types::FunctionResult]
|
875
|
+
#
|
876
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InvocationResultMember AWS API Documentation
|
877
|
+
#
|
878
|
+
class InvocationResultMember < Struct.new(
|
879
|
+
:api_result,
|
880
|
+
:function_result,
|
881
|
+
:unknown)
|
882
|
+
SENSITIVE = []
|
883
|
+
include Aws::Structure
|
884
|
+
include Aws::Structure::Union
|
885
|
+
|
886
|
+
class ApiResult < InvocationResultMember; end
|
887
|
+
class FunctionResult < InvocationResultMember; end
|
888
|
+
class Unknown < InvocationResultMember; end
|
889
|
+
end
|
890
|
+
|
405
891
|
# @!attribute [rw] agent_alias_id
|
406
892
|
# The alias of the agent to use.
|
407
893
|
# @return [String]
|
@@ -901,7 +1387,7 @@ module Aws::BedrockAgentRuntime
|
|
901
1387
|
class Unknown < OrchestrationTrace; end
|
902
1388
|
end
|
903
1389
|
|
904
|
-
# A parameter
|
1390
|
+
# A parameter for the API request or function.
|
905
1391
|
#
|
906
1392
|
# @!attribute [rw] name
|
907
1393
|
# The name of the parameter.
|
@@ -1145,6 +1631,20 @@ module Aws::BedrockAgentRuntime
|
|
1145
1631
|
include Aws::Structure
|
1146
1632
|
end
|
1147
1633
|
|
1634
|
+
# Contains the parameters in the request body.
|
1635
|
+
#
|
1636
|
+
# @!attribute [rw] properties
|
1637
|
+
# A list of parameters in the request body.
|
1638
|
+
# @return [Array<Types::Parameter>]
|
1639
|
+
#
|
1640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/PropertyParameters AWS API Documentation
|
1641
|
+
#
|
1642
|
+
class PropertyParameters < Struct.new(
|
1643
|
+
:properties)
|
1644
|
+
SENSITIVE = []
|
1645
|
+
include Aws::Structure
|
1646
|
+
end
|
1647
|
+
|
1148
1648
|
# Contains the reasoning, based on the input, that the agent uses to
|
1149
1649
|
# justify carrying out an action group or getting information from a
|
1150
1650
|
# knowledge base.
|
@@ -1185,7 +1685,7 @@ module Aws::BedrockAgentRuntime
|
|
1185
1685
|
include Aws::Structure
|
1186
1686
|
end
|
1187
1687
|
|
1188
|
-
# The parameters in the request body
|
1688
|
+
# The parameters in the API request body.
|
1189
1689
|
#
|
1190
1690
|
# @!attribute [rw] content
|
1191
1691
|
# The content in the request body.
|
@@ -1199,8 +1699,8 @@ module Aws::BedrockAgentRuntime
|
|
1199
1699
|
include Aws::Structure
|
1200
1700
|
end
|
1201
1701
|
|
1202
|
-
# The specified resource ARN was not found. Check
|
1203
|
-
# request again.
|
1702
|
+
# The specified resource Amazon Resource Name (ARN) was not found. Check
|
1703
|
+
# the Amazon Resource Name (ARN) and try your request again.
|
1204
1704
|
#
|
1205
1705
|
# @!attribute [rw] message
|
1206
1706
|
# @return [String]
|
@@ -1429,6 +1929,11 @@ module Aws::BedrockAgentRuntime
|
|
1429
1929
|
#
|
1430
1930
|
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
|
1431
1931
|
#
|
1932
|
+
# @!attribute [rw] external_sources_configuration
|
1933
|
+
# The configuration used with the external source wrapper object in
|
1934
|
+
# the retrieveAndGenerate function.
|
1935
|
+
# @return [Types::ExternalSourcesRetrieveAndGenerateConfiguration]
|
1936
|
+
#
|
1432
1937
|
# @!attribute [rw] knowledge_base_configuration
|
1433
1938
|
# Contains details about the resource being queried.
|
1434
1939
|
# @return [Types::KnowledgeBaseRetrieveAndGenerateConfiguration]
|
@@ -1440,6 +1945,7 @@ module Aws::BedrockAgentRuntime
|
|
1440
1945
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateConfiguration AWS API Documentation
|
1441
1946
|
#
|
1442
1947
|
class RetrieveAndGenerateConfiguration < Struct.new(
|
1948
|
+
:external_sources_configuration,
|
1443
1949
|
:knowledge_base_configuration,
|
1444
1950
|
:type)
|
1445
1951
|
SENSITIVE = []
|
@@ -1671,6 +2177,53 @@ module Aws::BedrockAgentRuntime
|
|
1671
2177
|
include Aws::Structure
|
1672
2178
|
end
|
1673
2179
|
|
2180
|
+
# Contains information to return from the action group that the agent
|
2181
|
+
# has predicted to invoke.
|
2182
|
+
#
|
2183
|
+
# This data type is used in the following API operations:
|
2184
|
+
#
|
2185
|
+
# * [Retrieve response][1]
|
2186
|
+
#
|
2187
|
+
# ^
|
2188
|
+
#
|
2189
|
+
#
|
2190
|
+
#
|
2191
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
|
2192
|
+
#
|
2193
|
+
# @!attribute [rw] invocation_id
|
2194
|
+
# The identifier of the action group invocation.
|
2195
|
+
# @return [String]
|
2196
|
+
#
|
2197
|
+
# @!attribute [rw] invocation_inputs
|
2198
|
+
# A list of objects that contain information about the parameters and
|
2199
|
+
# inputs that need to be sent into the API operation or function,
|
2200
|
+
# based on what the agent determines from its session with the user.
|
2201
|
+
# @return [Array<Types::InvocationInputMember>]
|
2202
|
+
#
|
2203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ReturnControlPayload AWS API Documentation
|
2204
|
+
#
|
2205
|
+
class ReturnControlPayload < Struct.new(
|
2206
|
+
:invocation_id,
|
2207
|
+
:invocation_inputs,
|
2208
|
+
:event_type)
|
2209
|
+
SENSITIVE = []
|
2210
|
+
include Aws::Structure
|
2211
|
+
end
|
2212
|
+
|
2213
|
+
# The unique wrapper object of the document from the S3 location.
|
2214
|
+
#
|
2215
|
+
# @!attribute [rw] uri
|
2216
|
+
# The file location of the S3 wrapper object.
|
2217
|
+
# @return [String]
|
2218
|
+
#
|
2219
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/S3ObjectDoc AWS API Documentation
|
2220
|
+
#
|
2221
|
+
class S3ObjectDoc < Struct.new(
|
2222
|
+
:uri)
|
2223
|
+
SENSITIVE = []
|
2224
|
+
include Aws::Structure
|
2225
|
+
end
|
2226
|
+
|
1674
2227
|
# The number of requests exceeds the service quota. Resubmit your
|
1675
2228
|
# request later.
|
1676
2229
|
#
|
@@ -1700,6 +2253,10 @@ module Aws::BedrockAgentRuntime
|
|
1700
2253
|
# [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
|
1701
2254
|
# [3]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html
|
1702
2255
|
#
|
2256
|
+
# @!attribute [rw] invocation_id
|
2257
|
+
# The identifier of the invocation.
|
2258
|
+
# @return [String]
|
2259
|
+
#
|
1703
2260
|
# @!attribute [rw] prompt_session_attributes
|
1704
2261
|
# Contains attributes that persist across a prompt and the values of
|
1705
2262
|
# those attributes. These attributes replace the
|
@@ -1712,6 +2269,11 @@ module Aws::BedrockAgentRuntime
|
|
1712
2269
|
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html
|
1713
2270
|
# @return [Hash<String,String>]
|
1714
2271
|
#
|
2272
|
+
# @!attribute [rw] return_control_invocation_results
|
2273
|
+
# Contains information about the results from the action group
|
2274
|
+
# invocation.
|
2275
|
+
# @return [Array<Types::InvocationResultMember>]
|
2276
|
+
#
|
1715
2277
|
# @!attribute [rw] session_attributes
|
1716
2278
|
# Contains attributes that persist across a session and the values of
|
1717
2279
|
# those attributes.
|
@@ -1720,7 +2282,9 @@ module Aws::BedrockAgentRuntime
|
|
1720
2282
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/SessionState AWS API Documentation
|
1721
2283
|
#
|
1722
2284
|
class SessionState < Struct.new(
|
2285
|
+
:invocation_id,
|
1723
2286
|
:prompt_session_attributes,
|
2287
|
+
:return_control_invocation_results,
|
1724
2288
|
:session_attributes)
|
1725
2289
|
SENSITIVE = []
|
1726
2290
|
include Aws::Structure
|
@@ -1871,6 +2435,10 @@ module Aws::BedrockAgentRuntime
|
|
1871
2435
|
# The unique identifier of the agent.
|
1872
2436
|
# @return [String]
|
1873
2437
|
#
|
2438
|
+
# @!attribute [rw] agent_version
|
2439
|
+
# The version of the agent.
|
2440
|
+
# @return [String]
|
2441
|
+
#
|
1874
2442
|
# @!attribute [rw] session_id
|
1875
2443
|
# The unique identifier of the session with the agent.
|
1876
2444
|
# @return [String]
|
@@ -1892,6 +2460,7 @@ module Aws::BedrockAgentRuntime
|
|
1892
2460
|
class TracePart < Struct.new(
|
1893
2461
|
:agent_alias_id,
|
1894
2462
|
:agent_id,
|
2463
|
+
:agent_version,
|
1895
2464
|
:session_id,
|
1896
2465
|
:trace,
|
1897
2466
|
:event_type)
|
@@ -1933,6 +2502,7 @@ module Aws::BedrockAgentRuntime
|
|
1933
2502
|
:dependency_failed_exception,
|
1934
2503
|
:internal_server_exception,
|
1935
2504
|
:resource_not_found_exception,
|
2505
|
+
:return_control,
|
1936
2506
|
:service_quota_exceeded_exception,
|
1937
2507
|
:throttling_exception,
|
1938
2508
|
:trace,
|