aws-sdk-qconnect 1.23.0 → 1.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qconnect/client.rb +2715 -89
- data/lib/aws-sdk-qconnect/client_api.rb +1161 -0
- data/lib/aws-sdk-qconnect/types.rb +3572 -260
- data/lib/aws-sdk-qconnect.rb +2 -2
- data/sig/client.rbs +866 -6
- data/sig/types.rbs +809 -13
- metadata +2 -2
data/sig/client.rbs
CHANGED
|
@@ -75,6 +75,20 @@ module Aws
|
|
|
75
75
|
| (?Hash[Symbol, untyped]) -> instance
|
|
76
76
|
|
|
77
77
|
|
|
78
|
+
interface _ActivateMessageTemplateResponseSuccess
|
|
79
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ActivateMessageTemplateResponse]
|
|
80
|
+
def message_template_arn: () -> ::String
|
|
81
|
+
def message_template_id: () -> ::String
|
|
82
|
+
def version_number: () -> ::Integer
|
|
83
|
+
end
|
|
84
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#activate_message_template-instance_method
|
|
85
|
+
def activate_message_template: (
|
|
86
|
+
knowledge_base_id: ::String,
|
|
87
|
+
message_template_id: ::String,
|
|
88
|
+
version_number: ::Integer
|
|
89
|
+
) -> _ActivateMessageTemplateResponseSuccess
|
|
90
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ActivateMessageTemplateResponseSuccess
|
|
91
|
+
|
|
78
92
|
interface _CreateAIAgentResponseSuccess
|
|
79
93
|
include ::Seahorse::Client::_ResponseSuccess[Types::CreateAIAgentResponse]
|
|
80
94
|
def ai_agent: () -> Types::AIAgentData
|
|
@@ -85,6 +99,7 @@ module Aws
|
|
|
85
99
|
?client_token: ::String,
|
|
86
100
|
configuration: {
|
|
87
101
|
answer_recommendation_ai_agent_configuration: {
|
|
102
|
+
answer_generation_ai_guardrail_id: ::String?,
|
|
88
103
|
answer_generation_ai_prompt_id: ::String?,
|
|
89
104
|
association_configurations: Array[
|
|
90
105
|
{
|
|
@@ -128,6 +143,7 @@ module Aws
|
|
|
128
143
|
query_reformulation_ai_prompt_id: ::String?
|
|
129
144
|
}?,
|
|
130
145
|
manual_search_ai_agent_configuration: {
|
|
146
|
+
answer_generation_ai_guardrail_id: ::String?,
|
|
131
147
|
answer_generation_ai_prompt_id: ::String?,
|
|
132
148
|
association_configurations: Array[
|
|
133
149
|
{
|
|
@@ -167,12 +183,55 @@ module Aws
|
|
|
167
183
|
association_type: ("KNOWLEDGE_BASE")?
|
|
168
184
|
},
|
|
169
185
|
]?
|
|
186
|
+
}?,
|
|
187
|
+
self_service_ai_agent_configuration: {
|
|
188
|
+
association_configurations: Array[
|
|
189
|
+
{
|
|
190
|
+
association_configuration_data: {
|
|
191
|
+
knowledge_base_association_configuration_data: {
|
|
192
|
+
content_tag_filter: {
|
|
193
|
+
and_conditions: Array[
|
|
194
|
+
{
|
|
195
|
+
key: ::String,
|
|
196
|
+
value: ::String?
|
|
197
|
+
},
|
|
198
|
+
]?,
|
|
199
|
+
or_conditions: Array[
|
|
200
|
+
{
|
|
201
|
+
and_conditions: Array[
|
|
202
|
+
{
|
|
203
|
+
key: ::String,
|
|
204
|
+
value: ::String?
|
|
205
|
+
},
|
|
206
|
+
]?,
|
|
207
|
+
tag_condition: {
|
|
208
|
+
key: ::String,
|
|
209
|
+
value: ::String?
|
|
210
|
+
}?
|
|
211
|
+
},
|
|
212
|
+
]?,
|
|
213
|
+
tag_condition: {
|
|
214
|
+
key: ::String,
|
|
215
|
+
value: ::String?
|
|
216
|
+
}?
|
|
217
|
+
}?,
|
|
218
|
+
max_results: ::Integer?,
|
|
219
|
+
override_knowledge_base_search_type: ("HYBRID" | "SEMANTIC")?
|
|
220
|
+
}?
|
|
221
|
+
}?,
|
|
222
|
+
association_id: ::String?,
|
|
223
|
+
association_type: ("KNOWLEDGE_BASE")?
|
|
224
|
+
},
|
|
225
|
+
]?,
|
|
226
|
+
self_service_ai_guardrail_id: ::String?,
|
|
227
|
+
self_service_answer_generation_ai_prompt_id: ::String?,
|
|
228
|
+
self_service_pre_processing_ai_prompt_id: ::String?
|
|
170
229
|
}?
|
|
171
230
|
},
|
|
172
231
|
?description: ::String,
|
|
173
232
|
name: ::String,
|
|
174
233
|
?tags: Hash[::String, ::String],
|
|
175
|
-
type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION"),
|
|
234
|
+
type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE"),
|
|
176
235
|
visibility_status: ("SAVED" | "PUBLISHED")
|
|
177
236
|
) -> _CreateAIAgentResponseSuccess
|
|
178
237
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAIAgentResponseSuccess
|
|
@@ -191,6 +250,92 @@ module Aws
|
|
|
191
250
|
) -> _CreateAIAgentVersionResponseSuccess
|
|
192
251
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAIAgentVersionResponseSuccess
|
|
193
252
|
|
|
253
|
+
interface _CreateAIGuardrailResponseSuccess
|
|
254
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateAIGuardrailResponse]
|
|
255
|
+
def ai_guardrail: () -> Types::AIGuardrailData
|
|
256
|
+
end
|
|
257
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_ai_guardrail-instance_method
|
|
258
|
+
def create_ai_guardrail: (
|
|
259
|
+
assistant_id: ::String,
|
|
260
|
+
blocked_input_messaging: ::String,
|
|
261
|
+
blocked_outputs_messaging: ::String,
|
|
262
|
+
?client_token: ::String,
|
|
263
|
+
?content_policy_config: {
|
|
264
|
+
filters_config: Array[
|
|
265
|
+
{
|
|
266
|
+
input_strength: ("NONE" | "LOW" | "MEDIUM" | "HIGH"),
|
|
267
|
+
output_strength: ("NONE" | "LOW" | "MEDIUM" | "HIGH"),
|
|
268
|
+
type: ("SEXUAL" | "VIOLENCE" | "HATE" | "INSULTS" | "MISCONDUCT" | "PROMPT_ATTACK")
|
|
269
|
+
},
|
|
270
|
+
]
|
|
271
|
+
},
|
|
272
|
+
?contextual_grounding_policy_config: {
|
|
273
|
+
filters_config: Array[
|
|
274
|
+
{
|
|
275
|
+
threshold: ::Float,
|
|
276
|
+
type: ("GROUNDING" | "RELEVANCE")
|
|
277
|
+
},
|
|
278
|
+
]
|
|
279
|
+
},
|
|
280
|
+
?description: ::String,
|
|
281
|
+
name: ::String,
|
|
282
|
+
?sensitive_information_policy_config: {
|
|
283
|
+
pii_entities_config: Array[
|
|
284
|
+
{
|
|
285
|
+
action: ("BLOCK" | "ANONYMIZE"),
|
|
286
|
+
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")
|
|
287
|
+
},
|
|
288
|
+
]?,
|
|
289
|
+
regexes_config: Array[
|
|
290
|
+
{
|
|
291
|
+
action: ("BLOCK" | "ANONYMIZE"),
|
|
292
|
+
description: ::String?,
|
|
293
|
+
name: ::String,
|
|
294
|
+
pattern: ::String
|
|
295
|
+
},
|
|
296
|
+
]?
|
|
297
|
+
},
|
|
298
|
+
?tags: Hash[::String, ::String],
|
|
299
|
+
?topic_policy_config: {
|
|
300
|
+
topics_config: Array[
|
|
301
|
+
{
|
|
302
|
+
definition: ::String,
|
|
303
|
+
examples: Array[::String]?,
|
|
304
|
+
name: ::String,
|
|
305
|
+
type: ("DENY")
|
|
306
|
+
},
|
|
307
|
+
]
|
|
308
|
+
},
|
|
309
|
+
visibility_status: ("SAVED" | "PUBLISHED"),
|
|
310
|
+
?word_policy_config: {
|
|
311
|
+
managed_word_lists_config: Array[
|
|
312
|
+
{
|
|
313
|
+
type: ("PROFANITY")
|
|
314
|
+
},
|
|
315
|
+
]?,
|
|
316
|
+
words_config: Array[
|
|
317
|
+
{
|
|
318
|
+
text: ::String
|
|
319
|
+
},
|
|
320
|
+
]?
|
|
321
|
+
}
|
|
322
|
+
) -> _CreateAIGuardrailResponseSuccess
|
|
323
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAIGuardrailResponseSuccess
|
|
324
|
+
|
|
325
|
+
interface _CreateAIGuardrailVersionResponseSuccess
|
|
326
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateAIGuardrailVersionResponse]
|
|
327
|
+
def ai_guardrail: () -> Types::AIGuardrailData
|
|
328
|
+
def version_number: () -> ::Integer
|
|
329
|
+
end
|
|
330
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_ai_guardrail_version-instance_method
|
|
331
|
+
def create_ai_guardrail_version: (
|
|
332
|
+
ai_guardrail_id: ::String,
|
|
333
|
+
assistant_id: ::String,
|
|
334
|
+
?client_token: ::String,
|
|
335
|
+
?modified_time: ::Time
|
|
336
|
+
) -> _CreateAIGuardrailVersionResponseSuccess
|
|
337
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAIGuardrailVersionResponseSuccess
|
|
338
|
+
|
|
194
339
|
interface _CreateAIPromptResponseSuccess
|
|
195
340
|
include ::Seahorse::Client::_ResponseSuccess[Types::CreateAIPromptResponse]
|
|
196
341
|
def ai_prompt: () -> Types::AIPromptData
|
|
@@ -210,7 +355,7 @@ module Aws
|
|
|
210
355
|
}?
|
|
211
356
|
},
|
|
212
357
|
template_type: ("TEXT"),
|
|
213
|
-
type: ("ANSWER_GENERATION" | "INTENT_LABELING_GENERATION" | "QUERY_REFORMULATION"),
|
|
358
|
+
type: ("ANSWER_GENERATION" | "INTENT_LABELING_GENERATION" | "QUERY_REFORMULATION" | "SELF_SERVICE_PRE_PROCESSING" | "SELF_SERVICE_ANSWER_GENERATION"),
|
|
214
359
|
visibility_status: ("SAVED" | "PUBLISHED")
|
|
215
360
|
) -> _CreateAIPromptResponseSuccess
|
|
216
361
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAIPromptResponseSuccess
|
|
@@ -372,6 +517,155 @@ module Aws
|
|
|
372
517
|
) -> _CreateKnowledgeBaseResponseSuccess
|
|
373
518
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateKnowledgeBaseResponseSuccess
|
|
374
519
|
|
|
520
|
+
interface _CreateMessageTemplateResponseSuccess
|
|
521
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateMessageTemplateResponse]
|
|
522
|
+
def message_template: () -> Types::MessageTemplateData
|
|
523
|
+
end
|
|
524
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_message_template-instance_method
|
|
525
|
+
def create_message_template: (
|
|
526
|
+
channel_subtype: ("EMAIL" | "SMS"),
|
|
527
|
+
?client_token: ::String,
|
|
528
|
+
content: {
|
|
529
|
+
email: {
|
|
530
|
+
body: {
|
|
531
|
+
html: {
|
|
532
|
+
content: ::String?
|
|
533
|
+
}?,
|
|
534
|
+
plain_text: {
|
|
535
|
+
content: ::String?
|
|
536
|
+
}?
|
|
537
|
+
}?,
|
|
538
|
+
headers: Array[
|
|
539
|
+
{
|
|
540
|
+
name: ::String?,
|
|
541
|
+
value: ::String?
|
|
542
|
+
},
|
|
543
|
+
]?,
|
|
544
|
+
subject: ::String?
|
|
545
|
+
}?,
|
|
546
|
+
sms: {
|
|
547
|
+
body: {
|
|
548
|
+
plain_text: {
|
|
549
|
+
content: ::String?
|
|
550
|
+
}?
|
|
551
|
+
}?
|
|
552
|
+
}?
|
|
553
|
+
},
|
|
554
|
+
?default_attributes: {
|
|
555
|
+
agent_attributes: {
|
|
556
|
+
first_name: ::String?,
|
|
557
|
+
last_name: ::String?
|
|
558
|
+
}?,
|
|
559
|
+
custom_attributes: Hash[::String, ::String]?,
|
|
560
|
+
customer_profile_attributes: {
|
|
561
|
+
account_number: ::String?,
|
|
562
|
+
additional_information: ::String?,
|
|
563
|
+
address1: ::String?,
|
|
564
|
+
address2: ::String?,
|
|
565
|
+
address3: ::String?,
|
|
566
|
+
address4: ::String?,
|
|
567
|
+
billing_address_1: ::String?,
|
|
568
|
+
billing_address_2: ::String?,
|
|
569
|
+
billing_address_3: ::String?,
|
|
570
|
+
billing_address_4: ::String?,
|
|
571
|
+
billing_city: ::String?,
|
|
572
|
+
billing_country: ::String?,
|
|
573
|
+
billing_county: ::String?,
|
|
574
|
+
billing_postal_code: ::String?,
|
|
575
|
+
billing_province: ::String?,
|
|
576
|
+
billing_state: ::String?,
|
|
577
|
+
birth_date: ::String?,
|
|
578
|
+
business_email_address: ::String?,
|
|
579
|
+
business_name: ::String?,
|
|
580
|
+
business_phone_number: ::String?,
|
|
581
|
+
city: ::String?,
|
|
582
|
+
country: ::String?,
|
|
583
|
+
county: ::String?,
|
|
584
|
+
custom: Hash[::String, ::String]?,
|
|
585
|
+
email_address: ::String?,
|
|
586
|
+
first_name: ::String?,
|
|
587
|
+
gender: ::String?,
|
|
588
|
+
home_phone_number: ::String?,
|
|
589
|
+
last_name: ::String?,
|
|
590
|
+
mailing_address_1: ::String?,
|
|
591
|
+
mailing_address_2: ::String?,
|
|
592
|
+
mailing_address_3: ::String?,
|
|
593
|
+
mailing_address_4: ::String?,
|
|
594
|
+
mailing_city: ::String?,
|
|
595
|
+
mailing_country: ::String?,
|
|
596
|
+
mailing_county: ::String?,
|
|
597
|
+
mailing_postal_code: ::String?,
|
|
598
|
+
mailing_province: ::String?,
|
|
599
|
+
mailing_state: ::String?,
|
|
600
|
+
middle_name: ::String?,
|
|
601
|
+
mobile_phone_number: ::String?,
|
|
602
|
+
party_type: ::String?,
|
|
603
|
+
phone_number: ::String?,
|
|
604
|
+
postal_code: ::String?,
|
|
605
|
+
profile_arn: ::String?,
|
|
606
|
+
profile_id: ::String?,
|
|
607
|
+
province: ::String?,
|
|
608
|
+
shipping_address_1: ::String?,
|
|
609
|
+
shipping_address_2: ::String?,
|
|
610
|
+
shipping_address_3: ::String?,
|
|
611
|
+
shipping_address_4: ::String?,
|
|
612
|
+
shipping_city: ::String?,
|
|
613
|
+
shipping_country: ::String?,
|
|
614
|
+
shipping_county: ::String?,
|
|
615
|
+
shipping_postal_code: ::String?,
|
|
616
|
+
shipping_province: ::String?,
|
|
617
|
+
shipping_state: ::String?,
|
|
618
|
+
state: ::String?
|
|
619
|
+
}?,
|
|
620
|
+
system_attributes: {
|
|
621
|
+
customer_endpoint: {
|
|
622
|
+
address: ::String?
|
|
623
|
+
}?,
|
|
624
|
+
name: ::String?,
|
|
625
|
+
system_endpoint: {
|
|
626
|
+
address: ::String?
|
|
627
|
+
}?
|
|
628
|
+
}?
|
|
629
|
+
},
|
|
630
|
+
?description: ::String,
|
|
631
|
+
?grouping_configuration: {
|
|
632
|
+
criteria: ::String?,
|
|
633
|
+
values: Array[::String]?
|
|
634
|
+
},
|
|
635
|
+
knowledge_base_id: ::String,
|
|
636
|
+
?language: ::String,
|
|
637
|
+
name: ::String,
|
|
638
|
+
?tags: Hash[::String, ::String]
|
|
639
|
+
) -> _CreateMessageTemplateResponseSuccess
|
|
640
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateMessageTemplateResponseSuccess
|
|
641
|
+
|
|
642
|
+
interface _CreateMessageTemplateAttachmentResponseSuccess
|
|
643
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateMessageTemplateAttachmentResponse]
|
|
644
|
+
def attachment: () -> Types::MessageTemplateAttachment
|
|
645
|
+
end
|
|
646
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_message_template_attachment-instance_method
|
|
647
|
+
def create_message_template_attachment: (
|
|
648
|
+
body: ::String,
|
|
649
|
+
?client_token: ::String,
|
|
650
|
+
content_disposition: ("ATTACHMENT"),
|
|
651
|
+
knowledge_base_id: ::String,
|
|
652
|
+
message_template_id: ::String,
|
|
653
|
+
name: ::String
|
|
654
|
+
) -> _CreateMessageTemplateAttachmentResponseSuccess
|
|
655
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateMessageTemplateAttachmentResponseSuccess
|
|
656
|
+
|
|
657
|
+
interface _CreateMessageTemplateVersionResponseSuccess
|
|
658
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateMessageTemplateVersionResponse]
|
|
659
|
+
def message_template: () -> Types::ExtendedMessageTemplateData
|
|
660
|
+
end
|
|
661
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_message_template_version-instance_method
|
|
662
|
+
def create_message_template_version: (
|
|
663
|
+
knowledge_base_id: ::String,
|
|
664
|
+
?message_template_content_sha_256: ::String,
|
|
665
|
+
message_template_id: ::String
|
|
666
|
+
) -> _CreateMessageTemplateVersionResponseSuccess
|
|
667
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateMessageTemplateVersionResponseSuccess
|
|
668
|
+
|
|
375
669
|
interface _CreateQuickResponseResponseSuccess
|
|
376
670
|
include ::Seahorse::Client::_ResponseSuccess[Types::CreateQuickResponseResponse]
|
|
377
671
|
def quick_response: () -> Types::QuickResponseData
|
|
@@ -404,7 +698,7 @@ module Aws
|
|
|
404
698
|
end
|
|
405
699
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_session-instance_method
|
|
406
700
|
def create_session: (
|
|
407
|
-
?ai_agent_configuration: Hash[("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION"), {
|
|
701
|
+
?ai_agent_configuration: Hash[("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE"), {
|
|
408
702
|
ai_agent_id: ::String
|
|
409
703
|
}],
|
|
410
704
|
assistant_id: ::String,
|
|
@@ -441,6 +735,20 @@ module Aws
|
|
|
441
735
|
) -> _CreateSessionResponseSuccess
|
|
442
736
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateSessionResponseSuccess
|
|
443
737
|
|
|
738
|
+
interface _DeactivateMessageTemplateResponseSuccess
|
|
739
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeactivateMessageTemplateResponse]
|
|
740
|
+
def message_template_arn: () -> ::String
|
|
741
|
+
def message_template_id: () -> ::String
|
|
742
|
+
def version_number: () -> ::Integer
|
|
743
|
+
end
|
|
744
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#deactivate_message_template-instance_method
|
|
745
|
+
def deactivate_message_template: (
|
|
746
|
+
knowledge_base_id: ::String,
|
|
747
|
+
message_template_id: ::String,
|
|
748
|
+
version_number: ::Integer
|
|
749
|
+
) -> _DeactivateMessageTemplateResponseSuccess
|
|
750
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeactivateMessageTemplateResponseSuccess
|
|
751
|
+
|
|
444
752
|
interface _DeleteAIAgentResponseSuccess
|
|
445
753
|
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteAIAgentResponse]
|
|
446
754
|
end
|
|
@@ -462,6 +770,27 @@ module Aws
|
|
|
462
770
|
) -> _DeleteAIAgentVersionResponseSuccess
|
|
463
771
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAIAgentVersionResponseSuccess
|
|
464
772
|
|
|
773
|
+
interface _DeleteAIGuardrailResponseSuccess
|
|
774
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteAIGuardrailResponse]
|
|
775
|
+
end
|
|
776
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_ai_guardrail-instance_method
|
|
777
|
+
def delete_ai_guardrail: (
|
|
778
|
+
ai_guardrail_id: ::String,
|
|
779
|
+
assistant_id: ::String
|
|
780
|
+
) -> _DeleteAIGuardrailResponseSuccess
|
|
781
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAIGuardrailResponseSuccess
|
|
782
|
+
|
|
783
|
+
interface _DeleteAIGuardrailVersionResponseSuccess
|
|
784
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteAIGuardrailVersionResponse]
|
|
785
|
+
end
|
|
786
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_ai_guardrail_version-instance_method
|
|
787
|
+
def delete_ai_guardrail_version: (
|
|
788
|
+
ai_guardrail_id: ::String,
|
|
789
|
+
assistant_id: ::String,
|
|
790
|
+
version_number: ::Integer
|
|
791
|
+
) -> _DeleteAIGuardrailVersionResponseSuccess
|
|
792
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAIGuardrailVersionResponseSuccess
|
|
793
|
+
|
|
465
794
|
interface _DeleteAIPromptResponseSuccess
|
|
466
795
|
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteAIPromptResponse]
|
|
467
796
|
end
|
|
@@ -542,6 +871,27 @@ module Aws
|
|
|
542
871
|
) -> _DeleteKnowledgeBaseResponseSuccess
|
|
543
872
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteKnowledgeBaseResponseSuccess
|
|
544
873
|
|
|
874
|
+
interface _DeleteMessageTemplateResponseSuccess
|
|
875
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteMessageTemplateResponse]
|
|
876
|
+
end
|
|
877
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_message_template-instance_method
|
|
878
|
+
def delete_message_template: (
|
|
879
|
+
knowledge_base_id: ::String,
|
|
880
|
+
message_template_id: ::String
|
|
881
|
+
) -> _DeleteMessageTemplateResponseSuccess
|
|
882
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteMessageTemplateResponseSuccess
|
|
883
|
+
|
|
884
|
+
interface _DeleteMessageTemplateAttachmentResponseSuccess
|
|
885
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteMessageTemplateAttachmentResponse]
|
|
886
|
+
end
|
|
887
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_message_template_attachment-instance_method
|
|
888
|
+
def delete_message_template_attachment: (
|
|
889
|
+
attachment_id: ::String,
|
|
890
|
+
knowledge_base_id: ::String,
|
|
891
|
+
message_template_id: ::String
|
|
892
|
+
) -> _DeleteMessageTemplateAttachmentResponseSuccess
|
|
893
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteMessageTemplateAttachmentResponseSuccess
|
|
894
|
+
|
|
545
895
|
interface _DeleteQuickResponseResponseSuccess
|
|
546
896
|
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteQuickResponseResponse]
|
|
547
897
|
end
|
|
@@ -564,6 +914,18 @@ module Aws
|
|
|
564
914
|
) -> _GetAIAgentResponseSuccess
|
|
565
915
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAIAgentResponseSuccess
|
|
566
916
|
|
|
917
|
+
interface _GetAIGuardrailResponseSuccess
|
|
918
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetAIGuardrailResponse]
|
|
919
|
+
def ai_guardrail: () -> Types::AIGuardrailData
|
|
920
|
+
def version_number: () -> ::Integer
|
|
921
|
+
end
|
|
922
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_ai_guardrail-instance_method
|
|
923
|
+
def get_ai_guardrail: (
|
|
924
|
+
ai_guardrail_id: ::String,
|
|
925
|
+
assistant_id: ::String
|
|
926
|
+
) -> _GetAIGuardrailResponseSuccess
|
|
927
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAIGuardrailResponseSuccess
|
|
928
|
+
|
|
567
929
|
interface _GetAIPromptResponseSuccess
|
|
568
930
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetAIPromptResponse]
|
|
569
931
|
def ai_prompt: () -> Types::AIPromptData
|
|
@@ -652,6 +1014,34 @@ module Aws
|
|
|
652
1014
|
) -> _GetKnowledgeBaseResponseSuccess
|
|
653
1015
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetKnowledgeBaseResponseSuccess
|
|
654
1016
|
|
|
1017
|
+
interface _GetMessageTemplateResponseSuccess
|
|
1018
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetMessageTemplateResponse]
|
|
1019
|
+
def message_template: () -> Types::ExtendedMessageTemplateData
|
|
1020
|
+
end
|
|
1021
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_message_template-instance_method
|
|
1022
|
+
def get_message_template: (
|
|
1023
|
+
knowledge_base_id: ::String,
|
|
1024
|
+
message_template_id: ::String
|
|
1025
|
+
) -> _GetMessageTemplateResponseSuccess
|
|
1026
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetMessageTemplateResponseSuccess
|
|
1027
|
+
|
|
1028
|
+
interface _GetNextMessageResponseSuccess
|
|
1029
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetNextMessageResponse]
|
|
1030
|
+
def conversation_session_data: () -> ::Array[Types::RuntimeSessionData]
|
|
1031
|
+
def conversation_state: () -> Types::ConversationState
|
|
1032
|
+
def next_message_token: () -> ::String
|
|
1033
|
+
def request_message_id: () -> ::String
|
|
1034
|
+
def response: () -> Types::MessageOutput
|
|
1035
|
+
def type: () -> ("TEXT")
|
|
1036
|
+
end
|
|
1037
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_next_message-instance_method
|
|
1038
|
+
def get_next_message: (
|
|
1039
|
+
assistant_id: ::String,
|
|
1040
|
+
next_message_token: ::String,
|
|
1041
|
+
session_id: ::String
|
|
1042
|
+
) -> _GetNextMessageResponseSuccess
|
|
1043
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetNextMessageResponseSuccess
|
|
1044
|
+
|
|
655
1045
|
interface _GetQuickResponseResponseSuccess
|
|
656
1046
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetQuickResponseResponse]
|
|
657
1047
|
def quick_response: () -> Types::QuickResponseData
|
|
@@ -717,6 +1107,33 @@ module Aws
|
|
|
717
1107
|
) -> _ListAIAgentsResponseSuccess
|
|
718
1108
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAIAgentsResponseSuccess
|
|
719
1109
|
|
|
1110
|
+
interface _ListAIGuardrailVersionsResponseSuccess
|
|
1111
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListAIGuardrailVersionsResponse]
|
|
1112
|
+
def ai_guardrail_version_summaries: () -> ::Array[Types::AIGuardrailVersionSummary]
|
|
1113
|
+
def next_token: () -> ::String
|
|
1114
|
+
end
|
|
1115
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_ai_guardrail_versions-instance_method
|
|
1116
|
+
def list_ai_guardrail_versions: (
|
|
1117
|
+
ai_guardrail_id: ::String,
|
|
1118
|
+
assistant_id: ::String,
|
|
1119
|
+
?max_results: ::Integer,
|
|
1120
|
+
?next_token: ::String
|
|
1121
|
+
) -> _ListAIGuardrailVersionsResponseSuccess
|
|
1122
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAIGuardrailVersionsResponseSuccess
|
|
1123
|
+
|
|
1124
|
+
interface _ListAIGuardrailsResponseSuccess
|
|
1125
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListAIGuardrailsResponse]
|
|
1126
|
+
def ai_guardrail_summaries: () -> ::Array[Types::AIGuardrailSummary]
|
|
1127
|
+
def next_token: () -> ::String
|
|
1128
|
+
end
|
|
1129
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_ai_guardrails-instance_method
|
|
1130
|
+
def list_ai_guardrails: (
|
|
1131
|
+
assistant_id: ::String,
|
|
1132
|
+
?max_results: ::Integer,
|
|
1133
|
+
?next_token: ::String
|
|
1134
|
+
) -> _ListAIGuardrailsResponseSuccess
|
|
1135
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAIGuardrailsResponseSuccess
|
|
1136
|
+
|
|
720
1137
|
interface _ListAIPromptVersionsResponseSuccess
|
|
721
1138
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListAIPromptVersionsResponse]
|
|
722
1139
|
def ai_prompt_version_summaries: () -> ::Array[Types::AIPromptVersionSummary]
|
|
@@ -823,6 +1240,47 @@ module Aws
|
|
|
823
1240
|
) -> _ListKnowledgeBasesResponseSuccess
|
|
824
1241
|
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListKnowledgeBasesResponseSuccess
|
|
825
1242
|
|
|
1243
|
+
interface _ListMessageTemplateVersionsResponseSuccess
|
|
1244
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListMessageTemplateVersionsResponse]
|
|
1245
|
+
def message_template_version_summaries: () -> ::Array[Types::MessageTemplateVersionSummary]
|
|
1246
|
+
def next_token: () -> ::String
|
|
1247
|
+
end
|
|
1248
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_message_template_versions-instance_method
|
|
1249
|
+
def list_message_template_versions: (
|
|
1250
|
+
knowledge_base_id: ::String,
|
|
1251
|
+
?max_results: ::Integer,
|
|
1252
|
+
message_template_id: ::String,
|
|
1253
|
+
?next_token: ::String
|
|
1254
|
+
) -> _ListMessageTemplateVersionsResponseSuccess
|
|
1255
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListMessageTemplateVersionsResponseSuccess
|
|
1256
|
+
|
|
1257
|
+
interface _ListMessageTemplatesResponseSuccess
|
|
1258
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListMessageTemplatesResponse]
|
|
1259
|
+
def message_template_summaries: () -> ::Array[Types::MessageTemplateSummary]
|
|
1260
|
+
def next_token: () -> ::String
|
|
1261
|
+
end
|
|
1262
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_message_templates-instance_method
|
|
1263
|
+
def list_message_templates: (
|
|
1264
|
+
knowledge_base_id: ::String,
|
|
1265
|
+
?max_results: ::Integer,
|
|
1266
|
+
?next_token: ::String
|
|
1267
|
+
) -> _ListMessageTemplatesResponseSuccess
|
|
1268
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListMessageTemplatesResponseSuccess
|
|
1269
|
+
|
|
1270
|
+
interface _ListMessagesResponseSuccess
|
|
1271
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListMessagesResponse]
|
|
1272
|
+
def messages: () -> ::Array[Types::MessageOutput]
|
|
1273
|
+
def next_token: () -> ::String
|
|
1274
|
+
end
|
|
1275
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_messages-instance_method
|
|
1276
|
+
def list_messages: (
|
|
1277
|
+
assistant_id: ::String,
|
|
1278
|
+
?max_results: ::Integer,
|
|
1279
|
+
?next_token: ::String,
|
|
1280
|
+
session_id: ::String
|
|
1281
|
+
) -> _ListMessagesResponseSuccess
|
|
1282
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListMessagesResponseSuccess
|
|
1283
|
+
|
|
826
1284
|
interface _ListQuickResponsesResponseSuccess
|
|
827
1285
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListQuickResponsesResponse]
|
|
828
1286
|
def next_token: () -> ::String
|
|
@@ -918,7 +1376,7 @@ module Aws
|
|
|
918
1376
|
end
|
|
919
1377
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#remove_assistant_ai_agent-instance_method
|
|
920
1378
|
def remove_assistant_ai_agent: (
|
|
921
|
-
ai_agent_type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION"),
|
|
1379
|
+
ai_agent_type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE"),
|
|
922
1380
|
assistant_id: ::String
|
|
923
1381
|
) -> _RemoveAssistantAIAgentResponseSuccess
|
|
924
1382
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RemoveAssistantAIAgentResponseSuccess
|
|
@@ -932,6 +1390,95 @@ module Aws
|
|
|
932
1390
|
) -> _RemoveKnowledgeBaseTemplateUriResponseSuccess
|
|
933
1391
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RemoveKnowledgeBaseTemplateUriResponseSuccess
|
|
934
1392
|
|
|
1393
|
+
interface _RenderMessageTemplateResponseSuccess
|
|
1394
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::RenderMessageTemplateResponse]
|
|
1395
|
+
def attachments: () -> ::Array[Types::MessageTemplateAttachment]
|
|
1396
|
+
def attributes_not_interpolated: () -> ::Array[::String]
|
|
1397
|
+
def content: () -> Types::MessageTemplateContentProvider
|
|
1398
|
+
end
|
|
1399
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#render_message_template-instance_method
|
|
1400
|
+
def render_message_template: (
|
|
1401
|
+
attributes: {
|
|
1402
|
+
agent_attributes: {
|
|
1403
|
+
first_name: ::String?,
|
|
1404
|
+
last_name: ::String?
|
|
1405
|
+
}?,
|
|
1406
|
+
custom_attributes: Hash[::String, ::String]?,
|
|
1407
|
+
customer_profile_attributes: {
|
|
1408
|
+
account_number: ::String?,
|
|
1409
|
+
additional_information: ::String?,
|
|
1410
|
+
address1: ::String?,
|
|
1411
|
+
address2: ::String?,
|
|
1412
|
+
address3: ::String?,
|
|
1413
|
+
address4: ::String?,
|
|
1414
|
+
billing_address_1: ::String?,
|
|
1415
|
+
billing_address_2: ::String?,
|
|
1416
|
+
billing_address_3: ::String?,
|
|
1417
|
+
billing_address_4: ::String?,
|
|
1418
|
+
billing_city: ::String?,
|
|
1419
|
+
billing_country: ::String?,
|
|
1420
|
+
billing_county: ::String?,
|
|
1421
|
+
billing_postal_code: ::String?,
|
|
1422
|
+
billing_province: ::String?,
|
|
1423
|
+
billing_state: ::String?,
|
|
1424
|
+
birth_date: ::String?,
|
|
1425
|
+
business_email_address: ::String?,
|
|
1426
|
+
business_name: ::String?,
|
|
1427
|
+
business_phone_number: ::String?,
|
|
1428
|
+
city: ::String?,
|
|
1429
|
+
country: ::String?,
|
|
1430
|
+
county: ::String?,
|
|
1431
|
+
custom: Hash[::String, ::String]?,
|
|
1432
|
+
email_address: ::String?,
|
|
1433
|
+
first_name: ::String?,
|
|
1434
|
+
gender: ::String?,
|
|
1435
|
+
home_phone_number: ::String?,
|
|
1436
|
+
last_name: ::String?,
|
|
1437
|
+
mailing_address_1: ::String?,
|
|
1438
|
+
mailing_address_2: ::String?,
|
|
1439
|
+
mailing_address_3: ::String?,
|
|
1440
|
+
mailing_address_4: ::String?,
|
|
1441
|
+
mailing_city: ::String?,
|
|
1442
|
+
mailing_country: ::String?,
|
|
1443
|
+
mailing_county: ::String?,
|
|
1444
|
+
mailing_postal_code: ::String?,
|
|
1445
|
+
mailing_province: ::String?,
|
|
1446
|
+
mailing_state: ::String?,
|
|
1447
|
+
middle_name: ::String?,
|
|
1448
|
+
mobile_phone_number: ::String?,
|
|
1449
|
+
party_type: ::String?,
|
|
1450
|
+
phone_number: ::String?,
|
|
1451
|
+
postal_code: ::String?,
|
|
1452
|
+
profile_arn: ::String?,
|
|
1453
|
+
profile_id: ::String?,
|
|
1454
|
+
province: ::String?,
|
|
1455
|
+
shipping_address_1: ::String?,
|
|
1456
|
+
shipping_address_2: ::String?,
|
|
1457
|
+
shipping_address_3: ::String?,
|
|
1458
|
+
shipping_address_4: ::String?,
|
|
1459
|
+
shipping_city: ::String?,
|
|
1460
|
+
shipping_country: ::String?,
|
|
1461
|
+
shipping_county: ::String?,
|
|
1462
|
+
shipping_postal_code: ::String?,
|
|
1463
|
+
shipping_province: ::String?,
|
|
1464
|
+
shipping_state: ::String?,
|
|
1465
|
+
state: ::String?
|
|
1466
|
+
}?,
|
|
1467
|
+
system_attributes: {
|
|
1468
|
+
customer_endpoint: {
|
|
1469
|
+
address: ::String?
|
|
1470
|
+
}?,
|
|
1471
|
+
name: ::String?,
|
|
1472
|
+
system_endpoint: {
|
|
1473
|
+
address: ::String?
|
|
1474
|
+
}?
|
|
1475
|
+
}?
|
|
1476
|
+
},
|
|
1477
|
+
knowledge_base_id: ::String,
|
|
1478
|
+
message_template_id: ::String
|
|
1479
|
+
) -> _RenderMessageTemplateResponseSuccess
|
|
1480
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RenderMessageTemplateResponseSuccess
|
|
1481
|
+
|
|
935
1482
|
interface _SearchContentResponseSuccess
|
|
936
1483
|
include ::Seahorse::Client::_ResponseSuccess[Types::SearchContentResponse]
|
|
937
1484
|
def content_summaries: () -> ::Array[Types::ContentSummary]
|
|
@@ -954,6 +1501,42 @@ module Aws
|
|
|
954
1501
|
) -> _SearchContentResponseSuccess
|
|
955
1502
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchContentResponseSuccess
|
|
956
1503
|
|
|
1504
|
+
interface _SearchMessageTemplatesResponseSuccess
|
|
1505
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SearchMessageTemplatesResponse]
|
|
1506
|
+
def next_token: () -> ::String
|
|
1507
|
+
def results: () -> ::Array[Types::MessageTemplateSearchResultData]
|
|
1508
|
+
end
|
|
1509
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#search_message_templates-instance_method
|
|
1510
|
+
def search_message_templates: (
|
|
1511
|
+
knowledge_base_id: ::String,
|
|
1512
|
+
?max_results: ::Integer,
|
|
1513
|
+
?next_token: ::String,
|
|
1514
|
+
search_expression: {
|
|
1515
|
+
filters: Array[
|
|
1516
|
+
{
|
|
1517
|
+
include_no_existence: bool?,
|
|
1518
|
+
name: ::String,
|
|
1519
|
+
operator: ("EQUALS" | "PREFIX"),
|
|
1520
|
+
values: Array[::String]?
|
|
1521
|
+
},
|
|
1522
|
+
]?,
|
|
1523
|
+
order_on_field: {
|
|
1524
|
+
name: ::String,
|
|
1525
|
+
order: ("ASC" | "DESC")?
|
|
1526
|
+
}?,
|
|
1527
|
+
queries: Array[
|
|
1528
|
+
{
|
|
1529
|
+
allow_fuzziness: bool?,
|
|
1530
|
+
name: ::String,
|
|
1531
|
+
operator: ("CONTAINS" | "CONTAINS_AND_PREFIX"),
|
|
1532
|
+
priority: ("HIGH" | "MEDIUM" | "LOW")?,
|
|
1533
|
+
values: Array[::String]
|
|
1534
|
+
},
|
|
1535
|
+
]?
|
|
1536
|
+
}
|
|
1537
|
+
) -> _SearchMessageTemplatesResponseSuccess
|
|
1538
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchMessageTemplatesResponseSuccess
|
|
1539
|
+
|
|
957
1540
|
interface _SearchQuickResponsesResponseSuccess
|
|
958
1541
|
include ::Seahorse::Client::_ResponseSuccess[Types::SearchQuickResponsesResponse]
|
|
959
1542
|
def next_token: () -> ::String
|
|
@@ -1013,6 +1596,36 @@ module Aws
|
|
|
1013
1596
|
) -> _SearchSessionsResponseSuccess
|
|
1014
1597
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchSessionsResponseSuccess
|
|
1015
1598
|
|
|
1599
|
+
interface _SendMessageResponseSuccess
|
|
1600
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SendMessageResponse]
|
|
1601
|
+
def next_message_token: () -> ::String
|
|
1602
|
+
def request_message_id: () -> ::String
|
|
1603
|
+
end
|
|
1604
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#send_message-instance_method
|
|
1605
|
+
def send_message: (
|
|
1606
|
+
assistant_id: ::String,
|
|
1607
|
+
?client_token: ::String,
|
|
1608
|
+
?conversation_context: {
|
|
1609
|
+
self_service_conversation_history: Array[
|
|
1610
|
+
{
|
|
1611
|
+
bot_response: ::String?,
|
|
1612
|
+
input_transcript: ::String?,
|
|
1613
|
+
turn_number: ::Integer
|
|
1614
|
+
},
|
|
1615
|
+
]
|
|
1616
|
+
},
|
|
1617
|
+
message: {
|
|
1618
|
+
value: {
|
|
1619
|
+
text: {
|
|
1620
|
+
value: ::String?
|
|
1621
|
+
}?
|
|
1622
|
+
}
|
|
1623
|
+
},
|
|
1624
|
+
session_id: ::String,
|
|
1625
|
+
type: ("TEXT")
|
|
1626
|
+
) -> _SendMessageResponseSuccess
|
|
1627
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendMessageResponseSuccess
|
|
1628
|
+
|
|
1016
1629
|
interface _StartContentUploadResponseSuccess
|
|
1017
1630
|
include ::Seahorse::Client::_ResponseSuccess[Types::StartContentUploadResponse]
|
|
1018
1631
|
def headers_to_include: () -> ::Hash[::String, ::String]
|
|
@@ -1081,6 +1694,7 @@ module Aws
|
|
|
1081
1694
|
?client_token: ::String,
|
|
1082
1695
|
?configuration: {
|
|
1083
1696
|
answer_recommendation_ai_agent_configuration: {
|
|
1697
|
+
answer_generation_ai_guardrail_id: ::String?,
|
|
1084
1698
|
answer_generation_ai_prompt_id: ::String?,
|
|
1085
1699
|
association_configurations: Array[
|
|
1086
1700
|
{
|
|
@@ -1124,6 +1738,7 @@ module Aws
|
|
|
1124
1738
|
query_reformulation_ai_prompt_id: ::String?
|
|
1125
1739
|
}?,
|
|
1126
1740
|
manual_search_ai_agent_configuration: {
|
|
1741
|
+
answer_generation_ai_guardrail_id: ::String?,
|
|
1127
1742
|
answer_generation_ai_prompt_id: ::String?,
|
|
1128
1743
|
association_configurations: Array[
|
|
1129
1744
|
{
|
|
@@ -1163,6 +1778,49 @@ module Aws
|
|
|
1163
1778
|
association_type: ("KNOWLEDGE_BASE")?
|
|
1164
1779
|
},
|
|
1165
1780
|
]?
|
|
1781
|
+
}?,
|
|
1782
|
+
self_service_ai_agent_configuration: {
|
|
1783
|
+
association_configurations: Array[
|
|
1784
|
+
{
|
|
1785
|
+
association_configuration_data: {
|
|
1786
|
+
knowledge_base_association_configuration_data: {
|
|
1787
|
+
content_tag_filter: {
|
|
1788
|
+
and_conditions: Array[
|
|
1789
|
+
{
|
|
1790
|
+
key: ::String,
|
|
1791
|
+
value: ::String?
|
|
1792
|
+
},
|
|
1793
|
+
]?,
|
|
1794
|
+
or_conditions: Array[
|
|
1795
|
+
{
|
|
1796
|
+
and_conditions: Array[
|
|
1797
|
+
{
|
|
1798
|
+
key: ::String,
|
|
1799
|
+
value: ::String?
|
|
1800
|
+
},
|
|
1801
|
+
]?,
|
|
1802
|
+
tag_condition: {
|
|
1803
|
+
key: ::String,
|
|
1804
|
+
value: ::String?
|
|
1805
|
+
}?
|
|
1806
|
+
},
|
|
1807
|
+
]?,
|
|
1808
|
+
tag_condition: {
|
|
1809
|
+
key: ::String,
|
|
1810
|
+
value: ::String?
|
|
1811
|
+
}?
|
|
1812
|
+
}?,
|
|
1813
|
+
max_results: ::Integer?,
|
|
1814
|
+
override_knowledge_base_search_type: ("HYBRID" | "SEMANTIC")?
|
|
1815
|
+
}?
|
|
1816
|
+
}?,
|
|
1817
|
+
association_id: ::String?,
|
|
1818
|
+
association_type: ("KNOWLEDGE_BASE")?
|
|
1819
|
+
},
|
|
1820
|
+
]?,
|
|
1821
|
+
self_service_ai_guardrail_id: ::String?,
|
|
1822
|
+
self_service_answer_generation_ai_prompt_id: ::String?,
|
|
1823
|
+
self_service_pre_processing_ai_prompt_id: ::String?
|
|
1166
1824
|
}?
|
|
1167
1825
|
},
|
|
1168
1826
|
?description: ::String,
|
|
@@ -1170,6 +1828,77 @@ module Aws
|
|
|
1170
1828
|
) -> _UpdateAIAgentResponseSuccess
|
|
1171
1829
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAIAgentResponseSuccess
|
|
1172
1830
|
|
|
1831
|
+
interface _UpdateAIGuardrailResponseSuccess
|
|
1832
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateAIGuardrailResponse]
|
|
1833
|
+
def ai_guardrail: () -> Types::AIGuardrailData
|
|
1834
|
+
end
|
|
1835
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_ai_guardrail-instance_method
|
|
1836
|
+
def update_ai_guardrail: (
|
|
1837
|
+
ai_guardrail_id: ::String,
|
|
1838
|
+
assistant_id: ::String,
|
|
1839
|
+
blocked_input_messaging: ::String,
|
|
1840
|
+
blocked_outputs_messaging: ::String,
|
|
1841
|
+
?client_token: ::String,
|
|
1842
|
+
?content_policy_config: {
|
|
1843
|
+
filters_config: Array[
|
|
1844
|
+
{
|
|
1845
|
+
input_strength: ("NONE" | "LOW" | "MEDIUM" | "HIGH"),
|
|
1846
|
+
output_strength: ("NONE" | "LOW" | "MEDIUM" | "HIGH"),
|
|
1847
|
+
type: ("SEXUAL" | "VIOLENCE" | "HATE" | "INSULTS" | "MISCONDUCT" | "PROMPT_ATTACK")
|
|
1848
|
+
},
|
|
1849
|
+
]
|
|
1850
|
+
},
|
|
1851
|
+
?contextual_grounding_policy_config: {
|
|
1852
|
+
filters_config: Array[
|
|
1853
|
+
{
|
|
1854
|
+
threshold: ::Float,
|
|
1855
|
+
type: ("GROUNDING" | "RELEVANCE")
|
|
1856
|
+
},
|
|
1857
|
+
]
|
|
1858
|
+
},
|
|
1859
|
+
?description: ::String,
|
|
1860
|
+
?sensitive_information_policy_config: {
|
|
1861
|
+
pii_entities_config: Array[
|
|
1862
|
+
{
|
|
1863
|
+
action: ("BLOCK" | "ANONYMIZE"),
|
|
1864
|
+
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")
|
|
1865
|
+
},
|
|
1866
|
+
]?,
|
|
1867
|
+
regexes_config: Array[
|
|
1868
|
+
{
|
|
1869
|
+
action: ("BLOCK" | "ANONYMIZE"),
|
|
1870
|
+
description: ::String?,
|
|
1871
|
+
name: ::String,
|
|
1872
|
+
pattern: ::String
|
|
1873
|
+
},
|
|
1874
|
+
]?
|
|
1875
|
+
},
|
|
1876
|
+
?topic_policy_config: {
|
|
1877
|
+
topics_config: Array[
|
|
1878
|
+
{
|
|
1879
|
+
definition: ::String,
|
|
1880
|
+
examples: Array[::String]?,
|
|
1881
|
+
name: ::String,
|
|
1882
|
+
type: ("DENY")
|
|
1883
|
+
},
|
|
1884
|
+
]
|
|
1885
|
+
},
|
|
1886
|
+
visibility_status: ("SAVED" | "PUBLISHED"),
|
|
1887
|
+
?word_policy_config: {
|
|
1888
|
+
managed_word_lists_config: Array[
|
|
1889
|
+
{
|
|
1890
|
+
type: ("PROFANITY")
|
|
1891
|
+
},
|
|
1892
|
+
]?,
|
|
1893
|
+
words_config: Array[
|
|
1894
|
+
{
|
|
1895
|
+
text: ::String
|
|
1896
|
+
},
|
|
1897
|
+
]?
|
|
1898
|
+
}
|
|
1899
|
+
) -> _UpdateAIGuardrailResponseSuccess
|
|
1900
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAIGuardrailResponseSuccess
|
|
1901
|
+
|
|
1173
1902
|
interface _UpdateAIPromptResponseSuccess
|
|
1174
1903
|
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateAIPromptResponse]
|
|
1175
1904
|
def ai_prompt: () -> Types::AIPromptData
|
|
@@ -1195,7 +1924,7 @@ module Aws
|
|
|
1195
1924
|
end
|
|
1196
1925
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_assistant_ai_agent-instance_method
|
|
1197
1926
|
def update_assistant_ai_agent: (
|
|
1198
|
-
ai_agent_type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION"),
|
|
1927
|
+
ai_agent_type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE"),
|
|
1199
1928
|
assistant_id: ::String,
|
|
1200
1929
|
configuration: {
|
|
1201
1930
|
ai_agent_id: ::String
|
|
@@ -1231,6 +1960,137 @@ module Aws
|
|
|
1231
1960
|
) -> _UpdateKnowledgeBaseTemplateUriResponseSuccess
|
|
1232
1961
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateKnowledgeBaseTemplateUriResponseSuccess
|
|
1233
1962
|
|
|
1963
|
+
interface _UpdateMessageTemplateResponseSuccess
|
|
1964
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateMessageTemplateResponse]
|
|
1965
|
+
def message_template: () -> Types::MessageTemplateData
|
|
1966
|
+
end
|
|
1967
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_message_template-instance_method
|
|
1968
|
+
def update_message_template: (
|
|
1969
|
+
?content: {
|
|
1970
|
+
email: {
|
|
1971
|
+
body: {
|
|
1972
|
+
html: {
|
|
1973
|
+
content: ::String?
|
|
1974
|
+
}?,
|
|
1975
|
+
plain_text: {
|
|
1976
|
+
content: ::String?
|
|
1977
|
+
}?
|
|
1978
|
+
}?,
|
|
1979
|
+
headers: Array[
|
|
1980
|
+
{
|
|
1981
|
+
name: ::String?,
|
|
1982
|
+
value: ::String?
|
|
1983
|
+
},
|
|
1984
|
+
]?,
|
|
1985
|
+
subject: ::String?
|
|
1986
|
+
}?,
|
|
1987
|
+
sms: {
|
|
1988
|
+
body: {
|
|
1989
|
+
plain_text: {
|
|
1990
|
+
content: ::String?
|
|
1991
|
+
}?
|
|
1992
|
+
}?
|
|
1993
|
+
}?
|
|
1994
|
+
},
|
|
1995
|
+
?default_attributes: {
|
|
1996
|
+
agent_attributes: {
|
|
1997
|
+
first_name: ::String?,
|
|
1998
|
+
last_name: ::String?
|
|
1999
|
+
}?,
|
|
2000
|
+
custom_attributes: Hash[::String, ::String]?,
|
|
2001
|
+
customer_profile_attributes: {
|
|
2002
|
+
account_number: ::String?,
|
|
2003
|
+
additional_information: ::String?,
|
|
2004
|
+
address1: ::String?,
|
|
2005
|
+
address2: ::String?,
|
|
2006
|
+
address3: ::String?,
|
|
2007
|
+
address4: ::String?,
|
|
2008
|
+
billing_address_1: ::String?,
|
|
2009
|
+
billing_address_2: ::String?,
|
|
2010
|
+
billing_address_3: ::String?,
|
|
2011
|
+
billing_address_4: ::String?,
|
|
2012
|
+
billing_city: ::String?,
|
|
2013
|
+
billing_country: ::String?,
|
|
2014
|
+
billing_county: ::String?,
|
|
2015
|
+
billing_postal_code: ::String?,
|
|
2016
|
+
billing_province: ::String?,
|
|
2017
|
+
billing_state: ::String?,
|
|
2018
|
+
birth_date: ::String?,
|
|
2019
|
+
business_email_address: ::String?,
|
|
2020
|
+
business_name: ::String?,
|
|
2021
|
+
business_phone_number: ::String?,
|
|
2022
|
+
city: ::String?,
|
|
2023
|
+
country: ::String?,
|
|
2024
|
+
county: ::String?,
|
|
2025
|
+
custom: Hash[::String, ::String]?,
|
|
2026
|
+
email_address: ::String?,
|
|
2027
|
+
first_name: ::String?,
|
|
2028
|
+
gender: ::String?,
|
|
2029
|
+
home_phone_number: ::String?,
|
|
2030
|
+
last_name: ::String?,
|
|
2031
|
+
mailing_address_1: ::String?,
|
|
2032
|
+
mailing_address_2: ::String?,
|
|
2033
|
+
mailing_address_3: ::String?,
|
|
2034
|
+
mailing_address_4: ::String?,
|
|
2035
|
+
mailing_city: ::String?,
|
|
2036
|
+
mailing_country: ::String?,
|
|
2037
|
+
mailing_county: ::String?,
|
|
2038
|
+
mailing_postal_code: ::String?,
|
|
2039
|
+
mailing_province: ::String?,
|
|
2040
|
+
mailing_state: ::String?,
|
|
2041
|
+
middle_name: ::String?,
|
|
2042
|
+
mobile_phone_number: ::String?,
|
|
2043
|
+
party_type: ::String?,
|
|
2044
|
+
phone_number: ::String?,
|
|
2045
|
+
postal_code: ::String?,
|
|
2046
|
+
profile_arn: ::String?,
|
|
2047
|
+
profile_id: ::String?,
|
|
2048
|
+
province: ::String?,
|
|
2049
|
+
shipping_address_1: ::String?,
|
|
2050
|
+
shipping_address_2: ::String?,
|
|
2051
|
+
shipping_address_3: ::String?,
|
|
2052
|
+
shipping_address_4: ::String?,
|
|
2053
|
+
shipping_city: ::String?,
|
|
2054
|
+
shipping_country: ::String?,
|
|
2055
|
+
shipping_county: ::String?,
|
|
2056
|
+
shipping_postal_code: ::String?,
|
|
2057
|
+
shipping_province: ::String?,
|
|
2058
|
+
shipping_state: ::String?,
|
|
2059
|
+
state: ::String?
|
|
2060
|
+
}?,
|
|
2061
|
+
system_attributes: {
|
|
2062
|
+
customer_endpoint: {
|
|
2063
|
+
address: ::String?
|
|
2064
|
+
}?,
|
|
2065
|
+
name: ::String?,
|
|
2066
|
+
system_endpoint: {
|
|
2067
|
+
address: ::String?
|
|
2068
|
+
}?
|
|
2069
|
+
}?
|
|
2070
|
+
},
|
|
2071
|
+
knowledge_base_id: ::String,
|
|
2072
|
+
?language: ::String,
|
|
2073
|
+
message_template_id: ::String
|
|
2074
|
+
) -> _UpdateMessageTemplateResponseSuccess
|
|
2075
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateMessageTemplateResponseSuccess
|
|
2076
|
+
|
|
2077
|
+
interface _UpdateMessageTemplateMetadataResponseSuccess
|
|
2078
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateMessageTemplateMetadataResponse]
|
|
2079
|
+
def message_template: () -> Types::MessageTemplateData
|
|
2080
|
+
end
|
|
2081
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_message_template_metadata-instance_method
|
|
2082
|
+
def update_message_template_metadata: (
|
|
2083
|
+
?description: ::String,
|
|
2084
|
+
?grouping_configuration: {
|
|
2085
|
+
criteria: ::String?,
|
|
2086
|
+
values: Array[::String]?
|
|
2087
|
+
},
|
|
2088
|
+
knowledge_base_id: ::String,
|
|
2089
|
+
message_template_id: ::String,
|
|
2090
|
+
?name: ::String
|
|
2091
|
+
) -> _UpdateMessageTemplateMetadataResponseSuccess
|
|
2092
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateMessageTemplateMetadataResponseSuccess
|
|
2093
|
+
|
|
1234
2094
|
interface _UpdateQuickResponseResponseSuccess
|
|
1235
2095
|
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateQuickResponseResponse]
|
|
1236
2096
|
def quick_response: () -> Types::QuickResponseData
|
|
@@ -1265,7 +2125,7 @@ module Aws
|
|
|
1265
2125
|
end
|
|
1266
2126
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_session-instance_method
|
|
1267
2127
|
def update_session: (
|
|
1268
|
-
?ai_agent_configuration: Hash[("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION"), {
|
|
2128
|
+
?ai_agent_configuration: Hash[("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE"), {
|
|
1269
2129
|
ai_agent_id: ::String
|
|
1270
2130
|
}],
|
|
1271
2131
|
assistant_id: ::String,
|