aws-sdk-qconnect 1.30.0 → 1.31.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qconnect/client.rb +2377 -2342
- data/lib/aws-sdk-qconnect/client_api.rb +522 -506
- data/lib/aws-sdk-qconnect/types.rb +2641 -2515
- data/lib/aws-sdk-qconnect/waiters.rb +15 -0
- data/lib/aws-sdk-qconnect.rb +2 -1
- data/sig/client.rbs +583 -578
- data/sig/types.rbs +539 -520
- metadata +3 -2
data/sig/client.rbs
CHANGED
@@ -97,17 +97,25 @@ module Aws
|
|
97
97
|
end
|
98
98
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_ai_agent-instance_method
|
99
99
|
def create_ai_agent: (
|
100
|
-
assistant_id: ::String,
|
101
100
|
?client_token: ::String,
|
101
|
+
assistant_id: ::String,
|
102
|
+
name: ::String,
|
103
|
+
type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE"),
|
102
104
|
configuration: {
|
103
|
-
|
104
|
-
answer_generation_ai_guardrail_id: ::String?,
|
105
|
+
manual_search_ai_agent_configuration: {
|
105
106
|
answer_generation_ai_prompt_id: ::String?,
|
107
|
+
answer_generation_ai_guardrail_id: ::String?,
|
106
108
|
association_configurations: Array[
|
107
109
|
{
|
110
|
+
association_id: ::String?,
|
111
|
+
association_type: ("KNOWLEDGE_BASE")?,
|
108
112
|
association_configuration_data: {
|
109
113
|
knowledge_base_association_configuration_data: {
|
110
114
|
content_tag_filter: {
|
115
|
+
tag_condition: {
|
116
|
+
key: ::String,
|
117
|
+
value: ::String?
|
118
|
+
}?,
|
111
119
|
and_conditions: Array[
|
112
120
|
{
|
113
121
|
key: ::String,
|
@@ -127,32 +135,32 @@ module Aws
|
|
127
135
|
value: ::String?
|
128
136
|
}?
|
129
137
|
},
|
130
|
-
]
|
131
|
-
tag_condition: {
|
132
|
-
key: ::String,
|
133
|
-
value: ::String?
|
134
|
-
}?
|
138
|
+
]?
|
135
139
|
}?,
|
136
140
|
max_results: ::Integer?,
|
137
141
|
override_knowledge_base_search_type: ("HYBRID" | "SEMANTIC")?
|
138
142
|
}?
|
139
|
-
}
|
140
|
-
association_id: ::String?,
|
141
|
-
association_type: ("KNOWLEDGE_BASE")?
|
143
|
+
}?
|
142
144
|
},
|
143
145
|
]?,
|
144
|
-
|
145
|
-
locale: ::String?,
|
146
|
-
query_reformulation_ai_prompt_id: ::String?
|
146
|
+
locale: ::String?
|
147
147
|
}?,
|
148
|
-
|
149
|
-
|
148
|
+
answer_recommendation_ai_agent_configuration: {
|
149
|
+
intent_labeling_generation_ai_prompt_id: ::String?,
|
150
|
+
query_reformulation_ai_prompt_id: ::String?,
|
150
151
|
answer_generation_ai_prompt_id: ::String?,
|
152
|
+
answer_generation_ai_guardrail_id: ::String?,
|
151
153
|
association_configurations: Array[
|
152
154
|
{
|
155
|
+
association_id: ::String?,
|
156
|
+
association_type: ("KNOWLEDGE_BASE")?,
|
153
157
|
association_configuration_data: {
|
154
158
|
knowledge_base_association_configuration_data: {
|
155
159
|
content_tag_filter: {
|
160
|
+
tag_condition: {
|
161
|
+
key: ::String,
|
162
|
+
value: ::String?
|
163
|
+
}?,
|
156
164
|
and_conditions: Array[
|
157
165
|
{
|
158
166
|
key: ::String,
|
@@ -172,28 +180,31 @@ module Aws
|
|
172
180
|
value: ::String?
|
173
181
|
}?
|
174
182
|
},
|
175
|
-
]
|
176
|
-
tag_condition: {
|
177
|
-
key: ::String,
|
178
|
-
value: ::String?
|
179
|
-
}?
|
183
|
+
]?
|
180
184
|
}?,
|
181
185
|
max_results: ::Integer?,
|
182
186
|
override_knowledge_base_search_type: ("HYBRID" | "SEMANTIC")?
|
183
187
|
}?
|
184
|
-
}
|
185
|
-
association_id: ::String?,
|
186
|
-
association_type: ("KNOWLEDGE_BASE")?
|
188
|
+
}?
|
187
189
|
},
|
188
190
|
]?,
|
189
191
|
locale: ::String?
|
190
192
|
}?,
|
191
193
|
self_service_ai_agent_configuration: {
|
194
|
+
self_service_pre_processing_ai_prompt_id: ::String?,
|
195
|
+
self_service_answer_generation_ai_prompt_id: ::String?,
|
196
|
+
self_service_ai_guardrail_id: ::String?,
|
192
197
|
association_configurations: Array[
|
193
198
|
{
|
199
|
+
association_id: ::String?,
|
200
|
+
association_type: ("KNOWLEDGE_BASE")?,
|
194
201
|
association_configuration_data: {
|
195
202
|
knowledge_base_association_configuration_data: {
|
196
203
|
content_tag_filter: {
|
204
|
+
tag_condition: {
|
205
|
+
key: ::String,
|
206
|
+
value: ::String?
|
207
|
+
}?,
|
197
208
|
and_conditions: Array[
|
198
209
|
{
|
199
210
|
key: ::String,
|
@@ -213,30 +224,19 @@ module Aws
|
|
213
224
|
value: ::String?
|
214
225
|
}?
|
215
226
|
},
|
216
|
-
]
|
217
|
-
tag_condition: {
|
218
|
-
key: ::String,
|
219
|
-
value: ::String?
|
220
|
-
}?
|
227
|
+
]?
|
221
228
|
}?,
|
222
229
|
max_results: ::Integer?,
|
223
230
|
override_knowledge_base_search_type: ("HYBRID" | "SEMANTIC")?
|
224
231
|
}?
|
225
|
-
}
|
226
|
-
association_id: ::String?,
|
227
|
-
association_type: ("KNOWLEDGE_BASE")?
|
232
|
+
}?
|
228
233
|
},
|
229
|
-
]
|
230
|
-
self_service_ai_guardrail_id: ::String?,
|
231
|
-
self_service_answer_generation_ai_prompt_id: ::String?,
|
232
|
-
self_service_pre_processing_ai_prompt_id: ::String?
|
234
|
+
]?
|
233
235
|
}?
|
234
236
|
},
|
235
|
-
|
236
|
-
name: ::String,
|
237
|
+
visibility_status: ("SAVED" | "PUBLISHED"),
|
237
238
|
?tags: Hash[::String, ::String],
|
238
|
-
|
239
|
-
visibility_status: ("SAVED" | "PUBLISHED")
|
239
|
+
?description: ::String
|
240
240
|
) -> _CreateAIAgentResponseSuccess
|
241
241
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAIAgentResponseSuccess
|
242
242
|
|
@@ -247,10 +247,10 @@ module Aws
|
|
247
247
|
end
|
248
248
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_ai_agent_version-instance_method
|
249
249
|
def create_ai_agent_version: (
|
250
|
-
ai_agent_id: ::String,
|
251
250
|
assistant_id: ::String,
|
252
|
-
|
253
|
-
?modified_time: ::Time
|
251
|
+
ai_agent_id: ::String,
|
252
|
+
?modified_time: ::Time,
|
253
|
+
?client_token: ::String
|
254
254
|
) -> _CreateAIAgentVersionResponseSuccess
|
255
255
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAIAgentVersionResponseSuccess
|
256
256
|
|
@@ -260,69 +260,69 @@ module Aws
|
|
260
260
|
end
|
261
261
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_ai_guardrail-instance_method
|
262
262
|
def create_ai_guardrail: (
|
263
|
+
?client_token: ::String,
|
263
264
|
assistant_id: ::String,
|
265
|
+
name: ::String,
|
264
266
|
blocked_input_messaging: ::String,
|
265
267
|
blocked_outputs_messaging: ::String,
|
266
|
-
|
268
|
+
visibility_status: ("SAVED" | "PUBLISHED"),
|
269
|
+
?description: ::String,
|
270
|
+
?topic_policy_config: {
|
271
|
+
topics_config: Array[
|
272
|
+
{
|
273
|
+
name: ::String,
|
274
|
+
definition: ::String,
|
275
|
+
examples: Array[::String]?,
|
276
|
+
type: ("DENY")
|
277
|
+
},
|
278
|
+
]
|
279
|
+
},
|
267
280
|
?content_policy_config: {
|
268
281
|
filters_config: Array[
|
269
282
|
{
|
283
|
+
type: ("SEXUAL" | "VIOLENCE" | "HATE" | "INSULTS" | "MISCONDUCT" | "PROMPT_ATTACK"),
|
270
284
|
input_strength: ("NONE" | "LOW" | "MEDIUM" | "HIGH"),
|
271
|
-
output_strength: ("NONE" | "LOW" | "MEDIUM" | "HIGH")
|
272
|
-
type: ("SEXUAL" | "VIOLENCE" | "HATE" | "INSULTS" | "MISCONDUCT" | "PROMPT_ATTACK")
|
285
|
+
output_strength: ("NONE" | "LOW" | "MEDIUM" | "HIGH")
|
273
286
|
},
|
274
287
|
]
|
275
288
|
},
|
276
|
-
?
|
277
|
-
|
289
|
+
?word_policy_config: {
|
290
|
+
words_config: Array[
|
278
291
|
{
|
279
|
-
|
280
|
-
type: ("GROUNDING" | "RELEVANCE")
|
292
|
+
text: ::String
|
281
293
|
},
|
282
|
-
]
|
294
|
+
]?,
|
295
|
+
managed_word_lists_config: Array[
|
296
|
+
{
|
297
|
+
type: ("PROFANITY")
|
298
|
+
},
|
299
|
+
]?
|
283
300
|
},
|
284
|
-
?description: ::String,
|
285
|
-
name: ::String,
|
286
301
|
?sensitive_information_policy_config: {
|
287
302
|
pii_entities_config: Array[
|
288
303
|
{
|
289
|
-
|
290
|
-
|
304
|
+
type: ("ADDRESS" | "AGE" | "AWS_ACCESS_KEY" | "AWS_SECRET_KEY" | "CA_HEALTH_NUMBER" | "CA_SOCIAL_INSURANCE_NUMBER" | "CREDIT_DEBIT_CARD_CVV" | "CREDIT_DEBIT_CARD_EXPIRY" | "CREDIT_DEBIT_CARD_NUMBER" | "DRIVER_ID" | "EMAIL" | "INTERNATIONAL_BANK_ACCOUNT_NUMBER" | "IP_ADDRESS" | "LICENSE_PLATE" | "MAC_ADDRESS" | "NAME" | "PASSWORD" | "PHONE" | "PIN" | "SWIFT_CODE" | "UK_NATIONAL_HEALTH_SERVICE_NUMBER" | "UK_NATIONAL_INSURANCE_NUMBER" | "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" | "URL" | "USERNAME" | "US_BANK_ACCOUNT_NUMBER" | "US_BANK_ROUTING_NUMBER" | "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" | "US_PASSPORT_NUMBER" | "US_SOCIAL_SECURITY_NUMBER" | "VEHICLE_IDENTIFICATION_NUMBER"),
|
305
|
+
action: ("BLOCK" | "ANONYMIZE")
|
291
306
|
},
|
292
307
|
]?,
|
293
308
|
regexes_config: Array[
|
294
309
|
{
|
295
|
-
action: ("BLOCK" | "ANONYMIZE"),
|
296
|
-
description: ::String?,
|
297
310
|
name: ::String,
|
298
|
-
|
311
|
+
description: ::String?,
|
312
|
+
pattern: ::String,
|
313
|
+
action: ("BLOCK" | "ANONYMIZE")
|
299
314
|
},
|
300
315
|
]?
|
301
316
|
},
|
302
|
-
?
|
303
|
-
|
304
|
-
topics_config: Array[
|
317
|
+
?contextual_grounding_policy_config: {
|
318
|
+
filters_config: Array[
|
305
319
|
{
|
306
|
-
|
307
|
-
|
308
|
-
name: ::String,
|
309
|
-
type: ("DENY")
|
320
|
+
type: ("GROUNDING" | "RELEVANCE"),
|
321
|
+
threshold: ::Float
|
310
322
|
},
|
311
323
|
]
|
312
324
|
},
|
313
|
-
|
314
|
-
?word_policy_config: {
|
315
|
-
managed_word_lists_config: Array[
|
316
|
-
{
|
317
|
-
type: ("PROFANITY")
|
318
|
-
},
|
319
|
-
]?,
|
320
|
-
words_config: Array[
|
321
|
-
{
|
322
|
-
text: ::String
|
323
|
-
},
|
324
|
-
]?
|
325
|
-
}
|
325
|
+
?tags: Hash[::String, ::String]
|
326
326
|
) -> _CreateAIGuardrailResponseSuccess
|
327
327
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAIGuardrailResponseSuccess
|
328
328
|
|
@@ -333,10 +333,10 @@ module Aws
|
|
333
333
|
end
|
334
334
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_ai_guardrail_version-instance_method
|
335
335
|
def create_ai_guardrail_version: (
|
336
|
-
ai_guardrail_id: ::String,
|
337
336
|
assistant_id: ::String,
|
338
|
-
|
339
|
-
?modified_time: ::Time
|
337
|
+
ai_guardrail_id: ::String,
|
338
|
+
?modified_time: ::Time,
|
339
|
+
?client_token: ::String
|
340
340
|
) -> _CreateAIGuardrailVersionResponseSuccess
|
341
341
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAIGuardrailVersionResponseSuccess
|
342
342
|
|
@@ -346,21 +346,21 @@ module Aws
|
|
346
346
|
end
|
347
347
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_ai_prompt-instance_method
|
348
348
|
def create_ai_prompt: (
|
349
|
-
api_format: ("ANTHROPIC_CLAUDE_MESSAGES" | "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS"),
|
350
|
-
assistant_id: ::String,
|
351
349
|
?client_token: ::String,
|
352
|
-
|
353
|
-
model_id: ::String,
|
350
|
+
assistant_id: ::String,
|
354
351
|
name: ::String,
|
355
|
-
|
352
|
+
type: ("ANSWER_GENERATION" | "INTENT_LABELING_GENERATION" | "QUERY_REFORMULATION" | "SELF_SERVICE_PRE_PROCESSING" | "SELF_SERVICE_ANSWER_GENERATION"),
|
356
353
|
template_configuration: {
|
357
354
|
text_full_ai_prompt_edit_template_configuration: {
|
358
355
|
text: ::String
|
359
356
|
}?
|
360
357
|
},
|
358
|
+
visibility_status: ("SAVED" | "PUBLISHED"),
|
361
359
|
template_type: ("TEXT"),
|
362
|
-
|
363
|
-
|
360
|
+
model_id: ::String,
|
361
|
+
api_format: ("ANTHROPIC_CLAUDE_MESSAGES" | "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS" | "MESSAGES" | "TEXT_COMPLETIONS"),
|
362
|
+
?tags: Hash[::String, ::String],
|
363
|
+
?description: ::String
|
364
364
|
) -> _CreateAIPromptResponseSuccess
|
365
365
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAIPromptResponseSuccess
|
366
366
|
|
@@ -371,10 +371,10 @@ module Aws
|
|
371
371
|
end
|
372
372
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_ai_prompt_version-instance_method
|
373
373
|
def create_ai_prompt_version: (
|
374
|
-
ai_prompt_id: ::String,
|
375
374
|
assistant_id: ::String,
|
376
|
-
|
377
|
-
?modified_time: ::Time
|
375
|
+
ai_prompt_id: ::String,
|
376
|
+
?modified_time: ::Time,
|
377
|
+
?client_token: ::String
|
378
378
|
) -> _CreateAIPromptVersionResponseSuccess
|
379
379
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAIPromptVersionResponseSuccess
|
380
380
|
|
@@ -385,13 +385,13 @@ module Aws
|
|
385
385
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_assistant-instance_method
|
386
386
|
def create_assistant: (
|
387
387
|
?client_token: ::String,
|
388
|
-
?description: ::String,
|
389
388
|
name: ::String,
|
389
|
+
type: ("AGENT"),
|
390
|
+
?description: ::String,
|
391
|
+
?tags: Hash[::String, ::String],
|
390
392
|
?server_side_encryption_configuration: {
|
391
393
|
kms_key_id: ::String?
|
392
|
-
}
|
393
|
-
?tags: Hash[::String, ::String],
|
394
|
-
type: ("AGENT")
|
394
|
+
}
|
395
395
|
) -> _CreateAssistantResponseSuccess
|
396
396
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAssistantResponseSuccess
|
397
397
|
|
@@ -402,10 +402,10 @@ module Aws
|
|
402
402
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_assistant_association-instance_method
|
403
403
|
def create_assistant_association: (
|
404
404
|
assistant_id: ::String,
|
405
|
+
association_type: ("KNOWLEDGE_BASE"),
|
405
406
|
association: {
|
406
407
|
knowledge_base_id: ::String?
|
407
408
|
},
|
408
|
-
association_type: ("KNOWLEDGE_BASE"),
|
409
409
|
?client_token: ::String,
|
410
410
|
?tags: Hash[::String, ::String]
|
411
411
|
) -> _CreateAssistantAssociationResponseSuccess
|
@@ -417,14 +417,14 @@ module Aws
|
|
417
417
|
end
|
418
418
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_content-instance_method
|
419
419
|
def create_content: (
|
420
|
-
?client_token: ::String,
|
421
420
|
knowledge_base_id: ::String,
|
422
|
-
?metadata: Hash[::String, ::String],
|
423
421
|
name: ::String,
|
424
|
-
?override_link_out_uri: ::String,
|
425
|
-
?tags: Hash[::String, ::String],
|
426
422
|
?title: ::String,
|
427
|
-
|
423
|
+
?override_link_out_uri: ::String,
|
424
|
+
?metadata: Hash[::String, ::String],
|
425
|
+
upload_id: ::String,
|
426
|
+
?client_token: ::String,
|
427
|
+
?tags: Hash[::String, ::String]
|
428
428
|
) -> _CreateContentResponseSuccess
|
429
429
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateContentResponseSuccess
|
430
430
|
|
@@ -434,15 +434,15 @@ module Aws
|
|
434
434
|
end
|
435
435
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_content_association-instance_method
|
436
436
|
def create_content_association: (
|
437
|
+
?client_token: ::String,
|
438
|
+
knowledge_base_id: ::String,
|
439
|
+
content_id: ::String,
|
440
|
+
association_type: ("AMAZON_CONNECT_GUIDE"),
|
437
441
|
association: {
|
438
442
|
amazon_connect_guide_association: {
|
439
443
|
flow_id: ::String?
|
440
444
|
}?
|
441
445
|
},
|
442
|
-
association_type: ("AMAZON_CONNECT_GUIDE"),
|
443
|
-
?client_token: ::String,
|
444
|
-
content_id: ::String,
|
445
|
-
knowledge_base_id: ::String,
|
446
446
|
?tags: Hash[::String, ::String]
|
447
447
|
) -> _CreateContentAssociationResponseSuccess
|
448
448
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateContentAssociationResponseSuccess
|
@@ -454,15 +454,8 @@ module Aws
|
|
454
454
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_knowledge_base-instance_method
|
455
455
|
def create_knowledge_base: (
|
456
456
|
?client_token: ::String,
|
457
|
-
?description: ::String,
|
458
|
-
knowledge_base_type: ("EXTERNAL" | "CUSTOM" | "QUICK_RESPONSES" | "MESSAGE_TEMPLATES" | "MANAGED"),
|
459
457
|
name: ::String,
|
460
|
-
|
461
|
-
template_uri: ::String?
|
462
|
-
},
|
463
|
-
?server_side_encryption_configuration: {
|
464
|
-
kms_key_id: ::String?
|
465
|
-
},
|
458
|
+
knowledge_base_type: ("EXTERNAL" | "CUSTOM" | "QUICK_RESPONSES" | "MESSAGE_TEMPLATES" | "MANAGED"),
|
466
459
|
?source_configuration: {
|
467
460
|
app_integrations: {
|
468
461
|
app_integration_arn: ::String,
|
@@ -470,23 +463,25 @@ module Aws
|
|
470
463
|
}?,
|
471
464
|
managed_source_configuration: {
|
472
465
|
web_crawler_configuration: {
|
473
|
-
crawler_limits: {
|
474
|
-
rate_limit: ::Integer?
|
475
|
-
}?,
|
476
|
-
exclusion_filters: Array[::String]?,
|
477
|
-
inclusion_filters: Array[::String]?,
|
478
|
-
scope: ("HOST_ONLY" | "SUBDOMAINS")?,
|
479
466
|
url_configuration: {
|
480
467
|
seed_urls: Array[
|
481
468
|
{
|
482
469
|
url: ::String?
|
483
470
|
},
|
484
471
|
]?
|
485
|
-
}
|
472
|
+
},
|
473
|
+
crawler_limits: {
|
474
|
+
rate_limit: ::Integer?
|
475
|
+
}?,
|
476
|
+
inclusion_filters: Array[::String]?,
|
477
|
+
exclusion_filters: Array[::String]?,
|
478
|
+
scope: ("HOST_ONLY" | "SUBDOMAINS")?
|
486
479
|
}?
|
487
480
|
}?
|
488
481
|
},
|
489
|
-
?
|
482
|
+
?rendering_configuration: {
|
483
|
+
template_uri: ::String?
|
484
|
+
},
|
490
485
|
?vector_ingestion_configuration: {
|
491
486
|
chunking_configuration: {
|
492
487
|
chunking_strategy: ("FIXED_SIZE" | "NONE" | "HIERARCHICAL" | "SEMANTIC"),
|
@@ -503,21 +498,26 @@ module Aws
|
|
503
498
|
overlap_tokens: ::Integer
|
504
499
|
}?,
|
505
500
|
semantic_chunking_configuration: {
|
506
|
-
|
501
|
+
max_tokens: ::Integer,
|
507
502
|
buffer_size: ::Integer,
|
508
|
-
|
503
|
+
breakpoint_percentile_threshold: ::Integer
|
509
504
|
}?
|
510
505
|
}?,
|
511
506
|
parsing_configuration: {
|
507
|
+
parsing_strategy: ("BEDROCK_FOUNDATION_MODEL"),
|
512
508
|
bedrock_foundation_model_configuration: {
|
513
509
|
model_arn: ::String,
|
514
510
|
parsing_prompt: {
|
515
511
|
parsing_prompt_text: ::String
|
516
512
|
}?
|
517
|
-
}
|
518
|
-
parsing_strategy: ("BEDROCK_FOUNDATION_MODEL")
|
513
|
+
}?
|
519
514
|
}?
|
520
|
-
}
|
515
|
+
},
|
516
|
+
?server_side_encryption_configuration: {
|
517
|
+
kms_key_id: ::String?
|
518
|
+
},
|
519
|
+
?description: ::String,
|
520
|
+
?tags: Hash[::String, ::String]
|
521
521
|
) -> _CreateKnowledgeBaseResponseSuccess
|
522
522
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateKnowledgeBaseResponseSuccess
|
523
523
|
|
@@ -527,15 +527,16 @@ module Aws
|
|
527
527
|
end
|
528
528
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_message_template-instance_method
|
529
529
|
def create_message_template: (
|
530
|
-
|
531
|
-
|
530
|
+
knowledge_base_id: ::String,
|
531
|
+
name: ::String,
|
532
532
|
content: {
|
533
533
|
email: {
|
534
|
+
subject: ::String?,
|
534
535
|
body: {
|
535
|
-
|
536
|
+
plain_text: {
|
536
537
|
content: ::String?
|
537
538
|
}?,
|
538
|
-
|
539
|
+
html: {
|
539
540
|
content: ::String?
|
540
541
|
}?
|
541
542
|
}?,
|
@@ -544,8 +545,7 @@ module Aws
|
|
544
545
|
name: ::String?,
|
545
546
|
value: ::String?
|
546
547
|
},
|
547
|
-
]
|
548
|
-
subject: ::String?
|
548
|
+
]?
|
549
549
|
}?,
|
550
550
|
sms: {
|
551
551
|
body: {
|
@@ -555,90 +555,90 @@ module Aws
|
|
555
555
|
}?
|
556
556
|
}?
|
557
557
|
},
|
558
|
+
?description: ::String,
|
559
|
+
channel_subtype: ("EMAIL" | "SMS"),
|
560
|
+
?language: ::String,
|
558
561
|
?default_attributes: {
|
562
|
+
system_attributes: {
|
563
|
+
name: ::String?,
|
564
|
+
customer_endpoint: {
|
565
|
+
address: ::String?
|
566
|
+
}?,
|
567
|
+
system_endpoint: {
|
568
|
+
address: ::String?
|
569
|
+
}?
|
570
|
+
}?,
|
559
571
|
agent_attributes: {
|
560
572
|
first_name: ::String?,
|
561
573
|
last_name: ::String?
|
562
574
|
}?,
|
563
|
-
custom_attributes: Hash[::String, ::String]?,
|
564
575
|
customer_profile_attributes: {
|
576
|
+
profile_id: ::String?,
|
577
|
+
profile_arn: ::String?,
|
578
|
+
first_name: ::String?,
|
579
|
+
middle_name: ::String?,
|
580
|
+
last_name: ::String?,
|
565
581
|
account_number: ::String?,
|
582
|
+
email_address: ::String?,
|
583
|
+
phone_number: ::String?,
|
566
584
|
additional_information: ::String?,
|
585
|
+
party_type: ::String?,
|
586
|
+
business_name: ::String?,
|
587
|
+
birth_date: ::String?,
|
588
|
+
gender: ::String?,
|
589
|
+
mobile_phone_number: ::String?,
|
590
|
+
home_phone_number: ::String?,
|
591
|
+
business_phone_number: ::String?,
|
592
|
+
business_email_address: ::String?,
|
567
593
|
address1: ::String?,
|
568
594
|
address2: ::String?,
|
569
595
|
address3: ::String?,
|
570
596
|
address4: ::String?,
|
571
|
-
billing_address_1: ::String?,
|
572
|
-
billing_address_2: ::String?,
|
573
|
-
billing_address_3: ::String?,
|
574
|
-
billing_address_4: ::String?,
|
575
|
-
billing_city: ::String?,
|
576
|
-
billing_country: ::String?,
|
577
|
-
billing_county: ::String?,
|
578
|
-
billing_postal_code: ::String?,
|
579
|
-
billing_province: ::String?,
|
580
|
-
billing_state: ::String?,
|
581
|
-
birth_date: ::String?,
|
582
|
-
business_email_address: ::String?,
|
583
|
-
business_name: ::String?,
|
584
|
-
business_phone_number: ::String?,
|
585
597
|
city: ::String?,
|
586
|
-
country: ::String?,
|
587
598
|
county: ::String?,
|
588
|
-
|
589
|
-
|
590
|
-
|
591
|
-
|
592
|
-
|
593
|
-
|
599
|
+
country: ::String?,
|
600
|
+
postal_code: ::String?,
|
601
|
+
province: ::String?,
|
602
|
+
state: ::String?,
|
603
|
+
shipping_address_1: ::String?,
|
604
|
+
shipping_address_2: ::String?,
|
605
|
+
shipping_address_3: ::String?,
|
606
|
+
shipping_address_4: ::String?,
|
607
|
+
shipping_city: ::String?,
|
608
|
+
shipping_county: ::String?,
|
609
|
+
shipping_country: ::String?,
|
610
|
+
shipping_postal_code: ::String?,
|
611
|
+
shipping_province: ::String?,
|
612
|
+
shipping_state: ::String?,
|
594
613
|
mailing_address_1: ::String?,
|
595
614
|
mailing_address_2: ::String?,
|
596
615
|
mailing_address_3: ::String?,
|
597
616
|
mailing_address_4: ::String?,
|
598
617
|
mailing_city: ::String?,
|
599
|
-
mailing_country: ::String?,
|
600
618
|
mailing_county: ::String?,
|
619
|
+
mailing_country: ::String?,
|
601
620
|
mailing_postal_code: ::String?,
|
602
621
|
mailing_province: ::String?,
|
603
622
|
mailing_state: ::String?,
|
604
|
-
|
605
|
-
|
606
|
-
|
607
|
-
|
608
|
-
|
609
|
-
|
610
|
-
|
611
|
-
|
612
|
-
|
613
|
-
|
614
|
-
|
615
|
-
shipping_address_4: ::String?,
|
616
|
-
shipping_city: ::String?,
|
617
|
-
shipping_country: ::String?,
|
618
|
-
shipping_county: ::String?,
|
619
|
-
shipping_postal_code: ::String?,
|
620
|
-
shipping_province: ::String?,
|
621
|
-
shipping_state: ::String?,
|
622
|
-
state: ::String?
|
623
|
+
billing_address_1: ::String?,
|
624
|
+
billing_address_2: ::String?,
|
625
|
+
billing_address_3: ::String?,
|
626
|
+
billing_address_4: ::String?,
|
627
|
+
billing_city: ::String?,
|
628
|
+
billing_county: ::String?,
|
629
|
+
billing_country: ::String?,
|
630
|
+
billing_postal_code: ::String?,
|
631
|
+
billing_province: ::String?,
|
632
|
+
billing_state: ::String?,
|
633
|
+
custom: Hash[::String, ::String]?
|
623
634
|
}?,
|
624
|
-
|
625
|
-
customer_endpoint: {
|
626
|
-
address: ::String?
|
627
|
-
}?,
|
628
|
-
name: ::String?,
|
629
|
-
system_endpoint: {
|
630
|
-
address: ::String?
|
631
|
-
}?
|
632
|
-
}?
|
635
|
+
custom_attributes: Hash[::String, ::String]?
|
633
636
|
},
|
634
|
-
?description: ::String,
|
635
637
|
?grouping_configuration: {
|
636
638
|
criteria: ::String?,
|
637
639
|
values: Array[::String]?
|
638
640
|
},
|
639
|
-
|
640
|
-
?language: ::String,
|
641
|
-
name: ::String,
|
641
|
+
?client_token: ::String,
|
642
642
|
?tags: Hash[::String, ::String]
|
643
643
|
) -> _CreateMessageTemplateResponseSuccess
|
644
644
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateMessageTemplateResponseSuccess
|
@@ -649,12 +649,12 @@ module Aws
|
|
649
649
|
end
|
650
650
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_message_template_attachment-instance_method
|
651
651
|
def create_message_template_attachment: (
|
652
|
-
body: ::String,
|
653
|
-
?client_token: ::String,
|
654
|
-
content_disposition: ("ATTACHMENT"),
|
655
652
|
knowledge_base_id: ::String,
|
656
653
|
message_template_id: ::String,
|
657
|
-
|
654
|
+
content_disposition: ("ATTACHMENT"),
|
655
|
+
name: ::String,
|
656
|
+
body: ::String,
|
657
|
+
?client_token: ::String
|
658
658
|
) -> _CreateMessageTemplateAttachmentResponseSuccess
|
659
659
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateMessageTemplateAttachmentResponseSuccess
|
660
660
|
|
@@ -665,8 +665,8 @@ module Aws
|
|
665
665
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_message_template_version-instance_method
|
666
666
|
def create_message_template_version: (
|
667
667
|
knowledge_base_id: ::String,
|
668
|
-
|
669
|
-
|
668
|
+
message_template_id: ::String,
|
669
|
+
?message_template_content_sha_256: ::String
|
670
670
|
) -> _CreateMessageTemplateVersionResponseSuccess
|
671
671
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateMessageTemplateVersionResponseSuccess
|
672
672
|
|
@@ -676,22 +676,22 @@ module Aws
|
|
676
676
|
end
|
677
677
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_quick_response-instance_method
|
678
678
|
def create_quick_response: (
|
679
|
-
|
680
|
-
|
679
|
+
knowledge_base_id: ::String,
|
680
|
+
name: ::String,
|
681
681
|
content: {
|
682
682
|
content: ::String?
|
683
683
|
},
|
684
684
|
?content_type: ::String,
|
685
|
-
?description: ::String,
|
686
685
|
?grouping_configuration: {
|
687
686
|
criteria: ::String?,
|
688
687
|
values: Array[::String]?
|
689
688
|
},
|
689
|
+
?description: ::String,
|
690
|
+
?shortcut_key: ::String,
|
690
691
|
?is_active: bool,
|
691
|
-
|
692
|
+
?channels: Array[::String],
|
692
693
|
?language: ::String,
|
693
|
-
|
694
|
-
?shortcut_key: ::String,
|
694
|
+
?client_token: ::String,
|
695
695
|
?tags: Hash[::String, ::String]
|
696
696
|
) -> _CreateQuickResponseResponseSuccess
|
697
697
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateQuickResponseResponseSuccess
|
@@ -702,14 +702,16 @@ module Aws
|
|
702
702
|
end
|
703
703
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_session-instance_method
|
704
704
|
def create_session: (
|
705
|
-
?ai_agent_configuration: Hash[("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE"), {
|
706
|
-
ai_agent_id: ::String
|
707
|
-
}],
|
708
|
-
assistant_id: ::String,
|
709
705
|
?client_token: ::String,
|
710
|
-
|
706
|
+
assistant_id: ::String,
|
711
707
|
name: ::String,
|
708
|
+
?description: ::String,
|
709
|
+
?tags: Hash[::String, ::String],
|
712
710
|
?tag_filter: {
|
711
|
+
tag_condition: {
|
712
|
+
key: ::String,
|
713
|
+
value: ::String?
|
714
|
+
}?,
|
713
715
|
and_conditions: Array[
|
714
716
|
{
|
715
717
|
key: ::String,
|
@@ -729,13 +731,11 @@ module Aws
|
|
729
731
|
value: ::String?
|
730
732
|
}?
|
731
733
|
},
|
732
|
-
]
|
733
|
-
tag_condition: {
|
734
|
-
key: ::String,
|
735
|
-
value: ::String?
|
736
|
-
}?
|
734
|
+
]?
|
737
735
|
},
|
738
|
-
?
|
736
|
+
?ai_agent_configuration: Hash[("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE"), {
|
737
|
+
ai_agent_id: ::String
|
738
|
+
}]
|
739
739
|
) -> _CreateSessionResponseSuccess
|
740
740
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateSessionResponseSuccess
|
741
741
|
|
@@ -758,8 +758,8 @@ module Aws
|
|
758
758
|
end
|
759
759
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_ai_agent-instance_method
|
760
760
|
def delete_ai_agent: (
|
761
|
-
|
762
|
-
|
761
|
+
assistant_id: ::String,
|
762
|
+
ai_agent_id: ::String
|
763
763
|
) -> _DeleteAIAgentResponseSuccess
|
764
764
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAIAgentResponseSuccess
|
765
765
|
|
@@ -768,8 +768,8 @@ module Aws
|
|
768
768
|
end
|
769
769
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_ai_agent_version-instance_method
|
770
770
|
def delete_ai_agent_version: (
|
771
|
-
ai_agent_id: ::String,
|
772
771
|
assistant_id: ::String,
|
772
|
+
ai_agent_id: ::String,
|
773
773
|
version_number: ::Integer
|
774
774
|
) -> _DeleteAIAgentVersionResponseSuccess
|
775
775
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAIAgentVersionResponseSuccess
|
@@ -779,8 +779,8 @@ module Aws
|
|
779
779
|
end
|
780
780
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_ai_guardrail-instance_method
|
781
781
|
def delete_ai_guardrail: (
|
782
|
-
|
783
|
-
|
782
|
+
assistant_id: ::String,
|
783
|
+
ai_guardrail_id: ::String
|
784
784
|
) -> _DeleteAIGuardrailResponseSuccess
|
785
785
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAIGuardrailResponseSuccess
|
786
786
|
|
@@ -789,8 +789,8 @@ module Aws
|
|
789
789
|
end
|
790
790
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_ai_guardrail_version-instance_method
|
791
791
|
def delete_ai_guardrail_version: (
|
792
|
-
ai_guardrail_id: ::String,
|
793
792
|
assistant_id: ::String,
|
793
|
+
ai_guardrail_id: ::String,
|
794
794
|
version_number: ::Integer
|
795
795
|
) -> _DeleteAIGuardrailVersionResponseSuccess
|
796
796
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAIGuardrailVersionResponseSuccess
|
@@ -800,8 +800,8 @@ module Aws
|
|
800
800
|
end
|
801
801
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_ai_prompt-instance_method
|
802
802
|
def delete_ai_prompt: (
|
803
|
-
|
804
|
-
|
803
|
+
assistant_id: ::String,
|
804
|
+
ai_prompt_id: ::String
|
805
805
|
) -> _DeleteAIPromptResponseSuccess
|
806
806
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAIPromptResponseSuccess
|
807
807
|
|
@@ -810,8 +810,8 @@ module Aws
|
|
810
810
|
end
|
811
811
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_ai_prompt_version-instance_method
|
812
812
|
def delete_ai_prompt_version: (
|
813
|
-
ai_prompt_id: ::String,
|
814
813
|
assistant_id: ::String,
|
814
|
+
ai_prompt_id: ::String,
|
815
815
|
version_number: ::Integer
|
816
816
|
) -> _DeleteAIPromptVersionResponseSuccess
|
817
817
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAIPromptVersionResponseSuccess
|
@@ -840,8 +840,8 @@ module Aws
|
|
840
840
|
end
|
841
841
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_content-instance_method
|
842
842
|
def delete_content: (
|
843
|
-
|
844
|
-
|
843
|
+
knowledge_base_id: ::String,
|
844
|
+
content_id: ::String
|
845
845
|
) -> _DeleteContentResponseSuccess
|
846
846
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteContentResponseSuccess
|
847
847
|
|
@@ -850,9 +850,9 @@ module Aws
|
|
850
850
|
end
|
851
851
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_content_association-instance_method
|
852
852
|
def delete_content_association: (
|
853
|
-
|
853
|
+
knowledge_base_id: ::String,
|
854
854
|
content_id: ::String,
|
855
|
-
|
855
|
+
content_association_id: ::String
|
856
856
|
) -> _DeleteContentAssociationResponseSuccess
|
857
857
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteContentAssociationResponseSuccess
|
858
858
|
|
@@ -861,8 +861,8 @@ module Aws
|
|
861
861
|
end
|
862
862
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_import_job-instance_method
|
863
863
|
def delete_import_job: (
|
864
|
-
|
865
|
-
|
864
|
+
knowledge_base_id: ::String,
|
865
|
+
import_job_id: ::String
|
866
866
|
) -> _DeleteImportJobResponseSuccess
|
867
867
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteImportJobResponseSuccess
|
868
868
|
|
@@ -890,9 +890,9 @@ module Aws
|
|
890
890
|
end
|
891
891
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_message_template_attachment-instance_method
|
892
892
|
def delete_message_template_attachment: (
|
893
|
-
attachment_id: ::String,
|
894
893
|
knowledge_base_id: ::String,
|
895
|
-
message_template_id: ::String
|
894
|
+
message_template_id: ::String,
|
895
|
+
attachment_id: ::String
|
896
896
|
) -> _DeleteMessageTemplateAttachmentResponseSuccess
|
897
897
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteMessageTemplateAttachmentResponseSuccess
|
898
898
|
|
@@ -913,8 +913,8 @@ module Aws
|
|
913
913
|
end
|
914
914
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_ai_agent-instance_method
|
915
915
|
def get_ai_agent: (
|
916
|
-
|
917
|
-
|
916
|
+
assistant_id: ::String,
|
917
|
+
ai_agent_id: ::String
|
918
918
|
) -> _GetAIAgentResponseSuccess
|
919
919
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAIAgentResponseSuccess
|
920
920
|
|
@@ -925,8 +925,8 @@ module Aws
|
|
925
925
|
end
|
926
926
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_ai_guardrail-instance_method
|
927
927
|
def get_ai_guardrail: (
|
928
|
-
|
929
|
-
|
928
|
+
assistant_id: ::String,
|
929
|
+
ai_guardrail_id: ::String
|
930
930
|
) -> _GetAIGuardrailResponseSuccess
|
931
931
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAIGuardrailResponseSuccess
|
932
932
|
|
@@ -937,8 +937,8 @@ module Aws
|
|
937
937
|
end
|
938
938
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_ai_prompt-instance_method
|
939
939
|
def get_ai_prompt: (
|
940
|
-
|
941
|
-
|
940
|
+
assistant_id: ::String,
|
941
|
+
ai_prompt_id: ::String
|
942
942
|
) -> _GetAIPromptResponseSuccess
|
943
943
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAIPromptResponseSuccess
|
944
944
|
|
@@ -980,9 +980,9 @@ module Aws
|
|
980
980
|
end
|
981
981
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_content_association-instance_method
|
982
982
|
def get_content_association: (
|
983
|
-
|
983
|
+
knowledge_base_id: ::String,
|
984
984
|
content_id: ::String,
|
985
|
-
|
985
|
+
content_association_id: ::String
|
986
986
|
) -> _GetContentAssociationResponseSuccess
|
987
987
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetContentAssociationResponseSuccess
|
988
988
|
|
@@ -1024,25 +1024,25 @@ module Aws
|
|
1024
1024
|
end
|
1025
1025
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_message_template-instance_method
|
1026
1026
|
def get_message_template: (
|
1027
|
-
|
1028
|
-
|
1027
|
+
message_template_id: ::String,
|
1028
|
+
knowledge_base_id: ::String
|
1029
1029
|
) -> _GetMessageTemplateResponseSuccess
|
1030
1030
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetMessageTemplateResponseSuccess
|
1031
1031
|
|
1032
1032
|
interface _GetNextMessageResponseSuccess
|
1033
1033
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetNextMessageResponse]
|
1034
|
-
def
|
1034
|
+
def type: () -> ("TEXT")
|
1035
|
+
def response: () -> Types::MessageOutput
|
1036
|
+
def request_message_id: () -> ::String
|
1035
1037
|
def conversation_state: () -> Types::ConversationState
|
1036
1038
|
def next_message_token: () -> ::String
|
1037
|
-
def
|
1038
|
-
def response: () -> Types::MessageOutput
|
1039
|
-
def type: () -> ("TEXT")
|
1039
|
+
def conversation_session_data: () -> ::Array[Types::RuntimeSessionData]
|
1040
1040
|
end
|
1041
1041
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_next_message-instance_method
|
1042
1042
|
def get_next_message: (
|
1043
1043
|
assistant_id: ::String,
|
1044
|
-
|
1045
|
-
|
1044
|
+
session_id: ::String,
|
1045
|
+
next_message_token: ::String
|
1046
1046
|
) -> _GetNextMessageResponseSuccess
|
1047
1047
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetNextMessageResponseSuccess
|
1048
1048
|
|
@@ -1052,8 +1052,8 @@ module Aws
|
|
1052
1052
|
end
|
1053
1053
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_quick_response-instance_method
|
1054
1054
|
def get_quick_response: (
|
1055
|
-
|
1056
|
-
|
1055
|
+
quick_response_id: ::String,
|
1056
|
+
knowledge_base_id: ::String
|
1057
1057
|
) -> _GetQuickResponseResponseSuccess
|
1058
1058
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetQuickResponseResponseSuccess
|
1059
1059
|
|
@@ -1065,9 +1065,10 @@ module Aws
|
|
1065
1065
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_recommendations-instance_method
|
1066
1066
|
def get_recommendations: (
|
1067
1067
|
assistant_id: ::String,
|
1068
|
-
?max_results: ::Integer,
|
1069
1068
|
session_id: ::String,
|
1070
|
-
?
|
1069
|
+
?max_results: ::Integer,
|
1070
|
+
?wait_time_seconds: ::Integer,
|
1071
|
+
?next_chunk_token: ::String
|
1071
1072
|
) -> _GetRecommendationsResponseSuccess
|
1072
1073
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetRecommendationsResponseSuccess
|
1073
1074
|
|
@@ -1089,10 +1090,10 @@ module Aws
|
|
1089
1090
|
end
|
1090
1091
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_ai_agent_versions-instance_method
|
1091
1092
|
def list_ai_agent_versions: (
|
1092
|
-
ai_agent_id: ::String,
|
1093
1093
|
assistant_id: ::String,
|
1094
|
-
|
1094
|
+
ai_agent_id: ::String,
|
1095
1095
|
?next_token: ::String,
|
1096
|
+
?max_results: ::Integer,
|
1096
1097
|
?origin: ("SYSTEM" | "CUSTOMER")
|
1097
1098
|
) -> _ListAIAgentVersionsResponseSuccess
|
1098
1099
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAIAgentVersionsResponseSuccess
|
@@ -1105,8 +1106,8 @@ module Aws
|
|
1105
1106
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_ai_agents-instance_method
|
1106
1107
|
def list_ai_agents: (
|
1107
1108
|
assistant_id: ::String,
|
1108
|
-
?max_results: ::Integer,
|
1109
1109
|
?next_token: ::String,
|
1110
|
+
?max_results: ::Integer,
|
1110
1111
|
?origin: ("SYSTEM" | "CUSTOMER")
|
1111
1112
|
) -> _ListAIAgentsResponseSuccess
|
1112
1113
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAIAgentsResponseSuccess
|
@@ -1118,10 +1119,10 @@ module Aws
|
|
1118
1119
|
end
|
1119
1120
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_ai_guardrail_versions-instance_method
|
1120
1121
|
def list_ai_guardrail_versions: (
|
1121
|
-
ai_guardrail_id: ::String,
|
1122
1122
|
assistant_id: ::String,
|
1123
|
-
|
1124
|
-
?next_token: ::String
|
1123
|
+
ai_guardrail_id: ::String,
|
1124
|
+
?next_token: ::String,
|
1125
|
+
?max_results: ::Integer
|
1125
1126
|
) -> _ListAIGuardrailVersionsResponseSuccess
|
1126
1127
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAIGuardrailVersionsResponseSuccess
|
1127
1128
|
|
@@ -1133,8 +1134,8 @@ module Aws
|
|
1133
1134
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_ai_guardrails-instance_method
|
1134
1135
|
def list_ai_guardrails: (
|
1135
1136
|
assistant_id: ::String,
|
1136
|
-
?
|
1137
|
-
?
|
1137
|
+
?next_token: ::String,
|
1138
|
+
?max_results: ::Integer
|
1138
1139
|
) -> _ListAIGuardrailsResponseSuccess
|
1139
1140
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAIGuardrailsResponseSuccess
|
1140
1141
|
|
@@ -1145,10 +1146,10 @@ module Aws
|
|
1145
1146
|
end
|
1146
1147
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_ai_prompt_versions-instance_method
|
1147
1148
|
def list_ai_prompt_versions: (
|
1148
|
-
ai_prompt_id: ::String,
|
1149
1149
|
assistant_id: ::String,
|
1150
|
-
|
1150
|
+
ai_prompt_id: ::String,
|
1151
1151
|
?next_token: ::String,
|
1152
|
+
?max_results: ::Integer,
|
1152
1153
|
?origin: ("SYSTEM" | "CUSTOMER")
|
1153
1154
|
) -> _ListAIPromptVersionsResponseSuccess
|
1154
1155
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAIPromptVersionsResponseSuccess
|
@@ -1161,8 +1162,8 @@ module Aws
|
|
1161
1162
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_ai_prompts-instance_method
|
1162
1163
|
def list_ai_prompts: (
|
1163
1164
|
assistant_id: ::String,
|
1164
|
-
?max_results: ::Integer,
|
1165
1165
|
?next_token: ::String,
|
1166
|
+
?max_results: ::Integer,
|
1166
1167
|
?origin: ("SYSTEM" | "CUSTOMER")
|
1167
1168
|
) -> _ListAIPromptsResponseSuccess
|
1168
1169
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAIPromptsResponseSuccess
|
@@ -1174,9 +1175,9 @@ module Aws
|
|
1174
1175
|
end
|
1175
1176
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_assistant_associations-instance_method
|
1176
1177
|
def list_assistant_associations: (
|
1177
|
-
|
1178
|
+
?next_token: ::String,
|
1178
1179
|
?max_results: ::Integer,
|
1179
|
-
|
1180
|
+
assistant_id: ::String
|
1180
1181
|
) -> _ListAssistantAssociationsResponseSuccess
|
1181
1182
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAssistantAssociationsResponseSuccess
|
1182
1183
|
|
@@ -1187,8 +1188,8 @@ module Aws
|
|
1187
1188
|
end
|
1188
1189
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_assistants-instance_method
|
1189
1190
|
def list_assistants: (
|
1190
|
-
?
|
1191
|
-
?
|
1191
|
+
?next_token: ::String,
|
1192
|
+
?max_results: ::Integer
|
1192
1193
|
) -> _ListAssistantsResponseSuccess
|
1193
1194
|
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAssistantsResponseSuccess
|
1194
1195
|
|
@@ -1199,10 +1200,10 @@ module Aws
|
|
1199
1200
|
end
|
1200
1201
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_content_associations-instance_method
|
1201
1202
|
def list_content_associations: (
|
1202
|
-
|
1203
|
-
knowledge_base_id: ::String,
|
1203
|
+
?next_token: ::String,
|
1204
1204
|
?max_results: ::Integer,
|
1205
|
-
|
1205
|
+
knowledge_base_id: ::String,
|
1206
|
+
content_id: ::String
|
1206
1207
|
) -> _ListContentAssociationsResponseSuccess
|
1207
1208
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListContentAssociationsResponseSuccess
|
1208
1209
|
|
@@ -1213,9 +1214,9 @@ module Aws
|
|
1213
1214
|
end
|
1214
1215
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_contents-instance_method
|
1215
1216
|
def list_contents: (
|
1216
|
-
|
1217
|
+
?next_token: ::String,
|
1217
1218
|
?max_results: ::Integer,
|
1218
|
-
|
1219
|
+
knowledge_base_id: ::String
|
1219
1220
|
) -> _ListContentsResponseSuccess
|
1220
1221
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListContentsResponseSuccess
|
1221
1222
|
|
@@ -1226,9 +1227,9 @@ module Aws
|
|
1226
1227
|
end
|
1227
1228
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_import_jobs-instance_method
|
1228
1229
|
def list_import_jobs: (
|
1229
|
-
|
1230
|
+
?next_token: ::String,
|
1230
1231
|
?max_results: ::Integer,
|
1231
|
-
|
1232
|
+
knowledge_base_id: ::String
|
1232
1233
|
) -> _ListImportJobsResponseSuccess
|
1233
1234
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListImportJobsResponseSuccess
|
1234
1235
|
|
@@ -1239,8 +1240,8 @@ module Aws
|
|
1239
1240
|
end
|
1240
1241
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_knowledge_bases-instance_method
|
1241
1242
|
def list_knowledge_bases: (
|
1242
|
-
?
|
1243
|
-
?
|
1243
|
+
?next_token: ::String,
|
1244
|
+
?max_results: ::Integer
|
1244
1245
|
) -> _ListKnowledgeBasesResponseSuccess
|
1245
1246
|
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListKnowledgeBasesResponseSuccess
|
1246
1247
|
|
@@ -1252,9 +1253,9 @@ module Aws
|
|
1252
1253
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_message_template_versions-instance_method
|
1253
1254
|
def list_message_template_versions: (
|
1254
1255
|
knowledge_base_id: ::String,
|
1255
|
-
?max_results: ::Integer,
|
1256
1256
|
message_template_id: ::String,
|
1257
|
-
?next_token: ::String
|
1257
|
+
?next_token: ::String,
|
1258
|
+
?max_results: ::Integer
|
1258
1259
|
) -> _ListMessageTemplateVersionsResponseSuccess
|
1259
1260
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListMessageTemplateVersionsResponseSuccess
|
1260
1261
|
|
@@ -1265,9 +1266,9 @@ module Aws
|
|
1265
1266
|
end
|
1266
1267
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_message_templates-instance_method
|
1267
1268
|
def list_message_templates: (
|
1268
|
-
|
1269
|
+
?next_token: ::String,
|
1269
1270
|
?max_results: ::Integer,
|
1270
|
-
|
1271
|
+
knowledge_base_id: ::String
|
1271
1272
|
) -> _ListMessageTemplatesResponseSuccess
|
1272
1273
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListMessageTemplatesResponseSuccess
|
1273
1274
|
|
@@ -1279,22 +1280,22 @@ module Aws
|
|
1279
1280
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_messages-instance_method
|
1280
1281
|
def list_messages: (
|
1281
1282
|
assistant_id: ::String,
|
1282
|
-
|
1283
|
+
session_id: ::String,
|
1283
1284
|
?next_token: ::String,
|
1284
|
-
|
1285
|
+
?max_results: ::Integer
|
1285
1286
|
) -> _ListMessagesResponseSuccess
|
1286
1287
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListMessagesResponseSuccess
|
1287
1288
|
|
1288
1289
|
interface _ListQuickResponsesResponseSuccess
|
1289
1290
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListQuickResponsesResponse]
|
1290
|
-
def next_token: () -> ::String
|
1291
1291
|
def quick_response_summaries: () -> ::Array[Types::QuickResponseSummary]
|
1292
|
+
def next_token: () -> ::String
|
1292
1293
|
end
|
1293
1294
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_quick_responses-instance_method
|
1294
1295
|
def list_quick_responses: (
|
1295
|
-
|
1296
|
+
?next_token: ::String,
|
1296
1297
|
?max_results: ::Integer,
|
1297
|
-
|
1298
|
+
knowledge_base_id: ::String
|
1298
1299
|
) -> _ListQuickResponsesResponseSuccess
|
1299
1300
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListQuickResponsesResponseSuccess
|
1300
1301
|
|
@@ -1310,68 +1311,68 @@ module Aws
|
|
1310
1311
|
|
1311
1312
|
interface _NotifyRecommendationsReceivedResponseSuccess
|
1312
1313
|
include ::Seahorse::Client::_ResponseSuccess[Types::NotifyRecommendationsReceivedResponse]
|
1313
|
-
def errors: () -> ::Array[Types::NotifyRecommendationsReceivedError]
|
1314
1314
|
def recommendation_ids: () -> ::Array[::String]
|
1315
|
+
def errors: () -> ::Array[Types::NotifyRecommendationsReceivedError]
|
1315
1316
|
end
|
1316
1317
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#notify_recommendations_received-instance_method
|
1317
1318
|
def notify_recommendations_received: (
|
1318
1319
|
assistant_id: ::String,
|
1319
|
-
|
1320
|
-
|
1320
|
+
session_id: ::String,
|
1321
|
+
recommendation_ids: Array[::String]
|
1321
1322
|
) -> _NotifyRecommendationsReceivedResponseSuccess
|
1322
1323
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _NotifyRecommendationsReceivedResponseSuccess
|
1323
1324
|
|
1324
1325
|
interface _PutFeedbackResponseSuccess
|
1325
1326
|
include ::Seahorse::Client::_ResponseSuccess[Types::PutFeedbackResponse]
|
1326
|
-
def assistant_arn: () -> ::String
|
1327
1327
|
def assistant_id: () -> ::String
|
1328
|
-
def
|
1328
|
+
def assistant_arn: () -> ::String
|
1329
1329
|
def target_id: () -> ::String
|
1330
1330
|
def target_type: () -> ("RECOMMENDATION" | "RESULT")
|
1331
|
+
def content_feedback: () -> Types::ContentFeedbackData
|
1331
1332
|
end
|
1332
1333
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#put_feedback-instance_method
|
1333
1334
|
def put_feedback: (
|
1334
1335
|
assistant_id: ::String,
|
1336
|
+
target_id: ::String,
|
1337
|
+
target_type: ("RECOMMENDATION" | "RESULT"),
|
1335
1338
|
content_feedback: {
|
1336
1339
|
generative_content_feedback_data: {
|
1337
1340
|
relevance: ("HELPFUL" | "NOT_HELPFUL")
|
1338
1341
|
}?
|
1339
|
-
}
|
1340
|
-
target_id: ::String,
|
1341
|
-
target_type: ("RECOMMENDATION" | "RESULT")
|
1342
|
+
}
|
1342
1343
|
) -> _PutFeedbackResponseSuccess
|
1343
1344
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutFeedbackResponseSuccess
|
1344
1345
|
|
1345
1346
|
interface _QueryAssistantResponseSuccess
|
1346
1347
|
include ::Seahorse::Client::_ResponseSuccess[Types::QueryAssistantResponse]
|
1347
|
-
def next_token: () -> ::String
|
1348
1348
|
def results: () -> ::Array[Types::ResultData]
|
1349
|
+
def next_token: () -> ::String
|
1349
1350
|
end
|
1350
1351
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#query_assistant-instance_method
|
1351
1352
|
def query_assistant: (
|
1352
1353
|
assistant_id: ::String,
|
1353
|
-
?
|
1354
|
+
?query_text: ::String,
|
1354
1355
|
?next_token: ::String,
|
1355
|
-
?
|
1356
|
+
?max_results: ::Integer,
|
1357
|
+
?session_id: ::String,
|
1356
1358
|
?query_condition: Array[
|
1357
1359
|
{
|
1358
1360
|
single: {
|
1359
|
-
comparator: ("EQUALS"),
|
1360
1361
|
field: ("RESULT_TYPE"),
|
1362
|
+
comparator: ("EQUALS"),
|
1361
1363
|
value: ::String
|
1362
1364
|
}?
|
1363
1365
|
},
|
1364
1366
|
],
|
1365
1367
|
?query_input_data: {
|
1366
|
-
intent_input_data: {
|
1367
|
-
intent_id: ::String
|
1368
|
-
}?,
|
1369
1368
|
query_text_input_data: {
|
1370
1369
|
text: ::String
|
1370
|
+
}?,
|
1371
|
+
intent_input_data: {
|
1372
|
+
intent_id: ::String
|
1371
1373
|
}?
|
1372
1374
|
},
|
1373
|
-
?
|
1374
|
-
?session_id: ::String
|
1375
|
+
?override_knowledge_base_search_type: ("HYBRID" | "SEMANTIC")
|
1375
1376
|
) -> _QueryAssistantResponseSuccess
|
1376
1377
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _QueryAssistantResponseSuccess
|
1377
1378
|
|
@@ -1380,8 +1381,8 @@ module Aws
|
|
1380
1381
|
end
|
1381
1382
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#remove_assistant_ai_agent-instance_method
|
1382
1383
|
def remove_assistant_ai_agent: (
|
1383
|
-
|
1384
|
-
|
1384
|
+
assistant_id: ::String,
|
1385
|
+
ai_agent_type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE")
|
1385
1386
|
) -> _RemoveAssistantAIAgentResponseSuccess
|
1386
1387
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RemoveAssistantAIAgentResponseSuccess
|
1387
1388
|
|
@@ -1396,90 +1397,90 @@ module Aws
|
|
1396
1397
|
|
1397
1398
|
interface _RenderMessageTemplateResponseSuccess
|
1398
1399
|
include ::Seahorse::Client::_ResponseSuccess[Types::RenderMessageTemplateResponse]
|
1399
|
-
def attachments: () -> ::Array[Types::MessageTemplateAttachment]
|
1400
|
-
def attributes_not_interpolated: () -> ::Array[::String]
|
1401
1400
|
def content: () -> Types::MessageTemplateContentProvider
|
1401
|
+
def attributes_not_interpolated: () -> ::Array[::String]
|
1402
|
+
def attachments: () -> ::Array[Types::MessageTemplateAttachment]
|
1402
1403
|
end
|
1403
1404
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#render_message_template-instance_method
|
1404
1405
|
def render_message_template: (
|
1406
|
+
knowledge_base_id: ::String,
|
1407
|
+
message_template_id: ::String,
|
1405
1408
|
attributes: {
|
1409
|
+
system_attributes: {
|
1410
|
+
name: ::String?,
|
1411
|
+
customer_endpoint: {
|
1412
|
+
address: ::String?
|
1413
|
+
}?,
|
1414
|
+
system_endpoint: {
|
1415
|
+
address: ::String?
|
1416
|
+
}?
|
1417
|
+
}?,
|
1406
1418
|
agent_attributes: {
|
1407
1419
|
first_name: ::String?,
|
1408
1420
|
last_name: ::String?
|
1409
1421
|
}?,
|
1410
|
-
custom_attributes: Hash[::String, ::String]?,
|
1411
1422
|
customer_profile_attributes: {
|
1423
|
+
profile_id: ::String?,
|
1424
|
+
profile_arn: ::String?,
|
1425
|
+
first_name: ::String?,
|
1426
|
+
middle_name: ::String?,
|
1427
|
+
last_name: ::String?,
|
1412
1428
|
account_number: ::String?,
|
1429
|
+
email_address: ::String?,
|
1430
|
+
phone_number: ::String?,
|
1413
1431
|
additional_information: ::String?,
|
1432
|
+
party_type: ::String?,
|
1433
|
+
business_name: ::String?,
|
1434
|
+
birth_date: ::String?,
|
1435
|
+
gender: ::String?,
|
1436
|
+
mobile_phone_number: ::String?,
|
1437
|
+
home_phone_number: ::String?,
|
1438
|
+
business_phone_number: ::String?,
|
1439
|
+
business_email_address: ::String?,
|
1414
1440
|
address1: ::String?,
|
1415
1441
|
address2: ::String?,
|
1416
1442
|
address3: ::String?,
|
1417
1443
|
address4: ::String?,
|
1418
|
-
billing_address_1: ::String?,
|
1419
|
-
billing_address_2: ::String?,
|
1420
|
-
billing_address_3: ::String?,
|
1421
|
-
billing_address_4: ::String?,
|
1422
|
-
billing_city: ::String?,
|
1423
|
-
billing_country: ::String?,
|
1424
|
-
billing_county: ::String?,
|
1425
|
-
billing_postal_code: ::String?,
|
1426
|
-
billing_province: ::String?,
|
1427
|
-
billing_state: ::String?,
|
1428
|
-
birth_date: ::String?,
|
1429
|
-
business_email_address: ::String?,
|
1430
|
-
business_name: ::String?,
|
1431
|
-
business_phone_number: ::String?,
|
1432
1444
|
city: ::String?,
|
1433
|
-
country: ::String?,
|
1434
1445
|
county: ::String?,
|
1435
|
-
|
1436
|
-
email_address: ::String?,
|
1437
|
-
first_name: ::String?,
|
1438
|
-
gender: ::String?,
|
1439
|
-
home_phone_number: ::String?,
|
1440
|
-
last_name: ::String?,
|
1441
|
-
mailing_address_1: ::String?,
|
1442
|
-
mailing_address_2: ::String?,
|
1443
|
-
mailing_address_3: ::String?,
|
1444
|
-
mailing_address_4: ::String?,
|
1445
|
-
mailing_city: ::String?,
|
1446
|
-
mailing_country: ::String?,
|
1447
|
-
mailing_county: ::String?,
|
1448
|
-
mailing_postal_code: ::String?,
|
1449
|
-
mailing_province: ::String?,
|
1450
|
-
mailing_state: ::String?,
|
1451
|
-
middle_name: ::String?,
|
1452
|
-
mobile_phone_number: ::String?,
|
1453
|
-
party_type: ::String?,
|
1454
|
-
phone_number: ::String?,
|
1446
|
+
country: ::String?,
|
1455
1447
|
postal_code: ::String?,
|
1456
|
-
profile_arn: ::String?,
|
1457
|
-
profile_id: ::String?,
|
1458
1448
|
province: ::String?,
|
1449
|
+
state: ::String?,
|
1459
1450
|
shipping_address_1: ::String?,
|
1460
1451
|
shipping_address_2: ::String?,
|
1461
1452
|
shipping_address_3: ::String?,
|
1462
1453
|
shipping_address_4: ::String?,
|
1463
1454
|
shipping_city: ::String?,
|
1464
|
-
shipping_country: ::String?,
|
1465
1455
|
shipping_county: ::String?,
|
1456
|
+
shipping_country: ::String?,
|
1466
1457
|
shipping_postal_code: ::String?,
|
1467
1458
|
shipping_province: ::String?,
|
1468
1459
|
shipping_state: ::String?,
|
1469
|
-
|
1460
|
+
mailing_address_1: ::String?,
|
1461
|
+
mailing_address_2: ::String?,
|
1462
|
+
mailing_address_3: ::String?,
|
1463
|
+
mailing_address_4: ::String?,
|
1464
|
+
mailing_city: ::String?,
|
1465
|
+
mailing_county: ::String?,
|
1466
|
+
mailing_country: ::String?,
|
1467
|
+
mailing_postal_code: ::String?,
|
1468
|
+
mailing_province: ::String?,
|
1469
|
+
mailing_state: ::String?,
|
1470
|
+
billing_address_1: ::String?,
|
1471
|
+
billing_address_2: ::String?,
|
1472
|
+
billing_address_3: ::String?,
|
1473
|
+
billing_address_4: ::String?,
|
1474
|
+
billing_city: ::String?,
|
1475
|
+
billing_county: ::String?,
|
1476
|
+
billing_country: ::String?,
|
1477
|
+
billing_postal_code: ::String?,
|
1478
|
+
billing_province: ::String?,
|
1479
|
+
billing_state: ::String?,
|
1480
|
+
custom: Hash[::String, ::String]?
|
1470
1481
|
}?,
|
1471
|
-
|
1472
|
-
|
1473
|
-
address: ::String?
|
1474
|
-
}?,
|
1475
|
-
name: ::String?,
|
1476
|
-
system_endpoint: {
|
1477
|
-
address: ::String?
|
1478
|
-
}?
|
1479
|
-
}?
|
1480
|
-
},
|
1481
|
-
knowledge_base_id: ::String,
|
1482
|
-
message_template_id: ::String
|
1482
|
+
custom_attributes: Hash[::String, ::String]?
|
1483
|
+
}
|
1483
1484
|
) -> _RenderMessageTemplateResponseSuccess
|
1484
1485
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RenderMessageTemplateResponseSuccess
|
1485
1486
|
|
@@ -1490,9 +1491,9 @@ module Aws
|
|
1490
1491
|
end
|
1491
1492
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#search_content-instance_method
|
1492
1493
|
def search_content: (
|
1493
|
-
knowledge_base_id: ::String,
|
1494
|
-
?max_results: ::Integer,
|
1495
1494
|
?next_token: ::String,
|
1495
|
+
?max_results: ::Integer,
|
1496
|
+
knowledge_base_id: ::String,
|
1496
1497
|
search_expression: {
|
1497
1498
|
filters: Array[
|
1498
1499
|
{
|
@@ -1507,87 +1508,87 @@ module Aws
|
|
1507
1508
|
|
1508
1509
|
interface _SearchMessageTemplatesResponseSuccess
|
1509
1510
|
include ::Seahorse::Client::_ResponseSuccess[Types::SearchMessageTemplatesResponse]
|
1510
|
-
def next_token: () -> ::String
|
1511
1511
|
def results: () -> ::Array[Types::MessageTemplateSearchResultData]
|
1512
|
+
def next_token: () -> ::String
|
1512
1513
|
end
|
1513
1514
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#search_message_templates-instance_method
|
1514
1515
|
def search_message_templates: (
|
1515
1516
|
knowledge_base_id: ::String,
|
1516
|
-
?max_results: ::Integer,
|
1517
|
-
?next_token: ::String,
|
1518
1517
|
search_expression: {
|
1518
|
+
queries: Array[
|
1519
|
+
{
|
1520
|
+
name: ::String,
|
1521
|
+
values: Array[::String],
|
1522
|
+
operator: ("CONTAINS" | "CONTAINS_AND_PREFIX"),
|
1523
|
+
allow_fuzziness: bool?,
|
1524
|
+
priority: ("HIGH" | "MEDIUM" | "LOW")?
|
1525
|
+
},
|
1526
|
+
]?,
|
1519
1527
|
filters: Array[
|
1520
1528
|
{
|
1521
|
-
include_no_existence: bool?,
|
1522
1529
|
name: ::String,
|
1530
|
+
values: Array[::String]?,
|
1523
1531
|
operator: ("EQUALS" | "PREFIX"),
|
1524
|
-
|
1532
|
+
include_no_existence: bool?
|
1525
1533
|
},
|
1526
1534
|
]?,
|
1527
1535
|
order_on_field: {
|
1528
1536
|
name: ::String,
|
1529
1537
|
order: ("ASC" | "DESC")?
|
1530
|
-
}
|
1531
|
-
|
1532
|
-
|
1533
|
-
|
1534
|
-
name: ::String,
|
1535
|
-
operator: ("CONTAINS" | "CONTAINS_AND_PREFIX"),
|
1536
|
-
priority: ("HIGH" | "MEDIUM" | "LOW")?,
|
1537
|
-
values: Array[::String]
|
1538
|
-
},
|
1539
|
-
]?
|
1540
|
-
}
|
1538
|
+
}?
|
1539
|
+
},
|
1540
|
+
?next_token: ::String,
|
1541
|
+
?max_results: ::Integer
|
1541
1542
|
) -> _SearchMessageTemplatesResponseSuccess
|
1542
1543
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchMessageTemplatesResponseSuccess
|
1543
1544
|
|
1544
1545
|
interface _SearchQuickResponsesResponseSuccess
|
1545
1546
|
include ::Seahorse::Client::_ResponseSuccess[Types::SearchQuickResponsesResponse]
|
1546
|
-
def next_token: () -> ::String
|
1547
1547
|
def results: () -> ::Array[Types::QuickResponseSearchResultData]
|
1548
|
+
def next_token: () -> ::String
|
1548
1549
|
end
|
1549
1550
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#search_quick_responses-instance_method
|
1550
1551
|
def search_quick_responses: (
|
1551
|
-
?attributes: Hash[::String, ::String],
|
1552
1552
|
knowledge_base_id: ::String,
|
1553
|
-
?max_results: ::Integer,
|
1554
|
-
?next_token: ::String,
|
1555
1553
|
search_expression: {
|
1554
|
+
queries: Array[
|
1555
|
+
{
|
1556
|
+
name: ::String,
|
1557
|
+
values: Array[::String],
|
1558
|
+
operator: ("CONTAINS" | "CONTAINS_AND_PREFIX"),
|
1559
|
+
allow_fuzziness: bool?,
|
1560
|
+
priority: ("HIGH" | "MEDIUM" | "LOW")?
|
1561
|
+
},
|
1562
|
+
]?,
|
1556
1563
|
filters: Array[
|
1557
1564
|
{
|
1558
|
-
include_no_existence: bool?,
|
1559
1565
|
name: ::String,
|
1566
|
+
values: Array[::String]?,
|
1560
1567
|
operator: ("EQUALS" | "PREFIX"),
|
1561
|
-
|
1568
|
+
include_no_existence: bool?
|
1562
1569
|
},
|
1563
1570
|
]?,
|
1564
1571
|
order_on_field: {
|
1565
1572
|
name: ::String,
|
1566
1573
|
order: ("ASC" | "DESC")?
|
1567
|
-
}
|
1568
|
-
|
1569
|
-
|
1570
|
-
|
1571
|
-
|
1572
|
-
operator: ("CONTAINS" | "CONTAINS_AND_PREFIX"),
|
1573
|
-
priority: ("HIGH" | "MEDIUM" | "LOW")?,
|
1574
|
-
values: Array[::String]
|
1575
|
-
},
|
1576
|
-
]?
|
1577
|
-
}
|
1574
|
+
}?
|
1575
|
+
},
|
1576
|
+
?next_token: ::String,
|
1577
|
+
?max_results: ::Integer,
|
1578
|
+
?attributes: Hash[::String, ::String]
|
1578
1579
|
) -> _SearchQuickResponsesResponseSuccess
|
1579
1580
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchQuickResponsesResponseSuccess
|
1580
1581
|
|
1581
1582
|
interface _SearchSessionsResponseSuccess
|
1582
1583
|
include ::Seahorse::Client::_ResponseSuccess[Types::SearchSessionsResponse]
|
1583
|
-
def next_token: () -> ::String
|
1584
1584
|
def session_summaries: () -> ::Array[Types::SessionSummary]
|
1585
|
+
def next_token: () -> ::String
|
1585
1586
|
end
|
1586
1587
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#search_sessions-instance_method
|
1587
1588
|
def search_sessions: (
|
1588
|
-
assistant_id: ::String,
|
1589
|
-
?max_results: ::Integer,
|
1590
1589
|
?next_token: ::String,
|
1590
|
+
?max_results: ::Integer,
|
1591
|
+
assistant_id: ::String,
|
1591
1592
|
search_expression: {
|
1592
1593
|
filters: Array[
|
1593
1594
|
{
|
@@ -1602,45 +1603,49 @@ module Aws
|
|
1602
1603
|
|
1603
1604
|
interface _SendMessageResponseSuccess
|
1604
1605
|
include ::Seahorse::Client::_ResponseSuccess[Types::SendMessageResponse]
|
1605
|
-
def next_message_token: () -> ::String
|
1606
1606
|
def request_message_id: () -> ::String
|
1607
|
+
def configuration: () -> Types::MessageConfiguration
|
1608
|
+
def next_message_token: () -> ::String
|
1607
1609
|
end
|
1608
1610
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#send_message-instance_method
|
1609
1611
|
def send_message: (
|
1610
1612
|
assistant_id: ::String,
|
1611
|
-
|
1613
|
+
session_id: ::String,
|
1614
|
+
type: ("TEXT"),
|
1615
|
+
message: {
|
1616
|
+
value: {
|
1617
|
+
text: {
|
1618
|
+
value: ::String?
|
1619
|
+
}?
|
1620
|
+
}
|
1621
|
+
},
|
1612
1622
|
?conversation_context: {
|
1613
1623
|
self_service_conversation_history: Array[
|
1614
1624
|
{
|
1615
|
-
|
1625
|
+
turn_number: ::Integer,
|
1616
1626
|
input_transcript: ::String?,
|
1617
|
-
|
1627
|
+
bot_response: ::String?
|
1618
1628
|
},
|
1619
1629
|
]
|
1620
1630
|
},
|
1621
|
-
|
1622
|
-
|
1623
|
-
text: {
|
1624
|
-
value: ::String?
|
1625
|
-
}?
|
1626
|
-
}
|
1631
|
+
?configuration: {
|
1632
|
+
generate_filler_message: bool?
|
1627
1633
|
},
|
1628
|
-
|
1629
|
-
type: ("TEXT")
|
1634
|
+
?client_token: ::String
|
1630
1635
|
) -> _SendMessageResponseSuccess
|
1631
1636
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendMessageResponseSuccess
|
1632
1637
|
|
1633
1638
|
interface _StartContentUploadResponseSuccess
|
1634
1639
|
include ::Seahorse::Client::_ResponseSuccess[Types::StartContentUploadResponse]
|
1635
|
-
def headers_to_include: () -> ::Hash[::String, ::String]
|
1636
1640
|
def upload_id: () -> ::String
|
1637
1641
|
def url: () -> ::String
|
1638
1642
|
def url_expiry: () -> ::Time
|
1643
|
+
def headers_to_include: () -> ::Hash[::String, ::String]
|
1639
1644
|
end
|
1640
1645
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#start_content_upload-instance_method
|
1641
1646
|
def start_content_upload: (
|
1642
|
-
content_type: ::String,
|
1643
1647
|
knowledge_base_id: ::String,
|
1648
|
+
content_type: ::String,
|
1644
1649
|
?presigned_url_time_to_live: ::Integer
|
1645
1650
|
) -> _StartContentUploadResponseSuccess
|
1646
1651
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartContentUploadResponseSuccess
|
@@ -1651,19 +1656,19 @@ module Aws
|
|
1651
1656
|
end
|
1652
1657
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#start_import_job-instance_method
|
1653
1658
|
def start_import_job: (
|
1659
|
+
knowledge_base_id: ::String,
|
1660
|
+
import_job_type: ("QUICK_RESPONSES"),
|
1661
|
+
upload_id: ::String,
|
1654
1662
|
?client_token: ::String,
|
1663
|
+
?metadata: Hash[::String, ::String],
|
1655
1664
|
?external_source_configuration: {
|
1665
|
+
source: ("AMAZON_CONNECT"),
|
1656
1666
|
configuration: {
|
1657
1667
|
connect_configuration: {
|
1658
1668
|
instance_id: ::String?
|
1659
1669
|
}?
|
1660
|
-
}
|
1661
|
-
|
1662
|
-
},
|
1663
|
-
import_job_type: ("QUICK_RESPONSES"),
|
1664
|
-
knowledge_base_id: ::String,
|
1665
|
-
?metadata: Hash[::String, ::String],
|
1666
|
-
upload_id: ::String
|
1670
|
+
}
|
1671
|
+
}
|
1667
1672
|
) -> _StartImportJobResponseSuccess
|
1668
1673
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartImportJobResponseSuccess
|
1669
1674
|
|
@@ -1693,18 +1698,25 @@ module Aws
|
|
1693
1698
|
end
|
1694
1699
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_ai_agent-instance_method
|
1695
1700
|
def update_ai_agent: (
|
1696
|
-
ai_agent_id: ::String,
|
1697
|
-
assistant_id: ::String,
|
1698
1701
|
?client_token: ::String,
|
1702
|
+
assistant_id: ::String,
|
1703
|
+
ai_agent_id: ::String,
|
1704
|
+
visibility_status: ("SAVED" | "PUBLISHED"),
|
1699
1705
|
?configuration: {
|
1700
|
-
|
1701
|
-
answer_generation_ai_guardrail_id: ::String?,
|
1706
|
+
manual_search_ai_agent_configuration: {
|
1702
1707
|
answer_generation_ai_prompt_id: ::String?,
|
1708
|
+
answer_generation_ai_guardrail_id: ::String?,
|
1703
1709
|
association_configurations: Array[
|
1704
1710
|
{
|
1711
|
+
association_id: ::String?,
|
1712
|
+
association_type: ("KNOWLEDGE_BASE")?,
|
1705
1713
|
association_configuration_data: {
|
1706
1714
|
knowledge_base_association_configuration_data: {
|
1707
1715
|
content_tag_filter: {
|
1716
|
+
tag_condition: {
|
1717
|
+
key: ::String,
|
1718
|
+
value: ::String?
|
1719
|
+
}?,
|
1708
1720
|
and_conditions: Array[
|
1709
1721
|
{
|
1710
1722
|
key: ::String,
|
@@ -1724,32 +1736,32 @@ module Aws
|
|
1724
1736
|
value: ::String?
|
1725
1737
|
}?
|
1726
1738
|
},
|
1727
|
-
]
|
1728
|
-
tag_condition: {
|
1729
|
-
key: ::String,
|
1730
|
-
value: ::String?
|
1731
|
-
}?
|
1739
|
+
]?
|
1732
1740
|
}?,
|
1733
1741
|
max_results: ::Integer?,
|
1734
1742
|
override_knowledge_base_search_type: ("HYBRID" | "SEMANTIC")?
|
1735
1743
|
}?
|
1736
|
-
}
|
1737
|
-
association_id: ::String?,
|
1738
|
-
association_type: ("KNOWLEDGE_BASE")?
|
1744
|
+
}?
|
1739
1745
|
},
|
1740
1746
|
]?,
|
1741
|
-
|
1742
|
-
locale: ::String?,
|
1743
|
-
query_reformulation_ai_prompt_id: ::String?
|
1747
|
+
locale: ::String?
|
1744
1748
|
}?,
|
1745
|
-
|
1746
|
-
|
1749
|
+
answer_recommendation_ai_agent_configuration: {
|
1750
|
+
intent_labeling_generation_ai_prompt_id: ::String?,
|
1751
|
+
query_reformulation_ai_prompt_id: ::String?,
|
1747
1752
|
answer_generation_ai_prompt_id: ::String?,
|
1753
|
+
answer_generation_ai_guardrail_id: ::String?,
|
1748
1754
|
association_configurations: Array[
|
1749
1755
|
{
|
1756
|
+
association_id: ::String?,
|
1757
|
+
association_type: ("KNOWLEDGE_BASE")?,
|
1750
1758
|
association_configuration_data: {
|
1751
1759
|
knowledge_base_association_configuration_data: {
|
1752
1760
|
content_tag_filter: {
|
1761
|
+
tag_condition: {
|
1762
|
+
key: ::String,
|
1763
|
+
value: ::String?
|
1764
|
+
}?,
|
1753
1765
|
and_conditions: Array[
|
1754
1766
|
{
|
1755
1767
|
key: ::String,
|
@@ -1769,28 +1781,31 @@ module Aws
|
|
1769
1781
|
value: ::String?
|
1770
1782
|
}?
|
1771
1783
|
},
|
1772
|
-
]
|
1773
|
-
tag_condition: {
|
1774
|
-
key: ::String,
|
1775
|
-
value: ::String?
|
1776
|
-
}?
|
1784
|
+
]?
|
1777
1785
|
}?,
|
1778
1786
|
max_results: ::Integer?,
|
1779
1787
|
override_knowledge_base_search_type: ("HYBRID" | "SEMANTIC")?
|
1780
1788
|
}?
|
1781
|
-
}
|
1782
|
-
association_id: ::String?,
|
1783
|
-
association_type: ("KNOWLEDGE_BASE")?
|
1789
|
+
}?
|
1784
1790
|
},
|
1785
1791
|
]?,
|
1786
1792
|
locale: ::String?
|
1787
1793
|
}?,
|
1788
1794
|
self_service_ai_agent_configuration: {
|
1795
|
+
self_service_pre_processing_ai_prompt_id: ::String?,
|
1796
|
+
self_service_answer_generation_ai_prompt_id: ::String?,
|
1797
|
+
self_service_ai_guardrail_id: ::String?,
|
1789
1798
|
association_configurations: Array[
|
1790
1799
|
{
|
1800
|
+
association_id: ::String?,
|
1801
|
+
association_type: ("KNOWLEDGE_BASE")?,
|
1791
1802
|
association_configuration_data: {
|
1792
1803
|
knowledge_base_association_configuration_data: {
|
1793
1804
|
content_tag_filter: {
|
1805
|
+
tag_condition: {
|
1806
|
+
key: ::String,
|
1807
|
+
value: ::String?
|
1808
|
+
}?,
|
1794
1809
|
and_conditions: Array[
|
1795
1810
|
{
|
1796
1811
|
key: ::String,
|
@@ -1810,27 +1825,17 @@ module Aws
|
|
1810
1825
|
value: ::String?
|
1811
1826
|
}?
|
1812
1827
|
},
|
1813
|
-
]
|
1814
|
-
tag_condition: {
|
1815
|
-
key: ::String,
|
1816
|
-
value: ::String?
|
1817
|
-
}?
|
1828
|
+
]?
|
1818
1829
|
}?,
|
1819
1830
|
max_results: ::Integer?,
|
1820
1831
|
override_knowledge_base_search_type: ("HYBRID" | "SEMANTIC")?
|
1821
1832
|
}?
|
1822
|
-
}
|
1823
|
-
association_id: ::String?,
|
1824
|
-
association_type: ("KNOWLEDGE_BASE")?
|
1833
|
+
}?
|
1825
1834
|
},
|
1826
|
-
]
|
1827
|
-
self_service_ai_guardrail_id: ::String?,
|
1828
|
-
self_service_answer_generation_ai_prompt_id: ::String?,
|
1829
|
-
self_service_pre_processing_ai_prompt_id: ::String?
|
1835
|
+
]?
|
1830
1836
|
}?
|
1831
1837
|
},
|
1832
|
-
?description: ::String
|
1833
|
-
visibility_status: ("SAVED" | "PUBLISHED")
|
1838
|
+
?description: ::String
|
1834
1839
|
) -> _UpdateAIAgentResponseSuccess
|
1835
1840
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAIAgentResponseSuccess
|
1836
1841
|
|
@@ -1840,67 +1845,67 @@ module Aws
|
|
1840
1845
|
end
|
1841
1846
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_ai_guardrail-instance_method
|
1842
1847
|
def update_ai_guardrail: (
|
1843
|
-
|
1848
|
+
?client_token: ::String,
|
1844
1849
|
assistant_id: ::String,
|
1850
|
+
ai_guardrail_id: ::String,
|
1851
|
+
visibility_status: ("SAVED" | "PUBLISHED"),
|
1845
1852
|
blocked_input_messaging: ::String,
|
1846
1853
|
blocked_outputs_messaging: ::String,
|
1847
|
-
?
|
1854
|
+
?description: ::String,
|
1855
|
+
?topic_policy_config: {
|
1856
|
+
topics_config: Array[
|
1857
|
+
{
|
1858
|
+
name: ::String,
|
1859
|
+
definition: ::String,
|
1860
|
+
examples: Array[::String]?,
|
1861
|
+
type: ("DENY")
|
1862
|
+
},
|
1863
|
+
]
|
1864
|
+
},
|
1848
1865
|
?content_policy_config: {
|
1849
1866
|
filters_config: Array[
|
1850
1867
|
{
|
1868
|
+
type: ("SEXUAL" | "VIOLENCE" | "HATE" | "INSULTS" | "MISCONDUCT" | "PROMPT_ATTACK"),
|
1851
1869
|
input_strength: ("NONE" | "LOW" | "MEDIUM" | "HIGH"),
|
1852
|
-
output_strength: ("NONE" | "LOW" | "MEDIUM" | "HIGH")
|
1853
|
-
type: ("SEXUAL" | "VIOLENCE" | "HATE" | "INSULTS" | "MISCONDUCT" | "PROMPT_ATTACK")
|
1870
|
+
output_strength: ("NONE" | "LOW" | "MEDIUM" | "HIGH")
|
1854
1871
|
},
|
1855
1872
|
]
|
1856
1873
|
},
|
1857
|
-
?
|
1858
|
-
|
1874
|
+
?word_policy_config: {
|
1875
|
+
words_config: Array[
|
1859
1876
|
{
|
1860
|
-
|
1861
|
-
type: ("GROUNDING" | "RELEVANCE")
|
1877
|
+
text: ::String
|
1862
1878
|
},
|
1863
|
-
]
|
1879
|
+
]?,
|
1880
|
+
managed_word_lists_config: Array[
|
1881
|
+
{
|
1882
|
+
type: ("PROFANITY")
|
1883
|
+
},
|
1884
|
+
]?
|
1864
1885
|
},
|
1865
|
-
?description: ::String,
|
1866
1886
|
?sensitive_information_policy_config: {
|
1867
1887
|
pii_entities_config: Array[
|
1868
1888
|
{
|
1869
|
-
|
1870
|
-
|
1889
|
+
type: ("ADDRESS" | "AGE" | "AWS_ACCESS_KEY" | "AWS_SECRET_KEY" | "CA_HEALTH_NUMBER" | "CA_SOCIAL_INSURANCE_NUMBER" | "CREDIT_DEBIT_CARD_CVV" | "CREDIT_DEBIT_CARD_EXPIRY" | "CREDIT_DEBIT_CARD_NUMBER" | "DRIVER_ID" | "EMAIL" | "INTERNATIONAL_BANK_ACCOUNT_NUMBER" | "IP_ADDRESS" | "LICENSE_PLATE" | "MAC_ADDRESS" | "NAME" | "PASSWORD" | "PHONE" | "PIN" | "SWIFT_CODE" | "UK_NATIONAL_HEALTH_SERVICE_NUMBER" | "UK_NATIONAL_INSURANCE_NUMBER" | "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" | "URL" | "USERNAME" | "US_BANK_ACCOUNT_NUMBER" | "US_BANK_ROUTING_NUMBER" | "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" | "US_PASSPORT_NUMBER" | "US_SOCIAL_SECURITY_NUMBER" | "VEHICLE_IDENTIFICATION_NUMBER"),
|
1890
|
+
action: ("BLOCK" | "ANONYMIZE")
|
1871
1891
|
},
|
1872
1892
|
]?,
|
1873
1893
|
regexes_config: Array[
|
1874
1894
|
{
|
1875
|
-
action: ("BLOCK" | "ANONYMIZE"),
|
1876
|
-
description: ::String?,
|
1877
1895
|
name: ::String,
|
1878
|
-
|
1896
|
+
description: ::String?,
|
1897
|
+
pattern: ::String,
|
1898
|
+
action: ("BLOCK" | "ANONYMIZE")
|
1879
1899
|
},
|
1880
1900
|
]?
|
1881
1901
|
},
|
1882
|
-
?
|
1883
|
-
|
1902
|
+
?contextual_grounding_policy_config: {
|
1903
|
+
filters_config: Array[
|
1884
1904
|
{
|
1885
|
-
|
1886
|
-
|
1887
|
-
name: ::String,
|
1888
|
-
type: ("DENY")
|
1905
|
+
type: ("GROUNDING" | "RELEVANCE"),
|
1906
|
+
threshold: ::Float
|
1889
1907
|
},
|
1890
1908
|
]
|
1891
|
-
},
|
1892
|
-
visibility_status: ("SAVED" | "PUBLISHED"),
|
1893
|
-
?word_policy_config: {
|
1894
|
-
managed_word_lists_config: Array[
|
1895
|
-
{
|
1896
|
-
type: ("PROFANITY")
|
1897
|
-
},
|
1898
|
-
]?,
|
1899
|
-
words_config: Array[
|
1900
|
-
{
|
1901
|
-
text: ::String
|
1902
|
-
},
|
1903
|
-
]?
|
1904
1909
|
}
|
1905
1910
|
) -> _UpdateAIGuardrailResponseSuccess
|
1906
1911
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAIGuardrailResponseSuccess
|
@@ -1911,16 +1916,16 @@ module Aws
|
|
1911
1916
|
end
|
1912
1917
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_ai_prompt-instance_method
|
1913
1918
|
def update_ai_prompt: (
|
1914
|
-
ai_prompt_id: ::String,
|
1915
|
-
assistant_id: ::String,
|
1916
1919
|
?client_token: ::String,
|
1917
|
-
|
1920
|
+
assistant_id: ::String,
|
1921
|
+
ai_prompt_id: ::String,
|
1922
|
+
visibility_status: ("SAVED" | "PUBLISHED"),
|
1918
1923
|
?template_configuration: {
|
1919
1924
|
text_full_ai_prompt_edit_template_configuration: {
|
1920
1925
|
text: ::String
|
1921
1926
|
}?
|
1922
1927
|
},
|
1923
|
-
|
1928
|
+
?description: ::String
|
1924
1929
|
) -> _UpdateAIPromptResponseSuccess
|
1925
1930
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAIPromptResponseSuccess
|
1926
1931
|
|
@@ -1930,8 +1935,8 @@ module Aws
|
|
1930
1935
|
end
|
1931
1936
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_assistant_ai_agent-instance_method
|
1932
1937
|
def update_assistant_ai_agent: (
|
1933
|
-
ai_agent_type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE"),
|
1934
1938
|
assistant_id: ::String,
|
1939
|
+
ai_agent_type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE"),
|
1935
1940
|
configuration: {
|
1936
1941
|
ai_agent_id: ::String
|
1937
1942
|
}
|
@@ -1944,13 +1949,13 @@ module Aws
|
|
1944
1949
|
end
|
1945
1950
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_content-instance_method
|
1946
1951
|
def update_content: (
|
1947
|
-
content_id: ::String,
|
1948
1952
|
knowledge_base_id: ::String,
|
1949
|
-
|
1950
|
-
?override_link_out_uri: ::String,
|
1951
|
-
?remove_override_link_out_uri: bool,
|
1953
|
+
content_id: ::String,
|
1952
1954
|
?revision_id: ::String,
|
1953
1955
|
?title: ::String,
|
1956
|
+
?override_link_out_uri: ::String,
|
1957
|
+
?remove_override_link_out_uri: bool,
|
1958
|
+
?metadata: Hash[::String, ::String],
|
1954
1959
|
?upload_id: ::String
|
1955
1960
|
) -> _UpdateContentResponseSuccess
|
1956
1961
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateContentResponseSuccess
|
@@ -1972,13 +1977,16 @@ module Aws
|
|
1972
1977
|
end
|
1973
1978
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_message_template-instance_method
|
1974
1979
|
def update_message_template: (
|
1980
|
+
knowledge_base_id: ::String,
|
1981
|
+
message_template_id: ::String,
|
1975
1982
|
?content: {
|
1976
1983
|
email: {
|
1984
|
+
subject: ::String?,
|
1977
1985
|
body: {
|
1978
|
-
|
1986
|
+
plain_text: {
|
1979
1987
|
content: ::String?
|
1980
1988
|
}?,
|
1981
|
-
|
1989
|
+
html: {
|
1982
1990
|
content: ::String?
|
1983
1991
|
}?
|
1984
1992
|
}?,
|
@@ -1987,8 +1995,7 @@ module Aws
|
|
1987
1995
|
name: ::String?,
|
1988
1996
|
value: ::String?
|
1989
1997
|
},
|
1990
|
-
]
|
1991
|
-
subject: ::String?
|
1998
|
+
]?
|
1992
1999
|
}?,
|
1993
2000
|
sms: {
|
1994
2001
|
body: {
|
@@ -1998,85 +2005,83 @@ module Aws
|
|
1998
2005
|
}?
|
1999
2006
|
}?
|
2000
2007
|
},
|
2008
|
+
?language: ::String,
|
2001
2009
|
?default_attributes: {
|
2010
|
+
system_attributes: {
|
2011
|
+
name: ::String?,
|
2012
|
+
customer_endpoint: {
|
2013
|
+
address: ::String?
|
2014
|
+
}?,
|
2015
|
+
system_endpoint: {
|
2016
|
+
address: ::String?
|
2017
|
+
}?
|
2018
|
+
}?,
|
2002
2019
|
agent_attributes: {
|
2003
2020
|
first_name: ::String?,
|
2004
2021
|
last_name: ::String?
|
2005
2022
|
}?,
|
2006
|
-
custom_attributes: Hash[::String, ::String]?,
|
2007
2023
|
customer_profile_attributes: {
|
2024
|
+
profile_id: ::String?,
|
2025
|
+
profile_arn: ::String?,
|
2026
|
+
first_name: ::String?,
|
2027
|
+
middle_name: ::String?,
|
2028
|
+
last_name: ::String?,
|
2008
2029
|
account_number: ::String?,
|
2030
|
+
email_address: ::String?,
|
2031
|
+
phone_number: ::String?,
|
2009
2032
|
additional_information: ::String?,
|
2033
|
+
party_type: ::String?,
|
2034
|
+
business_name: ::String?,
|
2035
|
+
birth_date: ::String?,
|
2036
|
+
gender: ::String?,
|
2037
|
+
mobile_phone_number: ::String?,
|
2038
|
+
home_phone_number: ::String?,
|
2039
|
+
business_phone_number: ::String?,
|
2040
|
+
business_email_address: ::String?,
|
2010
2041
|
address1: ::String?,
|
2011
2042
|
address2: ::String?,
|
2012
2043
|
address3: ::String?,
|
2013
2044
|
address4: ::String?,
|
2014
|
-
billing_address_1: ::String?,
|
2015
|
-
billing_address_2: ::String?,
|
2016
|
-
billing_address_3: ::String?,
|
2017
|
-
billing_address_4: ::String?,
|
2018
|
-
billing_city: ::String?,
|
2019
|
-
billing_country: ::String?,
|
2020
|
-
billing_county: ::String?,
|
2021
|
-
billing_postal_code: ::String?,
|
2022
|
-
billing_province: ::String?,
|
2023
|
-
billing_state: ::String?,
|
2024
|
-
birth_date: ::String?,
|
2025
|
-
business_email_address: ::String?,
|
2026
|
-
business_name: ::String?,
|
2027
|
-
business_phone_number: ::String?,
|
2028
2045
|
city: ::String?,
|
2029
|
-
country: ::String?,
|
2030
2046
|
county: ::String?,
|
2031
|
-
|
2032
|
-
email_address: ::String?,
|
2033
|
-
first_name: ::String?,
|
2034
|
-
gender: ::String?,
|
2035
|
-
home_phone_number: ::String?,
|
2036
|
-
last_name: ::String?,
|
2037
|
-
mailing_address_1: ::String?,
|
2038
|
-
mailing_address_2: ::String?,
|
2039
|
-
mailing_address_3: ::String?,
|
2040
|
-
mailing_address_4: ::String?,
|
2041
|
-
mailing_city: ::String?,
|
2042
|
-
mailing_country: ::String?,
|
2043
|
-
mailing_county: ::String?,
|
2044
|
-
mailing_postal_code: ::String?,
|
2045
|
-
mailing_province: ::String?,
|
2046
|
-
mailing_state: ::String?,
|
2047
|
-
middle_name: ::String?,
|
2048
|
-
mobile_phone_number: ::String?,
|
2049
|
-
party_type: ::String?,
|
2050
|
-
phone_number: ::String?,
|
2047
|
+
country: ::String?,
|
2051
2048
|
postal_code: ::String?,
|
2052
|
-
profile_arn: ::String?,
|
2053
|
-
profile_id: ::String?,
|
2054
2049
|
province: ::String?,
|
2050
|
+
state: ::String?,
|
2055
2051
|
shipping_address_1: ::String?,
|
2056
2052
|
shipping_address_2: ::String?,
|
2057
2053
|
shipping_address_3: ::String?,
|
2058
2054
|
shipping_address_4: ::String?,
|
2059
2055
|
shipping_city: ::String?,
|
2060
|
-
shipping_country: ::String?,
|
2061
2056
|
shipping_county: ::String?,
|
2057
|
+
shipping_country: ::String?,
|
2062
2058
|
shipping_postal_code: ::String?,
|
2063
2059
|
shipping_province: ::String?,
|
2064
2060
|
shipping_state: ::String?,
|
2065
|
-
|
2061
|
+
mailing_address_1: ::String?,
|
2062
|
+
mailing_address_2: ::String?,
|
2063
|
+
mailing_address_3: ::String?,
|
2064
|
+
mailing_address_4: ::String?,
|
2065
|
+
mailing_city: ::String?,
|
2066
|
+
mailing_county: ::String?,
|
2067
|
+
mailing_country: ::String?,
|
2068
|
+
mailing_postal_code: ::String?,
|
2069
|
+
mailing_province: ::String?,
|
2070
|
+
mailing_state: ::String?,
|
2071
|
+
billing_address_1: ::String?,
|
2072
|
+
billing_address_2: ::String?,
|
2073
|
+
billing_address_3: ::String?,
|
2074
|
+
billing_address_4: ::String?,
|
2075
|
+
billing_city: ::String?,
|
2076
|
+
billing_county: ::String?,
|
2077
|
+
billing_country: ::String?,
|
2078
|
+
billing_postal_code: ::String?,
|
2079
|
+
billing_province: ::String?,
|
2080
|
+
billing_state: ::String?,
|
2081
|
+
custom: Hash[::String, ::String]?
|
2066
2082
|
}?,
|
2067
|
-
|
2068
|
-
|
2069
|
-
address: ::String?
|
2070
|
-
}?,
|
2071
|
-
name: ::String?,
|
2072
|
-
system_endpoint: {
|
2073
|
-
address: ::String?
|
2074
|
-
}?
|
2075
|
-
}?
|
2076
|
-
},
|
2077
|
-
knowledge_base_id: ::String,
|
2078
|
-
?language: ::String,
|
2079
|
-
message_template_id: ::String
|
2083
|
+
custom_attributes: Hash[::String, ::String]?
|
2084
|
+
}
|
2080
2085
|
) -> _UpdateMessageTemplateResponseSuccess
|
2081
2086
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateMessageTemplateResponseSuccess
|
2082
2087
|
|
@@ -2086,14 +2091,14 @@ module Aws
|
|
2086
2091
|
end
|
2087
2092
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_message_template_metadata-instance_method
|
2088
2093
|
def update_message_template_metadata: (
|
2094
|
+
knowledge_base_id: ::String,
|
2095
|
+
message_template_id: ::String,
|
2096
|
+
?name: ::String,
|
2089
2097
|
?description: ::String,
|
2090
2098
|
?grouping_configuration: {
|
2091
2099
|
criteria: ::String?,
|
2092
2100
|
values: Array[::String]?
|
2093
|
-
}
|
2094
|
-
knowledge_base_id: ::String,
|
2095
|
-
message_template_id: ::String,
|
2096
|
-
?name: ::String
|
2101
|
+
}
|
2097
2102
|
) -> _UpdateMessageTemplateMetadataResponseSuccess
|
2098
2103
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateMessageTemplateMetadataResponseSuccess
|
2099
2104
|
|
@@ -2103,25 +2108,25 @@ module Aws
|
|
2103
2108
|
end
|
2104
2109
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_quick_response-instance_method
|
2105
2110
|
def update_quick_response: (
|
2106
|
-
|
2111
|
+
knowledge_base_id: ::String,
|
2112
|
+
quick_response_id: ::String,
|
2113
|
+
?name: ::String,
|
2107
2114
|
?content: {
|
2108
2115
|
content: ::String?
|
2109
2116
|
},
|
2110
2117
|
?content_type: ::String,
|
2111
|
-
?description: ::String,
|
2112
2118
|
?grouping_configuration: {
|
2113
2119
|
criteria: ::String?,
|
2114
2120
|
values: Array[::String]?
|
2115
2121
|
},
|
2116
|
-
?is_active: bool,
|
2117
|
-
knowledge_base_id: ::String,
|
2118
|
-
?language: ::String,
|
2119
|
-
?name: ::String,
|
2120
|
-
quick_response_id: ::String,
|
2121
|
-
?remove_description: bool,
|
2122
2122
|
?remove_grouping_configuration: bool,
|
2123
|
+
?description: ::String,
|
2124
|
+
?remove_description: bool,
|
2125
|
+
?shortcut_key: ::String,
|
2123
2126
|
?remove_shortcut_key: bool,
|
2124
|
-
?
|
2127
|
+
?is_active: bool,
|
2128
|
+
?channels: Array[::String],
|
2129
|
+
?language: ::String
|
2125
2130
|
) -> _UpdateQuickResponseResponseSuccess
|
2126
2131
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateQuickResponseResponseSuccess
|
2127
2132
|
|
@@ -2131,13 +2136,14 @@ module Aws
|
|
2131
2136
|
end
|
2132
2137
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_session-instance_method
|
2133
2138
|
def update_session: (
|
2134
|
-
?ai_agent_configuration: Hash[("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE"), {
|
2135
|
-
ai_agent_id: ::String
|
2136
|
-
}],
|
2137
2139
|
assistant_id: ::String,
|
2138
|
-
?description: ::String,
|
2139
2140
|
session_id: ::String,
|
2141
|
+
?description: ::String,
|
2140
2142
|
?tag_filter: {
|
2143
|
+
tag_condition: {
|
2144
|
+
key: ::String,
|
2145
|
+
value: ::String?
|
2146
|
+
}?,
|
2141
2147
|
and_conditions: Array[
|
2142
2148
|
{
|
2143
2149
|
key: ::String,
|
@@ -2157,24 +2163,25 @@ module Aws
|
|
2157
2163
|
value: ::String?
|
2158
2164
|
}?
|
2159
2165
|
},
|
2160
|
-
]
|
2161
|
-
|
2162
|
-
|
2163
|
-
|
2164
|
-
}
|
2165
|
-
}
|
2166
|
+
]?
|
2167
|
+
},
|
2168
|
+
?ai_agent_configuration: Hash[("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE"), {
|
2169
|
+
ai_agent_id: ::String
|
2170
|
+
}]
|
2166
2171
|
) -> _UpdateSessionResponseSuccess
|
2167
2172
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateSessionResponseSuccess
|
2168
2173
|
|
2169
2174
|
interface _UpdateSessionDataResponseSuccess
|
2170
2175
|
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateSessionDataResponse]
|
2171
|
-
def namespace: () -> ("Custom")
|
2172
2176
|
def session_arn: () -> ::String
|
2173
2177
|
def session_id: () -> ::String
|
2178
|
+
def namespace: () -> ("Custom")
|
2174
2179
|
end
|
2175
2180
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_session_data-instance_method
|
2176
2181
|
def update_session_data: (
|
2177
2182
|
assistant_id: ::String,
|
2183
|
+
session_id: ::String,
|
2184
|
+
?namespace: ("Custom"),
|
2178
2185
|
data: Array[
|
2179
2186
|
{
|
2180
2187
|
key: ::String,
|
@@ -2182,9 +2189,7 @@ module Aws
|
|
2182
2189
|
string_value: ::String?
|
2183
2190
|
}
|
2184
2191
|
},
|
2185
|
-
]
|
2186
|
-
?namespace: ("Custom"),
|
2187
|
-
session_id: ::String
|
2192
|
+
]
|
2188
2193
|
) -> _UpdateSessionDataResponseSuccess
|
2189
2194
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateSessionDataResponseSuccess
|
2190
2195
|
end
|