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