aws-sdk-qconnect 1.42.0 → 1.44.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 +1234 -41
- data/lib/aws-sdk-qconnect/client_api.rb +592 -6
- data/lib/aws-sdk-qconnect/errors.rb +16 -0
- data/lib/aws-sdk-qconnect/types.rb +2118 -86
- data/lib/aws-sdk-qconnect.rb +1 -1
- data/sig/client.rbs +459 -25
- data/sig/errors.rbs +3 -0
- data/sig/types.rbs +604 -27
- metadata +3 -3
data/sig/client.rbs
CHANGED
|
@@ -101,7 +101,7 @@ module Aws
|
|
|
101
101
|
?client_token: ::String,
|
|
102
102
|
assistant_id: ::String,
|
|
103
103
|
name: ::String,
|
|
104
|
-
type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE" | "EMAIL_RESPONSE" | "EMAIL_OVERVIEW" | "EMAIL_GENERATIVE_ANSWER"),
|
|
104
|
+
type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE" | "EMAIL_RESPONSE" | "EMAIL_OVERVIEW" | "EMAIL_GENERATIVE_ANSWER" | "ORCHESTRATION" | "NOTE_TAKING" | "CASE_SUMMARIZATION"),
|
|
105
105
|
configuration: {
|
|
106
106
|
manual_search_ai_agent_configuration: {
|
|
107
107
|
answer_generation_ai_prompt_id: ::String?,
|
|
@@ -189,7 +189,8 @@ module Aws
|
|
|
189
189
|
}?
|
|
190
190
|
},
|
|
191
191
|
]?,
|
|
192
|
-
locale: ::String
|
|
192
|
+
locale: ::String?,
|
|
193
|
+
suggested_messages: Array[::String]?
|
|
193
194
|
}?,
|
|
194
195
|
self_service_ai_agent_configuration: {
|
|
195
196
|
self_service_pre_processing_ai_prompt_id: ::String?,
|
|
@@ -323,6 +324,66 @@ module Aws
|
|
|
323
324
|
}?
|
|
324
325
|
},
|
|
325
326
|
]?
|
|
327
|
+
}?,
|
|
328
|
+
orchestration_ai_agent_configuration: {
|
|
329
|
+
orchestration_ai_prompt_id: ::String,
|
|
330
|
+
orchestration_ai_guardrail_id: ::String?,
|
|
331
|
+
tool_configurations: Array[
|
|
332
|
+
{
|
|
333
|
+
tool_name: ::String,
|
|
334
|
+
tool_type: ("MODEL_CONTEXT_PROTOCOL" | "RETURN_TO_CONTROL" | "CONSTANT"),
|
|
335
|
+
title: ::String?,
|
|
336
|
+
tool_id: ::String?,
|
|
337
|
+
description: ::String?,
|
|
338
|
+
instruction: {
|
|
339
|
+
instruction: ::String?,
|
|
340
|
+
examples: Array[::String]?
|
|
341
|
+
}?,
|
|
342
|
+
override_input_values: Array[
|
|
343
|
+
{
|
|
344
|
+
json_path: ::String,
|
|
345
|
+
value: {
|
|
346
|
+
constant: {
|
|
347
|
+
type: ("STRING" | "NUMBER" | "JSON_STRING"),
|
|
348
|
+
value: ::String
|
|
349
|
+
}?
|
|
350
|
+
}
|
|
351
|
+
},
|
|
352
|
+
]?,
|
|
353
|
+
output_filters: Array[
|
|
354
|
+
{
|
|
355
|
+
json_path: ::String,
|
|
356
|
+
output_configuration: {
|
|
357
|
+
output_variable_name_override: ::String?,
|
|
358
|
+
session_data_namespace: ::String?
|
|
359
|
+
}?
|
|
360
|
+
},
|
|
361
|
+
]?,
|
|
362
|
+
input_schema: {
|
|
363
|
+
}?,
|
|
364
|
+
output_schema: {
|
|
365
|
+
}?,
|
|
366
|
+
annotations: {
|
|
367
|
+
title: ::String?,
|
|
368
|
+
destructive_hint: bool?
|
|
369
|
+
}?,
|
|
370
|
+
user_interaction_configuration: {
|
|
371
|
+
is_user_confirmation_required: bool?
|
|
372
|
+
}?
|
|
373
|
+
},
|
|
374
|
+
]?,
|
|
375
|
+
connect_instance_arn: ::String?,
|
|
376
|
+
locale: ::String?
|
|
377
|
+
}?,
|
|
378
|
+
note_taking_ai_agent_configuration: {
|
|
379
|
+
note_taking_ai_prompt_id: ::String?,
|
|
380
|
+
note_taking_ai_guardrail_id: ::String?,
|
|
381
|
+
locale: ::String?
|
|
382
|
+
}?,
|
|
383
|
+
case_summarization_ai_agent_configuration: {
|
|
384
|
+
case_summarization_ai_prompt_id: ::String?,
|
|
385
|
+
case_summarization_ai_guardrail_id: ::String?,
|
|
386
|
+
locale: ::String?
|
|
326
387
|
}?
|
|
327
388
|
},
|
|
328
389
|
visibility_status: ("SAVED" | "PUBLISHED"),
|
|
@@ -440,7 +501,7 @@ module Aws
|
|
|
440
501
|
?client_token: ::String,
|
|
441
502
|
assistant_id: ::String,
|
|
442
503
|
name: ::String,
|
|
443
|
-
type: ("ANSWER_GENERATION" | "INTENT_LABELING_GENERATION" | "QUERY_REFORMULATION" | "SELF_SERVICE_PRE_PROCESSING" | "SELF_SERVICE_ANSWER_GENERATION" | "EMAIL_RESPONSE" | "EMAIL_OVERVIEW" | "EMAIL_GENERATIVE_ANSWER" | "EMAIL_QUERY_REFORMULATION"),
|
|
504
|
+
type: ("ANSWER_GENERATION" | "INTENT_LABELING_GENERATION" | "QUERY_REFORMULATION" | "SELF_SERVICE_PRE_PROCESSING" | "SELF_SERVICE_ANSWER_GENERATION" | "EMAIL_RESPONSE" | "EMAIL_OVERVIEW" | "EMAIL_GENERATIVE_ANSWER" | "EMAIL_QUERY_REFORMULATION" | "ORCHESTRATION" | "NOTE_TAKING" | "CASE_SUMMARIZATION"),
|
|
444
505
|
template_configuration: {
|
|
445
506
|
text_full_ai_prompt_edit_template_configuration: {
|
|
446
507
|
text: ::String
|
|
@@ -451,7 +512,15 @@ module Aws
|
|
|
451
512
|
model_id: ::String,
|
|
452
513
|
api_format: ("ANTHROPIC_CLAUDE_MESSAGES" | "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS" | "MESSAGES" | "TEXT_COMPLETIONS"),
|
|
453
514
|
?tags: Hash[::String, ::String],
|
|
454
|
-
?description: ::String
|
|
515
|
+
?description: ::String,
|
|
516
|
+
?inference_configuration: {
|
|
517
|
+
text_ai_prompt_inference_configuration: {
|
|
518
|
+
temperature: ::Float?,
|
|
519
|
+
top_p: ::Float?,
|
|
520
|
+
top_k: ::Integer?,
|
|
521
|
+
max_tokens_to_sample: ::Integer?
|
|
522
|
+
}?
|
|
523
|
+
}
|
|
455
524
|
) -> _CreateAIPromptResponseSuccess
|
|
456
525
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAIPromptResponseSuccess
|
|
457
526
|
|
|
@@ -493,9 +562,13 @@ module Aws
|
|
|
493
562
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_assistant_association-instance_method
|
|
494
563
|
def create_assistant_association: (
|
|
495
564
|
assistant_id: ::String,
|
|
496
|
-
association_type: ("KNOWLEDGE_BASE"),
|
|
565
|
+
association_type: ("KNOWLEDGE_BASE" | "EXTERNAL_BEDROCK_KNOWLEDGE_BASE"),
|
|
497
566
|
association: {
|
|
498
|
-
knowledge_base_id: ::String
|
|
567
|
+
knowledge_base_id: ::String?,
|
|
568
|
+
external_bedrock_knowledge_base_config: {
|
|
569
|
+
bedrock_knowledge_base_arn: ::String,
|
|
570
|
+
access_role_arn: ::String
|
|
571
|
+
}?
|
|
499
572
|
},
|
|
500
573
|
?client_token: ::String,
|
|
501
574
|
?tags: Hash[::String, ::String]
|
|
@@ -619,8 +692,8 @@ module Aws
|
|
|
619
692
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_message_template-instance_method
|
|
620
693
|
def create_message_template: (
|
|
621
694
|
knowledge_base_id: ::String,
|
|
622
|
-
name: ::String,
|
|
623
|
-
content: {
|
|
695
|
+
?name: ::String,
|
|
696
|
+
?content: {
|
|
624
697
|
email: {
|
|
625
698
|
subject: ::String?,
|
|
626
699
|
body: {
|
|
@@ -644,11 +717,81 @@ module Aws
|
|
|
644
717
|
content: ::String?
|
|
645
718
|
}?
|
|
646
719
|
}?
|
|
720
|
+
}?,
|
|
721
|
+
whats_app: {
|
|
722
|
+
data: ::String?
|
|
723
|
+
}?,
|
|
724
|
+
push: {
|
|
725
|
+
adm: {
|
|
726
|
+
title: ::String?,
|
|
727
|
+
body: {
|
|
728
|
+
content: ::String?
|
|
729
|
+
}?,
|
|
730
|
+
action: ("OPEN_APP" | "DEEP_LINK" | "URL")?,
|
|
731
|
+
sound: ::String?,
|
|
732
|
+
url: ::String?,
|
|
733
|
+
image_url: ::String?,
|
|
734
|
+
image_icon_url: ::String?,
|
|
735
|
+
small_image_icon_url: ::String?,
|
|
736
|
+
raw_content: {
|
|
737
|
+
content: ::String?
|
|
738
|
+
}?
|
|
739
|
+
}?,
|
|
740
|
+
apns: {
|
|
741
|
+
title: ::String?,
|
|
742
|
+
body: {
|
|
743
|
+
content: ::String?
|
|
744
|
+
}?,
|
|
745
|
+
action: ("OPEN_APP" | "DEEP_LINK" | "URL")?,
|
|
746
|
+
sound: ::String?,
|
|
747
|
+
url: ::String?,
|
|
748
|
+
media_url: ::String?,
|
|
749
|
+
raw_content: {
|
|
750
|
+
content: ::String?
|
|
751
|
+
}?
|
|
752
|
+
}?,
|
|
753
|
+
fcm: {
|
|
754
|
+
title: ::String?,
|
|
755
|
+
body: {
|
|
756
|
+
content: ::String?
|
|
757
|
+
}?,
|
|
758
|
+
action: ("OPEN_APP" | "DEEP_LINK" | "URL")?,
|
|
759
|
+
sound: ::String?,
|
|
760
|
+
url: ::String?,
|
|
761
|
+
image_url: ::String?,
|
|
762
|
+
image_icon_url: ::String?,
|
|
763
|
+
small_image_icon_url: ::String?,
|
|
764
|
+
raw_content: {
|
|
765
|
+
content: ::String?
|
|
766
|
+
}?
|
|
767
|
+
}?,
|
|
768
|
+
baidu: {
|
|
769
|
+
title: ::String?,
|
|
770
|
+
body: {
|
|
771
|
+
content: ::String?
|
|
772
|
+
}?,
|
|
773
|
+
action: ("OPEN_APP" | "DEEP_LINK" | "URL")?,
|
|
774
|
+
sound: ::String?,
|
|
775
|
+
url: ::String?,
|
|
776
|
+
image_url: ::String?,
|
|
777
|
+
image_icon_url: ::String?,
|
|
778
|
+
small_image_icon_url: ::String?,
|
|
779
|
+
raw_content: {
|
|
780
|
+
content: ::String?
|
|
781
|
+
}?
|
|
782
|
+
}?
|
|
647
783
|
}?
|
|
648
784
|
},
|
|
649
785
|
?description: ::String,
|
|
650
|
-
channel_subtype: ("EMAIL" | "SMS"),
|
|
786
|
+
channel_subtype: ("EMAIL" | "SMS" | "WHATSAPP" | "PUSH"),
|
|
651
787
|
?language: ::String,
|
|
788
|
+
?source_configuration: {
|
|
789
|
+
whats_app: {
|
|
790
|
+
business_account_id: ::String,
|
|
791
|
+
template_id: ::String,
|
|
792
|
+
components: Array[::String]?
|
|
793
|
+
}?
|
|
794
|
+
},
|
|
652
795
|
?default_attributes: {
|
|
653
796
|
system_attributes: {
|
|
654
797
|
name: ::String?,
|
|
@@ -824,10 +967,17 @@ module Aws
|
|
|
824
967
|
},
|
|
825
968
|
]?
|
|
826
969
|
},
|
|
827
|
-
?ai_agent_configuration: Hash[("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE" | "EMAIL_RESPONSE" | "EMAIL_OVERVIEW" | "EMAIL_GENERATIVE_ANSWER"), {
|
|
970
|
+
?ai_agent_configuration: Hash[("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE" | "EMAIL_RESPONSE" | "EMAIL_OVERVIEW" | "EMAIL_GENERATIVE_ANSWER" | "ORCHESTRATION" | "NOTE_TAKING" | "CASE_SUMMARIZATION"), {
|
|
828
971
|
ai_agent_id: ::String
|
|
829
972
|
}],
|
|
830
|
-
?contact_arn: ::String
|
|
973
|
+
?contact_arn: ::String,
|
|
974
|
+
?orchestrator_configuration_list: Array[
|
|
975
|
+
{
|
|
976
|
+
ai_agent_id: ::String?,
|
|
977
|
+
orchestrator_use_case: ::String
|
|
978
|
+
},
|
|
979
|
+
],
|
|
980
|
+
?remove_orchestrator_configuration_list: bool
|
|
831
981
|
) -> _CreateSessionResponseSuccess
|
|
832
982
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateSessionResponseSuccess
|
|
833
983
|
|
|
@@ -1129,6 +1279,7 @@ module Aws
|
|
|
1129
1279
|
def conversation_state: () -> Types::ConversationState
|
|
1130
1280
|
def next_message_token: () -> ::String
|
|
1131
1281
|
def conversation_session_data: () -> ::Array[Types::RuntimeSessionData]
|
|
1282
|
+
def chunked_response_terminated: () -> bool
|
|
1132
1283
|
end
|
|
1133
1284
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_next_message-instance_method
|
|
1134
1285
|
def get_next_message: (
|
|
@@ -1160,7 +1311,8 @@ module Aws
|
|
|
1160
1311
|
session_id: ::String,
|
|
1161
1312
|
?max_results: ::Integer,
|
|
1162
1313
|
?wait_time_seconds: ::Integer,
|
|
1163
|
-
?next_chunk_token: ::String
|
|
1314
|
+
?next_chunk_token: ::String,
|
|
1315
|
+
?recommendation_type: ("KNOWLEDGE_CONTENT" | "GENERATIVE_RESPONSE" | "GENERATIVE_ANSWER" | "DETECTED_INTENT" | "GENERATIVE_ANSWER_CHUNK" | "BLOCKED_GENERATIVE_ANSWER_CHUNK" | "INTENT_ANSWER_CHUNK" | "BLOCKED_INTENT_ANSWER_CHUNK" | "EMAIL_RESPONSE_CHUNK" | "EMAIL_OVERVIEW_CHUNK" | "EMAIL_GENERATIVE_ANSWER_CHUNK" | "CASE_SUMMARIZATION_CHUNK" | "BLOCKED_CASE_SUMMARIZATION_CHUNK" | "SUGGESTED_MESSAGE" | "NOTES_CHUNK" | "BLOCKED_NOTES_CHUNK")
|
|
1164
1316
|
) -> _GetRecommendationsResponseSuccess
|
|
1165
1317
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetRecommendationsResponseSuccess
|
|
1166
1318
|
|
|
@@ -1374,7 +1526,8 @@ module Aws
|
|
|
1374
1526
|
assistant_id: ::String,
|
|
1375
1527
|
session_id: ::String,
|
|
1376
1528
|
?next_token: ::String,
|
|
1377
|
-
?max_results: ::Integer
|
|
1529
|
+
?max_results: ::Integer,
|
|
1530
|
+
?filter: ("ALL" | "TEXT_ONLY")
|
|
1378
1531
|
) -> _ListMessagesResponseSuccess
|
|
1379
1532
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListMessagesResponseSuccess
|
|
1380
1533
|
|
|
@@ -1391,6 +1544,20 @@ module Aws
|
|
|
1391
1544
|
) -> _ListQuickResponsesResponseSuccess
|
|
1392
1545
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListQuickResponsesResponseSuccess
|
|
1393
1546
|
|
|
1547
|
+
interface _ListSpansResponseSuccess
|
|
1548
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListSpansResponse]
|
|
1549
|
+
def spans: () -> ::Array[Types::Span]
|
|
1550
|
+
def next_token: () -> ::String
|
|
1551
|
+
end
|
|
1552
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_spans-instance_method
|
|
1553
|
+
def list_spans: (
|
|
1554
|
+
assistant_id: ::String,
|
|
1555
|
+
session_id: ::String,
|
|
1556
|
+
?next_token: ::String,
|
|
1557
|
+
?max_results: ::Integer
|
|
1558
|
+
) -> _ListSpansResponseSuccess
|
|
1559
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListSpansResponseSuccess
|
|
1560
|
+
|
|
1394
1561
|
interface _ListTagsForResourceResponseSuccess
|
|
1395
1562
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
|
|
1396
1563
|
def tags: () -> ::Hash[::String, ::String]
|
|
@@ -1462,6 +1629,9 @@ module Aws
|
|
|
1462
1629
|
}?,
|
|
1463
1630
|
intent_input_data: {
|
|
1464
1631
|
intent_id: ::String
|
|
1632
|
+
}?,
|
|
1633
|
+
case_summarization_input_data: {
|
|
1634
|
+
case_arn: ::String
|
|
1465
1635
|
}?
|
|
1466
1636
|
},
|
|
1467
1637
|
?override_knowledge_base_search_type: ("HYBRID" | "SEMANTIC")
|
|
@@ -1474,7 +1644,8 @@ module Aws
|
|
|
1474
1644
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#remove_assistant_ai_agent-instance_method
|
|
1475
1645
|
def remove_assistant_ai_agent: (
|
|
1476
1646
|
assistant_id: ::String,
|
|
1477
|
-
ai_agent_type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE" | "EMAIL_RESPONSE" | "EMAIL_OVERVIEW" | "EMAIL_GENERATIVE_ANSWER")
|
|
1647
|
+
ai_agent_type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE" | "EMAIL_RESPONSE" | "EMAIL_OVERVIEW" | "EMAIL_GENERATIVE_ANSWER" | "ORCHESTRATION" | "NOTE_TAKING" | "CASE_SUMMARIZATION"),
|
|
1648
|
+
?orchestrator_use_case: ::String
|
|
1478
1649
|
) -> _RemoveAssistantAIAgentResponseSuccess
|
|
1479
1650
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RemoveAssistantAIAgentResponseSuccess
|
|
1480
1651
|
|
|
@@ -1490,6 +1661,7 @@ module Aws
|
|
|
1490
1661
|
interface _RenderMessageTemplateResponseSuccess
|
|
1491
1662
|
include ::Seahorse::Client::_ResponseSuccess[Types::RenderMessageTemplateResponse]
|
|
1492
1663
|
def content: () -> Types::MessageTemplateContentProvider
|
|
1664
|
+
def source_configuration_summary: () -> Types::MessageTemplateSourceConfigurationSummary
|
|
1493
1665
|
def attributes_not_interpolated: () -> ::Array[::String]
|
|
1494
1666
|
def attachments: () -> ::Array[Types::MessageTemplateAttachment]
|
|
1495
1667
|
end
|
|
@@ -1576,6 +1748,87 @@ module Aws
|
|
|
1576
1748
|
) -> _RenderMessageTemplateResponseSuccess
|
|
1577
1749
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RenderMessageTemplateResponseSuccess
|
|
1578
1750
|
|
|
1751
|
+
interface _RetrieveResponseSuccess
|
|
1752
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::RetrieveResponse]
|
|
1753
|
+
def results: () -> ::Array[Types::RetrieveResult]
|
|
1754
|
+
end
|
|
1755
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#retrieve-instance_method
|
|
1756
|
+
def retrieve: (
|
|
1757
|
+
assistant_id: ::String,
|
|
1758
|
+
retrieval_configuration: {
|
|
1759
|
+
knowledge_source: {
|
|
1760
|
+
assistant_association_ids: Array[::String]?
|
|
1761
|
+
},
|
|
1762
|
+
filter: {
|
|
1763
|
+
and_all: Array[
|
|
1764
|
+
untyped,
|
|
1765
|
+
]?,
|
|
1766
|
+
equals: {
|
|
1767
|
+
key: ::String,
|
|
1768
|
+
value: {
|
|
1769
|
+
}
|
|
1770
|
+
}?,
|
|
1771
|
+
greater_than: {
|
|
1772
|
+
key: ::String,
|
|
1773
|
+
value: {
|
|
1774
|
+
}
|
|
1775
|
+
}?,
|
|
1776
|
+
greater_than_or_equals: {
|
|
1777
|
+
key: ::String,
|
|
1778
|
+
value: {
|
|
1779
|
+
}
|
|
1780
|
+
}?,
|
|
1781
|
+
in: {
|
|
1782
|
+
key: ::String,
|
|
1783
|
+
value: {
|
|
1784
|
+
}
|
|
1785
|
+
}?,
|
|
1786
|
+
less_than: {
|
|
1787
|
+
key: ::String,
|
|
1788
|
+
value: {
|
|
1789
|
+
}
|
|
1790
|
+
}?,
|
|
1791
|
+
less_than_or_equals: {
|
|
1792
|
+
key: ::String,
|
|
1793
|
+
value: {
|
|
1794
|
+
}
|
|
1795
|
+
}?,
|
|
1796
|
+
list_contains: {
|
|
1797
|
+
key: ::String,
|
|
1798
|
+
value: {
|
|
1799
|
+
}
|
|
1800
|
+
}?,
|
|
1801
|
+
not_equals: {
|
|
1802
|
+
key: ::String,
|
|
1803
|
+
value: {
|
|
1804
|
+
}
|
|
1805
|
+
}?,
|
|
1806
|
+
not_in: {
|
|
1807
|
+
key: ::String,
|
|
1808
|
+
value: {
|
|
1809
|
+
}
|
|
1810
|
+
}?,
|
|
1811
|
+
or_all: Array[
|
|
1812
|
+
untyped,
|
|
1813
|
+
]?,
|
|
1814
|
+
starts_with: {
|
|
1815
|
+
key: ::String,
|
|
1816
|
+
value: {
|
|
1817
|
+
}
|
|
1818
|
+
}?,
|
|
1819
|
+
string_contains: {
|
|
1820
|
+
key: ::String,
|
|
1821
|
+
value: {
|
|
1822
|
+
}
|
|
1823
|
+
}?
|
|
1824
|
+
}?,
|
|
1825
|
+
number_of_results: ::Integer?,
|
|
1826
|
+
override_knowledge_base_search_type: ("HYBRID" | "SEMANTIC")?
|
|
1827
|
+
},
|
|
1828
|
+
retrieval_query: ::String
|
|
1829
|
+
) -> _RetrieveResponseSuccess
|
|
1830
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RetrieveResponseSuccess
|
|
1831
|
+
|
|
1579
1832
|
interface _SearchContentResponseSuccess
|
|
1580
1833
|
include ::Seahorse::Client::_ResponseSuccess[Types::SearchContentResponse]
|
|
1581
1834
|
def content_summaries: () -> ::Array[Types::ContentSummary]
|
|
@@ -1707,23 +1960,52 @@ module Aws
|
|
|
1707
1960
|
message: {
|
|
1708
1961
|
value: {
|
|
1709
1962
|
text: {
|
|
1710
|
-
value: ::String
|
|
1963
|
+
value: ::String?,
|
|
1964
|
+
citations: Array[
|
|
1965
|
+
{
|
|
1966
|
+
content_id: ::String?,
|
|
1967
|
+
title: ::String?,
|
|
1968
|
+
knowledge_base_id: ::String?,
|
|
1969
|
+
citation_span: {
|
|
1970
|
+
begin_offset_inclusive: ::Integer?,
|
|
1971
|
+
end_offset_exclusive: ::Integer?
|
|
1972
|
+
},
|
|
1973
|
+
source_url: ::String?,
|
|
1974
|
+
reference_type: ("WEB_CRAWLER" | "KNOWLEDGE_BASE" | "BEDROCK_KB_S3" | "BEDROCK_KB_WEB" | "BEDROCK_KB_CONFLUENCE" | "BEDROCK_KB_SALESFORCE" | "BEDROCK_KB_SHAREPOINT" | "BEDROCK_KB_KENDRA" | "BEDROCK_KB_CUSTOM_DOCUMENT" | "BEDROCK_KB_SQL")
|
|
1975
|
+
},
|
|
1976
|
+
]?,
|
|
1977
|
+
ai_guardrail_assessment: {
|
|
1978
|
+
blocked: bool
|
|
1979
|
+
}?
|
|
1980
|
+
}?,
|
|
1981
|
+
tool_use_result: {
|
|
1982
|
+
tool_use_id: ::String,
|
|
1983
|
+
tool_name: ::String,
|
|
1984
|
+
tool_result: {
|
|
1985
|
+
},
|
|
1986
|
+
input_schema: {
|
|
1987
|
+
}?
|
|
1711
1988
|
}?
|
|
1712
1989
|
}
|
|
1713
1990
|
},
|
|
1991
|
+
?ai_agent_id: ::String,
|
|
1714
1992
|
?conversation_context: {
|
|
1715
1993
|
self_service_conversation_history: Array[
|
|
1716
1994
|
{
|
|
1717
|
-
turn_number: ::Integer
|
|
1995
|
+
turn_number: ::Integer?,
|
|
1718
1996
|
input_transcript: ::String?,
|
|
1719
|
-
bot_response: ::String
|
|
1997
|
+
bot_response: ::String?,
|
|
1998
|
+
timestamp: ::Time?
|
|
1720
1999
|
},
|
|
1721
2000
|
]
|
|
1722
2001
|
},
|
|
1723
2002
|
?configuration: {
|
|
1724
|
-
generate_filler_message: bool
|
|
2003
|
+
generate_filler_message: bool?,
|
|
2004
|
+
generate_chunked_message: bool?
|
|
1725
2005
|
},
|
|
1726
|
-
?client_token: ::String
|
|
2006
|
+
?client_token: ::String,
|
|
2007
|
+
?orchestrator_use_case: ::String,
|
|
2008
|
+
?metadata: Hash[::String, ::String]
|
|
1727
2009
|
) -> _SendMessageResponseSuccess
|
|
1728
2010
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendMessageResponseSuccess
|
|
1729
2011
|
|
|
@@ -1881,7 +2163,8 @@ module Aws
|
|
|
1881
2163
|
}?
|
|
1882
2164
|
},
|
|
1883
2165
|
]?,
|
|
1884
|
-
locale: ::String
|
|
2166
|
+
locale: ::String?,
|
|
2167
|
+
suggested_messages: Array[::String]?
|
|
1885
2168
|
}?,
|
|
1886
2169
|
self_service_ai_agent_configuration: {
|
|
1887
2170
|
self_service_pre_processing_ai_prompt_id: ::String?,
|
|
@@ -2015,6 +2298,66 @@ module Aws
|
|
|
2015
2298
|
}?
|
|
2016
2299
|
},
|
|
2017
2300
|
]?
|
|
2301
|
+
}?,
|
|
2302
|
+
orchestration_ai_agent_configuration: {
|
|
2303
|
+
orchestration_ai_prompt_id: ::String,
|
|
2304
|
+
orchestration_ai_guardrail_id: ::String?,
|
|
2305
|
+
tool_configurations: Array[
|
|
2306
|
+
{
|
|
2307
|
+
tool_name: ::String,
|
|
2308
|
+
tool_type: ("MODEL_CONTEXT_PROTOCOL" | "RETURN_TO_CONTROL" | "CONSTANT"),
|
|
2309
|
+
title: ::String?,
|
|
2310
|
+
tool_id: ::String?,
|
|
2311
|
+
description: ::String?,
|
|
2312
|
+
instruction: {
|
|
2313
|
+
instruction: ::String?,
|
|
2314
|
+
examples: Array[::String]?
|
|
2315
|
+
}?,
|
|
2316
|
+
override_input_values: Array[
|
|
2317
|
+
{
|
|
2318
|
+
json_path: ::String,
|
|
2319
|
+
value: {
|
|
2320
|
+
constant: {
|
|
2321
|
+
type: ("STRING" | "NUMBER" | "JSON_STRING"),
|
|
2322
|
+
value: ::String
|
|
2323
|
+
}?
|
|
2324
|
+
}
|
|
2325
|
+
},
|
|
2326
|
+
]?,
|
|
2327
|
+
output_filters: Array[
|
|
2328
|
+
{
|
|
2329
|
+
json_path: ::String,
|
|
2330
|
+
output_configuration: {
|
|
2331
|
+
output_variable_name_override: ::String?,
|
|
2332
|
+
session_data_namespace: ::String?
|
|
2333
|
+
}?
|
|
2334
|
+
},
|
|
2335
|
+
]?,
|
|
2336
|
+
input_schema: {
|
|
2337
|
+
}?,
|
|
2338
|
+
output_schema: {
|
|
2339
|
+
}?,
|
|
2340
|
+
annotations: {
|
|
2341
|
+
title: ::String?,
|
|
2342
|
+
destructive_hint: bool?
|
|
2343
|
+
}?,
|
|
2344
|
+
user_interaction_configuration: {
|
|
2345
|
+
is_user_confirmation_required: bool?
|
|
2346
|
+
}?
|
|
2347
|
+
},
|
|
2348
|
+
]?,
|
|
2349
|
+
connect_instance_arn: ::String?,
|
|
2350
|
+
locale: ::String?
|
|
2351
|
+
}?,
|
|
2352
|
+
note_taking_ai_agent_configuration: {
|
|
2353
|
+
note_taking_ai_prompt_id: ::String?,
|
|
2354
|
+
note_taking_ai_guardrail_id: ::String?,
|
|
2355
|
+
locale: ::String?
|
|
2356
|
+
}?,
|
|
2357
|
+
case_summarization_ai_agent_configuration: {
|
|
2358
|
+
case_summarization_ai_prompt_id: ::String?,
|
|
2359
|
+
case_summarization_ai_guardrail_id: ::String?,
|
|
2360
|
+
locale: ::String?
|
|
2018
2361
|
}?
|
|
2019
2362
|
},
|
|
2020
2363
|
?description: ::String
|
|
@@ -2108,7 +2451,15 @@ module Aws
|
|
|
2108
2451
|
}?
|
|
2109
2452
|
},
|
|
2110
2453
|
?description: ::String,
|
|
2111
|
-
?model_id: ::String
|
|
2454
|
+
?model_id: ::String,
|
|
2455
|
+
?inference_configuration: {
|
|
2456
|
+
text_ai_prompt_inference_configuration: {
|
|
2457
|
+
temperature: ::Float?,
|
|
2458
|
+
top_p: ::Float?,
|
|
2459
|
+
top_k: ::Integer?,
|
|
2460
|
+
max_tokens_to_sample: ::Integer?
|
|
2461
|
+
}?
|
|
2462
|
+
}
|
|
2112
2463
|
) -> _UpdateAIPromptResponseSuccess
|
|
2113
2464
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAIPromptResponseSuccess
|
|
2114
2465
|
|
|
@@ -2119,10 +2470,16 @@ module Aws
|
|
|
2119
2470
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_assistant_ai_agent-instance_method
|
|
2120
2471
|
def update_assistant_ai_agent: (
|
|
2121
2472
|
assistant_id: ::String,
|
|
2122
|
-
ai_agent_type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE" | "EMAIL_RESPONSE" | "EMAIL_OVERVIEW" | "EMAIL_GENERATIVE_ANSWER"),
|
|
2473
|
+
ai_agent_type: ("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE" | "EMAIL_RESPONSE" | "EMAIL_OVERVIEW" | "EMAIL_GENERATIVE_ANSWER" | "ORCHESTRATION" | "NOTE_TAKING" | "CASE_SUMMARIZATION"),
|
|
2123
2474
|
configuration: {
|
|
2124
2475
|
ai_agent_id: ::String
|
|
2125
|
-
}
|
|
2476
|
+
},
|
|
2477
|
+
?orchestrator_configuration_list: Array[
|
|
2478
|
+
{
|
|
2479
|
+
ai_agent_id: ::String?,
|
|
2480
|
+
orchestrator_use_case: ::String
|
|
2481
|
+
},
|
|
2482
|
+
]
|
|
2126
2483
|
) -> _UpdateAssistantAIAgentResponseSuccess
|
|
2127
2484
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAssistantAIAgentResponseSuccess
|
|
2128
2485
|
|
|
@@ -2186,9 +2543,79 @@ module Aws
|
|
|
2186
2543
|
content: ::String?
|
|
2187
2544
|
}?
|
|
2188
2545
|
}?
|
|
2546
|
+
}?,
|
|
2547
|
+
whats_app: {
|
|
2548
|
+
data: ::String?
|
|
2549
|
+
}?,
|
|
2550
|
+
push: {
|
|
2551
|
+
adm: {
|
|
2552
|
+
title: ::String?,
|
|
2553
|
+
body: {
|
|
2554
|
+
content: ::String?
|
|
2555
|
+
}?,
|
|
2556
|
+
action: ("OPEN_APP" | "DEEP_LINK" | "URL")?,
|
|
2557
|
+
sound: ::String?,
|
|
2558
|
+
url: ::String?,
|
|
2559
|
+
image_url: ::String?,
|
|
2560
|
+
image_icon_url: ::String?,
|
|
2561
|
+
small_image_icon_url: ::String?,
|
|
2562
|
+
raw_content: {
|
|
2563
|
+
content: ::String?
|
|
2564
|
+
}?
|
|
2565
|
+
}?,
|
|
2566
|
+
apns: {
|
|
2567
|
+
title: ::String?,
|
|
2568
|
+
body: {
|
|
2569
|
+
content: ::String?
|
|
2570
|
+
}?,
|
|
2571
|
+
action: ("OPEN_APP" | "DEEP_LINK" | "URL")?,
|
|
2572
|
+
sound: ::String?,
|
|
2573
|
+
url: ::String?,
|
|
2574
|
+
media_url: ::String?,
|
|
2575
|
+
raw_content: {
|
|
2576
|
+
content: ::String?
|
|
2577
|
+
}?
|
|
2578
|
+
}?,
|
|
2579
|
+
fcm: {
|
|
2580
|
+
title: ::String?,
|
|
2581
|
+
body: {
|
|
2582
|
+
content: ::String?
|
|
2583
|
+
}?,
|
|
2584
|
+
action: ("OPEN_APP" | "DEEP_LINK" | "URL")?,
|
|
2585
|
+
sound: ::String?,
|
|
2586
|
+
url: ::String?,
|
|
2587
|
+
image_url: ::String?,
|
|
2588
|
+
image_icon_url: ::String?,
|
|
2589
|
+
small_image_icon_url: ::String?,
|
|
2590
|
+
raw_content: {
|
|
2591
|
+
content: ::String?
|
|
2592
|
+
}?
|
|
2593
|
+
}?,
|
|
2594
|
+
baidu: {
|
|
2595
|
+
title: ::String?,
|
|
2596
|
+
body: {
|
|
2597
|
+
content: ::String?
|
|
2598
|
+
}?,
|
|
2599
|
+
action: ("OPEN_APP" | "DEEP_LINK" | "URL")?,
|
|
2600
|
+
sound: ::String?,
|
|
2601
|
+
url: ::String?,
|
|
2602
|
+
image_url: ::String?,
|
|
2603
|
+
image_icon_url: ::String?,
|
|
2604
|
+
small_image_icon_url: ::String?,
|
|
2605
|
+
raw_content: {
|
|
2606
|
+
content: ::String?
|
|
2607
|
+
}?
|
|
2608
|
+
}?
|
|
2189
2609
|
}?
|
|
2190
2610
|
},
|
|
2191
2611
|
?language: ::String,
|
|
2612
|
+
?source_configuration: {
|
|
2613
|
+
whats_app: {
|
|
2614
|
+
business_account_id: ::String,
|
|
2615
|
+
template_id: ::String,
|
|
2616
|
+
components: Array[::String]?
|
|
2617
|
+
}?
|
|
2618
|
+
},
|
|
2192
2619
|
?default_attributes: {
|
|
2193
2620
|
system_attributes: {
|
|
2194
2621
|
name: ::String?,
|
|
@@ -2348,9 +2775,16 @@ module Aws
|
|
|
2348
2775
|
},
|
|
2349
2776
|
]?
|
|
2350
2777
|
},
|
|
2351
|
-
?ai_agent_configuration: Hash[("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE" | "EMAIL_RESPONSE" | "EMAIL_OVERVIEW" | "EMAIL_GENERATIVE_ANSWER"), {
|
|
2778
|
+
?ai_agent_configuration: Hash[("MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE" | "EMAIL_RESPONSE" | "EMAIL_OVERVIEW" | "EMAIL_GENERATIVE_ANSWER" | "ORCHESTRATION" | "NOTE_TAKING" | "CASE_SUMMARIZATION"), {
|
|
2352
2779
|
ai_agent_id: ::String
|
|
2353
|
-
}]
|
|
2780
|
+
}],
|
|
2781
|
+
?orchestrator_configuration_list: Array[
|
|
2782
|
+
{
|
|
2783
|
+
ai_agent_id: ::String?,
|
|
2784
|
+
orchestrator_use_case: ::String
|
|
2785
|
+
},
|
|
2786
|
+
],
|
|
2787
|
+
?remove_orchestrator_configuration_list: bool
|
|
2354
2788
|
) -> _UpdateSessionResponseSuccess
|
|
2355
2789
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateSessionResponseSuccess
|
|
2356
2790
|
|