aws-sdk-bedrockagent 1.3.0 → 1.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockagent/client.rb +1004 -648
- data/lib/aws-sdk-bedrockagent/client_api.rb +142 -140
- data/lib/aws-sdk-bedrockagent/errors.rb +4 -4
- data/lib/aws-sdk-bedrockagent/types.rb +1605 -1079
- data/lib/aws-sdk-bedrockagent.rb +1 -1
- data/sig/client.rbs +137 -137
- data/sig/errors.rbs +1 -1
- data/sig/types.rbs +143 -141
- metadata +2 -2
@@ -10,40 +10,58 @@
|
|
10
10
|
module Aws::BedrockAgent
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# Contains
|
13
|
+
# Contains details about the OpenAPI schema for the action group. For
|
14
|
+
# more information, see [Action group OpenAPI schemas][1]. You can
|
15
|
+
# either include the schema directly in the `payload` field or you can
|
16
|
+
# upload it to an S3 bucket and specify the S3 bucket location in the
|
17
|
+
# `s3` field.
|
18
|
+
#
|
19
|
+
#
|
20
|
+
#
|
21
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html
|
14
22
|
#
|
15
23
|
# @note APISchema is a union - when making an API calls you must set exactly one of the members.
|
16
24
|
#
|
17
25
|
# @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
26
|
#
|
19
|
-
# @!attribute [rw] s3
|
20
|
-
# The identifier for the S3 resource.
|
21
|
-
# @return [Types::S3Identifier]
|
22
|
-
#
|
23
27
|
# @!attribute [rw] payload
|
24
|
-
#
|
28
|
+
# The JSON or YAML-formatted payload defining the OpenAPI schema for
|
29
|
+
# the action group. For more information, see [Action group OpenAPI
|
30
|
+
# schemas][1].
|
31
|
+
#
|
32
|
+
#
|
33
|
+
#
|
34
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html
|
25
35
|
# @return [String]
|
26
36
|
#
|
37
|
+
# @!attribute [rw] s3
|
38
|
+
# Contains details about the S3 object containing the OpenAPI schema
|
39
|
+
# for the action group. For more information, see [Action group
|
40
|
+
# OpenAPI schemas][1].
|
41
|
+
#
|
42
|
+
#
|
43
|
+
#
|
44
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html
|
45
|
+
# @return [Types::S3Identifier]
|
46
|
+
#
|
27
47
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/APISchema AWS API Documentation
|
28
48
|
#
|
29
49
|
class APISchema < Struct.new(
|
30
|
-
:s3,
|
31
50
|
:payload,
|
51
|
+
:s3,
|
32
52
|
:unknown)
|
33
53
|
SENSITIVE = [:payload]
|
34
54
|
include Aws::Structure
|
35
55
|
include Aws::Structure::Union
|
36
56
|
|
37
|
-
class S3 < APISchema; end
|
38
57
|
class Payload < APISchema; end
|
58
|
+
class S3 < APISchema; end
|
39
59
|
class Unknown < APISchema; end
|
40
60
|
end
|
41
61
|
|
42
|
-
#
|
43
|
-
# permissions
|
62
|
+
# The request is denied because of missing access permissions.
|
44
63
|
#
|
45
64
|
# @!attribute [rw] message
|
46
|
-
# Non Blank String
|
47
65
|
# @return [String]
|
48
66
|
#
|
49
67
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AccessDeniedException AWS API Documentation
|
@@ -54,14 +72,16 @@ module Aws::BedrockAgent
|
|
54
72
|
include Aws::Structure
|
55
73
|
end
|
56
74
|
|
57
|
-
#
|
75
|
+
# Contains details about the Lambda function containing the business
|
76
|
+
# logic that is carried out upon invoking the action.
|
58
77
|
#
|
59
78
|
# @note ActionGroupExecutor is a union - when making an API calls you must set exactly one of the members.
|
60
79
|
#
|
61
80
|
# @note ActionGroupExecutor is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ActionGroupExecutor corresponding to the set member.
|
62
81
|
#
|
63
82
|
# @!attribute [rw] lambda
|
64
|
-
# ARN of
|
83
|
+
# The Amazon Resource Name (ARN) of the Lambda function containing the
|
84
|
+
# business logic that is carried out upon invoking the action.
|
65
85
|
# @return [String]
|
66
86
|
#
|
67
87
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ActionGroupExecutor AWS API Documentation
|
@@ -77,26 +97,31 @@ module Aws::BedrockAgent
|
|
77
97
|
class Unknown < ActionGroupExecutor; end
|
78
98
|
end
|
79
99
|
|
80
|
-
#
|
100
|
+
# Contains details about an action group.
|
81
101
|
#
|
82
102
|
# @!attribute [rw] action_group_id
|
83
|
-
#
|
103
|
+
# The unique identifier of the action group.
|
84
104
|
# @return [String]
|
85
105
|
#
|
86
106
|
# @!attribute [rw] action_group_name
|
87
|
-
#
|
107
|
+
# The name of the action group.
|
88
108
|
# @return [String]
|
89
109
|
#
|
90
110
|
# @!attribute [rw] action_group_state
|
91
|
-
#
|
111
|
+
# Specifies whether the action group is available for the agent to
|
112
|
+
# invoke or not when sending an [InvokeAgent][1] request.
|
113
|
+
#
|
114
|
+
#
|
115
|
+
#
|
116
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
|
92
117
|
# @return [String]
|
93
118
|
#
|
94
119
|
# @!attribute [rw] description
|
95
|
-
#
|
120
|
+
# The description of the action group.
|
96
121
|
# @return [String]
|
97
122
|
#
|
98
123
|
# @!attribute [rw] updated_at
|
99
|
-
#
|
124
|
+
# The time at which the action group was last updated.
|
100
125
|
# @return [Time]
|
101
126
|
#
|
102
127
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ActionGroupSummary AWS API Documentation
|
@@ -111,267 +136,359 @@ module Aws::BedrockAgent
|
|
111
136
|
include Aws::Structure
|
112
137
|
end
|
113
138
|
|
114
|
-
# Contains
|
139
|
+
# Contains details about an agent.
|
140
|
+
#
|
141
|
+
# @!attribute [rw] agent_arn
|
142
|
+
# The Amazon Resource Name (ARN) of the agent.
|
143
|
+
# @return [String]
|
115
144
|
#
|
116
145
|
# @!attribute [rw] agent_id
|
117
|
-
#
|
146
|
+
# The unique identifier of the agent.
|
118
147
|
# @return [String]
|
119
148
|
#
|
120
149
|
# @!attribute [rw] agent_name
|
121
|
-
#
|
150
|
+
# The name of the agent.
|
122
151
|
# @return [String]
|
123
152
|
#
|
124
|
-
# @!attribute [rw]
|
125
|
-
#
|
153
|
+
# @!attribute [rw] agent_resource_role_arn
|
154
|
+
# The Amazon Resource Name (ARN) of the IAM role with permissions to
|
155
|
+
# invoke API operations on the agent.
|
156
|
+
# @return [String]
|
157
|
+
#
|
158
|
+
# @!attribute [rw] agent_status
|
159
|
+
# The status of the agent and whether it is ready for use. The
|
160
|
+
# following statuses are possible:
|
161
|
+
#
|
162
|
+
# * CREATING – The agent is being created.
|
163
|
+
#
|
164
|
+
# * PREPARING – The agent is being prepared.
|
165
|
+
#
|
166
|
+
# * PREPARED – The agent is prepared and ready to be invoked.
|
167
|
+
#
|
168
|
+
# * NOT\_PREPARED – The agent has been created but not yet prepared.
|
169
|
+
#
|
170
|
+
# * FAILED – The agent API operation failed.
|
171
|
+
#
|
172
|
+
# * UPDATING – The agent is being updated.
|
173
|
+
#
|
174
|
+
# * DELETING – The agent is being deleted.
|
126
175
|
# @return [String]
|
127
176
|
#
|
128
177
|
# @!attribute [rw] agent_version
|
129
|
-
#
|
178
|
+
# The version of the agent.
|
130
179
|
# @return [String]
|
131
180
|
#
|
132
181
|
# @!attribute [rw] client_token
|
133
|
-
#
|
134
|
-
#
|
182
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
183
|
+
# completes no more than one time. If this token matches a previous
|
184
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
185
|
+
# error. For more information, see [Ensuring idempotency][1].
|
135
186
|
#
|
136
|
-
# @!attribute [rw] instruction
|
137
|
-
# Instruction for the agent.
|
138
|
-
# @return [String]
|
139
187
|
#
|
140
|
-
#
|
141
|
-
#
|
188
|
+
#
|
189
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
142
190
|
# @return [String]
|
143
191
|
#
|
144
|
-
# @!attribute [rw]
|
145
|
-
#
|
192
|
+
# @!attribute [rw] created_at
|
193
|
+
# The time at which the agent was created.
|
194
|
+
# @return [Time]
|
195
|
+
#
|
196
|
+
# @!attribute [rw] customer_encryption_key_arn
|
197
|
+
# The Amazon Resource Name (ARN) of the KMS key that encrypts the
|
198
|
+
# agent.
|
146
199
|
# @return [String]
|
147
200
|
#
|
148
201
|
# @!attribute [rw] description
|
149
|
-
#
|
202
|
+
# The description of the agent.
|
150
203
|
# @return [String]
|
151
204
|
#
|
152
|
-
# @!attribute [rw]
|
153
|
-
#
|
154
|
-
# @return [
|
205
|
+
# @!attribute [rw] failure_reasons
|
206
|
+
# Contains reasons that the agent-related API that you invoked failed.
|
207
|
+
# @return [Array<String>]
|
155
208
|
#
|
156
|
-
# @!attribute [rw]
|
157
|
-
#
|
209
|
+
# @!attribute [rw] foundation_model
|
210
|
+
# The foundation model used for orchestration by the agent.
|
158
211
|
# @return [String]
|
159
212
|
#
|
160
|
-
# @!attribute [rw]
|
161
|
-
#
|
162
|
-
#
|
213
|
+
# @!attribute [rw] idle_session_ttl_in_seconds
|
214
|
+
# The number of seconds for which Amazon Bedrock keeps information
|
215
|
+
# about a user's conversation with the agent.
|
163
216
|
#
|
164
|
-
#
|
165
|
-
#
|
166
|
-
#
|
217
|
+
# A user interaction remains active for the amount of time specified.
|
218
|
+
# If no conversation occurs during this time, the session expires and
|
219
|
+
# Amazon Bedrock deletes any data provided before the timeout.
|
220
|
+
# @return [Integer]
|
167
221
|
#
|
168
|
-
# @!attribute [rw]
|
169
|
-
#
|
170
|
-
#
|
222
|
+
# @!attribute [rw] instruction
|
223
|
+
# Instructions that tell the agent what it should do and how it should
|
224
|
+
# interact with users.
|
225
|
+
# @return [String]
|
171
226
|
#
|
172
227
|
# @!attribute [rw] prepared_at
|
173
|
-
#
|
228
|
+
# The time at which the agent was last prepared.
|
174
229
|
# @return [Time]
|
175
230
|
#
|
176
|
-
# @!attribute [rw]
|
177
|
-
#
|
178
|
-
#
|
231
|
+
# @!attribute [rw] prompt_override_configuration
|
232
|
+
# Contains configurations to override prompt templates in different
|
233
|
+
# parts of an agent sequence. For more information, see [Advanced
|
234
|
+
# prompts][1].
|
235
|
+
#
|
236
|
+
#
|
237
|
+
#
|
238
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
|
239
|
+
# @return [Types::PromptOverrideConfiguration]
|
179
240
|
#
|
180
241
|
# @!attribute [rw] recommended_actions
|
181
|
-
#
|
182
|
-
#
|
242
|
+
# Contains recommended actions to take for the agent-related API that
|
243
|
+
# you invoked to succeed.
|
183
244
|
# @return [Array<String>]
|
184
245
|
#
|
185
|
-
# @!attribute [rw]
|
186
|
-
#
|
187
|
-
# @return [
|
246
|
+
# @!attribute [rw] updated_at
|
247
|
+
# The time at which the agent was last updated.
|
248
|
+
# @return [Time]
|
188
249
|
#
|
189
250
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/Agent AWS API Documentation
|
190
251
|
#
|
191
252
|
class Agent < Struct.new(
|
253
|
+
:agent_arn,
|
192
254
|
:agent_id,
|
193
255
|
:agent_name,
|
194
|
-
:
|
256
|
+
:agent_resource_role_arn,
|
257
|
+
:agent_status,
|
195
258
|
:agent_version,
|
196
259
|
:client_token,
|
197
|
-
:
|
198
|
-
:
|
199
|
-
:foundation_model,
|
260
|
+
:created_at,
|
261
|
+
:customer_encryption_key_arn,
|
200
262
|
:description,
|
263
|
+
:failure_reasons,
|
264
|
+
:foundation_model,
|
201
265
|
:idle_session_ttl_in_seconds,
|
202
|
-
:
|
203
|
-
:customer_encryption_key_arn,
|
204
|
-
:created_at,
|
205
|
-
:updated_at,
|
266
|
+
:instruction,
|
206
267
|
:prepared_at,
|
207
|
-
:
|
268
|
+
:prompt_override_configuration,
|
208
269
|
:recommended_actions,
|
209
|
-
:
|
270
|
+
:updated_at)
|
210
271
|
SENSITIVE = [:instruction, :prompt_override_configuration]
|
211
272
|
include Aws::Structure
|
212
273
|
end
|
213
274
|
|
214
|
-
# Contains
|
275
|
+
# Contains details about an action group.
|
215
276
|
#
|
216
|
-
# @!attribute [rw]
|
217
|
-
#
|
277
|
+
# @!attribute [rw] action_group_executor
|
278
|
+
# The Amazon Resource Name (ARN) of the Lambda function containing the
|
279
|
+
# business logic that is carried out upon invoking the action.
|
280
|
+
# @return [Types::ActionGroupExecutor]
|
281
|
+
#
|
282
|
+
# @!attribute [rw] action_group_id
|
283
|
+
# The unique identifier of the action group.
|
218
284
|
# @return [String]
|
219
285
|
#
|
220
|
-
# @!attribute [rw]
|
221
|
-
#
|
286
|
+
# @!attribute [rw] action_group_name
|
287
|
+
# The name of the action group.
|
222
288
|
# @return [String]
|
223
289
|
#
|
224
|
-
# @!attribute [rw]
|
225
|
-
#
|
290
|
+
# @!attribute [rw] action_group_state
|
291
|
+
# Specifies whether the action group is available for the agent to
|
292
|
+
# invoke or not when sending an [InvokeAgent][1] request.
|
293
|
+
#
|
294
|
+
#
|
295
|
+
#
|
296
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
|
226
297
|
# @return [String]
|
227
298
|
#
|
228
|
-
# @!attribute [rw]
|
229
|
-
#
|
299
|
+
# @!attribute [rw] agent_id
|
300
|
+
# The unique identifier of the agent to which the action group
|
301
|
+
# belongs.
|
230
302
|
# @return [String]
|
231
303
|
#
|
232
|
-
# @!attribute [rw]
|
233
|
-
#
|
304
|
+
# @!attribute [rw] agent_version
|
305
|
+
# The version of the agent to which the action group belongs.
|
234
306
|
# @return [String]
|
235
307
|
#
|
236
|
-
# @!attribute [rw]
|
237
|
-
#
|
308
|
+
# @!attribute [rw] api_schema
|
309
|
+
# Contains either details about the S3 object containing the OpenAPI
|
310
|
+
# schema for the action group or the JSON or YAML-formatted payload
|
311
|
+
# defining the schema. For more information, see [Action group OpenAPI
|
312
|
+
# schemas][1].
|
313
|
+
#
|
314
|
+
#
|
315
|
+
#
|
316
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html
|
317
|
+
# @return [Types::APISchema]
|
318
|
+
#
|
319
|
+
# @!attribute [rw] client_token
|
320
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
321
|
+
# completes no more than one time. If this token matches a previous
|
322
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
323
|
+
# error. For more information, see [Ensuring idempotency][1].
|
324
|
+
#
|
325
|
+
#
|
326
|
+
#
|
327
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
238
328
|
# @return [String]
|
239
329
|
#
|
240
330
|
# @!attribute [rw] created_at
|
241
|
-
#
|
331
|
+
# The time at which the action group was created.
|
242
332
|
# @return [Time]
|
243
333
|
#
|
244
|
-
# @!attribute [rw]
|
245
|
-
#
|
246
|
-
# @return [
|
334
|
+
# @!attribute [rw] description
|
335
|
+
# The description of the action group.
|
336
|
+
# @return [String]
|
247
337
|
#
|
248
338
|
# @!attribute [rw] parent_action_signature
|
249
|
-
#
|
250
|
-
#
|
339
|
+
# If this field is set as `AMAZON.UserInput`, the agent can request
|
340
|
+
# the user for additional information when trying to complete a task.
|
341
|
+
# The `description`, `apiSchema`, and `actionGroupExecutor` fields
|
342
|
+
# must be blank for this action group.
|
251
343
|
#
|
252
|
-
#
|
253
|
-
#
|
254
|
-
#
|
344
|
+
# During orchestration, if the agent determines that it needs to
|
345
|
+
# invoke an API in an action group, but doesn't have enough
|
346
|
+
# information to complete the API request, it will invoke this action
|
347
|
+
# group instead and return an [Observation][1] reprompting the user
|
348
|
+
# for more information.
|
255
349
|
#
|
256
|
-
# @!attribute [rw] api_schema
|
257
|
-
# Contains information about the API Schema for the Action Group
|
258
|
-
# @return [Types::APISchema]
|
259
350
|
#
|
260
|
-
#
|
261
|
-
#
|
351
|
+
#
|
352
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html
|
262
353
|
# @return [String]
|
263
354
|
#
|
355
|
+
# @!attribute [rw] updated_at
|
356
|
+
# The time at which the action group was last updated.
|
357
|
+
# @return [Time]
|
358
|
+
#
|
264
359
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentActionGroup AWS API Documentation
|
265
360
|
#
|
266
361
|
class AgentActionGroup < Struct.new(
|
267
|
-
:
|
268
|
-
:agent_version,
|
362
|
+
:action_group_executor,
|
269
363
|
:action_group_id,
|
270
364
|
:action_group_name,
|
365
|
+
:action_group_state,
|
366
|
+
:agent_id,
|
367
|
+
:agent_version,
|
368
|
+
:api_schema,
|
271
369
|
:client_token,
|
272
|
-
:description,
|
273
370
|
:created_at,
|
274
|
-
:
|
371
|
+
:description,
|
275
372
|
:parent_action_signature,
|
276
|
-
:
|
277
|
-
:api_schema,
|
278
|
-
:action_group_state)
|
373
|
+
:updated_at)
|
279
374
|
SENSITIVE = []
|
280
375
|
include Aws::Structure
|
281
376
|
end
|
282
377
|
|
283
|
-
# Contains
|
378
|
+
# Contains details about an alias of an agent.
|
284
379
|
#
|
285
|
-
# @!attribute [rw]
|
286
|
-
#
|
380
|
+
# @!attribute [rw] agent_alias_arn
|
381
|
+
# The Amazon Resource Name (ARN) of the alias of the agent.
|
287
382
|
# @return [String]
|
288
383
|
#
|
384
|
+
# @!attribute [rw] agent_alias_history_events
|
385
|
+
# Contains details about the history of the alias.
|
386
|
+
# @return [Array<Types::AgentAliasHistoryEvent>]
|
387
|
+
#
|
289
388
|
# @!attribute [rw] agent_alias_id
|
290
|
-
#
|
389
|
+
# The unique identifier of the alias of the agent.
|
291
390
|
# @return [String]
|
292
391
|
#
|
293
392
|
# @!attribute [rw] agent_alias_name
|
294
|
-
#
|
393
|
+
# The name of the alias of the agent.
|
295
394
|
# @return [String]
|
296
395
|
#
|
297
|
-
# @!attribute [rw]
|
298
|
-
#
|
396
|
+
# @!attribute [rw] agent_alias_status
|
397
|
+
# The status of the alias of the agent and whether it is ready for
|
398
|
+
# use. The following statuses are possible:
|
399
|
+
#
|
400
|
+
# * CREATING – The agent alias is being created.
|
401
|
+
#
|
402
|
+
# * PREPARED – The agent alias is finished being created or updated
|
403
|
+
# and is ready to be invoked.
|
404
|
+
#
|
405
|
+
# * FAILED – The agent alias API operation failed.
|
406
|
+
#
|
407
|
+
# * UPDATING – The agent alias is being updated.
|
408
|
+
#
|
409
|
+
# * DELETING – The agent alias is being deleted.
|
410
|
+
# @return [String]
|
411
|
+
#
|
412
|
+
# @!attribute [rw] agent_id
|
413
|
+
# The unique identifier of the agent.
|
299
414
|
# @return [String]
|
300
415
|
#
|
301
416
|
# @!attribute [rw] client_token
|
302
|
-
#
|
417
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
418
|
+
# completes no more than one time. If this token matches a previous
|
419
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
420
|
+
# error. For more information, see [Ensuring idempotency][1].
|
421
|
+
#
|
422
|
+
#
|
423
|
+
#
|
424
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
303
425
|
# @return [String]
|
304
426
|
#
|
427
|
+
# @!attribute [rw] created_at
|
428
|
+
# The time at which the alias of the agent was created.
|
429
|
+
# @return [Time]
|
430
|
+
#
|
305
431
|
# @!attribute [rw] description
|
306
|
-
#
|
432
|
+
# The description of the alias of the agent.
|
307
433
|
# @return [String]
|
308
434
|
#
|
309
435
|
# @!attribute [rw] routing_configuration
|
310
|
-
#
|
436
|
+
# Contains details about the routing configuration of the alias.
|
311
437
|
# @return [Array<Types::AgentAliasRoutingConfigurationListItem>]
|
312
438
|
#
|
313
|
-
# @!attribute [rw] created_at
|
314
|
-
# Time Stamp.
|
315
|
-
# @return [Time]
|
316
|
-
#
|
317
439
|
# @!attribute [rw] updated_at
|
318
|
-
#
|
440
|
+
# The time at which the alias was last updated.
|
319
441
|
# @return [Time]
|
320
442
|
#
|
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
443
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentAlias AWS API Documentation
|
330
444
|
#
|
331
445
|
class AgentAlias < Struct.new(
|
332
|
-
:
|
446
|
+
:agent_alias_arn,
|
447
|
+
:agent_alias_history_events,
|
333
448
|
:agent_alias_id,
|
334
449
|
:agent_alias_name,
|
335
|
-
:
|
450
|
+
:agent_alias_status,
|
451
|
+
:agent_id,
|
336
452
|
:client_token,
|
453
|
+
:created_at,
|
337
454
|
:description,
|
338
455
|
:routing_configuration,
|
339
|
-
:
|
340
|
-
:updated_at,
|
341
|
-
:agent_alias_history_events,
|
342
|
-
:agent_alias_status)
|
456
|
+
:updated_at)
|
343
457
|
SENSITIVE = []
|
344
458
|
include Aws::Structure
|
345
459
|
end
|
346
460
|
|
347
|
-
#
|
348
|
-
#
|
349
|
-
# @!attribute [rw] routing_configuration
|
350
|
-
# Routing configuration for an Agent alias.
|
351
|
-
# @return [Array<Types::AgentAliasRoutingConfigurationListItem>]
|
461
|
+
# Contains details about the history of the alias.
|
352
462
|
#
|
353
463
|
# @!attribute [rw] end_date
|
354
|
-
#
|
464
|
+
# The date that the alias stopped being associated to the version in
|
465
|
+
# the `routingConfiguration` object
|
355
466
|
# @return [Time]
|
356
467
|
#
|
468
|
+
# @!attribute [rw] routing_configuration
|
469
|
+
# Contains details about the version of the agent with which the alias
|
470
|
+
# is associated.
|
471
|
+
# @return [Array<Types::AgentAliasRoutingConfigurationListItem>]
|
472
|
+
#
|
357
473
|
# @!attribute [rw] start_date
|
358
|
-
#
|
474
|
+
# The date that the alias began being associated to the version in the
|
475
|
+
# `routingConfiguration` object.
|
359
476
|
# @return [Time]
|
360
477
|
#
|
361
478
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentAliasHistoryEvent AWS API Documentation
|
362
479
|
#
|
363
480
|
class AgentAliasHistoryEvent < Struct.new(
|
364
|
-
:routing_configuration,
|
365
481
|
:end_date,
|
482
|
+
:routing_configuration,
|
366
483
|
:start_date)
|
367
484
|
SENSITIVE = []
|
368
485
|
include Aws::Structure
|
369
486
|
end
|
370
487
|
|
371
|
-
#
|
488
|
+
# Contains details about the routing configuration of the alias.
|
372
489
|
#
|
373
490
|
# @!attribute [rw] agent_version
|
374
|
-
#
|
491
|
+
# The version of the agent with which the alias is associated.
|
375
492
|
# @return [String]
|
376
493
|
#
|
377
494
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentAliasRoutingConfigurationListItem AWS API Documentation
|
@@ -382,34 +499,35 @@ module Aws::BedrockAgent
|
|
382
499
|
include Aws::Structure
|
383
500
|
end
|
384
501
|
|
385
|
-
#
|
502
|
+
# Contains details about an alias of an agent.
|
386
503
|
#
|
387
504
|
# @!attribute [rw] agent_alias_id
|
388
|
-
#
|
505
|
+
# Contains details about
|
389
506
|
# @return [String]
|
390
507
|
#
|
391
508
|
# @!attribute [rw] agent_alias_name
|
392
|
-
#
|
393
|
-
# @return [String]
|
394
|
-
#
|
395
|
-
# @!attribute [rw] description
|
396
|
-
# Description of the Resource.
|
509
|
+
# The name of the alias.
|
397
510
|
# @return [String]
|
398
511
|
#
|
399
|
-
# @!attribute [rw] routing_configuration
|
400
|
-
# Routing configuration for an Agent alias.
|
401
|
-
# @return [Array<Types::AgentAliasRoutingConfigurationListItem>]
|
402
|
-
#
|
403
512
|
# @!attribute [rw] agent_alias_status
|
404
|
-
# The
|
513
|
+
# The status of the alias.
|
405
514
|
# @return [String]
|
406
515
|
#
|
407
516
|
# @!attribute [rw] created_at
|
408
|
-
#
|
517
|
+
# The time at which the alias of the agent was created.
|
409
518
|
# @return [Time]
|
410
519
|
#
|
520
|
+
# @!attribute [rw] description
|
521
|
+
# The description of the alias.
|
522
|
+
# @return [String]
|
523
|
+
#
|
524
|
+
# @!attribute [rw] routing_configuration
|
525
|
+
# Contains details about the version of the agent with which the alias
|
526
|
+
# is associated.
|
527
|
+
# @return [Array<Types::AgentAliasRoutingConfigurationListItem>]
|
528
|
+
#
|
411
529
|
# @!attribute [rw] updated_at
|
412
|
-
#
|
530
|
+
# The time at which the alias was last updated.
|
413
531
|
# @return [Time]
|
414
532
|
#
|
415
533
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentAliasSummary AWS API Documentation
|
@@ -417,114 +535,133 @@ module Aws::BedrockAgent
|
|
417
535
|
class AgentAliasSummary < Struct.new(
|
418
536
|
:agent_alias_id,
|
419
537
|
:agent_alias_name,
|
420
|
-
:description,
|
421
|
-
:routing_configuration,
|
422
538
|
:agent_alias_status,
|
423
539
|
:created_at,
|
540
|
+
:description,
|
541
|
+
:routing_configuration,
|
424
542
|
:updated_at)
|
425
543
|
SENSITIVE = []
|
426
544
|
include Aws::Structure
|
427
545
|
end
|
428
546
|
|
429
|
-
# Contains
|
547
|
+
# Contains details about a knowledge base that is associated with an
|
548
|
+
# agent.
|
430
549
|
#
|
431
550
|
# @!attribute [rw] agent_id
|
432
|
-
#
|
551
|
+
# The unique identifier of the agent with which the knowledge base is
|
552
|
+
# associated.
|
433
553
|
# @return [String]
|
434
554
|
#
|
435
555
|
# @!attribute [rw] agent_version
|
436
|
-
#
|
556
|
+
# The version of the agent with which the knowledge base is
|
557
|
+
# associated.
|
437
558
|
# @return [String]
|
438
559
|
#
|
439
|
-
# @!attribute [rw]
|
440
|
-
#
|
441
|
-
#
|
560
|
+
# @!attribute [rw] created_at
|
561
|
+
# The time at which the association between the agent and the
|
562
|
+
# knowledge base was created.
|
563
|
+
# @return [Time]
|
442
564
|
#
|
443
565
|
# @!attribute [rw] description
|
444
|
-
#
|
566
|
+
# The description of the association between the agent and the
|
567
|
+
# knowledge base.
|
445
568
|
# @return [String]
|
446
569
|
#
|
447
|
-
# @!attribute [rw]
|
448
|
-
#
|
449
|
-
#
|
450
|
-
#
|
451
|
-
# @!attribute [rw] updated_at
|
452
|
-
# Time Stamp.
|
453
|
-
# @return [Time]
|
570
|
+
# @!attribute [rw] knowledge_base_id
|
571
|
+
# The unique identifier of the association between the agent and the
|
572
|
+
# knowledge base.
|
573
|
+
# @return [String]
|
454
574
|
#
|
455
575
|
# @!attribute [rw] knowledge_base_state
|
456
|
-
#
|
576
|
+
# Specifies whether to use the knowledge base or not when sending an
|
577
|
+
# [InvokeAgent][1] request.
|
578
|
+
#
|
579
|
+
#
|
580
|
+
#
|
581
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
|
457
582
|
# @return [String]
|
458
583
|
#
|
584
|
+
# @!attribute [rw] updated_at
|
585
|
+
# The time at which the association between the agent and the
|
586
|
+
# knowledge base was last updated.
|
587
|
+
# @return [Time]
|
588
|
+
#
|
459
589
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentKnowledgeBase AWS API Documentation
|
460
590
|
#
|
461
591
|
class AgentKnowledgeBase < Struct.new(
|
462
592
|
:agent_id,
|
463
593
|
:agent_version,
|
464
|
-
:knowledge_base_id,
|
465
|
-
:description,
|
466
594
|
:created_at,
|
467
|
-
:
|
468
|
-
:
|
595
|
+
:description,
|
596
|
+
:knowledge_base_id,
|
597
|
+
:knowledge_base_state,
|
598
|
+
:updated_at)
|
469
599
|
SENSITIVE = []
|
470
600
|
include Aws::Structure
|
471
601
|
end
|
472
602
|
|
473
|
-
#
|
603
|
+
# Contains details about a knowledge base associated with an agent.
|
474
604
|
#
|
475
|
-
# @!attribute [rw]
|
476
|
-
#
|
605
|
+
# @!attribute [rw] description
|
606
|
+
# The description of the knowledge base associated with an agent.
|
477
607
|
# @return [String]
|
478
608
|
#
|
479
|
-
# @!attribute [rw]
|
480
|
-
#
|
609
|
+
# @!attribute [rw] knowledge_base_id
|
610
|
+
# The unique identifier of the knowledge base associated with an
|
611
|
+
# agent.
|
481
612
|
# @return [String]
|
482
613
|
#
|
483
614
|
# @!attribute [rw] knowledge_base_state
|
484
|
-
#
|
615
|
+
# Specifies whether the agent uses the knowledge base or not when
|
616
|
+
# sending an [InvokeAgent][1] request.
|
617
|
+
#
|
618
|
+
#
|
619
|
+
#
|
620
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
|
485
621
|
# @return [String]
|
486
622
|
#
|
487
623
|
# @!attribute [rw] updated_at
|
488
|
-
#
|
624
|
+
# The time at which the knowledge base associated with an agent was
|
625
|
+
# last updated.
|
489
626
|
# @return [Time]
|
490
627
|
#
|
491
628
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentKnowledgeBaseSummary AWS API Documentation
|
492
629
|
#
|
493
630
|
class AgentKnowledgeBaseSummary < Struct.new(
|
494
|
-
:knowledge_base_id,
|
495
631
|
:description,
|
632
|
+
:knowledge_base_id,
|
496
633
|
:knowledge_base_state,
|
497
634
|
:updated_at)
|
498
635
|
SENSITIVE = []
|
499
636
|
include Aws::Structure
|
500
637
|
end
|
501
638
|
|
502
|
-
#
|
639
|
+
# Contains details about an agent.
|
503
640
|
#
|
504
641
|
# @!attribute [rw] agent_id
|
505
|
-
#
|
642
|
+
# The unique identifier of the agent.
|
506
643
|
# @return [String]
|
507
644
|
#
|
508
645
|
# @!attribute [rw] agent_name
|
509
|
-
#
|
646
|
+
# The name of the agent.
|
510
647
|
# @return [String]
|
511
648
|
#
|
512
649
|
# @!attribute [rw] agent_status
|
513
|
-
#
|
650
|
+
# The status of the agent.
|
514
651
|
# @return [String]
|
515
652
|
#
|
516
653
|
# @!attribute [rw] description
|
517
|
-
#
|
654
|
+
# The description of the agent.
|
518
655
|
# @return [String]
|
519
656
|
#
|
520
|
-
# @!attribute [rw] updated_at
|
521
|
-
# Time Stamp.
|
522
|
-
# @return [Time]
|
523
|
-
#
|
524
657
|
# @!attribute [rw] latest_agent_version
|
525
|
-
#
|
658
|
+
# The latest version of the agent.
|
526
659
|
# @return [String]
|
527
660
|
#
|
661
|
+
# @!attribute [rw] updated_at
|
662
|
+
# The time at which the agent was last updated.
|
663
|
+
# @return [Time]
|
664
|
+
#
|
528
665
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentSummary AWS API Documentation
|
529
666
|
#
|
530
667
|
class AgentSummary < Struct.new(
|
@@ -532,128 +669,142 @@ module Aws::BedrockAgent
|
|
532
669
|
:agent_name,
|
533
670
|
:agent_status,
|
534
671
|
:description,
|
535
|
-
:
|
536
|
-
:
|
672
|
+
:latest_agent_version,
|
673
|
+
:updated_at)
|
537
674
|
SENSITIVE = []
|
538
675
|
include Aws::Structure
|
539
676
|
end
|
540
677
|
|
541
|
-
# Contains
|
678
|
+
# Contains details about a version of an agent.
|
679
|
+
#
|
680
|
+
# @!attribute [rw] agent_arn
|
681
|
+
# The Amazon Resource Name (ARN) of the agent that the version belongs
|
682
|
+
# to.
|
683
|
+
# @return [String]
|
542
684
|
#
|
543
685
|
# @!attribute [rw] agent_id
|
544
|
-
#
|
686
|
+
# The unique identifier of the agent that the version belongs to.
|
545
687
|
# @return [String]
|
546
688
|
#
|
547
689
|
# @!attribute [rw] agent_name
|
548
|
-
#
|
690
|
+
# The name of the agent that the version belongs to.
|
549
691
|
# @return [String]
|
550
692
|
#
|
551
|
-
# @!attribute [rw]
|
552
|
-
#
|
693
|
+
# @!attribute [rw] agent_resource_role_arn
|
694
|
+
# The Amazon Resource Name (ARN) of the IAM role with permissions to
|
695
|
+
# invoke API operations on the agent.
|
553
696
|
# @return [String]
|
554
697
|
#
|
555
|
-
# @!attribute [rw]
|
556
|
-
#
|
698
|
+
# @!attribute [rw] agent_status
|
699
|
+
# The status of the agent that the version belongs to.
|
557
700
|
# @return [String]
|
558
701
|
#
|
559
|
-
# @!attribute [rw]
|
560
|
-
#
|
561
|
-
# @return [
|
702
|
+
# @!attribute [rw] created_at
|
703
|
+
# The time at which the version was created.
|
704
|
+
# @return [Time]
|
562
705
|
#
|
563
|
-
# @!attribute [rw]
|
564
|
-
#
|
706
|
+
# @!attribute [rw] customer_encryption_key_arn
|
707
|
+
# The Amazon Resource Name (ARN) of the KMS key that encrypts the
|
708
|
+
# agent.
|
565
709
|
# @return [String]
|
566
710
|
#
|
567
|
-
# @!attribute [rw]
|
568
|
-
#
|
711
|
+
# @!attribute [rw] description
|
712
|
+
# The description of the version.
|
569
713
|
# @return [String]
|
570
714
|
#
|
571
|
-
# @!attribute [rw]
|
572
|
-
#
|
715
|
+
# @!attribute [rw] failure_reasons
|
716
|
+
# A list of reasons that the API operation on the version failed.
|
717
|
+
# @return [Array<String>]
|
718
|
+
#
|
719
|
+
# @!attribute [rw] foundation_model
|
720
|
+
# The foundation model that the version invokes.
|
573
721
|
# @return [String]
|
574
722
|
#
|
575
723
|
# @!attribute [rw] idle_session_ttl_in_seconds
|
576
|
-
#
|
724
|
+
# The number of seconds for which Amazon Bedrock keeps information
|
725
|
+
# about a user's conversation with the agent.
|
726
|
+
#
|
727
|
+
# A user interaction remains active for the amount of time specified.
|
728
|
+
# If no conversation occurs during this time, the session expires and
|
729
|
+
# Amazon Bedrock deletes any data provided before the timeout.
|
577
730
|
# @return [Integer]
|
578
731
|
#
|
579
|
-
# @!attribute [rw]
|
580
|
-
#
|
732
|
+
# @!attribute [rw] instruction
|
733
|
+
# The instructions provided to the agent.
|
581
734
|
# @return [String]
|
582
735
|
#
|
583
|
-
# @!attribute [rw]
|
584
|
-
#
|
585
|
-
#
|
736
|
+
# @!attribute [rw] prompt_override_configuration
|
737
|
+
# Contains configurations to override prompt templates in different
|
738
|
+
# parts of an agent sequence. For more information, see [Advanced
|
739
|
+
# prompts][1].
|
586
740
|
#
|
587
|
-
# @!attribute [rw] created_at
|
588
|
-
# Time Stamp.
|
589
|
-
# @return [Time]
|
590
741
|
#
|
591
|
-
# @!attribute [rw] updated_at
|
592
|
-
# Time Stamp.
|
593
|
-
# @return [Time]
|
594
742
|
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
# @return [Array<String>]
|
743
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
|
744
|
+
# @return [Types::PromptOverrideConfiguration]
|
598
745
|
#
|
599
746
|
# @!attribute [rw] recommended_actions
|
600
|
-
#
|
601
|
-
#
|
747
|
+
# A list of recommended actions to take for the failed API operation
|
748
|
+
# on the version to succeed.
|
602
749
|
# @return [Array<String>]
|
603
750
|
#
|
604
|
-
# @!attribute [rw]
|
605
|
-
#
|
606
|
-
# @return [
|
751
|
+
# @!attribute [rw] updated_at
|
752
|
+
# The time at which the version was last updated.
|
753
|
+
# @return [Time]
|
754
|
+
#
|
755
|
+
# @!attribute [rw] version
|
756
|
+
# The version number.
|
757
|
+
# @return [String]
|
607
758
|
#
|
608
759
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentVersion AWS API Documentation
|
609
760
|
#
|
610
761
|
class AgentVersion < Struct.new(
|
762
|
+
:agent_arn,
|
611
763
|
:agent_id,
|
612
764
|
:agent_name,
|
613
|
-
:agent_arn,
|
614
|
-
:version,
|
615
|
-
:instruction,
|
616
|
-
:agent_status,
|
617
|
-
:foundation_model,
|
618
|
-
:description,
|
619
|
-
:idle_session_ttl_in_seconds,
|
620
765
|
:agent_resource_role_arn,
|
621
|
-
:
|
766
|
+
:agent_status,
|
622
767
|
:created_at,
|
623
|
-
:
|
768
|
+
:customer_encryption_key_arn,
|
769
|
+
:description,
|
624
770
|
:failure_reasons,
|
771
|
+
:foundation_model,
|
772
|
+
:idle_session_ttl_in_seconds,
|
773
|
+
:instruction,
|
774
|
+
:prompt_override_configuration,
|
625
775
|
:recommended_actions,
|
626
|
-
:
|
776
|
+
:updated_at,
|
777
|
+
:version)
|
627
778
|
SENSITIVE = [:instruction, :prompt_override_configuration]
|
628
779
|
include Aws::Structure
|
629
780
|
end
|
630
781
|
|
631
|
-
#
|
782
|
+
# Contains details about a version of an agent.
|
632
783
|
#
|
633
784
|
# @!attribute [rw] agent_name
|
634
|
-
#
|
785
|
+
# The name of the agent to which the version belongs.
|
635
786
|
# @return [String]
|
636
787
|
#
|
637
788
|
# @!attribute [rw] agent_status
|
638
|
-
#
|
789
|
+
# The status of the agent to which the version belongs.
|
639
790
|
# @return [String]
|
640
791
|
#
|
641
792
|
# @!attribute [rw] agent_version
|
642
|
-
#
|
793
|
+
# The version of the agent.
|
643
794
|
# @return [String]
|
644
795
|
#
|
645
796
|
# @!attribute [rw] created_at
|
646
|
-
#
|
647
|
-
# @return [Time]
|
648
|
-
#
|
649
|
-
# @!attribute [rw] updated_at
|
650
|
-
# Time Stamp.
|
797
|
+
# The time at which the version was created.
|
651
798
|
# @return [Time]
|
652
799
|
#
|
653
800
|
# @!attribute [rw] description
|
654
|
-
#
|
801
|
+
# The description of the version of the agent.
|
655
802
|
# @return [String]
|
656
803
|
#
|
804
|
+
# @!attribute [rw] updated_at
|
805
|
+
# The time at which the version was last updated.
|
806
|
+
# @return [Time]
|
807
|
+
#
|
657
808
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentVersionSummary AWS API Documentation
|
658
809
|
#
|
659
810
|
class AgentVersionSummary < Struct.new(
|
@@ -661,32 +812,38 @@ module Aws::BedrockAgent
|
|
661
812
|
:agent_status,
|
662
813
|
:agent_version,
|
663
814
|
:created_at,
|
664
|
-
:
|
665
|
-
:
|
815
|
+
:description,
|
816
|
+
:updated_at)
|
666
817
|
SENSITIVE = []
|
667
818
|
include Aws::Structure
|
668
819
|
end
|
669
820
|
|
670
|
-
# Associate Agent Knowledge Base Request
|
671
|
-
#
|
672
821
|
# @!attribute [rw] agent_id
|
673
|
-
#
|
822
|
+
# The unique identifier of the agent with which you want to associate
|
823
|
+
# the knowledge base.
|
674
824
|
# @return [String]
|
675
825
|
#
|
676
826
|
# @!attribute [rw] agent_version
|
677
|
-
#
|
827
|
+
# The version of the agent with which you want to associate the
|
828
|
+
# knowledge base.
|
678
829
|
# @return [String]
|
679
830
|
#
|
680
|
-
# @!attribute [rw]
|
681
|
-
#
|
831
|
+
# @!attribute [rw] description
|
832
|
+
# A description of what the agent should use the knowledge base for.
|
682
833
|
# @return [String]
|
683
834
|
#
|
684
|
-
# @!attribute [rw]
|
685
|
-
#
|
835
|
+
# @!attribute [rw] knowledge_base_id
|
836
|
+
# The unique identifier of the knowledge base to associate with the
|
837
|
+
# agent.
|
686
838
|
# @return [String]
|
687
839
|
#
|
688
840
|
# @!attribute [rw] knowledge_base_state
|
689
|
-
#
|
841
|
+
# Specifies whether to use the knowledge base or not when sending an
|
842
|
+
# [InvokeAgent][1] request.
|
843
|
+
#
|
844
|
+
#
|
845
|
+
#
|
846
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
|
690
847
|
# @return [String]
|
691
848
|
#
|
692
849
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBaseRequest AWS API Documentation
|
@@ -694,17 +851,16 @@ module Aws::BedrockAgent
|
|
694
851
|
class AssociateAgentKnowledgeBaseRequest < Struct.new(
|
695
852
|
:agent_id,
|
696
853
|
:agent_version,
|
697
|
-
:knowledge_base_id,
|
698
854
|
:description,
|
855
|
+
:knowledge_base_id,
|
699
856
|
:knowledge_base_state)
|
700
857
|
SENSITIVE = []
|
701
858
|
include Aws::Structure
|
702
859
|
end
|
703
860
|
|
704
|
-
# Associate Agent Knowledge Base Response
|
705
|
-
#
|
706
861
|
# @!attribute [rw] agent_knowledge_base
|
707
|
-
# Contains the
|
862
|
+
# Contains details about the knowledge base that has been associated
|
863
|
+
# with the agent.
|
708
864
|
# @return [Types::AgentKnowledgeBase]
|
709
865
|
#
|
710
866
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBaseResponse AWS API Documentation
|
@@ -715,14 +871,30 @@ module Aws::BedrockAgent
|
|
715
871
|
include Aws::Structure
|
716
872
|
end
|
717
873
|
|
718
|
-
#
|
874
|
+
# Details about how to chunk the documents in the data source. A *chunk*
|
875
|
+
# refers to an excerpt from a data source that is returned when the
|
876
|
+
# knowledge base that it belongs to is queried.
|
719
877
|
#
|
720
878
|
# @!attribute [rw] chunking_strategy
|
721
|
-
#
|
879
|
+
# Knowledge base can split your source data into chunks. A *chunk*
|
880
|
+
# refers to an excerpt from a data source that is returned when the
|
881
|
+
# knowledge base that it belongs to is queried. You have the following
|
882
|
+
# options for chunking your data. If you opt for `NONE`, then you may
|
883
|
+
# want to pre-process your files by splitting them up such that each
|
884
|
+
# file corresponds to a chunk.
|
885
|
+
#
|
886
|
+
# * `FIXED_SIZE` – Amazon Bedrock splits your source data into chunks
|
887
|
+
# of the approximate size that you set in the
|
888
|
+
# `fixedSizeChunkingConfiguration`.
|
889
|
+
#
|
890
|
+
# * `NONE` – Amazon Bedrock treats each file as one chunk. If you
|
891
|
+
# choose this option, you may want to pre-process your documents by
|
892
|
+
# splitting them into separate files.
|
722
893
|
# @return [String]
|
723
894
|
#
|
724
895
|
# @!attribute [rw] fixed_size_chunking_configuration
|
725
|
-
#
|
896
|
+
# Configurations for when you choose fixed-size chunking. If you set
|
897
|
+
# the `chunkingStrategy` as `NONE`, exclude this field.
|
726
898
|
# @return [Types::FixedSizeChunkingConfiguration]
|
727
899
|
#
|
728
900
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ChunkingConfiguration AWS API Documentation
|
@@ -734,11 +906,9 @@ module Aws::BedrockAgent
|
|
734
906
|
include Aws::Structure
|
735
907
|
end
|
736
908
|
|
737
|
-
#
|
738
|
-
# operation
|
909
|
+
# There was a conflict performing an operation.
|
739
910
|
#
|
740
911
|
# @!attribute [rw] message
|
741
|
-
# Non Blank String
|
742
912
|
# @return [String]
|
743
913
|
#
|
744
914
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ConflictException AWS API Documentation
|
@@ -749,67 +919,97 @@ module Aws::BedrockAgent
|
|
749
919
|
include Aws::Structure
|
750
920
|
end
|
751
921
|
|
752
|
-
#
|
922
|
+
# @!attribute [rw] action_group_executor
|
923
|
+
# The Amazon Resource Name (ARN) of the Lambda function containing the
|
924
|
+
# business logic that is carried out upon invoking the action.
|
925
|
+
# @return [Types::ActionGroupExecutor]
|
926
|
+
#
|
927
|
+
# @!attribute [rw] action_group_name
|
928
|
+
# The name to give the action group.
|
929
|
+
# @return [String]
|
930
|
+
#
|
931
|
+
# @!attribute [rw] action_group_state
|
932
|
+
# Specifies whether the action group is available for the agent to
|
933
|
+
# invoke or not when sending an [InvokeAgent][1] request.
|
934
|
+
#
|
935
|
+
#
|
936
|
+
#
|
937
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
|
938
|
+
# @return [String]
|
753
939
|
#
|
754
940
|
# @!attribute [rw] agent_id
|
755
|
-
#
|
941
|
+
# The unique identifier of the agent for which to create the action
|
942
|
+
# group.
|
756
943
|
# @return [String]
|
757
944
|
#
|
758
945
|
# @!attribute [rw] agent_version
|
759
|
-
#
|
946
|
+
# The version of the agent for which to create the action group.
|
760
947
|
# @return [String]
|
761
948
|
#
|
762
|
-
# @!attribute [rw]
|
763
|
-
#
|
764
|
-
#
|
949
|
+
# @!attribute [rw] api_schema
|
950
|
+
# Contains either details about the S3 object containing the OpenAPI
|
951
|
+
# schema for the action group or the JSON or YAML-formatted payload
|
952
|
+
# defining the schema. For more information, see [Action group OpenAPI
|
953
|
+
# schemas][1].
|
954
|
+
#
|
955
|
+
#
|
956
|
+
#
|
957
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html
|
958
|
+
# @return [Types::APISchema]
|
765
959
|
#
|
766
960
|
# @!attribute [rw] client_token
|
767
|
-
#
|
961
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
962
|
+
# completes no more than one time. If this token matches a previous
|
963
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
964
|
+
# error. For more information, see [Ensuring idempotency][1].
|
768
965
|
#
|
769
966
|
# **A suitable default value is auto-generated.** You should normally
|
770
967
|
# not need to pass this option.
|
968
|
+
#
|
969
|
+
#
|
970
|
+
#
|
971
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
771
972
|
# @return [String]
|
772
973
|
#
|
773
974
|
# @!attribute [rw] description
|
774
|
-
#
|
975
|
+
# A description of the action group.
|
775
976
|
# @return [String]
|
776
977
|
#
|
777
978
|
# @!attribute [rw] parent_action_group_signature
|
778
|
-
#
|
779
|
-
#
|
979
|
+
# To allow your agent to request the user for additional information
|
980
|
+
# when trying to complete a task, set this field to
|
981
|
+
# `AMAZON.UserInput`. You must leave the `description`, `apiSchema`,
|
982
|
+
# and `actionGroupExecutor` fields blank for this action group.
|
780
983
|
#
|
781
|
-
#
|
782
|
-
#
|
783
|
-
#
|
984
|
+
# During orchestration, if your agent determines that it needs to
|
985
|
+
# invoke an API in an action group, but doesn't have enough
|
986
|
+
# information to complete the API request, it will invoke this action
|
987
|
+
# group instead and return an [Observation][1] reprompting the user
|
988
|
+
# for more information.
|
784
989
|
#
|
785
|
-
# @!attribute [rw] api_schema
|
786
|
-
# Contains information about the API Schema for the Action Group
|
787
|
-
# @return [Types::APISchema]
|
788
990
|
#
|
789
|
-
#
|
790
|
-
#
|
991
|
+
#
|
992
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html
|
791
993
|
# @return [String]
|
792
994
|
#
|
793
995
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentActionGroupRequest AWS API Documentation
|
794
996
|
#
|
795
997
|
class CreateAgentActionGroupRequest < Struct.new(
|
998
|
+
:action_group_executor,
|
999
|
+
:action_group_name,
|
1000
|
+
:action_group_state,
|
796
1001
|
:agent_id,
|
797
1002
|
:agent_version,
|
798
|
-
:
|
1003
|
+
:api_schema,
|
799
1004
|
:client_token,
|
800
1005
|
:description,
|
801
|
-
:parent_action_group_signature
|
802
|
-
:action_group_executor,
|
803
|
-
:api_schema,
|
804
|
-
:action_group_state)
|
1006
|
+
:parent_action_group_signature)
|
805
1007
|
SENSITIVE = []
|
806
1008
|
include Aws::Structure
|
807
1009
|
end
|
808
1010
|
|
809
|
-
# Create Action Group Response
|
810
|
-
#
|
811
1011
|
# @!attribute [rw] agent_action_group
|
812
|
-
# Contains the
|
1012
|
+
# Contains details about the action group that was created.
|
813
1013
|
# @return [Types::AgentActionGroup]
|
814
1014
|
#
|
815
1015
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentActionGroupResponse AWS API Documentation
|
@@ -820,40 +1020,45 @@ module Aws::BedrockAgent
|
|
820
1020
|
include Aws::Structure
|
821
1021
|
end
|
822
1022
|
|
823
|
-
#
|
824
|
-
#
|
825
|
-
# @!attribute [rw] agent_id
|
826
|
-
# Id generated at the server side when an Agent is created
|
1023
|
+
# @!attribute [rw] agent_alias_name
|
1024
|
+
# The name of the alias.
|
827
1025
|
# @return [String]
|
828
1026
|
#
|
829
|
-
# @!attribute [rw]
|
830
|
-
#
|
1027
|
+
# @!attribute [rw] agent_id
|
1028
|
+
# The unique identifier of the agent.
|
831
1029
|
# @return [String]
|
832
1030
|
#
|
833
1031
|
# @!attribute [rw] client_token
|
834
|
-
#
|
1032
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
1033
|
+
# completes no more than one time. If this token matches a previous
|
1034
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
1035
|
+
# error. For more information, see [Ensuring idempotency][1].
|
835
1036
|
#
|
836
1037
|
# **A suitable default value is auto-generated.** You should normally
|
837
1038
|
# not need to pass this option.
|
1039
|
+
#
|
1040
|
+
#
|
1041
|
+
#
|
1042
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
838
1043
|
# @return [String]
|
839
1044
|
#
|
840
1045
|
# @!attribute [rw] description
|
841
|
-
#
|
1046
|
+
# A description of the alias of the agent.
|
842
1047
|
# @return [String]
|
843
1048
|
#
|
844
1049
|
# @!attribute [rw] routing_configuration
|
845
|
-
#
|
1050
|
+
# Contains details about the routing configuration of the alias.
|
846
1051
|
# @return [Array<Types::AgentAliasRoutingConfigurationListItem>]
|
847
1052
|
#
|
848
1053
|
# @!attribute [rw] tags
|
849
|
-
#
|
1054
|
+
# Any tags that you want to attach to the alias of the agent.
|
850
1055
|
# @return [Hash<String,String>]
|
851
1056
|
#
|
852
1057
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentAliasRequest AWS API Documentation
|
853
1058
|
#
|
854
1059
|
class CreateAgentAliasRequest < Struct.new(
|
855
|
-
:agent_id,
|
856
1060
|
:agent_alias_name,
|
1061
|
+
:agent_id,
|
857
1062
|
:client_token,
|
858
1063
|
:description,
|
859
1064
|
:routing_configuration,
|
@@ -862,10 +1067,8 @@ module Aws::BedrockAgent
|
|
862
1067
|
include Aws::Structure
|
863
1068
|
end
|
864
1069
|
|
865
|
-
# Create Agent Alias Response
|
866
|
-
#
|
867
1070
|
# @!attribute [rw] agent_alias
|
868
|
-
# Contains the
|
1071
|
+
# Contains details about the alias that was created.
|
869
1072
|
# @return [Types::AgentAlias]
|
870
1073
|
#
|
871
1074
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentAliasResponse AWS API Documentation
|
@@ -876,72 +1079,89 @@ module Aws::BedrockAgent
|
|
876
1079
|
include Aws::Structure
|
877
1080
|
end
|
878
1081
|
|
879
|
-
# Create Agent Request
|
880
|
-
#
|
881
1082
|
# @!attribute [rw] agent_name
|
882
|
-
#
|
1083
|
+
# A name for the agent that you create.
|
1084
|
+
# @return [String]
|
1085
|
+
#
|
1086
|
+
# @!attribute [rw] agent_resource_role_arn
|
1087
|
+
# The Amazon Resource Name (ARN) of the IAM role with permissions to
|
1088
|
+
# invoke API operations on the agent.
|
883
1089
|
# @return [String]
|
884
1090
|
#
|
885
1091
|
# @!attribute [rw] client_token
|
886
|
-
#
|
1092
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
1093
|
+
# completes no more than one time. If this token matches a previous
|
1094
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
1095
|
+
# error. For more information, see [Ensuring idempotency][1].
|
887
1096
|
#
|
888
1097
|
# **A suitable default value is auto-generated.** You should normally
|
889
1098
|
# not need to pass this option.
|
890
|
-
# @return [String]
|
891
1099
|
#
|
892
|
-
#
|
893
|
-
#
|
1100
|
+
#
|
1101
|
+
#
|
1102
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
894
1103
|
# @return [String]
|
895
1104
|
#
|
896
|
-
# @!attribute [rw]
|
897
|
-
#
|
1105
|
+
# @!attribute [rw] customer_encryption_key_arn
|
1106
|
+
# The Amazon Resource Name (ARN) of the KMS key with which to encrypt
|
1107
|
+
# the agent.
|
898
1108
|
# @return [String]
|
899
1109
|
#
|
900
1110
|
# @!attribute [rw] description
|
901
|
-
#
|
1111
|
+
# A description of the agent.
|
1112
|
+
# @return [String]
|
1113
|
+
#
|
1114
|
+
# @!attribute [rw] foundation_model
|
1115
|
+
# The foundation model to be used for orchestration by the agent you
|
1116
|
+
# create.
|
902
1117
|
# @return [String]
|
903
1118
|
#
|
904
1119
|
# @!attribute [rw] idle_session_ttl_in_seconds
|
905
|
-
#
|
1120
|
+
# The number of seconds for which Amazon Bedrock keeps information
|
1121
|
+
# about a user's conversation with the agent.
|
1122
|
+
#
|
1123
|
+
# A user interaction remains active for the amount of time specified.
|
1124
|
+
# If no conversation occurs during this time, the session expires and
|
1125
|
+
# Amazon Bedrock deletes any data provided before the timeout.
|
906
1126
|
# @return [Integer]
|
907
1127
|
#
|
908
|
-
# @!attribute [rw]
|
909
|
-
#
|
1128
|
+
# @!attribute [rw] instruction
|
1129
|
+
# Instructions that tell the agent what it should do and how it should
|
1130
|
+
# interact with users.
|
910
1131
|
# @return [String]
|
911
1132
|
#
|
912
|
-
# @!attribute [rw]
|
913
|
-
#
|
914
|
-
#
|
1133
|
+
# @!attribute [rw] prompt_override_configuration
|
1134
|
+
# Contains configurations to override prompts in different parts of an
|
1135
|
+
# agent sequence. For more information, see [Advanced prompts][1].
|
915
1136
|
#
|
916
|
-
# @!attribute [rw] tags
|
917
|
-
# A map of tag keys and values
|
918
|
-
# @return [Hash<String,String>]
|
919
1137
|
#
|
920
|
-
#
|
921
|
-
#
|
1138
|
+
#
|
1139
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
|
922
1140
|
# @return [Types::PromptOverrideConfiguration]
|
923
1141
|
#
|
1142
|
+
# @!attribute [rw] tags
|
1143
|
+
# Any tags that you want to attach to the agent.
|
1144
|
+
# @return [Hash<String,String>]
|
1145
|
+
#
|
924
1146
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentRequest AWS API Documentation
|
925
1147
|
#
|
926
1148
|
class CreateAgentRequest < Struct.new(
|
927
1149
|
:agent_name,
|
1150
|
+
:agent_resource_role_arn,
|
928
1151
|
:client_token,
|
929
|
-
:
|
930
|
-
:foundation_model,
|
1152
|
+
:customer_encryption_key_arn,
|
931
1153
|
:description,
|
1154
|
+
:foundation_model,
|
932
1155
|
:idle_session_ttl_in_seconds,
|
933
|
-
:
|
934
|
-
:
|
935
|
-
:tags
|
936
|
-
:prompt_override_configuration)
|
1156
|
+
:instruction,
|
1157
|
+
:prompt_override_configuration,
|
1158
|
+
:tags)
|
937
1159
|
SENSITIVE = [:instruction, :prompt_override_configuration]
|
938
1160
|
include Aws::Structure
|
939
1161
|
end
|
940
1162
|
|
941
|
-
# Create Agent Response
|
942
|
-
#
|
943
1163
|
# @!attribute [rw] agent
|
944
|
-
# Contains
|
1164
|
+
# Contains details about the agent created.
|
945
1165
|
# @return [Types::Agent]
|
946
1166
|
#
|
947
1167
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentResponse AWS API Documentation
|
@@ -952,45 +1172,55 @@ module Aws::BedrockAgent
|
|
952
1172
|
include Aws::Structure
|
953
1173
|
end
|
954
1174
|
|
955
|
-
# @!attribute [rw] knowledge_base_id
|
956
|
-
# Identifier for a resource.
|
957
|
-
# @return [String]
|
958
|
-
#
|
959
1175
|
# @!attribute [rw] client_token
|
960
|
-
#
|
1176
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
1177
|
+
# completes no more than one time. If this token matches a previous
|
1178
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
1179
|
+
# error. For more information, see [Ensuring idempotency][1].
|
961
1180
|
#
|
962
1181
|
# **A suitable default value is auto-generated.** You should normally
|
963
1182
|
# not need to pass this option.
|
964
|
-
# @return [String]
|
965
1183
|
#
|
966
|
-
# @!attribute [rw] name
|
967
|
-
# Name for a resource.
|
968
|
-
# @return [String]
|
969
1184
|
#
|
970
|
-
#
|
971
|
-
#
|
1185
|
+
#
|
1186
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
972
1187
|
# @return [String]
|
973
1188
|
#
|
974
1189
|
# @!attribute [rw] data_source_configuration
|
975
|
-
#
|
1190
|
+
# Contains metadata about where the data source is stored.
|
976
1191
|
# @return [Types::DataSourceConfiguration]
|
977
1192
|
#
|
1193
|
+
# @!attribute [rw] description
|
1194
|
+
# A description of the data source.
|
1195
|
+
# @return [String]
|
1196
|
+
#
|
1197
|
+
# @!attribute [rw] knowledge_base_id
|
1198
|
+
# The unique identifier of the knowledge base to which to add the data
|
1199
|
+
# source.
|
1200
|
+
# @return [String]
|
1201
|
+
#
|
1202
|
+
# @!attribute [rw] name
|
1203
|
+
# The name of the data source.
|
1204
|
+
# @return [String]
|
1205
|
+
#
|
978
1206
|
# @!attribute [rw] server_side_encryption_configuration
|
979
|
-
#
|
1207
|
+
# Contains details about the server-side encryption for the data
|
1208
|
+
# source.
|
980
1209
|
# @return [Types::ServerSideEncryptionConfiguration]
|
981
1210
|
#
|
982
1211
|
# @!attribute [rw] vector_ingestion_configuration
|
983
|
-
#
|
1212
|
+
# Contains details about how to ingest the documents in the data
|
1213
|
+
# source.
|
984
1214
|
# @return [Types::VectorIngestionConfiguration]
|
985
1215
|
#
|
986
1216
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateDataSourceRequest AWS API Documentation
|
987
1217
|
#
|
988
1218
|
class CreateDataSourceRequest < Struct.new(
|
989
|
-
:knowledge_base_id,
|
990
1219
|
:client_token,
|
991
|
-
:name,
|
992
|
-
:description,
|
993
1220
|
:data_source_configuration,
|
1221
|
+
:description,
|
1222
|
+
:knowledge_base_id,
|
1223
|
+
:name,
|
994
1224
|
:server_side_encryption_configuration,
|
995
1225
|
:vector_ingestion_configuration)
|
996
1226
|
SENSITIVE = []
|
@@ -998,7 +1228,7 @@ module Aws::BedrockAgent
|
|
998
1228
|
end
|
999
1229
|
|
1000
1230
|
# @!attribute [rw] data_source
|
1001
|
-
# Contains
|
1231
|
+
# Contains details about the data source.
|
1002
1232
|
# @return [Types::DataSource]
|
1003
1233
|
#
|
1004
1234
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateDataSourceResponse AWS API Documentation
|
@@ -1010,45 +1240,55 @@ module Aws::BedrockAgent
|
|
1010
1240
|
end
|
1011
1241
|
|
1012
1242
|
# @!attribute [rw] client_token
|
1013
|
-
#
|
1243
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
1244
|
+
# completes no more than one time. If this token matches a previous
|
1245
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
1246
|
+
# error. For more information, see [Ensuring idempotency][1].
|
1014
1247
|
#
|
1015
1248
|
# **A suitable default value is auto-generated.** You should normally
|
1016
1249
|
# not need to pass this option.
|
1017
|
-
# @return [String]
|
1018
1250
|
#
|
1019
|
-
# @!attribute [rw] name
|
1020
|
-
# Name for a resource.
|
1021
|
-
# @return [String]
|
1022
1251
|
#
|
1023
|
-
#
|
1024
|
-
#
|
1252
|
+
#
|
1253
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
1025
1254
|
# @return [String]
|
1026
1255
|
#
|
1027
|
-
# @!attribute [rw]
|
1028
|
-
#
|
1256
|
+
# @!attribute [rw] description
|
1257
|
+
# A description of the knowledge base.
|
1029
1258
|
# @return [String]
|
1030
1259
|
#
|
1031
1260
|
# @!attribute [rw] knowledge_base_configuration
|
1032
|
-
#
|
1261
|
+
# Contains details about the embeddings model used for the knowledge
|
1262
|
+
# base.
|
1033
1263
|
# @return [Types::KnowledgeBaseConfiguration]
|
1034
1264
|
#
|
1265
|
+
# @!attribute [rw] name
|
1266
|
+
# A name for the knowledge base.
|
1267
|
+
# @return [String]
|
1268
|
+
#
|
1269
|
+
# @!attribute [rw] role_arn
|
1270
|
+
# The Amazon Resource Name (ARN) of the IAM role with permissions to
|
1271
|
+
# invoke API operations on the knowledge base.
|
1272
|
+
# @return [String]
|
1273
|
+
#
|
1035
1274
|
# @!attribute [rw] storage_configuration
|
1036
|
-
#
|
1037
|
-
# base.
|
1275
|
+
# Contains details about the configuration of the vector database used
|
1276
|
+
# for the knowledge base.
|
1038
1277
|
# @return [Types::StorageConfiguration]
|
1039
1278
|
#
|
1040
1279
|
# @!attribute [rw] tags
|
1041
|
-
#
|
1280
|
+
# Specify the key-value pairs for the tags that you want to attach to
|
1281
|
+
# your knowledge base in this object.
|
1042
1282
|
# @return [Hash<String,String>]
|
1043
1283
|
#
|
1044
1284
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateKnowledgeBaseRequest AWS API Documentation
|
1045
1285
|
#
|
1046
1286
|
class CreateKnowledgeBaseRequest < Struct.new(
|
1047
1287
|
:client_token,
|
1048
|
-
:name,
|
1049
1288
|
:description,
|
1050
|
-
:role_arn,
|
1051
1289
|
:knowledge_base_configuration,
|
1290
|
+
:name,
|
1291
|
+
:role_arn,
|
1052
1292
|
:storage_configuration,
|
1053
1293
|
:tags)
|
1054
1294
|
SENSITIVE = []
|
@@ -1056,7 +1296,7 @@ module Aws::BedrockAgent
|
|
1056
1296
|
end
|
1057
1297
|
|
1058
1298
|
# @!attribute [rw] knowledge_base
|
1059
|
-
# Contains
|
1299
|
+
# Contains details about the knowledge base.
|
1060
1300
|
# @return [Types::KnowledgeBase]
|
1061
1301
|
#
|
1062
1302
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateKnowledgeBaseResponse AWS API Documentation
|
@@ -1067,211 +1307,213 @@ module Aws::BedrockAgent
|
|
1067
1307
|
include Aws::Structure
|
1068
1308
|
end
|
1069
1309
|
|
1070
|
-
# Contains
|
1310
|
+
# Contains details about a data source.
|
1071
1311
|
#
|
1072
|
-
# @!attribute [rw]
|
1073
|
-
#
|
1074
|
-
# @return [
|
1312
|
+
# @!attribute [rw] created_at
|
1313
|
+
# The time at which the data source was created.
|
1314
|
+
# @return [Time]
|
1315
|
+
#
|
1316
|
+
# @!attribute [rw] data_source_configuration
|
1317
|
+
# Contains details about how the data source is stored.
|
1318
|
+
# @return [Types::DataSourceConfiguration]
|
1075
1319
|
#
|
1076
1320
|
# @!attribute [rw] data_source_id
|
1077
|
-
#
|
1321
|
+
# The unique identifier of the data source.
|
1078
1322
|
# @return [String]
|
1079
1323
|
#
|
1080
|
-
# @!attribute [rw]
|
1081
|
-
#
|
1324
|
+
# @!attribute [rw] description
|
1325
|
+
# The description of the data source.
|
1082
1326
|
# @return [String]
|
1083
1327
|
#
|
1084
|
-
# @!attribute [rw]
|
1085
|
-
# The
|
1328
|
+
# @!attribute [rw] knowledge_base_id
|
1329
|
+
# The unique identifier of the knowledge base to which the data source
|
1330
|
+
# belongs.
|
1086
1331
|
# @return [String]
|
1087
1332
|
#
|
1088
|
-
# @!attribute [rw]
|
1089
|
-
#
|
1333
|
+
# @!attribute [rw] name
|
1334
|
+
# The name of the data source.
|
1090
1335
|
# @return [String]
|
1091
1336
|
#
|
1092
|
-
# @!attribute [rw] data_source_configuration
|
1093
|
-
# Specifies a raw data source location to ingest.
|
1094
|
-
# @return [Types::DataSourceConfiguration]
|
1095
|
-
#
|
1096
1337
|
# @!attribute [rw] server_side_encryption_configuration
|
1097
|
-
#
|
1338
|
+
# Contains details about the configuration of the server-side
|
1339
|
+
# encryption.
|
1098
1340
|
# @return [Types::ServerSideEncryptionConfiguration]
|
1099
1341
|
#
|
1100
|
-
# @!attribute [rw]
|
1101
|
-
#
|
1102
|
-
# @return [Types::VectorIngestionConfiguration]
|
1342
|
+
# @!attribute [rw] status
|
1343
|
+
# The status of the data source. The following statuses are possible:
|
1103
1344
|
#
|
1104
|
-
#
|
1105
|
-
#
|
1106
|
-
#
|
1345
|
+
# * Available – The data source has been created and is ready for
|
1346
|
+
# ingestion into the knowledge base.
|
1347
|
+
#
|
1348
|
+
# * Deleting – The data source is being deleted.
|
1349
|
+
# @return [String]
|
1107
1350
|
#
|
1108
1351
|
# @!attribute [rw] updated_at
|
1109
|
-
#
|
1352
|
+
# The time at which the data source was last updated.
|
1110
1353
|
# @return [Time]
|
1111
1354
|
#
|
1355
|
+
# @!attribute [rw] vector_ingestion_configuration
|
1356
|
+
# Contains details about how to ingest the documents in the data
|
1357
|
+
# source.
|
1358
|
+
# @return [Types::VectorIngestionConfiguration]
|
1359
|
+
#
|
1112
1360
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DataSource AWS API Documentation
|
1113
1361
|
#
|
1114
1362
|
class DataSource < Struct.new(
|
1115
|
-
:
|
1363
|
+
:created_at,
|
1364
|
+
:data_source_configuration,
|
1116
1365
|
:data_source_id,
|
1117
|
-
:name,
|
1118
|
-
:status,
|
1119
1366
|
:description,
|
1120
|
-
:
|
1367
|
+
:knowledge_base_id,
|
1368
|
+
:name,
|
1121
1369
|
:server_side_encryption_configuration,
|
1122
|
-
:
|
1123
|
-
:
|
1124
|
-
:
|
1370
|
+
:status,
|
1371
|
+
:updated_at,
|
1372
|
+
:vector_ingestion_configuration)
|
1125
1373
|
SENSITIVE = []
|
1126
1374
|
include Aws::Structure
|
1127
1375
|
end
|
1128
1376
|
|
1129
|
-
#
|
1130
|
-
#
|
1131
|
-
# @!attribute [rw] type
|
1132
|
-
# The type of the data source location.
|
1133
|
-
# @return [String]
|
1377
|
+
# Contains details about how a data source is stored.
|
1134
1378
|
#
|
1135
1379
|
# @!attribute [rw] s3_configuration
|
1136
|
-
#
|
1380
|
+
# Contains details about the configuration of the S3 object containing
|
1381
|
+
# the data source.
|
1137
1382
|
# @return [Types::S3DataSourceConfiguration]
|
1138
1383
|
#
|
1384
|
+
# @!attribute [rw] type
|
1385
|
+
# The type of storage for the data source.
|
1386
|
+
# @return [String]
|
1387
|
+
#
|
1139
1388
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DataSourceConfiguration AWS API Documentation
|
1140
1389
|
#
|
1141
1390
|
class DataSourceConfiguration < Struct.new(
|
1142
|
-
:
|
1143
|
-
:
|
1391
|
+
:s3_configuration,
|
1392
|
+
:type)
|
1144
1393
|
SENSITIVE = []
|
1145
1394
|
include Aws::Structure
|
1146
1395
|
end
|
1147
1396
|
|
1148
|
-
#
|
1397
|
+
# Contains details about a data source.
|
1149
1398
|
#
|
1150
|
-
# @!attribute [rw]
|
1151
|
-
#
|
1399
|
+
# @!attribute [rw] data_source_id
|
1400
|
+
# The unique identifier of the data source.
|
1152
1401
|
# @return [String]
|
1153
1402
|
#
|
1154
|
-
# @!attribute [rw]
|
1155
|
-
#
|
1403
|
+
# @!attribute [rw] description
|
1404
|
+
# The description of the data source.
|
1156
1405
|
# @return [String]
|
1157
1406
|
#
|
1158
|
-
# @!attribute [rw]
|
1159
|
-
#
|
1407
|
+
# @!attribute [rw] knowledge_base_id
|
1408
|
+
# The unique identifier of the knowledge base to which the data source
|
1409
|
+
# belongs.
|
1160
1410
|
# @return [String]
|
1161
1411
|
#
|
1162
|
-
# @!attribute [rw]
|
1163
|
-
# The
|
1412
|
+
# @!attribute [rw] name
|
1413
|
+
# The name of the data source.
|
1164
1414
|
# @return [String]
|
1165
1415
|
#
|
1166
|
-
# @!attribute [rw]
|
1167
|
-
#
|
1416
|
+
# @!attribute [rw] status
|
1417
|
+
# The status of the data source.
|
1168
1418
|
# @return [String]
|
1169
1419
|
#
|
1170
1420
|
# @!attribute [rw] updated_at
|
1171
|
-
#
|
1421
|
+
# The time at which the data source was last updated.
|
1172
1422
|
# @return [Time]
|
1173
1423
|
#
|
1174
1424
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DataSourceSummary AWS API Documentation
|
1175
1425
|
#
|
1176
1426
|
class DataSourceSummary < Struct.new(
|
1177
|
-
:knowledge_base_id,
|
1178
1427
|
:data_source_id,
|
1428
|
+
:description,
|
1429
|
+
:knowledge_base_id,
|
1179
1430
|
:name,
|
1180
1431
|
:status,
|
1181
|
-
:description,
|
1182
1432
|
:updated_at)
|
1183
1433
|
SENSITIVE = []
|
1184
1434
|
include Aws::Structure
|
1185
1435
|
end
|
1186
1436
|
|
1187
|
-
#
|
1437
|
+
# @!attribute [rw] action_group_id
|
1438
|
+
# The unique identifier of the action group to delete.
|
1439
|
+
# @return [String]
|
1188
1440
|
#
|
1189
1441
|
# @!attribute [rw] agent_id
|
1190
|
-
#
|
1442
|
+
# The unique identifier of the agent that the action group belongs to.
|
1191
1443
|
# @return [String]
|
1192
1444
|
#
|
1193
1445
|
# @!attribute [rw] agent_version
|
1194
|
-
#
|
1195
|
-
# @return [String]
|
1196
|
-
#
|
1197
|
-
# @!attribute [rw] action_group_id
|
1198
|
-
# Id generated at the server side when an Agent ActionGroup is created
|
1446
|
+
# The version of the agent that the action group belongs to.
|
1199
1447
|
# @return [String]
|
1200
1448
|
#
|
1201
1449
|
# @!attribute [rw] skip_resource_in_use_check
|
1202
|
-
#
|
1203
|
-
#
|
1450
|
+
# By default, this value is `false` and deletion is stopped if the
|
1451
|
+
# resource is in use. If you set it to `true`, the resource will be
|
1452
|
+
# deleted even if the resource is in use.
|
1204
1453
|
# @return [Boolean]
|
1205
1454
|
#
|
1206
1455
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentActionGroupRequest AWS API Documentation
|
1207
1456
|
#
|
1208
1457
|
class DeleteAgentActionGroupRequest < Struct.new(
|
1458
|
+
:action_group_id,
|
1209
1459
|
:agent_id,
|
1210
1460
|
:agent_version,
|
1211
|
-
:action_group_id,
|
1212
1461
|
:skip_resource_in_use_check)
|
1213
1462
|
SENSITIVE = []
|
1214
1463
|
include Aws::Structure
|
1215
1464
|
end
|
1216
1465
|
|
1217
|
-
# Delete Action Group Response
|
1218
|
-
#
|
1219
1466
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentActionGroupResponse AWS API Documentation
|
1220
1467
|
#
|
1221
1468
|
class DeleteAgentActionGroupResponse < Aws::EmptyStructure; end
|
1222
1469
|
|
1223
|
-
#
|
1224
|
-
#
|
1225
|
-
# @!attribute [rw] agent_id
|
1226
|
-
# Id generated at the server side when an Agent is created
|
1470
|
+
# @!attribute [rw] agent_alias_id
|
1471
|
+
# The unique identifier of the alias to delete.
|
1227
1472
|
# @return [String]
|
1228
1473
|
#
|
1229
|
-
# @!attribute [rw]
|
1230
|
-
#
|
1474
|
+
# @!attribute [rw] agent_id
|
1475
|
+
# The unique identifier of the agent that the alias belongs to.
|
1231
1476
|
# @return [String]
|
1232
1477
|
#
|
1233
1478
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentAliasRequest AWS API Documentation
|
1234
1479
|
#
|
1235
1480
|
class DeleteAgentAliasRequest < Struct.new(
|
1236
|
-
:
|
1237
|
-
:
|
1481
|
+
:agent_alias_id,
|
1482
|
+
:agent_id)
|
1238
1483
|
SENSITIVE = []
|
1239
1484
|
include Aws::Structure
|
1240
1485
|
end
|
1241
1486
|
|
1242
|
-
# Delete Agent Alias Response
|
1243
|
-
#
|
1244
|
-
# @!attribute [rw] agent_id
|
1245
|
-
# Identifier for a resource.
|
1246
|
-
# @return [String]
|
1247
|
-
#
|
1248
1487
|
# @!attribute [rw] agent_alias_id
|
1249
|
-
#
|
1488
|
+
# The unique identifier of the alias that was deleted.
|
1250
1489
|
# @return [String]
|
1251
1490
|
#
|
1252
1491
|
# @!attribute [rw] agent_alias_status
|
1253
|
-
# The
|
1492
|
+
# The status of the alias.
|
1493
|
+
# @return [String]
|
1494
|
+
#
|
1495
|
+
# @!attribute [rw] agent_id
|
1496
|
+
# The unique identifier of the agent that the alias belongs to.
|
1254
1497
|
# @return [String]
|
1255
1498
|
#
|
1256
1499
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentAliasResponse AWS API Documentation
|
1257
1500
|
#
|
1258
1501
|
class DeleteAgentAliasResponse < Struct.new(
|
1259
|
-
:agent_id,
|
1260
1502
|
:agent_alias_id,
|
1261
|
-
:agent_alias_status
|
1503
|
+
:agent_alias_status,
|
1504
|
+
:agent_id)
|
1262
1505
|
SENSITIVE = []
|
1263
1506
|
include Aws::Structure
|
1264
1507
|
end
|
1265
1508
|
|
1266
|
-
# Delete Agent Request
|
1267
|
-
#
|
1268
1509
|
# @!attribute [rw] agent_id
|
1269
|
-
#
|
1510
|
+
# The unique identifier of the agent to delete.
|
1270
1511
|
# @return [String]
|
1271
1512
|
#
|
1272
1513
|
# @!attribute [rw] skip_resource_in_use_check
|
1273
|
-
#
|
1274
|
-
#
|
1514
|
+
# By default, this value is `false` and deletion is stopped if the
|
1515
|
+
# resource is in use. If you set it to `true`, the resource will be
|
1516
|
+
# deleted even if the resource is in use.
|
1275
1517
|
# @return [Boolean]
|
1276
1518
|
#
|
1277
1519
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentRequest AWS API Documentation
|
@@ -1283,14 +1525,12 @@ module Aws::BedrockAgent
|
|
1283
1525
|
include Aws::Structure
|
1284
1526
|
end
|
1285
1527
|
|
1286
|
-
# Delete Agent Response
|
1287
|
-
#
|
1288
1528
|
# @!attribute [rw] agent_id
|
1289
|
-
#
|
1529
|
+
# The unique identifier of the agent that was deleted.
|
1290
1530
|
# @return [String]
|
1291
1531
|
#
|
1292
1532
|
# @!attribute [rw] agent_status
|
1293
|
-
#
|
1533
|
+
# The status of the agent.
|
1294
1534
|
# @return [String]
|
1295
1535
|
#
|
1296
1536
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentResponse AWS API Documentation
|
@@ -1302,19 +1542,18 @@ module Aws::BedrockAgent
|
|
1302
1542
|
include Aws::Structure
|
1303
1543
|
end
|
1304
1544
|
|
1305
|
-
# Delete Agent Version Request
|
1306
|
-
#
|
1307
1545
|
# @!attribute [rw] agent_id
|
1308
|
-
#
|
1546
|
+
# The unique identifier of the agent that the version belongs to.
|
1309
1547
|
# @return [String]
|
1310
1548
|
#
|
1311
1549
|
# @!attribute [rw] agent_version
|
1312
|
-
#
|
1550
|
+
# The version of the agent to delete.
|
1313
1551
|
# @return [String]
|
1314
1552
|
#
|
1315
1553
|
# @!attribute [rw] skip_resource_in_use_check
|
1316
|
-
#
|
1317
|
-
#
|
1554
|
+
# By default, this value is `false` and deletion is stopped if the
|
1555
|
+
# resource is in use. If you set it to `true`, the resource will be
|
1556
|
+
# deleted even if the resource is in use.
|
1318
1557
|
# @return [Boolean]
|
1319
1558
|
#
|
1320
1559
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentVersionRequest AWS API Documentation
|
@@ -1327,71 +1566,71 @@ module Aws::BedrockAgent
|
|
1327
1566
|
include Aws::Structure
|
1328
1567
|
end
|
1329
1568
|
|
1330
|
-
# Delete Agent Version Response
|
1331
|
-
#
|
1332
1569
|
# @!attribute [rw] agent_id
|
1333
|
-
#
|
1570
|
+
# The unique identifier of the agent that the version belongs to.
|
1334
1571
|
# @return [String]
|
1335
1572
|
#
|
1336
|
-
# @!attribute [rw]
|
1337
|
-
#
|
1573
|
+
# @!attribute [rw] agent_status
|
1574
|
+
# The status of the agent version.
|
1338
1575
|
# @return [String]
|
1339
1576
|
#
|
1340
|
-
# @!attribute [rw]
|
1341
|
-
#
|
1577
|
+
# @!attribute [rw] agent_version
|
1578
|
+
# The version that was deleted.
|
1342
1579
|
# @return [String]
|
1343
1580
|
#
|
1344
1581
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentVersionResponse AWS API Documentation
|
1345
1582
|
#
|
1346
1583
|
class DeleteAgentVersionResponse < Struct.new(
|
1347
1584
|
:agent_id,
|
1348
|
-
:
|
1349
|
-
:
|
1585
|
+
:agent_status,
|
1586
|
+
:agent_version)
|
1350
1587
|
SENSITIVE = []
|
1351
1588
|
include Aws::Structure
|
1352
1589
|
end
|
1353
1590
|
|
1354
|
-
# @!attribute [rw]
|
1355
|
-
#
|
1591
|
+
# @!attribute [rw] data_source_id
|
1592
|
+
# The unique identifier of the data source to delete.
|
1356
1593
|
# @return [String]
|
1357
1594
|
#
|
1358
|
-
# @!attribute [rw]
|
1359
|
-
#
|
1595
|
+
# @!attribute [rw] knowledge_base_id
|
1596
|
+
# The unique identifier of the knowledge base from which to delete the
|
1597
|
+
# data source.
|
1360
1598
|
# @return [String]
|
1361
1599
|
#
|
1362
1600
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteDataSourceRequest AWS API Documentation
|
1363
1601
|
#
|
1364
1602
|
class DeleteDataSourceRequest < Struct.new(
|
1365
|
-
:
|
1366
|
-
:
|
1603
|
+
:data_source_id,
|
1604
|
+
:knowledge_base_id)
|
1367
1605
|
SENSITIVE = []
|
1368
1606
|
include Aws::Structure
|
1369
1607
|
end
|
1370
1608
|
|
1371
|
-
# @!attribute [rw]
|
1372
|
-
#
|
1609
|
+
# @!attribute [rw] data_source_id
|
1610
|
+
# The unique identifier of the data source that was deleted.
|
1373
1611
|
# @return [String]
|
1374
1612
|
#
|
1375
|
-
# @!attribute [rw]
|
1376
|
-
#
|
1613
|
+
# @!attribute [rw] knowledge_base_id
|
1614
|
+
# The unique identifier of the knowledge base to which the data source
|
1615
|
+
# that was deleted belonged.
|
1377
1616
|
# @return [String]
|
1378
1617
|
#
|
1379
1618
|
# @!attribute [rw] status
|
1380
|
-
# The status of
|
1619
|
+
# The status of the data source.
|
1381
1620
|
# @return [String]
|
1382
1621
|
#
|
1383
1622
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteDataSourceResponse AWS API Documentation
|
1384
1623
|
#
|
1385
1624
|
class DeleteDataSourceResponse < Struct.new(
|
1386
|
-
:knowledge_base_id,
|
1387
1625
|
:data_source_id,
|
1626
|
+
:knowledge_base_id,
|
1388
1627
|
:status)
|
1389
1628
|
SENSITIVE = []
|
1390
1629
|
include Aws::Structure
|
1391
1630
|
end
|
1392
1631
|
|
1393
1632
|
# @!attribute [rw] knowledge_base_id
|
1394
|
-
#
|
1633
|
+
# The unique identifier of the knowledge base to delete.
|
1395
1634
|
# @return [String]
|
1396
1635
|
#
|
1397
1636
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteKnowledgeBaseRequest AWS API Documentation
|
@@ -1403,11 +1642,12 @@ module Aws::BedrockAgent
|
|
1403
1642
|
end
|
1404
1643
|
|
1405
1644
|
# @!attribute [rw] knowledge_base_id
|
1406
|
-
#
|
1645
|
+
# The unique identifier of the knowledge base that was deleted.
|
1407
1646
|
# @return [String]
|
1408
1647
|
#
|
1409
1648
|
# @!attribute [rw] status
|
1410
|
-
# The status of
|
1649
|
+
# The status of the knowledge base and whether it has been
|
1650
|
+
# successfully deleted.
|
1411
1651
|
# @return [String]
|
1412
1652
|
#
|
1413
1653
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteKnowledgeBaseResponse AWS API Documentation
|
@@ -1419,19 +1659,18 @@ module Aws::BedrockAgent
|
|
1419
1659
|
include Aws::Structure
|
1420
1660
|
end
|
1421
1661
|
|
1422
|
-
# Disassociate Agent Knowledge Base Request
|
1423
|
-
#
|
1424
1662
|
# @!attribute [rw] agent_id
|
1425
|
-
#
|
1663
|
+
# The unique identifier of the agent from which to disassociate the
|
1664
|
+
# knowledge base.
|
1426
1665
|
# @return [String]
|
1427
1666
|
#
|
1428
1667
|
# @!attribute [rw] agent_version
|
1429
|
-
#
|
1668
|
+
# The version of the agent from which to disassociate the knowledge
|
1669
|
+
# base.
|
1430
1670
|
# @return [String]
|
1431
1671
|
#
|
1432
1672
|
# @!attribute [rw] knowledge_base_id
|
1433
|
-
#
|
1434
|
-
# to an Agent
|
1673
|
+
# The unique identifier of the knowledge base to disassociate.
|
1435
1674
|
# @return [String]
|
1436
1675
|
#
|
1437
1676
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBaseRequest AWS API Documentation
|
@@ -1444,20 +1683,19 @@ module Aws::BedrockAgent
|
|
1444
1683
|
include Aws::Structure
|
1445
1684
|
end
|
1446
1685
|
|
1447
|
-
# Disassociate Agent Knowledge Base Response
|
1448
|
-
#
|
1449
1686
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBaseResponse AWS API Documentation
|
1450
1687
|
#
|
1451
1688
|
class DisassociateAgentKnowledgeBaseResponse < Aws::EmptyStructure; end
|
1452
1689
|
|
1453
|
-
#
|
1690
|
+
# Configurations for when you choose fixed-size chunking. If you set the
|
1691
|
+
# `chunkingStrategy` as `NONE`, exclude this field.
|
1454
1692
|
#
|
1455
1693
|
# @!attribute [rw] max_tokens
|
1456
|
-
# The maximum number of tokens
|
1694
|
+
# The maximum number of tokens to include in a chunk.
|
1457
1695
|
# @return [Integer]
|
1458
1696
|
#
|
1459
1697
|
# @!attribute [rw] overlap_percentage
|
1460
|
-
# The overlap
|
1698
|
+
# The percentage of overlap between adjacent chunks of a data source.
|
1461
1699
|
# @return [Integer]
|
1462
1700
|
#
|
1463
1701
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FixedSizeChunkingConfiguration AWS API Documentation
|
@@ -1469,35 +1707,31 @@ module Aws::BedrockAgent
|
|
1469
1707
|
include Aws::Structure
|
1470
1708
|
end
|
1471
1709
|
|
1472
|
-
#
|
1710
|
+
# @!attribute [rw] action_group_id
|
1711
|
+
# The unique identifier of the action group for which to get
|
1712
|
+
# information.
|
1713
|
+
# @return [String]
|
1473
1714
|
#
|
1474
1715
|
# @!attribute [rw] agent_id
|
1475
|
-
#
|
1716
|
+
# The unique identifier of the agent that the action group belongs to.
|
1476
1717
|
# @return [String]
|
1477
1718
|
#
|
1478
1719
|
# @!attribute [rw] agent_version
|
1479
|
-
#
|
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
|
1720
|
+
# The version of the agent that the action group belongs to.
|
1485
1721
|
# @return [String]
|
1486
1722
|
#
|
1487
1723
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentActionGroupRequest AWS API Documentation
|
1488
1724
|
#
|
1489
1725
|
class GetAgentActionGroupRequest < Struct.new(
|
1726
|
+
:action_group_id,
|
1490
1727
|
:agent_id,
|
1491
|
-
:agent_version
|
1492
|
-
:action_group_id)
|
1728
|
+
:agent_version)
|
1493
1729
|
SENSITIVE = []
|
1494
1730
|
include Aws::Structure
|
1495
1731
|
end
|
1496
1732
|
|
1497
|
-
# Get Action Group Response
|
1498
|
-
#
|
1499
1733
|
# @!attribute [rw] agent_action_group
|
1500
|
-
# Contains
|
1734
|
+
# Contains details about the action group.
|
1501
1735
|
# @return [Types::AgentActionGroup]
|
1502
1736
|
#
|
1503
1737
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentActionGroupResponse AWS API Documentation
|
@@ -1508,29 +1742,26 @@ module Aws::BedrockAgent
|
|
1508
1742
|
include Aws::Structure
|
1509
1743
|
end
|
1510
1744
|
|
1511
|
-
#
|
1512
|
-
#
|
1513
|
-
# @!attribute [rw] agent_id
|
1514
|
-
# Id generated at the server side when an Agent is created
|
1745
|
+
# @!attribute [rw] agent_alias_id
|
1746
|
+
# The unique identifier of the alias for which to get information.
|
1515
1747
|
# @return [String]
|
1516
1748
|
#
|
1517
|
-
# @!attribute [rw]
|
1518
|
-
#
|
1749
|
+
# @!attribute [rw] agent_id
|
1750
|
+
# The unique identifier of the agent to which the alias to get
|
1751
|
+
# information belongs.
|
1519
1752
|
# @return [String]
|
1520
1753
|
#
|
1521
1754
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentAliasRequest AWS API Documentation
|
1522
1755
|
#
|
1523
1756
|
class GetAgentAliasRequest < Struct.new(
|
1524
|
-
:
|
1525
|
-
:
|
1757
|
+
:agent_alias_id,
|
1758
|
+
:agent_id)
|
1526
1759
|
SENSITIVE = []
|
1527
1760
|
include Aws::Structure
|
1528
1761
|
end
|
1529
1762
|
|
1530
|
-
# Get Agent Alias Response
|
1531
|
-
#
|
1532
1763
|
# @!attribute [rw] agent_alias
|
1533
|
-
# Contains
|
1764
|
+
# Contains information about the alias.
|
1534
1765
|
# @return [Types::AgentAlias]
|
1535
1766
|
#
|
1536
1767
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentAliasResponse AWS API Documentation
|
@@ -1541,18 +1772,19 @@ module Aws::BedrockAgent
|
|
1541
1772
|
include Aws::Structure
|
1542
1773
|
end
|
1543
1774
|
|
1544
|
-
# Get Agent Knowledge Base Request
|
1545
|
-
#
|
1546
1775
|
# @!attribute [rw] agent_id
|
1547
|
-
#
|
1776
|
+
# The unique identifier of the agent with which the knowledge base is
|
1777
|
+
# associated.
|
1548
1778
|
# @return [String]
|
1549
1779
|
#
|
1550
1780
|
# @!attribute [rw] agent_version
|
1551
|
-
#
|
1781
|
+
# The version of the agent with which the knowledge base is
|
1782
|
+
# associated.
|
1552
1783
|
# @return [String]
|
1553
1784
|
#
|
1554
1785
|
# @!attribute [rw] knowledge_base_id
|
1555
|
-
#
|
1786
|
+
# The unique identifier of the knowledge base associated with the
|
1787
|
+
# agent.
|
1556
1788
|
# @return [String]
|
1557
1789
|
#
|
1558
1790
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentKnowledgeBaseRequest AWS API Documentation
|
@@ -1565,10 +1797,8 @@ module Aws::BedrockAgent
|
|
1565
1797
|
include Aws::Structure
|
1566
1798
|
end
|
1567
1799
|
|
1568
|
-
# Get Agent Knowledge Base Response
|
1569
|
-
#
|
1570
1800
|
# @!attribute [rw] agent_knowledge_base
|
1571
|
-
# Contains
|
1801
|
+
# Contains details about a knowledge base attached to an agent.
|
1572
1802
|
# @return [Types::AgentKnowledgeBase]
|
1573
1803
|
#
|
1574
1804
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentKnowledgeBaseResponse AWS API Documentation
|
@@ -1579,10 +1809,8 @@ module Aws::BedrockAgent
|
|
1579
1809
|
include Aws::Structure
|
1580
1810
|
end
|
1581
1811
|
|
1582
|
-
# Get Agent Request
|
1583
|
-
#
|
1584
1812
|
# @!attribute [rw] agent_id
|
1585
|
-
#
|
1813
|
+
# The unique identifier of the agent.
|
1586
1814
|
# @return [String]
|
1587
1815
|
#
|
1588
1816
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentRequest AWS API Documentation
|
@@ -1593,10 +1821,8 @@ module Aws::BedrockAgent
|
|
1593
1821
|
include Aws::Structure
|
1594
1822
|
end
|
1595
1823
|
|
1596
|
-
# Get Agent Response
|
1597
|
-
#
|
1598
1824
|
# @!attribute [rw] agent
|
1599
|
-
# Contains
|
1825
|
+
# Contains details about the agent.
|
1600
1826
|
# @return [Types::Agent]
|
1601
1827
|
#
|
1602
1828
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentResponse AWS API Documentation
|
@@ -1607,14 +1833,12 @@ module Aws::BedrockAgent
|
|
1607
1833
|
include Aws::Structure
|
1608
1834
|
end
|
1609
1835
|
|
1610
|
-
# Get Agent Version Request
|
1611
|
-
#
|
1612
1836
|
# @!attribute [rw] agent_id
|
1613
|
-
#
|
1837
|
+
# The unique identifier of the agent.
|
1614
1838
|
# @return [String]
|
1615
1839
|
#
|
1616
1840
|
# @!attribute [rw] agent_version
|
1617
|
-
#
|
1841
|
+
# The version of the agent.
|
1618
1842
|
# @return [String]
|
1619
1843
|
#
|
1620
1844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentVersionRequest AWS API Documentation
|
@@ -1626,10 +1850,8 @@ module Aws::BedrockAgent
|
|
1626
1850
|
include Aws::Structure
|
1627
1851
|
end
|
1628
1852
|
|
1629
|
-
# Get Agent Version Response
|
1630
|
-
#
|
1631
1853
|
# @!attribute [rw] agent_version
|
1632
|
-
# Contains the
|
1854
|
+
# Contains details about the version of the agent.
|
1633
1855
|
# @return [Types::AgentVersion]
|
1634
1856
|
#
|
1635
1857
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentVersionResponse AWS API Documentation
|
@@ -1640,25 +1862,26 @@ module Aws::BedrockAgent
|
|
1640
1862
|
include Aws::Structure
|
1641
1863
|
end
|
1642
1864
|
|
1643
|
-
# @!attribute [rw]
|
1644
|
-
#
|
1865
|
+
# @!attribute [rw] data_source_id
|
1866
|
+
# The unique identifier of the data source.
|
1645
1867
|
# @return [String]
|
1646
1868
|
#
|
1647
|
-
# @!attribute [rw]
|
1648
|
-
#
|
1869
|
+
# @!attribute [rw] knowledge_base_id
|
1870
|
+
# The unique identifier of the knowledge base that the data source was
|
1871
|
+
# added to.
|
1649
1872
|
# @return [String]
|
1650
1873
|
#
|
1651
1874
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetDataSourceRequest AWS API Documentation
|
1652
1875
|
#
|
1653
1876
|
class GetDataSourceRequest < Struct.new(
|
1654
|
-
:
|
1655
|
-
:
|
1877
|
+
:data_source_id,
|
1878
|
+
:knowledge_base_id)
|
1656
1879
|
SENSITIVE = []
|
1657
1880
|
include Aws::Structure
|
1658
1881
|
end
|
1659
1882
|
|
1660
1883
|
# @!attribute [rw] data_source
|
1661
|
-
# Contains
|
1884
|
+
# Contains details about the data source.
|
1662
1885
|
# @return [Types::DataSource]
|
1663
1886
|
#
|
1664
1887
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetDataSourceResponse AWS API Documentation
|
@@ -1669,30 +1892,31 @@ module Aws::BedrockAgent
|
|
1669
1892
|
include Aws::Structure
|
1670
1893
|
end
|
1671
1894
|
|
1672
|
-
# @!attribute [rw] knowledge_base_id
|
1673
|
-
# Identifier for a resource.
|
1674
|
-
# @return [String]
|
1675
|
-
#
|
1676
1895
|
# @!attribute [rw] data_source_id
|
1677
|
-
#
|
1896
|
+
# The unique identifier of the data source in the ingestion job.
|
1678
1897
|
# @return [String]
|
1679
1898
|
#
|
1680
1899
|
# @!attribute [rw] ingestion_job_id
|
1681
|
-
#
|
1900
|
+
# The unique identifier of the ingestion job.
|
1901
|
+
# @return [String]
|
1902
|
+
#
|
1903
|
+
# @!attribute [rw] knowledge_base_id
|
1904
|
+
# The unique identifier of the knowledge base for which the ingestion
|
1905
|
+
# job applies.
|
1682
1906
|
# @return [String]
|
1683
1907
|
#
|
1684
1908
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJobRequest AWS API Documentation
|
1685
1909
|
#
|
1686
1910
|
class GetIngestionJobRequest < Struct.new(
|
1687
|
-
:knowledge_base_id,
|
1688
1911
|
:data_source_id,
|
1689
|
-
:ingestion_job_id
|
1912
|
+
:ingestion_job_id,
|
1913
|
+
:knowledge_base_id)
|
1690
1914
|
SENSITIVE = []
|
1691
1915
|
include Aws::Structure
|
1692
1916
|
end
|
1693
1917
|
|
1694
1918
|
# @!attribute [rw] ingestion_job
|
1695
|
-
# Contains
|
1919
|
+
# Contains details about the ingestion job.
|
1696
1920
|
# @return [Types::IngestionJob]
|
1697
1921
|
#
|
1698
1922
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJobResponse AWS API Documentation
|
@@ -1704,7 +1928,8 @@ module Aws::BedrockAgent
|
|
1704
1928
|
end
|
1705
1929
|
|
1706
1930
|
# @!attribute [rw] knowledge_base_id
|
1707
|
-
#
|
1931
|
+
# The unique identifier of the knowledge base for which to get
|
1932
|
+
# information.
|
1708
1933
|
# @return [String]
|
1709
1934
|
#
|
1710
1935
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBaseRequest AWS API Documentation
|
@@ -1716,7 +1941,7 @@ module Aws::BedrockAgent
|
|
1716
1941
|
end
|
1717
1942
|
|
1718
1943
|
# @!attribute [rw] knowledge_base
|
1719
|
-
# Contains
|
1944
|
+
# Contains details about the knowledge base.
|
1720
1945
|
# @return [Types::KnowledgeBase]
|
1721
1946
|
#
|
1722
1947
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBaseResponse AWS API Documentation
|
@@ -1727,106 +1952,143 @@ module Aws::BedrockAgent
|
|
1727
1952
|
include Aws::Structure
|
1728
1953
|
end
|
1729
1954
|
|
1730
|
-
#
|
1955
|
+
# Contains inference parameters to use when the agent invokes a
|
1956
|
+
# foundation model in the part of the agent sequence defined by the
|
1957
|
+
# `promptType`. For more information, see [Inference parameters for
|
1958
|
+
# foundation models][1].
|
1731
1959
|
#
|
1732
|
-
# @!attribute [rw] temperature
|
1733
|
-
# Controls randomness, higher values increase diversity
|
1734
|
-
# @return [Float]
|
1735
1960
|
#
|
1736
|
-
# @!attribute [rw] top_p
|
1737
|
-
# Cumulative probability cutoff for token selection
|
1738
|
-
# @return [Float]
|
1739
1961
|
#
|
1740
|
-
#
|
1741
|
-
# Sample from the k most likely next tokens
|
1742
|
-
# @return [Integer]
|
1962
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html
|
1743
1963
|
#
|
1744
1964
|
# @!attribute [rw] maximum_length
|
1745
|
-
#
|
1965
|
+
# The maximum number of tokens to allow in the generated response.
|
1746
1966
|
# @return [Integer]
|
1747
1967
|
#
|
1748
1968
|
# @!attribute [rw] stop_sequences
|
1749
|
-
#
|
1969
|
+
# A list of stop sequences. A stop sequence is a sequence of
|
1970
|
+
# characters that causes the model to stop generating the response.
|
1750
1971
|
# @return [Array<String>]
|
1751
1972
|
#
|
1973
|
+
# @!attribute [rw] temperature
|
1974
|
+
# The likelihood of the model selecting higher-probability options
|
1975
|
+
# while generating a response. A lower value makes the model more
|
1976
|
+
# likely to choose higher-probability options, while a higher value
|
1977
|
+
# makes the model more likely to choose lower-probability options.
|
1978
|
+
# @return [Float]
|
1979
|
+
#
|
1980
|
+
# @!attribute [rw] top_k
|
1981
|
+
# While generating a response, the model determines the probability of
|
1982
|
+
# the following token at each point of generation. The value that you
|
1983
|
+
# set for `topK` is the number of most-likely candidates from which
|
1984
|
+
# the model chooses the next token in the sequence. For example, if
|
1985
|
+
# you set `topK` to 50, the model selects the next token from among
|
1986
|
+
# the top 50 most likely choices.
|
1987
|
+
# @return [Integer]
|
1988
|
+
#
|
1989
|
+
# @!attribute [rw] top_p
|
1990
|
+
# While generating a response, the model determines the probability of
|
1991
|
+
# the following token at each point of generation. The value that you
|
1992
|
+
# set for `Top P` determines the number of most-likely candidates from
|
1993
|
+
# which the model chooses the next token in the sequence. For example,
|
1994
|
+
# if you set `topP` to 80, the model only selects the next token from
|
1995
|
+
# the top 80% of the probability distribution of next tokens.
|
1996
|
+
# @return [Float]
|
1997
|
+
#
|
1752
1998
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/InferenceConfiguration AWS API Documentation
|
1753
1999
|
#
|
1754
2000
|
class InferenceConfiguration < Struct.new(
|
2001
|
+
:maximum_length,
|
2002
|
+
:stop_sequences,
|
1755
2003
|
:temperature,
|
1756
|
-
:top_p,
|
1757
2004
|
:top_k,
|
1758
|
-
:
|
1759
|
-
:stop_sequences)
|
2005
|
+
:top_p)
|
1760
2006
|
SENSITIVE = []
|
1761
2007
|
include Aws::Structure
|
1762
2008
|
end
|
1763
2009
|
|
1764
|
-
# Contains
|
2010
|
+
# Contains details about an ingestion job, which converts a data source
|
2011
|
+
# to embeddings for a vector store in knowledge base.
|
1765
2012
|
#
|
1766
|
-
#
|
1767
|
-
#
|
1768
|
-
#
|
2013
|
+
# This data type is used in the following API operations:
|
2014
|
+
#
|
2015
|
+
# * [StartIngestionJob response][1]
|
2016
|
+
#
|
2017
|
+
# * [GetIngestionJob response][2]
|
2018
|
+
#
|
2019
|
+
# * [ListIngestionJob response][3]
|
2020
|
+
#
|
2021
|
+
#
|
2022
|
+
#
|
2023
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_StartIngestionJob.html#API_agent_StartIngestionJob_ResponseSyntax
|
2024
|
+
# [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetIngestionJob.html#API_agent_GetIngestionJob_ResponseSyntax
|
2025
|
+
# [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJob.html#API_agent_ListIngestionJob_ResponseSyntax
|
1769
2026
|
#
|
1770
2027
|
# @!attribute [rw] data_source_id
|
1771
|
-
#
|
2028
|
+
# The unique identifier of the ingested data source.
|
1772
2029
|
# @return [String]
|
1773
2030
|
#
|
1774
|
-
# @!attribute [rw]
|
1775
|
-
#
|
2031
|
+
# @!attribute [rw] description
|
2032
|
+
# The description of the ingestion job.
|
1776
2033
|
# @return [String]
|
1777
2034
|
#
|
1778
|
-
# @!attribute [rw]
|
1779
|
-
#
|
2035
|
+
# @!attribute [rw] failure_reasons
|
2036
|
+
# A list of reasons that the ingestion job failed.
|
2037
|
+
# @return [Array<String>]
|
2038
|
+
#
|
2039
|
+
# @!attribute [rw] ingestion_job_id
|
2040
|
+
# The unique identifier of the ingestion job.
|
1780
2041
|
# @return [String]
|
1781
2042
|
#
|
1782
|
-
# @!attribute [rw]
|
1783
|
-
# The
|
2043
|
+
# @!attribute [rw] knowledge_base_id
|
2044
|
+
# The unique identifier of the knowledge base to which the data source
|
2045
|
+
# is being added.
|
1784
2046
|
# @return [String]
|
1785
2047
|
#
|
2048
|
+
# @!attribute [rw] started_at
|
2049
|
+
# The time at which the ingestion job started.
|
2050
|
+
# @return [Time]
|
2051
|
+
#
|
1786
2052
|
# @!attribute [rw] statistics
|
1787
|
-
#
|
2053
|
+
# Contains statistics about the ingestion job.
|
1788
2054
|
# @return [Types::IngestionJobStatistics]
|
1789
2055
|
#
|
1790
|
-
# @!attribute [rw]
|
1791
|
-
#
|
1792
|
-
# @return [
|
1793
|
-
#
|
1794
|
-
# @!attribute [rw] started_at
|
1795
|
-
# Time Stamp.
|
1796
|
-
# @return [Time]
|
2056
|
+
# @!attribute [rw] status
|
2057
|
+
# The status of the ingestion job.
|
2058
|
+
# @return [String]
|
1797
2059
|
#
|
1798
2060
|
# @!attribute [rw] updated_at
|
1799
|
-
#
|
2061
|
+
# The time at which the ingestion job was last updated.
|
1800
2062
|
# @return [Time]
|
1801
2063
|
#
|
1802
2064
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJob AWS API Documentation
|
1803
2065
|
#
|
1804
2066
|
class IngestionJob < Struct.new(
|
1805
|
-
:knowledge_base_id,
|
1806
2067
|
:data_source_id,
|
1807
|
-
:ingestion_job_id,
|
1808
2068
|
:description,
|
1809
|
-
:status,
|
1810
|
-
:statistics,
|
1811
2069
|
:failure_reasons,
|
2070
|
+
:ingestion_job_id,
|
2071
|
+
:knowledge_base_id,
|
1812
2072
|
:started_at,
|
2073
|
+
:statistics,
|
2074
|
+
:status,
|
1813
2075
|
:updated_at)
|
1814
2076
|
SENSITIVE = []
|
1815
2077
|
include Aws::Structure
|
1816
2078
|
end
|
1817
2079
|
|
1818
|
-
#
|
2080
|
+
# Defines a filter by which to filter the results.
|
1819
2081
|
#
|
1820
2082
|
# @!attribute [rw] attribute
|
1821
|
-
# The
|
2083
|
+
# The attribute by which to filter the results.
|
1822
2084
|
# @return [String]
|
1823
2085
|
#
|
1824
2086
|
# @!attribute [rw] operator
|
1825
|
-
# The
|
2087
|
+
# The operation to carry out between the attribute and the values.
|
1826
2088
|
# @return [String]
|
1827
2089
|
#
|
1828
2090
|
# @!attribute [rw] values
|
1829
|
-
#
|
2091
|
+
# A list of values for the attribute.
|
1830
2092
|
# @return [Array<String>]
|
1831
2093
|
#
|
1832
2094
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJobFilter AWS API Documentation
|
@@ -1839,14 +2101,14 @@ module Aws::BedrockAgent
|
|
1839
2101
|
include Aws::Structure
|
1840
2102
|
end
|
1841
2103
|
|
1842
|
-
#
|
2104
|
+
# Parameters by which to sort the results.
|
1843
2105
|
#
|
1844
2106
|
# @!attribute [rw] attribute
|
1845
|
-
# The
|
2107
|
+
# The attribute by which to sort the results.
|
1846
2108
|
# @return [String]
|
1847
2109
|
#
|
1848
2110
|
# @!attribute [rw] order
|
1849
|
-
#
|
2111
|
+
# The order by which to sort the results.
|
1850
2112
|
# @return [String]
|
1851
2113
|
#
|
1852
2114
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJobSortBy AWS API Documentation
|
@@ -1858,94 +2120,107 @@ module Aws::BedrockAgent
|
|
1858
2120
|
include Aws::Structure
|
1859
2121
|
end
|
1860
2122
|
|
1861
|
-
#
|
2123
|
+
# Contains the statistics for the ingestion job.
|
2124
|
+
#
|
2125
|
+
# @!attribute [rw] number_of_documents_deleted
|
2126
|
+
# The number of source documents that was deleted.
|
2127
|
+
# @return [Integer]
|
2128
|
+
#
|
2129
|
+
# @!attribute [rw] number_of_documents_failed
|
2130
|
+
# The number of source documents that failed to be ingested.
|
2131
|
+
# @return [Integer]
|
1862
2132
|
#
|
1863
2133
|
# @!attribute [rw] number_of_documents_scanned
|
1864
|
-
#
|
2134
|
+
# The total number of source documents that were scanned. Includes
|
2135
|
+
# new, updated, and unchanged documents.
|
1865
2136
|
# @return [Integer]
|
1866
2137
|
#
|
1867
|
-
# @!attribute [rw]
|
1868
|
-
#
|
2138
|
+
# @!attribute [rw] number_of_metadata_documents_modified
|
2139
|
+
# The number of metadata files that were updated or deleted.
|
1869
2140
|
# @return [Integer]
|
1870
2141
|
#
|
1871
|
-
# @!attribute [rw]
|
1872
|
-
#
|
2142
|
+
# @!attribute [rw] number_of_metadata_documents_scanned
|
2143
|
+
# The total number of metadata files that were scanned. Includes new,
|
2144
|
+
# updated, and unchanged files.
|
1873
2145
|
# @return [Integer]
|
1874
2146
|
#
|
1875
|
-
# @!attribute [rw]
|
1876
|
-
#
|
2147
|
+
# @!attribute [rw] number_of_modified_documents_indexed
|
2148
|
+
# The number of modified source documents in the data source that were
|
2149
|
+
# successfully indexed.
|
1877
2150
|
# @return [Integer]
|
1878
2151
|
#
|
1879
|
-
# @!attribute [rw]
|
1880
|
-
#
|
2152
|
+
# @!attribute [rw] number_of_new_documents_indexed
|
2153
|
+
# The number of new source documents in the data source that were
|
2154
|
+
# successfully indexed.
|
1881
2155
|
# @return [Integer]
|
1882
2156
|
#
|
1883
2157
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJobStatistics AWS API Documentation
|
1884
2158
|
#
|
1885
2159
|
class IngestionJobStatistics < Struct.new(
|
2160
|
+
:number_of_documents_deleted,
|
2161
|
+
:number_of_documents_failed,
|
1886
2162
|
:number_of_documents_scanned,
|
1887
|
-
:
|
2163
|
+
:number_of_metadata_documents_modified,
|
2164
|
+
:number_of_metadata_documents_scanned,
|
1888
2165
|
:number_of_modified_documents_indexed,
|
1889
|
-
:
|
1890
|
-
:number_of_documents_failed)
|
2166
|
+
:number_of_new_documents_indexed)
|
1891
2167
|
SENSITIVE = []
|
1892
2168
|
include Aws::Structure
|
1893
2169
|
end
|
1894
2170
|
|
1895
|
-
#
|
1896
|
-
#
|
1897
|
-
# @!attribute [rw] knowledge_base_id
|
1898
|
-
# Identifier for a resource.
|
1899
|
-
# @return [String]
|
2171
|
+
# Contains details about an ingestion job.
|
1900
2172
|
#
|
1901
2173
|
# @!attribute [rw] data_source_id
|
1902
|
-
#
|
2174
|
+
# The unique identifier of the data source in the ingestion job.
|
1903
2175
|
# @return [String]
|
1904
2176
|
#
|
1905
|
-
# @!attribute [rw]
|
1906
|
-
#
|
2177
|
+
# @!attribute [rw] description
|
2178
|
+
# The description of the ingestion job.
|
1907
2179
|
# @return [String]
|
1908
2180
|
#
|
1909
|
-
# @!attribute [rw]
|
1910
|
-
#
|
2181
|
+
# @!attribute [rw] ingestion_job_id
|
2182
|
+
# The unique identifier of the ingestion job.
|
1911
2183
|
# @return [String]
|
1912
2184
|
#
|
1913
|
-
# @!attribute [rw]
|
1914
|
-
# The
|
2185
|
+
# @!attribute [rw] knowledge_base_id
|
2186
|
+
# The unique identifier of the knowledge base to which the data source
|
2187
|
+
# is added.
|
1915
2188
|
# @return [String]
|
1916
2189
|
#
|
1917
2190
|
# @!attribute [rw] started_at
|
1918
|
-
#
|
1919
|
-
# @return [Time]
|
1920
|
-
#
|
1921
|
-
# @!attribute [rw] updated_at
|
1922
|
-
# Time Stamp.
|
2191
|
+
# The time at which the ingestion job was started.
|
1923
2192
|
# @return [Time]
|
1924
2193
|
#
|
1925
2194
|
# @!attribute [rw] statistics
|
1926
|
-
#
|
2195
|
+
# Contains statistics for the ingestion job.
|
1927
2196
|
# @return [Types::IngestionJobStatistics]
|
1928
2197
|
#
|
2198
|
+
# @!attribute [rw] status
|
2199
|
+
# The status of the ingestion job.
|
2200
|
+
# @return [String]
|
2201
|
+
#
|
2202
|
+
# @!attribute [rw] updated_at
|
2203
|
+
# The time at which the ingestion job was last updated.
|
2204
|
+
# @return [Time]
|
2205
|
+
#
|
1929
2206
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJobSummary AWS API Documentation
|
1930
2207
|
#
|
1931
2208
|
class IngestionJobSummary < Struct.new(
|
1932
|
-
:knowledge_base_id,
|
1933
2209
|
:data_source_id,
|
1934
|
-
:ingestion_job_id,
|
1935
2210
|
:description,
|
1936
|
-
:
|
2211
|
+
:ingestion_job_id,
|
2212
|
+
:knowledge_base_id,
|
1937
2213
|
:started_at,
|
1938
|
-
:
|
1939
|
-
:
|
2214
|
+
:statistics,
|
2215
|
+
:status,
|
2216
|
+
:updated_at)
|
1940
2217
|
SENSITIVE = []
|
1941
2218
|
include Aws::Structure
|
1942
2219
|
end
|
1943
2220
|
|
1944
|
-
#
|
1945
|
-
# processing of request
|
2221
|
+
# An internal server error occurred. Retry your request.
|
1946
2222
|
#
|
1947
2223
|
# @!attribute [rw] message
|
1948
|
-
# Non Blank String
|
1949
2224
|
# @return [String]
|
1950
2225
|
#
|
1951
2226
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/InternalServerException AWS API Documentation
|
@@ -1956,79 +2231,96 @@ module Aws::BedrockAgent
|
|
1956
2231
|
include Aws::Structure
|
1957
2232
|
end
|
1958
2233
|
|
1959
|
-
# Contains
|
2234
|
+
# Contains information about a knowledge base.
|
1960
2235
|
#
|
1961
|
-
# @!attribute [rw]
|
1962
|
-
#
|
1963
|
-
# @return [
|
2236
|
+
# @!attribute [rw] created_at
|
2237
|
+
# The time at which the knowledge base was created.
|
2238
|
+
# @return [Time]
|
1964
2239
|
#
|
1965
|
-
# @!attribute [rw]
|
1966
|
-
#
|
2240
|
+
# @!attribute [rw] description
|
2241
|
+
# The description of the knowledge base.
|
1967
2242
|
# @return [String]
|
1968
2243
|
#
|
2244
|
+
# @!attribute [rw] failure_reasons
|
2245
|
+
# A list of reasons that the API operation on the knowledge base
|
2246
|
+
# failed.
|
2247
|
+
# @return [Array<String>]
|
2248
|
+
#
|
1969
2249
|
# @!attribute [rw] knowledge_base_arn
|
1970
|
-
# ARN of
|
2250
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
1971
2251
|
# @return [String]
|
1972
2252
|
#
|
1973
|
-
# @!attribute [rw]
|
1974
|
-
#
|
2253
|
+
# @!attribute [rw] knowledge_base_configuration
|
2254
|
+
# Contains details about the embeddings configuration of the knowledge
|
2255
|
+
# base.
|
2256
|
+
# @return [Types::KnowledgeBaseConfiguration]
|
2257
|
+
#
|
2258
|
+
# @!attribute [rw] knowledge_base_id
|
2259
|
+
# The unique identifier of the knowledge base.
|
2260
|
+
# @return [String]
|
2261
|
+
#
|
2262
|
+
# @!attribute [rw] name
|
2263
|
+
# The name of the knowledge base.
|
1975
2264
|
# @return [String]
|
1976
2265
|
#
|
1977
2266
|
# @!attribute [rw] role_arn
|
1978
|
-
# ARN of
|
2267
|
+
# The Amazon Resource Name (ARN) of the IAM role with permissions to
|
2268
|
+
# invoke API operations on the knowledge base.
|
1979
2269
|
# @return [String]
|
1980
2270
|
#
|
1981
|
-
# @!attribute [rw]
|
1982
|
-
#
|
1983
|
-
#
|
2271
|
+
# @!attribute [rw] status
|
2272
|
+
# The status of the knowledge base. The following statuses are
|
2273
|
+
# possible:
|
1984
2274
|
#
|
1985
|
-
#
|
1986
|
-
# Configures the physical storage of ingested data in a knowledge
|
1987
|
-
# base.
|
1988
|
-
# @return [Types::StorageConfiguration]
|
2275
|
+
# * CREATING – The knowledge base is being created.
|
1989
2276
|
#
|
1990
|
-
#
|
1991
|
-
#
|
2277
|
+
# * ACTIVE – The knowledge base is ready to be queried.
|
2278
|
+
#
|
2279
|
+
# * DELETING – The knowledge base is being deleted.
|
2280
|
+
#
|
2281
|
+
# * UPDATING – The knowledge base is being updated.
|
2282
|
+
#
|
2283
|
+
# * FAILED – The knowledge base API operation failed.
|
1992
2284
|
# @return [String]
|
1993
2285
|
#
|
1994
|
-
# @!attribute [rw]
|
1995
|
-
#
|
1996
|
-
#
|
2286
|
+
# @!attribute [rw] storage_configuration
|
2287
|
+
# Contains details about the storage configuration of the knowledge
|
2288
|
+
# base.
|
2289
|
+
# @return [Types::StorageConfiguration]
|
1997
2290
|
#
|
1998
2291
|
# @!attribute [rw] updated_at
|
1999
|
-
#
|
2292
|
+
# The time at which the knowledge base was last updated.
|
2000
2293
|
# @return [Time]
|
2001
2294
|
#
|
2002
|
-
# @!attribute [rw] failure_reasons
|
2003
|
-
# Failure Reasons for Error.
|
2004
|
-
# @return [Array<String>]
|
2005
|
-
#
|
2006
2295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBase AWS API Documentation
|
2007
2296
|
#
|
2008
2297
|
class KnowledgeBase < Struct.new(
|
2298
|
+
:created_at,
|
2299
|
+
:description,
|
2300
|
+
:failure_reasons,
|
2301
|
+
:knowledge_base_arn,
|
2302
|
+
:knowledge_base_configuration,
|
2009
2303
|
:knowledge_base_id,
|
2010
2304
|
:name,
|
2011
|
-
:knowledge_base_arn,
|
2012
|
-
:description,
|
2013
2305
|
:role_arn,
|
2014
|
-
:knowledge_base_configuration,
|
2015
|
-
:storage_configuration,
|
2016
2306
|
:status,
|
2017
|
-
:
|
2018
|
-
:updated_at
|
2019
|
-
:failure_reasons)
|
2307
|
+
:storage_configuration,
|
2308
|
+
:updated_at)
|
2020
2309
|
SENSITIVE = []
|
2021
2310
|
include Aws::Structure
|
2022
2311
|
end
|
2023
2312
|
|
2024
|
-
#
|
2313
|
+
# Contains details about the embeddings configuration of the knowledge
|
2314
|
+
# base.
|
2025
2315
|
#
|
2026
2316
|
# @!attribute [rw] type
|
2027
|
-
# The type of
|
2317
|
+
# The type of data that the data source is converted into for the
|
2318
|
+
# knowledge base.
|
2028
2319
|
# @return [String]
|
2029
2320
|
#
|
2030
2321
|
# @!attribute [rw] vector_knowledge_base_configuration
|
2031
|
-
#
|
2322
|
+
# Contains details about the embeddings model that'sused to convert
|
2323
|
+
# the data source.
|
2032
2324
|
# @return [Types::VectorKnowledgeBaseConfiguration]
|
2033
2325
|
#
|
2034
2326
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseConfiguration AWS API Documentation
|
@@ -2040,56 +2332,60 @@ module Aws::BedrockAgent
|
|
2040
2332
|
include Aws::Structure
|
2041
2333
|
end
|
2042
2334
|
|
2043
|
-
#
|
2335
|
+
# Contains details about a knowledge base.
|
2044
2336
|
#
|
2045
|
-
# @!attribute [rw]
|
2046
|
-
#
|
2337
|
+
# @!attribute [rw] description
|
2338
|
+
# The description of the knowledge base.
|
2047
2339
|
# @return [String]
|
2048
2340
|
#
|
2049
|
-
# @!attribute [rw]
|
2050
|
-
#
|
2341
|
+
# @!attribute [rw] knowledge_base_id
|
2342
|
+
# The unique identifier of the knowledge base.
|
2051
2343
|
# @return [String]
|
2052
2344
|
#
|
2053
|
-
# @!attribute [rw]
|
2054
|
-
#
|
2345
|
+
# @!attribute [rw] name
|
2346
|
+
# The name of the knowledge base.
|
2055
2347
|
# @return [String]
|
2056
2348
|
#
|
2057
2349
|
# @!attribute [rw] status
|
2058
|
-
# The status of
|
2350
|
+
# The status of the knowledge base.
|
2059
2351
|
# @return [String]
|
2060
2352
|
#
|
2061
2353
|
# @!attribute [rw] updated_at
|
2062
|
-
#
|
2354
|
+
# The time at which the knowledge base was last updated.
|
2063
2355
|
# @return [Time]
|
2064
2356
|
#
|
2065
2357
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseSummary AWS API Documentation
|
2066
2358
|
#
|
2067
2359
|
class KnowledgeBaseSummary < Struct.new(
|
2360
|
+
:description,
|
2068
2361
|
:knowledge_base_id,
|
2069
2362
|
:name,
|
2070
|
-
:description,
|
2071
2363
|
:status,
|
2072
2364
|
:updated_at)
|
2073
2365
|
SENSITIVE = []
|
2074
2366
|
include Aws::Structure
|
2075
2367
|
end
|
2076
2368
|
|
2077
|
-
# List Action Groups Request
|
2078
|
-
#
|
2079
2369
|
# @!attribute [rw] agent_id
|
2080
|
-
#
|
2370
|
+
# The unique identifier of the agent.
|
2081
2371
|
# @return [String]
|
2082
2372
|
#
|
2083
2373
|
# @!attribute [rw] agent_version
|
2084
|
-
#
|
2374
|
+
# The version of the agent.
|
2085
2375
|
# @return [String]
|
2086
2376
|
#
|
2087
2377
|
# @!attribute [rw] max_results
|
2088
|
-
#
|
2378
|
+
# The maximum number of results to return in the response. If the
|
2379
|
+
# total number of results is greater than this value, use the token
|
2380
|
+
# returned in the response in the `nextToken` field when making
|
2381
|
+
# another request to return the next batch of results.
|
2089
2382
|
# @return [Integer]
|
2090
2383
|
#
|
2091
2384
|
# @!attribute [rw] next_token
|
2092
|
-
#
|
2385
|
+
# If the total number of results is greater than the `maxResults`
|
2386
|
+
# value provided in the request, enter the token returned in the
|
2387
|
+
# `nextToken` field in the response in this field to return the next
|
2388
|
+
# batch of results.
|
2093
2389
|
# @return [String]
|
2094
2390
|
#
|
2095
2391
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentActionGroupsRequest AWS API Documentation
|
@@ -2103,14 +2399,16 @@ module Aws::BedrockAgent
|
|
2103
2399
|
include Aws::Structure
|
2104
2400
|
end
|
2105
2401
|
|
2106
|
-
# List Action Groups Response
|
2107
|
-
#
|
2108
2402
|
# @!attribute [rw] action_group_summaries
|
2109
|
-
#
|
2403
|
+
# A list of objects, each of which contains information about an
|
2404
|
+
# action group.
|
2110
2405
|
# @return [Array<Types::ActionGroupSummary>]
|
2111
2406
|
#
|
2112
2407
|
# @!attribute [rw] next_token
|
2113
|
-
#
|
2408
|
+
# If the total number of results is greater than the `maxResults`
|
2409
|
+
# value provided in the request, use this token when making another
|
2410
|
+
# request in the `nextToken` field to return the next batch of
|
2411
|
+
# results.
|
2114
2412
|
# @return [String]
|
2115
2413
|
#
|
2116
2414
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentActionGroupsResponse AWS API Documentation
|
@@ -2122,18 +2420,22 @@ module Aws::BedrockAgent
|
|
2122
2420
|
include Aws::Structure
|
2123
2421
|
end
|
2124
2422
|
|
2125
|
-
# List Agent Aliases Request
|
2126
|
-
#
|
2127
2423
|
# @!attribute [rw] agent_id
|
2128
|
-
#
|
2424
|
+
# The unique identifier of the agent.
|
2129
2425
|
# @return [String]
|
2130
2426
|
#
|
2131
2427
|
# @!attribute [rw] max_results
|
2132
|
-
#
|
2428
|
+
# The maximum number of results to return in the response. If the
|
2429
|
+
# total number of results is greater than this value, use the token
|
2430
|
+
# returned in the response in the `nextToken` field when making
|
2431
|
+
# another request to return the next batch of results.
|
2133
2432
|
# @return [Integer]
|
2134
2433
|
#
|
2135
2434
|
# @!attribute [rw] next_token
|
2136
|
-
#
|
2435
|
+
# If the total number of results is greater than the `maxResults`
|
2436
|
+
# value provided in the request, enter the token returned in the
|
2437
|
+
# `nextToken` field in the response in this field to return the next
|
2438
|
+
# batch of results.
|
2137
2439
|
# @return [String]
|
2138
2440
|
#
|
2139
2441
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentAliasesRequest AWS API Documentation
|
@@ -2146,14 +2448,16 @@ module Aws::BedrockAgent
|
|
2146
2448
|
include Aws::Structure
|
2147
2449
|
end
|
2148
2450
|
|
2149
|
-
# List Agent Aliases Response
|
2150
|
-
#
|
2151
2451
|
# @!attribute [rw] agent_alias_summaries
|
2152
|
-
#
|
2452
|
+
# A list of objects, each of which contains information about an alias
|
2453
|
+
# of the agent.
|
2153
2454
|
# @return [Array<Types::AgentAliasSummary>]
|
2154
2455
|
#
|
2155
2456
|
# @!attribute [rw] next_token
|
2156
|
-
#
|
2457
|
+
# If the total number of results is greater than the `maxResults`
|
2458
|
+
# value provided in the request, use this token when making another
|
2459
|
+
# request in the `nextToken` field to return the next batch of
|
2460
|
+
# results.
|
2157
2461
|
# @return [String]
|
2158
2462
|
#
|
2159
2463
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentAliasesResponse AWS API Documentation
|
@@ -2165,22 +2469,28 @@ module Aws::BedrockAgent
|
|
2165
2469
|
include Aws::Structure
|
2166
2470
|
end
|
2167
2471
|
|
2168
|
-
# List Agent Knowledge Bases Request
|
2169
|
-
#
|
2170
2472
|
# @!attribute [rw] agent_id
|
2171
|
-
#
|
2473
|
+
# The unique identifier of the agent for which to return information
|
2474
|
+
# about knowledge bases associated with it.
|
2172
2475
|
# @return [String]
|
2173
2476
|
#
|
2174
2477
|
# @!attribute [rw] agent_version
|
2175
|
-
#
|
2478
|
+
# The version of the agent for which to return information about
|
2479
|
+
# knowledge bases associated with it.
|
2176
2480
|
# @return [String]
|
2177
2481
|
#
|
2178
2482
|
# @!attribute [rw] max_results
|
2179
|
-
#
|
2483
|
+
# The maximum number of results to return in the response. If the
|
2484
|
+
# total number of results is greater than this value, use the token
|
2485
|
+
# returned in the response in the `nextToken` field when making
|
2486
|
+
# another request to return the next batch of results.
|
2180
2487
|
# @return [Integer]
|
2181
2488
|
#
|
2182
2489
|
# @!attribute [rw] next_token
|
2183
|
-
#
|
2490
|
+
# If the total number of results is greater than the `maxResults`
|
2491
|
+
# value provided in the request, enter the token returned in the
|
2492
|
+
# `nextToken` field in the response in this field to return the next
|
2493
|
+
# batch of results.
|
2184
2494
|
# @return [String]
|
2185
2495
|
#
|
2186
2496
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentKnowledgeBasesRequest AWS API Documentation
|
@@ -2194,14 +2504,16 @@ module Aws::BedrockAgent
|
|
2194
2504
|
include Aws::Structure
|
2195
2505
|
end
|
2196
2506
|
|
2197
|
-
# List Agent Knowledge Bases Response
|
2198
|
-
#
|
2199
2507
|
# @!attribute [rw] agent_knowledge_base_summaries
|
2200
|
-
#
|
2508
|
+
# A list of objects, each of which contains information about a
|
2509
|
+
# knowledge base associated with the agent.
|
2201
2510
|
# @return [Array<Types::AgentKnowledgeBaseSummary>]
|
2202
2511
|
#
|
2203
2512
|
# @!attribute [rw] next_token
|
2204
|
-
#
|
2513
|
+
# If the total number of results is greater than the `maxResults`
|
2514
|
+
# value provided in the request, use this token when making another
|
2515
|
+
# request in the `nextToken` field to return the next batch of
|
2516
|
+
# results.
|
2205
2517
|
# @return [String]
|
2206
2518
|
#
|
2207
2519
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentKnowledgeBasesResponse AWS API Documentation
|
@@ -2213,18 +2525,22 @@ module Aws::BedrockAgent
|
|
2213
2525
|
include Aws::Structure
|
2214
2526
|
end
|
2215
2527
|
|
2216
|
-
# List Agent Versions Request
|
2217
|
-
#
|
2218
2528
|
# @!attribute [rw] agent_id
|
2219
|
-
#
|
2529
|
+
# The unique identifier of the agent.
|
2220
2530
|
# @return [String]
|
2221
2531
|
#
|
2222
2532
|
# @!attribute [rw] max_results
|
2223
|
-
#
|
2533
|
+
# The maximum number of results to return in the response. If the
|
2534
|
+
# total number of results is greater than this value, use the token
|
2535
|
+
# returned in the response in the `nextToken` field when making
|
2536
|
+
# another request to return the next batch of results.
|
2224
2537
|
# @return [Integer]
|
2225
2538
|
#
|
2226
2539
|
# @!attribute [rw] next_token
|
2227
|
-
#
|
2540
|
+
# If the total number of results is greater than the `maxResults`
|
2541
|
+
# value provided in the request, enter the token returned in the
|
2542
|
+
# `nextToken` field in the response in this field to return the next
|
2543
|
+
# batch of results.
|
2228
2544
|
# @return [String]
|
2229
2545
|
#
|
2230
2546
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentVersionsRequest AWS API Documentation
|
@@ -2237,14 +2553,16 @@ module Aws::BedrockAgent
|
|
2237
2553
|
include Aws::Structure
|
2238
2554
|
end
|
2239
2555
|
|
2240
|
-
# List Agent Versions Response
|
2241
|
-
#
|
2242
2556
|
# @!attribute [rw] agent_version_summaries
|
2243
|
-
#
|
2557
|
+
# A list of objects, each of which contains information about a
|
2558
|
+
# version of the agent.
|
2244
2559
|
# @return [Array<Types::AgentVersionSummary>]
|
2245
2560
|
#
|
2246
2561
|
# @!attribute [rw] next_token
|
2247
|
-
#
|
2562
|
+
# If the total number of results is greater than the `maxResults`
|
2563
|
+
# value provided in the request, use this token when making another
|
2564
|
+
# request in the `nextToken` field to return the next batch of
|
2565
|
+
# results.
|
2248
2566
|
# @return [String]
|
2249
2567
|
#
|
2250
2568
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentVersionsResponse AWS API Documentation
|
@@ -2256,14 +2574,18 @@ module Aws::BedrockAgent
|
|
2256
2574
|
include Aws::Structure
|
2257
2575
|
end
|
2258
2576
|
|
2259
|
-
# List Agent Request
|
2260
|
-
#
|
2261
2577
|
# @!attribute [rw] max_results
|
2262
|
-
#
|
2578
|
+
# The maximum number of results to return in the response. If the
|
2579
|
+
# total number of results is greater than this value, use the token
|
2580
|
+
# returned in the response in the `nextToken` field when making
|
2581
|
+
# another request to return the next batch of results.
|
2263
2582
|
# @return [Integer]
|
2264
2583
|
#
|
2265
2584
|
# @!attribute [rw] next_token
|
2266
|
-
#
|
2585
|
+
# If the total number of results is greater than the `maxResults`
|
2586
|
+
# value provided in the request, enter the token returned in the
|
2587
|
+
# `nextToken` field in the response in this field to return the next
|
2588
|
+
# batch of results.
|
2267
2589
|
# @return [String]
|
2268
2590
|
#
|
2269
2591
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentsRequest AWS API Documentation
|
@@ -2275,14 +2597,16 @@ module Aws::BedrockAgent
|
|
2275
2597
|
include Aws::Structure
|
2276
2598
|
end
|
2277
2599
|
|
2278
|
-
# List Agent Response
|
2279
|
-
#
|
2280
2600
|
# @!attribute [rw] agent_summaries
|
2281
|
-
#
|
2601
|
+
# A list of objects, each of which contains information about an
|
2602
|
+
# agent.
|
2282
2603
|
# @return [Array<Types::AgentSummary>]
|
2283
2604
|
#
|
2284
2605
|
# @!attribute [rw] next_token
|
2285
|
-
#
|
2606
|
+
# If the total number of results is greater than the `maxResults`
|
2607
|
+
# value provided in the request, use this token when making another
|
2608
|
+
# request in the `nextToken` field to return the next batch of
|
2609
|
+
# results.
|
2286
2610
|
# @return [String]
|
2287
2611
|
#
|
2288
2612
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentsResponse AWS API Documentation
|
@@ -2295,15 +2619,22 @@ module Aws::BedrockAgent
|
|
2295
2619
|
end
|
2296
2620
|
|
2297
2621
|
# @!attribute [rw] knowledge_base_id
|
2298
|
-
#
|
2622
|
+
# The unique identifier of the knowledge base for which to return a
|
2623
|
+
# list of information.
|
2299
2624
|
# @return [String]
|
2300
2625
|
#
|
2301
2626
|
# @!attribute [rw] max_results
|
2302
|
-
#
|
2627
|
+
# The maximum number of results to return in the response. If the
|
2628
|
+
# total number of results is greater than this value, use the token
|
2629
|
+
# returned in the response in the `nextToken` field when making
|
2630
|
+
# another request to return the next batch of results.
|
2303
2631
|
# @return [Integer]
|
2304
2632
|
#
|
2305
2633
|
# @!attribute [rw] next_token
|
2306
|
-
#
|
2634
|
+
# If the total number of results is greater than the `maxResults`
|
2635
|
+
# value provided in the request, enter the token returned in the
|
2636
|
+
# `nextToken` field in the response in this field to return the next
|
2637
|
+
# batch of results.
|
2307
2638
|
# @return [String]
|
2308
2639
|
#
|
2309
2640
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListDataSourcesRequest AWS API Documentation
|
@@ -2317,11 +2648,15 @@ module Aws::BedrockAgent
|
|
2317
2648
|
end
|
2318
2649
|
|
2319
2650
|
# @!attribute [rw] data_source_summaries
|
2320
|
-
# list of
|
2651
|
+
# A list of objects, each of which contains information about a data
|
2652
|
+
# source.
|
2321
2653
|
# @return [Array<Types::DataSourceSummary>]
|
2322
2654
|
#
|
2323
2655
|
# @!attribute [rw] next_token
|
2324
|
-
#
|
2656
|
+
# If the total number of results is greater than the `maxResults`
|
2657
|
+
# value provided in the request, use this token when making another
|
2658
|
+
# request in the `nextToken` field to return the next batch of
|
2659
|
+
# results.
|
2325
2660
|
# @return [String]
|
2326
2661
|
#
|
2327
2662
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListDataSourcesResponse AWS API Documentation
|
@@ -2333,49 +2668,61 @@ module Aws::BedrockAgent
|
|
2333
2668
|
include Aws::Structure
|
2334
2669
|
end
|
2335
2670
|
|
2336
|
-
# @!attribute [rw] knowledge_base_id
|
2337
|
-
# Identifier for a resource.
|
2338
|
-
# @return [String]
|
2339
|
-
#
|
2340
2671
|
# @!attribute [rw] data_source_id
|
2341
|
-
#
|
2672
|
+
# The unique identifier of the data source for which to return
|
2673
|
+
# ingestion jobs.
|
2342
2674
|
# @return [String]
|
2343
2675
|
#
|
2344
2676
|
# @!attribute [rw] filters
|
2345
|
-
#
|
2677
|
+
# Contains a definition of a filter for which to filter the results.
|
2346
2678
|
# @return [Array<Types::IngestionJobFilter>]
|
2347
2679
|
#
|
2348
|
-
# @!attribute [rw]
|
2349
|
-
#
|
2350
|
-
#
|
2680
|
+
# @!attribute [rw] knowledge_base_id
|
2681
|
+
# The unique identifier of the knowledge base for which to return
|
2682
|
+
# ingestion jobs.
|
2683
|
+
# @return [String]
|
2351
2684
|
#
|
2352
2685
|
# @!attribute [rw] max_results
|
2353
|
-
#
|
2686
|
+
# The maximum number of results to return in the response. If the
|
2687
|
+
# total number of results is greater than this value, use the token
|
2688
|
+
# returned in the response in the `nextToken` field when making
|
2689
|
+
# another request to return the next batch of results.
|
2354
2690
|
# @return [Integer]
|
2355
2691
|
#
|
2356
2692
|
# @!attribute [rw] next_token
|
2357
|
-
#
|
2693
|
+
# If the total number of results is greater than the `maxResults`
|
2694
|
+
# value provided in the request, enter the token returned in the
|
2695
|
+
# `nextToken` field in the response in this field to return the next
|
2696
|
+
# batch of results.
|
2358
2697
|
# @return [String]
|
2359
2698
|
#
|
2699
|
+
# @!attribute [rw] sort_by
|
2700
|
+
# Contains details about how to sort the results.
|
2701
|
+
# @return [Types::IngestionJobSortBy]
|
2702
|
+
#
|
2360
2703
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListIngestionJobsRequest AWS API Documentation
|
2361
2704
|
#
|
2362
2705
|
class ListIngestionJobsRequest < Struct.new(
|
2363
|
-
:knowledge_base_id,
|
2364
2706
|
:data_source_id,
|
2365
2707
|
:filters,
|
2366
|
-
:
|
2708
|
+
:knowledge_base_id,
|
2367
2709
|
:max_results,
|
2368
|
-
:next_token
|
2710
|
+
:next_token,
|
2711
|
+
:sort_by)
|
2369
2712
|
SENSITIVE = []
|
2370
2713
|
include Aws::Structure
|
2371
2714
|
end
|
2372
2715
|
|
2373
2716
|
# @!attribute [rw] ingestion_job_summaries
|
2374
|
-
#
|
2717
|
+
# A list of objects, each of which contains information about an
|
2718
|
+
# ingestion job.
|
2375
2719
|
# @return [Array<Types::IngestionJobSummary>]
|
2376
2720
|
#
|
2377
2721
|
# @!attribute [rw] next_token
|
2378
|
-
#
|
2722
|
+
# If the total number of results is greater than the `maxResults`
|
2723
|
+
# value provided in the request, use this token when making another
|
2724
|
+
# request in the `nextToken` field to return the next batch of
|
2725
|
+
# results.
|
2379
2726
|
# @return [String]
|
2380
2727
|
#
|
2381
2728
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListIngestionJobsResponse AWS API Documentation
|
@@ -2388,11 +2735,17 @@ module Aws::BedrockAgent
|
|
2388
2735
|
end
|
2389
2736
|
|
2390
2737
|
# @!attribute [rw] max_results
|
2391
|
-
#
|
2738
|
+
# The maximum number of results to return in the response. If the
|
2739
|
+
# total number of results is greater than this value, use the token
|
2740
|
+
# returned in the response in the `nextToken` field when making
|
2741
|
+
# another request to return the next batch of results.
|
2392
2742
|
# @return [Integer]
|
2393
2743
|
#
|
2394
2744
|
# @!attribute [rw] next_token
|
2395
|
-
#
|
2745
|
+
# If the total number of results is greater than the `maxResults`
|
2746
|
+
# value provided in the request, enter the token returned in the
|
2747
|
+
# `nextToken` field in the response in this field to return the next
|
2748
|
+
# batch of results.
|
2396
2749
|
# @return [String]
|
2397
2750
|
#
|
2398
2751
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListKnowledgeBasesRequest AWS API Documentation
|
@@ -2405,11 +2758,15 @@ module Aws::BedrockAgent
|
|
2405
2758
|
end
|
2406
2759
|
|
2407
2760
|
# @!attribute [rw] knowledge_base_summaries
|
2408
|
-
#
|
2761
|
+
# A list of objects, each of which contains information about a
|
2762
|
+
# knowledge base.
|
2409
2763
|
# @return [Array<Types::KnowledgeBaseSummary>]
|
2410
2764
|
#
|
2411
2765
|
# @!attribute [rw] next_token
|
2412
|
-
#
|
2766
|
+
# If the total number of results is greater than the `maxResults`
|
2767
|
+
# value provided in the request, use this token when making another
|
2768
|
+
# request in the `nextToken` field to return the next batch of
|
2769
|
+
# results.
|
2413
2770
|
# @return [String]
|
2414
2771
|
#
|
2415
2772
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListKnowledgeBasesResponse AWS API Documentation
|
@@ -2422,7 +2779,8 @@ module Aws::BedrockAgent
|
|
2422
2779
|
end
|
2423
2780
|
|
2424
2781
|
# @!attribute [rw] resource_arn
|
2425
|
-
# ARN of
|
2782
|
+
# The Amazon Resource Name (ARN) of the resource for which to list
|
2783
|
+
# tags.
|
2426
2784
|
# @return [String]
|
2427
2785
|
#
|
2428
2786
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListTagsForResourceRequest AWS API Documentation
|
@@ -2434,7 +2792,7 @@ module Aws::BedrockAgent
|
|
2434
2792
|
end
|
2435
2793
|
|
2436
2794
|
# @!attribute [rw] tags
|
2437
|
-
#
|
2795
|
+
# The key-value pairs for the tags associated with the resource.
|
2438
2796
|
# @return [Hash<String,String>]
|
2439
2797
|
#
|
2440
2798
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListTagsForResourceResponse AWS API Documentation
|
@@ -2445,110 +2803,130 @@ module Aws::BedrockAgent
|
|
2445
2803
|
include Aws::Structure
|
2446
2804
|
end
|
2447
2805
|
|
2448
|
-
# Contains the
|
2449
|
-
#
|
2806
|
+
# Contains details about the storage configuration of the knowledge base
|
2807
|
+
# in Amazon OpenSearch Service. For more information, see [Create a
|
2808
|
+
# vector index in Amazon OpenSearch Service][1].
|
2450
2809
|
#
|
2451
|
-
# @!attribute [rw] collection_arn
|
2452
|
-
# Arn of an OpenSearch Serverless collection.
|
2453
|
-
# @return [String]
|
2454
2810
|
#
|
2455
|
-
#
|
2456
|
-
#
|
2811
|
+
#
|
2812
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html
|
2813
|
+
#
|
2814
|
+
# @!attribute [rw] collection_arn
|
2815
|
+
# The Amazon Resource Name (ARN) of the OpenSearch Service vector
|
2816
|
+
# store.
|
2457
2817
|
# @return [String]
|
2458
2818
|
#
|
2459
2819
|
# @!attribute [rw] field_mapping
|
2460
|
-
#
|
2461
|
-
#
|
2820
|
+
# Contains the names of the fields to which to map information about
|
2821
|
+
# the vector store.
|
2462
2822
|
# @return [Types::OpenSearchServerlessFieldMapping]
|
2463
2823
|
#
|
2824
|
+
# @!attribute [rw] vector_index_name
|
2825
|
+
# The name of the vector store.
|
2826
|
+
# @return [String]
|
2827
|
+
#
|
2464
2828
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/OpenSearchServerlessConfiguration AWS API Documentation
|
2465
2829
|
#
|
2466
2830
|
class OpenSearchServerlessConfiguration < Struct.new(
|
2467
2831
|
:collection_arn,
|
2468
|
-
:
|
2469
|
-
:
|
2832
|
+
:field_mapping,
|
2833
|
+
:vector_index_name)
|
2470
2834
|
SENSITIVE = []
|
2471
2835
|
include Aws::Structure
|
2472
2836
|
end
|
2473
2837
|
|
2474
|
-
#
|
2475
|
-
#
|
2838
|
+
# Contains the names of the fields to which to map information about the
|
2839
|
+
# vector store.
|
2476
2840
|
#
|
2477
|
-
# @!attribute [rw]
|
2478
|
-
#
|
2841
|
+
# @!attribute [rw] metadata_field
|
2842
|
+
# The name of the field in which Amazon Bedrock stores metadata about
|
2843
|
+
# the vector store.
|
2479
2844
|
# @return [String]
|
2480
2845
|
#
|
2481
2846
|
# @!attribute [rw] text_field
|
2482
|
-
#
|
2847
|
+
# The name of the field in which Amazon Bedrock stores the raw text
|
2848
|
+
# from your data. The text is split according to the chunking strategy
|
2849
|
+
# you choose.
|
2483
2850
|
# @return [String]
|
2484
2851
|
#
|
2485
|
-
# @!attribute [rw]
|
2486
|
-
#
|
2852
|
+
# @!attribute [rw] vector_field
|
2853
|
+
# The name of the field in which Amazon Bedrock stores the vector
|
2854
|
+
# embeddings for your data sources.
|
2487
2855
|
# @return [String]
|
2488
2856
|
#
|
2489
2857
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/OpenSearchServerlessFieldMapping AWS API Documentation
|
2490
2858
|
#
|
2491
2859
|
class OpenSearchServerlessFieldMapping < Struct.new(
|
2492
|
-
:
|
2860
|
+
:metadata_field,
|
2493
2861
|
:text_field,
|
2494
|
-
:
|
2862
|
+
:vector_field)
|
2495
2863
|
SENSITIVE = []
|
2496
2864
|
include Aws::Structure
|
2497
2865
|
end
|
2498
2866
|
|
2499
|
-
# Contains
|
2500
|
-
#
|
2867
|
+
# Contains details about the storage configuration of the knowledge base
|
2868
|
+
# in Pinecone. For more information, see [Create a vector index in
|
2869
|
+
# Pinecone][1].
|
2870
|
+
#
|
2871
|
+
#
|
2872
|
+
#
|
2873
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html
|
2501
2874
|
#
|
2502
2875
|
# @!attribute [rw] connection_string
|
2503
|
-
#
|
2876
|
+
# The endpoint URL for your index management page.
|
2504
2877
|
# @return [String]
|
2505
2878
|
#
|
2506
2879
|
# @!attribute [rw] credentials_secret_arn
|
2507
|
-
#
|
2508
|
-
#
|
2509
|
-
#
|
2510
|
-
# @!attribute [rw] namespace
|
2511
|
-
# Pinecone namespace
|
2880
|
+
# The Amazon Resource Name (ARN) of the secret that you created in
|
2881
|
+
# Secrets Manager that is linked to your Pinecone API key.
|
2512
2882
|
# @return [String]
|
2513
2883
|
#
|
2514
2884
|
# @!attribute [rw] field_mapping
|
2515
|
-
#
|
2885
|
+
# Contains the names of the fields to which to map information about
|
2886
|
+
# the vector store.
|
2516
2887
|
# @return [Types::PineconeFieldMapping]
|
2517
2888
|
#
|
2889
|
+
# @!attribute [rw] namespace
|
2890
|
+
# The namespace to be used to write new data to your database.
|
2891
|
+
# @return [String]
|
2892
|
+
#
|
2518
2893
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PineconeConfiguration AWS API Documentation
|
2519
2894
|
#
|
2520
2895
|
class PineconeConfiguration < Struct.new(
|
2521
2896
|
:connection_string,
|
2522
2897
|
:credentials_secret_arn,
|
2523
|
-
:
|
2524
|
-
:
|
2898
|
+
:field_mapping,
|
2899
|
+
:namespace)
|
2525
2900
|
SENSITIVE = []
|
2526
2901
|
include Aws::Structure
|
2527
2902
|
end
|
2528
2903
|
|
2529
|
-
#
|
2904
|
+
# Contains the names of the fields to which to map information about the
|
2905
|
+
# vector store.
|
2530
2906
|
#
|
2531
|
-
# @!attribute [rw]
|
2532
|
-
#
|
2907
|
+
# @!attribute [rw] metadata_field
|
2908
|
+
# The name of the field in which Amazon Bedrock stores metadata about
|
2909
|
+
# the vector store.
|
2533
2910
|
# @return [String]
|
2534
2911
|
#
|
2535
|
-
# @!attribute [rw]
|
2536
|
-
#
|
2912
|
+
# @!attribute [rw] text_field
|
2913
|
+
# The name of the field in which Amazon Bedrock stores the raw text
|
2914
|
+
# from your data. The text is split according to the chunking strategy
|
2915
|
+
# you choose.
|
2537
2916
|
# @return [String]
|
2538
2917
|
#
|
2539
2918
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PineconeFieldMapping AWS API Documentation
|
2540
2919
|
#
|
2541
2920
|
class PineconeFieldMapping < Struct.new(
|
2542
|
-
:
|
2543
|
-
:
|
2921
|
+
:metadata_field,
|
2922
|
+
:text_field)
|
2544
2923
|
SENSITIVE = []
|
2545
2924
|
include Aws::Structure
|
2546
2925
|
end
|
2547
2926
|
|
2548
|
-
# PrepareAgent Request
|
2549
|
-
#
|
2550
2927
|
# @!attribute [rw] agent_id
|
2551
|
-
#
|
2928
|
+
# The unique identifier of the agent for which to create a `DRAFT`
|
2929
|
+
# version.
|
2552
2930
|
# @return [String]
|
2553
2931
|
#
|
2554
2932
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PrepareAgentRequest AWS API Documentation
|
@@ -2559,22 +2937,22 @@ module Aws::BedrockAgent
|
|
2559
2937
|
include Aws::Structure
|
2560
2938
|
end
|
2561
2939
|
|
2562
|
-
# PrepareAgent Response
|
2563
|
-
#
|
2564
2940
|
# @!attribute [rw] agent_id
|
2565
|
-
#
|
2941
|
+
# The unique identifier of the agent for which the `DRAFT` version was
|
2942
|
+
# created.
|
2566
2943
|
# @return [String]
|
2567
2944
|
#
|
2568
2945
|
# @!attribute [rw] agent_status
|
2569
|
-
#
|
2946
|
+
# The status of the `DRAFT` version and whether it is ready for use.
|
2570
2947
|
# @return [String]
|
2571
2948
|
#
|
2572
2949
|
# @!attribute [rw] agent_version
|
2573
|
-
#
|
2950
|
+
# The version of the agent.
|
2574
2951
|
# @return [String]
|
2575
2952
|
#
|
2576
2953
|
# @!attribute [rw] prepared_at
|
2577
|
-
#
|
2954
|
+
# The time at which the `DRAFT` version of the agent was last
|
2955
|
+
# prepared.
|
2578
2956
|
# @return [Time]
|
2579
2957
|
#
|
2580
2958
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PrepareAgentResponse AWS API Documentation
|
@@ -2588,187 +2966,268 @@ module Aws::BedrockAgent
|
|
2588
2966
|
include Aws::Structure
|
2589
2967
|
end
|
2590
2968
|
|
2591
|
-
#
|
2969
|
+
# Contains configurations to override a prompt template in one part of
|
2970
|
+
# an agent sequence. For more information, see [Advanced prompts][1].
|
2592
2971
|
#
|
2593
|
-
# @!attribute [rw] prompt_type
|
2594
|
-
# Prompt Type.
|
2595
|
-
# @return [String]
|
2596
2972
|
#
|
2597
|
-
# @!attribute [rw] prompt_creation_mode
|
2598
|
-
# Creation Mode for Prompt Configuration.
|
2599
|
-
# @return [String]
|
2600
2973
|
#
|
2601
|
-
#
|
2602
|
-
# Prompt State.
|
2603
|
-
# @return [String]
|
2974
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
|
2604
2975
|
#
|
2605
2976
|
# @!attribute [rw] base_prompt_template
|
2606
|
-
#
|
2977
|
+
# Defines the prompt template with which to replace the default prompt
|
2978
|
+
# template. You can use placeholder variables in the base prompt
|
2979
|
+
# template to customize the prompt. For more information, see [Prompt
|
2980
|
+
# template placeholder variables][1].
|
2981
|
+
#
|
2982
|
+
#
|
2983
|
+
#
|
2984
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html
|
2607
2985
|
# @return [String]
|
2608
2986
|
#
|
2609
2987
|
# @!attribute [rw] inference_configuration
|
2610
|
-
#
|
2988
|
+
# Contains inference parameters to use when the agent invokes a
|
2989
|
+
# foundation model in the part of the agent sequence defined by the
|
2990
|
+
# `promptType`. For more information, see [Inference parameters for
|
2991
|
+
# foundation models][1].
|
2992
|
+
#
|
2993
|
+
#
|
2994
|
+
#
|
2995
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html
|
2611
2996
|
# @return [Types::InferenceConfiguration]
|
2612
2997
|
#
|
2613
2998
|
# @!attribute [rw] parser_mode
|
2614
|
-
#
|
2999
|
+
# Specifies whether to override the default parser Lambda function
|
3000
|
+
# when parsing the raw foundation model output in the part of the
|
3001
|
+
# agent sequence defined by the `promptType`. If you set the field as
|
3002
|
+
# `OVERRIDEN`, the `overrideLambda` field in the
|
3003
|
+
# [PromptOverrideConfiguration][1] must be specified with the ARN of a
|
3004
|
+
# Lambda function.
|
3005
|
+
#
|
3006
|
+
#
|
3007
|
+
#
|
3008
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html
|
3009
|
+
# @return [String]
|
3010
|
+
#
|
3011
|
+
# @!attribute [rw] prompt_creation_mode
|
3012
|
+
# Specifies whether to override the default prompt template for this
|
3013
|
+
# `promptType`. Set this value to `OVERRIDDEN` to use the prompt that
|
3014
|
+
# you provide in the `basePromptTemplate`. If you leave it as
|
3015
|
+
# `DEFAULT`, the agent uses a default prompt template.
|
3016
|
+
# @return [String]
|
3017
|
+
#
|
3018
|
+
# @!attribute [rw] prompt_state
|
3019
|
+
# Specifies whether to allow the agent to carry out the step specified
|
3020
|
+
# in the `promptType`. If you set this value to `DISABLED`, the agent
|
3021
|
+
# skips that step. The default state for each `promptType` is as
|
3022
|
+
# follows.
|
3023
|
+
#
|
3024
|
+
# * `PRE_PROCESSING` – `ENABLED`
|
3025
|
+
#
|
3026
|
+
# * `ORCHESTRATION` – `ENABLED`
|
3027
|
+
#
|
3028
|
+
# * `KNOWLEDGE_BASE_RESPONSE_GENERATION` – `ENABLED`
|
3029
|
+
#
|
3030
|
+
# * `POST_PROCESSING` – `DISABLED`
|
3031
|
+
# @return [String]
|
3032
|
+
#
|
3033
|
+
# @!attribute [rw] prompt_type
|
3034
|
+
# The step in the agent sequence that this prompt configuration
|
3035
|
+
# applies to.
|
2615
3036
|
# @return [String]
|
2616
3037
|
#
|
2617
3038
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptConfiguration AWS API Documentation
|
2618
3039
|
#
|
2619
3040
|
class PromptConfiguration < Struct.new(
|
2620
|
-
:prompt_type,
|
2621
|
-
:prompt_creation_mode,
|
2622
|
-
:prompt_state,
|
2623
3041
|
:base_prompt_template,
|
2624
3042
|
:inference_configuration,
|
2625
|
-
:parser_mode
|
3043
|
+
:parser_mode,
|
3044
|
+
:prompt_creation_mode,
|
3045
|
+
:prompt_state,
|
3046
|
+
:prompt_type)
|
2626
3047
|
SENSITIVE = []
|
2627
3048
|
include Aws::Structure
|
2628
3049
|
end
|
2629
3050
|
|
2630
|
-
#
|
3051
|
+
# Contains configurations to override prompts in different parts of an
|
3052
|
+
# agent sequence. For more information, see [Advanced prompts][1].
|
3053
|
+
#
|
2631
3054
|
#
|
2632
|
-
#
|
2633
|
-
#
|
2634
|
-
# @return [Array<Types::PromptConfiguration>]
|
3055
|
+
#
|
3056
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
|
2635
3057
|
#
|
2636
3058
|
# @!attribute [rw] override_lambda
|
2637
|
-
# ARN of
|
3059
|
+
# The ARN of the Lambda function to use when parsing the raw
|
3060
|
+
# foundation model output in parts of the agent sequence. If you
|
3061
|
+
# specify this field, at least one of the `promptConfigurations` must
|
3062
|
+
# contain a `parserMode` value that is set to `OVERRIDDEN`.
|
2638
3063
|
# @return [String]
|
2639
3064
|
#
|
3065
|
+
# @!attribute [rw] prompt_configurations
|
3066
|
+
# Contains configurations to override a prompt template in one part of
|
3067
|
+
# an agent sequence. For more information, see [Advanced prompts][1].
|
3068
|
+
#
|
3069
|
+
#
|
3070
|
+
#
|
3071
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
|
3072
|
+
# @return [Array<Types::PromptConfiguration>]
|
3073
|
+
#
|
2640
3074
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptOverrideConfiguration AWS API Documentation
|
2641
3075
|
#
|
2642
3076
|
class PromptOverrideConfiguration < Struct.new(
|
2643
|
-
:
|
2644
|
-
:
|
3077
|
+
:override_lambda,
|
3078
|
+
:prompt_configurations)
|
2645
3079
|
SENSITIVE = []
|
2646
3080
|
include Aws::Structure
|
2647
3081
|
end
|
2648
3082
|
|
2649
|
-
# Contains
|
3083
|
+
# Contains details about the storage configuration of the knowledge base
|
3084
|
+
# in Amazon RDS. For more information, see [Create a vector index in
|
3085
|
+
# Amazon RDS][1].
|
3086
|
+
#
|
2650
3087
|
#
|
2651
|
-
#
|
2652
|
-
#
|
2653
|
-
# @return [String]
|
3088
|
+
#
|
3089
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html
|
2654
3090
|
#
|
2655
3091
|
# @!attribute [rw] credentials_secret_arn
|
2656
|
-
#
|
3092
|
+
# The Amazon Resource Name (ARN) of the secret that you created in
|
3093
|
+
# Secrets Manager that is linked to your Amazon RDS database.
|
2657
3094
|
# @return [String]
|
2658
3095
|
#
|
2659
3096
|
# @!attribute [rw] database_name
|
2660
|
-
#
|
2661
|
-
# @return [String]
|
2662
|
-
#
|
2663
|
-
# @!attribute [rw] table_name
|
2664
|
-
# Name of the table within RDS
|
3097
|
+
# The name of your Amazon RDS database.
|
2665
3098
|
# @return [String]
|
2666
3099
|
#
|
2667
3100
|
# @!attribute [rw] field_mapping
|
2668
|
-
#
|
3101
|
+
# Contains the names of the fields to which to map information about
|
3102
|
+
# the vector store.
|
2669
3103
|
# @return [Types::RdsFieldMapping]
|
2670
3104
|
#
|
3105
|
+
# @!attribute [rw] resource_arn
|
3106
|
+
# The Amazon Resource Name (ARN) of the vector store.
|
3107
|
+
# @return [String]
|
3108
|
+
#
|
3109
|
+
# @!attribute [rw] table_name
|
3110
|
+
# The name of the table in the database.
|
3111
|
+
# @return [String]
|
3112
|
+
#
|
2671
3113
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RdsConfiguration AWS API Documentation
|
2672
3114
|
#
|
2673
3115
|
class RdsConfiguration < Struct.new(
|
2674
|
-
:resource_arn,
|
2675
3116
|
:credentials_secret_arn,
|
2676
3117
|
:database_name,
|
2677
|
-
:
|
2678
|
-
:
|
3118
|
+
:field_mapping,
|
3119
|
+
:resource_arn,
|
3120
|
+
:table_name)
|
2679
3121
|
SENSITIVE = []
|
2680
3122
|
include Aws::Structure
|
2681
3123
|
end
|
2682
3124
|
|
2683
|
-
#
|
3125
|
+
# Contains the names of the fields to which to map information about the
|
3126
|
+
# vector store.
|
2684
3127
|
#
|
2685
|
-
# @!attribute [rw]
|
2686
|
-
#
|
3128
|
+
# @!attribute [rw] metadata_field
|
3129
|
+
# The name of the field in which Amazon Bedrock stores metadata about
|
3130
|
+
# the vector store.
|
2687
3131
|
# @return [String]
|
2688
3132
|
#
|
2689
|
-
# @!attribute [rw]
|
2690
|
-
#
|
3133
|
+
# @!attribute [rw] primary_key_field
|
3134
|
+
# The name of the field in which Amazon Bedrock stores the ID for each
|
3135
|
+
# entry.
|
2691
3136
|
# @return [String]
|
2692
3137
|
#
|
2693
3138
|
# @!attribute [rw] text_field
|
2694
|
-
#
|
3139
|
+
# The name of the field in which Amazon Bedrock stores the raw text
|
3140
|
+
# from your data. The text is split according to the chunking strategy
|
3141
|
+
# you choose.
|
2695
3142
|
# @return [String]
|
2696
3143
|
#
|
2697
|
-
# @!attribute [rw]
|
2698
|
-
#
|
3144
|
+
# @!attribute [rw] vector_field
|
3145
|
+
# The name of the field in which Amazon Bedrock stores the vector
|
3146
|
+
# embeddings for your data sources.
|
2699
3147
|
# @return [String]
|
2700
3148
|
#
|
2701
3149
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RdsFieldMapping AWS API Documentation
|
2702
3150
|
#
|
2703
3151
|
class RdsFieldMapping < Struct.new(
|
3152
|
+
:metadata_field,
|
2704
3153
|
:primary_key_field,
|
2705
|
-
:vector_field,
|
2706
3154
|
:text_field,
|
2707
|
-
:
|
3155
|
+
:vector_field)
|
2708
3156
|
SENSITIVE = []
|
2709
3157
|
include Aws::Structure
|
2710
3158
|
end
|
2711
3159
|
|
2712
|
-
# Contains
|
2713
|
-
#
|
3160
|
+
# Contains details about the storage configuration of the knowledge base
|
3161
|
+
# in Redis Enterprise Cloud. For more information, see [Create a vector
|
3162
|
+
# index in Redis Enterprise Cloud][1].
|
2714
3163
|
#
|
2715
|
-
# @!attribute [rw] endpoint
|
2716
|
-
# Redis enterprise cloud endpoint
|
2717
|
-
# @return [String]
|
2718
3164
|
#
|
2719
|
-
#
|
2720
|
-
#
|
2721
|
-
# @return [String]
|
3165
|
+
#
|
3166
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html
|
2722
3167
|
#
|
2723
3168
|
# @!attribute [rw] credentials_secret_arn
|
2724
|
-
#
|
3169
|
+
# The Amazon Resource Name (ARN) of the secret that you created in
|
3170
|
+
# Secrets Manager that is linked to your Redis Enterprise Cloud
|
3171
|
+
# database.
|
3172
|
+
# @return [String]
|
3173
|
+
#
|
3174
|
+
# @!attribute [rw] endpoint
|
3175
|
+
# The endpoint URL of the Redis Enterprise Cloud database.
|
2725
3176
|
# @return [String]
|
2726
3177
|
#
|
2727
3178
|
# @!attribute [rw] field_mapping
|
2728
|
-
#
|
2729
|
-
#
|
3179
|
+
# Contains the names of the fields to which to map information about
|
3180
|
+
# the vector store.
|
2730
3181
|
# @return [Types::RedisEnterpriseCloudFieldMapping]
|
2731
3182
|
#
|
3183
|
+
# @!attribute [rw] vector_index_name
|
3184
|
+
# The name of the vector index.
|
3185
|
+
# @return [String]
|
3186
|
+
#
|
2732
3187
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedisEnterpriseCloudConfiguration AWS API Documentation
|
2733
3188
|
#
|
2734
3189
|
class RedisEnterpriseCloudConfiguration < Struct.new(
|
2735
|
-
:endpoint,
|
2736
|
-
:vector_index_name,
|
2737
3190
|
:credentials_secret_arn,
|
2738
|
-
:
|
3191
|
+
:endpoint,
|
3192
|
+
:field_mapping,
|
3193
|
+
:vector_index_name)
|
2739
3194
|
SENSITIVE = []
|
2740
3195
|
include Aws::Structure
|
2741
3196
|
end
|
2742
3197
|
|
2743
|
-
#
|
3198
|
+
# Contains the names of the fields to which to map information about the
|
3199
|
+
# vector store.
|
2744
3200
|
#
|
2745
|
-
# @!attribute [rw]
|
2746
|
-
#
|
3201
|
+
# @!attribute [rw] metadata_field
|
3202
|
+
# The name of the field in which Amazon Bedrock stores metadata about
|
3203
|
+
# the vector store.
|
2747
3204
|
# @return [String]
|
2748
3205
|
#
|
2749
3206
|
# @!attribute [rw] text_field
|
2750
|
-
#
|
3207
|
+
# The name of the field in which Amazon Bedrock stores the raw text
|
3208
|
+
# from your data. The text is split according to the chunking strategy
|
3209
|
+
# you choose.
|
2751
3210
|
# @return [String]
|
2752
3211
|
#
|
2753
|
-
# @!attribute [rw]
|
2754
|
-
#
|
3212
|
+
# @!attribute [rw] vector_field
|
3213
|
+
# The name of the field in which Amazon Bedrock stores the vector
|
3214
|
+
# embeddings for your data sources.
|
2755
3215
|
# @return [String]
|
2756
3216
|
#
|
2757
3217
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedisEnterpriseCloudFieldMapping AWS API Documentation
|
2758
3218
|
#
|
2759
3219
|
class RedisEnterpriseCloudFieldMapping < Struct.new(
|
2760
|
-
:
|
3220
|
+
:metadata_field,
|
2761
3221
|
:text_field,
|
2762
|
-
:
|
3222
|
+
:vector_field)
|
2763
3223
|
SENSITIVE = []
|
2764
3224
|
include Aws::Structure
|
2765
3225
|
end
|
2766
3226
|
|
2767
|
-
#
|
2768
|
-
#
|
3227
|
+
# The specified resource Amazon Resource Name (ARN) was not found. Check
|
3228
|
+
# the Amazon Resource Name (ARN) and try your request again.
|
2769
3229
|
#
|
2770
3230
|
# @!attribute [rw] message
|
2771
|
-
# Non Blank String
|
2772
3231
|
# @return [String]
|
2773
3232
|
#
|
2774
3233
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ResourceNotFoundException AWS API Documentation
|
@@ -2779,14 +3238,21 @@ module Aws::BedrockAgent
|
|
2779
3238
|
include Aws::Structure
|
2780
3239
|
end
|
2781
3240
|
|
2782
|
-
#
|
3241
|
+
# Contains information about the S3 configuration of the data source.
|
2783
3242
|
#
|
2784
3243
|
# @!attribute [rw] bucket_arn
|
2785
|
-
#
|
3244
|
+
# The Amazon Resource Name (ARN) of the bucket that contains the data
|
3245
|
+
# source.
|
2786
3246
|
# @return [String]
|
2787
3247
|
#
|
2788
3248
|
# @!attribute [rw] inclusion_prefixes
|
2789
|
-
# A list of S3 prefixes
|
3249
|
+
# A list of S3 prefixes that define the object containing the data
|
3250
|
+
# sources. For more information, see [Organizing objects using
|
3251
|
+
# prefixes][1].
|
3252
|
+
#
|
3253
|
+
#
|
3254
|
+
#
|
3255
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html
|
2790
3256
|
# @return [Array<String>]
|
2791
3257
|
#
|
2792
3258
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/S3DataSourceConfiguration AWS API Documentation
|
@@ -2798,14 +3264,14 @@ module Aws::BedrockAgent
|
|
2798
3264
|
include Aws::Structure
|
2799
3265
|
end
|
2800
3266
|
|
2801
|
-
#
|
3267
|
+
# Contains information about the S3 object containing the resource.
|
2802
3268
|
#
|
2803
3269
|
# @!attribute [rw] s3_bucket_name
|
2804
|
-
#
|
3270
|
+
# The name of the S3 bucket.
|
2805
3271
|
# @return [String]
|
2806
3272
|
#
|
2807
3273
|
# @!attribute [rw] s3_object_key
|
2808
|
-
#
|
3274
|
+
# The S3 object key containing the resource.
|
2809
3275
|
# @return [String]
|
2810
3276
|
#
|
2811
3277
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/S3Identifier AWS API Documentation
|
@@ -2817,10 +3283,11 @@ module Aws::BedrockAgent
|
|
2817
3283
|
include Aws::Structure
|
2818
3284
|
end
|
2819
3285
|
|
2820
|
-
#
|
3286
|
+
# Contains the configuration for server-side encryption.
|
2821
3287
|
#
|
2822
3288
|
# @!attribute [rw] kms_key_arn
|
2823
|
-
#
|
3289
|
+
# The Amazon Resource Name (ARN) of the KMS key used to encrypt the
|
3290
|
+
# resource.
|
2824
3291
|
# @return [String]
|
2825
3292
|
#
|
2826
3293
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ServerSideEncryptionConfiguration AWS API Documentation
|
@@ -2831,11 +3298,10 @@ module Aws::BedrockAgent
|
|
2831
3298
|
include Aws::Structure
|
2832
3299
|
end
|
2833
3300
|
|
2834
|
-
#
|
2835
|
-
#
|
3301
|
+
# The number of requests exceeds the service quota. Resubmit your
|
3302
|
+
# request later.
|
2836
3303
|
#
|
2837
3304
|
# @!attribute [rw] message
|
2838
|
-
# Non Blank String
|
2839
3305
|
# @return [String]
|
2840
3306
|
#
|
2841
3307
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ServiceQuotaExceededException AWS API Documentation
|
@@ -2846,38 +3312,46 @@ module Aws::BedrockAgent
|
|
2846
3312
|
include Aws::Structure
|
2847
3313
|
end
|
2848
3314
|
|
2849
|
-
# @!attribute [rw] knowledge_base_id
|
2850
|
-
# Identifier for a resource.
|
2851
|
-
# @return [String]
|
2852
|
-
#
|
2853
|
-
# @!attribute [rw] data_source_id
|
2854
|
-
# Identifier for a resource.
|
2855
|
-
# @return [String]
|
2856
|
-
#
|
2857
3315
|
# @!attribute [rw] client_token
|
2858
|
-
#
|
3316
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
3317
|
+
# completes no more than one time. If this token matches a previous
|
3318
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
3319
|
+
# error. For more information, see [Ensuring idempotency][1].
|
2859
3320
|
#
|
2860
3321
|
# **A suitable default value is auto-generated.** You should normally
|
2861
3322
|
# not need to pass this option.
|
3323
|
+
#
|
3324
|
+
#
|
3325
|
+
#
|
3326
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
3327
|
+
# @return [String]
|
3328
|
+
#
|
3329
|
+
# @!attribute [rw] data_source_id
|
3330
|
+
# The unique identifier of the data source to ingest.
|
2862
3331
|
# @return [String]
|
2863
3332
|
#
|
2864
3333
|
# @!attribute [rw] description
|
2865
|
-
#
|
3334
|
+
# A description of the ingestion job.
|
3335
|
+
# @return [String]
|
3336
|
+
#
|
3337
|
+
# @!attribute [rw] knowledge_base_id
|
3338
|
+
# The unique identifier of the knowledge base to which to add the data
|
3339
|
+
# source.
|
2866
3340
|
# @return [String]
|
2867
3341
|
#
|
2868
3342
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StartIngestionJobRequest AWS API Documentation
|
2869
3343
|
#
|
2870
3344
|
class StartIngestionJobRequest < Struct.new(
|
2871
|
-
:knowledge_base_id,
|
2872
|
-
:data_source_id,
|
2873
3345
|
:client_token,
|
2874
|
-
:
|
3346
|
+
:data_source_id,
|
3347
|
+
:description,
|
3348
|
+
:knowledge_base_id)
|
2875
3349
|
SENSITIVE = []
|
2876
3350
|
include Aws::Structure
|
2877
3351
|
end
|
2878
3352
|
|
2879
3353
|
# @!attribute [rw] ingestion_job
|
2880
|
-
#
|
3354
|
+
# An object containing information about the ingestion job.
|
2881
3355
|
# @return [Types::IngestionJob]
|
2882
3356
|
#
|
2883
3357
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StartIngestionJobResponse AWS API Documentation
|
@@ -2888,49 +3362,56 @@ module Aws::BedrockAgent
|
|
2888
3362
|
include Aws::Structure
|
2889
3363
|
end
|
2890
3364
|
|
2891
|
-
#
|
2892
|
-
#
|
2893
|
-
# @!attribute [rw] type
|
2894
|
-
# The storage type of a knowledge base.
|
2895
|
-
# @return [String]
|
3365
|
+
# Contains the storage configuration of the knowledge base.
|
2896
3366
|
#
|
2897
3367
|
# @!attribute [rw] opensearch_serverless_configuration
|
2898
|
-
# Contains the
|
2899
|
-
#
|
3368
|
+
# Contains the storage configuration of the knowledge base in Amazon
|
3369
|
+
# OpenSearch Service.
|
2900
3370
|
# @return [Types::OpenSearchServerlessConfiguration]
|
2901
3371
|
#
|
2902
3372
|
# @!attribute [rw] pinecone_configuration
|
2903
|
-
# Contains the
|
2904
|
-
#
|
3373
|
+
# Contains the storage configuration of the knowledge base in
|
3374
|
+
# Pinecone.
|
2905
3375
|
# @return [Types::PineconeConfiguration]
|
2906
3376
|
#
|
3377
|
+
# @!attribute [rw] rds_configuration
|
3378
|
+
# Contains details about the storage configuration of the knowledge
|
3379
|
+
# base in Amazon RDS. For more information, see [Create a vector index
|
3380
|
+
# in Amazon RDS][1].
|
3381
|
+
#
|
3382
|
+
#
|
3383
|
+
#
|
3384
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html
|
3385
|
+
# @return [Types::RdsConfiguration]
|
3386
|
+
#
|
2907
3387
|
# @!attribute [rw] redis_enterprise_cloud_configuration
|
2908
|
-
# Contains the
|
2909
|
-
#
|
3388
|
+
# Contains the storage configuration of the knowledge base in Redis
|
3389
|
+
# Enterprise Cloud.
|
2910
3390
|
# @return [Types::RedisEnterpriseCloudConfiguration]
|
2911
3391
|
#
|
2912
|
-
# @!attribute [rw]
|
2913
|
-
#
|
2914
|
-
# @return [
|
3392
|
+
# @!attribute [rw] type
|
3393
|
+
# The vector store service in which the knowledge base is stored.
|
3394
|
+
# @return [String]
|
2915
3395
|
#
|
2916
3396
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StorageConfiguration AWS API Documentation
|
2917
3397
|
#
|
2918
3398
|
class StorageConfiguration < Struct.new(
|
2919
|
-
:type,
|
2920
3399
|
:opensearch_serverless_configuration,
|
2921
3400
|
:pinecone_configuration,
|
3401
|
+
:rds_configuration,
|
2922
3402
|
:redis_enterprise_cloud_configuration,
|
2923
|
-
:
|
3403
|
+
:type)
|
2924
3404
|
SENSITIVE = []
|
2925
3405
|
include Aws::Structure
|
2926
3406
|
end
|
2927
3407
|
|
2928
3408
|
# @!attribute [rw] resource_arn
|
2929
|
-
# ARN of
|
3409
|
+
# The Amazon Resource Name (ARN) of the resource to tag.
|
2930
3410
|
# @return [String]
|
2931
3411
|
#
|
2932
3412
|
# @!attribute [rw] tags
|
2933
|
-
#
|
3413
|
+
# An object containing key-value pairs that define the tags to attach
|
3414
|
+
# to the resource.
|
2934
3415
|
# @return [Hash<String,String>]
|
2935
3416
|
#
|
2936
3417
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/TagResourceRequest AWS API Documentation
|
@@ -2946,10 +3427,9 @@ module Aws::BedrockAgent
|
|
2946
3427
|
#
|
2947
3428
|
class TagResourceResponse < Aws::EmptyStructure; end
|
2948
3429
|
|
2949
|
-
#
|
3430
|
+
# The number of requests exceeds the limit. Resubmit your request later.
|
2950
3431
|
#
|
2951
3432
|
# @!attribute [rw] message
|
2952
|
-
# Non Blank String
|
2953
3433
|
# @return [String]
|
2954
3434
|
#
|
2955
3435
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ThrottlingException AWS API Documentation
|
@@ -2961,11 +3441,12 @@ module Aws::BedrockAgent
|
|
2961
3441
|
end
|
2962
3442
|
|
2963
3443
|
# @!attribute [rw] resource_arn
|
2964
|
-
# ARN of
|
3444
|
+
# The Amazon Resource Name (ARN) of the resource from which to remove
|
3445
|
+
# tags.
|
2965
3446
|
# @return [String]
|
2966
3447
|
#
|
2967
3448
|
# @!attribute [rw] tag_keys
|
2968
|
-
#
|
3449
|
+
# A list of keys of the tags to remove from the resource.
|
2969
3450
|
# @return [Array<String>]
|
2970
3451
|
#
|
2971
3452
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UntagResourceRequest AWS API Documentation
|
@@ -2981,65 +3462,88 @@ module Aws::BedrockAgent
|
|
2981
3462
|
#
|
2982
3463
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
2983
3464
|
|
2984
|
-
#
|
3465
|
+
# @!attribute [rw] action_group_executor
|
3466
|
+
# The Amazon Resource Name (ARN) of the Lambda function containing the
|
3467
|
+
# business logic that is carried out upon invoking the action.
|
3468
|
+
# @return [Types::ActionGroupExecutor]
|
2985
3469
|
#
|
2986
|
-
# @!attribute [rw]
|
2987
|
-
#
|
3470
|
+
# @!attribute [rw] action_group_id
|
3471
|
+
# The unique identifier of the action group.
|
2988
3472
|
# @return [String]
|
2989
3473
|
#
|
2990
|
-
# @!attribute [rw]
|
2991
|
-
#
|
3474
|
+
# @!attribute [rw] action_group_name
|
3475
|
+
# Specifies a new name for the action group.
|
2992
3476
|
# @return [String]
|
2993
3477
|
#
|
2994
|
-
# @!attribute [rw]
|
2995
|
-
#
|
2996
|
-
#
|
3478
|
+
# @!attribute [rw] action_group_state
|
3479
|
+
# Specifies whether the action group is available for the agent to
|
3480
|
+
# invoke or not when sending an [InvokeAgent][1] request.
|
3481
|
+
#
|
3482
|
+
#
|
3483
|
+
#
|
3484
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
|
2997
3485
|
# @return [String]
|
2998
3486
|
#
|
2999
|
-
# @!attribute [rw]
|
3000
|
-
#
|
3487
|
+
# @!attribute [rw] agent_id
|
3488
|
+
# The unique identifier of the agent for which to update the action
|
3489
|
+
# group.
|
3490
|
+
# @return [String]
|
3491
|
+
#
|
3492
|
+
# @!attribute [rw] agent_version
|
3493
|
+
# The unique identifier of the agent version for which to update the
|
3494
|
+
# action group.
|
3001
3495
|
# @return [String]
|
3002
3496
|
#
|
3497
|
+
# @!attribute [rw] api_schema
|
3498
|
+
# Contains either details about the S3 object containing the OpenAPI
|
3499
|
+
# schema for the action group or the JSON or YAML-formatted payload
|
3500
|
+
# defining the schema. For more information, see [Action group OpenAPI
|
3501
|
+
# schemas][1].
|
3502
|
+
#
|
3503
|
+
#
|
3504
|
+
#
|
3505
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html
|
3506
|
+
# @return [Types::APISchema]
|
3507
|
+
#
|
3003
3508
|
# @!attribute [rw] description
|
3004
|
-
#
|
3509
|
+
# Specifies a new name for the action group.
|
3005
3510
|
# @return [String]
|
3006
3511
|
#
|
3007
3512
|
# @!attribute [rw] parent_action_group_signature
|
3008
|
-
#
|
3009
|
-
#
|
3513
|
+
# To allow your agent to request the user for additional information
|
3514
|
+
# when trying to complete a task, set this field to
|
3515
|
+
# `AMAZON.UserInput`. You must leave the `description`, `apiSchema`,
|
3516
|
+
# and `actionGroupExecutor` fields blank for this action group.
|
3010
3517
|
#
|
3011
|
-
#
|
3012
|
-
#
|
3013
|
-
#
|
3518
|
+
# During orchestration, if your agent determines that it needs to
|
3519
|
+
# invoke an API in an action group, but doesn't have enough
|
3520
|
+
# information to complete the API request, it will invoke this action
|
3521
|
+
# group instead and return an [Observation][1] reprompting the user
|
3522
|
+
# for more information.
|
3014
3523
|
#
|
3015
|
-
# @!attribute [rw] action_group_state
|
3016
|
-
# State of the action group
|
3017
|
-
# @return [String]
|
3018
3524
|
#
|
3019
|
-
#
|
3020
|
-
#
|
3021
|
-
# @return [
|
3525
|
+
#
|
3526
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html
|
3527
|
+
# @return [String]
|
3022
3528
|
#
|
3023
3529
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentActionGroupRequest AWS API Documentation
|
3024
3530
|
#
|
3025
3531
|
class UpdateAgentActionGroupRequest < Struct.new(
|
3026
|
-
:
|
3027
|
-
:agent_version,
|
3532
|
+
:action_group_executor,
|
3028
3533
|
:action_group_id,
|
3029
3534
|
:action_group_name,
|
3030
|
-
:description,
|
3031
|
-
:parent_action_group_signature,
|
3032
|
-
:action_group_executor,
|
3033
3535
|
:action_group_state,
|
3034
|
-
:
|
3536
|
+
:agent_id,
|
3537
|
+
:agent_version,
|
3538
|
+
:api_schema,
|
3539
|
+
:description,
|
3540
|
+
:parent_action_group_signature)
|
3035
3541
|
SENSITIVE = []
|
3036
3542
|
include Aws::Structure
|
3037
3543
|
end
|
3038
3544
|
|
3039
|
-
# Update Action Group Response
|
3040
|
-
#
|
3041
3545
|
# @!attribute [rw] agent_action_group
|
3042
|
-
# Contains the
|
3546
|
+
# Contains details about the action group that was updated.
|
3043
3547
|
# @return [Types::AgentActionGroup]
|
3044
3548
|
#
|
3045
3549
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentActionGroupResponse AWS API Documentation
|
@@ -3050,44 +3554,40 @@ module Aws::BedrockAgent
|
|
3050
3554
|
include Aws::Structure
|
3051
3555
|
end
|
3052
3556
|
|
3053
|
-
# Update Agent Alias Request
|
3054
|
-
#
|
3055
|
-
# @!attribute [rw] agent_id
|
3056
|
-
# Id generated at the server side when an Agent is created
|
3057
|
-
# @return [String]
|
3058
|
-
#
|
3059
3557
|
# @!attribute [rw] agent_alias_id
|
3060
|
-
#
|
3558
|
+
# The unique identifier of the alias.
|
3061
3559
|
# @return [String]
|
3062
3560
|
#
|
3063
3561
|
# @!attribute [rw] agent_alias_name
|
3064
|
-
#
|
3562
|
+
# Specifies a new name for the alias.
|
3563
|
+
# @return [String]
|
3564
|
+
#
|
3565
|
+
# @!attribute [rw] agent_id
|
3566
|
+
# The unique identifier of the agent.
|
3065
3567
|
# @return [String]
|
3066
3568
|
#
|
3067
3569
|
# @!attribute [rw] description
|
3068
|
-
#
|
3570
|
+
# Specifies a new description for the alias.
|
3069
3571
|
# @return [String]
|
3070
3572
|
#
|
3071
3573
|
# @!attribute [rw] routing_configuration
|
3072
|
-
#
|
3574
|
+
# Contains details about the routing configuration of the alias.
|
3073
3575
|
# @return [Array<Types::AgentAliasRoutingConfigurationListItem>]
|
3074
3576
|
#
|
3075
3577
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentAliasRequest AWS API Documentation
|
3076
3578
|
#
|
3077
3579
|
class UpdateAgentAliasRequest < Struct.new(
|
3078
|
-
:agent_id,
|
3079
3580
|
:agent_alias_id,
|
3080
3581
|
:agent_alias_name,
|
3582
|
+
:agent_id,
|
3081
3583
|
:description,
|
3082
3584
|
:routing_configuration)
|
3083
3585
|
SENSITIVE = []
|
3084
3586
|
include Aws::Structure
|
3085
3587
|
end
|
3086
3588
|
|
3087
|
-
# Update Agent Alias Response
|
3088
|
-
#
|
3089
3589
|
# @!attribute [rw] agent_alias
|
3090
|
-
# Contains the
|
3590
|
+
# Contains details about the alias that was updated.
|
3091
3591
|
# @return [Types::AgentAlias]
|
3092
3592
|
#
|
3093
3593
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentAliasResponse AWS API Documentation
|
@@ -3098,27 +3598,33 @@ module Aws::BedrockAgent
|
|
3098
3598
|
include Aws::Structure
|
3099
3599
|
end
|
3100
3600
|
|
3101
|
-
# Update Agent Knowledge Base Request
|
3102
|
-
#
|
3103
3601
|
# @!attribute [rw] agent_id
|
3104
|
-
#
|
3602
|
+
# The unique identifier of the agent associated with the knowledge
|
3603
|
+
# base that you want to update.
|
3105
3604
|
# @return [String]
|
3106
3605
|
#
|
3107
3606
|
# @!attribute [rw] agent_version
|
3108
|
-
#
|
3607
|
+
# The version of the agent associated with the knowledge base that you
|
3608
|
+
# want to update.
|
3109
3609
|
# @return [String]
|
3110
3610
|
#
|
3111
|
-
# @!attribute [rw]
|
3112
|
-
#
|
3113
|
-
#
|
3611
|
+
# @!attribute [rw] description
|
3612
|
+
# Specifies a new description for the knowledge base associated with
|
3613
|
+
# an agent.
|
3114
3614
|
# @return [String]
|
3115
3615
|
#
|
3116
|
-
# @!attribute [rw]
|
3117
|
-
#
|
3616
|
+
# @!attribute [rw] knowledge_base_id
|
3617
|
+
# The unique identifier of the knowledge base that has been associated
|
3618
|
+
# with an agent.
|
3118
3619
|
# @return [String]
|
3119
3620
|
#
|
3120
3621
|
# @!attribute [rw] knowledge_base_state
|
3121
|
-
#
|
3622
|
+
# Specifies whether the agent uses the knowledge base or not when
|
3623
|
+
# sending an [InvokeAgent][1] request.
|
3624
|
+
#
|
3625
|
+
#
|
3626
|
+
#
|
3627
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
|
3122
3628
|
# @return [String]
|
3123
3629
|
#
|
3124
3630
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBaseRequest AWS API Documentation
|
@@ -3126,17 +3632,16 @@ module Aws::BedrockAgent
|
|
3126
3632
|
class UpdateAgentKnowledgeBaseRequest < Struct.new(
|
3127
3633
|
:agent_id,
|
3128
3634
|
:agent_version,
|
3129
|
-
:knowledge_base_id,
|
3130
3635
|
:description,
|
3636
|
+
:knowledge_base_id,
|
3131
3637
|
:knowledge_base_state)
|
3132
3638
|
SENSITIVE = []
|
3133
3639
|
include Aws::Structure
|
3134
3640
|
end
|
3135
3641
|
|
3136
|
-
# Update Agent Knowledge Base Response
|
3137
|
-
#
|
3138
3642
|
# @!attribute [rw] agent_knowledge_base
|
3139
|
-
# Contains the
|
3643
|
+
# Contains details about the knowledge base that has been associated
|
3644
|
+
# with an agent.
|
3140
3645
|
# @return [Types::AgentKnowledgeBase]
|
3141
3646
|
#
|
3142
3647
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBaseResponse AWS API Documentation
|
@@ -3147,42 +3652,54 @@ module Aws::BedrockAgent
|
|
3147
3652
|
include Aws::Structure
|
3148
3653
|
end
|
3149
3654
|
|
3150
|
-
# Update Agent Request
|
3151
|
-
#
|
3152
3655
|
# @!attribute [rw] agent_id
|
3153
|
-
#
|
3656
|
+
# The unique identifier of the agent.
|
3154
3657
|
# @return [String]
|
3155
3658
|
#
|
3156
3659
|
# @!attribute [rw] agent_name
|
3157
|
-
#
|
3660
|
+
# Specifies a new name for the agent.
|
3158
3661
|
# @return [String]
|
3159
3662
|
#
|
3160
|
-
# @!attribute [rw]
|
3161
|
-
#
|
3663
|
+
# @!attribute [rw] agent_resource_role_arn
|
3664
|
+
# The Amazon Resource Name (ARN) of the IAM role with permissions to
|
3665
|
+
# invoke API operations on the agent.
|
3162
3666
|
# @return [String]
|
3163
3667
|
#
|
3164
|
-
# @!attribute [rw]
|
3165
|
-
#
|
3668
|
+
# @!attribute [rw] customer_encryption_key_arn
|
3669
|
+
# The Amazon Resource Name (ARN) of the KMS key with which to encrypt
|
3670
|
+
# the agent.
|
3166
3671
|
# @return [String]
|
3167
3672
|
#
|
3168
3673
|
# @!attribute [rw] description
|
3169
|
-
#
|
3674
|
+
# Specifies a new description of the agent.
|
3675
|
+
# @return [String]
|
3676
|
+
#
|
3677
|
+
# @!attribute [rw] foundation_model
|
3678
|
+
# Specifies a new foundation model to be used for orchestration by the
|
3679
|
+
# agent.
|
3170
3680
|
# @return [String]
|
3171
3681
|
#
|
3172
3682
|
# @!attribute [rw] idle_session_ttl_in_seconds
|
3173
|
-
#
|
3174
|
-
#
|
3683
|
+
# The number of seconds for which Amazon Bedrock keeps information
|
3684
|
+
# about a user's conversation with the agent.
|
3175
3685
|
#
|
3176
|
-
#
|
3177
|
-
#
|
3178
|
-
#
|
3686
|
+
# A user interaction remains active for the amount of time specified.
|
3687
|
+
# If no conversation occurs during this time, the session expires and
|
3688
|
+
# Amazon Bedrock deletes any data provided before the timeout.
|
3689
|
+
# @return [Integer]
|
3179
3690
|
#
|
3180
|
-
# @!attribute [rw]
|
3181
|
-
#
|
3691
|
+
# @!attribute [rw] instruction
|
3692
|
+
# Specifies new instructions that tell the agent what it should do and
|
3693
|
+
# how it should interact with users.
|
3182
3694
|
# @return [String]
|
3183
3695
|
#
|
3184
3696
|
# @!attribute [rw] prompt_override_configuration
|
3185
|
-
#
|
3697
|
+
# Contains configurations to override prompts in different parts of an
|
3698
|
+
# agent sequence. For more information, see [Advanced prompts][1].
|
3699
|
+
#
|
3700
|
+
#
|
3701
|
+
#
|
3702
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
|
3186
3703
|
# @return [Types::PromptOverrideConfiguration]
|
3187
3704
|
#
|
3188
3705
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentRequest AWS API Documentation
|
@@ -3190,21 +3707,19 @@ module Aws::BedrockAgent
|
|
3190
3707
|
class UpdateAgentRequest < Struct.new(
|
3191
3708
|
:agent_id,
|
3192
3709
|
:agent_name,
|
3193
|
-
:instruction,
|
3194
|
-
:foundation_model,
|
3195
|
-
:description,
|
3196
|
-
:idle_session_ttl_in_seconds,
|
3197
3710
|
:agent_resource_role_arn,
|
3198
3711
|
:customer_encryption_key_arn,
|
3712
|
+
:description,
|
3713
|
+
:foundation_model,
|
3714
|
+
:idle_session_ttl_in_seconds,
|
3715
|
+
:instruction,
|
3199
3716
|
:prompt_override_configuration)
|
3200
3717
|
SENSITIVE = [:instruction, :prompt_override_configuration]
|
3201
3718
|
include Aws::Structure
|
3202
3719
|
end
|
3203
3720
|
|
3204
|
-
# Update Agent Response
|
3205
|
-
#
|
3206
3721
|
# @!attribute [rw] agent
|
3207
|
-
# Contains the
|
3722
|
+
# Contains details about the agent that was updated.
|
3208
3723
|
# @return [Types::Agent]
|
3209
3724
|
#
|
3210
3725
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentResponse AWS API Documentation
|
@@ -3215,42 +3730,44 @@ module Aws::BedrockAgent
|
|
3215
3730
|
include Aws::Structure
|
3216
3731
|
end
|
3217
3732
|
|
3218
|
-
# @!attribute [rw]
|
3219
|
-
#
|
3220
|
-
# @return [
|
3733
|
+
# @!attribute [rw] data_source_configuration
|
3734
|
+
# Contains details about the storage configuration of the data source.
|
3735
|
+
# @return [Types::DataSourceConfiguration]
|
3221
3736
|
#
|
3222
3737
|
# @!attribute [rw] data_source_id
|
3223
|
-
#
|
3738
|
+
# The unique identifier of the data source.
|
3224
3739
|
# @return [String]
|
3225
3740
|
#
|
3226
|
-
# @!attribute [rw]
|
3227
|
-
#
|
3741
|
+
# @!attribute [rw] description
|
3742
|
+
# Specifies a new description for the data source.
|
3228
3743
|
# @return [String]
|
3229
3744
|
#
|
3230
|
-
# @!attribute [rw]
|
3231
|
-
#
|
3745
|
+
# @!attribute [rw] knowledge_base_id
|
3746
|
+
# The unique identifier of the knowledge base to which the data source
|
3747
|
+
# belongs.
|
3232
3748
|
# @return [String]
|
3233
3749
|
#
|
3234
|
-
# @!attribute [rw]
|
3235
|
-
# Specifies a
|
3236
|
-
# @return [
|
3750
|
+
# @!attribute [rw] name
|
3751
|
+
# Specifies a new name for the data source.
|
3752
|
+
# @return [String]
|
3237
3753
|
#
|
3238
3754
|
# @!attribute [rw] server_side_encryption_configuration
|
3239
|
-
#
|
3755
|
+
# Contains details about server-side encryption of the data source.
|
3240
3756
|
# @return [Types::ServerSideEncryptionConfiguration]
|
3241
3757
|
#
|
3242
3758
|
# @!attribute [rw] vector_ingestion_configuration
|
3243
|
-
#
|
3759
|
+
# Contains details about how to ingest the documents in the data
|
3760
|
+
# source.
|
3244
3761
|
# @return [Types::VectorIngestionConfiguration]
|
3245
3762
|
#
|
3246
3763
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateDataSourceRequest AWS API Documentation
|
3247
3764
|
#
|
3248
3765
|
class UpdateDataSourceRequest < Struct.new(
|
3249
|
-
:
|
3766
|
+
:data_source_configuration,
|
3250
3767
|
:data_source_id,
|
3251
|
-
:name,
|
3252
3768
|
:description,
|
3253
|
-
:
|
3769
|
+
:knowledge_base_id,
|
3770
|
+
:name,
|
3254
3771
|
:server_side_encryption_configuration,
|
3255
3772
|
:vector_ingestion_configuration)
|
3256
3773
|
SENSITIVE = []
|
@@ -3258,7 +3775,7 @@ module Aws::BedrockAgent
|
|
3258
3775
|
end
|
3259
3776
|
|
3260
3777
|
# @!attribute [rw] data_source
|
3261
|
-
# Contains
|
3778
|
+
# Contains details about the data source.
|
3262
3779
|
# @return [Types::DataSource]
|
3263
3780
|
#
|
3264
3781
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateDataSourceResponse AWS API Documentation
|
@@ -3269,46 +3786,50 @@ module Aws::BedrockAgent
|
|
3269
3786
|
include Aws::Structure
|
3270
3787
|
end
|
3271
3788
|
|
3272
|
-
# @!attribute [rw]
|
3273
|
-
#
|
3789
|
+
# @!attribute [rw] description
|
3790
|
+
# Specifies a new description for the knowledge base.
|
3274
3791
|
# @return [String]
|
3275
3792
|
#
|
3276
|
-
# @!attribute [rw]
|
3277
|
-
#
|
3793
|
+
# @!attribute [rw] knowledge_base_configuration
|
3794
|
+
# Specifies the configuration for the embeddings model used for the
|
3795
|
+
# knowledge base. You must use the same configuration as when the
|
3796
|
+
# knowledge base was created.
|
3797
|
+
# @return [Types::KnowledgeBaseConfiguration]
|
3798
|
+
#
|
3799
|
+
# @!attribute [rw] knowledge_base_id
|
3800
|
+
# The unique identifier of the knowledge base to update.
|
3278
3801
|
# @return [String]
|
3279
3802
|
#
|
3280
|
-
# @!attribute [rw]
|
3281
|
-
#
|
3803
|
+
# @!attribute [rw] name
|
3804
|
+
# Specifies a new name for the knowledge base.
|
3282
3805
|
# @return [String]
|
3283
3806
|
#
|
3284
3807
|
# @!attribute [rw] role_arn
|
3285
|
-
# ARN of
|
3808
|
+
# Specifies a different Amazon Resource Name (ARN) of the IAM role
|
3809
|
+
# with permissions to invoke API operations on the knowledge base.
|
3286
3810
|
# @return [String]
|
3287
3811
|
#
|
3288
|
-
# @!attribute [rw] knowledge_base_configuration
|
3289
|
-
# Configures a bedrock knowledge base.
|
3290
|
-
# @return [Types::KnowledgeBaseConfiguration]
|
3291
|
-
#
|
3292
3812
|
# @!attribute [rw] storage_configuration
|
3293
|
-
#
|
3294
|
-
# base.
|
3813
|
+
# Specifies the configuration for the vector store used for the
|
3814
|
+
# knowledge base. You must use the same configuration as when the
|
3815
|
+
# knowledge base was created.
|
3295
3816
|
# @return [Types::StorageConfiguration]
|
3296
3817
|
#
|
3297
3818
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateKnowledgeBaseRequest AWS API Documentation
|
3298
3819
|
#
|
3299
3820
|
class UpdateKnowledgeBaseRequest < Struct.new(
|
3821
|
+
:description,
|
3822
|
+
:knowledge_base_configuration,
|
3300
3823
|
:knowledge_base_id,
|
3301
3824
|
:name,
|
3302
|
-
:description,
|
3303
3825
|
:role_arn,
|
3304
|
-
:knowledge_base_configuration,
|
3305
3826
|
:storage_configuration)
|
3306
3827
|
SENSITIVE = []
|
3307
3828
|
include Aws::Structure
|
3308
3829
|
end
|
3309
3830
|
|
3310
3831
|
# @!attribute [rw] knowledge_base
|
3311
|
-
# Contains
|
3832
|
+
# Contains details about the knowledge base.
|
3312
3833
|
# @return [Types::KnowledgeBase]
|
3313
3834
|
#
|
3314
3835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateKnowledgeBaseResponse AWS API Documentation
|
@@ -3319,49 +3840,52 @@ module Aws::BedrockAgent
|
|
3319
3840
|
include Aws::Structure
|
3320
3841
|
end
|
3321
3842
|
|
3322
|
-
#
|
3323
|
-
#
|
3324
|
-
# @!attribute [rw] message
|
3325
|
-
# Non Blank String
|
3326
|
-
# @return [String]
|
3843
|
+
# Input validation failed. Check your request parameters and retry the
|
3844
|
+
# request.
|
3327
3845
|
#
|
3328
3846
|
# @!attribute [rw] field_list
|
3329
|
-
# list of
|
3847
|
+
# A list of objects containing fields that caused validation errors
|
3848
|
+
# and their corresponding validation error messages.
|
3330
3849
|
# @return [Array<Types::ValidationExceptionField>]
|
3331
3850
|
#
|
3851
|
+
# @!attribute [rw] message
|
3852
|
+
# @return [String]
|
3853
|
+
#
|
3332
3854
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ValidationException AWS API Documentation
|
3333
3855
|
#
|
3334
3856
|
class ValidationException < Struct.new(
|
3335
|
-
:
|
3336
|
-
:
|
3857
|
+
:field_list,
|
3858
|
+
:message)
|
3337
3859
|
SENSITIVE = []
|
3338
3860
|
include Aws::Structure
|
3339
3861
|
end
|
3340
3862
|
|
3341
3863
|
# Stores information about a field passed inside a request that resulted
|
3342
|
-
# in an
|
3864
|
+
# in an validation error.
|
3343
3865
|
#
|
3344
|
-
# @!attribute [rw]
|
3345
|
-
#
|
3866
|
+
# @!attribute [rw] message
|
3867
|
+
# A message describing why this field failed validation.
|
3346
3868
|
# @return [String]
|
3347
3869
|
#
|
3348
|
-
# @!attribute [rw]
|
3349
|
-
#
|
3870
|
+
# @!attribute [rw] name
|
3871
|
+
# The name of the field.
|
3350
3872
|
# @return [String]
|
3351
3873
|
#
|
3352
3874
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ValidationExceptionField AWS API Documentation
|
3353
3875
|
#
|
3354
3876
|
class ValidationExceptionField < Struct.new(
|
3355
|
-
:
|
3356
|
-
:
|
3877
|
+
:message,
|
3878
|
+
:name)
|
3357
3879
|
SENSITIVE = []
|
3358
3880
|
include Aws::Structure
|
3359
3881
|
end
|
3360
3882
|
|
3361
|
-
#
|
3883
|
+
# Contains details about how to ingest the documents in a data source.
|
3362
3884
|
#
|
3363
3885
|
# @!attribute [rw] chunking_configuration
|
3364
|
-
#
|
3886
|
+
# Details about how to chunk the documents in the data source. A
|
3887
|
+
# *chunk* refers to an excerpt from a data source that is returned
|
3888
|
+
# when the knowledge base that it belongs to is queried.
|
3365
3889
|
# @return [Types::ChunkingConfiguration]
|
3366
3890
|
#
|
3367
3891
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorIngestionConfiguration AWS API Documentation
|
@@ -3372,10 +3896,12 @@ module Aws::BedrockAgent
|
|
3372
3896
|
include Aws::Structure
|
3373
3897
|
end
|
3374
3898
|
|
3375
|
-
#
|
3899
|
+
# Contains details about the model used to create vector embeddings for
|
3900
|
+
# the knowledge base.
|
3376
3901
|
#
|
3377
3902
|
# @!attribute [rw] embedding_model_arn
|
3378
|
-
#
|
3903
|
+
# The Amazon Resource Name (ARN) of the model used to create vector
|
3904
|
+
# embeddings for the knowledge base.
|
3379
3905
|
# @return [String]
|
3380
3906
|
#
|
3381
3907
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorKnowledgeBaseConfiguration AWS API Documentation
|