aws-sdk-bedrockagent 1.0.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 +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-bedrockagent/client.rb +2675 -0
- data/lib/aws-sdk-bedrockagent/client_api.rb +1592 -0
- data/lib/aws-sdk-bedrockagent/customizations.rb +0 -0
- data/lib/aws-sdk-bedrockagent/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-bedrockagent/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-bedrockagent/endpoints.rb +576 -0
- data/lib/aws-sdk-bedrockagent/errors.rb +155 -0
- data/lib/aws-sdk-bedrockagent/plugins/endpoints.rb +149 -0
- data/lib/aws-sdk-bedrockagent/resource.rb +26 -0
- data/lib/aws-sdk-bedrockagent/types.rb +3322 -0
- data/lib/aws-sdk-bedrockagent.rb +57 -0
- metadata +94 -0
@@ -0,0 +1,3322 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::BedrockAgent
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# Contains information about the API Schema for the Action Group
|
14
|
+
#
|
15
|
+
# @note APISchema is a union - when making an API calls you must set exactly one of the members.
|
16
|
+
#
|
17
|
+
# @note APISchema is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of APISchema corresponding to the set member.
|
18
|
+
#
|
19
|
+
# @!attribute [rw] s3
|
20
|
+
# The identifier for the S3 resource.
|
21
|
+
# @return [Types::S3Identifier]
|
22
|
+
#
|
23
|
+
# @!attribute [rw] payload
|
24
|
+
# String OpenAPI Payload
|
25
|
+
# @return [String]
|
26
|
+
#
|
27
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/APISchema AWS API Documentation
|
28
|
+
#
|
29
|
+
class APISchema < Struct.new(
|
30
|
+
:s3,
|
31
|
+
:payload,
|
32
|
+
:unknown)
|
33
|
+
SENSITIVE = [:payload]
|
34
|
+
include Aws::Structure
|
35
|
+
include Aws::Structure::Union
|
36
|
+
|
37
|
+
class S3 < APISchema; end
|
38
|
+
class Payload < APISchema; end
|
39
|
+
class Unknown < APISchema; end
|
40
|
+
end
|
41
|
+
|
42
|
+
# This exception is thrown when a request is denied per access
|
43
|
+
# permissions
|
44
|
+
#
|
45
|
+
# @!attribute [rw] message
|
46
|
+
# Non Blank String
|
47
|
+
# @return [String]
|
48
|
+
#
|
49
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AccessDeniedException AWS API Documentation
|
50
|
+
#
|
51
|
+
class AccessDeniedException < Struct.new(
|
52
|
+
:message)
|
53
|
+
SENSITIVE = []
|
54
|
+
include Aws::Structure
|
55
|
+
end
|
56
|
+
|
57
|
+
# Type of Executors for an Action Group
|
58
|
+
#
|
59
|
+
# @note ActionGroupExecutor is a union - when making an API calls you must set exactly one of the members.
|
60
|
+
#
|
61
|
+
# @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.
|
62
|
+
#
|
63
|
+
# @!attribute [rw] lambda
|
64
|
+
# ARN of a Lambda.
|
65
|
+
# @return [String]
|
66
|
+
#
|
67
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ActionGroupExecutor AWS API Documentation
|
68
|
+
#
|
69
|
+
class ActionGroupExecutor < Struct.new(
|
70
|
+
:lambda,
|
71
|
+
:unknown)
|
72
|
+
SENSITIVE = []
|
73
|
+
include Aws::Structure
|
74
|
+
include Aws::Structure::Union
|
75
|
+
|
76
|
+
class Lambda < ActionGroupExecutor; end
|
77
|
+
class Unknown < ActionGroupExecutor; end
|
78
|
+
end
|
79
|
+
|
80
|
+
# ActionGroup Summary
|
81
|
+
#
|
82
|
+
# @!attribute [rw] action_group_id
|
83
|
+
# Identifier for a resource.
|
84
|
+
# @return [String]
|
85
|
+
#
|
86
|
+
# @!attribute [rw] action_group_name
|
87
|
+
# Name for a resource.
|
88
|
+
# @return [String]
|
89
|
+
#
|
90
|
+
# @!attribute [rw] action_group_state
|
91
|
+
# State of the action group
|
92
|
+
# @return [String]
|
93
|
+
#
|
94
|
+
# @!attribute [rw] description
|
95
|
+
# Description of the Resource.
|
96
|
+
# @return [String]
|
97
|
+
#
|
98
|
+
# @!attribute [rw] updated_at
|
99
|
+
# Time Stamp.
|
100
|
+
# @return [Time]
|
101
|
+
#
|
102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ActionGroupSummary AWS API Documentation
|
103
|
+
#
|
104
|
+
class ActionGroupSummary < Struct.new(
|
105
|
+
:action_group_id,
|
106
|
+
:action_group_name,
|
107
|
+
:action_group_state,
|
108
|
+
:description,
|
109
|
+
:updated_at)
|
110
|
+
SENSITIVE = []
|
111
|
+
include Aws::Structure
|
112
|
+
end
|
113
|
+
|
114
|
+
# Contains the information of an agent
|
115
|
+
#
|
116
|
+
# @!attribute [rw] agent_id
|
117
|
+
# Identifier for a resource.
|
118
|
+
# @return [String]
|
119
|
+
#
|
120
|
+
# @!attribute [rw] agent_name
|
121
|
+
# Name for a resource.
|
122
|
+
# @return [String]
|
123
|
+
#
|
124
|
+
# @!attribute [rw] agent_arn
|
125
|
+
# Arn representation of the Agent.
|
126
|
+
# @return [String]
|
127
|
+
#
|
128
|
+
# @!attribute [rw] agent_version
|
129
|
+
# Draft Agent Version.
|
130
|
+
# @return [String]
|
131
|
+
#
|
132
|
+
# @!attribute [rw] client_token
|
133
|
+
# Client specified token used for idempotency checks
|
134
|
+
# @return [String]
|
135
|
+
#
|
136
|
+
# @!attribute [rw] instruction
|
137
|
+
# Instruction for the agent.
|
138
|
+
# @return [String]
|
139
|
+
#
|
140
|
+
# @!attribute [rw] agent_status
|
141
|
+
# Schema Type for Action APIs.
|
142
|
+
# @return [String]
|
143
|
+
#
|
144
|
+
# @!attribute [rw] foundation_model
|
145
|
+
# ARN or name of a Bedrock model.
|
146
|
+
# @return [String]
|
147
|
+
#
|
148
|
+
# @!attribute [rw] description
|
149
|
+
# Description of the Resource.
|
150
|
+
# @return [String]
|
151
|
+
#
|
152
|
+
# @!attribute [rw] idle_session_ttl_in_seconds
|
153
|
+
# Max Session Time.
|
154
|
+
# @return [Integer]
|
155
|
+
#
|
156
|
+
# @!attribute [rw] agent_resource_role_arn
|
157
|
+
# ARN of a IAM role.
|
158
|
+
# @return [String]
|
159
|
+
#
|
160
|
+
# @!attribute [rw] customer_encryption_key_arn
|
161
|
+
# A KMS key ARN
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] created_at
|
165
|
+
# Time Stamp.
|
166
|
+
# @return [Time]
|
167
|
+
#
|
168
|
+
# @!attribute [rw] updated_at
|
169
|
+
# Time Stamp.
|
170
|
+
# @return [Time]
|
171
|
+
#
|
172
|
+
# @!attribute [rw] prepared_at
|
173
|
+
# Time Stamp.
|
174
|
+
# @return [Time]
|
175
|
+
#
|
176
|
+
# @!attribute [rw] failure_reasons
|
177
|
+
# Failure Reasons for Error.
|
178
|
+
# @return [Array<String>]
|
179
|
+
#
|
180
|
+
# @!attribute [rw] recommended_actions
|
181
|
+
# The recommended actions users can take to resolve an error in
|
182
|
+
# failureReasons.
|
183
|
+
# @return [Array<String>]
|
184
|
+
#
|
185
|
+
# @!attribute [rw] prompt_override_configuration
|
186
|
+
# Configuration for prompt override.
|
187
|
+
# @return [Types::PromptOverrideConfiguration]
|
188
|
+
#
|
189
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/Agent AWS API Documentation
|
190
|
+
#
|
191
|
+
class Agent < Struct.new(
|
192
|
+
:agent_id,
|
193
|
+
:agent_name,
|
194
|
+
:agent_arn,
|
195
|
+
:agent_version,
|
196
|
+
:client_token,
|
197
|
+
:instruction,
|
198
|
+
:agent_status,
|
199
|
+
:foundation_model,
|
200
|
+
:description,
|
201
|
+
:idle_session_ttl_in_seconds,
|
202
|
+
:agent_resource_role_arn,
|
203
|
+
:customer_encryption_key_arn,
|
204
|
+
:created_at,
|
205
|
+
:updated_at,
|
206
|
+
:prepared_at,
|
207
|
+
:failure_reasons,
|
208
|
+
:recommended_actions,
|
209
|
+
:prompt_override_configuration)
|
210
|
+
SENSITIVE = [:instruction, :prompt_override_configuration]
|
211
|
+
include Aws::Structure
|
212
|
+
end
|
213
|
+
|
214
|
+
# Contains the information of an Agent Action Group
|
215
|
+
#
|
216
|
+
# @!attribute [rw] agent_id
|
217
|
+
# Identifier for a resource.
|
218
|
+
# @return [String]
|
219
|
+
#
|
220
|
+
# @!attribute [rw] agent_version
|
221
|
+
# Agent Version.
|
222
|
+
# @return [String]
|
223
|
+
#
|
224
|
+
# @!attribute [rw] action_group_id
|
225
|
+
# Identifier for a resource.
|
226
|
+
# @return [String]
|
227
|
+
#
|
228
|
+
# @!attribute [rw] action_group_name
|
229
|
+
# Name for a resource.
|
230
|
+
# @return [String]
|
231
|
+
#
|
232
|
+
# @!attribute [rw] client_token
|
233
|
+
# Client specified token used for idempotency checks
|
234
|
+
# @return [String]
|
235
|
+
#
|
236
|
+
# @!attribute [rw] description
|
237
|
+
# Description of the Resource.
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @!attribute [rw] created_at
|
241
|
+
# Time Stamp.
|
242
|
+
# @return [Time]
|
243
|
+
#
|
244
|
+
# @!attribute [rw] updated_at
|
245
|
+
# Time Stamp.
|
246
|
+
# @return [Time]
|
247
|
+
#
|
248
|
+
# @!attribute [rw] parent_action_signature
|
249
|
+
# Action Group Signature for a BuiltIn Action
|
250
|
+
# @return [String]
|
251
|
+
#
|
252
|
+
# @!attribute [rw] action_group_executor
|
253
|
+
# Type of Executors for an Action Group
|
254
|
+
# @return [Types::ActionGroupExecutor]
|
255
|
+
#
|
256
|
+
# @!attribute [rw] api_schema
|
257
|
+
# Contains information about the API Schema for the Action Group
|
258
|
+
# @return [Types::APISchema]
|
259
|
+
#
|
260
|
+
# @!attribute [rw] action_group_state
|
261
|
+
# State of the action group
|
262
|
+
# @return [String]
|
263
|
+
#
|
264
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentActionGroup AWS API Documentation
|
265
|
+
#
|
266
|
+
class AgentActionGroup < Struct.new(
|
267
|
+
:agent_id,
|
268
|
+
:agent_version,
|
269
|
+
:action_group_id,
|
270
|
+
:action_group_name,
|
271
|
+
:client_token,
|
272
|
+
:description,
|
273
|
+
:created_at,
|
274
|
+
:updated_at,
|
275
|
+
:parent_action_signature,
|
276
|
+
:action_group_executor,
|
277
|
+
:api_schema,
|
278
|
+
:action_group_state)
|
279
|
+
SENSITIVE = []
|
280
|
+
include Aws::Structure
|
281
|
+
end
|
282
|
+
|
283
|
+
# Contains the information of an agent alias
|
284
|
+
#
|
285
|
+
# @!attribute [rw] agent_id
|
286
|
+
# Identifier for a resource.
|
287
|
+
# @return [String]
|
288
|
+
#
|
289
|
+
# @!attribute [rw] agent_alias_id
|
290
|
+
# Id for an Agent Alias generated at the server side.
|
291
|
+
# @return [String]
|
292
|
+
#
|
293
|
+
# @!attribute [rw] agent_alias_name
|
294
|
+
# Name for a resource.
|
295
|
+
# @return [String]
|
296
|
+
#
|
297
|
+
# @!attribute [rw] agent_alias_arn
|
298
|
+
# Arn representation of the Agent Alias.
|
299
|
+
# @return [String]
|
300
|
+
#
|
301
|
+
# @!attribute [rw] client_token
|
302
|
+
# Client specified token used for idempotency checks
|
303
|
+
# @return [String]
|
304
|
+
#
|
305
|
+
# @!attribute [rw] description
|
306
|
+
# Description of the Resource.
|
307
|
+
# @return [String]
|
308
|
+
#
|
309
|
+
# @!attribute [rw] routing_configuration
|
310
|
+
# Routing configuration for an Agent alias.
|
311
|
+
# @return [Array<Types::AgentAliasRoutingConfigurationListItem>]
|
312
|
+
#
|
313
|
+
# @!attribute [rw] created_at
|
314
|
+
# Time Stamp.
|
315
|
+
# @return [Time]
|
316
|
+
#
|
317
|
+
# @!attribute [rw] updated_at
|
318
|
+
# Time Stamp.
|
319
|
+
# @return [Time]
|
320
|
+
#
|
321
|
+
# @!attribute [rw] agent_alias_history_events
|
322
|
+
# The list of history events for an alias for an Agent.
|
323
|
+
# @return [Array<Types::AgentAliasHistoryEvent>]
|
324
|
+
#
|
325
|
+
# @!attribute [rw] agent_alias_status
|
326
|
+
# The statuses an Agent Alias can be in.
|
327
|
+
# @return [String]
|
328
|
+
#
|
329
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentAlias AWS API Documentation
|
330
|
+
#
|
331
|
+
class AgentAlias < Struct.new(
|
332
|
+
:agent_id,
|
333
|
+
:agent_alias_id,
|
334
|
+
:agent_alias_name,
|
335
|
+
:agent_alias_arn,
|
336
|
+
:client_token,
|
337
|
+
:description,
|
338
|
+
:routing_configuration,
|
339
|
+
:created_at,
|
340
|
+
:updated_at,
|
341
|
+
:agent_alias_history_events,
|
342
|
+
:agent_alias_status)
|
343
|
+
SENSITIVE = []
|
344
|
+
include Aws::Structure
|
345
|
+
end
|
346
|
+
|
347
|
+
# History event for an alias for an Agent.
|
348
|
+
#
|
349
|
+
# @!attribute [rw] routing_configuration
|
350
|
+
# Routing configuration for an Agent alias.
|
351
|
+
# @return [Array<Types::AgentAliasRoutingConfigurationListItem>]
|
352
|
+
#
|
353
|
+
# @!attribute [rw] end_date
|
354
|
+
# Time Stamp.
|
355
|
+
# @return [Time]
|
356
|
+
#
|
357
|
+
# @!attribute [rw] start_date
|
358
|
+
# Time Stamp.
|
359
|
+
# @return [Time]
|
360
|
+
#
|
361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentAliasHistoryEvent AWS API Documentation
|
362
|
+
#
|
363
|
+
class AgentAliasHistoryEvent < Struct.new(
|
364
|
+
:routing_configuration,
|
365
|
+
:end_date,
|
366
|
+
:start_date)
|
367
|
+
SENSITIVE = []
|
368
|
+
include Aws::Structure
|
369
|
+
end
|
370
|
+
|
371
|
+
# Details about the routing configuration for an Agent alias.
|
372
|
+
#
|
373
|
+
# @!attribute [rw] agent_version
|
374
|
+
# Agent Version.
|
375
|
+
# @return [String]
|
376
|
+
#
|
377
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentAliasRoutingConfigurationListItem AWS API Documentation
|
378
|
+
#
|
379
|
+
class AgentAliasRoutingConfigurationListItem < Struct.new(
|
380
|
+
:agent_version)
|
381
|
+
SENSITIVE = []
|
382
|
+
include Aws::Structure
|
383
|
+
end
|
384
|
+
|
385
|
+
# Summary of an alias for an Agent.
|
386
|
+
#
|
387
|
+
# @!attribute [rw] agent_alias_id
|
388
|
+
# Id for an Agent Alias generated at the server side.
|
389
|
+
# @return [String]
|
390
|
+
#
|
391
|
+
# @!attribute [rw] agent_alias_name
|
392
|
+
# Name for a resource.
|
393
|
+
# @return [String]
|
394
|
+
#
|
395
|
+
# @!attribute [rw] description
|
396
|
+
# Description of the Resource.
|
397
|
+
# @return [String]
|
398
|
+
#
|
399
|
+
# @!attribute [rw] routing_configuration
|
400
|
+
# Routing configuration for an Agent alias.
|
401
|
+
# @return [Array<Types::AgentAliasRoutingConfigurationListItem>]
|
402
|
+
#
|
403
|
+
# @!attribute [rw] agent_alias_status
|
404
|
+
# The statuses an Agent Alias can be in.
|
405
|
+
# @return [String]
|
406
|
+
#
|
407
|
+
# @!attribute [rw] created_at
|
408
|
+
# Time Stamp.
|
409
|
+
# @return [Time]
|
410
|
+
#
|
411
|
+
# @!attribute [rw] updated_at
|
412
|
+
# Time Stamp.
|
413
|
+
# @return [Time]
|
414
|
+
#
|
415
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentAliasSummary AWS API Documentation
|
416
|
+
#
|
417
|
+
class AgentAliasSummary < Struct.new(
|
418
|
+
:agent_alias_id,
|
419
|
+
:agent_alias_name,
|
420
|
+
:description,
|
421
|
+
:routing_configuration,
|
422
|
+
:agent_alias_status,
|
423
|
+
:created_at,
|
424
|
+
:updated_at)
|
425
|
+
SENSITIVE = []
|
426
|
+
include Aws::Structure
|
427
|
+
end
|
428
|
+
|
429
|
+
# Contains the information of an Agent Knowledge Base.
|
430
|
+
#
|
431
|
+
# @!attribute [rw] agent_id
|
432
|
+
# Identifier for a resource.
|
433
|
+
# @return [String]
|
434
|
+
#
|
435
|
+
# @!attribute [rw] agent_version
|
436
|
+
# Agent Version.
|
437
|
+
# @return [String]
|
438
|
+
#
|
439
|
+
# @!attribute [rw] knowledge_base_id
|
440
|
+
# Identifier for a resource.
|
441
|
+
# @return [String]
|
442
|
+
#
|
443
|
+
# @!attribute [rw] description
|
444
|
+
# Description of the Resource.
|
445
|
+
# @return [String]
|
446
|
+
#
|
447
|
+
# @!attribute [rw] created_at
|
448
|
+
# Time Stamp.
|
449
|
+
# @return [Time]
|
450
|
+
#
|
451
|
+
# @!attribute [rw] updated_at
|
452
|
+
# Time Stamp.
|
453
|
+
# @return [Time]
|
454
|
+
#
|
455
|
+
# @!attribute [rw] knowledge_base_state
|
456
|
+
# State of the knowledge base; whether it is enabled or disabled
|
457
|
+
# @return [String]
|
458
|
+
#
|
459
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentKnowledgeBase AWS API Documentation
|
460
|
+
#
|
461
|
+
class AgentKnowledgeBase < Struct.new(
|
462
|
+
:agent_id,
|
463
|
+
:agent_version,
|
464
|
+
:knowledge_base_id,
|
465
|
+
:description,
|
466
|
+
:created_at,
|
467
|
+
:updated_at,
|
468
|
+
:knowledge_base_state)
|
469
|
+
SENSITIVE = []
|
470
|
+
include Aws::Structure
|
471
|
+
end
|
472
|
+
|
473
|
+
# Agent Knowledge Base Summary
|
474
|
+
#
|
475
|
+
# @!attribute [rw] knowledge_base_id
|
476
|
+
# Identifier for a resource.
|
477
|
+
# @return [String]
|
478
|
+
#
|
479
|
+
# @!attribute [rw] description
|
480
|
+
# Description of the Resource.
|
481
|
+
# @return [String]
|
482
|
+
#
|
483
|
+
# @!attribute [rw] knowledge_base_state
|
484
|
+
# State of the knowledge base; whether it is enabled or disabled
|
485
|
+
# @return [String]
|
486
|
+
#
|
487
|
+
# @!attribute [rw] updated_at
|
488
|
+
# Time Stamp.
|
489
|
+
# @return [Time]
|
490
|
+
#
|
491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentKnowledgeBaseSummary AWS API Documentation
|
492
|
+
#
|
493
|
+
class AgentKnowledgeBaseSummary < Struct.new(
|
494
|
+
:knowledge_base_id,
|
495
|
+
:description,
|
496
|
+
:knowledge_base_state,
|
497
|
+
:updated_at)
|
498
|
+
SENSITIVE = []
|
499
|
+
include Aws::Structure
|
500
|
+
end
|
501
|
+
|
502
|
+
# Summary of Agent.
|
503
|
+
#
|
504
|
+
# @!attribute [rw] agent_id
|
505
|
+
# Identifier for a resource.
|
506
|
+
# @return [String]
|
507
|
+
#
|
508
|
+
# @!attribute [rw] agent_name
|
509
|
+
# Name for a resource.
|
510
|
+
# @return [String]
|
511
|
+
#
|
512
|
+
# @!attribute [rw] agent_status
|
513
|
+
# Schema Type for Action APIs.
|
514
|
+
# @return [String]
|
515
|
+
#
|
516
|
+
# @!attribute [rw] description
|
517
|
+
# Description of the Resource.
|
518
|
+
# @return [String]
|
519
|
+
#
|
520
|
+
# @!attribute [rw] updated_at
|
521
|
+
# Time Stamp.
|
522
|
+
# @return [Time]
|
523
|
+
#
|
524
|
+
# @!attribute [rw] latest_agent_version
|
525
|
+
# Agent Version.
|
526
|
+
# @return [String]
|
527
|
+
#
|
528
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentSummary AWS API Documentation
|
529
|
+
#
|
530
|
+
class AgentSummary < Struct.new(
|
531
|
+
:agent_id,
|
532
|
+
:agent_name,
|
533
|
+
:agent_status,
|
534
|
+
:description,
|
535
|
+
:updated_at,
|
536
|
+
:latest_agent_version)
|
537
|
+
SENSITIVE = []
|
538
|
+
include Aws::Structure
|
539
|
+
end
|
540
|
+
|
541
|
+
# Contains the information of an agent version.
|
542
|
+
#
|
543
|
+
# @!attribute [rw] agent_id
|
544
|
+
# Identifier for a resource.
|
545
|
+
# @return [String]
|
546
|
+
#
|
547
|
+
# @!attribute [rw] agent_name
|
548
|
+
# Name for a resource.
|
549
|
+
# @return [String]
|
550
|
+
#
|
551
|
+
# @!attribute [rw] agent_arn
|
552
|
+
# Arn representation of the Agent.
|
553
|
+
# @return [String]
|
554
|
+
#
|
555
|
+
# @!attribute [rw] version
|
556
|
+
# Numerical Agent Version.
|
557
|
+
# @return [String]
|
558
|
+
#
|
559
|
+
# @!attribute [rw] instruction
|
560
|
+
# Instruction for the agent.
|
561
|
+
# @return [String]
|
562
|
+
#
|
563
|
+
# @!attribute [rw] agent_status
|
564
|
+
# Schema Type for Action APIs.
|
565
|
+
# @return [String]
|
566
|
+
#
|
567
|
+
# @!attribute [rw] foundation_model
|
568
|
+
# ARN or name of a Bedrock model.
|
569
|
+
# @return [String]
|
570
|
+
#
|
571
|
+
# @!attribute [rw] description
|
572
|
+
# Description of the Resource.
|
573
|
+
# @return [String]
|
574
|
+
#
|
575
|
+
# @!attribute [rw] idle_session_ttl_in_seconds
|
576
|
+
# Max Session Time.
|
577
|
+
# @return [Integer]
|
578
|
+
#
|
579
|
+
# @!attribute [rw] agent_resource_role_arn
|
580
|
+
# ARN of a IAM role.
|
581
|
+
# @return [String]
|
582
|
+
#
|
583
|
+
# @!attribute [rw] customer_encryption_key_arn
|
584
|
+
# A KMS key ARN
|
585
|
+
# @return [String]
|
586
|
+
#
|
587
|
+
# @!attribute [rw] created_at
|
588
|
+
# Time Stamp.
|
589
|
+
# @return [Time]
|
590
|
+
#
|
591
|
+
# @!attribute [rw] updated_at
|
592
|
+
# Time Stamp.
|
593
|
+
# @return [Time]
|
594
|
+
#
|
595
|
+
# @!attribute [rw] failure_reasons
|
596
|
+
# Failure Reasons for Error.
|
597
|
+
# @return [Array<String>]
|
598
|
+
#
|
599
|
+
# @!attribute [rw] recommended_actions
|
600
|
+
# The recommended actions users can take to resolve an error in
|
601
|
+
# failureReasons.
|
602
|
+
# @return [Array<String>]
|
603
|
+
#
|
604
|
+
# @!attribute [rw] prompt_override_configuration
|
605
|
+
# Configuration for prompt override.
|
606
|
+
# @return [Types::PromptOverrideConfiguration]
|
607
|
+
#
|
608
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentVersion AWS API Documentation
|
609
|
+
#
|
610
|
+
class AgentVersion < Struct.new(
|
611
|
+
:agent_id,
|
612
|
+
:agent_name,
|
613
|
+
:agent_arn,
|
614
|
+
:version,
|
615
|
+
:instruction,
|
616
|
+
:agent_status,
|
617
|
+
:foundation_model,
|
618
|
+
:description,
|
619
|
+
:idle_session_ttl_in_seconds,
|
620
|
+
:agent_resource_role_arn,
|
621
|
+
:customer_encryption_key_arn,
|
622
|
+
:created_at,
|
623
|
+
:updated_at,
|
624
|
+
:failure_reasons,
|
625
|
+
:recommended_actions,
|
626
|
+
:prompt_override_configuration)
|
627
|
+
SENSITIVE = [:instruction, :prompt_override_configuration]
|
628
|
+
include Aws::Structure
|
629
|
+
end
|
630
|
+
|
631
|
+
# Summary of agent version.
|
632
|
+
#
|
633
|
+
# @!attribute [rw] agent_name
|
634
|
+
# Name for a resource.
|
635
|
+
# @return [String]
|
636
|
+
#
|
637
|
+
# @!attribute [rw] agent_status
|
638
|
+
# Schema Type for Action APIs.
|
639
|
+
# @return [String]
|
640
|
+
#
|
641
|
+
# @!attribute [rw] agent_version
|
642
|
+
# Agent Version.
|
643
|
+
# @return [String]
|
644
|
+
#
|
645
|
+
# @!attribute [rw] created_at
|
646
|
+
# Time Stamp.
|
647
|
+
# @return [Time]
|
648
|
+
#
|
649
|
+
# @!attribute [rw] updated_at
|
650
|
+
# Time Stamp.
|
651
|
+
# @return [Time]
|
652
|
+
#
|
653
|
+
# @!attribute [rw] description
|
654
|
+
# Description of the Resource.
|
655
|
+
# @return [String]
|
656
|
+
#
|
657
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentVersionSummary AWS API Documentation
|
658
|
+
#
|
659
|
+
class AgentVersionSummary < Struct.new(
|
660
|
+
:agent_name,
|
661
|
+
:agent_status,
|
662
|
+
:agent_version,
|
663
|
+
:created_at,
|
664
|
+
:updated_at,
|
665
|
+
:description)
|
666
|
+
SENSITIVE = []
|
667
|
+
include Aws::Structure
|
668
|
+
end
|
669
|
+
|
670
|
+
# Associate Agent Knowledge Base Request
|
671
|
+
#
|
672
|
+
# @!attribute [rw] agent_id
|
673
|
+
# Id generated at the server side when an Agent is created
|
674
|
+
# @return [String]
|
675
|
+
#
|
676
|
+
# @!attribute [rw] agent_version
|
677
|
+
# Draft Version of the Agent.
|
678
|
+
# @return [String]
|
679
|
+
#
|
680
|
+
# @!attribute [rw] knowledge_base_id
|
681
|
+
# Identifier for a resource.
|
682
|
+
# @return [String]
|
683
|
+
#
|
684
|
+
# @!attribute [rw] description
|
685
|
+
# Description of the Resource.
|
686
|
+
# @return [String]
|
687
|
+
#
|
688
|
+
# @!attribute [rw] knowledge_base_state
|
689
|
+
# State of the knowledge base; whether it is enabled or disabled
|
690
|
+
# @return [String]
|
691
|
+
#
|
692
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBaseRequest AWS API Documentation
|
693
|
+
#
|
694
|
+
class AssociateAgentKnowledgeBaseRequest < Struct.new(
|
695
|
+
:agent_id,
|
696
|
+
:agent_version,
|
697
|
+
:knowledge_base_id,
|
698
|
+
:description,
|
699
|
+
:knowledge_base_state)
|
700
|
+
SENSITIVE = []
|
701
|
+
include Aws::Structure
|
702
|
+
end
|
703
|
+
|
704
|
+
# Associate Agent Knowledge Base Response
|
705
|
+
#
|
706
|
+
# @!attribute [rw] agent_knowledge_base
|
707
|
+
# Contains the information of an Agent Knowledge Base.
|
708
|
+
# @return [Types::AgentKnowledgeBase]
|
709
|
+
#
|
710
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBaseResponse AWS API Documentation
|
711
|
+
#
|
712
|
+
class AssociateAgentKnowledgeBaseResponse < Struct.new(
|
713
|
+
:agent_knowledge_base)
|
714
|
+
SENSITIVE = []
|
715
|
+
include Aws::Structure
|
716
|
+
end
|
717
|
+
|
718
|
+
# Configures chunking strategy
|
719
|
+
#
|
720
|
+
# @!attribute [rw] chunking_strategy
|
721
|
+
# The type of chunking strategy
|
722
|
+
# @return [String]
|
723
|
+
#
|
724
|
+
# @!attribute [rw] fixed_size_chunking_configuration
|
725
|
+
# Configures fixed size chunking strategy
|
726
|
+
# @return [Types::FixedSizeChunkingConfiguration]
|
727
|
+
#
|
728
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ChunkingConfiguration AWS API Documentation
|
729
|
+
#
|
730
|
+
class ChunkingConfiguration < Struct.new(
|
731
|
+
:chunking_strategy,
|
732
|
+
:fixed_size_chunking_configuration)
|
733
|
+
SENSITIVE = []
|
734
|
+
include Aws::Structure
|
735
|
+
end
|
736
|
+
|
737
|
+
# This exception is thrown when there is a conflict performing an
|
738
|
+
# operation
|
739
|
+
#
|
740
|
+
# @!attribute [rw] message
|
741
|
+
# Non Blank String
|
742
|
+
# @return [String]
|
743
|
+
#
|
744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ConflictException AWS API Documentation
|
745
|
+
#
|
746
|
+
class ConflictException < Struct.new(
|
747
|
+
:message)
|
748
|
+
SENSITIVE = []
|
749
|
+
include Aws::Structure
|
750
|
+
end
|
751
|
+
|
752
|
+
# Create Action Group Request
|
753
|
+
#
|
754
|
+
# @!attribute [rw] agent_id
|
755
|
+
# Id generated at the server side when an Agent is created
|
756
|
+
# @return [String]
|
757
|
+
#
|
758
|
+
# @!attribute [rw] agent_version
|
759
|
+
# Draft Version of the Agent.
|
760
|
+
# @return [String]
|
761
|
+
#
|
762
|
+
# @!attribute [rw] action_group_name
|
763
|
+
# Name for a resource.
|
764
|
+
# @return [String]
|
765
|
+
#
|
766
|
+
# @!attribute [rw] client_token
|
767
|
+
# Client specified token used for idempotency checks
|
768
|
+
#
|
769
|
+
# **A suitable default value is auto-generated.** You should normally
|
770
|
+
# not need to pass this option.
|
771
|
+
# @return [String]
|
772
|
+
#
|
773
|
+
# @!attribute [rw] description
|
774
|
+
# Description of the Resource.
|
775
|
+
# @return [String]
|
776
|
+
#
|
777
|
+
# @!attribute [rw] parent_action_group_signature
|
778
|
+
# Action Group Signature for a BuiltIn Action
|
779
|
+
# @return [String]
|
780
|
+
#
|
781
|
+
# @!attribute [rw] action_group_executor
|
782
|
+
# Type of Executors for an Action Group
|
783
|
+
# @return [Types::ActionGroupExecutor]
|
784
|
+
#
|
785
|
+
# @!attribute [rw] api_schema
|
786
|
+
# Contains information about the API Schema for the Action Group
|
787
|
+
# @return [Types::APISchema]
|
788
|
+
#
|
789
|
+
# @!attribute [rw] action_group_state
|
790
|
+
# State of the action group
|
791
|
+
# @return [String]
|
792
|
+
#
|
793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentActionGroupRequest AWS API Documentation
|
794
|
+
#
|
795
|
+
class CreateAgentActionGroupRequest < Struct.new(
|
796
|
+
:agent_id,
|
797
|
+
:agent_version,
|
798
|
+
:action_group_name,
|
799
|
+
:client_token,
|
800
|
+
:description,
|
801
|
+
:parent_action_group_signature,
|
802
|
+
:action_group_executor,
|
803
|
+
:api_schema,
|
804
|
+
:action_group_state)
|
805
|
+
SENSITIVE = []
|
806
|
+
include Aws::Structure
|
807
|
+
end
|
808
|
+
|
809
|
+
# Create Action Group Response
|
810
|
+
#
|
811
|
+
# @!attribute [rw] agent_action_group
|
812
|
+
# Contains the information of an Agent Action Group
|
813
|
+
# @return [Types::AgentActionGroup]
|
814
|
+
#
|
815
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentActionGroupResponse AWS API Documentation
|
816
|
+
#
|
817
|
+
class CreateAgentActionGroupResponse < Struct.new(
|
818
|
+
:agent_action_group)
|
819
|
+
SENSITIVE = []
|
820
|
+
include Aws::Structure
|
821
|
+
end
|
822
|
+
|
823
|
+
# Create Agent Alias Request
|
824
|
+
#
|
825
|
+
# @!attribute [rw] agent_id
|
826
|
+
# Id generated at the server side when an Agent is created
|
827
|
+
# @return [String]
|
828
|
+
#
|
829
|
+
# @!attribute [rw] agent_alias_name
|
830
|
+
# Name for a resource.
|
831
|
+
# @return [String]
|
832
|
+
#
|
833
|
+
# @!attribute [rw] client_token
|
834
|
+
# Client specified token used for idempotency checks
|
835
|
+
#
|
836
|
+
# **A suitable default value is auto-generated.** You should normally
|
837
|
+
# not need to pass this option.
|
838
|
+
# @return [String]
|
839
|
+
#
|
840
|
+
# @!attribute [rw] description
|
841
|
+
# Description of the Resource.
|
842
|
+
# @return [String]
|
843
|
+
#
|
844
|
+
# @!attribute [rw] routing_configuration
|
845
|
+
# Routing configuration for an Agent alias.
|
846
|
+
# @return [Array<Types::AgentAliasRoutingConfigurationListItem>]
|
847
|
+
#
|
848
|
+
# @!attribute [rw] tags
|
849
|
+
# A map of tag keys and values
|
850
|
+
# @return [Hash<String,String>]
|
851
|
+
#
|
852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentAliasRequest AWS API Documentation
|
853
|
+
#
|
854
|
+
class CreateAgentAliasRequest < Struct.new(
|
855
|
+
:agent_id,
|
856
|
+
:agent_alias_name,
|
857
|
+
:client_token,
|
858
|
+
:description,
|
859
|
+
:routing_configuration,
|
860
|
+
:tags)
|
861
|
+
SENSITIVE = []
|
862
|
+
include Aws::Structure
|
863
|
+
end
|
864
|
+
|
865
|
+
# Create Agent Alias Response
|
866
|
+
#
|
867
|
+
# @!attribute [rw] agent_alias
|
868
|
+
# Contains the information of an agent alias
|
869
|
+
# @return [Types::AgentAlias]
|
870
|
+
#
|
871
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentAliasResponse AWS API Documentation
|
872
|
+
#
|
873
|
+
class CreateAgentAliasResponse < Struct.new(
|
874
|
+
:agent_alias)
|
875
|
+
SENSITIVE = []
|
876
|
+
include Aws::Structure
|
877
|
+
end
|
878
|
+
|
879
|
+
# Create Agent Request
|
880
|
+
#
|
881
|
+
# @!attribute [rw] agent_name
|
882
|
+
# Name for a resource.
|
883
|
+
# @return [String]
|
884
|
+
#
|
885
|
+
# @!attribute [rw] client_token
|
886
|
+
# Client specified token used for idempotency checks
|
887
|
+
#
|
888
|
+
# **A suitable default value is auto-generated.** You should normally
|
889
|
+
# not need to pass this option.
|
890
|
+
# @return [String]
|
891
|
+
#
|
892
|
+
# @!attribute [rw] instruction
|
893
|
+
# Instruction for the agent.
|
894
|
+
# @return [String]
|
895
|
+
#
|
896
|
+
# @!attribute [rw] foundation_model
|
897
|
+
# ARN or name of a Bedrock model.
|
898
|
+
# @return [String]
|
899
|
+
#
|
900
|
+
# @!attribute [rw] description
|
901
|
+
# Description of the Resource.
|
902
|
+
# @return [String]
|
903
|
+
#
|
904
|
+
# @!attribute [rw] idle_session_ttl_in_seconds
|
905
|
+
# Max Session Time.
|
906
|
+
# @return [Integer]
|
907
|
+
#
|
908
|
+
# @!attribute [rw] agent_resource_role_arn
|
909
|
+
# ARN of a IAM role.
|
910
|
+
# @return [String]
|
911
|
+
#
|
912
|
+
# @!attribute [rw] customer_encryption_key_arn
|
913
|
+
# A KMS key ARN
|
914
|
+
# @return [String]
|
915
|
+
#
|
916
|
+
# @!attribute [rw] tags
|
917
|
+
# A map of tag keys and values
|
918
|
+
# @return [Hash<String,String>]
|
919
|
+
#
|
920
|
+
# @!attribute [rw] prompt_override_configuration
|
921
|
+
# Configuration for prompt override.
|
922
|
+
# @return [Types::PromptOverrideConfiguration]
|
923
|
+
#
|
924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentRequest AWS API Documentation
|
925
|
+
#
|
926
|
+
class CreateAgentRequest < Struct.new(
|
927
|
+
:agent_name,
|
928
|
+
:client_token,
|
929
|
+
:instruction,
|
930
|
+
:foundation_model,
|
931
|
+
:description,
|
932
|
+
:idle_session_ttl_in_seconds,
|
933
|
+
:agent_resource_role_arn,
|
934
|
+
:customer_encryption_key_arn,
|
935
|
+
:tags,
|
936
|
+
:prompt_override_configuration)
|
937
|
+
SENSITIVE = [:instruction, :prompt_override_configuration]
|
938
|
+
include Aws::Structure
|
939
|
+
end
|
940
|
+
|
941
|
+
# Create Agent Response
|
942
|
+
#
|
943
|
+
# @!attribute [rw] agent
|
944
|
+
# Contains the information of an agent
|
945
|
+
# @return [Types::Agent]
|
946
|
+
#
|
947
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentResponse AWS API Documentation
|
948
|
+
#
|
949
|
+
class CreateAgentResponse < Struct.new(
|
950
|
+
:agent)
|
951
|
+
SENSITIVE = []
|
952
|
+
include Aws::Structure
|
953
|
+
end
|
954
|
+
|
955
|
+
# @!attribute [rw] knowledge_base_id
|
956
|
+
# Identifier for a resource.
|
957
|
+
# @return [String]
|
958
|
+
#
|
959
|
+
# @!attribute [rw] client_token
|
960
|
+
# Client specified token used for idempotency checks
|
961
|
+
#
|
962
|
+
# **A suitable default value is auto-generated.** You should normally
|
963
|
+
# not need to pass this option.
|
964
|
+
# @return [String]
|
965
|
+
#
|
966
|
+
# @!attribute [rw] name
|
967
|
+
# Name for a resource.
|
968
|
+
# @return [String]
|
969
|
+
#
|
970
|
+
# @!attribute [rw] description
|
971
|
+
# Description of the Resource.
|
972
|
+
# @return [String]
|
973
|
+
#
|
974
|
+
# @!attribute [rw] data_source_configuration
|
975
|
+
# Specifies a raw data source location to ingest.
|
976
|
+
# @return [Types::DataSourceConfiguration]
|
977
|
+
#
|
978
|
+
# @!attribute [rw] server_side_encryption_configuration
|
979
|
+
# Server-side encryption configuration.
|
980
|
+
# @return [Types::ServerSideEncryptionConfiguration]
|
981
|
+
#
|
982
|
+
# @!attribute [rw] vector_ingestion_configuration
|
983
|
+
# Configures ingestion for a vector knowledge base
|
984
|
+
# @return [Types::VectorIngestionConfiguration]
|
985
|
+
#
|
986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateDataSourceRequest AWS API Documentation
|
987
|
+
#
|
988
|
+
class CreateDataSourceRequest < Struct.new(
|
989
|
+
:knowledge_base_id,
|
990
|
+
:client_token,
|
991
|
+
:name,
|
992
|
+
:description,
|
993
|
+
:data_source_configuration,
|
994
|
+
:server_side_encryption_configuration,
|
995
|
+
:vector_ingestion_configuration)
|
996
|
+
SENSITIVE = []
|
997
|
+
include Aws::Structure
|
998
|
+
end
|
999
|
+
|
1000
|
+
# @!attribute [rw] data_source
|
1001
|
+
# Contains the information of a data source.
|
1002
|
+
# @return [Types::DataSource]
|
1003
|
+
#
|
1004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateDataSourceResponse AWS API Documentation
|
1005
|
+
#
|
1006
|
+
class CreateDataSourceResponse < Struct.new(
|
1007
|
+
:data_source)
|
1008
|
+
SENSITIVE = []
|
1009
|
+
include Aws::Structure
|
1010
|
+
end
|
1011
|
+
|
1012
|
+
# @!attribute [rw] client_token
|
1013
|
+
# Client specified token used for idempotency checks
|
1014
|
+
#
|
1015
|
+
# **A suitable default value is auto-generated.** You should normally
|
1016
|
+
# not need to pass this option.
|
1017
|
+
# @return [String]
|
1018
|
+
#
|
1019
|
+
# @!attribute [rw] name
|
1020
|
+
# Name for a resource.
|
1021
|
+
# @return [String]
|
1022
|
+
#
|
1023
|
+
# @!attribute [rw] description
|
1024
|
+
# Description of the Resource.
|
1025
|
+
# @return [String]
|
1026
|
+
#
|
1027
|
+
# @!attribute [rw] role_arn
|
1028
|
+
# ARN of a IAM role.
|
1029
|
+
# @return [String]
|
1030
|
+
#
|
1031
|
+
# @!attribute [rw] knowledge_base_configuration
|
1032
|
+
# Configures a bedrock knowledge base.
|
1033
|
+
# @return [Types::KnowledgeBaseConfiguration]
|
1034
|
+
#
|
1035
|
+
# @!attribute [rw] storage_configuration
|
1036
|
+
# Configures the physical storage of ingested data in a knowledge
|
1037
|
+
# base.
|
1038
|
+
# @return [Types::StorageConfiguration]
|
1039
|
+
#
|
1040
|
+
# @!attribute [rw] tags
|
1041
|
+
# A map of tag keys and values
|
1042
|
+
# @return [Hash<String,String>]
|
1043
|
+
#
|
1044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateKnowledgeBaseRequest AWS API Documentation
|
1045
|
+
#
|
1046
|
+
class CreateKnowledgeBaseRequest < Struct.new(
|
1047
|
+
:client_token,
|
1048
|
+
:name,
|
1049
|
+
:description,
|
1050
|
+
:role_arn,
|
1051
|
+
:knowledge_base_configuration,
|
1052
|
+
:storage_configuration,
|
1053
|
+
:tags)
|
1054
|
+
SENSITIVE = []
|
1055
|
+
include Aws::Structure
|
1056
|
+
end
|
1057
|
+
|
1058
|
+
# @!attribute [rw] knowledge_base
|
1059
|
+
# Contains the information of a knowledge base.
|
1060
|
+
# @return [Types::KnowledgeBase]
|
1061
|
+
#
|
1062
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateKnowledgeBaseResponse AWS API Documentation
|
1063
|
+
#
|
1064
|
+
class CreateKnowledgeBaseResponse < Struct.new(
|
1065
|
+
:knowledge_base)
|
1066
|
+
SENSITIVE = []
|
1067
|
+
include Aws::Structure
|
1068
|
+
end
|
1069
|
+
|
1070
|
+
# Contains the information of a data source.
|
1071
|
+
#
|
1072
|
+
# @!attribute [rw] knowledge_base_id
|
1073
|
+
# Identifier for a resource.
|
1074
|
+
# @return [String]
|
1075
|
+
#
|
1076
|
+
# @!attribute [rw] data_source_id
|
1077
|
+
# Identifier for a resource.
|
1078
|
+
# @return [String]
|
1079
|
+
#
|
1080
|
+
# @!attribute [rw] name
|
1081
|
+
# Name for a resource.
|
1082
|
+
# @return [String]
|
1083
|
+
#
|
1084
|
+
# @!attribute [rw] status
|
1085
|
+
# The status of a data source.
|
1086
|
+
# @return [String]
|
1087
|
+
#
|
1088
|
+
# @!attribute [rw] description
|
1089
|
+
# Description of the Resource.
|
1090
|
+
# @return [String]
|
1091
|
+
#
|
1092
|
+
# @!attribute [rw] data_source_configuration
|
1093
|
+
# Specifies a raw data source location to ingest.
|
1094
|
+
# @return [Types::DataSourceConfiguration]
|
1095
|
+
#
|
1096
|
+
# @!attribute [rw] server_side_encryption_configuration
|
1097
|
+
# Server-side encryption configuration.
|
1098
|
+
# @return [Types::ServerSideEncryptionConfiguration]
|
1099
|
+
#
|
1100
|
+
# @!attribute [rw] vector_ingestion_configuration
|
1101
|
+
# Configures ingestion for a vector knowledge base
|
1102
|
+
# @return [Types::VectorIngestionConfiguration]
|
1103
|
+
#
|
1104
|
+
# @!attribute [rw] created_at
|
1105
|
+
# Time Stamp.
|
1106
|
+
# @return [Time]
|
1107
|
+
#
|
1108
|
+
# @!attribute [rw] updated_at
|
1109
|
+
# Time Stamp.
|
1110
|
+
# @return [Time]
|
1111
|
+
#
|
1112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DataSource AWS API Documentation
|
1113
|
+
#
|
1114
|
+
class DataSource < Struct.new(
|
1115
|
+
:knowledge_base_id,
|
1116
|
+
:data_source_id,
|
1117
|
+
:name,
|
1118
|
+
:status,
|
1119
|
+
:description,
|
1120
|
+
:data_source_configuration,
|
1121
|
+
:server_side_encryption_configuration,
|
1122
|
+
:vector_ingestion_configuration,
|
1123
|
+
:created_at,
|
1124
|
+
:updated_at)
|
1125
|
+
SENSITIVE = []
|
1126
|
+
include Aws::Structure
|
1127
|
+
end
|
1128
|
+
|
1129
|
+
# Specifies a raw data source location to ingest.
|
1130
|
+
#
|
1131
|
+
# @!attribute [rw] type
|
1132
|
+
# The type of the data source location.
|
1133
|
+
# @return [String]
|
1134
|
+
#
|
1135
|
+
# @!attribute [rw] s3_configuration
|
1136
|
+
# Configures an S3 data source location.
|
1137
|
+
# @return [Types::S3DataSourceConfiguration]
|
1138
|
+
#
|
1139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DataSourceConfiguration AWS API Documentation
|
1140
|
+
#
|
1141
|
+
class DataSourceConfiguration < Struct.new(
|
1142
|
+
:type,
|
1143
|
+
:s3_configuration)
|
1144
|
+
SENSITIVE = []
|
1145
|
+
include Aws::Structure
|
1146
|
+
end
|
1147
|
+
|
1148
|
+
# Summary information of a data source.
|
1149
|
+
#
|
1150
|
+
# @!attribute [rw] knowledge_base_id
|
1151
|
+
# Identifier for a resource.
|
1152
|
+
# @return [String]
|
1153
|
+
#
|
1154
|
+
# @!attribute [rw] data_source_id
|
1155
|
+
# Identifier for a resource.
|
1156
|
+
# @return [String]
|
1157
|
+
#
|
1158
|
+
# @!attribute [rw] name
|
1159
|
+
# Name for a resource.
|
1160
|
+
# @return [String]
|
1161
|
+
#
|
1162
|
+
# @!attribute [rw] status
|
1163
|
+
# The status of a data source.
|
1164
|
+
# @return [String]
|
1165
|
+
#
|
1166
|
+
# @!attribute [rw] description
|
1167
|
+
# Description of the Resource.
|
1168
|
+
# @return [String]
|
1169
|
+
#
|
1170
|
+
# @!attribute [rw] updated_at
|
1171
|
+
# Time Stamp.
|
1172
|
+
# @return [Time]
|
1173
|
+
#
|
1174
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DataSourceSummary AWS API Documentation
|
1175
|
+
#
|
1176
|
+
class DataSourceSummary < Struct.new(
|
1177
|
+
:knowledge_base_id,
|
1178
|
+
:data_source_id,
|
1179
|
+
:name,
|
1180
|
+
:status,
|
1181
|
+
:description,
|
1182
|
+
:updated_at)
|
1183
|
+
SENSITIVE = []
|
1184
|
+
include Aws::Structure
|
1185
|
+
end
|
1186
|
+
|
1187
|
+
# Delete Action Group Request
|
1188
|
+
#
|
1189
|
+
# @!attribute [rw] agent_id
|
1190
|
+
# Id generated at the server side when an Agent is created
|
1191
|
+
# @return [String]
|
1192
|
+
#
|
1193
|
+
# @!attribute [rw] agent_version
|
1194
|
+
# Draft Version of the Agent.
|
1195
|
+
# @return [String]
|
1196
|
+
#
|
1197
|
+
# @!attribute [rw] action_group_id
|
1198
|
+
# Id generated at the server side when an Agent ActionGroup is created
|
1199
|
+
# @return [String]
|
1200
|
+
#
|
1201
|
+
# @!attribute [rw] skip_resource_in_use_check
|
1202
|
+
# Skips checking if resource is in use when set to true. Defaults to
|
1203
|
+
# false
|
1204
|
+
# @return [Boolean]
|
1205
|
+
#
|
1206
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentActionGroupRequest AWS API Documentation
|
1207
|
+
#
|
1208
|
+
class DeleteAgentActionGroupRequest < Struct.new(
|
1209
|
+
:agent_id,
|
1210
|
+
:agent_version,
|
1211
|
+
:action_group_id,
|
1212
|
+
:skip_resource_in_use_check)
|
1213
|
+
SENSITIVE = []
|
1214
|
+
include Aws::Structure
|
1215
|
+
end
|
1216
|
+
|
1217
|
+
# Delete Action Group Response
|
1218
|
+
#
|
1219
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentActionGroupResponse AWS API Documentation
|
1220
|
+
#
|
1221
|
+
class DeleteAgentActionGroupResponse < Aws::EmptyStructure; end
|
1222
|
+
|
1223
|
+
# Delete Agent Alias Request
|
1224
|
+
#
|
1225
|
+
# @!attribute [rw] agent_id
|
1226
|
+
# Id generated at the server side when an Agent is created
|
1227
|
+
# @return [String]
|
1228
|
+
#
|
1229
|
+
# @!attribute [rw] agent_alias_id
|
1230
|
+
# Id generated at the server side when an Agent Alias is created
|
1231
|
+
# @return [String]
|
1232
|
+
#
|
1233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentAliasRequest AWS API Documentation
|
1234
|
+
#
|
1235
|
+
class DeleteAgentAliasRequest < Struct.new(
|
1236
|
+
:agent_id,
|
1237
|
+
:agent_alias_id)
|
1238
|
+
SENSITIVE = []
|
1239
|
+
include Aws::Structure
|
1240
|
+
end
|
1241
|
+
|
1242
|
+
# Delete Agent Alias Response
|
1243
|
+
#
|
1244
|
+
# @!attribute [rw] agent_id
|
1245
|
+
# Identifier for a resource.
|
1246
|
+
# @return [String]
|
1247
|
+
#
|
1248
|
+
# @!attribute [rw] agent_alias_id
|
1249
|
+
# Id for an Agent Alias generated at the server side.
|
1250
|
+
# @return [String]
|
1251
|
+
#
|
1252
|
+
# @!attribute [rw] agent_alias_status
|
1253
|
+
# The statuses an Agent Alias can be in.
|
1254
|
+
# @return [String]
|
1255
|
+
#
|
1256
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentAliasResponse AWS API Documentation
|
1257
|
+
#
|
1258
|
+
class DeleteAgentAliasResponse < Struct.new(
|
1259
|
+
:agent_id,
|
1260
|
+
:agent_alias_id,
|
1261
|
+
:agent_alias_status)
|
1262
|
+
SENSITIVE = []
|
1263
|
+
include Aws::Structure
|
1264
|
+
end
|
1265
|
+
|
1266
|
+
# Delete Agent Request
|
1267
|
+
#
|
1268
|
+
# @!attribute [rw] agent_id
|
1269
|
+
# Id generated at the server side when an Agent is created
|
1270
|
+
# @return [String]
|
1271
|
+
#
|
1272
|
+
# @!attribute [rw] skip_resource_in_use_check
|
1273
|
+
# Skips checking if resource is in use when set to true. Defaults to
|
1274
|
+
# false
|
1275
|
+
# @return [Boolean]
|
1276
|
+
#
|
1277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentRequest AWS API Documentation
|
1278
|
+
#
|
1279
|
+
class DeleteAgentRequest < Struct.new(
|
1280
|
+
:agent_id,
|
1281
|
+
:skip_resource_in_use_check)
|
1282
|
+
SENSITIVE = []
|
1283
|
+
include Aws::Structure
|
1284
|
+
end
|
1285
|
+
|
1286
|
+
# Delete Agent Response
|
1287
|
+
#
|
1288
|
+
# @!attribute [rw] agent_id
|
1289
|
+
# Identifier for a resource.
|
1290
|
+
# @return [String]
|
1291
|
+
#
|
1292
|
+
# @!attribute [rw] agent_status
|
1293
|
+
# Schema Type for Action APIs.
|
1294
|
+
# @return [String]
|
1295
|
+
#
|
1296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentResponse AWS API Documentation
|
1297
|
+
#
|
1298
|
+
class DeleteAgentResponse < Struct.new(
|
1299
|
+
:agent_id,
|
1300
|
+
:agent_status)
|
1301
|
+
SENSITIVE = []
|
1302
|
+
include Aws::Structure
|
1303
|
+
end
|
1304
|
+
|
1305
|
+
# Delete Agent Version Request
|
1306
|
+
#
|
1307
|
+
# @!attribute [rw] agent_id
|
1308
|
+
# Id generated at the server side when an Agent is created
|
1309
|
+
# @return [String]
|
1310
|
+
#
|
1311
|
+
# @!attribute [rw] agent_version
|
1312
|
+
# Numerical Agent Version.
|
1313
|
+
# @return [String]
|
1314
|
+
#
|
1315
|
+
# @!attribute [rw] skip_resource_in_use_check
|
1316
|
+
# Skips checking if resource is in use when set to true. Defaults to
|
1317
|
+
# false
|
1318
|
+
# @return [Boolean]
|
1319
|
+
#
|
1320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentVersionRequest AWS API Documentation
|
1321
|
+
#
|
1322
|
+
class DeleteAgentVersionRequest < Struct.new(
|
1323
|
+
:agent_id,
|
1324
|
+
:agent_version,
|
1325
|
+
:skip_resource_in_use_check)
|
1326
|
+
SENSITIVE = []
|
1327
|
+
include Aws::Structure
|
1328
|
+
end
|
1329
|
+
|
1330
|
+
# Delete Agent Version Response
|
1331
|
+
#
|
1332
|
+
# @!attribute [rw] agent_id
|
1333
|
+
# Identifier for a resource.
|
1334
|
+
# @return [String]
|
1335
|
+
#
|
1336
|
+
# @!attribute [rw] agent_version
|
1337
|
+
# Numerical Agent Version.
|
1338
|
+
# @return [String]
|
1339
|
+
#
|
1340
|
+
# @!attribute [rw] agent_status
|
1341
|
+
# Schema Type for Action APIs.
|
1342
|
+
# @return [String]
|
1343
|
+
#
|
1344
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentVersionResponse AWS API Documentation
|
1345
|
+
#
|
1346
|
+
class DeleteAgentVersionResponse < Struct.new(
|
1347
|
+
:agent_id,
|
1348
|
+
:agent_version,
|
1349
|
+
:agent_status)
|
1350
|
+
SENSITIVE = []
|
1351
|
+
include Aws::Structure
|
1352
|
+
end
|
1353
|
+
|
1354
|
+
# @!attribute [rw] knowledge_base_id
|
1355
|
+
# Identifier for a resource.
|
1356
|
+
# @return [String]
|
1357
|
+
#
|
1358
|
+
# @!attribute [rw] data_source_id
|
1359
|
+
# Identifier for a resource.
|
1360
|
+
# @return [String]
|
1361
|
+
#
|
1362
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteDataSourceRequest AWS API Documentation
|
1363
|
+
#
|
1364
|
+
class DeleteDataSourceRequest < Struct.new(
|
1365
|
+
:knowledge_base_id,
|
1366
|
+
:data_source_id)
|
1367
|
+
SENSITIVE = []
|
1368
|
+
include Aws::Structure
|
1369
|
+
end
|
1370
|
+
|
1371
|
+
# @!attribute [rw] knowledge_base_id
|
1372
|
+
# Identifier for a resource.
|
1373
|
+
# @return [String]
|
1374
|
+
#
|
1375
|
+
# @!attribute [rw] data_source_id
|
1376
|
+
# Identifier for a resource.
|
1377
|
+
# @return [String]
|
1378
|
+
#
|
1379
|
+
# @!attribute [rw] status
|
1380
|
+
# The status of a data source.
|
1381
|
+
# @return [String]
|
1382
|
+
#
|
1383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteDataSourceResponse AWS API Documentation
|
1384
|
+
#
|
1385
|
+
class DeleteDataSourceResponse < Struct.new(
|
1386
|
+
:knowledge_base_id,
|
1387
|
+
:data_source_id,
|
1388
|
+
:status)
|
1389
|
+
SENSITIVE = []
|
1390
|
+
include Aws::Structure
|
1391
|
+
end
|
1392
|
+
|
1393
|
+
# @!attribute [rw] knowledge_base_id
|
1394
|
+
# Identifier for a resource.
|
1395
|
+
# @return [String]
|
1396
|
+
#
|
1397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteKnowledgeBaseRequest AWS API Documentation
|
1398
|
+
#
|
1399
|
+
class DeleteKnowledgeBaseRequest < Struct.new(
|
1400
|
+
:knowledge_base_id)
|
1401
|
+
SENSITIVE = []
|
1402
|
+
include Aws::Structure
|
1403
|
+
end
|
1404
|
+
|
1405
|
+
# @!attribute [rw] knowledge_base_id
|
1406
|
+
# Identifier for a resource.
|
1407
|
+
# @return [String]
|
1408
|
+
#
|
1409
|
+
# @!attribute [rw] status
|
1410
|
+
# The status of a knowledge base.
|
1411
|
+
# @return [String]
|
1412
|
+
#
|
1413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteKnowledgeBaseResponse AWS API Documentation
|
1414
|
+
#
|
1415
|
+
class DeleteKnowledgeBaseResponse < Struct.new(
|
1416
|
+
:knowledge_base_id,
|
1417
|
+
:status)
|
1418
|
+
SENSITIVE = []
|
1419
|
+
include Aws::Structure
|
1420
|
+
end
|
1421
|
+
|
1422
|
+
# Disassociate Agent Knowledge Base Request
|
1423
|
+
#
|
1424
|
+
# @!attribute [rw] agent_id
|
1425
|
+
# Id generated at the server side when an Agent is created
|
1426
|
+
# @return [String]
|
1427
|
+
#
|
1428
|
+
# @!attribute [rw] agent_version
|
1429
|
+
# Draft Version of the Agent.
|
1430
|
+
# @return [String]
|
1431
|
+
#
|
1432
|
+
# @!attribute [rw] knowledge_base_id
|
1433
|
+
# Id generated at the server side when a Knowledge Base is associated
|
1434
|
+
# to an Agent
|
1435
|
+
# @return [String]
|
1436
|
+
#
|
1437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBaseRequest AWS API Documentation
|
1438
|
+
#
|
1439
|
+
class DisassociateAgentKnowledgeBaseRequest < Struct.new(
|
1440
|
+
:agent_id,
|
1441
|
+
:agent_version,
|
1442
|
+
:knowledge_base_id)
|
1443
|
+
SENSITIVE = []
|
1444
|
+
include Aws::Structure
|
1445
|
+
end
|
1446
|
+
|
1447
|
+
# Disassociate Agent Knowledge Base Response
|
1448
|
+
#
|
1449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBaseResponse AWS API Documentation
|
1450
|
+
#
|
1451
|
+
class DisassociateAgentKnowledgeBaseResponse < Aws::EmptyStructure; end
|
1452
|
+
|
1453
|
+
# Configures fixed size chunking strategy
|
1454
|
+
#
|
1455
|
+
# @!attribute [rw] max_tokens
|
1456
|
+
# The maximum number of tokens per chunk.
|
1457
|
+
# @return [Integer]
|
1458
|
+
#
|
1459
|
+
# @!attribute [rw] overlap_percentage
|
1460
|
+
# The overlap percentage between adjacent chunks.
|
1461
|
+
# @return [Integer]
|
1462
|
+
#
|
1463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FixedSizeChunkingConfiguration AWS API Documentation
|
1464
|
+
#
|
1465
|
+
class FixedSizeChunkingConfiguration < Struct.new(
|
1466
|
+
:max_tokens,
|
1467
|
+
:overlap_percentage)
|
1468
|
+
SENSITIVE = []
|
1469
|
+
include Aws::Structure
|
1470
|
+
end
|
1471
|
+
|
1472
|
+
# Get Action Group Request
|
1473
|
+
#
|
1474
|
+
# @!attribute [rw] agent_id
|
1475
|
+
# Id generated at the server side when an Agent is created
|
1476
|
+
# @return [String]
|
1477
|
+
#
|
1478
|
+
# @!attribute [rw] agent_version
|
1479
|
+
# Version number generated when a version is created
|
1480
|
+
# @return [String]
|
1481
|
+
#
|
1482
|
+
# @!attribute [rw] action_group_id
|
1483
|
+
# Id generated at the server side when an Agent Action Group is
|
1484
|
+
# created
|
1485
|
+
# @return [String]
|
1486
|
+
#
|
1487
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentActionGroupRequest AWS API Documentation
|
1488
|
+
#
|
1489
|
+
class GetAgentActionGroupRequest < Struct.new(
|
1490
|
+
:agent_id,
|
1491
|
+
:agent_version,
|
1492
|
+
:action_group_id)
|
1493
|
+
SENSITIVE = []
|
1494
|
+
include Aws::Structure
|
1495
|
+
end
|
1496
|
+
|
1497
|
+
# Get Action Group Response
|
1498
|
+
#
|
1499
|
+
# @!attribute [rw] agent_action_group
|
1500
|
+
# Contains the information of an Agent Action Group
|
1501
|
+
# @return [Types::AgentActionGroup]
|
1502
|
+
#
|
1503
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentActionGroupResponse AWS API Documentation
|
1504
|
+
#
|
1505
|
+
class GetAgentActionGroupResponse < Struct.new(
|
1506
|
+
:agent_action_group)
|
1507
|
+
SENSITIVE = []
|
1508
|
+
include Aws::Structure
|
1509
|
+
end
|
1510
|
+
|
1511
|
+
# Get Agent Alias Request
|
1512
|
+
#
|
1513
|
+
# @!attribute [rw] agent_id
|
1514
|
+
# Id generated at the server side when an Agent is created
|
1515
|
+
# @return [String]
|
1516
|
+
#
|
1517
|
+
# @!attribute [rw] agent_alias_id
|
1518
|
+
# Id generated at the server side when an Agent Alias is created
|
1519
|
+
# @return [String]
|
1520
|
+
#
|
1521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentAliasRequest AWS API Documentation
|
1522
|
+
#
|
1523
|
+
class GetAgentAliasRequest < Struct.new(
|
1524
|
+
:agent_id,
|
1525
|
+
:agent_alias_id)
|
1526
|
+
SENSITIVE = []
|
1527
|
+
include Aws::Structure
|
1528
|
+
end
|
1529
|
+
|
1530
|
+
# Get Agent Alias Response
|
1531
|
+
#
|
1532
|
+
# @!attribute [rw] agent_alias
|
1533
|
+
# Contains the information of an agent alias
|
1534
|
+
# @return [Types::AgentAlias]
|
1535
|
+
#
|
1536
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentAliasResponse AWS API Documentation
|
1537
|
+
#
|
1538
|
+
class GetAgentAliasResponse < Struct.new(
|
1539
|
+
:agent_alias)
|
1540
|
+
SENSITIVE = []
|
1541
|
+
include Aws::Structure
|
1542
|
+
end
|
1543
|
+
|
1544
|
+
# Get Agent Knowledge Base Request
|
1545
|
+
#
|
1546
|
+
# @!attribute [rw] agent_id
|
1547
|
+
# Id generated at the server side when an Agent is created
|
1548
|
+
# @return [String]
|
1549
|
+
#
|
1550
|
+
# @!attribute [rw] agent_version
|
1551
|
+
# Version number generated when a version is created
|
1552
|
+
# @return [String]
|
1553
|
+
#
|
1554
|
+
# @!attribute [rw] knowledge_base_id
|
1555
|
+
# Id generated at the server side when a Knowledge Base is associated
|
1556
|
+
# @return [String]
|
1557
|
+
#
|
1558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentKnowledgeBaseRequest AWS API Documentation
|
1559
|
+
#
|
1560
|
+
class GetAgentKnowledgeBaseRequest < Struct.new(
|
1561
|
+
:agent_id,
|
1562
|
+
:agent_version,
|
1563
|
+
:knowledge_base_id)
|
1564
|
+
SENSITIVE = []
|
1565
|
+
include Aws::Structure
|
1566
|
+
end
|
1567
|
+
|
1568
|
+
# Get Agent Knowledge Base Response
|
1569
|
+
#
|
1570
|
+
# @!attribute [rw] agent_knowledge_base
|
1571
|
+
# Contains the information of an Agent Knowledge Base.
|
1572
|
+
# @return [Types::AgentKnowledgeBase]
|
1573
|
+
#
|
1574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentKnowledgeBaseResponse AWS API Documentation
|
1575
|
+
#
|
1576
|
+
class GetAgentKnowledgeBaseResponse < Struct.new(
|
1577
|
+
:agent_knowledge_base)
|
1578
|
+
SENSITIVE = []
|
1579
|
+
include Aws::Structure
|
1580
|
+
end
|
1581
|
+
|
1582
|
+
# Get Agent Request
|
1583
|
+
#
|
1584
|
+
# @!attribute [rw] agent_id
|
1585
|
+
# Id generated at the server side when an Agent is created
|
1586
|
+
# @return [String]
|
1587
|
+
#
|
1588
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentRequest AWS API Documentation
|
1589
|
+
#
|
1590
|
+
class GetAgentRequest < Struct.new(
|
1591
|
+
:agent_id)
|
1592
|
+
SENSITIVE = []
|
1593
|
+
include Aws::Structure
|
1594
|
+
end
|
1595
|
+
|
1596
|
+
# Get Agent Response
|
1597
|
+
#
|
1598
|
+
# @!attribute [rw] agent
|
1599
|
+
# Contains the information of an agent
|
1600
|
+
# @return [Types::Agent]
|
1601
|
+
#
|
1602
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentResponse AWS API Documentation
|
1603
|
+
#
|
1604
|
+
class GetAgentResponse < Struct.new(
|
1605
|
+
:agent)
|
1606
|
+
SENSITIVE = []
|
1607
|
+
include Aws::Structure
|
1608
|
+
end
|
1609
|
+
|
1610
|
+
# Get Agent Version Request
|
1611
|
+
#
|
1612
|
+
# @!attribute [rw] agent_id
|
1613
|
+
# Id generated at the server side when an Agent is created
|
1614
|
+
# @return [String]
|
1615
|
+
#
|
1616
|
+
# @!attribute [rw] agent_version
|
1617
|
+
# Numerical Agent Version.
|
1618
|
+
# @return [String]
|
1619
|
+
#
|
1620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentVersionRequest AWS API Documentation
|
1621
|
+
#
|
1622
|
+
class GetAgentVersionRequest < Struct.new(
|
1623
|
+
:agent_id,
|
1624
|
+
:agent_version)
|
1625
|
+
SENSITIVE = []
|
1626
|
+
include Aws::Structure
|
1627
|
+
end
|
1628
|
+
|
1629
|
+
# Get Agent Version Response
|
1630
|
+
#
|
1631
|
+
# @!attribute [rw] agent_version
|
1632
|
+
# Contains the information of an agent version.
|
1633
|
+
# @return [Types::AgentVersion]
|
1634
|
+
#
|
1635
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentVersionResponse AWS API Documentation
|
1636
|
+
#
|
1637
|
+
class GetAgentVersionResponse < Struct.new(
|
1638
|
+
:agent_version)
|
1639
|
+
SENSITIVE = []
|
1640
|
+
include Aws::Structure
|
1641
|
+
end
|
1642
|
+
|
1643
|
+
# @!attribute [rw] knowledge_base_id
|
1644
|
+
# Identifier for a resource.
|
1645
|
+
# @return [String]
|
1646
|
+
#
|
1647
|
+
# @!attribute [rw] data_source_id
|
1648
|
+
# Identifier for a resource.
|
1649
|
+
# @return [String]
|
1650
|
+
#
|
1651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetDataSourceRequest AWS API Documentation
|
1652
|
+
#
|
1653
|
+
class GetDataSourceRequest < Struct.new(
|
1654
|
+
:knowledge_base_id,
|
1655
|
+
:data_source_id)
|
1656
|
+
SENSITIVE = []
|
1657
|
+
include Aws::Structure
|
1658
|
+
end
|
1659
|
+
|
1660
|
+
# @!attribute [rw] data_source
|
1661
|
+
# Contains the information of a data source.
|
1662
|
+
# @return [Types::DataSource]
|
1663
|
+
#
|
1664
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetDataSourceResponse AWS API Documentation
|
1665
|
+
#
|
1666
|
+
class GetDataSourceResponse < Struct.new(
|
1667
|
+
:data_source)
|
1668
|
+
SENSITIVE = []
|
1669
|
+
include Aws::Structure
|
1670
|
+
end
|
1671
|
+
|
1672
|
+
# @!attribute [rw] knowledge_base_id
|
1673
|
+
# Identifier for a resource.
|
1674
|
+
# @return [String]
|
1675
|
+
#
|
1676
|
+
# @!attribute [rw] data_source_id
|
1677
|
+
# Identifier for a resource.
|
1678
|
+
# @return [String]
|
1679
|
+
#
|
1680
|
+
# @!attribute [rw] ingestion_job_id
|
1681
|
+
# Identifier for a resource.
|
1682
|
+
# @return [String]
|
1683
|
+
#
|
1684
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJobRequest AWS API Documentation
|
1685
|
+
#
|
1686
|
+
class GetIngestionJobRequest < Struct.new(
|
1687
|
+
:knowledge_base_id,
|
1688
|
+
:data_source_id,
|
1689
|
+
:ingestion_job_id)
|
1690
|
+
SENSITIVE = []
|
1691
|
+
include Aws::Structure
|
1692
|
+
end
|
1693
|
+
|
1694
|
+
# @!attribute [rw] ingestion_job
|
1695
|
+
# Contains the information of an ingestion job.
|
1696
|
+
# @return [Types::IngestionJob]
|
1697
|
+
#
|
1698
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJobResponse AWS API Documentation
|
1699
|
+
#
|
1700
|
+
class GetIngestionJobResponse < Struct.new(
|
1701
|
+
:ingestion_job)
|
1702
|
+
SENSITIVE = []
|
1703
|
+
include Aws::Structure
|
1704
|
+
end
|
1705
|
+
|
1706
|
+
# @!attribute [rw] knowledge_base_id
|
1707
|
+
# Identifier for a resource.
|
1708
|
+
# @return [String]
|
1709
|
+
#
|
1710
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBaseRequest AWS API Documentation
|
1711
|
+
#
|
1712
|
+
class GetKnowledgeBaseRequest < Struct.new(
|
1713
|
+
:knowledge_base_id)
|
1714
|
+
SENSITIVE = []
|
1715
|
+
include Aws::Structure
|
1716
|
+
end
|
1717
|
+
|
1718
|
+
# @!attribute [rw] knowledge_base
|
1719
|
+
# Contains the information of a knowledge base.
|
1720
|
+
# @return [Types::KnowledgeBase]
|
1721
|
+
#
|
1722
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBaseResponse AWS API Documentation
|
1723
|
+
#
|
1724
|
+
class GetKnowledgeBaseResponse < Struct.new(
|
1725
|
+
:knowledge_base)
|
1726
|
+
SENSITIVE = []
|
1727
|
+
include Aws::Structure
|
1728
|
+
end
|
1729
|
+
|
1730
|
+
# Configuration for inference in prompt configuration
|
1731
|
+
#
|
1732
|
+
# @!attribute [rw] temperature
|
1733
|
+
# Controls randomness, higher values increase diversity
|
1734
|
+
# @return [Float]
|
1735
|
+
#
|
1736
|
+
# @!attribute [rw] top_p
|
1737
|
+
# Cumulative probability cutoff for token selection
|
1738
|
+
# @return [Float]
|
1739
|
+
#
|
1740
|
+
# @!attribute [rw] top_k
|
1741
|
+
# Sample from the k most likely next tokens
|
1742
|
+
# @return [Integer]
|
1743
|
+
#
|
1744
|
+
# @!attribute [rw] maximum_length
|
1745
|
+
# Maximum length of output
|
1746
|
+
# @return [Integer]
|
1747
|
+
#
|
1748
|
+
# @!attribute [rw] stop_sequences
|
1749
|
+
# List of stop sequences
|
1750
|
+
# @return [Array<String>]
|
1751
|
+
#
|
1752
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/InferenceConfiguration AWS API Documentation
|
1753
|
+
#
|
1754
|
+
class InferenceConfiguration < Struct.new(
|
1755
|
+
:temperature,
|
1756
|
+
:top_p,
|
1757
|
+
:top_k,
|
1758
|
+
:maximum_length,
|
1759
|
+
:stop_sequences)
|
1760
|
+
SENSITIVE = []
|
1761
|
+
include Aws::Structure
|
1762
|
+
end
|
1763
|
+
|
1764
|
+
# Contains the information of an ingestion job.
|
1765
|
+
#
|
1766
|
+
# @!attribute [rw] knowledge_base_id
|
1767
|
+
# Identifier for a resource.
|
1768
|
+
# @return [String]
|
1769
|
+
#
|
1770
|
+
# @!attribute [rw] data_source_id
|
1771
|
+
# Identifier for a resource.
|
1772
|
+
# @return [String]
|
1773
|
+
#
|
1774
|
+
# @!attribute [rw] ingestion_job_id
|
1775
|
+
# Identifier for a resource.
|
1776
|
+
# @return [String]
|
1777
|
+
#
|
1778
|
+
# @!attribute [rw] description
|
1779
|
+
# Description of the Resource.
|
1780
|
+
# @return [String]
|
1781
|
+
#
|
1782
|
+
# @!attribute [rw] status
|
1783
|
+
# The status of an ingestion job.
|
1784
|
+
# @return [String]
|
1785
|
+
#
|
1786
|
+
# @!attribute [rw] statistics
|
1787
|
+
# The document level statistics of an ingestion job
|
1788
|
+
# @return [Types::IngestionJobStatistics]
|
1789
|
+
#
|
1790
|
+
# @!attribute [rw] failure_reasons
|
1791
|
+
# Failure Reasons for Error.
|
1792
|
+
# @return [Array<String>]
|
1793
|
+
#
|
1794
|
+
# @!attribute [rw] started_at
|
1795
|
+
# Time Stamp.
|
1796
|
+
# @return [Time]
|
1797
|
+
#
|
1798
|
+
# @!attribute [rw] updated_at
|
1799
|
+
# Time Stamp.
|
1800
|
+
# @return [Time]
|
1801
|
+
#
|
1802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJob AWS API Documentation
|
1803
|
+
#
|
1804
|
+
class IngestionJob < Struct.new(
|
1805
|
+
:knowledge_base_id,
|
1806
|
+
:data_source_id,
|
1807
|
+
:ingestion_job_id,
|
1808
|
+
:description,
|
1809
|
+
:status,
|
1810
|
+
:statistics,
|
1811
|
+
:failure_reasons,
|
1812
|
+
:started_at,
|
1813
|
+
:updated_at)
|
1814
|
+
SENSITIVE = []
|
1815
|
+
include Aws::Structure
|
1816
|
+
end
|
1817
|
+
|
1818
|
+
# Filters the response returned by ListIngestionJobs operation.
|
1819
|
+
#
|
1820
|
+
# @!attribute [rw] attribute
|
1821
|
+
# The name of the field to filter ingestion jobs.
|
1822
|
+
# @return [String]
|
1823
|
+
#
|
1824
|
+
# @!attribute [rw] operator
|
1825
|
+
# The operator used to filter ingestion jobs.
|
1826
|
+
# @return [String]
|
1827
|
+
#
|
1828
|
+
# @!attribute [rw] values
|
1829
|
+
# The list of values used to filter ingestion jobs.
|
1830
|
+
# @return [Array<String>]
|
1831
|
+
#
|
1832
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJobFilter AWS API Documentation
|
1833
|
+
#
|
1834
|
+
class IngestionJobFilter < Struct.new(
|
1835
|
+
:attribute,
|
1836
|
+
:operator,
|
1837
|
+
:values)
|
1838
|
+
SENSITIVE = []
|
1839
|
+
include Aws::Structure
|
1840
|
+
end
|
1841
|
+
|
1842
|
+
# Sorts the response returned by ListIngestionJobs operation.
|
1843
|
+
#
|
1844
|
+
# @!attribute [rw] attribute
|
1845
|
+
# The name of the field to sort ingestion jobs.
|
1846
|
+
# @return [String]
|
1847
|
+
#
|
1848
|
+
# @!attribute [rw] order
|
1849
|
+
# Order to sort results by.
|
1850
|
+
# @return [String]
|
1851
|
+
#
|
1852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJobSortBy AWS API Documentation
|
1853
|
+
#
|
1854
|
+
class IngestionJobSortBy < Struct.new(
|
1855
|
+
:attribute,
|
1856
|
+
:order)
|
1857
|
+
SENSITIVE = []
|
1858
|
+
include Aws::Structure
|
1859
|
+
end
|
1860
|
+
|
1861
|
+
# The document level statistics of an ingestion job
|
1862
|
+
#
|
1863
|
+
# @!attribute [rw] number_of_documents_scanned
|
1864
|
+
# Number of scanned documents
|
1865
|
+
# @return [Integer]
|
1866
|
+
#
|
1867
|
+
# @!attribute [rw] number_of_new_documents_indexed
|
1868
|
+
# Number of indexed documents
|
1869
|
+
# @return [Integer]
|
1870
|
+
#
|
1871
|
+
# @!attribute [rw] number_of_modified_documents_indexed
|
1872
|
+
# Number of modified documents indexed
|
1873
|
+
# @return [Integer]
|
1874
|
+
#
|
1875
|
+
# @!attribute [rw] number_of_documents_deleted
|
1876
|
+
# Number of deleted documents
|
1877
|
+
# @return [Integer]
|
1878
|
+
#
|
1879
|
+
# @!attribute [rw] number_of_documents_failed
|
1880
|
+
# Number of failed documents
|
1881
|
+
# @return [Integer]
|
1882
|
+
#
|
1883
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJobStatistics AWS API Documentation
|
1884
|
+
#
|
1885
|
+
class IngestionJobStatistics < Struct.new(
|
1886
|
+
:number_of_documents_scanned,
|
1887
|
+
:number_of_new_documents_indexed,
|
1888
|
+
:number_of_modified_documents_indexed,
|
1889
|
+
:number_of_documents_deleted,
|
1890
|
+
:number_of_documents_failed)
|
1891
|
+
SENSITIVE = []
|
1892
|
+
include Aws::Structure
|
1893
|
+
end
|
1894
|
+
|
1895
|
+
# Summary information of an ingestion job.
|
1896
|
+
#
|
1897
|
+
# @!attribute [rw] knowledge_base_id
|
1898
|
+
# Identifier for a resource.
|
1899
|
+
# @return [String]
|
1900
|
+
#
|
1901
|
+
# @!attribute [rw] data_source_id
|
1902
|
+
# Identifier for a resource.
|
1903
|
+
# @return [String]
|
1904
|
+
#
|
1905
|
+
# @!attribute [rw] ingestion_job_id
|
1906
|
+
# Identifier for a resource.
|
1907
|
+
# @return [String]
|
1908
|
+
#
|
1909
|
+
# @!attribute [rw] description
|
1910
|
+
# Description of the Resource.
|
1911
|
+
# @return [String]
|
1912
|
+
#
|
1913
|
+
# @!attribute [rw] status
|
1914
|
+
# The status of an ingestion job.
|
1915
|
+
# @return [String]
|
1916
|
+
#
|
1917
|
+
# @!attribute [rw] started_at
|
1918
|
+
# Time Stamp.
|
1919
|
+
# @return [Time]
|
1920
|
+
#
|
1921
|
+
# @!attribute [rw] updated_at
|
1922
|
+
# Time Stamp.
|
1923
|
+
# @return [Time]
|
1924
|
+
#
|
1925
|
+
# @!attribute [rw] statistics
|
1926
|
+
# The document level statistics of an ingestion job
|
1927
|
+
# @return [Types::IngestionJobStatistics]
|
1928
|
+
#
|
1929
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJobSummary AWS API Documentation
|
1930
|
+
#
|
1931
|
+
class IngestionJobSummary < Struct.new(
|
1932
|
+
:knowledge_base_id,
|
1933
|
+
:data_source_id,
|
1934
|
+
:ingestion_job_id,
|
1935
|
+
:description,
|
1936
|
+
:status,
|
1937
|
+
:started_at,
|
1938
|
+
:updated_at,
|
1939
|
+
:statistics)
|
1940
|
+
SENSITIVE = []
|
1941
|
+
include Aws::Structure
|
1942
|
+
end
|
1943
|
+
|
1944
|
+
# This exception is thrown if there was an unexpected error during
|
1945
|
+
# processing of request
|
1946
|
+
#
|
1947
|
+
# @!attribute [rw] message
|
1948
|
+
# Non Blank String
|
1949
|
+
# @return [String]
|
1950
|
+
#
|
1951
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/InternalServerException AWS API Documentation
|
1952
|
+
#
|
1953
|
+
class InternalServerException < Struct.new(
|
1954
|
+
:message)
|
1955
|
+
SENSITIVE = []
|
1956
|
+
include Aws::Structure
|
1957
|
+
end
|
1958
|
+
|
1959
|
+
# Contains the information of a knowledge base.
|
1960
|
+
#
|
1961
|
+
# @!attribute [rw] knowledge_base_id
|
1962
|
+
# Identifier for a resource.
|
1963
|
+
# @return [String]
|
1964
|
+
#
|
1965
|
+
# @!attribute [rw] name
|
1966
|
+
# Name for a resource.
|
1967
|
+
# @return [String]
|
1968
|
+
#
|
1969
|
+
# @!attribute [rw] knowledge_base_arn
|
1970
|
+
# ARN of a KnowledgeBase
|
1971
|
+
# @return [String]
|
1972
|
+
#
|
1973
|
+
# @!attribute [rw] description
|
1974
|
+
# Description of the Resource.
|
1975
|
+
# @return [String]
|
1976
|
+
#
|
1977
|
+
# @!attribute [rw] role_arn
|
1978
|
+
# ARN of a IAM role.
|
1979
|
+
# @return [String]
|
1980
|
+
#
|
1981
|
+
# @!attribute [rw] knowledge_base_configuration
|
1982
|
+
# Configures a bedrock knowledge base.
|
1983
|
+
# @return [Types::KnowledgeBaseConfiguration]
|
1984
|
+
#
|
1985
|
+
# @!attribute [rw] storage_configuration
|
1986
|
+
# Configures the physical storage of ingested data in a knowledge
|
1987
|
+
# base.
|
1988
|
+
# @return [Types::StorageConfiguration]
|
1989
|
+
#
|
1990
|
+
# @!attribute [rw] status
|
1991
|
+
# The status of a knowledge base.
|
1992
|
+
# @return [String]
|
1993
|
+
#
|
1994
|
+
# @!attribute [rw] created_at
|
1995
|
+
# Time Stamp.
|
1996
|
+
# @return [Time]
|
1997
|
+
#
|
1998
|
+
# @!attribute [rw] updated_at
|
1999
|
+
# Time Stamp.
|
2000
|
+
# @return [Time]
|
2001
|
+
#
|
2002
|
+
# @!attribute [rw] failure_reasons
|
2003
|
+
# Failure Reasons for Error.
|
2004
|
+
# @return [Array<String>]
|
2005
|
+
#
|
2006
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBase AWS API Documentation
|
2007
|
+
#
|
2008
|
+
class KnowledgeBase < Struct.new(
|
2009
|
+
:knowledge_base_id,
|
2010
|
+
:name,
|
2011
|
+
:knowledge_base_arn,
|
2012
|
+
:description,
|
2013
|
+
:role_arn,
|
2014
|
+
:knowledge_base_configuration,
|
2015
|
+
:storage_configuration,
|
2016
|
+
:status,
|
2017
|
+
:created_at,
|
2018
|
+
:updated_at,
|
2019
|
+
:failure_reasons)
|
2020
|
+
SENSITIVE = []
|
2021
|
+
include Aws::Structure
|
2022
|
+
end
|
2023
|
+
|
2024
|
+
# Configures a bedrock knowledge base.
|
2025
|
+
#
|
2026
|
+
# @!attribute [rw] type
|
2027
|
+
# The type of a knowledge base.
|
2028
|
+
# @return [String]
|
2029
|
+
#
|
2030
|
+
# @!attribute [rw] vector_knowledge_base_configuration
|
2031
|
+
# Configurations for a vector knowledge base.
|
2032
|
+
# @return [Types::VectorKnowledgeBaseConfiguration]
|
2033
|
+
#
|
2034
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseConfiguration AWS API Documentation
|
2035
|
+
#
|
2036
|
+
class KnowledgeBaseConfiguration < Struct.new(
|
2037
|
+
:type,
|
2038
|
+
:vector_knowledge_base_configuration)
|
2039
|
+
SENSITIVE = []
|
2040
|
+
include Aws::Structure
|
2041
|
+
end
|
2042
|
+
|
2043
|
+
# Summary information of a knowledge base.
|
2044
|
+
#
|
2045
|
+
# @!attribute [rw] knowledge_base_id
|
2046
|
+
# Identifier for a resource.
|
2047
|
+
# @return [String]
|
2048
|
+
#
|
2049
|
+
# @!attribute [rw] name
|
2050
|
+
# Name for a resource.
|
2051
|
+
# @return [String]
|
2052
|
+
#
|
2053
|
+
# @!attribute [rw] description
|
2054
|
+
# Description of the Resource.
|
2055
|
+
# @return [String]
|
2056
|
+
#
|
2057
|
+
# @!attribute [rw] status
|
2058
|
+
# The status of a knowledge base.
|
2059
|
+
# @return [String]
|
2060
|
+
#
|
2061
|
+
# @!attribute [rw] updated_at
|
2062
|
+
# Time Stamp.
|
2063
|
+
# @return [Time]
|
2064
|
+
#
|
2065
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseSummary AWS API Documentation
|
2066
|
+
#
|
2067
|
+
class KnowledgeBaseSummary < Struct.new(
|
2068
|
+
:knowledge_base_id,
|
2069
|
+
:name,
|
2070
|
+
:description,
|
2071
|
+
:status,
|
2072
|
+
:updated_at)
|
2073
|
+
SENSITIVE = []
|
2074
|
+
include Aws::Structure
|
2075
|
+
end
|
2076
|
+
|
2077
|
+
# List Action Groups Request
|
2078
|
+
#
|
2079
|
+
# @!attribute [rw] agent_id
|
2080
|
+
# Id generated at the server side when an Agent is Listed
|
2081
|
+
# @return [String]
|
2082
|
+
#
|
2083
|
+
# @!attribute [rw] agent_version
|
2084
|
+
# Id generated at the server side when an Agent is Listed
|
2085
|
+
# @return [String]
|
2086
|
+
#
|
2087
|
+
# @!attribute [rw] max_results
|
2088
|
+
# Max Results.
|
2089
|
+
# @return [Integer]
|
2090
|
+
#
|
2091
|
+
# @!attribute [rw] next_token
|
2092
|
+
# Opaque continuation token of previous paginated response.
|
2093
|
+
# @return [String]
|
2094
|
+
#
|
2095
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentActionGroupsRequest AWS API Documentation
|
2096
|
+
#
|
2097
|
+
class ListAgentActionGroupsRequest < Struct.new(
|
2098
|
+
:agent_id,
|
2099
|
+
:agent_version,
|
2100
|
+
:max_results,
|
2101
|
+
:next_token)
|
2102
|
+
SENSITIVE = []
|
2103
|
+
include Aws::Structure
|
2104
|
+
end
|
2105
|
+
|
2106
|
+
# List Action Groups Response
|
2107
|
+
#
|
2108
|
+
# @!attribute [rw] action_group_summaries
|
2109
|
+
# List of ActionGroup Summaries
|
2110
|
+
# @return [Array<Types::ActionGroupSummary>]
|
2111
|
+
#
|
2112
|
+
# @!attribute [rw] next_token
|
2113
|
+
# Opaque continuation token of previous paginated response.
|
2114
|
+
# @return [String]
|
2115
|
+
#
|
2116
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentActionGroupsResponse AWS API Documentation
|
2117
|
+
#
|
2118
|
+
class ListAgentActionGroupsResponse < Struct.new(
|
2119
|
+
:action_group_summaries,
|
2120
|
+
:next_token)
|
2121
|
+
SENSITIVE = []
|
2122
|
+
include Aws::Structure
|
2123
|
+
end
|
2124
|
+
|
2125
|
+
# List Agent Aliases Request
|
2126
|
+
#
|
2127
|
+
# @!attribute [rw] agent_id
|
2128
|
+
# Id generated at the server side when an Agent is created
|
2129
|
+
# @return [String]
|
2130
|
+
#
|
2131
|
+
# @!attribute [rw] max_results
|
2132
|
+
# Max Results.
|
2133
|
+
# @return [Integer]
|
2134
|
+
#
|
2135
|
+
# @!attribute [rw] next_token
|
2136
|
+
# Opaque continuation token of previous paginated response.
|
2137
|
+
# @return [String]
|
2138
|
+
#
|
2139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentAliasesRequest AWS API Documentation
|
2140
|
+
#
|
2141
|
+
class ListAgentAliasesRequest < Struct.new(
|
2142
|
+
:agent_id,
|
2143
|
+
:max_results,
|
2144
|
+
:next_token)
|
2145
|
+
SENSITIVE = []
|
2146
|
+
include Aws::Structure
|
2147
|
+
end
|
2148
|
+
|
2149
|
+
# List Agent Aliases Response
|
2150
|
+
#
|
2151
|
+
# @!attribute [rw] agent_alias_summaries
|
2152
|
+
# The list of summaries of all the aliases for an Agent.
|
2153
|
+
# @return [Array<Types::AgentAliasSummary>]
|
2154
|
+
#
|
2155
|
+
# @!attribute [rw] next_token
|
2156
|
+
# Opaque continuation token of previous paginated response.
|
2157
|
+
# @return [String]
|
2158
|
+
#
|
2159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentAliasesResponse AWS API Documentation
|
2160
|
+
#
|
2161
|
+
class ListAgentAliasesResponse < Struct.new(
|
2162
|
+
:agent_alias_summaries,
|
2163
|
+
:next_token)
|
2164
|
+
SENSITIVE = []
|
2165
|
+
include Aws::Structure
|
2166
|
+
end
|
2167
|
+
|
2168
|
+
# List Agent Knowledge Bases Request
|
2169
|
+
#
|
2170
|
+
# @!attribute [rw] agent_id
|
2171
|
+
# Id generated at the server side when an Agent is created
|
2172
|
+
# @return [String]
|
2173
|
+
#
|
2174
|
+
# @!attribute [rw] agent_version
|
2175
|
+
# Version number generated when a version is created
|
2176
|
+
# @return [String]
|
2177
|
+
#
|
2178
|
+
# @!attribute [rw] max_results
|
2179
|
+
# Max Results.
|
2180
|
+
# @return [Integer]
|
2181
|
+
#
|
2182
|
+
# @!attribute [rw] next_token
|
2183
|
+
# Opaque continuation token of previous paginated response.
|
2184
|
+
# @return [String]
|
2185
|
+
#
|
2186
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentKnowledgeBasesRequest AWS API Documentation
|
2187
|
+
#
|
2188
|
+
class ListAgentKnowledgeBasesRequest < Struct.new(
|
2189
|
+
:agent_id,
|
2190
|
+
:agent_version,
|
2191
|
+
:max_results,
|
2192
|
+
:next_token)
|
2193
|
+
SENSITIVE = []
|
2194
|
+
include Aws::Structure
|
2195
|
+
end
|
2196
|
+
|
2197
|
+
# List Agent Knowledge Bases Response
|
2198
|
+
#
|
2199
|
+
# @!attribute [rw] agent_knowledge_base_summaries
|
2200
|
+
# List of Agent Knowledge Base Summaries
|
2201
|
+
# @return [Array<Types::AgentKnowledgeBaseSummary>]
|
2202
|
+
#
|
2203
|
+
# @!attribute [rw] next_token
|
2204
|
+
# Opaque continuation token of previous paginated response.
|
2205
|
+
# @return [String]
|
2206
|
+
#
|
2207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentKnowledgeBasesResponse AWS API Documentation
|
2208
|
+
#
|
2209
|
+
class ListAgentKnowledgeBasesResponse < Struct.new(
|
2210
|
+
:agent_knowledge_base_summaries,
|
2211
|
+
:next_token)
|
2212
|
+
SENSITIVE = []
|
2213
|
+
include Aws::Structure
|
2214
|
+
end
|
2215
|
+
|
2216
|
+
# List Agent Versions Request
|
2217
|
+
#
|
2218
|
+
# @!attribute [rw] agent_id
|
2219
|
+
# Id generated at the server side when an Agent is created
|
2220
|
+
# @return [String]
|
2221
|
+
#
|
2222
|
+
# @!attribute [rw] max_results
|
2223
|
+
# Max Results.
|
2224
|
+
# @return [Integer]
|
2225
|
+
#
|
2226
|
+
# @!attribute [rw] next_token
|
2227
|
+
# Opaque continuation token of previous paginated response.
|
2228
|
+
# @return [String]
|
2229
|
+
#
|
2230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentVersionsRequest AWS API Documentation
|
2231
|
+
#
|
2232
|
+
class ListAgentVersionsRequest < Struct.new(
|
2233
|
+
:agent_id,
|
2234
|
+
:max_results,
|
2235
|
+
:next_token)
|
2236
|
+
SENSITIVE = []
|
2237
|
+
include Aws::Structure
|
2238
|
+
end
|
2239
|
+
|
2240
|
+
# List Agent Versions Response
|
2241
|
+
#
|
2242
|
+
# @!attribute [rw] agent_version_summaries
|
2243
|
+
# List of AgentVersionSummary.
|
2244
|
+
# @return [Array<Types::AgentVersionSummary>]
|
2245
|
+
#
|
2246
|
+
# @!attribute [rw] next_token
|
2247
|
+
# Opaque continuation token of previous paginated response.
|
2248
|
+
# @return [String]
|
2249
|
+
#
|
2250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentVersionsResponse AWS API Documentation
|
2251
|
+
#
|
2252
|
+
class ListAgentVersionsResponse < Struct.new(
|
2253
|
+
:agent_version_summaries,
|
2254
|
+
:next_token)
|
2255
|
+
SENSITIVE = []
|
2256
|
+
include Aws::Structure
|
2257
|
+
end
|
2258
|
+
|
2259
|
+
# List Agent Request
|
2260
|
+
#
|
2261
|
+
# @!attribute [rw] max_results
|
2262
|
+
# Max Results.
|
2263
|
+
# @return [Integer]
|
2264
|
+
#
|
2265
|
+
# @!attribute [rw] next_token
|
2266
|
+
# Opaque continuation token of previous paginated response.
|
2267
|
+
# @return [String]
|
2268
|
+
#
|
2269
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentsRequest AWS API Documentation
|
2270
|
+
#
|
2271
|
+
class ListAgentsRequest < Struct.new(
|
2272
|
+
:max_results,
|
2273
|
+
:next_token)
|
2274
|
+
SENSITIVE = []
|
2275
|
+
include Aws::Structure
|
2276
|
+
end
|
2277
|
+
|
2278
|
+
# List Agent Response
|
2279
|
+
#
|
2280
|
+
# @!attribute [rw] agent_summaries
|
2281
|
+
# List of AgentSummary.
|
2282
|
+
# @return [Array<Types::AgentSummary>]
|
2283
|
+
#
|
2284
|
+
# @!attribute [rw] next_token
|
2285
|
+
# Opaque continuation token of previous paginated response.
|
2286
|
+
# @return [String]
|
2287
|
+
#
|
2288
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentsResponse AWS API Documentation
|
2289
|
+
#
|
2290
|
+
class ListAgentsResponse < Struct.new(
|
2291
|
+
:agent_summaries,
|
2292
|
+
:next_token)
|
2293
|
+
SENSITIVE = []
|
2294
|
+
include Aws::Structure
|
2295
|
+
end
|
2296
|
+
|
2297
|
+
# @!attribute [rw] knowledge_base_id
|
2298
|
+
# Identifier for a resource.
|
2299
|
+
# @return [String]
|
2300
|
+
#
|
2301
|
+
# @!attribute [rw] max_results
|
2302
|
+
# Max Results.
|
2303
|
+
# @return [Integer]
|
2304
|
+
#
|
2305
|
+
# @!attribute [rw] next_token
|
2306
|
+
# Opaque continuation token of previous paginated response.
|
2307
|
+
# @return [String]
|
2308
|
+
#
|
2309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListDataSourcesRequest AWS API Documentation
|
2310
|
+
#
|
2311
|
+
class ListDataSourcesRequest < Struct.new(
|
2312
|
+
:knowledge_base_id,
|
2313
|
+
:max_results,
|
2314
|
+
:next_token)
|
2315
|
+
SENSITIVE = []
|
2316
|
+
include Aws::Structure
|
2317
|
+
end
|
2318
|
+
|
2319
|
+
# @!attribute [rw] data_source_summaries
|
2320
|
+
# list of data source summaries
|
2321
|
+
# @return [Array<Types::DataSourceSummary>]
|
2322
|
+
#
|
2323
|
+
# @!attribute [rw] next_token
|
2324
|
+
# Opaque continuation token of previous paginated response.
|
2325
|
+
# @return [String]
|
2326
|
+
#
|
2327
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListDataSourcesResponse AWS API Documentation
|
2328
|
+
#
|
2329
|
+
class ListDataSourcesResponse < Struct.new(
|
2330
|
+
:data_source_summaries,
|
2331
|
+
:next_token)
|
2332
|
+
SENSITIVE = []
|
2333
|
+
include Aws::Structure
|
2334
|
+
end
|
2335
|
+
|
2336
|
+
# @!attribute [rw] knowledge_base_id
|
2337
|
+
# Identifier for a resource.
|
2338
|
+
# @return [String]
|
2339
|
+
#
|
2340
|
+
# @!attribute [rw] data_source_id
|
2341
|
+
# Identifier for a resource.
|
2342
|
+
# @return [String]
|
2343
|
+
#
|
2344
|
+
# @!attribute [rw] filters
|
2345
|
+
# List of IngestionJobFilters
|
2346
|
+
# @return [Array<Types::IngestionJobFilter>]
|
2347
|
+
#
|
2348
|
+
# @!attribute [rw] sort_by
|
2349
|
+
# Sorts the response returned by ListIngestionJobs operation.
|
2350
|
+
# @return [Types::IngestionJobSortBy]
|
2351
|
+
#
|
2352
|
+
# @!attribute [rw] max_results
|
2353
|
+
# Max Results.
|
2354
|
+
# @return [Integer]
|
2355
|
+
#
|
2356
|
+
# @!attribute [rw] next_token
|
2357
|
+
# Opaque continuation token of previous paginated response.
|
2358
|
+
# @return [String]
|
2359
|
+
#
|
2360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListIngestionJobsRequest AWS API Documentation
|
2361
|
+
#
|
2362
|
+
class ListIngestionJobsRequest < Struct.new(
|
2363
|
+
:knowledge_base_id,
|
2364
|
+
:data_source_id,
|
2365
|
+
:filters,
|
2366
|
+
:sort_by,
|
2367
|
+
:max_results,
|
2368
|
+
:next_token)
|
2369
|
+
SENSITIVE = []
|
2370
|
+
include Aws::Structure
|
2371
|
+
end
|
2372
|
+
|
2373
|
+
# @!attribute [rw] ingestion_job_summaries
|
2374
|
+
# List of IngestionJobSummaries
|
2375
|
+
# @return [Array<Types::IngestionJobSummary>]
|
2376
|
+
#
|
2377
|
+
# @!attribute [rw] next_token
|
2378
|
+
# Opaque continuation token of previous paginated response.
|
2379
|
+
# @return [String]
|
2380
|
+
#
|
2381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListIngestionJobsResponse AWS API Documentation
|
2382
|
+
#
|
2383
|
+
class ListIngestionJobsResponse < Struct.new(
|
2384
|
+
:ingestion_job_summaries,
|
2385
|
+
:next_token)
|
2386
|
+
SENSITIVE = []
|
2387
|
+
include Aws::Structure
|
2388
|
+
end
|
2389
|
+
|
2390
|
+
# @!attribute [rw] max_results
|
2391
|
+
# Max Results.
|
2392
|
+
# @return [Integer]
|
2393
|
+
#
|
2394
|
+
# @!attribute [rw] next_token
|
2395
|
+
# Opaque continuation token of previous paginated response.
|
2396
|
+
# @return [String]
|
2397
|
+
#
|
2398
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListKnowledgeBasesRequest AWS API Documentation
|
2399
|
+
#
|
2400
|
+
class ListKnowledgeBasesRequest < Struct.new(
|
2401
|
+
:max_results,
|
2402
|
+
:next_token)
|
2403
|
+
SENSITIVE = []
|
2404
|
+
include Aws::Structure
|
2405
|
+
end
|
2406
|
+
|
2407
|
+
# @!attribute [rw] knowledge_base_summaries
|
2408
|
+
# List of KnowledgeBaseSummaries
|
2409
|
+
# @return [Array<Types::KnowledgeBaseSummary>]
|
2410
|
+
#
|
2411
|
+
# @!attribute [rw] next_token
|
2412
|
+
# Opaque continuation token of previous paginated response.
|
2413
|
+
# @return [String]
|
2414
|
+
#
|
2415
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListKnowledgeBasesResponse AWS API Documentation
|
2416
|
+
#
|
2417
|
+
class ListKnowledgeBasesResponse < Struct.new(
|
2418
|
+
:knowledge_base_summaries,
|
2419
|
+
:next_token)
|
2420
|
+
SENSITIVE = []
|
2421
|
+
include Aws::Structure
|
2422
|
+
end
|
2423
|
+
|
2424
|
+
# @!attribute [rw] resource_arn
|
2425
|
+
# ARN of Taggable resources: \[Agent, AgentAlias, Knowledge-Base\]
|
2426
|
+
# @return [String]
|
2427
|
+
#
|
2428
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListTagsForResourceRequest AWS API Documentation
|
2429
|
+
#
|
2430
|
+
class ListTagsForResourceRequest < Struct.new(
|
2431
|
+
:resource_arn)
|
2432
|
+
SENSITIVE = []
|
2433
|
+
include Aws::Structure
|
2434
|
+
end
|
2435
|
+
|
2436
|
+
# @!attribute [rw] tags
|
2437
|
+
# A map of tag keys and values
|
2438
|
+
# @return [Hash<String,String>]
|
2439
|
+
#
|
2440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListTagsForResourceResponse AWS API Documentation
|
2441
|
+
#
|
2442
|
+
class ListTagsForResourceResponse < Struct.new(
|
2443
|
+
:tags)
|
2444
|
+
SENSITIVE = []
|
2445
|
+
include Aws::Structure
|
2446
|
+
end
|
2447
|
+
|
2448
|
+
# Contains the configurations to use OpenSearch Serverless to store
|
2449
|
+
# knowledge base data.
|
2450
|
+
#
|
2451
|
+
# @!attribute [rw] collection_arn
|
2452
|
+
# Arn of an OpenSearch Serverless collection.
|
2453
|
+
# @return [String]
|
2454
|
+
#
|
2455
|
+
# @!attribute [rw] vector_index_name
|
2456
|
+
# Arn of an OpenSearch Serverless index.
|
2457
|
+
# @return [String]
|
2458
|
+
#
|
2459
|
+
# @!attribute [rw] field_mapping
|
2460
|
+
# A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless
|
2461
|
+
# field names
|
2462
|
+
# @return [Types::OpenSearchServerlessFieldMapping]
|
2463
|
+
#
|
2464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/OpenSearchServerlessConfiguration AWS API Documentation
|
2465
|
+
#
|
2466
|
+
class OpenSearchServerlessConfiguration < Struct.new(
|
2467
|
+
:collection_arn,
|
2468
|
+
:vector_index_name,
|
2469
|
+
:field_mapping)
|
2470
|
+
SENSITIVE = []
|
2471
|
+
include Aws::Structure
|
2472
|
+
end
|
2473
|
+
|
2474
|
+
# A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless
|
2475
|
+
# field names
|
2476
|
+
#
|
2477
|
+
# @!attribute [rw] vector_field
|
2478
|
+
# Name of the field
|
2479
|
+
# @return [String]
|
2480
|
+
#
|
2481
|
+
# @!attribute [rw] text_field
|
2482
|
+
# Name of the field
|
2483
|
+
# @return [String]
|
2484
|
+
#
|
2485
|
+
# @!attribute [rw] metadata_field
|
2486
|
+
# Name of the field
|
2487
|
+
# @return [String]
|
2488
|
+
#
|
2489
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/OpenSearchServerlessFieldMapping AWS API Documentation
|
2490
|
+
#
|
2491
|
+
class OpenSearchServerlessFieldMapping < Struct.new(
|
2492
|
+
:vector_field,
|
2493
|
+
:text_field,
|
2494
|
+
:metadata_field)
|
2495
|
+
SENSITIVE = []
|
2496
|
+
include Aws::Structure
|
2497
|
+
end
|
2498
|
+
|
2499
|
+
# Contains the configurations to use Pinecone to store knowledge base
|
2500
|
+
# data.
|
2501
|
+
#
|
2502
|
+
# @!attribute [rw] connection_string
|
2503
|
+
# Pinecone connection string
|
2504
|
+
# @return [String]
|
2505
|
+
#
|
2506
|
+
# @!attribute [rw] credentials_secret_arn
|
2507
|
+
# Arn of a SecretsManager Secret.
|
2508
|
+
# @return [String]
|
2509
|
+
#
|
2510
|
+
# @!attribute [rw] namespace
|
2511
|
+
# Pinecone namespace
|
2512
|
+
# @return [String]
|
2513
|
+
#
|
2514
|
+
# @!attribute [rw] field_mapping
|
2515
|
+
# A mapping of Bedrock Knowledge Base fields to Pinecone field names
|
2516
|
+
# @return [Types::PineconeFieldMapping]
|
2517
|
+
#
|
2518
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PineconeConfiguration AWS API Documentation
|
2519
|
+
#
|
2520
|
+
class PineconeConfiguration < Struct.new(
|
2521
|
+
:connection_string,
|
2522
|
+
:credentials_secret_arn,
|
2523
|
+
:namespace,
|
2524
|
+
:field_mapping)
|
2525
|
+
SENSITIVE = []
|
2526
|
+
include Aws::Structure
|
2527
|
+
end
|
2528
|
+
|
2529
|
+
# A mapping of Bedrock Knowledge Base fields to Pinecone field names
|
2530
|
+
#
|
2531
|
+
# @!attribute [rw] text_field
|
2532
|
+
# Name of the field
|
2533
|
+
# @return [String]
|
2534
|
+
#
|
2535
|
+
# @!attribute [rw] metadata_field
|
2536
|
+
# Name of the field
|
2537
|
+
# @return [String]
|
2538
|
+
#
|
2539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PineconeFieldMapping AWS API Documentation
|
2540
|
+
#
|
2541
|
+
class PineconeFieldMapping < Struct.new(
|
2542
|
+
:text_field,
|
2543
|
+
:metadata_field)
|
2544
|
+
SENSITIVE = []
|
2545
|
+
include Aws::Structure
|
2546
|
+
end
|
2547
|
+
|
2548
|
+
# PrepareAgent Request
|
2549
|
+
#
|
2550
|
+
# @!attribute [rw] agent_id
|
2551
|
+
# Id generated at the server side when an Agent is created
|
2552
|
+
# @return [String]
|
2553
|
+
#
|
2554
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PrepareAgentRequest AWS API Documentation
|
2555
|
+
#
|
2556
|
+
class PrepareAgentRequest < Struct.new(
|
2557
|
+
:agent_id)
|
2558
|
+
SENSITIVE = []
|
2559
|
+
include Aws::Structure
|
2560
|
+
end
|
2561
|
+
|
2562
|
+
# PrepareAgent Response
|
2563
|
+
#
|
2564
|
+
# @!attribute [rw] agent_id
|
2565
|
+
# Identifier for a resource.
|
2566
|
+
# @return [String]
|
2567
|
+
#
|
2568
|
+
# @!attribute [rw] agent_status
|
2569
|
+
# Schema Type for Action APIs.
|
2570
|
+
# @return [String]
|
2571
|
+
#
|
2572
|
+
# @!attribute [rw] agent_version
|
2573
|
+
# Agent Version.
|
2574
|
+
# @return [String]
|
2575
|
+
#
|
2576
|
+
# @!attribute [rw] prepared_at
|
2577
|
+
# Time Stamp.
|
2578
|
+
# @return [Time]
|
2579
|
+
#
|
2580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PrepareAgentResponse AWS API Documentation
|
2581
|
+
#
|
2582
|
+
class PrepareAgentResponse < Struct.new(
|
2583
|
+
:agent_id,
|
2584
|
+
:agent_status,
|
2585
|
+
:agent_version,
|
2586
|
+
:prepared_at)
|
2587
|
+
SENSITIVE = []
|
2588
|
+
include Aws::Structure
|
2589
|
+
end
|
2590
|
+
|
2591
|
+
# BasePromptConfiguration per Prompt Type.
|
2592
|
+
#
|
2593
|
+
# @!attribute [rw] prompt_type
|
2594
|
+
# Prompt Type.
|
2595
|
+
# @return [String]
|
2596
|
+
#
|
2597
|
+
# @!attribute [rw] prompt_creation_mode
|
2598
|
+
# Creation Mode for Prompt Configuration.
|
2599
|
+
# @return [String]
|
2600
|
+
#
|
2601
|
+
# @!attribute [rw] prompt_state
|
2602
|
+
# Prompt State.
|
2603
|
+
# @return [String]
|
2604
|
+
#
|
2605
|
+
# @!attribute [rw] base_prompt_template
|
2606
|
+
# Base Prompt Template.
|
2607
|
+
# @return [String]
|
2608
|
+
#
|
2609
|
+
# @!attribute [rw] inference_configuration
|
2610
|
+
# Configuration for inference in prompt configuration
|
2611
|
+
# @return [Types::InferenceConfiguration]
|
2612
|
+
#
|
2613
|
+
# @!attribute [rw] parser_mode
|
2614
|
+
# Creation Mode for Prompt Configuration.
|
2615
|
+
# @return [String]
|
2616
|
+
#
|
2617
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptConfiguration AWS API Documentation
|
2618
|
+
#
|
2619
|
+
class PromptConfiguration < Struct.new(
|
2620
|
+
:prompt_type,
|
2621
|
+
:prompt_creation_mode,
|
2622
|
+
:prompt_state,
|
2623
|
+
:base_prompt_template,
|
2624
|
+
:inference_configuration,
|
2625
|
+
:parser_mode)
|
2626
|
+
SENSITIVE = []
|
2627
|
+
include Aws::Structure
|
2628
|
+
end
|
2629
|
+
|
2630
|
+
# Configuration for prompt override.
|
2631
|
+
#
|
2632
|
+
# @!attribute [rw] prompt_configurations
|
2633
|
+
# List of BasePromptConfiguration
|
2634
|
+
# @return [Array<Types::PromptConfiguration>]
|
2635
|
+
#
|
2636
|
+
# @!attribute [rw] override_lambda
|
2637
|
+
# ARN of a Lambda.
|
2638
|
+
# @return [String]
|
2639
|
+
#
|
2640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptOverrideConfiguration AWS API Documentation
|
2641
|
+
#
|
2642
|
+
class PromptOverrideConfiguration < Struct.new(
|
2643
|
+
:prompt_configurations,
|
2644
|
+
:override_lambda)
|
2645
|
+
SENSITIVE = []
|
2646
|
+
include Aws::Structure
|
2647
|
+
end
|
2648
|
+
|
2649
|
+
# Contains the configurations to use Redis Enterprise Cloud to store
|
2650
|
+
# knowledge base data.
|
2651
|
+
#
|
2652
|
+
# @!attribute [rw] endpoint
|
2653
|
+
# Redis enterprise cloud endpoint
|
2654
|
+
# @return [String]
|
2655
|
+
#
|
2656
|
+
# @!attribute [rw] vector_index_name
|
2657
|
+
# Name of a redis enterprise cloud index
|
2658
|
+
# @return [String]
|
2659
|
+
#
|
2660
|
+
# @!attribute [rw] credentials_secret_arn
|
2661
|
+
# Arn of a SecretsManager Secret.
|
2662
|
+
# @return [String]
|
2663
|
+
#
|
2664
|
+
# @!attribute [rw] field_mapping
|
2665
|
+
# A mapping of Bedrock Knowledge Base fields to Redis Cloud field
|
2666
|
+
# names
|
2667
|
+
# @return [Types::RedisEnterpriseCloudFieldMapping]
|
2668
|
+
#
|
2669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedisEnterpriseCloudConfiguration AWS API Documentation
|
2670
|
+
#
|
2671
|
+
class RedisEnterpriseCloudConfiguration < Struct.new(
|
2672
|
+
:endpoint,
|
2673
|
+
:vector_index_name,
|
2674
|
+
:credentials_secret_arn,
|
2675
|
+
:field_mapping)
|
2676
|
+
SENSITIVE = []
|
2677
|
+
include Aws::Structure
|
2678
|
+
end
|
2679
|
+
|
2680
|
+
# A mapping of Bedrock Knowledge Base fields to Redis Cloud field names
|
2681
|
+
#
|
2682
|
+
# @!attribute [rw] vector_field
|
2683
|
+
# Name of the field
|
2684
|
+
# @return [String]
|
2685
|
+
#
|
2686
|
+
# @!attribute [rw] text_field
|
2687
|
+
# Name of the field
|
2688
|
+
# @return [String]
|
2689
|
+
#
|
2690
|
+
# @!attribute [rw] metadata_field
|
2691
|
+
# Name of the field
|
2692
|
+
# @return [String]
|
2693
|
+
#
|
2694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedisEnterpriseCloudFieldMapping AWS API Documentation
|
2695
|
+
#
|
2696
|
+
class RedisEnterpriseCloudFieldMapping < Struct.new(
|
2697
|
+
:vector_field,
|
2698
|
+
:text_field,
|
2699
|
+
:metadata_field)
|
2700
|
+
SENSITIVE = []
|
2701
|
+
include Aws::Structure
|
2702
|
+
end
|
2703
|
+
|
2704
|
+
# This exception is thrown when a resource referenced by the operation
|
2705
|
+
# does not exist
|
2706
|
+
#
|
2707
|
+
# @!attribute [rw] message
|
2708
|
+
# Non Blank String
|
2709
|
+
# @return [String]
|
2710
|
+
#
|
2711
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ResourceNotFoundException AWS API Documentation
|
2712
|
+
#
|
2713
|
+
class ResourceNotFoundException < Struct.new(
|
2714
|
+
:message)
|
2715
|
+
SENSITIVE = []
|
2716
|
+
include Aws::Structure
|
2717
|
+
end
|
2718
|
+
|
2719
|
+
# Configures an S3 data source location.
|
2720
|
+
#
|
2721
|
+
# @!attribute [rw] bucket_arn
|
2722
|
+
# A S3 bucket ARN
|
2723
|
+
# @return [String]
|
2724
|
+
#
|
2725
|
+
# @!attribute [rw] inclusion_prefixes
|
2726
|
+
# A list of S3 prefixes.
|
2727
|
+
# @return [Array<String>]
|
2728
|
+
#
|
2729
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/S3DataSourceConfiguration AWS API Documentation
|
2730
|
+
#
|
2731
|
+
class S3DataSourceConfiguration < Struct.new(
|
2732
|
+
:bucket_arn,
|
2733
|
+
:inclusion_prefixes)
|
2734
|
+
SENSITIVE = []
|
2735
|
+
include Aws::Structure
|
2736
|
+
end
|
2737
|
+
|
2738
|
+
# The identifier for the S3 resource.
|
2739
|
+
#
|
2740
|
+
# @!attribute [rw] s3_bucket_name
|
2741
|
+
# A bucket in S3.
|
2742
|
+
# @return [String]
|
2743
|
+
#
|
2744
|
+
# @!attribute [rw] s3_object_key
|
2745
|
+
# A object key in S3.
|
2746
|
+
# @return [String]
|
2747
|
+
#
|
2748
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/S3Identifier AWS API Documentation
|
2749
|
+
#
|
2750
|
+
class S3Identifier < Struct.new(
|
2751
|
+
:s3_bucket_name,
|
2752
|
+
:s3_object_key)
|
2753
|
+
SENSITIVE = []
|
2754
|
+
include Aws::Structure
|
2755
|
+
end
|
2756
|
+
|
2757
|
+
# Server-side encryption configuration.
|
2758
|
+
#
|
2759
|
+
# @!attribute [rw] kms_key_arn
|
2760
|
+
# A KMS key ARN
|
2761
|
+
# @return [String]
|
2762
|
+
#
|
2763
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ServerSideEncryptionConfiguration AWS API Documentation
|
2764
|
+
#
|
2765
|
+
class ServerSideEncryptionConfiguration < Struct.new(
|
2766
|
+
:kms_key_arn)
|
2767
|
+
SENSITIVE = []
|
2768
|
+
include Aws::Structure
|
2769
|
+
end
|
2770
|
+
|
2771
|
+
# This exception is thrown when a request is made beyond the service
|
2772
|
+
# quota
|
2773
|
+
#
|
2774
|
+
# @!attribute [rw] message
|
2775
|
+
# Non Blank String
|
2776
|
+
# @return [String]
|
2777
|
+
#
|
2778
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ServiceQuotaExceededException AWS API Documentation
|
2779
|
+
#
|
2780
|
+
class ServiceQuotaExceededException < Struct.new(
|
2781
|
+
:message)
|
2782
|
+
SENSITIVE = []
|
2783
|
+
include Aws::Structure
|
2784
|
+
end
|
2785
|
+
|
2786
|
+
# @!attribute [rw] knowledge_base_id
|
2787
|
+
# Identifier for a resource.
|
2788
|
+
# @return [String]
|
2789
|
+
#
|
2790
|
+
# @!attribute [rw] data_source_id
|
2791
|
+
# Identifier for a resource.
|
2792
|
+
# @return [String]
|
2793
|
+
#
|
2794
|
+
# @!attribute [rw] client_token
|
2795
|
+
# Client specified token used for idempotency checks
|
2796
|
+
#
|
2797
|
+
# **A suitable default value is auto-generated.** You should normally
|
2798
|
+
# not need to pass this option.
|
2799
|
+
# @return [String]
|
2800
|
+
#
|
2801
|
+
# @!attribute [rw] description
|
2802
|
+
# Description of the Resource.
|
2803
|
+
# @return [String]
|
2804
|
+
#
|
2805
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StartIngestionJobRequest AWS API Documentation
|
2806
|
+
#
|
2807
|
+
class StartIngestionJobRequest < Struct.new(
|
2808
|
+
:knowledge_base_id,
|
2809
|
+
:data_source_id,
|
2810
|
+
:client_token,
|
2811
|
+
:description)
|
2812
|
+
SENSITIVE = []
|
2813
|
+
include Aws::Structure
|
2814
|
+
end
|
2815
|
+
|
2816
|
+
# @!attribute [rw] ingestion_job
|
2817
|
+
# Contains the information of an ingestion job.
|
2818
|
+
# @return [Types::IngestionJob]
|
2819
|
+
#
|
2820
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StartIngestionJobResponse AWS API Documentation
|
2821
|
+
#
|
2822
|
+
class StartIngestionJobResponse < Struct.new(
|
2823
|
+
:ingestion_job)
|
2824
|
+
SENSITIVE = []
|
2825
|
+
include Aws::Structure
|
2826
|
+
end
|
2827
|
+
|
2828
|
+
# Configures the physical storage of ingested data in a knowledge base.
|
2829
|
+
#
|
2830
|
+
# @!attribute [rw] type
|
2831
|
+
# The storage type of a knowledge base.
|
2832
|
+
# @return [String]
|
2833
|
+
#
|
2834
|
+
# @!attribute [rw] opensearch_serverless_configuration
|
2835
|
+
# Contains the configurations to use OpenSearch Serverless to store
|
2836
|
+
# knowledge base data.
|
2837
|
+
# @return [Types::OpenSearchServerlessConfiguration]
|
2838
|
+
#
|
2839
|
+
# @!attribute [rw] pinecone_configuration
|
2840
|
+
# Contains the configurations to use Pinecone to store knowledge base
|
2841
|
+
# data.
|
2842
|
+
# @return [Types::PineconeConfiguration]
|
2843
|
+
#
|
2844
|
+
# @!attribute [rw] redis_enterprise_cloud_configuration
|
2845
|
+
# Contains the configurations to use Redis Enterprise Cloud to store
|
2846
|
+
# knowledge base data.
|
2847
|
+
# @return [Types::RedisEnterpriseCloudConfiguration]
|
2848
|
+
#
|
2849
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StorageConfiguration AWS API Documentation
|
2850
|
+
#
|
2851
|
+
class StorageConfiguration < Struct.new(
|
2852
|
+
:type,
|
2853
|
+
:opensearch_serverless_configuration,
|
2854
|
+
:pinecone_configuration,
|
2855
|
+
:redis_enterprise_cloud_configuration)
|
2856
|
+
SENSITIVE = []
|
2857
|
+
include Aws::Structure
|
2858
|
+
end
|
2859
|
+
|
2860
|
+
# @!attribute [rw] resource_arn
|
2861
|
+
# ARN of Taggable resources: \[Agent, AgentAlias, Knowledge-Base\]
|
2862
|
+
# @return [String]
|
2863
|
+
#
|
2864
|
+
# @!attribute [rw] tags
|
2865
|
+
# A map of tag keys and values
|
2866
|
+
# @return [Hash<String,String>]
|
2867
|
+
#
|
2868
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/TagResourceRequest AWS API Documentation
|
2869
|
+
#
|
2870
|
+
class TagResourceRequest < Struct.new(
|
2871
|
+
:resource_arn,
|
2872
|
+
:tags)
|
2873
|
+
SENSITIVE = []
|
2874
|
+
include Aws::Structure
|
2875
|
+
end
|
2876
|
+
|
2877
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/TagResourceResponse AWS API Documentation
|
2878
|
+
#
|
2879
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
2880
|
+
|
2881
|
+
# This exception is thrown when the number of requests exceeds the limit
|
2882
|
+
#
|
2883
|
+
# @!attribute [rw] message
|
2884
|
+
# Non Blank String
|
2885
|
+
# @return [String]
|
2886
|
+
#
|
2887
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ThrottlingException AWS API Documentation
|
2888
|
+
#
|
2889
|
+
class ThrottlingException < Struct.new(
|
2890
|
+
:message)
|
2891
|
+
SENSITIVE = []
|
2892
|
+
include Aws::Structure
|
2893
|
+
end
|
2894
|
+
|
2895
|
+
# @!attribute [rw] resource_arn
|
2896
|
+
# ARN of Taggable resources: \[Agent, AgentAlias, Knowledge-Base\]
|
2897
|
+
# @return [String]
|
2898
|
+
#
|
2899
|
+
# @!attribute [rw] tag_keys
|
2900
|
+
# List of Tag Keys
|
2901
|
+
# @return [Array<String>]
|
2902
|
+
#
|
2903
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UntagResourceRequest AWS API Documentation
|
2904
|
+
#
|
2905
|
+
class UntagResourceRequest < Struct.new(
|
2906
|
+
:resource_arn,
|
2907
|
+
:tag_keys)
|
2908
|
+
SENSITIVE = []
|
2909
|
+
include Aws::Structure
|
2910
|
+
end
|
2911
|
+
|
2912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UntagResourceResponse AWS API Documentation
|
2913
|
+
#
|
2914
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
2915
|
+
|
2916
|
+
# Update Action Group Request
|
2917
|
+
#
|
2918
|
+
# @!attribute [rw] agent_id
|
2919
|
+
# Id generated at the server side when an Agent is created
|
2920
|
+
# @return [String]
|
2921
|
+
#
|
2922
|
+
# @!attribute [rw] agent_version
|
2923
|
+
# Draft Version of the Agent.
|
2924
|
+
# @return [String]
|
2925
|
+
#
|
2926
|
+
# @!attribute [rw] action_group_id
|
2927
|
+
# Id generated at the server side when an Action Group is created
|
2928
|
+
# under Agent
|
2929
|
+
# @return [String]
|
2930
|
+
#
|
2931
|
+
# @!attribute [rw] action_group_name
|
2932
|
+
# Name for a resource.
|
2933
|
+
# @return [String]
|
2934
|
+
#
|
2935
|
+
# @!attribute [rw] description
|
2936
|
+
# Description of the Resource.
|
2937
|
+
# @return [String]
|
2938
|
+
#
|
2939
|
+
# @!attribute [rw] parent_action_group_signature
|
2940
|
+
# Action Group Signature for a BuiltIn Action
|
2941
|
+
# @return [String]
|
2942
|
+
#
|
2943
|
+
# @!attribute [rw] action_group_executor
|
2944
|
+
# Type of Executors for an Action Group
|
2945
|
+
# @return [Types::ActionGroupExecutor]
|
2946
|
+
#
|
2947
|
+
# @!attribute [rw] action_group_state
|
2948
|
+
# State of the action group
|
2949
|
+
# @return [String]
|
2950
|
+
#
|
2951
|
+
# @!attribute [rw] api_schema
|
2952
|
+
# Contains information about the API Schema for the Action Group
|
2953
|
+
# @return [Types::APISchema]
|
2954
|
+
#
|
2955
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentActionGroupRequest AWS API Documentation
|
2956
|
+
#
|
2957
|
+
class UpdateAgentActionGroupRequest < Struct.new(
|
2958
|
+
:agent_id,
|
2959
|
+
:agent_version,
|
2960
|
+
:action_group_id,
|
2961
|
+
:action_group_name,
|
2962
|
+
:description,
|
2963
|
+
:parent_action_group_signature,
|
2964
|
+
:action_group_executor,
|
2965
|
+
:action_group_state,
|
2966
|
+
:api_schema)
|
2967
|
+
SENSITIVE = []
|
2968
|
+
include Aws::Structure
|
2969
|
+
end
|
2970
|
+
|
2971
|
+
# Update Action Group Response
|
2972
|
+
#
|
2973
|
+
# @!attribute [rw] agent_action_group
|
2974
|
+
# Contains the information of an Agent Action Group
|
2975
|
+
# @return [Types::AgentActionGroup]
|
2976
|
+
#
|
2977
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentActionGroupResponse AWS API Documentation
|
2978
|
+
#
|
2979
|
+
class UpdateAgentActionGroupResponse < Struct.new(
|
2980
|
+
:agent_action_group)
|
2981
|
+
SENSITIVE = []
|
2982
|
+
include Aws::Structure
|
2983
|
+
end
|
2984
|
+
|
2985
|
+
# Update Agent Alias Request
|
2986
|
+
#
|
2987
|
+
# @!attribute [rw] agent_id
|
2988
|
+
# Id generated at the server side when an Agent is created
|
2989
|
+
# @return [String]
|
2990
|
+
#
|
2991
|
+
# @!attribute [rw] agent_alias_id
|
2992
|
+
# Id generated at the server side when an Agent Alias is created
|
2993
|
+
# @return [String]
|
2994
|
+
#
|
2995
|
+
# @!attribute [rw] agent_alias_name
|
2996
|
+
# Name for a resource.
|
2997
|
+
# @return [String]
|
2998
|
+
#
|
2999
|
+
# @!attribute [rw] description
|
3000
|
+
# Description of the Resource.
|
3001
|
+
# @return [String]
|
3002
|
+
#
|
3003
|
+
# @!attribute [rw] routing_configuration
|
3004
|
+
# Routing configuration for an Agent alias.
|
3005
|
+
# @return [Array<Types::AgentAliasRoutingConfigurationListItem>]
|
3006
|
+
#
|
3007
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentAliasRequest AWS API Documentation
|
3008
|
+
#
|
3009
|
+
class UpdateAgentAliasRequest < Struct.new(
|
3010
|
+
:agent_id,
|
3011
|
+
:agent_alias_id,
|
3012
|
+
:agent_alias_name,
|
3013
|
+
:description,
|
3014
|
+
:routing_configuration)
|
3015
|
+
SENSITIVE = []
|
3016
|
+
include Aws::Structure
|
3017
|
+
end
|
3018
|
+
|
3019
|
+
# Update Agent Alias Response
|
3020
|
+
#
|
3021
|
+
# @!attribute [rw] agent_alias
|
3022
|
+
# Contains the information of an agent alias
|
3023
|
+
# @return [Types::AgentAlias]
|
3024
|
+
#
|
3025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentAliasResponse AWS API Documentation
|
3026
|
+
#
|
3027
|
+
class UpdateAgentAliasResponse < Struct.new(
|
3028
|
+
:agent_alias)
|
3029
|
+
SENSITIVE = []
|
3030
|
+
include Aws::Structure
|
3031
|
+
end
|
3032
|
+
|
3033
|
+
# Update Agent Knowledge Base Request
|
3034
|
+
#
|
3035
|
+
# @!attribute [rw] agent_id
|
3036
|
+
# Id generated at the server side when an Agent is created
|
3037
|
+
# @return [String]
|
3038
|
+
#
|
3039
|
+
# @!attribute [rw] agent_version
|
3040
|
+
# Draft Version of the Agent.
|
3041
|
+
# @return [String]
|
3042
|
+
#
|
3043
|
+
# @!attribute [rw] knowledge_base_id
|
3044
|
+
# Id generated at the server side when a Knowledge Base is associated
|
3045
|
+
# to an Agent
|
3046
|
+
# @return [String]
|
3047
|
+
#
|
3048
|
+
# @!attribute [rw] description
|
3049
|
+
# Description of the Resource.
|
3050
|
+
# @return [String]
|
3051
|
+
#
|
3052
|
+
# @!attribute [rw] knowledge_base_state
|
3053
|
+
# State of the knowledge base; whether it is enabled or disabled
|
3054
|
+
# @return [String]
|
3055
|
+
#
|
3056
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBaseRequest AWS API Documentation
|
3057
|
+
#
|
3058
|
+
class UpdateAgentKnowledgeBaseRequest < Struct.new(
|
3059
|
+
:agent_id,
|
3060
|
+
:agent_version,
|
3061
|
+
:knowledge_base_id,
|
3062
|
+
:description,
|
3063
|
+
:knowledge_base_state)
|
3064
|
+
SENSITIVE = []
|
3065
|
+
include Aws::Structure
|
3066
|
+
end
|
3067
|
+
|
3068
|
+
# Update Agent Knowledge Base Response
|
3069
|
+
#
|
3070
|
+
# @!attribute [rw] agent_knowledge_base
|
3071
|
+
# Contains the information of an Agent Knowledge Base.
|
3072
|
+
# @return [Types::AgentKnowledgeBase]
|
3073
|
+
#
|
3074
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBaseResponse AWS API Documentation
|
3075
|
+
#
|
3076
|
+
class UpdateAgentKnowledgeBaseResponse < Struct.new(
|
3077
|
+
:agent_knowledge_base)
|
3078
|
+
SENSITIVE = []
|
3079
|
+
include Aws::Structure
|
3080
|
+
end
|
3081
|
+
|
3082
|
+
# Update Agent Request
|
3083
|
+
#
|
3084
|
+
# @!attribute [rw] agent_id
|
3085
|
+
# Id generated at the server side when an Agent is created
|
3086
|
+
# @return [String]
|
3087
|
+
#
|
3088
|
+
# @!attribute [rw] agent_name
|
3089
|
+
# Name for a resource.
|
3090
|
+
# @return [String]
|
3091
|
+
#
|
3092
|
+
# @!attribute [rw] instruction
|
3093
|
+
# Instruction for the agent.
|
3094
|
+
# @return [String]
|
3095
|
+
#
|
3096
|
+
# @!attribute [rw] foundation_model
|
3097
|
+
# ARN or name of a Bedrock model.
|
3098
|
+
# @return [String]
|
3099
|
+
#
|
3100
|
+
# @!attribute [rw] description
|
3101
|
+
# Description of the Resource.
|
3102
|
+
# @return [String]
|
3103
|
+
#
|
3104
|
+
# @!attribute [rw] idle_session_ttl_in_seconds
|
3105
|
+
# Max Session Time.
|
3106
|
+
# @return [Integer]
|
3107
|
+
#
|
3108
|
+
# @!attribute [rw] agent_resource_role_arn
|
3109
|
+
# ARN of a IAM role.
|
3110
|
+
# @return [String]
|
3111
|
+
#
|
3112
|
+
# @!attribute [rw] customer_encryption_key_arn
|
3113
|
+
# A KMS key ARN
|
3114
|
+
# @return [String]
|
3115
|
+
#
|
3116
|
+
# @!attribute [rw] prompt_override_configuration
|
3117
|
+
# Configuration for prompt override.
|
3118
|
+
# @return [Types::PromptOverrideConfiguration]
|
3119
|
+
#
|
3120
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentRequest AWS API Documentation
|
3121
|
+
#
|
3122
|
+
class UpdateAgentRequest < Struct.new(
|
3123
|
+
:agent_id,
|
3124
|
+
:agent_name,
|
3125
|
+
:instruction,
|
3126
|
+
:foundation_model,
|
3127
|
+
:description,
|
3128
|
+
:idle_session_ttl_in_seconds,
|
3129
|
+
:agent_resource_role_arn,
|
3130
|
+
:customer_encryption_key_arn,
|
3131
|
+
:prompt_override_configuration)
|
3132
|
+
SENSITIVE = [:instruction, :prompt_override_configuration]
|
3133
|
+
include Aws::Structure
|
3134
|
+
end
|
3135
|
+
|
3136
|
+
# Update Agent Response
|
3137
|
+
#
|
3138
|
+
# @!attribute [rw] agent
|
3139
|
+
# Contains the information of an agent
|
3140
|
+
# @return [Types::Agent]
|
3141
|
+
#
|
3142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentResponse AWS API Documentation
|
3143
|
+
#
|
3144
|
+
class UpdateAgentResponse < Struct.new(
|
3145
|
+
:agent)
|
3146
|
+
SENSITIVE = []
|
3147
|
+
include Aws::Structure
|
3148
|
+
end
|
3149
|
+
|
3150
|
+
# @!attribute [rw] knowledge_base_id
|
3151
|
+
# Identifier for a resource.
|
3152
|
+
# @return [String]
|
3153
|
+
#
|
3154
|
+
# @!attribute [rw] data_source_id
|
3155
|
+
# Identifier for a resource.
|
3156
|
+
# @return [String]
|
3157
|
+
#
|
3158
|
+
# @!attribute [rw] name
|
3159
|
+
# Name for a resource.
|
3160
|
+
# @return [String]
|
3161
|
+
#
|
3162
|
+
# @!attribute [rw] description
|
3163
|
+
# Description of the Resource.
|
3164
|
+
# @return [String]
|
3165
|
+
#
|
3166
|
+
# @!attribute [rw] data_source_configuration
|
3167
|
+
# Specifies a raw data source location to ingest.
|
3168
|
+
# @return [Types::DataSourceConfiguration]
|
3169
|
+
#
|
3170
|
+
# @!attribute [rw] server_side_encryption_configuration
|
3171
|
+
# Server-side encryption configuration.
|
3172
|
+
# @return [Types::ServerSideEncryptionConfiguration]
|
3173
|
+
#
|
3174
|
+
# @!attribute [rw] vector_ingestion_configuration
|
3175
|
+
# Configures ingestion for a vector knowledge base
|
3176
|
+
# @return [Types::VectorIngestionConfiguration]
|
3177
|
+
#
|
3178
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateDataSourceRequest AWS API Documentation
|
3179
|
+
#
|
3180
|
+
class UpdateDataSourceRequest < Struct.new(
|
3181
|
+
:knowledge_base_id,
|
3182
|
+
:data_source_id,
|
3183
|
+
:name,
|
3184
|
+
:description,
|
3185
|
+
:data_source_configuration,
|
3186
|
+
:server_side_encryption_configuration,
|
3187
|
+
:vector_ingestion_configuration)
|
3188
|
+
SENSITIVE = []
|
3189
|
+
include Aws::Structure
|
3190
|
+
end
|
3191
|
+
|
3192
|
+
# @!attribute [rw] data_source
|
3193
|
+
# Contains the information of a data source.
|
3194
|
+
# @return [Types::DataSource]
|
3195
|
+
#
|
3196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateDataSourceResponse AWS API Documentation
|
3197
|
+
#
|
3198
|
+
class UpdateDataSourceResponse < Struct.new(
|
3199
|
+
:data_source)
|
3200
|
+
SENSITIVE = []
|
3201
|
+
include Aws::Structure
|
3202
|
+
end
|
3203
|
+
|
3204
|
+
# @!attribute [rw] knowledge_base_id
|
3205
|
+
# Identifier for a resource.
|
3206
|
+
# @return [String]
|
3207
|
+
#
|
3208
|
+
# @!attribute [rw] name
|
3209
|
+
# Name for a resource.
|
3210
|
+
# @return [String]
|
3211
|
+
#
|
3212
|
+
# @!attribute [rw] description
|
3213
|
+
# Description of the Resource.
|
3214
|
+
# @return [String]
|
3215
|
+
#
|
3216
|
+
# @!attribute [rw] role_arn
|
3217
|
+
# ARN of a IAM role.
|
3218
|
+
# @return [String]
|
3219
|
+
#
|
3220
|
+
# @!attribute [rw] knowledge_base_configuration
|
3221
|
+
# Configures a bedrock knowledge base.
|
3222
|
+
# @return [Types::KnowledgeBaseConfiguration]
|
3223
|
+
#
|
3224
|
+
# @!attribute [rw] storage_configuration
|
3225
|
+
# Configures the physical storage of ingested data in a knowledge
|
3226
|
+
# base.
|
3227
|
+
# @return [Types::StorageConfiguration]
|
3228
|
+
#
|
3229
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateKnowledgeBaseRequest AWS API Documentation
|
3230
|
+
#
|
3231
|
+
class UpdateKnowledgeBaseRequest < Struct.new(
|
3232
|
+
:knowledge_base_id,
|
3233
|
+
:name,
|
3234
|
+
:description,
|
3235
|
+
:role_arn,
|
3236
|
+
:knowledge_base_configuration,
|
3237
|
+
:storage_configuration)
|
3238
|
+
SENSITIVE = []
|
3239
|
+
include Aws::Structure
|
3240
|
+
end
|
3241
|
+
|
3242
|
+
# @!attribute [rw] knowledge_base
|
3243
|
+
# Contains the information of a knowledge base.
|
3244
|
+
# @return [Types::KnowledgeBase]
|
3245
|
+
#
|
3246
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateKnowledgeBaseResponse AWS API Documentation
|
3247
|
+
#
|
3248
|
+
class UpdateKnowledgeBaseResponse < Struct.new(
|
3249
|
+
:knowledge_base)
|
3250
|
+
SENSITIVE = []
|
3251
|
+
include Aws::Structure
|
3252
|
+
end
|
3253
|
+
|
3254
|
+
# This exception is thrown when the request's input validation fails
|
3255
|
+
#
|
3256
|
+
# @!attribute [rw] message
|
3257
|
+
# Non Blank String
|
3258
|
+
# @return [String]
|
3259
|
+
#
|
3260
|
+
# @!attribute [rw] field_list
|
3261
|
+
# list of ValidationExceptionField
|
3262
|
+
# @return [Array<Types::ValidationExceptionField>]
|
3263
|
+
#
|
3264
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ValidationException AWS API Documentation
|
3265
|
+
#
|
3266
|
+
class ValidationException < Struct.new(
|
3267
|
+
:message,
|
3268
|
+
:field_list)
|
3269
|
+
SENSITIVE = []
|
3270
|
+
include Aws::Structure
|
3271
|
+
end
|
3272
|
+
|
3273
|
+
# Stores information about a field passed inside a request that resulted
|
3274
|
+
# in an exception
|
3275
|
+
#
|
3276
|
+
# @!attribute [rw] name
|
3277
|
+
# Non Blank String
|
3278
|
+
# @return [String]
|
3279
|
+
#
|
3280
|
+
# @!attribute [rw] message
|
3281
|
+
# Non Blank String
|
3282
|
+
# @return [String]
|
3283
|
+
#
|
3284
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ValidationExceptionField AWS API Documentation
|
3285
|
+
#
|
3286
|
+
class ValidationExceptionField < Struct.new(
|
3287
|
+
:name,
|
3288
|
+
:message)
|
3289
|
+
SENSITIVE = []
|
3290
|
+
include Aws::Structure
|
3291
|
+
end
|
3292
|
+
|
3293
|
+
# Configures ingestion for a vector knowledge base
|
3294
|
+
#
|
3295
|
+
# @!attribute [rw] chunking_configuration
|
3296
|
+
# Configures chunking strategy
|
3297
|
+
# @return [Types::ChunkingConfiguration]
|
3298
|
+
#
|
3299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorIngestionConfiguration AWS API Documentation
|
3300
|
+
#
|
3301
|
+
class VectorIngestionConfiguration < Struct.new(
|
3302
|
+
:chunking_configuration)
|
3303
|
+
SENSITIVE = []
|
3304
|
+
include Aws::Structure
|
3305
|
+
end
|
3306
|
+
|
3307
|
+
# Configurations for a vector knowledge base.
|
3308
|
+
#
|
3309
|
+
# @!attribute [rw] embedding_model_arn
|
3310
|
+
# Arn of a Bedrock model.
|
3311
|
+
# @return [String]
|
3312
|
+
#
|
3313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorKnowledgeBaseConfiguration AWS API Documentation
|
3314
|
+
#
|
3315
|
+
class VectorKnowledgeBaseConfiguration < Struct.new(
|
3316
|
+
:embedding_model_arn)
|
3317
|
+
SENSITIVE = []
|
3318
|
+
include Aws::Structure
|
3319
|
+
end
|
3320
|
+
|
3321
|
+
end
|
3322
|
+
end
|