aws-sdk-qconnect 1.19.0 → 1.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qconnect/client.rb +1733 -46
- data/lib/aws-sdk-qconnect/client_api.rb +819 -1
- data/lib/aws-sdk-qconnect/endpoints.rb +209 -0
- data/lib/aws-sdk-qconnect/plugins/endpoints.rb +38 -0
- data/lib/aws-sdk-qconnect/types.rb +2153 -101
- data/lib/aws-sdk-qconnect.rb +4 -2
- data/sig/client.rbs +509 -3
- data/sig/types.rbs +580 -5
- metadata +4 -4
@@ -10,6 +10,454 @@
|
|
10
10
|
module Aws::QConnect
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# A typed union that specifies the configuration based on the type of AI
|
14
|
+
# Agent.
|
15
|
+
#
|
16
|
+
# @note AIAgentConfiguration is a union - when making an API calls you must set exactly one of the members.
|
17
|
+
#
|
18
|
+
# @note AIAgentConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AIAgentConfiguration corresponding to the set member.
|
19
|
+
#
|
20
|
+
# @!attribute [rw] answer_recommendation_ai_agent_configuration
|
21
|
+
# The configuration for AI Agents of type `ANSWER_RECOMMENDATION`.
|
22
|
+
# @return [Types::AnswerRecommendationAIAgentConfiguration]
|
23
|
+
#
|
24
|
+
# @!attribute [rw] manual_search_ai_agent_configuration
|
25
|
+
# The configuration for AI Agents of type `MANUAL_SEARCH`.
|
26
|
+
# @return [Types::ManualSearchAIAgentConfiguration]
|
27
|
+
#
|
28
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIAgentConfiguration AWS API Documentation
|
29
|
+
#
|
30
|
+
class AIAgentConfiguration < Struct.new(
|
31
|
+
:answer_recommendation_ai_agent_configuration,
|
32
|
+
:manual_search_ai_agent_configuration,
|
33
|
+
:unknown)
|
34
|
+
SENSITIVE = []
|
35
|
+
include Aws::Structure
|
36
|
+
include Aws::Structure::Union
|
37
|
+
|
38
|
+
class AnswerRecommendationAiAgentConfiguration < AIAgentConfiguration; end
|
39
|
+
class ManualSearchAiAgentConfiguration < AIAgentConfiguration; end
|
40
|
+
class Unknown < AIAgentConfiguration; end
|
41
|
+
end
|
42
|
+
|
43
|
+
# A type that specifies the AI Agent ID configuration data when mapping
|
44
|
+
# an AI Agents to be used for an AI Agent type on a session or
|
45
|
+
# assistant.
|
46
|
+
#
|
47
|
+
# @!attribute [rw] ai_agent_id
|
48
|
+
# The ID of the AI Agent to be configured.
|
49
|
+
# @return [String]
|
50
|
+
#
|
51
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIAgentConfigurationData AWS API Documentation
|
52
|
+
#
|
53
|
+
class AIAgentConfigurationData < Struct.new(
|
54
|
+
:ai_agent_id)
|
55
|
+
SENSITIVE = []
|
56
|
+
include Aws::Structure
|
57
|
+
end
|
58
|
+
|
59
|
+
# The data for the AI Agent.
|
60
|
+
#
|
61
|
+
# @!attribute [rw] ai_agent_arn
|
62
|
+
# The Amazon Resource Name (ARN) of the AI agent.
|
63
|
+
# @return [String]
|
64
|
+
#
|
65
|
+
# @!attribute [rw] ai_agent_id
|
66
|
+
# The identifier of the AI Agent.
|
67
|
+
# @return [String]
|
68
|
+
#
|
69
|
+
# @!attribute [rw] assistant_arn
|
70
|
+
# The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
|
71
|
+
# @return [String]
|
72
|
+
#
|
73
|
+
# @!attribute [rw] assistant_id
|
74
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
75
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
76
|
+
# @return [String]
|
77
|
+
#
|
78
|
+
# @!attribute [rw] configuration
|
79
|
+
# Configuration for the AI Agent.
|
80
|
+
# @return [Types::AIAgentConfiguration]
|
81
|
+
#
|
82
|
+
# @!attribute [rw] description
|
83
|
+
# The description of the AI Agent.
|
84
|
+
# @return [String]
|
85
|
+
#
|
86
|
+
# @!attribute [rw] modified_time
|
87
|
+
# The time the AI Agent was last modified.
|
88
|
+
# @return [Time]
|
89
|
+
#
|
90
|
+
# @!attribute [rw] name
|
91
|
+
# The name of the AI Agent.
|
92
|
+
# @return [String]
|
93
|
+
#
|
94
|
+
# @!attribute [rw] origin
|
95
|
+
# Specifies the origin of the AI Agent. `SYSTEM` for a default AI
|
96
|
+
# Agent created by Q in Connect or `CUSTOMER` for an AI Agent created
|
97
|
+
# by calling AI Agent creation APIs.
|
98
|
+
# @return [String]
|
99
|
+
#
|
100
|
+
# @!attribute [rw] status
|
101
|
+
# The status of the AI Agent.
|
102
|
+
# @return [String]
|
103
|
+
#
|
104
|
+
# @!attribute [rw] tags
|
105
|
+
# The tags used to organize, track, or control access for this
|
106
|
+
# resource.
|
107
|
+
# @return [Hash<String,String>]
|
108
|
+
#
|
109
|
+
# @!attribute [rw] type
|
110
|
+
# The type of the AI Agent.
|
111
|
+
# @return [String]
|
112
|
+
#
|
113
|
+
# @!attribute [rw] visibility_status
|
114
|
+
# The visibility status of the AI Agent.
|
115
|
+
# @return [String]
|
116
|
+
#
|
117
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIAgentData AWS API Documentation
|
118
|
+
#
|
119
|
+
class AIAgentData < Struct.new(
|
120
|
+
:ai_agent_arn,
|
121
|
+
:ai_agent_id,
|
122
|
+
:assistant_arn,
|
123
|
+
:assistant_id,
|
124
|
+
:configuration,
|
125
|
+
:description,
|
126
|
+
:modified_time,
|
127
|
+
:name,
|
128
|
+
:origin,
|
129
|
+
:status,
|
130
|
+
:tags,
|
131
|
+
:type,
|
132
|
+
:visibility_status)
|
133
|
+
SENSITIVE = []
|
134
|
+
include Aws::Structure
|
135
|
+
end
|
136
|
+
|
137
|
+
# The summary of the AI Agent.
|
138
|
+
#
|
139
|
+
# @!attribute [rw] ai_agent_arn
|
140
|
+
# The Amazon Resource Name (ARN) of the AI agent.
|
141
|
+
# @return [String]
|
142
|
+
#
|
143
|
+
# @!attribute [rw] ai_agent_id
|
144
|
+
# The identifier of the AI Agent.
|
145
|
+
# @return [String]
|
146
|
+
#
|
147
|
+
# @!attribute [rw] assistant_arn
|
148
|
+
# The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
|
149
|
+
# @return [String]
|
150
|
+
#
|
151
|
+
# @!attribute [rw] assistant_id
|
152
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
153
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
154
|
+
# @return [String]
|
155
|
+
#
|
156
|
+
# @!attribute [rw] configuration
|
157
|
+
# The configuration for the AI Agent.
|
158
|
+
# @return [Types::AIAgentConfiguration]
|
159
|
+
#
|
160
|
+
# @!attribute [rw] description
|
161
|
+
# The description of the AI Agent.
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] modified_time
|
165
|
+
# The time the AI Agent was last modified.
|
166
|
+
# @return [Time]
|
167
|
+
#
|
168
|
+
# @!attribute [rw] name
|
169
|
+
# The name of the AI Agent.
|
170
|
+
# @return [String]
|
171
|
+
#
|
172
|
+
# @!attribute [rw] origin
|
173
|
+
# The origin of the AI Agent. `SYSTEM` for a default AI Agent created
|
174
|
+
# by Q in Connect or `CUSTOMER` for an AI Agent created by calling AI
|
175
|
+
# Agent creation APIs.
|
176
|
+
# @return [String]
|
177
|
+
#
|
178
|
+
# @!attribute [rw] status
|
179
|
+
# The status of the AI Agent.
|
180
|
+
# @return [String]
|
181
|
+
#
|
182
|
+
# @!attribute [rw] tags
|
183
|
+
# The tags used to organize, track, or control access for this
|
184
|
+
# resource.
|
185
|
+
# @return [Hash<String,String>]
|
186
|
+
#
|
187
|
+
# @!attribute [rw] type
|
188
|
+
# The type of the AI Agent.
|
189
|
+
# @return [String]
|
190
|
+
#
|
191
|
+
# @!attribute [rw] visibility_status
|
192
|
+
# The visibility status of the AI Agent.
|
193
|
+
# @return [String]
|
194
|
+
#
|
195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIAgentSummary AWS API Documentation
|
196
|
+
#
|
197
|
+
class AIAgentSummary < Struct.new(
|
198
|
+
:ai_agent_arn,
|
199
|
+
:ai_agent_id,
|
200
|
+
:assistant_arn,
|
201
|
+
:assistant_id,
|
202
|
+
:configuration,
|
203
|
+
:description,
|
204
|
+
:modified_time,
|
205
|
+
:name,
|
206
|
+
:origin,
|
207
|
+
:status,
|
208
|
+
:tags,
|
209
|
+
:type,
|
210
|
+
:visibility_status)
|
211
|
+
SENSITIVE = []
|
212
|
+
include Aws::Structure
|
213
|
+
end
|
214
|
+
|
215
|
+
# The summary of the AI Agent version.
|
216
|
+
#
|
217
|
+
# @!attribute [rw] ai_agent_summary
|
218
|
+
# The data for the summary of the AI Agent version.
|
219
|
+
# @return [Types::AIAgentSummary]
|
220
|
+
#
|
221
|
+
# @!attribute [rw] version_number
|
222
|
+
# The version number for this AI Agent version.
|
223
|
+
# @return [Integer]
|
224
|
+
#
|
225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIAgentVersionSummary AWS API Documentation
|
226
|
+
#
|
227
|
+
class AIAgentVersionSummary < Struct.new(
|
228
|
+
:ai_agent_summary,
|
229
|
+
:version_number)
|
230
|
+
SENSITIVE = []
|
231
|
+
include Aws::Structure
|
232
|
+
end
|
233
|
+
|
234
|
+
# The data for the AI Prompt
|
235
|
+
#
|
236
|
+
# @!attribute [rw] ai_prompt_arn
|
237
|
+
# The Amazon Resource Name (ARN) of the AI Prompt.
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @!attribute [rw] ai_prompt_id
|
241
|
+
# The identifier of the Amazon Q in Connect AI prompt.
|
242
|
+
# @return [String]
|
243
|
+
#
|
244
|
+
# @!attribute [rw] api_format
|
245
|
+
# The API format used for this AI Prompt.
|
246
|
+
# @return [String]
|
247
|
+
#
|
248
|
+
# @!attribute [rw] assistant_arn
|
249
|
+
# The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
|
250
|
+
# @return [String]
|
251
|
+
#
|
252
|
+
# @!attribute [rw] assistant_id
|
253
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
254
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
255
|
+
# @return [String]
|
256
|
+
#
|
257
|
+
# @!attribute [rw] description
|
258
|
+
# The description of the AI Prompt.
|
259
|
+
# @return [String]
|
260
|
+
#
|
261
|
+
# @!attribute [rw] model_id
|
262
|
+
# The identifier of the model used for this AI Prompt. Model Ids
|
263
|
+
# supported are: `CLAUDE_3_HAIKU_20240307_V1`.
|
264
|
+
# @return [String]
|
265
|
+
#
|
266
|
+
# @!attribute [rw] modified_time
|
267
|
+
# The time the AI Prompt was last modified.
|
268
|
+
# @return [Time]
|
269
|
+
#
|
270
|
+
# @!attribute [rw] name
|
271
|
+
# The name of the AI Prompt
|
272
|
+
# @return [String]
|
273
|
+
#
|
274
|
+
# @!attribute [rw] origin
|
275
|
+
# The origin of the AI Prompt. `SYSTEM` for a default AI Prompt
|
276
|
+
# created by Q in Connect or `CUSTOMER` for an AI Prompt created by
|
277
|
+
# calling AI Prompt creation APIs.
|
278
|
+
# @return [String]
|
279
|
+
#
|
280
|
+
# @!attribute [rw] status
|
281
|
+
# The status of the AI Prompt.
|
282
|
+
# @return [String]
|
283
|
+
#
|
284
|
+
# @!attribute [rw] tags
|
285
|
+
# The tags used to organize, track, or control access for this
|
286
|
+
# resource.
|
287
|
+
# @return [Hash<String,String>]
|
288
|
+
#
|
289
|
+
# @!attribute [rw] template_configuration
|
290
|
+
# The configuration of the prompt template for this AI Prompt.
|
291
|
+
# @return [Types::AIPromptTemplateConfiguration]
|
292
|
+
#
|
293
|
+
# @!attribute [rw] template_type
|
294
|
+
# The type of the prompt template for this AI Prompt.
|
295
|
+
# @return [String]
|
296
|
+
#
|
297
|
+
# @!attribute [rw] type
|
298
|
+
# The type of this AI Prompt.
|
299
|
+
# @return [String]
|
300
|
+
#
|
301
|
+
# @!attribute [rw] visibility_status
|
302
|
+
# The visibility status of the AI Prompt.
|
303
|
+
# @return [String]
|
304
|
+
#
|
305
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIPromptData AWS API Documentation
|
306
|
+
#
|
307
|
+
class AIPromptData < Struct.new(
|
308
|
+
:ai_prompt_arn,
|
309
|
+
:ai_prompt_id,
|
310
|
+
:api_format,
|
311
|
+
:assistant_arn,
|
312
|
+
:assistant_id,
|
313
|
+
:description,
|
314
|
+
:model_id,
|
315
|
+
:modified_time,
|
316
|
+
:name,
|
317
|
+
:origin,
|
318
|
+
:status,
|
319
|
+
:tags,
|
320
|
+
:template_configuration,
|
321
|
+
:template_type,
|
322
|
+
:type,
|
323
|
+
:visibility_status)
|
324
|
+
SENSITIVE = []
|
325
|
+
include Aws::Structure
|
326
|
+
end
|
327
|
+
|
328
|
+
# The summary of the AI Prompt.
|
329
|
+
#
|
330
|
+
# @!attribute [rw] ai_prompt_arn
|
331
|
+
# The Amazon Resource Name (ARN) of the AI Prompt.
|
332
|
+
# @return [String]
|
333
|
+
#
|
334
|
+
# @!attribute [rw] ai_prompt_id
|
335
|
+
# The identifier of the Amazon Q in Connect AI prompt.
|
336
|
+
# @return [String]
|
337
|
+
#
|
338
|
+
# @!attribute [rw] api_format
|
339
|
+
# The API format used for this AI Prompt.
|
340
|
+
# @return [String]
|
341
|
+
#
|
342
|
+
# @!attribute [rw] assistant_arn
|
343
|
+
# The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
|
344
|
+
# @return [String]
|
345
|
+
#
|
346
|
+
# @!attribute [rw] assistant_id
|
347
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
348
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
349
|
+
# @return [String]
|
350
|
+
#
|
351
|
+
# @!attribute [rw] description
|
352
|
+
# The description of the AI Prompt.
|
353
|
+
# @return [String]
|
354
|
+
#
|
355
|
+
# @!attribute [rw] model_id
|
356
|
+
# The identifier of the model used for this AI Prompt. Model Ids
|
357
|
+
# supported are: `CLAUDE_3_HAIKU_20240307_V1`.
|
358
|
+
# @return [String]
|
359
|
+
#
|
360
|
+
# @!attribute [rw] modified_time
|
361
|
+
# The time the AI Prompt was last modified.
|
362
|
+
# @return [Time]
|
363
|
+
#
|
364
|
+
# @!attribute [rw] name
|
365
|
+
# The name of the AI Prompt.
|
366
|
+
# @return [String]
|
367
|
+
#
|
368
|
+
# @!attribute [rw] origin
|
369
|
+
# The origin of the AI Prompt. `SYSTEM` for a default AI Prompt
|
370
|
+
# created by Q in Connect or `CUSTOMER` for an AI Prompt created by
|
371
|
+
# calling AI Prompt creation APIs.
|
372
|
+
# @return [String]
|
373
|
+
#
|
374
|
+
# @!attribute [rw] status
|
375
|
+
# The status of the AI Prompt.
|
376
|
+
# @return [String]
|
377
|
+
#
|
378
|
+
# @!attribute [rw] tags
|
379
|
+
# The tags used to organize, track, or control access for this
|
380
|
+
# resource.
|
381
|
+
# @return [Hash<String,String>]
|
382
|
+
#
|
383
|
+
# @!attribute [rw] template_type
|
384
|
+
# The type of the prompt template for this AI Prompt.
|
385
|
+
# @return [String]
|
386
|
+
#
|
387
|
+
# @!attribute [rw] type
|
388
|
+
# The type of this AI Prompt.
|
389
|
+
# @return [String]
|
390
|
+
#
|
391
|
+
# @!attribute [rw] visibility_status
|
392
|
+
# The visibility status of the AI Prompt.
|
393
|
+
# @return [String]
|
394
|
+
#
|
395
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIPromptSummary AWS API Documentation
|
396
|
+
#
|
397
|
+
class AIPromptSummary < Struct.new(
|
398
|
+
:ai_prompt_arn,
|
399
|
+
:ai_prompt_id,
|
400
|
+
:api_format,
|
401
|
+
:assistant_arn,
|
402
|
+
:assistant_id,
|
403
|
+
:description,
|
404
|
+
:model_id,
|
405
|
+
:modified_time,
|
406
|
+
:name,
|
407
|
+
:origin,
|
408
|
+
:status,
|
409
|
+
:tags,
|
410
|
+
:template_type,
|
411
|
+
:type,
|
412
|
+
:visibility_status)
|
413
|
+
SENSITIVE = []
|
414
|
+
include Aws::Structure
|
415
|
+
end
|
416
|
+
|
417
|
+
# A typed union that specifies the configuration for a prompt template
|
418
|
+
# based on its type.
|
419
|
+
#
|
420
|
+
# @note AIPromptTemplateConfiguration is a union - when making an API calls you must set exactly one of the members.
|
421
|
+
#
|
422
|
+
# @note AIPromptTemplateConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AIPromptTemplateConfiguration corresponding to the set member.
|
423
|
+
#
|
424
|
+
# @!attribute [rw] text_full_ai_prompt_edit_template_configuration
|
425
|
+
# The configuration for a prompt template that supports full textual
|
426
|
+
# prompt configuration using a YAML prompt.
|
427
|
+
# @return [Types::TextFullAIPromptEditTemplateConfiguration]
|
428
|
+
#
|
429
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIPromptTemplateConfiguration AWS API Documentation
|
430
|
+
#
|
431
|
+
class AIPromptTemplateConfiguration < Struct.new(
|
432
|
+
:text_full_ai_prompt_edit_template_configuration,
|
433
|
+
:unknown)
|
434
|
+
SENSITIVE = []
|
435
|
+
include Aws::Structure
|
436
|
+
include Aws::Structure::Union
|
437
|
+
|
438
|
+
class TextFullAiPromptEditTemplateConfiguration < AIPromptTemplateConfiguration; end
|
439
|
+
class Unknown < AIPromptTemplateConfiguration; end
|
440
|
+
end
|
441
|
+
|
442
|
+
# The summary of the AI Prompt version.
|
443
|
+
#
|
444
|
+
# @!attribute [rw] ai_prompt_summary
|
445
|
+
# The date for the summary of the AI Prompt version.
|
446
|
+
# @return [Types::AIPromptSummary]
|
447
|
+
#
|
448
|
+
# @!attribute [rw] version_number
|
449
|
+
# The version number for this AI Prompt version.
|
450
|
+
# @return [Integer]
|
451
|
+
#
|
452
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIPromptVersionSummary AWS API Documentation
|
453
|
+
#
|
454
|
+
class AIPromptVersionSummary < Struct.new(
|
455
|
+
:ai_prompt_summary,
|
456
|
+
:version_number)
|
457
|
+
SENSITIVE = []
|
458
|
+
include Aws::Structure
|
459
|
+
end
|
460
|
+
|
13
461
|
# You do not have sufficient access to perform this action.
|
14
462
|
#
|
15
463
|
# @!attribute [rw] message
|
@@ -42,6 +490,39 @@ module Aws::QConnect
|
|
42
490
|
include Aws::Structure
|
43
491
|
end
|
44
492
|
|
493
|
+
# The configuration for the `ANSWER_RECOMMENDATION` AI Agent type.
|
494
|
+
#
|
495
|
+
# @!attribute [rw] answer_generation_ai_prompt_id
|
496
|
+
# The AI Prompt identifier for the Answer Generation prompt used by
|
497
|
+
# the `ANSWER_RECOMMENDATION` AI Agent.
|
498
|
+
# @return [String]
|
499
|
+
#
|
500
|
+
# @!attribute [rw] association_configurations
|
501
|
+
# The association configurations for overriding behavior on this AI
|
502
|
+
# Agent.
|
503
|
+
# @return [Array<Types::AssociationConfiguration>]
|
504
|
+
#
|
505
|
+
# @!attribute [rw] intent_labeling_generation_ai_prompt_id
|
506
|
+
# The AI Prompt identifier for the Intent Labeling prompt used by the
|
507
|
+
# `ANSWER_RECOMMENDATION` AI Agent.
|
508
|
+
# @return [String]
|
509
|
+
#
|
510
|
+
# @!attribute [rw] query_reformulation_ai_prompt_id
|
511
|
+
# The AI Prompt identifier for the Query Reformulation prompt used by
|
512
|
+
# the `ANSWER_RECOMMENDATION` AI Agent.
|
513
|
+
# @return [String]
|
514
|
+
#
|
515
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AnswerRecommendationAIAgentConfiguration AWS API Documentation
|
516
|
+
#
|
517
|
+
class AnswerRecommendationAIAgentConfiguration < Struct.new(
|
518
|
+
:answer_generation_ai_prompt_id,
|
519
|
+
:association_configurations,
|
520
|
+
:intent_labeling_generation_ai_prompt_id,
|
521
|
+
:query_reformulation_ai_prompt_id)
|
522
|
+
SENSITIVE = []
|
523
|
+
include Aws::Structure
|
524
|
+
end
|
525
|
+
|
45
526
|
# Configuration information for Amazon AppIntegrations to automatically
|
46
527
|
# ingest content.
|
47
528
|
#
|
@@ -84,7 +565,7 @@ module Aws::QConnect
|
|
84
565
|
# [2]: https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api
|
85
566
|
# [3]: https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/
|
86
567
|
# [4]: https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index
|
87
|
-
# [5]:
|
568
|
+
# [5]: http://aws.amazon.com/s3/
|
88
569
|
# @return [String]
|
89
570
|
#
|
90
571
|
# @!attribute [rw] object_fields
|
@@ -273,6 +754,11 @@ module Aws::QConnect
|
|
273
754
|
|
274
755
|
# The assistant data.
|
275
756
|
#
|
757
|
+
# @!attribute [rw] ai_agent_configuration
|
758
|
+
# The configuration of the AI Agents (mapped by AI Agent Type to AI
|
759
|
+
# Agent version) that is set on the Amazon Q in Connect Assistant.
|
760
|
+
# @return [Hash<String,Types::AIAgentConfigurationData>]
|
761
|
+
#
|
276
762
|
# @!attribute [rw] assistant_arn
|
277
763
|
# The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
|
278
764
|
# @return [String]
|
@@ -336,6 +822,7 @@ module Aws::QConnect
|
|
336
822
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssistantData AWS API Documentation
|
337
823
|
#
|
338
824
|
class AssistantData < Struct.new(
|
825
|
+
:ai_agent_configuration,
|
339
826
|
:assistant_arn,
|
340
827
|
:assistant_id,
|
341
828
|
:capability_configuration,
|
@@ -368,6 +855,11 @@ module Aws::QConnect
|
|
368
855
|
|
369
856
|
# Summary information about the assistant.
|
370
857
|
#
|
858
|
+
# @!attribute [rw] ai_agent_configuration
|
859
|
+
# The configuration of the AI Agents (mapped by AI Agent Type to AI
|
860
|
+
# Agent version) that is set on the Amazon Q in Connect Assistant.
|
861
|
+
# @return [Hash<String,Types::AIAgentConfigurationData>]
|
862
|
+
#
|
371
863
|
# @!attribute [rw] assistant_arn
|
372
864
|
# The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
|
373
865
|
# @return [String]
|
@@ -406,41 +898,176 @@ module Aws::QConnect
|
|
406
898
|
# `kms:DescribeKey` permissions to the `connect.amazonaws.com` service
|
407
899
|
# principal.
|
408
900
|
#
|
409
|
-
# For more information about setting up a customer managed key for
|
410
|
-
# Amazon Q in Connect, see [Enable Amazon Q in Connect for your
|
411
|
-
# instance][1].
|
901
|
+
# For more information about setting up a customer managed key for
|
902
|
+
# Amazon Q in Connect, see [Enable Amazon Q in Connect for your
|
903
|
+
# instance][1].
|
904
|
+
#
|
905
|
+
#
|
906
|
+
#
|
907
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html
|
908
|
+
# @return [Types::ServerSideEncryptionConfiguration]
|
909
|
+
#
|
910
|
+
# @!attribute [rw] status
|
911
|
+
# The status of the assistant.
|
912
|
+
# @return [String]
|
913
|
+
#
|
914
|
+
# @!attribute [rw] tags
|
915
|
+
# The tags used to organize, track, or control access for this
|
916
|
+
# resource.
|
917
|
+
# @return [Hash<String,String>]
|
918
|
+
#
|
919
|
+
# @!attribute [rw] type
|
920
|
+
# The type of the assistant.
|
921
|
+
# @return [String]
|
922
|
+
#
|
923
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssistantSummary AWS API Documentation
|
924
|
+
#
|
925
|
+
class AssistantSummary < Struct.new(
|
926
|
+
:ai_agent_configuration,
|
927
|
+
:assistant_arn,
|
928
|
+
:assistant_id,
|
929
|
+
:capability_configuration,
|
930
|
+
:description,
|
931
|
+
:integration_configuration,
|
932
|
+
:name,
|
933
|
+
:server_side_encryption_configuration,
|
934
|
+
:status,
|
935
|
+
:tags,
|
936
|
+
:type)
|
937
|
+
SENSITIVE = []
|
938
|
+
include Aws::Structure
|
939
|
+
end
|
940
|
+
|
941
|
+
# The configuration for an Amazon Q in Connect Assistant Association.
|
942
|
+
#
|
943
|
+
# @!attribute [rw] association_configuration_data
|
944
|
+
# The data of the configuration for an Amazon Q in Connect Assistant
|
945
|
+
# Association.
|
946
|
+
# @return [Types::AssociationConfigurationData]
|
947
|
+
#
|
948
|
+
# @!attribute [rw] association_id
|
949
|
+
# The identifier of the association for this Association
|
950
|
+
# Configuration.
|
951
|
+
# @return [String]
|
952
|
+
#
|
953
|
+
# @!attribute [rw] association_type
|
954
|
+
# The type of the association for this Association Configuration.
|
955
|
+
# @return [String]
|
956
|
+
#
|
957
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssociationConfiguration AWS API Documentation
|
958
|
+
#
|
959
|
+
class AssociationConfiguration < Struct.new(
|
960
|
+
:association_configuration_data,
|
961
|
+
:association_id,
|
962
|
+
:association_type)
|
963
|
+
SENSITIVE = []
|
964
|
+
include Aws::Structure
|
965
|
+
end
|
966
|
+
|
967
|
+
# A typed union of the data of the configuration for an Amazon Q in
|
968
|
+
# Connect Assistant Association.
|
969
|
+
#
|
970
|
+
# @note AssociationConfigurationData is a union - when making an API calls you must set exactly one of the members.
|
971
|
+
#
|
972
|
+
# @note AssociationConfigurationData is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AssociationConfigurationData corresponding to the set member.
|
973
|
+
#
|
974
|
+
# @!attribute [rw] knowledge_base_association_configuration_data
|
975
|
+
# The data of the configuration for a `KNOWLEDGE_BASE` type Amazon Q
|
976
|
+
# in Connect Assistant Association.
|
977
|
+
# @return [Types::KnowledgeBaseAssociationConfigurationData]
|
978
|
+
#
|
979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssociationConfigurationData AWS API Documentation
|
980
|
+
#
|
981
|
+
class AssociationConfigurationData < Struct.new(
|
982
|
+
:knowledge_base_association_configuration_data,
|
983
|
+
:unknown)
|
984
|
+
SENSITIVE = []
|
985
|
+
include Aws::Structure
|
986
|
+
include Aws::Structure::Union
|
987
|
+
|
988
|
+
class KnowledgeBaseAssociationConfigurationData < AssociationConfigurationData; end
|
989
|
+
class Unknown < AssociationConfigurationData; end
|
990
|
+
end
|
991
|
+
|
992
|
+
# Settings for a foundation model used to parse documents for a data
|
993
|
+
# source.
|
994
|
+
#
|
995
|
+
# @!attribute [rw] model_arn
|
996
|
+
# The ARN of the foundation model.
|
997
|
+
# @return [String]
|
412
998
|
#
|
999
|
+
# @!attribute [rw] parsing_prompt
|
1000
|
+
# Instructions for interpreting the contents of a document.
|
1001
|
+
# @return [Types::ParsingPrompt]
|
413
1002
|
#
|
1003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/BedrockFoundationModelConfigurationForParsing AWS API Documentation
|
414
1004
|
#
|
415
|
-
|
416
|
-
|
1005
|
+
class BedrockFoundationModelConfigurationForParsing < Struct.new(
|
1006
|
+
:model_arn,
|
1007
|
+
:parsing_prompt)
|
1008
|
+
SENSITIVE = []
|
1009
|
+
include Aws::Structure
|
1010
|
+
end
|
1011
|
+
|
1012
|
+
# Details about how to chunk the documents in the data source. A chunk
|
1013
|
+
# refers to an excerpt from a data source that is returned when the
|
1014
|
+
# knowledge base that it belongs to is queried.
|
417
1015
|
#
|
418
|
-
# @!attribute [rw]
|
419
|
-
#
|
1016
|
+
# @!attribute [rw] chunking_strategy
|
1017
|
+
# Knowledge base can split your source data into chunks. A chunk
|
1018
|
+
# refers to an excerpt from a data source that is returned when the
|
1019
|
+
# knowledge base that it belongs to is queried. You have the following
|
1020
|
+
# options for chunking your data. If you opt for `NONE`, then you may
|
1021
|
+
# want to pre-process your files by splitting them up such that each
|
1022
|
+
# file corresponds to a chunk.
|
420
1023
|
# @return [String]
|
421
1024
|
#
|
422
|
-
# @!attribute [rw]
|
423
|
-
#
|
424
|
-
#
|
425
|
-
# @return [
|
1025
|
+
# @!attribute [rw] fixed_size_chunking_configuration
|
1026
|
+
# Configurations for when you choose fixed-size chunking. If you set
|
1027
|
+
# the `chunkingStrategy` as `NONE`, exclude this field.
|
1028
|
+
# @return [Types::FixedSizeChunkingConfiguration]
|
426
1029
|
#
|
427
|
-
# @!attribute [rw]
|
428
|
-
#
|
429
|
-
#
|
1030
|
+
# @!attribute [rw] hierarchical_chunking_configuration
|
1031
|
+
# Settings for hierarchical document chunking for a data source.
|
1032
|
+
# Hierarchical chunking splits documents into layers of chunks where
|
1033
|
+
# the first layer contains large chunks, and the second layer contains
|
1034
|
+
# smaller chunks derived from the first layer.
|
1035
|
+
# @return [Types::HierarchicalChunkingConfiguration]
|
430
1036
|
#
|
431
|
-
#
|
1037
|
+
# @!attribute [rw] semantic_chunking_configuration
|
1038
|
+
# Settings for semantic document chunking for a data source. Semantic
|
1039
|
+
# chunking splits a document into smaller documents based on groups of
|
1040
|
+
# similar content derived from the text with natural language
|
1041
|
+
# processing.
|
1042
|
+
# @return [Types::SemanticChunkingConfiguration]
|
432
1043
|
#
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
:
|
437
|
-
:
|
438
|
-
:
|
439
|
-
:
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
1044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ChunkingConfiguration AWS API Documentation
|
1045
|
+
#
|
1046
|
+
class ChunkingConfiguration < Struct.new(
|
1047
|
+
:chunking_strategy,
|
1048
|
+
:fixed_size_chunking_configuration,
|
1049
|
+
:hierarchical_chunking_configuration,
|
1050
|
+
:semantic_chunking_configuration)
|
1051
|
+
SENSITIVE = []
|
1052
|
+
include Aws::Structure
|
1053
|
+
end
|
1054
|
+
|
1055
|
+
# Contains information about where the text with a citation begins and
|
1056
|
+
# ends in the generated output.
|
1057
|
+
#
|
1058
|
+
# @!attribute [rw] begin_offset_inclusive
|
1059
|
+
# Where the text with a citation starts in the generated output.
|
1060
|
+
# @return [Integer]
|
1061
|
+
#
|
1062
|
+
# @!attribute [rw] end_offset_exclusive
|
1063
|
+
# Where the text with a citation ends in the generated output.
|
1064
|
+
# @return [Integer]
|
1065
|
+
#
|
1066
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CitationSpan AWS API Documentation
|
1067
|
+
#
|
1068
|
+
class CitationSpan < Struct.new(
|
1069
|
+
:begin_offset_inclusive,
|
1070
|
+
:end_offset_exclusive)
|
444
1071
|
SENSITIVE = []
|
445
1072
|
include Aws::Structure
|
446
1073
|
end
|
@@ -778,82 +1405,366 @@ module Aws::QConnect
|
|
778
1405
|
# QUICK\_RESPONSES type knowledge base.
|
779
1406
|
# @return [String]
|
780
1407
|
#
|
781
|
-
#
|
1408
|
+
# @!attribute [rw] reference_type
|
1409
|
+
# The type of reference content.
|
1410
|
+
# @return [String]
|
1411
|
+
#
|
1412
|
+
# @!attribute [rw] source_url
|
1413
|
+
# The web URL of the source content.
|
1414
|
+
# @return [String]
|
1415
|
+
#
|
1416
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ContentReference AWS API Documentation
|
1417
|
+
#
|
1418
|
+
class ContentReference < Struct.new(
|
1419
|
+
:content_arn,
|
1420
|
+
:content_id,
|
1421
|
+
:knowledge_base_arn,
|
1422
|
+
:knowledge_base_id,
|
1423
|
+
:reference_type,
|
1424
|
+
:source_url)
|
1425
|
+
SENSITIVE = []
|
1426
|
+
include Aws::Structure
|
1427
|
+
end
|
1428
|
+
|
1429
|
+
# Summary information about the content.
|
1430
|
+
#
|
1431
|
+
# @!attribute [rw] content_arn
|
1432
|
+
# The Amazon Resource Name (ARN) of the content.
|
1433
|
+
# @return [String]
|
1434
|
+
#
|
1435
|
+
# @!attribute [rw] content_id
|
1436
|
+
# The identifier of the content.
|
1437
|
+
# @return [String]
|
1438
|
+
#
|
1439
|
+
# @!attribute [rw] content_type
|
1440
|
+
# The media type of the content.
|
1441
|
+
# @return [String]
|
1442
|
+
#
|
1443
|
+
# @!attribute [rw] knowledge_base_arn
|
1444
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
1445
|
+
# @return [String]
|
1446
|
+
#
|
1447
|
+
# @!attribute [rw] knowledge_base_id
|
1448
|
+
# The identifier of the knowledge base. This should not be a
|
1449
|
+
# QUICK\_RESPONSES type knowledge base.
|
1450
|
+
# @return [String]
|
1451
|
+
#
|
1452
|
+
# @!attribute [rw] metadata
|
1453
|
+
# A key/value map to store attributes without affecting tagging or
|
1454
|
+
# recommendations. For example, when synchronizing data between an
|
1455
|
+
# external system and Amazon Q in Connect, you can store an external
|
1456
|
+
# version identifier as metadata to utilize for determining drift.
|
1457
|
+
# @return [Hash<String,String>]
|
1458
|
+
#
|
1459
|
+
# @!attribute [rw] name
|
1460
|
+
# The name of the content.
|
1461
|
+
# @return [String]
|
1462
|
+
#
|
1463
|
+
# @!attribute [rw] revision_id
|
1464
|
+
# The identifier of the revision of the content.
|
1465
|
+
# @return [String]
|
1466
|
+
#
|
1467
|
+
# @!attribute [rw] status
|
1468
|
+
# The status of the content.
|
1469
|
+
# @return [String]
|
1470
|
+
#
|
1471
|
+
# @!attribute [rw] tags
|
1472
|
+
# The tags used to organize, track, or control access for this
|
1473
|
+
# resource.
|
1474
|
+
# @return [Hash<String,String>]
|
1475
|
+
#
|
1476
|
+
# @!attribute [rw] title
|
1477
|
+
# The title of the content.
|
1478
|
+
# @return [String]
|
1479
|
+
#
|
1480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ContentSummary AWS API Documentation
|
1481
|
+
#
|
1482
|
+
class ContentSummary < Struct.new(
|
1483
|
+
:content_arn,
|
1484
|
+
:content_id,
|
1485
|
+
:content_type,
|
1486
|
+
:knowledge_base_arn,
|
1487
|
+
:knowledge_base_id,
|
1488
|
+
:metadata,
|
1489
|
+
:name,
|
1490
|
+
:revision_id,
|
1491
|
+
:status,
|
1492
|
+
:tags,
|
1493
|
+
:title)
|
1494
|
+
SENSITIVE = []
|
1495
|
+
include Aws::Structure
|
1496
|
+
end
|
1497
|
+
|
1498
|
+
# @!attribute [rw] assistant_id
|
1499
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
1500
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
1501
|
+
# @return [String]
|
1502
|
+
#
|
1503
|
+
# @!attribute [rw] client_token
|
1504
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1505
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
1506
|
+
# this field. For more information about idempotency, see [Making
|
1507
|
+
# retries safe with idempotent APIs][1].
|
1508
|
+
#
|
1509
|
+
# **A suitable default value is auto-generated.** You should normally
|
1510
|
+
# not need to pass this option.
|
1511
|
+
#
|
1512
|
+
#
|
1513
|
+
#
|
1514
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1515
|
+
# @return [String]
|
1516
|
+
#
|
1517
|
+
# @!attribute [rw] configuration
|
1518
|
+
# The configuration of the AI Agent.
|
1519
|
+
# @return [Types::AIAgentConfiguration]
|
1520
|
+
#
|
1521
|
+
# @!attribute [rw] description
|
1522
|
+
# The description of the AI Agent.
|
1523
|
+
# @return [String]
|
1524
|
+
#
|
1525
|
+
# @!attribute [rw] name
|
1526
|
+
# The name of the AI Agent.
|
1527
|
+
# @return [String]
|
1528
|
+
#
|
1529
|
+
# @!attribute [rw] tags
|
1530
|
+
# The tags used to organize, track, or control access for this
|
1531
|
+
# resource.
|
1532
|
+
# @return [Hash<String,String>]
|
1533
|
+
#
|
1534
|
+
# @!attribute [rw] type
|
1535
|
+
# The type of the AI Agent.
|
1536
|
+
# @return [String]
|
1537
|
+
#
|
1538
|
+
# @!attribute [rw] visibility_status
|
1539
|
+
# The visibility status of the AI Agent.
|
1540
|
+
# @return [String]
|
1541
|
+
#
|
1542
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIAgentRequest AWS API Documentation
|
1543
|
+
#
|
1544
|
+
class CreateAIAgentRequest < Struct.new(
|
1545
|
+
:assistant_id,
|
1546
|
+
:client_token,
|
1547
|
+
:configuration,
|
1548
|
+
:description,
|
1549
|
+
:name,
|
1550
|
+
:tags,
|
1551
|
+
:type,
|
1552
|
+
:visibility_status)
|
1553
|
+
SENSITIVE = []
|
1554
|
+
include Aws::Structure
|
1555
|
+
end
|
1556
|
+
|
1557
|
+
# @!attribute [rw] ai_agent
|
1558
|
+
# The data of the created AI Agent.
|
1559
|
+
# @return [Types::AIAgentData]
|
1560
|
+
#
|
1561
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIAgentResponse AWS API Documentation
|
1562
|
+
#
|
1563
|
+
class CreateAIAgentResponse < Struct.new(
|
1564
|
+
:ai_agent)
|
1565
|
+
SENSITIVE = []
|
1566
|
+
include Aws::Structure
|
1567
|
+
end
|
1568
|
+
|
1569
|
+
# @!attribute [rw] ai_agent_id
|
1570
|
+
# The identifier of the Amazon Q in Connect AI Agent.
|
1571
|
+
# @return [String]
|
1572
|
+
#
|
1573
|
+
# @!attribute [rw] assistant_id
|
1574
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
1575
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
1576
|
+
# @return [String]
|
1577
|
+
#
|
1578
|
+
# @!attribute [rw] client_token
|
1579
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1580
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
1581
|
+
# this field. For more information about idempotency, see [Making
|
1582
|
+
# retries safe with idempotent APIs][1].
|
1583
|
+
#
|
1584
|
+
# **A suitable default value is auto-generated.** You should normally
|
1585
|
+
# not need to pass this option.
|
1586
|
+
#
|
1587
|
+
#
|
1588
|
+
#
|
1589
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1590
|
+
# @return [String]
|
1591
|
+
#
|
1592
|
+
# @!attribute [rw] modified_time
|
1593
|
+
# The modification time of the AI Agent should be tracked for version
|
1594
|
+
# creation. This field should be specified to avoid version creation
|
1595
|
+
# when simultaneous update to the underlying AI Agent are possible.
|
1596
|
+
# The value should be the modifiedTime returned from the request to
|
1597
|
+
# create or update an AI Agent so that version creation can fail if an
|
1598
|
+
# update to the AI Agent post the specified modification time has been
|
1599
|
+
# made.
|
1600
|
+
# @return [Time]
|
1601
|
+
#
|
1602
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIAgentVersionRequest AWS API Documentation
|
1603
|
+
#
|
1604
|
+
class CreateAIAgentVersionRequest < Struct.new(
|
1605
|
+
:ai_agent_id,
|
1606
|
+
:assistant_id,
|
1607
|
+
:client_token,
|
1608
|
+
:modified_time)
|
1609
|
+
SENSITIVE = []
|
1610
|
+
include Aws::Structure
|
1611
|
+
end
|
1612
|
+
|
1613
|
+
# @!attribute [rw] ai_agent
|
1614
|
+
# The data of the AI Agent version.
|
1615
|
+
# @return [Types::AIAgentData]
|
1616
|
+
#
|
1617
|
+
# @!attribute [rw] version_number
|
1618
|
+
# The version number of the AI Agent version.
|
1619
|
+
# @return [Integer]
|
1620
|
+
#
|
1621
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIAgentVersionResponse AWS API Documentation
|
1622
|
+
#
|
1623
|
+
class CreateAIAgentVersionResponse < Struct.new(
|
1624
|
+
:ai_agent,
|
1625
|
+
:version_number)
|
1626
|
+
SENSITIVE = []
|
1627
|
+
include Aws::Structure
|
1628
|
+
end
|
1629
|
+
|
1630
|
+
# @!attribute [rw] api_format
|
1631
|
+
# The API Format of the AI Prompt.
|
1632
|
+
# @return [String]
|
1633
|
+
#
|
1634
|
+
# @!attribute [rw] assistant_id
|
1635
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
1636
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
1637
|
+
# @return [String]
|
1638
|
+
#
|
1639
|
+
# @!attribute [rw] client_token
|
1640
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1641
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
1642
|
+
# this field. For more information about idempotency, see [Making
|
1643
|
+
# retries safe with idempotent APIs][1].
|
1644
|
+
#
|
1645
|
+
# **A suitable default value is auto-generated.** You should normally
|
1646
|
+
# not need to pass this option.
|
1647
|
+
#
|
1648
|
+
#
|
1649
|
+
#
|
1650
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1651
|
+
# @return [String]
|
1652
|
+
#
|
1653
|
+
# @!attribute [rw] description
|
1654
|
+
# The description of the AI Prompt.
|
1655
|
+
# @return [String]
|
1656
|
+
#
|
1657
|
+
# @!attribute [rw] model_id
|
1658
|
+
# The identifier of the model used for this AI Prompt. Model Ids
|
1659
|
+
# supported are: `CLAUDE_3_HAIKU_20240307_V1`
|
1660
|
+
# @return [String]
|
1661
|
+
#
|
1662
|
+
# @!attribute [rw] name
|
1663
|
+
# The name of the AI Prompt.
|
1664
|
+
# @return [String]
|
1665
|
+
#
|
1666
|
+
# @!attribute [rw] tags
|
1667
|
+
# The tags used to organize, track, or control access for this
|
1668
|
+
# resource.
|
1669
|
+
# @return [Hash<String,String>]
|
1670
|
+
#
|
1671
|
+
# @!attribute [rw] template_configuration
|
1672
|
+
# The configuration of the prompt template for this AI Prompt.
|
1673
|
+
# @return [Types::AIPromptTemplateConfiguration]
|
1674
|
+
#
|
1675
|
+
# @!attribute [rw] template_type
|
1676
|
+
# The type of the prompt template for this AI Prompt.
|
1677
|
+
# @return [String]
|
1678
|
+
#
|
1679
|
+
# @!attribute [rw] type
|
1680
|
+
# The type of this AI Prompt.
|
1681
|
+
# @return [String]
|
1682
|
+
#
|
1683
|
+
# @!attribute [rw] visibility_status
|
1684
|
+
# The visibility status of the AI Prompt.
|
1685
|
+
# @return [String]
|
1686
|
+
#
|
1687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptRequest AWS API Documentation
|
782
1688
|
#
|
783
|
-
class
|
784
|
-
:
|
785
|
-
:
|
786
|
-
:
|
787
|
-
:
|
1689
|
+
class CreateAIPromptRequest < Struct.new(
|
1690
|
+
:api_format,
|
1691
|
+
:assistant_id,
|
1692
|
+
:client_token,
|
1693
|
+
:description,
|
1694
|
+
:model_id,
|
1695
|
+
:name,
|
1696
|
+
:tags,
|
1697
|
+
:template_configuration,
|
1698
|
+
:template_type,
|
1699
|
+
:type,
|
1700
|
+
:visibility_status)
|
788
1701
|
SENSITIVE = []
|
789
1702
|
include Aws::Structure
|
790
1703
|
end
|
791
1704
|
|
792
|
-
#
|
1705
|
+
# @!attribute [rw] ai_prompt
|
1706
|
+
# The data of the AI Prompt.
|
1707
|
+
# @return [Types::AIPromptData]
|
793
1708
|
#
|
794
|
-
#
|
795
|
-
# The Amazon Resource Name (ARN) of the content.
|
796
|
-
# @return [String]
|
1709
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptResponse AWS API Documentation
|
797
1710
|
#
|
798
|
-
|
799
|
-
|
1711
|
+
class CreateAIPromptResponse < Struct.new(
|
1712
|
+
:ai_prompt)
|
1713
|
+
SENSITIVE = []
|
1714
|
+
include Aws::Structure
|
1715
|
+
end
|
1716
|
+
|
1717
|
+
# @!attribute [rw] ai_prompt_id
|
1718
|
+
# The identifier of the Amazon Q in Connect AI prompt.
|
800
1719
|
# @return [String]
|
801
1720
|
#
|
802
|
-
# @!attribute [rw]
|
803
|
-
# The
|
1721
|
+
# @!attribute [rw] assistant_id
|
1722
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
1723
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
804
1724
|
# @return [String]
|
805
1725
|
#
|
806
|
-
# @!attribute [rw]
|
807
|
-
#
|
808
|
-
#
|
1726
|
+
# @!attribute [rw] client_token
|
1727
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1728
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
1729
|
+
# this field. For more information about idempotency, see [Making
|
1730
|
+
# retries safe with idempotent APIs][1].
|
809
1731
|
#
|
810
|
-
#
|
811
|
-
#
|
812
|
-
# QUICK\_RESPONSES type knowledge base.
|
813
|
-
# @return [String]
|
1732
|
+
# **A suitable default value is auto-generated.** You should normally
|
1733
|
+
# not need to pass this option.
|
814
1734
|
#
|
815
|
-
# @!attribute [rw] metadata
|
816
|
-
# A key/value map to store attributes without affecting tagging or
|
817
|
-
# recommendations. For example, when synchronizing data between an
|
818
|
-
# external system and Amazon Q in Connect, you can store an external
|
819
|
-
# version identifier as metadata to utilize for determining drift.
|
820
|
-
# @return [Hash<String,String>]
|
821
1735
|
#
|
822
|
-
# @!attribute [rw] name
|
823
|
-
# The name of the content.
|
824
|
-
# @return [String]
|
825
1736
|
#
|
826
|
-
#
|
827
|
-
# The identifier of the revision of the content.
|
1737
|
+
# [1]: http://aws.amazon.com/https:/aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
828
1738
|
# @return [String]
|
829
1739
|
#
|
830
|
-
# @!attribute [rw]
|
831
|
-
# The
|
832
|
-
# @return [
|
1740
|
+
# @!attribute [rw] modified_time
|
1741
|
+
# The time the AI Prompt was last modified.
|
1742
|
+
# @return [Time]
|
833
1743
|
#
|
834
|
-
#
|
835
|
-
# The tags used to organize, track, or control access for this
|
836
|
-
# resource.
|
837
|
-
# @return [Hash<String,String>]
|
1744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptVersionRequest AWS API Documentation
|
838
1745
|
#
|
839
|
-
|
840
|
-
|
841
|
-
|
1746
|
+
class CreateAIPromptVersionRequest < Struct.new(
|
1747
|
+
:ai_prompt_id,
|
1748
|
+
:assistant_id,
|
1749
|
+
:client_token,
|
1750
|
+
:modified_time)
|
1751
|
+
SENSITIVE = []
|
1752
|
+
include Aws::Structure
|
1753
|
+
end
|
1754
|
+
|
1755
|
+
# @!attribute [rw] ai_prompt
|
1756
|
+
# The data of the AI Prompt version.
|
1757
|
+
# @return [Types::AIPromptData]
|
842
1758
|
#
|
843
|
-
#
|
1759
|
+
# @!attribute [rw] version_number
|
1760
|
+
# The version number of the AI Prompt version.
|
1761
|
+
# @return [Integer]
|
844
1762
|
#
|
845
|
-
|
846
|
-
|
847
|
-
|
848
|
-
:
|
849
|
-
:
|
850
|
-
:knowledge_base_id,
|
851
|
-
:metadata,
|
852
|
-
:name,
|
853
|
-
:revision_id,
|
854
|
-
:status,
|
855
|
-
:tags,
|
856
|
-
:title)
|
1763
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptVersionResponse AWS API Documentation
|
1764
|
+
#
|
1765
|
+
class CreateAIPromptVersionResponse < Struct.new(
|
1766
|
+
:ai_prompt,
|
1767
|
+
:version_number)
|
857
1768
|
SENSITIVE = []
|
858
1769
|
include Aws::Structure
|
859
1770
|
end
|
@@ -1203,6 +2114,10 @@ module Aws::QConnect
|
|
1203
2114
|
# resource.
|
1204
2115
|
# @return [Hash<String,String>]
|
1205
2116
|
#
|
2117
|
+
# @!attribute [rw] vector_ingestion_configuration
|
2118
|
+
# Contains details about how to ingest the documents in a data source.
|
2119
|
+
# @return [Types::VectorIngestionConfiguration]
|
2120
|
+
#
|
1206
2121
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateKnowledgeBaseRequest AWS API Documentation
|
1207
2122
|
#
|
1208
2123
|
class CreateKnowledgeBaseRequest < Struct.new(
|
@@ -1213,7 +2128,8 @@ module Aws::QConnect
|
|
1213
2128
|
:rendering_configuration,
|
1214
2129
|
:server_side_encryption_configuration,
|
1215
2130
|
:source_configuration,
|
1216
|
-
:tags
|
2131
|
+
:tags,
|
2132
|
+
:vector_ingestion_configuration)
|
1217
2133
|
SENSITIVE = []
|
1218
2134
|
include Aws::Structure
|
1219
2135
|
end
|
@@ -1332,6 +2248,12 @@ module Aws::QConnect
|
|
1332
2248
|
include Aws::Structure
|
1333
2249
|
end
|
1334
2250
|
|
2251
|
+
# @!attribute [rw] ai_agent_configuration
|
2252
|
+
# The configuration of the AI Agents (mapped by AI Agent Type to AI
|
2253
|
+
# Agent version) that should be used by Amazon Q in Connect for this
|
2254
|
+
# Session.
|
2255
|
+
# @return [Hash<String,Types::AIAgentConfigurationData>]
|
2256
|
+
#
|
1335
2257
|
# @!attribute [rw] assistant_id
|
1336
2258
|
# The identifier of the Amazon Q in Connect assistant. Can be either
|
1337
2259
|
# the ID or the ARN. URLs cannot contain the ARN.
|
@@ -1371,6 +2293,7 @@ module Aws::QConnect
|
|
1371
2293
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateSessionRequest AWS API Documentation
|
1372
2294
|
#
|
1373
2295
|
class CreateSessionRequest < Struct.new(
|
2296
|
+
:ai_agent_configuration,
|
1374
2297
|
:assistant_id,
|
1375
2298
|
:client_token,
|
1376
2299
|
:description,
|
@@ -1405,6 +2328,10 @@ module Aws::QConnect
|
|
1405
2328
|
# Details about the generative data.
|
1406
2329
|
# @return [Types::GenerativeDataDetails]
|
1407
2330
|
#
|
2331
|
+
# @!attribute [rw] intent_detected_data
|
2332
|
+
# Details about the intent data.
|
2333
|
+
# @return [Types::IntentDetectedDataDetails]
|
2334
|
+
#
|
1408
2335
|
# @!attribute [rw] source_content_data
|
1409
2336
|
# Details about the content data.
|
1410
2337
|
# @return [Types::SourceContentDataDetails]
|
@@ -1414,6 +2341,7 @@ module Aws::QConnect
|
|
1414
2341
|
class DataDetails < Struct.new(
|
1415
2342
|
:content_data,
|
1416
2343
|
:generative_data,
|
2344
|
+
:intent_detected_data,
|
1417
2345
|
:source_content_data,
|
1418
2346
|
:unknown)
|
1419
2347
|
SENSITIVE = []
|
@@ -1422,6 +2350,7 @@ module Aws::QConnect
|
|
1422
2350
|
|
1423
2351
|
class ContentData < DataDetails; end
|
1424
2352
|
class GenerativeData < DataDetails; end
|
2353
|
+
class IntentDetectedData < DataDetails; end
|
1425
2354
|
class SourceContentData < DataDetails; end
|
1426
2355
|
class Unknown < DataDetails; end
|
1427
2356
|
end
|
@@ -1472,6 +2401,107 @@ module Aws::QConnect
|
|
1472
2401
|
include Aws::Structure
|
1473
2402
|
end
|
1474
2403
|
|
2404
|
+
# @!attribute [rw] ai_agent_id
|
2405
|
+
# The identifier of the Amazon Q in Connect AI Agent. Can be either
|
2406
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
2407
|
+
# @return [String]
|
2408
|
+
#
|
2409
|
+
# @!attribute [rw] assistant_id
|
2410
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
2411
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
2412
|
+
# @return [String]
|
2413
|
+
#
|
2414
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIAgentRequest AWS API Documentation
|
2415
|
+
#
|
2416
|
+
class DeleteAIAgentRequest < Struct.new(
|
2417
|
+
:ai_agent_id,
|
2418
|
+
:assistant_id)
|
2419
|
+
SENSITIVE = []
|
2420
|
+
include Aws::Structure
|
2421
|
+
end
|
2422
|
+
|
2423
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIAgentResponse AWS API Documentation
|
2424
|
+
#
|
2425
|
+
class DeleteAIAgentResponse < Aws::EmptyStructure; end
|
2426
|
+
|
2427
|
+
# @!attribute [rw] ai_agent_id
|
2428
|
+
# The identifier of the Amazon Q in Connect AI Agent. Can be either
|
2429
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
2430
|
+
# @return [String]
|
2431
|
+
#
|
2432
|
+
# @!attribute [rw] assistant_id
|
2433
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
2434
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
2435
|
+
# @return [String]
|
2436
|
+
#
|
2437
|
+
# @!attribute [rw] version_number
|
2438
|
+
# The version number of the AI Agent version.
|
2439
|
+
# @return [Integer]
|
2440
|
+
#
|
2441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIAgentVersionRequest AWS API Documentation
|
2442
|
+
#
|
2443
|
+
class DeleteAIAgentVersionRequest < Struct.new(
|
2444
|
+
:ai_agent_id,
|
2445
|
+
:assistant_id,
|
2446
|
+
:version_number)
|
2447
|
+
SENSITIVE = []
|
2448
|
+
include Aws::Structure
|
2449
|
+
end
|
2450
|
+
|
2451
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIAgentVersionResponse AWS API Documentation
|
2452
|
+
#
|
2453
|
+
class DeleteAIAgentVersionResponse < Aws::EmptyStructure; end
|
2454
|
+
|
2455
|
+
# @!attribute [rw] ai_prompt_id
|
2456
|
+
# The identifier of the Amazon Q in Connect AI prompt. Can be either
|
2457
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
2458
|
+
# @return [String]
|
2459
|
+
#
|
2460
|
+
# @!attribute [rw] assistant_id
|
2461
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
2462
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
2463
|
+
# @return [String]
|
2464
|
+
#
|
2465
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIPromptRequest AWS API Documentation
|
2466
|
+
#
|
2467
|
+
class DeleteAIPromptRequest < Struct.new(
|
2468
|
+
:ai_prompt_id,
|
2469
|
+
:assistant_id)
|
2470
|
+
SENSITIVE = []
|
2471
|
+
include Aws::Structure
|
2472
|
+
end
|
2473
|
+
|
2474
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIPromptResponse AWS API Documentation
|
2475
|
+
#
|
2476
|
+
class DeleteAIPromptResponse < Aws::EmptyStructure; end
|
2477
|
+
|
2478
|
+
# @!attribute [rw] ai_prompt_id
|
2479
|
+
# The identifier of the Amazon Q in Connect AI prompt.
|
2480
|
+
# @return [String]
|
2481
|
+
#
|
2482
|
+
# @!attribute [rw] assistant_id
|
2483
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
2484
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
2485
|
+
# @return [String]
|
2486
|
+
#
|
2487
|
+
# @!attribute [rw] version_number
|
2488
|
+
# The version number of the AI Prompt version to be deleted.
|
2489
|
+
# @return [Integer]
|
2490
|
+
#
|
2491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIPromptVersionRequest AWS API Documentation
|
2492
|
+
#
|
2493
|
+
class DeleteAIPromptVersionRequest < Struct.new(
|
2494
|
+
:ai_prompt_id,
|
2495
|
+
:assistant_id,
|
2496
|
+
:version_number)
|
2497
|
+
SENSITIVE = []
|
2498
|
+
include Aws::Structure
|
2499
|
+
end
|
2500
|
+
|
2501
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIPromptVersionResponse AWS API Documentation
|
2502
|
+
#
|
2503
|
+
class DeleteAIPromptVersionResponse < Aws::EmptyStructure; end
|
2504
|
+
|
1475
2505
|
# @!attribute [rw] assistant_association_id
|
1476
2506
|
# The identifier of the assistant association. Can be either the ID or
|
1477
2507
|
# the ARN. URLs cannot contain the ARN.
|
@@ -1709,6 +2739,26 @@ module Aws::QConnect
|
|
1709
2739
|
include Aws::Structure
|
1710
2740
|
end
|
1711
2741
|
|
2742
|
+
# Configurations for when you choose fixed-size chunking. If you set the
|
2743
|
+
# `chunkingStrategy` as `NONE`, exclude this field.
|
2744
|
+
#
|
2745
|
+
# @!attribute [rw] max_tokens
|
2746
|
+
# The maximum number of tokens to include in a chunk.
|
2747
|
+
# @return [Integer]
|
2748
|
+
#
|
2749
|
+
# @!attribute [rw] overlap_percentage
|
2750
|
+
# The percentage of overlap between adjacent chunks of a data source.
|
2751
|
+
# @return [Integer]
|
2752
|
+
#
|
2753
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/FixedSizeChunkingConfiguration AWS API Documentation
|
2754
|
+
#
|
2755
|
+
class FixedSizeChunkingConfiguration < Struct.new(
|
2756
|
+
:max_tokens,
|
2757
|
+
:overlap_percentage)
|
2758
|
+
SENSITIVE = []
|
2759
|
+
include Aws::Structure
|
2760
|
+
end
|
2761
|
+
|
1712
2762
|
# The feedback information for a generative target type.
|
1713
2763
|
#
|
1714
2764
|
# @!attribute [rw] relevance
|
@@ -1766,6 +2816,82 @@ module Aws::QConnect
|
|
1766
2816
|
include Aws::Structure
|
1767
2817
|
end
|
1768
2818
|
|
2819
|
+
# @!attribute [rw] ai_agent_id
|
2820
|
+
# The identifier of the Amazon Q in Connect AI Agent (with or without
|
2821
|
+
# a version qualifier). Can be either the ID or the ARN. URLs cannot
|
2822
|
+
# contain the ARN.
|
2823
|
+
# @return [String]
|
2824
|
+
#
|
2825
|
+
# @!attribute [rw] assistant_id
|
2826
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
2827
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
2828
|
+
# @return [String]
|
2829
|
+
#
|
2830
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAIAgentRequest AWS API Documentation
|
2831
|
+
#
|
2832
|
+
class GetAIAgentRequest < Struct.new(
|
2833
|
+
:ai_agent_id,
|
2834
|
+
:assistant_id)
|
2835
|
+
SENSITIVE = []
|
2836
|
+
include Aws::Structure
|
2837
|
+
end
|
2838
|
+
|
2839
|
+
# @!attribute [rw] ai_agent
|
2840
|
+
# The data of the AI Agent.
|
2841
|
+
# @return [Types::AIAgentData]
|
2842
|
+
#
|
2843
|
+
# @!attribute [rw] version_number
|
2844
|
+
# The version number of the AI Agent version (returned if an AI Agent
|
2845
|
+
# version was specified via use of a qualifier for the `aiAgentId` on
|
2846
|
+
# the request).
|
2847
|
+
# @return [Integer]
|
2848
|
+
#
|
2849
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAIAgentResponse AWS API Documentation
|
2850
|
+
#
|
2851
|
+
class GetAIAgentResponse < Struct.new(
|
2852
|
+
:ai_agent,
|
2853
|
+
:version_number)
|
2854
|
+
SENSITIVE = []
|
2855
|
+
include Aws::Structure
|
2856
|
+
end
|
2857
|
+
|
2858
|
+
# @!attribute [rw] ai_prompt_id
|
2859
|
+
# The identifier of the Amazon Q in Connect AI prompt.
|
2860
|
+
# @return [String]
|
2861
|
+
#
|
2862
|
+
# @!attribute [rw] assistant_id
|
2863
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
2864
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
2865
|
+
# @return [String]
|
2866
|
+
#
|
2867
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAIPromptRequest AWS API Documentation
|
2868
|
+
#
|
2869
|
+
class GetAIPromptRequest < Struct.new(
|
2870
|
+
:ai_prompt_id,
|
2871
|
+
:assistant_id)
|
2872
|
+
SENSITIVE = []
|
2873
|
+
include Aws::Structure
|
2874
|
+
end
|
2875
|
+
|
2876
|
+
# @!attribute [rw] ai_prompt
|
2877
|
+
# The data of the AI Prompt.
|
2878
|
+
# @return [Types::AIPromptData]
|
2879
|
+
#
|
2880
|
+
# @!attribute [rw] version_number
|
2881
|
+
# The version number of the AI Prompt version (returned if an AI
|
2882
|
+
# Prompt version was specified via use of a qualifier for the
|
2883
|
+
# `aiPromptId` on the request).
|
2884
|
+
# @return [Integer]
|
2885
|
+
#
|
2886
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAIPromptResponse AWS API Documentation
|
2887
|
+
#
|
2888
|
+
class GetAIPromptResponse < Struct.new(
|
2889
|
+
:ai_prompt,
|
2890
|
+
:version_number)
|
2891
|
+
SENSITIVE = []
|
2892
|
+
include Aws::Structure
|
2893
|
+
end
|
2894
|
+
|
1769
2895
|
# @!attribute [rw] assistant_association_id
|
1770
2896
|
# The identifier of the assistant association. Can be either the ID or
|
1771
2897
|
# the ARN. URLs cannot contain the ARN.
|
@@ -2132,6 +3258,42 @@ module Aws::QConnect
|
|
2132
3258
|
include Aws::Structure
|
2133
3259
|
end
|
2134
3260
|
|
3261
|
+
# Settings for hierarchical document chunking for a data source.
|
3262
|
+
# Hierarchical chunking splits documents into layers of chunks where the
|
3263
|
+
# first layer contains large chunks, and the second layer contains
|
3264
|
+
# smaller chunks derived from the first layer.
|
3265
|
+
#
|
3266
|
+
# @!attribute [rw] level_configurations
|
3267
|
+
# Token settings for each layer.
|
3268
|
+
# @return [Array<Types::HierarchicalChunkingLevelConfiguration>]
|
3269
|
+
#
|
3270
|
+
# @!attribute [rw] overlap_tokens
|
3271
|
+
# The number of tokens to repeat across chunks in the same layer.
|
3272
|
+
# @return [Integer]
|
3273
|
+
#
|
3274
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/HierarchicalChunkingConfiguration AWS API Documentation
|
3275
|
+
#
|
3276
|
+
class HierarchicalChunkingConfiguration < Struct.new(
|
3277
|
+
:level_configurations,
|
3278
|
+
:overlap_tokens)
|
3279
|
+
SENSITIVE = []
|
3280
|
+
include Aws::Structure
|
3281
|
+
end
|
3282
|
+
|
3283
|
+
# Token settings for each layer.
|
3284
|
+
#
|
3285
|
+
# @!attribute [rw] max_tokens
|
3286
|
+
# The maximum number of tokens that a chunk can contain in this layer.
|
3287
|
+
# @return [Integer]
|
3288
|
+
#
|
3289
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/HierarchicalChunkingLevelConfiguration AWS API Documentation
|
3290
|
+
#
|
3291
|
+
class HierarchicalChunkingLevelConfiguration < Struct.new(
|
3292
|
+
:max_tokens)
|
3293
|
+
SENSITIVE = []
|
3294
|
+
include Aws::Structure
|
3295
|
+
end
|
3296
|
+
|
2135
3297
|
# Offset specification to describe highlighting of document excerpts for
|
2136
3298
|
# rendering search results and recommendations.
|
2137
3299
|
#
|
@@ -2278,22 +3440,82 @@ module Aws::QConnect
|
|
2278
3440
|
#
|
2279
3441
|
#
|
2280
3442
|
#
|
2281
|
-
# [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
|
3443
|
+
# [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
|
3444
|
+
# @return [String]
|
3445
|
+
#
|
3446
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ImportJobSummary AWS API Documentation
|
3447
|
+
#
|
3448
|
+
class ImportJobSummary < Struct.new(
|
3449
|
+
:created_time,
|
3450
|
+
:external_source_configuration,
|
3451
|
+
:import_job_id,
|
3452
|
+
:import_job_type,
|
3453
|
+
:knowledge_base_arn,
|
3454
|
+
:knowledge_base_id,
|
3455
|
+
:last_modified_time,
|
3456
|
+
:metadata,
|
3457
|
+
:status,
|
3458
|
+
:upload_id)
|
3459
|
+
SENSITIVE = []
|
3460
|
+
include Aws::Structure
|
3461
|
+
end
|
3462
|
+
|
3463
|
+
# Details about the detected intent.
|
3464
|
+
#
|
3465
|
+
# @!attribute [rw] intent
|
3466
|
+
# The detected intent.
|
3467
|
+
# @return [String]
|
3468
|
+
#
|
3469
|
+
# @!attribute [rw] intent_id
|
3470
|
+
# The identifier of the detected intent.
|
3471
|
+
# @return [String]
|
3472
|
+
#
|
3473
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/IntentDetectedDataDetails AWS API Documentation
|
3474
|
+
#
|
3475
|
+
class IntentDetectedDataDetails < Struct.new(
|
3476
|
+
:intent,
|
3477
|
+
:intent_id)
|
3478
|
+
SENSITIVE = [:intent]
|
3479
|
+
include Aws::Structure
|
3480
|
+
end
|
3481
|
+
|
3482
|
+
# Information about the Amazon Q intent.
|
3483
|
+
#
|
3484
|
+
# @!attribute [rw] intent_id
|
3485
|
+
# The identifier of the Amazon Q intent.
|
3486
|
+
# @return [String]
|
3487
|
+
#
|
3488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/IntentInputData AWS API Documentation
|
3489
|
+
#
|
3490
|
+
class IntentInputData < Struct.new(
|
3491
|
+
:intent_id)
|
3492
|
+
SENSITIVE = []
|
3493
|
+
include Aws::Structure
|
3494
|
+
end
|
3495
|
+
|
3496
|
+
# The data of the configuration for a `KNOWLEDGE_BASE` type Amazon Q in
|
3497
|
+
# Connect Assistant Association.
|
3498
|
+
#
|
3499
|
+
# @!attribute [rw] content_tag_filter
|
3500
|
+
# An object that can be used to specify Tag conditions.
|
3501
|
+
# @return [Types::TagFilter]
|
3502
|
+
#
|
3503
|
+
# @!attribute [rw] max_results
|
3504
|
+
# The maximum number of results to return per page.
|
3505
|
+
# @return [Integer]
|
3506
|
+
#
|
3507
|
+
# @!attribute [rw] override_knowledge_base_search_type
|
3508
|
+
# The search type to be used against the Knowledge Base for this
|
3509
|
+
# request. The values can be `SEMANTIC` which uses vector embeddings
|
3510
|
+
# or `HYBRID` which use vector embeddings and raw text
|
2282
3511
|
# @return [String]
|
2283
3512
|
#
|
2284
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/
|
3513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/KnowledgeBaseAssociationConfigurationData AWS API Documentation
|
2285
3514
|
#
|
2286
|
-
class
|
2287
|
-
:
|
2288
|
-
:
|
2289
|
-
:
|
2290
|
-
:import_job_type,
|
2291
|
-
:knowledge_base_arn,
|
2292
|
-
:knowledge_base_id,
|
2293
|
-
:last_modified_time,
|
2294
|
-
:metadata,
|
2295
|
-
:status,
|
2296
|
-
:upload_id)
|
3515
|
+
class KnowledgeBaseAssociationConfigurationData < Struct.new(
|
3516
|
+
:content_tag_filter,
|
3517
|
+
:max_results,
|
3518
|
+
:override_knowledge_base_search_type)
|
2297
3519
|
SENSITIVE = []
|
2298
3520
|
include Aws::Structure
|
2299
3521
|
end
|
@@ -2323,6 +3545,14 @@ module Aws::QConnect
|
|
2323
3545
|
# The description.
|
2324
3546
|
# @return [String]
|
2325
3547
|
#
|
3548
|
+
# @!attribute [rw] ingestion_failure_reasons
|
3549
|
+
# List of failure reasons on ingestion per file.
|
3550
|
+
# @return [Array<String>]
|
3551
|
+
#
|
3552
|
+
# @!attribute [rw] ingestion_status
|
3553
|
+
# Status of ingestion on data source.
|
3554
|
+
# @return [String]
|
3555
|
+
#
|
2326
3556
|
# @!attribute [rw] knowledge_base_arn
|
2327
3557
|
# The Amazon Resource Name (ARN) of the knowledge base.
|
2328
3558
|
# @return [String]
|
@@ -2380,10 +3610,16 @@ module Aws::QConnect
|
|
2380
3610
|
# resource.
|
2381
3611
|
# @return [Hash<String,String>]
|
2382
3612
|
#
|
3613
|
+
# @!attribute [rw] vector_ingestion_configuration
|
3614
|
+
# Contains details about how to ingest the documents in a data source.
|
3615
|
+
# @return [Types::VectorIngestionConfiguration]
|
3616
|
+
#
|
2383
3617
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/KnowledgeBaseData AWS API Documentation
|
2384
3618
|
#
|
2385
3619
|
class KnowledgeBaseData < Struct.new(
|
2386
3620
|
:description,
|
3621
|
+
:ingestion_failure_reasons,
|
3622
|
+
:ingestion_status,
|
2387
3623
|
:knowledge_base_arn,
|
2388
3624
|
:knowledge_base_id,
|
2389
3625
|
:knowledge_base_type,
|
@@ -2393,7 +3629,8 @@ module Aws::QConnect
|
|
2393
3629
|
:server_side_encryption_configuration,
|
2394
3630
|
:source_configuration,
|
2395
3631
|
:status,
|
2396
|
-
:tags
|
3632
|
+
:tags,
|
3633
|
+
:vector_ingestion_configuration)
|
2397
3634
|
SENSITIVE = []
|
2398
3635
|
include Aws::Structure
|
2399
3636
|
end
|
@@ -2455,6 +3692,10 @@ module Aws::QConnect
|
|
2455
3692
|
# resource.
|
2456
3693
|
# @return [Hash<String,String>]
|
2457
3694
|
#
|
3695
|
+
# @!attribute [rw] vector_ingestion_configuration
|
3696
|
+
# Contains details about how to ingest the documents in a data source.
|
3697
|
+
# @return [Types::VectorIngestionConfiguration]
|
3698
|
+
#
|
2458
3699
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/KnowledgeBaseSummary AWS API Documentation
|
2459
3700
|
#
|
2460
3701
|
class KnowledgeBaseSummary < Struct.new(
|
@@ -2467,7 +3708,224 @@ module Aws::QConnect
|
|
2467
3708
|
:server_side_encryption_configuration,
|
2468
3709
|
:source_configuration,
|
2469
3710
|
:status,
|
2470
|
-
:tags
|
3711
|
+
:tags,
|
3712
|
+
:vector_ingestion_configuration)
|
3713
|
+
SENSITIVE = []
|
3714
|
+
include Aws::Structure
|
3715
|
+
end
|
3716
|
+
|
3717
|
+
# @!attribute [rw] ai_agent_id
|
3718
|
+
# The identifier of the Amazon Q in Connect AI Agent for which
|
3719
|
+
# versions are to be listed.
|
3720
|
+
# @return [String]
|
3721
|
+
#
|
3722
|
+
# @!attribute [rw] assistant_id
|
3723
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
3724
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
3725
|
+
# @return [String]
|
3726
|
+
#
|
3727
|
+
# @!attribute [rw] max_results
|
3728
|
+
# The maximum number of results to return per page.
|
3729
|
+
# @return [Integer]
|
3730
|
+
#
|
3731
|
+
# @!attribute [rw] next_token
|
3732
|
+
# The token for the next set of results. Use the value returned in the
|
3733
|
+
# previous response in the next request to retrieve the next set of
|
3734
|
+
# results.
|
3735
|
+
# @return [String]
|
3736
|
+
#
|
3737
|
+
# @!attribute [rw] origin
|
3738
|
+
# The origin of the AI Agent versions to be listed. `SYSTEM` for a
|
3739
|
+
# default AI Agent created by Q in Connect or `CUSTOMER` for an AI
|
3740
|
+
# Agent created by calling AI Agent creation APIs.
|
3741
|
+
# @return [String]
|
3742
|
+
#
|
3743
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentVersionsRequest AWS API Documentation
|
3744
|
+
#
|
3745
|
+
class ListAIAgentVersionsRequest < Struct.new(
|
3746
|
+
:ai_agent_id,
|
3747
|
+
:assistant_id,
|
3748
|
+
:max_results,
|
3749
|
+
:next_token,
|
3750
|
+
:origin)
|
3751
|
+
SENSITIVE = []
|
3752
|
+
include Aws::Structure
|
3753
|
+
end
|
3754
|
+
|
3755
|
+
# @!attribute [rw] ai_agent_version_summaries
|
3756
|
+
# The summaries of AI Agent versions.
|
3757
|
+
# @return [Array<Types::AIAgentVersionSummary>]
|
3758
|
+
#
|
3759
|
+
# @!attribute [rw] next_token
|
3760
|
+
# The token for the next set of results. Use the value returned in the
|
3761
|
+
# previous response in the next request to retrieve the next set of
|
3762
|
+
# results.
|
3763
|
+
# @return [String]
|
3764
|
+
#
|
3765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentVersionsResponse AWS API Documentation
|
3766
|
+
#
|
3767
|
+
class ListAIAgentVersionsResponse < Struct.new(
|
3768
|
+
:ai_agent_version_summaries,
|
3769
|
+
:next_token)
|
3770
|
+
SENSITIVE = []
|
3771
|
+
include Aws::Structure
|
3772
|
+
end
|
3773
|
+
|
3774
|
+
# @!attribute [rw] assistant_id
|
3775
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
3776
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
3777
|
+
# @return [String]
|
3778
|
+
#
|
3779
|
+
# @!attribute [rw] max_results
|
3780
|
+
# The maximum number of results to return per page.
|
3781
|
+
# @return [Integer]
|
3782
|
+
#
|
3783
|
+
# @!attribute [rw] next_token
|
3784
|
+
# The token for the next set of results. Use the value returned in the
|
3785
|
+
# previous response in the next request to retrieve the next set of
|
3786
|
+
# results.
|
3787
|
+
# @return [String]
|
3788
|
+
#
|
3789
|
+
# @!attribute [rw] origin
|
3790
|
+
# The origin of the AI Agents to be listed. `SYSTEM` for a default AI
|
3791
|
+
# Agent created by Q in Connect or `CUSTOMER` for an AI Agent created
|
3792
|
+
# by calling AI Agent creation APIs.
|
3793
|
+
# @return [String]
|
3794
|
+
#
|
3795
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentsRequest AWS API Documentation
|
3796
|
+
#
|
3797
|
+
class ListAIAgentsRequest < Struct.new(
|
3798
|
+
:assistant_id,
|
3799
|
+
:max_results,
|
3800
|
+
:next_token,
|
3801
|
+
:origin)
|
3802
|
+
SENSITIVE = []
|
3803
|
+
include Aws::Structure
|
3804
|
+
end
|
3805
|
+
|
3806
|
+
# @!attribute [rw] ai_agent_summaries
|
3807
|
+
# The summaries of AI Agents.
|
3808
|
+
# @return [Array<Types::AIAgentSummary>]
|
3809
|
+
#
|
3810
|
+
# @!attribute [rw] next_token
|
3811
|
+
# The token for the next set of results. Use the value returned in the
|
3812
|
+
# previous response in the next request to retrieve the next set of
|
3813
|
+
# results.
|
3814
|
+
# @return [String]
|
3815
|
+
#
|
3816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentsResponse AWS API Documentation
|
3817
|
+
#
|
3818
|
+
class ListAIAgentsResponse < Struct.new(
|
3819
|
+
:ai_agent_summaries,
|
3820
|
+
:next_token)
|
3821
|
+
SENSITIVE = []
|
3822
|
+
include Aws::Structure
|
3823
|
+
end
|
3824
|
+
|
3825
|
+
# @!attribute [rw] ai_prompt_id
|
3826
|
+
# The identifier of the Amazon Q in Connect AI prompt for which
|
3827
|
+
# versions are to be listed.
|
3828
|
+
# @return [String]
|
3829
|
+
#
|
3830
|
+
# @!attribute [rw] assistant_id
|
3831
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
3832
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
3833
|
+
# @return [String]
|
3834
|
+
#
|
3835
|
+
# @!attribute [rw] max_results
|
3836
|
+
# The maximum number of results to return per page.
|
3837
|
+
# @return [Integer]
|
3838
|
+
#
|
3839
|
+
# @!attribute [rw] next_token
|
3840
|
+
# The token for the next set of results. Use the value returned in the
|
3841
|
+
# previous response in the next request to retrieve the next set of
|
3842
|
+
# results.
|
3843
|
+
# @return [String]
|
3844
|
+
#
|
3845
|
+
# @!attribute [rw] origin
|
3846
|
+
# The origin of the AI Prompt versions to be listed. `SYSTEM` for a
|
3847
|
+
# default AI Agent created by Q in Connect or `CUSTOMER` for an AI
|
3848
|
+
# Agent created by calling AI Agent creation APIs.
|
3849
|
+
# @return [String]
|
3850
|
+
#
|
3851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIPromptVersionsRequest AWS API Documentation
|
3852
|
+
#
|
3853
|
+
class ListAIPromptVersionsRequest < Struct.new(
|
3854
|
+
:ai_prompt_id,
|
3855
|
+
:assistant_id,
|
3856
|
+
:max_results,
|
3857
|
+
:next_token,
|
3858
|
+
:origin)
|
3859
|
+
SENSITIVE = []
|
3860
|
+
include Aws::Structure
|
3861
|
+
end
|
3862
|
+
|
3863
|
+
# @!attribute [rw] ai_prompt_version_summaries
|
3864
|
+
# The summaries of the AI Prompt versions.
|
3865
|
+
# @return [Array<Types::AIPromptVersionSummary>]
|
3866
|
+
#
|
3867
|
+
# @!attribute [rw] next_token
|
3868
|
+
# The token for the next set of results. Use the value returned in the
|
3869
|
+
# previous response in the next request to retrieve the next set of
|
3870
|
+
# results.
|
3871
|
+
# @return [String]
|
3872
|
+
#
|
3873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIPromptVersionsResponse AWS API Documentation
|
3874
|
+
#
|
3875
|
+
class ListAIPromptVersionsResponse < Struct.new(
|
3876
|
+
:ai_prompt_version_summaries,
|
3877
|
+
:next_token)
|
3878
|
+
SENSITIVE = []
|
3879
|
+
include Aws::Structure
|
3880
|
+
end
|
3881
|
+
|
3882
|
+
# @!attribute [rw] assistant_id
|
3883
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
3884
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
3885
|
+
# @return [String]
|
3886
|
+
#
|
3887
|
+
# @!attribute [rw] max_results
|
3888
|
+
# The maximum number of results to return per page.
|
3889
|
+
# @return [Integer]
|
3890
|
+
#
|
3891
|
+
# @!attribute [rw] next_token
|
3892
|
+
# The token for the next set of results. Use the value returned in the
|
3893
|
+
# previous response in the next request to retrieve the next set of
|
3894
|
+
# results.
|
3895
|
+
# @return [String]
|
3896
|
+
#
|
3897
|
+
# @!attribute [rw] origin
|
3898
|
+
# The origin of the AI Prompts to be listed. `SYSTEM` for a default AI
|
3899
|
+
# Agent created by Q in Connect or `CUSTOMER` for an AI Agent created
|
3900
|
+
# by calling AI Agent creation APIs.
|
3901
|
+
# @return [String]
|
3902
|
+
#
|
3903
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIPromptsRequest AWS API Documentation
|
3904
|
+
#
|
3905
|
+
class ListAIPromptsRequest < Struct.new(
|
3906
|
+
:assistant_id,
|
3907
|
+
:max_results,
|
3908
|
+
:next_token,
|
3909
|
+
:origin)
|
3910
|
+
SENSITIVE = []
|
3911
|
+
include Aws::Structure
|
3912
|
+
end
|
3913
|
+
|
3914
|
+
# @!attribute [rw] ai_prompt_summaries
|
3915
|
+
# The summaries of the AI Prompts.
|
3916
|
+
# @return [Array<Types::AIPromptSummary>]
|
3917
|
+
#
|
3918
|
+
# @!attribute [rw] next_token
|
3919
|
+
# The token for the next set of results. Use the value returned in the
|
3920
|
+
# previous response in the next request to retrieve the next set of
|
3921
|
+
# results.
|
3922
|
+
# @return [String]
|
3923
|
+
#
|
3924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIPromptsResponse AWS API Documentation
|
3925
|
+
#
|
3926
|
+
class ListAIPromptsResponse < Struct.new(
|
3927
|
+
:ai_prompt_summaries,
|
3928
|
+
:next_token)
|
2471
3929
|
SENSITIVE = []
|
2472
3930
|
include Aws::Structure
|
2473
3931
|
end
|
@@ -2793,6 +4251,50 @@ module Aws::QConnect
|
|
2793
4251
|
include Aws::Structure
|
2794
4252
|
end
|
2795
4253
|
|
4254
|
+
# Source configuration for managed resources.
|
4255
|
+
#
|
4256
|
+
# @note ManagedSourceConfiguration is a union - when making an API calls you must set exactly one of the members.
|
4257
|
+
#
|
4258
|
+
# @note ManagedSourceConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ManagedSourceConfiguration corresponding to the set member.
|
4259
|
+
#
|
4260
|
+
# @!attribute [rw] web_crawler_configuration
|
4261
|
+
# Configuration data for web crawler data source.
|
4262
|
+
# @return [Types::WebCrawlerConfiguration]
|
4263
|
+
#
|
4264
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ManagedSourceConfiguration AWS API Documentation
|
4265
|
+
#
|
4266
|
+
class ManagedSourceConfiguration < Struct.new(
|
4267
|
+
:web_crawler_configuration,
|
4268
|
+
:unknown)
|
4269
|
+
SENSITIVE = []
|
4270
|
+
include Aws::Structure
|
4271
|
+
include Aws::Structure::Union
|
4272
|
+
|
4273
|
+
class WebCrawlerConfiguration < ManagedSourceConfiguration; end
|
4274
|
+
class Unknown < ManagedSourceConfiguration; end
|
4275
|
+
end
|
4276
|
+
|
4277
|
+
# The configuration for the `MANUAL_SEARCH` AI Agent type.
|
4278
|
+
#
|
4279
|
+
# @!attribute [rw] answer_generation_ai_prompt_id
|
4280
|
+
# The AI Prompt identifier for the Answer Generation prompt used by
|
4281
|
+
# the MANUAL\_SEARCH AI Agent.
|
4282
|
+
# @return [String]
|
4283
|
+
#
|
4284
|
+
# @!attribute [rw] association_configurations
|
4285
|
+
# The association configurations for overriding behavior on this AI
|
4286
|
+
# Agent.
|
4287
|
+
# @return [Array<Types::AssociationConfiguration>]
|
4288
|
+
#
|
4289
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ManualSearchAIAgentConfiguration AWS API Documentation
|
4290
|
+
#
|
4291
|
+
class ManualSearchAIAgentConfiguration < Struct.new(
|
4292
|
+
:answer_generation_ai_prompt_id,
|
4293
|
+
:association_configurations)
|
4294
|
+
SENSITIVE = []
|
4295
|
+
include Aws::Structure
|
4296
|
+
end
|
4297
|
+
|
2796
4298
|
# An error occurred when creating a recommendation.
|
2797
4299
|
#
|
2798
4300
|
# @!attribute [rw] message
|
@@ -2884,6 +4386,44 @@ module Aws::QConnect
|
|
2884
4386
|
class Unknown < OrCondition; end
|
2885
4387
|
end
|
2886
4388
|
|
4389
|
+
# Settings for parsing document contents. By default, the service
|
4390
|
+
# converts the contents of each document into text before splitting it
|
4391
|
+
# into chunks. To improve processing of PDF files with tables and
|
4392
|
+
# images, you can configure the data source to convert the pages of text
|
4393
|
+
# into images and use a model to describe the contents of each page.
|
4394
|
+
#
|
4395
|
+
# @!attribute [rw] bedrock_foundation_model_configuration
|
4396
|
+
# Settings for a foundation model used to parse documents for a data
|
4397
|
+
# source.
|
4398
|
+
# @return [Types::BedrockFoundationModelConfigurationForParsing]
|
4399
|
+
#
|
4400
|
+
# @!attribute [rw] parsing_strategy
|
4401
|
+
# The parsing strategy for the data source.
|
4402
|
+
# @return [String]
|
4403
|
+
#
|
4404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ParsingConfiguration AWS API Documentation
|
4405
|
+
#
|
4406
|
+
class ParsingConfiguration < Struct.new(
|
4407
|
+
:bedrock_foundation_model_configuration,
|
4408
|
+
:parsing_strategy)
|
4409
|
+
SENSITIVE = []
|
4410
|
+
include Aws::Structure
|
4411
|
+
end
|
4412
|
+
|
4413
|
+
# Instructions for interpreting the contents of a document.
|
4414
|
+
#
|
4415
|
+
# @!attribute [rw] parsing_prompt_text
|
4416
|
+
# Instructions for interpreting the contents of a document.
|
4417
|
+
# @return [String]
|
4418
|
+
#
|
4419
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ParsingPrompt AWS API Documentation
|
4420
|
+
#
|
4421
|
+
class ParsingPrompt < Struct.new(
|
4422
|
+
:parsing_prompt_text)
|
4423
|
+
SENSITIVE = []
|
4424
|
+
include Aws::Structure
|
4425
|
+
end
|
4426
|
+
|
2887
4427
|
# The provided `revisionId` does not match, indicating the content has
|
2888
4428
|
# been modified since it was last read.
|
2889
4429
|
#
|
@@ -2972,10 +4512,20 @@ module Aws::QConnect
|
|
2972
4512
|
# results.
|
2973
4513
|
# @return [String]
|
2974
4514
|
#
|
4515
|
+
# @!attribute [rw] override_knowledge_base_search_type
|
4516
|
+
# The search type to be used against the Knowledge Base for this
|
4517
|
+
# request. The values can be `SEMANTIC` which uses vector embeddings
|
4518
|
+
# or `HYBRID` which use vector embeddings and raw text.
|
4519
|
+
# @return [String]
|
4520
|
+
#
|
2975
4521
|
# @!attribute [rw] query_condition
|
2976
4522
|
# Information about how to query content.
|
2977
4523
|
# @return [Array<Types::QueryCondition>]
|
2978
4524
|
#
|
4525
|
+
# @!attribute [rw] query_input_data
|
4526
|
+
# Information about the query.
|
4527
|
+
# @return [Types::QueryInputData]
|
4528
|
+
#
|
2979
4529
|
# @!attribute [rw] query_text
|
2980
4530
|
# The text to search for.
|
2981
4531
|
# @return [String]
|
@@ -2991,7 +4541,9 @@ module Aws::QConnect
|
|
2991
4541
|
:assistant_id,
|
2992
4542
|
:max_results,
|
2993
4543
|
:next_token,
|
4544
|
+
:override_knowledge_base_search_type,
|
2994
4545
|
:query_condition,
|
4546
|
+
:query_input_data,
|
2995
4547
|
:query_text,
|
2996
4548
|
:session_id)
|
2997
4549
|
SENSITIVE = [:query_text]
|
@@ -3061,15 +4613,56 @@ module Aws::QConnect
|
|
3061
4613
|
include Aws::Structure
|
3062
4614
|
end
|
3063
4615
|
|
4616
|
+
# Input information for the query.
|
4617
|
+
#
|
4618
|
+
# @note QueryInputData is a union - when making an API calls you must set exactly one of the members.
|
4619
|
+
#
|
4620
|
+
# @!attribute [rw] intent_input_data
|
4621
|
+
# Input information for the intent.
|
4622
|
+
# @return [Types::IntentInputData]
|
4623
|
+
#
|
4624
|
+
# @!attribute [rw] query_text_input_data
|
4625
|
+
# Input information for the query.
|
4626
|
+
# @return [Types::QueryTextInputData]
|
4627
|
+
#
|
4628
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QueryInputData AWS API Documentation
|
4629
|
+
#
|
4630
|
+
class QueryInputData < Struct.new(
|
4631
|
+
:intent_input_data,
|
4632
|
+
:query_text_input_data,
|
4633
|
+
:unknown)
|
4634
|
+
SENSITIVE = []
|
4635
|
+
include Aws::Structure
|
4636
|
+
include Aws::Structure::Union
|
4637
|
+
|
4638
|
+
class IntentInputData < QueryInputData; end
|
4639
|
+
class QueryTextInputData < QueryInputData; end
|
4640
|
+
class Unknown < QueryInputData; end
|
4641
|
+
end
|
4642
|
+
|
3064
4643
|
# Data associated with the QUERY RecommendationTriggerType.
|
3065
4644
|
#
|
3066
4645
|
# @!attribute [rw] text
|
3067
|
-
# The text associated with the recommendation trigger.
|
4646
|
+
# The text associated with the recommendation trigger.
|
4647
|
+
# @return [String]
|
4648
|
+
#
|
4649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QueryRecommendationTriggerData AWS API Documentation
|
4650
|
+
#
|
4651
|
+
class QueryRecommendationTriggerData < Struct.new(
|
4652
|
+
:text)
|
4653
|
+
SENSITIVE = [:text]
|
4654
|
+
include Aws::Structure
|
4655
|
+
end
|
4656
|
+
|
4657
|
+
# Information about the text to search for.
|
4658
|
+
#
|
4659
|
+
# @!attribute [rw] text
|
4660
|
+
# The text to search for.
|
3068
4661
|
# @return [String]
|
3069
4662
|
#
|
3070
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/
|
4663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QueryTextInputData AWS API Documentation
|
3071
4664
|
#
|
3072
|
-
class
|
4665
|
+
class QueryTextInputData < Struct.new(
|
3073
4666
|
:text)
|
3074
4667
|
SENSITIVE = [:text]
|
3075
4668
|
include Aws::Structure
|
@@ -3760,6 +5353,29 @@ module Aws::QConnect
|
|
3760
5353
|
class Unknown < RecommendationTriggerData; end
|
3761
5354
|
end
|
3762
5355
|
|
5356
|
+
# @!attribute [rw] ai_agent_type
|
5357
|
+
# The type of the AI Agent being removed for use by default from the
|
5358
|
+
# Amazon Q in Connect Assistant.
|
5359
|
+
# @return [String]
|
5360
|
+
#
|
5361
|
+
# @!attribute [rw] assistant_id
|
5362
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
5363
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
5364
|
+
# @return [String]
|
5365
|
+
#
|
5366
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RemoveAssistantAIAgentRequest AWS API Documentation
|
5367
|
+
#
|
5368
|
+
class RemoveAssistantAIAgentRequest < Struct.new(
|
5369
|
+
:ai_agent_type,
|
5370
|
+
:assistant_id)
|
5371
|
+
SENSITIVE = []
|
5372
|
+
include Aws::Structure
|
5373
|
+
end
|
5374
|
+
|
5375
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RemoveAssistantAIAgentResponse AWS API Documentation
|
5376
|
+
#
|
5377
|
+
class RemoveAssistantAIAgentResponse < Aws::EmptyStructure; end
|
5378
|
+
|
3763
5379
|
# @!attribute [rw] knowledge_base_id
|
3764
5380
|
# The identifier of the knowledge base. Can be either the ID or the
|
3765
5381
|
# ARN. URLs cannot contain the ARN.
|
@@ -3877,6 +5493,48 @@ module Aws::QConnect
|
|
3877
5493
|
include Aws::Structure
|
3878
5494
|
end
|
3879
5495
|
|
5496
|
+
# The list of key-value pairs that are stored on the session.
|
5497
|
+
#
|
5498
|
+
# @!attribute [rw] key
|
5499
|
+
# The key of the data stored on the session.
|
5500
|
+
# @return [String]
|
5501
|
+
#
|
5502
|
+
# @!attribute [rw] value
|
5503
|
+
# The value of the data stored on the session.
|
5504
|
+
# @return [Types::RuntimeSessionDataValue]
|
5505
|
+
#
|
5506
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RuntimeSessionData AWS API Documentation
|
5507
|
+
#
|
5508
|
+
class RuntimeSessionData < Struct.new(
|
5509
|
+
:key,
|
5510
|
+
:value)
|
5511
|
+
SENSITIVE = [:key]
|
5512
|
+
include Aws::Structure
|
5513
|
+
end
|
5514
|
+
|
5515
|
+
# A union type that specifies the data stored on the session.
|
5516
|
+
#
|
5517
|
+
# @note RuntimeSessionDataValue is a union - when making an API calls you must set exactly one of the members.
|
5518
|
+
#
|
5519
|
+
# @note RuntimeSessionDataValue is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RuntimeSessionDataValue corresponding to the set member.
|
5520
|
+
#
|
5521
|
+
# @!attribute [rw] string_value
|
5522
|
+
# The string value of the data stored on the session.
|
5523
|
+
# @return [String]
|
5524
|
+
#
|
5525
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RuntimeSessionDataValue AWS API Documentation
|
5526
|
+
#
|
5527
|
+
class RuntimeSessionDataValue < Struct.new(
|
5528
|
+
:string_value,
|
5529
|
+
:unknown)
|
5530
|
+
SENSITIVE = [:string_value]
|
5531
|
+
include Aws::Structure
|
5532
|
+
include Aws::Structure::Union
|
5533
|
+
|
5534
|
+
class StringValue < RuntimeSessionDataValue; end
|
5535
|
+
class Unknown < RuntimeSessionDataValue; end
|
5536
|
+
end
|
5537
|
+
|
3880
5538
|
# @!attribute [rw] knowledge_base_id
|
3881
5539
|
# The identifier of the knowledge base. This should not be a
|
3882
5540
|
# QUICK\_RESPONSES type knowledge base. Can be either the ID or the
|
@@ -4048,6 +5706,47 @@ module Aws::QConnect
|
|
4048
5706
|
include Aws::Structure
|
4049
5707
|
end
|
4050
5708
|
|
5709
|
+
# A URL for crawling.
|
5710
|
+
#
|
5711
|
+
# @!attribute [rw] url
|
5712
|
+
# URL for crawling
|
5713
|
+
# @return [String]
|
5714
|
+
#
|
5715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SeedUrl AWS API Documentation
|
5716
|
+
#
|
5717
|
+
class SeedUrl < Struct.new(
|
5718
|
+
:url)
|
5719
|
+
SENSITIVE = []
|
5720
|
+
include Aws::Structure
|
5721
|
+
end
|
5722
|
+
|
5723
|
+
# Settings for semantic document chunking for a data source. Semantic
|
5724
|
+
# chunking splits a document into smaller documents based on groups of
|
5725
|
+
# similar content derived from the text with natural language
|
5726
|
+
# processing.
|
5727
|
+
#
|
5728
|
+
# @!attribute [rw] breakpoint_percentile_threshold
|
5729
|
+
# The dissimilarity threshold for splitting chunks.
|
5730
|
+
# @return [Integer]
|
5731
|
+
#
|
5732
|
+
# @!attribute [rw] buffer_size
|
5733
|
+
# The buffer size.
|
5734
|
+
# @return [Integer]
|
5735
|
+
#
|
5736
|
+
# @!attribute [rw] max_tokens
|
5737
|
+
# The maximum number of tokens that a chunk can contain.
|
5738
|
+
# @return [Integer]
|
5739
|
+
#
|
5740
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SemanticChunkingConfiguration AWS API Documentation
|
5741
|
+
#
|
5742
|
+
class SemanticChunkingConfiguration < Struct.new(
|
5743
|
+
:breakpoint_percentile_threshold,
|
5744
|
+
:buffer_size,
|
5745
|
+
:max_tokens)
|
5746
|
+
SENSITIVE = []
|
5747
|
+
include Aws::Structure
|
5748
|
+
end
|
5749
|
+
|
4051
5750
|
# The configuration information for the customer managed key used for
|
4052
5751
|
# encryption.
|
4053
5752
|
#
|
@@ -4088,6 +5787,12 @@ module Aws::QConnect
|
|
4088
5787
|
|
4089
5788
|
# Information about the session.
|
4090
5789
|
#
|
5790
|
+
# @!attribute [rw] ai_agent_configuration
|
5791
|
+
# The configuration of the AI Agents (mapped by AI Agent Type to AI
|
5792
|
+
# Agent version) that should be used by Amazon Q in Connect for this
|
5793
|
+
# Session.
|
5794
|
+
# @return [Hash<String,Types::AIAgentConfigurationData>]
|
5795
|
+
#
|
4091
5796
|
# @!attribute [rw] description
|
4092
5797
|
# The description of the session.
|
4093
5798
|
# @return [String]
|
@@ -4120,6 +5825,7 @@ module Aws::QConnect
|
|
4120
5825
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SessionData AWS API Documentation
|
4121
5826
|
#
|
4122
5827
|
class SessionData < Struct.new(
|
5828
|
+
:ai_agent_configuration,
|
4123
5829
|
:description,
|
4124
5830
|
:integration_configuration,
|
4125
5831
|
:name,
|
@@ -4186,21 +5892,32 @@ module Aws::QConnect
|
|
4186
5892
|
# automatically ingest content.
|
4187
5893
|
# @return [Types::AppIntegrationsConfiguration]
|
4188
5894
|
#
|
5895
|
+
# @!attribute [rw] managed_source_configuration
|
5896
|
+
# Source configuration for managed resources.
|
5897
|
+
# @return [Types::ManagedSourceConfiguration]
|
5898
|
+
#
|
4189
5899
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SourceConfiguration AWS API Documentation
|
4190
5900
|
#
|
4191
5901
|
class SourceConfiguration < Struct.new(
|
4192
5902
|
:app_integrations,
|
5903
|
+
:managed_source_configuration,
|
4193
5904
|
:unknown)
|
4194
5905
|
SENSITIVE = []
|
4195
5906
|
include Aws::Structure
|
4196
5907
|
include Aws::Structure::Union
|
4197
5908
|
|
4198
5909
|
class AppIntegrations < SourceConfiguration; end
|
5910
|
+
class ManagedSourceConfiguration < SourceConfiguration; end
|
4199
5911
|
class Unknown < SourceConfiguration; end
|
4200
5912
|
end
|
4201
5913
|
|
4202
5914
|
# Details about the source content data.
|
4203
5915
|
#
|
5916
|
+
# @!attribute [rw] citation_span
|
5917
|
+
# Contains information about where the text with a citation begins and
|
5918
|
+
# ends in the generated output.
|
5919
|
+
# @return [Types::CitationSpan]
|
5920
|
+
#
|
4204
5921
|
# @!attribute [rw] id
|
4205
5922
|
# The identifier of the source content.
|
4206
5923
|
# @return [String]
|
@@ -4220,6 +5937,7 @@ module Aws::QConnect
|
|
4220
5937
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SourceContentDataDetails AWS API Documentation
|
4221
5938
|
#
|
4222
5939
|
class SourceContentDataDetails < Struct.new(
|
5940
|
+
:citation_span,
|
4223
5941
|
:id,
|
4224
5942
|
:ranking_data,
|
4225
5943
|
:text_data,
|
@@ -4446,6 +6164,21 @@ module Aws::QConnect
|
|
4446
6164
|
include Aws::Structure
|
4447
6165
|
end
|
4448
6166
|
|
6167
|
+
# The configuration for a prompt template that supports full textual
|
6168
|
+
# prompt configuration using a YAML prompt.
|
6169
|
+
#
|
6170
|
+
# @!attribute [rw] text
|
6171
|
+
# The YAML text for the AI Prompt template.
|
6172
|
+
# @return [String]
|
6173
|
+
#
|
6174
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/TextFullAIPromptEditTemplateConfiguration AWS API Documentation
|
6175
|
+
#
|
6176
|
+
class TextFullAIPromptEditTemplateConfiguration < Struct.new(
|
6177
|
+
:text)
|
6178
|
+
SENSITIVE = [:text]
|
6179
|
+
include Aws::Structure
|
6180
|
+
end
|
6181
|
+
|
4449
6182
|
# The throttling limit has been exceeded.
|
4450
6183
|
#
|
4451
6184
|
# @!attribute [rw] message
|
@@ -4499,6 +6232,163 @@ module Aws::QConnect
|
|
4499
6232
|
#
|
4500
6233
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
4501
6234
|
|
6235
|
+
# @!attribute [rw] ai_agent_id
|
6236
|
+
# The identifier of the Amazon Q in Connect AI Agent.
|
6237
|
+
# @return [String]
|
6238
|
+
#
|
6239
|
+
# @!attribute [rw] assistant_id
|
6240
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
6241
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
6242
|
+
# @return [String]
|
6243
|
+
#
|
6244
|
+
# @!attribute [rw] client_token
|
6245
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
6246
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
6247
|
+
# this field. For more information about idempotency, see [Making
|
6248
|
+
# retries safe with idempotent APIs][1].
|
6249
|
+
#
|
6250
|
+
# **A suitable default value is auto-generated.** You should normally
|
6251
|
+
# not need to pass this option.
|
6252
|
+
#
|
6253
|
+
#
|
6254
|
+
#
|
6255
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
6256
|
+
# @return [String]
|
6257
|
+
#
|
6258
|
+
# @!attribute [rw] configuration
|
6259
|
+
# The configuration of the Amazon Q in Connect AI Agent.
|
6260
|
+
# @return [Types::AIAgentConfiguration]
|
6261
|
+
#
|
6262
|
+
# @!attribute [rw] description
|
6263
|
+
# The description of the Amazon Q in Connect AI Agent.
|
6264
|
+
# @return [String]
|
6265
|
+
#
|
6266
|
+
# @!attribute [rw] visibility_status
|
6267
|
+
# The visbility status of the Amazon Q in Connect AI Agent.
|
6268
|
+
# @return [String]
|
6269
|
+
#
|
6270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAIAgentRequest AWS API Documentation
|
6271
|
+
#
|
6272
|
+
class UpdateAIAgentRequest < Struct.new(
|
6273
|
+
:ai_agent_id,
|
6274
|
+
:assistant_id,
|
6275
|
+
:client_token,
|
6276
|
+
:configuration,
|
6277
|
+
:description,
|
6278
|
+
:visibility_status)
|
6279
|
+
SENSITIVE = []
|
6280
|
+
include Aws::Structure
|
6281
|
+
end
|
6282
|
+
|
6283
|
+
# @!attribute [rw] ai_agent
|
6284
|
+
# The data of the updated Amazon Q in Connect AI Agent.
|
6285
|
+
# @return [Types::AIAgentData]
|
6286
|
+
#
|
6287
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAIAgentResponse AWS API Documentation
|
6288
|
+
#
|
6289
|
+
class UpdateAIAgentResponse < Struct.new(
|
6290
|
+
:ai_agent)
|
6291
|
+
SENSITIVE = []
|
6292
|
+
include Aws::Structure
|
6293
|
+
end
|
6294
|
+
|
6295
|
+
# @!attribute [rw] ai_prompt_id
|
6296
|
+
# The identifier of the Amazon Q in Connect AI Prompt.
|
6297
|
+
# @return [String]
|
6298
|
+
#
|
6299
|
+
# @!attribute [rw] assistant_id
|
6300
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
6301
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
6302
|
+
# @return [String]
|
6303
|
+
#
|
6304
|
+
# @!attribute [rw] client_token
|
6305
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
6306
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
6307
|
+
# this field. For more information about idempotency, see [Making
|
6308
|
+
# retries safe with idempotent APIs][1].
|
6309
|
+
#
|
6310
|
+
# **A suitable default value is auto-generated.** You should normally
|
6311
|
+
# not need to pass this option.
|
6312
|
+
#
|
6313
|
+
#
|
6314
|
+
#
|
6315
|
+
# [1]: http://aws.amazon.com/https:/aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
6316
|
+
# @return [String]
|
6317
|
+
#
|
6318
|
+
# @!attribute [rw] description
|
6319
|
+
# The description of the Amazon Q in Connect AI Prompt.
|
6320
|
+
# @return [String]
|
6321
|
+
#
|
6322
|
+
# @!attribute [rw] template_configuration
|
6323
|
+
# The configuration of the prompt template for this AI Prompt.
|
6324
|
+
# @return [Types::AIPromptTemplateConfiguration]
|
6325
|
+
#
|
6326
|
+
# @!attribute [rw] visibility_status
|
6327
|
+
# The visibility status of the Amazon Q in Connect AI prompt.
|
6328
|
+
# @return [String]
|
6329
|
+
#
|
6330
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAIPromptRequest AWS API Documentation
|
6331
|
+
#
|
6332
|
+
class UpdateAIPromptRequest < Struct.new(
|
6333
|
+
:ai_prompt_id,
|
6334
|
+
:assistant_id,
|
6335
|
+
:client_token,
|
6336
|
+
:description,
|
6337
|
+
:template_configuration,
|
6338
|
+
:visibility_status)
|
6339
|
+
SENSITIVE = []
|
6340
|
+
include Aws::Structure
|
6341
|
+
end
|
6342
|
+
|
6343
|
+
# @!attribute [rw] ai_prompt
|
6344
|
+
# The data of the updated Amazon Q in Connect AI Prompt.
|
6345
|
+
# @return [Types::AIPromptData]
|
6346
|
+
#
|
6347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAIPromptResponse AWS API Documentation
|
6348
|
+
#
|
6349
|
+
class UpdateAIPromptResponse < Struct.new(
|
6350
|
+
:ai_prompt)
|
6351
|
+
SENSITIVE = []
|
6352
|
+
include Aws::Structure
|
6353
|
+
end
|
6354
|
+
|
6355
|
+
# @!attribute [rw] ai_agent_type
|
6356
|
+
# The type of the AI Agent being updated for use by default on the
|
6357
|
+
# Amazon Q in Connect Assistant.
|
6358
|
+
# @return [String]
|
6359
|
+
#
|
6360
|
+
# @!attribute [rw] assistant_id
|
6361
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
6362
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
6363
|
+
# @return [String]
|
6364
|
+
#
|
6365
|
+
# @!attribute [rw] configuration
|
6366
|
+
# The configuration of the AI Agent being updated for use by default
|
6367
|
+
# on the Amazon Q in Connect Assistant.
|
6368
|
+
# @return [Types::AIAgentConfigurationData]
|
6369
|
+
#
|
6370
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAssistantAIAgentRequest AWS API Documentation
|
6371
|
+
#
|
6372
|
+
class UpdateAssistantAIAgentRequest < Struct.new(
|
6373
|
+
:ai_agent_type,
|
6374
|
+
:assistant_id,
|
6375
|
+
:configuration)
|
6376
|
+
SENSITIVE = []
|
6377
|
+
include Aws::Structure
|
6378
|
+
end
|
6379
|
+
|
6380
|
+
# @!attribute [rw] assistant
|
6381
|
+
# The assistant data.
|
6382
|
+
# @return [Types::AssistantData]
|
6383
|
+
#
|
6384
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAssistantAIAgentResponse AWS API Documentation
|
6385
|
+
#
|
6386
|
+
class UpdateAssistantAIAgentResponse < Struct.new(
|
6387
|
+
:assistant)
|
6388
|
+
SENSITIVE = []
|
6389
|
+
include Aws::Structure
|
6390
|
+
end
|
6391
|
+
|
4502
6392
|
# @!attribute [rw] content_id
|
4503
6393
|
# The identifier of the content. Can be either the ID or the ARN. URLs
|
4504
6394
|
# cannot contain the ARN.
|
@@ -4709,6 +6599,70 @@ module Aws::QConnect
|
|
4709
6599
|
include Aws::Structure
|
4710
6600
|
end
|
4711
6601
|
|
6602
|
+
# @!attribute [rw] assistant_id
|
6603
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
6604
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
6605
|
+
# @return [String]
|
6606
|
+
#
|
6607
|
+
# @!attribute [rw] data
|
6608
|
+
# The data stored on the Amazon Q in Connect Session.
|
6609
|
+
# @return [Array<Types::RuntimeSessionData>]
|
6610
|
+
#
|
6611
|
+
# @!attribute [rw] namespace
|
6612
|
+
# The namespace into which the session data is stored. Supported
|
6613
|
+
# namespaces are: Custom
|
6614
|
+
# @return [String]
|
6615
|
+
#
|
6616
|
+
# @!attribute [rw] session_id
|
6617
|
+
# The identifier of the session. Can be either the ID or the ARN. URLs
|
6618
|
+
# cannot contain the ARN.
|
6619
|
+
# @return [String]
|
6620
|
+
#
|
6621
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateSessionDataRequest AWS API Documentation
|
6622
|
+
#
|
6623
|
+
class UpdateSessionDataRequest < Struct.new(
|
6624
|
+
:assistant_id,
|
6625
|
+
:data,
|
6626
|
+
:namespace,
|
6627
|
+
:session_id)
|
6628
|
+
SENSITIVE = []
|
6629
|
+
include Aws::Structure
|
6630
|
+
end
|
6631
|
+
|
6632
|
+
# @!attribute [rw] data
|
6633
|
+
# Data stored in the session.
|
6634
|
+
# @return [Array<Types::RuntimeSessionData>]
|
6635
|
+
#
|
6636
|
+
# @!attribute [rw] namespace
|
6637
|
+
# The namespace into which the session data is stored. Supported
|
6638
|
+
# namespaces are: Custom
|
6639
|
+
# @return [String]
|
6640
|
+
#
|
6641
|
+
# @!attribute [rw] session_arn
|
6642
|
+
# The Amazon Resource Name (ARN) of the session.
|
6643
|
+
# @return [String]
|
6644
|
+
#
|
6645
|
+
# @!attribute [rw] session_id
|
6646
|
+
# The identifier of the session.
|
6647
|
+
# @return [String]
|
6648
|
+
#
|
6649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateSessionDataResponse AWS API Documentation
|
6650
|
+
#
|
6651
|
+
class UpdateSessionDataResponse < Struct.new(
|
6652
|
+
:data,
|
6653
|
+
:namespace,
|
6654
|
+
:session_arn,
|
6655
|
+
:session_id)
|
6656
|
+
SENSITIVE = []
|
6657
|
+
include Aws::Structure
|
6658
|
+
end
|
6659
|
+
|
6660
|
+
# @!attribute [rw] ai_agent_configuration
|
6661
|
+
# The configuration of the AI Agents (mapped by AI Agent Type to AI
|
6662
|
+
# Agent version) that should be used by Amazon Q in Connect for this
|
6663
|
+
# Session.
|
6664
|
+
# @return [Hash<String,Types::AIAgentConfigurationData>]
|
6665
|
+
#
|
4712
6666
|
# @!attribute [rw] assistant_id
|
4713
6667
|
# The identifier of the Amazon Q in Connect assistant. Can be either
|
4714
6668
|
# the ID or the ARN. URLs cannot contain the ARN.
|
@@ -4730,6 +6684,7 @@ module Aws::QConnect
|
|
4730
6684
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateSessionRequest AWS API Documentation
|
4731
6685
|
#
|
4732
6686
|
class UpdateSessionRequest < Struct.new(
|
6687
|
+
:ai_agent_configuration,
|
4733
6688
|
:assistant_id,
|
4734
6689
|
:description,
|
4735
6690
|
:session_id,
|
@@ -4750,6 +6705,21 @@ module Aws::QConnect
|
|
4750
6705
|
include Aws::Structure
|
4751
6706
|
end
|
4752
6707
|
|
6708
|
+
# The configuration of the URL/URLs for the web content that you want to
|
6709
|
+
# crawl. You should be authorized to crawl the URLs.
|
6710
|
+
#
|
6711
|
+
# @!attribute [rw] seed_urls
|
6712
|
+
# List of URLs for crawling.
|
6713
|
+
# @return [Array<Types::SeedUrl>]
|
6714
|
+
#
|
6715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UrlConfiguration AWS API Documentation
|
6716
|
+
#
|
6717
|
+
class UrlConfiguration < Struct.new(
|
6718
|
+
:seed_urls)
|
6719
|
+
SENSITIVE = []
|
6720
|
+
include Aws::Structure
|
6721
|
+
end
|
6722
|
+
|
4753
6723
|
# The input fails to satisfy the constraints specified by a service.
|
4754
6724
|
#
|
4755
6725
|
# @!attribute [rw] message
|
@@ -4763,6 +6733,88 @@ module Aws::QConnect
|
|
4763
6733
|
include Aws::Structure
|
4764
6734
|
end
|
4765
6735
|
|
6736
|
+
# Contains details about how to ingest the documents in a data source.
|
6737
|
+
#
|
6738
|
+
# @!attribute [rw] chunking_configuration
|
6739
|
+
# Details about how to chunk the documents in the data source. A chunk
|
6740
|
+
# refers to an excerpt from a data source that is returned when the
|
6741
|
+
# knowledge base that it belongs to is queried.
|
6742
|
+
# @return [Types::ChunkingConfiguration]
|
6743
|
+
#
|
6744
|
+
# @!attribute [rw] parsing_configuration
|
6745
|
+
# A custom parser for data source documents.
|
6746
|
+
# @return [Types::ParsingConfiguration]
|
6747
|
+
#
|
6748
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/VectorIngestionConfiguration AWS API Documentation
|
6749
|
+
#
|
6750
|
+
class VectorIngestionConfiguration < Struct.new(
|
6751
|
+
:chunking_configuration,
|
6752
|
+
:parsing_configuration)
|
6753
|
+
SENSITIVE = []
|
6754
|
+
include Aws::Structure
|
6755
|
+
end
|
6756
|
+
|
6757
|
+
# The configuration details for the web data source.
|
6758
|
+
#
|
6759
|
+
# @!attribute [rw] crawler_limits
|
6760
|
+
# The configuration of crawl limits for the web URLs.
|
6761
|
+
# @return [Types::WebCrawlerLimits]
|
6762
|
+
#
|
6763
|
+
# @!attribute [rw] exclusion_filters
|
6764
|
+
# A list of one or more exclusion regular expression patterns to
|
6765
|
+
# exclude certain URLs. If you specify an inclusion and exclusion
|
6766
|
+
# filter/pattern and both match a URL, the exclusion filter takes
|
6767
|
+
# precedence and the web content of the URL isn’t crawled.
|
6768
|
+
# @return [Array<String>]
|
6769
|
+
#
|
6770
|
+
# @!attribute [rw] inclusion_filters
|
6771
|
+
# A list of one or more inclusion regular expression patterns to
|
6772
|
+
# include certain URLs. If you specify an inclusion and exclusion
|
6773
|
+
# filter/pattern and both match a URL, the exclusion filter takes
|
6774
|
+
# precedence and the web content of the URL isn’t crawled.
|
6775
|
+
# @return [Array<String>]
|
6776
|
+
#
|
6777
|
+
# @!attribute [rw] scope
|
6778
|
+
# The scope of what is crawled for your URLs. You can choose to crawl
|
6779
|
+
# only web pages that belong to the same host or primary domain. For
|
6780
|
+
# example, only web pages that contain the seed URL
|
6781
|
+
# `https://docs.aws.amazon.com/bedrock/latest/userguide/` and no other
|
6782
|
+
# domains. You can choose to include sub domains in addition to the
|
6783
|
+
# host or primary domain. For example, web pages that contain
|
6784
|
+
# `aws.amazon.com` can also include sub domain `docs.aws.amazon.com`.
|
6785
|
+
# @return [String]
|
6786
|
+
#
|
6787
|
+
# @!attribute [rw] url_configuration
|
6788
|
+
# The configuration of the URL/URLs for the web content that you want
|
6789
|
+
# to crawl. You should be authorized to crawl the URLs.
|
6790
|
+
# @return [Types::UrlConfiguration]
|
6791
|
+
#
|
6792
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/WebCrawlerConfiguration AWS API Documentation
|
6793
|
+
#
|
6794
|
+
class WebCrawlerConfiguration < Struct.new(
|
6795
|
+
:crawler_limits,
|
6796
|
+
:exclusion_filters,
|
6797
|
+
:inclusion_filters,
|
6798
|
+
:scope,
|
6799
|
+
:url_configuration)
|
6800
|
+
SENSITIVE = [:exclusion_filters, :inclusion_filters]
|
6801
|
+
include Aws::Structure
|
6802
|
+
end
|
6803
|
+
|
6804
|
+
# The configuration of crawl limits for the web URLs.
|
6805
|
+
#
|
6806
|
+
# @!attribute [rw] rate_limit
|
6807
|
+
# Rate of web URLs retrieved per minute.
|
6808
|
+
# @return [Integer]
|
6809
|
+
#
|
6810
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/WebCrawlerLimits AWS API Documentation
|
6811
|
+
#
|
6812
|
+
class WebCrawlerLimits < Struct.new(
|
6813
|
+
:rate_limit)
|
6814
|
+
SENSITIVE = []
|
6815
|
+
include Aws::Structure
|
6816
|
+
end
|
6817
|
+
|
4766
6818
|
end
|
4767
6819
|
end
|
4768
6820
|
|