aws-sdk-qconnect 1.20.0 → 1.21.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 +1733 -44
- data/lib/aws-sdk-qconnect/client_api.rb +819 -1
- data/lib/aws-sdk-qconnect/endpoints.rb +209 -0
- data/lib/aws-sdk-qconnect/plugins/endpoints.rb +38 -0
- data/lib/aws-sdk-qconnect/types.rb +2153 -101
- data/lib/aws-sdk-qconnect.rb +2 -2
- data/sig/client.rbs +509 -3
- data/sig/types.rbs +580 -5
- metadata +4 -4
|
@@ -447,6 +447,485 @@ module Aws::QConnect
|
|
|
447
447
|
|
|
448
448
|
# @!group API Operations
|
|
449
449
|
|
|
450
|
+
# Creates an Amazon Q in Connect AI Agent.
|
|
451
|
+
#
|
|
452
|
+
# @option params [required, String] :assistant_id
|
|
453
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
454
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
455
|
+
#
|
|
456
|
+
# @option params [String] :client_token
|
|
457
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
458
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
|
459
|
+
# this field. For more information about idempotency, see [Making
|
|
460
|
+
# retries safe with idempotent APIs][1].
|
|
461
|
+
#
|
|
462
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
463
|
+
# not need to pass this option.**
|
|
464
|
+
#
|
|
465
|
+
#
|
|
466
|
+
#
|
|
467
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
468
|
+
#
|
|
469
|
+
# @option params [required, Types::AIAgentConfiguration] :configuration
|
|
470
|
+
# The configuration of the AI Agent.
|
|
471
|
+
#
|
|
472
|
+
# @option params [String] :description
|
|
473
|
+
# The description of the AI Agent.
|
|
474
|
+
#
|
|
475
|
+
# @option params [required, String] :name
|
|
476
|
+
# The name of the AI Agent.
|
|
477
|
+
#
|
|
478
|
+
# @option params [Hash<String,String>] :tags
|
|
479
|
+
# The tags used to organize, track, or control access for this resource.
|
|
480
|
+
#
|
|
481
|
+
# @option params [required, String] :type
|
|
482
|
+
# The type of the AI Agent.
|
|
483
|
+
#
|
|
484
|
+
# @option params [required, String] :visibility_status
|
|
485
|
+
# The visibility status of the AI Agent.
|
|
486
|
+
#
|
|
487
|
+
# @return [Types::CreateAIAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
488
|
+
#
|
|
489
|
+
# * {Types::CreateAIAgentResponse#ai_agent #ai_agent} => Types::AIAgentData
|
|
490
|
+
#
|
|
491
|
+
# @example Request syntax with placeholder values
|
|
492
|
+
#
|
|
493
|
+
# resp = client.create_ai_agent({
|
|
494
|
+
# assistant_id: "UuidOrArn", # required
|
|
495
|
+
# client_token: "ClientToken",
|
|
496
|
+
# configuration: { # required
|
|
497
|
+
# answer_recommendation_ai_agent_configuration: {
|
|
498
|
+
# answer_generation_ai_prompt_id: "UuidWithQualifier",
|
|
499
|
+
# association_configurations: [
|
|
500
|
+
# {
|
|
501
|
+
# association_configuration_data: {
|
|
502
|
+
# knowledge_base_association_configuration_data: {
|
|
503
|
+
# content_tag_filter: {
|
|
504
|
+
# and_conditions: [
|
|
505
|
+
# {
|
|
506
|
+
# key: "TagKey", # required
|
|
507
|
+
# value: "TagValue",
|
|
508
|
+
# },
|
|
509
|
+
# ],
|
|
510
|
+
# or_conditions: [
|
|
511
|
+
# {
|
|
512
|
+
# and_conditions: [
|
|
513
|
+
# {
|
|
514
|
+
# key: "TagKey", # required
|
|
515
|
+
# value: "TagValue",
|
|
516
|
+
# },
|
|
517
|
+
# ],
|
|
518
|
+
# tag_condition: {
|
|
519
|
+
# key: "TagKey", # required
|
|
520
|
+
# value: "TagValue",
|
|
521
|
+
# },
|
|
522
|
+
# },
|
|
523
|
+
# ],
|
|
524
|
+
# tag_condition: {
|
|
525
|
+
# key: "TagKey", # required
|
|
526
|
+
# value: "TagValue",
|
|
527
|
+
# },
|
|
528
|
+
# },
|
|
529
|
+
# max_results: 1,
|
|
530
|
+
# override_knowledge_base_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
|
|
531
|
+
# },
|
|
532
|
+
# },
|
|
533
|
+
# association_id: "Uuid",
|
|
534
|
+
# association_type: "KNOWLEDGE_BASE", # accepts KNOWLEDGE_BASE
|
|
535
|
+
# },
|
|
536
|
+
# ],
|
|
537
|
+
# intent_labeling_generation_ai_prompt_id: "UuidWithQualifier",
|
|
538
|
+
# query_reformulation_ai_prompt_id: "UuidWithQualifier",
|
|
539
|
+
# },
|
|
540
|
+
# manual_search_ai_agent_configuration: {
|
|
541
|
+
# answer_generation_ai_prompt_id: "UuidWithQualifier",
|
|
542
|
+
# association_configurations: [
|
|
543
|
+
# {
|
|
544
|
+
# association_configuration_data: {
|
|
545
|
+
# knowledge_base_association_configuration_data: {
|
|
546
|
+
# content_tag_filter: {
|
|
547
|
+
# and_conditions: [
|
|
548
|
+
# {
|
|
549
|
+
# key: "TagKey", # required
|
|
550
|
+
# value: "TagValue",
|
|
551
|
+
# },
|
|
552
|
+
# ],
|
|
553
|
+
# or_conditions: [
|
|
554
|
+
# {
|
|
555
|
+
# and_conditions: [
|
|
556
|
+
# {
|
|
557
|
+
# key: "TagKey", # required
|
|
558
|
+
# value: "TagValue",
|
|
559
|
+
# },
|
|
560
|
+
# ],
|
|
561
|
+
# tag_condition: {
|
|
562
|
+
# key: "TagKey", # required
|
|
563
|
+
# value: "TagValue",
|
|
564
|
+
# },
|
|
565
|
+
# },
|
|
566
|
+
# ],
|
|
567
|
+
# tag_condition: {
|
|
568
|
+
# key: "TagKey", # required
|
|
569
|
+
# value: "TagValue",
|
|
570
|
+
# },
|
|
571
|
+
# },
|
|
572
|
+
# max_results: 1,
|
|
573
|
+
# override_knowledge_base_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
|
|
574
|
+
# },
|
|
575
|
+
# },
|
|
576
|
+
# association_id: "Uuid",
|
|
577
|
+
# association_type: "KNOWLEDGE_BASE", # accepts KNOWLEDGE_BASE
|
|
578
|
+
# },
|
|
579
|
+
# ],
|
|
580
|
+
# },
|
|
581
|
+
# },
|
|
582
|
+
# description: "Description",
|
|
583
|
+
# name: "Name", # required
|
|
584
|
+
# tags: {
|
|
585
|
+
# "TagKey" => "TagValue",
|
|
586
|
+
# },
|
|
587
|
+
# type: "MANUAL_SEARCH", # required, accepts MANUAL_SEARCH, ANSWER_RECOMMENDATION
|
|
588
|
+
# visibility_status: "SAVED", # required, accepts SAVED, PUBLISHED
|
|
589
|
+
# })
|
|
590
|
+
#
|
|
591
|
+
# @example Response structure
|
|
592
|
+
#
|
|
593
|
+
# resp.ai_agent.ai_agent_arn #=> String
|
|
594
|
+
# resp.ai_agent.ai_agent_id #=> String
|
|
595
|
+
# resp.ai_agent.assistant_arn #=> String
|
|
596
|
+
# resp.ai_agent.assistant_id #=> String
|
|
597
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
598
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
|
|
599
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
600
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
601
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
602
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
603
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
604
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
605
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
606
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
607
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
608
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
609
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
610
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
611
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
612
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
613
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
614
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
|
|
615
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
|
|
616
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
617
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
|
|
618
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
619
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
620
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
621
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
622
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
623
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
624
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
625
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
626
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
627
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
628
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
629
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
630
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
631
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
632
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
633
|
+
# resp.ai_agent.description #=> String
|
|
634
|
+
# resp.ai_agent.modified_time #=> Time
|
|
635
|
+
# resp.ai_agent.name #=> String
|
|
636
|
+
# resp.ai_agent.origin #=> String, one of "SYSTEM", "CUSTOMER"
|
|
637
|
+
# resp.ai_agent.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
638
|
+
# resp.ai_agent.tags #=> Hash
|
|
639
|
+
# resp.ai_agent.tags["TagKey"] #=> String
|
|
640
|
+
# resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION"
|
|
641
|
+
# resp.ai_agent.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
642
|
+
#
|
|
643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIAgent AWS API Documentation
|
|
644
|
+
#
|
|
645
|
+
# @overload create_ai_agent(params = {})
|
|
646
|
+
# @param [Hash] params ({})
|
|
647
|
+
def create_ai_agent(params = {}, options = {})
|
|
648
|
+
req = build_request(:create_ai_agent, params)
|
|
649
|
+
req.send_request(options)
|
|
650
|
+
end
|
|
651
|
+
|
|
652
|
+
# Creates and Amazon Q in Connect AI Agent version.
|
|
653
|
+
#
|
|
654
|
+
# @option params [required, String] :ai_agent_id
|
|
655
|
+
# The identifier of the Amazon Q in Connect AI Agent.
|
|
656
|
+
#
|
|
657
|
+
# @option params [required, String] :assistant_id
|
|
658
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
659
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
660
|
+
#
|
|
661
|
+
# @option params [String] :client_token
|
|
662
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
663
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
|
664
|
+
# this field. For more information about idempotency, see [Making
|
|
665
|
+
# retries safe with idempotent APIs][1].
|
|
666
|
+
#
|
|
667
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
668
|
+
# not need to pass this option.**
|
|
669
|
+
#
|
|
670
|
+
#
|
|
671
|
+
#
|
|
672
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
673
|
+
#
|
|
674
|
+
# @option params [Time,DateTime,Date,Integer,String] :modified_time
|
|
675
|
+
# The modification time of the AI Agent should be tracked for version
|
|
676
|
+
# creation. This field should be specified to avoid version creation
|
|
677
|
+
# when simultaneous update to the underlying AI Agent are possible. The
|
|
678
|
+
# value should be the modifiedTime returned from the request to create
|
|
679
|
+
# or update an AI Agent so that version creation can fail if an update
|
|
680
|
+
# to the AI Agent post the specified modification time has been made.
|
|
681
|
+
#
|
|
682
|
+
# @return [Types::CreateAIAgentVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
683
|
+
#
|
|
684
|
+
# * {Types::CreateAIAgentVersionResponse#ai_agent #ai_agent} => Types::AIAgentData
|
|
685
|
+
# * {Types::CreateAIAgentVersionResponse#version_number #version_number} => Integer
|
|
686
|
+
#
|
|
687
|
+
# @example Request syntax with placeholder values
|
|
688
|
+
#
|
|
689
|
+
# resp = client.create_ai_agent_version({
|
|
690
|
+
# ai_agent_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
691
|
+
# assistant_id: "UuidOrArn", # required
|
|
692
|
+
# client_token: "ClientToken",
|
|
693
|
+
# modified_time: Time.now,
|
|
694
|
+
# })
|
|
695
|
+
#
|
|
696
|
+
# @example Response structure
|
|
697
|
+
#
|
|
698
|
+
# resp.ai_agent.ai_agent_arn #=> String
|
|
699
|
+
# resp.ai_agent.ai_agent_id #=> String
|
|
700
|
+
# resp.ai_agent.assistant_arn #=> String
|
|
701
|
+
# resp.ai_agent.assistant_id #=> String
|
|
702
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
703
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
|
|
704
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
705
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
706
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
707
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
708
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
709
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
710
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
711
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
712
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
713
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
714
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
715
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
716
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
717
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
718
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
719
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
|
|
720
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
|
|
721
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
722
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
|
|
723
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
724
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
725
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
726
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
727
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
728
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
729
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
730
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
731
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
732
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
733
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
734
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
735
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
736
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
737
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
738
|
+
# resp.ai_agent.description #=> String
|
|
739
|
+
# resp.ai_agent.modified_time #=> Time
|
|
740
|
+
# resp.ai_agent.name #=> String
|
|
741
|
+
# resp.ai_agent.origin #=> String, one of "SYSTEM", "CUSTOMER"
|
|
742
|
+
# resp.ai_agent.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
743
|
+
# resp.ai_agent.tags #=> Hash
|
|
744
|
+
# resp.ai_agent.tags["TagKey"] #=> String
|
|
745
|
+
# resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION"
|
|
746
|
+
# resp.ai_agent.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
747
|
+
# resp.version_number #=> Integer
|
|
748
|
+
#
|
|
749
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIAgentVersion AWS API Documentation
|
|
750
|
+
#
|
|
751
|
+
# @overload create_ai_agent_version(params = {})
|
|
752
|
+
# @param [Hash] params ({})
|
|
753
|
+
def create_ai_agent_version(params = {}, options = {})
|
|
754
|
+
req = build_request(:create_ai_agent_version, params)
|
|
755
|
+
req.send_request(options)
|
|
756
|
+
end
|
|
757
|
+
|
|
758
|
+
# Creates an Amazon Q in Connect AI Prompt.
|
|
759
|
+
#
|
|
760
|
+
# @option params [required, String] :api_format
|
|
761
|
+
# The API Format of the AI Prompt.
|
|
762
|
+
#
|
|
763
|
+
# @option params [required, String] :assistant_id
|
|
764
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
765
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
766
|
+
#
|
|
767
|
+
# @option params [String] :client_token
|
|
768
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
769
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
|
770
|
+
# this field. For more information about idempotency, see [Making
|
|
771
|
+
# retries safe with idempotent APIs][1].
|
|
772
|
+
#
|
|
773
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
774
|
+
# not need to pass this option.**
|
|
775
|
+
#
|
|
776
|
+
#
|
|
777
|
+
#
|
|
778
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
779
|
+
#
|
|
780
|
+
# @option params [String] :description
|
|
781
|
+
# The description of the AI Prompt.
|
|
782
|
+
#
|
|
783
|
+
# @option params [required, String] :model_id
|
|
784
|
+
# The identifier of the model used for this AI Prompt. Model Ids
|
|
785
|
+
# supported are: `CLAUDE_3_HAIKU_20240307_V1`
|
|
786
|
+
#
|
|
787
|
+
# @option params [required, String] :name
|
|
788
|
+
# The name of the AI Prompt.
|
|
789
|
+
#
|
|
790
|
+
# @option params [Hash<String,String>] :tags
|
|
791
|
+
# The tags used to organize, track, or control access for this resource.
|
|
792
|
+
#
|
|
793
|
+
# @option params [required, Types::AIPromptTemplateConfiguration] :template_configuration
|
|
794
|
+
# The configuration of the prompt template for this AI Prompt.
|
|
795
|
+
#
|
|
796
|
+
# @option params [required, String] :template_type
|
|
797
|
+
# The type of the prompt template for this AI Prompt.
|
|
798
|
+
#
|
|
799
|
+
# @option params [required, String] :type
|
|
800
|
+
# The type of this AI Prompt.
|
|
801
|
+
#
|
|
802
|
+
# @option params [required, String] :visibility_status
|
|
803
|
+
# The visibility status of the AI Prompt.
|
|
804
|
+
#
|
|
805
|
+
# @return [Types::CreateAIPromptResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
806
|
+
#
|
|
807
|
+
# * {Types::CreateAIPromptResponse#ai_prompt #ai_prompt} => Types::AIPromptData
|
|
808
|
+
#
|
|
809
|
+
# @example Request syntax with placeholder values
|
|
810
|
+
#
|
|
811
|
+
# resp = client.create_ai_prompt({
|
|
812
|
+
# api_format: "ANTHROPIC_CLAUDE_MESSAGES", # required, accepts ANTHROPIC_CLAUDE_MESSAGES, ANTHROPIC_CLAUDE_TEXT_COMPLETIONS
|
|
813
|
+
# assistant_id: "UuidOrArn", # required
|
|
814
|
+
# client_token: "ClientToken",
|
|
815
|
+
# description: "Description",
|
|
816
|
+
# model_id: "AIPromptModelIdentifier", # required
|
|
817
|
+
# name: "Name", # required
|
|
818
|
+
# tags: {
|
|
819
|
+
# "TagKey" => "TagValue",
|
|
820
|
+
# },
|
|
821
|
+
# template_configuration: { # required
|
|
822
|
+
# text_full_ai_prompt_edit_template_configuration: {
|
|
823
|
+
# text: "TextAIPrompt", # required
|
|
824
|
+
# },
|
|
825
|
+
# },
|
|
826
|
+
# template_type: "TEXT", # required, accepts TEXT
|
|
827
|
+
# type: "ANSWER_GENERATION", # required, accepts ANSWER_GENERATION, INTENT_LABELING_GENERATION, QUERY_REFORMULATION
|
|
828
|
+
# visibility_status: "SAVED", # required, accepts SAVED, PUBLISHED
|
|
829
|
+
# })
|
|
830
|
+
#
|
|
831
|
+
# @example Response structure
|
|
832
|
+
#
|
|
833
|
+
# resp.ai_prompt.ai_prompt_arn #=> String
|
|
834
|
+
# resp.ai_prompt.ai_prompt_id #=> String
|
|
835
|
+
# resp.ai_prompt.api_format #=> String, one of "ANTHROPIC_CLAUDE_MESSAGES", "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS"
|
|
836
|
+
# resp.ai_prompt.assistant_arn #=> String
|
|
837
|
+
# resp.ai_prompt.assistant_id #=> String
|
|
838
|
+
# resp.ai_prompt.description #=> String
|
|
839
|
+
# resp.ai_prompt.model_id #=> String
|
|
840
|
+
# resp.ai_prompt.modified_time #=> Time
|
|
841
|
+
# resp.ai_prompt.name #=> String
|
|
842
|
+
# resp.ai_prompt.origin #=> String, one of "SYSTEM", "CUSTOMER"
|
|
843
|
+
# resp.ai_prompt.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
844
|
+
# resp.ai_prompt.tags #=> Hash
|
|
845
|
+
# resp.ai_prompt.tags["TagKey"] #=> String
|
|
846
|
+
# resp.ai_prompt.template_configuration.text_full_ai_prompt_edit_template_configuration.text #=> String
|
|
847
|
+
# resp.ai_prompt.template_type #=> String, one of "TEXT"
|
|
848
|
+
# resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION"
|
|
849
|
+
# resp.ai_prompt.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
850
|
+
#
|
|
851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPrompt AWS API Documentation
|
|
852
|
+
#
|
|
853
|
+
# @overload create_ai_prompt(params = {})
|
|
854
|
+
# @param [Hash] params ({})
|
|
855
|
+
def create_ai_prompt(params = {}, options = {})
|
|
856
|
+
req = build_request(:create_ai_prompt, params)
|
|
857
|
+
req.send_request(options)
|
|
858
|
+
end
|
|
859
|
+
|
|
860
|
+
# Creates an Amazon Q in Connect AI Prompt version.
|
|
861
|
+
#
|
|
862
|
+
# @option params [required, String] :ai_prompt_id
|
|
863
|
+
# The identifier of the Amazon Q in Connect AI prompt.
|
|
864
|
+
#
|
|
865
|
+
# @option params [required, String] :assistant_id
|
|
866
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
867
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
868
|
+
#
|
|
869
|
+
# @option params [String] :client_token
|
|
870
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
871
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
|
872
|
+
# this field. For more information about idempotency, see [Making
|
|
873
|
+
# retries safe with idempotent APIs][1].
|
|
874
|
+
#
|
|
875
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
876
|
+
# not need to pass this option.**
|
|
877
|
+
#
|
|
878
|
+
#
|
|
879
|
+
#
|
|
880
|
+
# [1]: http://aws.amazon.com/https:/aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
881
|
+
#
|
|
882
|
+
# @option params [Time,DateTime,Date,Integer,String] :modified_time
|
|
883
|
+
# The time the AI Prompt was last modified.
|
|
884
|
+
#
|
|
885
|
+
# @return [Types::CreateAIPromptVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
886
|
+
#
|
|
887
|
+
# * {Types::CreateAIPromptVersionResponse#ai_prompt #ai_prompt} => Types::AIPromptData
|
|
888
|
+
# * {Types::CreateAIPromptVersionResponse#version_number #version_number} => Integer
|
|
889
|
+
#
|
|
890
|
+
# @example Request syntax with placeholder values
|
|
891
|
+
#
|
|
892
|
+
# resp = client.create_ai_prompt_version({
|
|
893
|
+
# ai_prompt_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
894
|
+
# assistant_id: "UuidOrArn", # required
|
|
895
|
+
# client_token: "ClientToken",
|
|
896
|
+
# modified_time: Time.now,
|
|
897
|
+
# })
|
|
898
|
+
#
|
|
899
|
+
# @example Response structure
|
|
900
|
+
#
|
|
901
|
+
# resp.ai_prompt.ai_prompt_arn #=> String
|
|
902
|
+
# resp.ai_prompt.ai_prompt_id #=> String
|
|
903
|
+
# resp.ai_prompt.api_format #=> String, one of "ANTHROPIC_CLAUDE_MESSAGES", "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS"
|
|
904
|
+
# resp.ai_prompt.assistant_arn #=> String
|
|
905
|
+
# resp.ai_prompt.assistant_id #=> String
|
|
906
|
+
# resp.ai_prompt.description #=> String
|
|
907
|
+
# resp.ai_prompt.model_id #=> String
|
|
908
|
+
# resp.ai_prompt.modified_time #=> Time
|
|
909
|
+
# resp.ai_prompt.name #=> String
|
|
910
|
+
# resp.ai_prompt.origin #=> String, one of "SYSTEM", "CUSTOMER"
|
|
911
|
+
# resp.ai_prompt.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
912
|
+
# resp.ai_prompt.tags #=> Hash
|
|
913
|
+
# resp.ai_prompt.tags["TagKey"] #=> String
|
|
914
|
+
# resp.ai_prompt.template_configuration.text_full_ai_prompt_edit_template_configuration.text #=> String
|
|
915
|
+
# resp.ai_prompt.template_type #=> String, one of "TEXT"
|
|
916
|
+
# resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION"
|
|
917
|
+
# resp.ai_prompt.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
918
|
+
# resp.version_number #=> Integer
|
|
919
|
+
#
|
|
920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptVersion AWS API Documentation
|
|
921
|
+
#
|
|
922
|
+
# @overload create_ai_prompt_version(params = {})
|
|
923
|
+
# @param [Hash] params ({})
|
|
924
|
+
def create_ai_prompt_version(params = {}, options = {})
|
|
925
|
+
req = build_request(:create_ai_prompt_version, params)
|
|
926
|
+
req.send_request(options)
|
|
927
|
+
end
|
|
928
|
+
|
|
450
929
|
# Creates an Amazon Q in Connect assistant.
|
|
451
930
|
#
|
|
452
931
|
# @option params [String] :client_token
|
|
@@ -515,6 +994,8 @@ module Aws::QConnect
|
|
|
515
994
|
#
|
|
516
995
|
# @example Response structure
|
|
517
996
|
#
|
|
997
|
+
# resp.assistant.ai_agent_configuration #=> Hash
|
|
998
|
+
# resp.assistant.ai_agent_configuration["AIAgentType"].ai_agent_id #=> String
|
|
518
999
|
# resp.assistant.assistant_arn #=> String
|
|
519
1000
|
# resp.assistant.assistant_id #=> String
|
|
520
1001
|
# resp.assistant.capability_configuration.type #=> String, one of "V1", "V2"
|
|
@@ -889,6 +1370,9 @@ module Aws::QConnect
|
|
|
889
1370
|
# @option params [Hash<String,String>] :tags
|
|
890
1371
|
# The tags used to organize, track, or control access for this resource.
|
|
891
1372
|
#
|
|
1373
|
+
# @option params [Types::VectorIngestionConfiguration] :vector_ingestion_configuration
|
|
1374
|
+
# Contains details about how to ingest the documents in a data source.
|
|
1375
|
+
#
|
|
892
1376
|
# @return [Types::CreateKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
893
1377
|
#
|
|
894
1378
|
# * {Types::CreateKnowledgeBaseResponse#knowledge_base #knowledge_base} => Types::KnowledgeBaseData
|
|
@@ -898,7 +1382,7 @@ module Aws::QConnect
|
|
|
898
1382
|
# resp = client.create_knowledge_base({
|
|
899
1383
|
# client_token: "NonEmptyString",
|
|
900
1384
|
# description: "Description",
|
|
901
|
-
# knowledge_base_type: "EXTERNAL", # required, accepts EXTERNAL, CUSTOM, QUICK_RESPONSES
|
|
1385
|
+
# knowledge_base_type: "EXTERNAL", # required, accepts EXTERNAL, CUSTOM, QUICK_RESPONSES, MESSAGE_TEMPLATES, MANAGED
|
|
902
1386
|
# name: "Name", # required
|
|
903
1387
|
# rendering_configuration: {
|
|
904
1388
|
# template_uri: "Uri",
|
|
@@ -911,18 +1395,69 @@ module Aws::QConnect
|
|
|
911
1395
|
# app_integration_arn: "GenericArn", # required
|
|
912
1396
|
# object_fields: ["NonEmptyString"],
|
|
913
1397
|
# },
|
|
1398
|
+
# managed_source_configuration: {
|
|
1399
|
+
# web_crawler_configuration: {
|
|
1400
|
+
# crawler_limits: {
|
|
1401
|
+
# rate_limit: 1,
|
|
1402
|
+
# },
|
|
1403
|
+
# exclusion_filters: ["UrlFilterPattern"],
|
|
1404
|
+
# inclusion_filters: ["UrlFilterPattern"],
|
|
1405
|
+
# scope: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS
|
|
1406
|
+
# url_configuration: { # required
|
|
1407
|
+
# seed_urls: [
|
|
1408
|
+
# {
|
|
1409
|
+
# url: "WebUrl",
|
|
1410
|
+
# },
|
|
1411
|
+
# ],
|
|
1412
|
+
# },
|
|
1413
|
+
# },
|
|
1414
|
+
# },
|
|
914
1415
|
# },
|
|
915
1416
|
# tags: {
|
|
916
1417
|
# "TagKey" => "TagValue",
|
|
917
1418
|
# },
|
|
1419
|
+
# vector_ingestion_configuration: {
|
|
1420
|
+
# chunking_configuration: {
|
|
1421
|
+
# chunking_strategy: "FIXED_SIZE", # required, accepts FIXED_SIZE, NONE, HIERARCHICAL, SEMANTIC
|
|
1422
|
+
# fixed_size_chunking_configuration: {
|
|
1423
|
+
# max_tokens: 1, # required
|
|
1424
|
+
# overlap_percentage: 1, # required
|
|
1425
|
+
# },
|
|
1426
|
+
# hierarchical_chunking_configuration: {
|
|
1427
|
+
# level_configurations: [ # required
|
|
1428
|
+
# {
|
|
1429
|
+
# max_tokens: 1, # required
|
|
1430
|
+
# },
|
|
1431
|
+
# ],
|
|
1432
|
+
# overlap_tokens: 1, # required
|
|
1433
|
+
# },
|
|
1434
|
+
# semantic_chunking_configuration: {
|
|
1435
|
+
# breakpoint_percentile_threshold: 1, # required
|
|
1436
|
+
# buffer_size: 1, # required
|
|
1437
|
+
# max_tokens: 1, # required
|
|
1438
|
+
# },
|
|
1439
|
+
# },
|
|
1440
|
+
# parsing_configuration: {
|
|
1441
|
+
# bedrock_foundation_model_configuration: {
|
|
1442
|
+
# model_arn: "BedrockModelArnForParsing", # required
|
|
1443
|
+
# parsing_prompt: {
|
|
1444
|
+
# parsing_prompt_text: "ParsingPromptText", # required
|
|
1445
|
+
# },
|
|
1446
|
+
# },
|
|
1447
|
+
# parsing_strategy: "BEDROCK_FOUNDATION_MODEL", # required, accepts BEDROCK_FOUNDATION_MODEL
|
|
1448
|
+
# },
|
|
1449
|
+
# },
|
|
918
1450
|
# })
|
|
919
1451
|
#
|
|
920
1452
|
# @example Response structure
|
|
921
1453
|
#
|
|
922
1454
|
# resp.knowledge_base.description #=> String
|
|
1455
|
+
# resp.knowledge_base.ingestion_failure_reasons #=> Array
|
|
1456
|
+
# resp.knowledge_base.ingestion_failure_reasons[0] #=> String
|
|
1457
|
+
# resp.knowledge_base.ingestion_status #=> String, one of "SYNC_FAILED", "SYNCING_IN_PROGRESS", "SYNC_SUCCESS", "CREATE_IN_PROGRESS"
|
|
923
1458
|
# resp.knowledge_base.knowledge_base_arn #=> String
|
|
924
1459
|
# resp.knowledge_base.knowledge_base_id #=> String
|
|
925
|
-
# resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES"
|
|
1460
|
+
# resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES", "MESSAGE_TEMPLATES", "MANAGED"
|
|
926
1461
|
# resp.knowledge_base.last_content_modification_time #=> Time
|
|
927
1462
|
# resp.knowledge_base.name #=> String
|
|
928
1463
|
# resp.knowledge_base.rendering_configuration.template_uri #=> String
|
|
@@ -930,9 +1465,29 @@ module Aws::QConnect
|
|
|
930
1465
|
# resp.knowledge_base.source_configuration.app_integrations.app_integration_arn #=> String
|
|
931
1466
|
# resp.knowledge_base.source_configuration.app_integrations.object_fields #=> Array
|
|
932
1467
|
# resp.knowledge_base.source_configuration.app_integrations.object_fields[0] #=> String
|
|
1468
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.crawler_limits.rate_limit #=> Integer
|
|
1469
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters #=> Array
|
|
1470
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters[0] #=> String
|
|
1471
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters #=> Array
|
|
1472
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters[0] #=> String
|
|
1473
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.scope #=> String, one of "HOST_ONLY", "SUBDOMAINS"
|
|
1474
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls #=> Array
|
|
1475
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls[0].url #=> String
|
|
933
1476
|
# resp.knowledge_base.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
934
1477
|
# resp.knowledge_base.tags #=> Hash
|
|
935
1478
|
# resp.knowledge_base.tags["TagKey"] #=> String
|
|
1479
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.chunking_strategy #=> String, one of "FIXED_SIZE", "NONE", "HIERARCHICAL", "SEMANTIC"
|
|
1480
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.max_tokens #=> Integer
|
|
1481
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.overlap_percentage #=> Integer
|
|
1482
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations #=> Array
|
|
1483
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations[0].max_tokens #=> Integer
|
|
1484
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.overlap_tokens #=> Integer
|
|
1485
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.breakpoint_percentile_threshold #=> Integer
|
|
1486
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.buffer_size #=> Integer
|
|
1487
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.max_tokens #=> Integer
|
|
1488
|
+
# resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.model_arn #=> String
|
|
1489
|
+
# resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.parsing_prompt.parsing_prompt_text #=> String
|
|
1490
|
+
# resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.parsing_strategy #=> String, one of "BEDROCK_FOUNDATION_MODEL"
|
|
936
1491
|
#
|
|
937
1492
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateKnowledgeBase AWS API Documentation
|
|
938
1493
|
#
|
|
@@ -1071,6 +1626,11 @@ module Aws::QConnect
|
|
|
1071
1626
|
# Connect session for each contact on which Amazon Q in Connect is
|
|
1072
1627
|
# enabled.
|
|
1073
1628
|
#
|
|
1629
|
+
# @option params [Hash<String,Types::AIAgentConfigurationData>] :ai_agent_configuration
|
|
1630
|
+
# The configuration of the AI Agents (mapped by AI Agent Type to AI
|
|
1631
|
+
# Agent version) that should be used by Amazon Q in Connect for this
|
|
1632
|
+
# Session.
|
|
1633
|
+
#
|
|
1074
1634
|
# @option params [required, String] :assistant_id
|
|
1075
1635
|
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
1076
1636
|
# ID or the ARN. URLs cannot contain the ARN.
|
|
@@ -1107,6 +1667,11 @@ module Aws::QConnect
|
|
|
1107
1667
|
# @example Request syntax with placeholder values
|
|
1108
1668
|
#
|
|
1109
1669
|
# resp = client.create_session({
|
|
1670
|
+
# ai_agent_configuration: {
|
|
1671
|
+
# "MANUAL_SEARCH" => {
|
|
1672
|
+
# ai_agent_id: "UuidWithQualifier", # required
|
|
1673
|
+
# },
|
|
1674
|
+
# },
|
|
1110
1675
|
# assistant_id: "UuidOrArn", # required
|
|
1111
1676
|
# client_token: "ClientToken",
|
|
1112
1677
|
# description: "Description",
|
|
@@ -1144,6 +1709,8 @@ module Aws::QConnect
|
|
|
1144
1709
|
#
|
|
1145
1710
|
# @example Response structure
|
|
1146
1711
|
#
|
|
1712
|
+
# resp.session.ai_agent_configuration #=> Hash
|
|
1713
|
+
# resp.session.ai_agent_configuration["AIAgentType"].ai_agent_id #=> String
|
|
1147
1714
|
# resp.session.description #=> String
|
|
1148
1715
|
# resp.session.integration_configuration.topic_integration_arn #=> String
|
|
1149
1716
|
# resp.session.name #=> String
|
|
@@ -1172,6 +1739,125 @@ module Aws::QConnect
|
|
|
1172
1739
|
req.send_request(options)
|
|
1173
1740
|
end
|
|
1174
1741
|
|
|
1742
|
+
# Deletes an Amazon Q in Connect AI Agent.
|
|
1743
|
+
#
|
|
1744
|
+
# @option params [required, String] :ai_agent_id
|
|
1745
|
+
# The identifier of the Amazon Q in Connect AI Agent. Can be either the
|
|
1746
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
1747
|
+
#
|
|
1748
|
+
# @option params [required, String] :assistant_id
|
|
1749
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
1750
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
1751
|
+
#
|
|
1752
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1753
|
+
#
|
|
1754
|
+
# @example Request syntax with placeholder values
|
|
1755
|
+
#
|
|
1756
|
+
# resp = client.delete_ai_agent({
|
|
1757
|
+
# ai_agent_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
1758
|
+
# assistant_id: "UuidOrArn", # required
|
|
1759
|
+
# })
|
|
1760
|
+
#
|
|
1761
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIAgent AWS API Documentation
|
|
1762
|
+
#
|
|
1763
|
+
# @overload delete_ai_agent(params = {})
|
|
1764
|
+
# @param [Hash] params ({})
|
|
1765
|
+
def delete_ai_agent(params = {}, options = {})
|
|
1766
|
+
req = build_request(:delete_ai_agent, params)
|
|
1767
|
+
req.send_request(options)
|
|
1768
|
+
end
|
|
1769
|
+
|
|
1770
|
+
# Deletes an Amazon Q in Connect AI Agent Version.
|
|
1771
|
+
#
|
|
1772
|
+
# @option params [required, String] :ai_agent_id
|
|
1773
|
+
# The identifier of the Amazon Q in Connect AI Agent. Can be either the
|
|
1774
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
1775
|
+
#
|
|
1776
|
+
# @option params [required, String] :assistant_id
|
|
1777
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
1778
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
1779
|
+
#
|
|
1780
|
+
# @option params [required, Integer] :version_number
|
|
1781
|
+
# The version number of the AI Agent version.
|
|
1782
|
+
#
|
|
1783
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1784
|
+
#
|
|
1785
|
+
# @example Request syntax with placeholder values
|
|
1786
|
+
#
|
|
1787
|
+
# resp = client.delete_ai_agent_version({
|
|
1788
|
+
# ai_agent_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
1789
|
+
# assistant_id: "UuidOrArn", # required
|
|
1790
|
+
# version_number: 1, # required
|
|
1791
|
+
# })
|
|
1792
|
+
#
|
|
1793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIAgentVersion AWS API Documentation
|
|
1794
|
+
#
|
|
1795
|
+
# @overload delete_ai_agent_version(params = {})
|
|
1796
|
+
# @param [Hash] params ({})
|
|
1797
|
+
def delete_ai_agent_version(params = {}, options = {})
|
|
1798
|
+
req = build_request(:delete_ai_agent_version, params)
|
|
1799
|
+
req.send_request(options)
|
|
1800
|
+
end
|
|
1801
|
+
|
|
1802
|
+
# Deletes an Amazon Q in Connect AI Prompt.
|
|
1803
|
+
#
|
|
1804
|
+
# @option params [required, String] :ai_prompt_id
|
|
1805
|
+
# The identifier of the Amazon Q in Connect AI prompt. Can be either the
|
|
1806
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
1807
|
+
#
|
|
1808
|
+
# @option params [required, String] :assistant_id
|
|
1809
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
1810
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
1811
|
+
#
|
|
1812
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1813
|
+
#
|
|
1814
|
+
# @example Request syntax with placeholder values
|
|
1815
|
+
#
|
|
1816
|
+
# resp = client.delete_ai_prompt({
|
|
1817
|
+
# ai_prompt_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
1818
|
+
# assistant_id: "UuidOrArn", # required
|
|
1819
|
+
# })
|
|
1820
|
+
#
|
|
1821
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIPrompt AWS API Documentation
|
|
1822
|
+
#
|
|
1823
|
+
# @overload delete_ai_prompt(params = {})
|
|
1824
|
+
# @param [Hash] params ({})
|
|
1825
|
+
def delete_ai_prompt(params = {}, options = {})
|
|
1826
|
+
req = build_request(:delete_ai_prompt, params)
|
|
1827
|
+
req.send_request(options)
|
|
1828
|
+
end
|
|
1829
|
+
|
|
1830
|
+
# Delete and Amazon Q in Connect AI Prompt version.
|
|
1831
|
+
#
|
|
1832
|
+
# @option params [required, String] :ai_prompt_id
|
|
1833
|
+
# The identifier of the Amazon Q in Connect AI prompt.
|
|
1834
|
+
#
|
|
1835
|
+
# @option params [required, String] :assistant_id
|
|
1836
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
1837
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
1838
|
+
#
|
|
1839
|
+
# @option params [required, Integer] :version_number
|
|
1840
|
+
# The version number of the AI Prompt version to be deleted.
|
|
1841
|
+
#
|
|
1842
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1843
|
+
#
|
|
1844
|
+
# @example Request syntax with placeholder values
|
|
1845
|
+
#
|
|
1846
|
+
# resp = client.delete_ai_prompt_version({
|
|
1847
|
+
# ai_prompt_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
1848
|
+
# assistant_id: "UuidOrArn", # required
|
|
1849
|
+
# version_number: 1, # required
|
|
1850
|
+
# })
|
|
1851
|
+
#
|
|
1852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIPromptVersion AWS API Documentation
|
|
1853
|
+
#
|
|
1854
|
+
# @overload delete_ai_prompt_version(params = {})
|
|
1855
|
+
# @param [Hash] params ({})
|
|
1856
|
+
def delete_ai_prompt_version(params = {}, options = {})
|
|
1857
|
+
req = build_request(:delete_ai_prompt_version, params)
|
|
1858
|
+
req.send_request(options)
|
|
1859
|
+
end
|
|
1860
|
+
|
|
1175
1861
|
# Deletes an assistant.
|
|
1176
1862
|
#
|
|
1177
1863
|
# @option params [required, String] :assistant_id
|
|
@@ -1382,6 +2068,142 @@ module Aws::QConnect
|
|
|
1382
2068
|
req.send_request(options)
|
|
1383
2069
|
end
|
|
1384
2070
|
|
|
2071
|
+
# Gets an Amazon Q in Connect AI Agent.
|
|
2072
|
+
#
|
|
2073
|
+
# @option params [required, String] :ai_agent_id
|
|
2074
|
+
# The identifier of the Amazon Q in Connect AI Agent (with or without a
|
|
2075
|
+
# version qualifier). Can be either the ID or the ARN. URLs cannot
|
|
2076
|
+
# contain the ARN.
|
|
2077
|
+
#
|
|
2078
|
+
# @option params [required, String] :assistant_id
|
|
2079
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
2080
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
2081
|
+
#
|
|
2082
|
+
# @return [Types::GetAIAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2083
|
+
#
|
|
2084
|
+
# * {Types::GetAIAgentResponse#ai_agent #ai_agent} => Types::AIAgentData
|
|
2085
|
+
# * {Types::GetAIAgentResponse#version_number #version_number} => Integer
|
|
2086
|
+
#
|
|
2087
|
+
# @example Request syntax with placeholder values
|
|
2088
|
+
#
|
|
2089
|
+
# resp = client.get_ai_agent({
|
|
2090
|
+
# ai_agent_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
2091
|
+
# assistant_id: "UuidOrArn", # required
|
|
2092
|
+
# })
|
|
2093
|
+
#
|
|
2094
|
+
# @example Response structure
|
|
2095
|
+
#
|
|
2096
|
+
# resp.ai_agent.ai_agent_arn #=> String
|
|
2097
|
+
# resp.ai_agent.ai_agent_id #=> String
|
|
2098
|
+
# resp.ai_agent.assistant_arn #=> String
|
|
2099
|
+
# resp.ai_agent.assistant_id #=> String
|
|
2100
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
2101
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
|
|
2102
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
2103
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
2104
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
2105
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
2106
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
2107
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
2108
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
2109
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
2110
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
2111
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
2112
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
2113
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
2114
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
2115
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
2116
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
2117
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
|
|
2118
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
|
|
2119
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
2120
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
|
|
2121
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
2122
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
2123
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
2124
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
2125
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
2126
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
2127
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
2128
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
2129
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
2130
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
2131
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
2132
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
2133
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
2134
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
2135
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
2136
|
+
# resp.ai_agent.description #=> String
|
|
2137
|
+
# resp.ai_agent.modified_time #=> Time
|
|
2138
|
+
# resp.ai_agent.name #=> String
|
|
2139
|
+
# resp.ai_agent.origin #=> String, one of "SYSTEM", "CUSTOMER"
|
|
2140
|
+
# resp.ai_agent.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
2141
|
+
# resp.ai_agent.tags #=> Hash
|
|
2142
|
+
# resp.ai_agent.tags["TagKey"] #=> String
|
|
2143
|
+
# resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION"
|
|
2144
|
+
# resp.ai_agent.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
2145
|
+
# resp.version_number #=> Integer
|
|
2146
|
+
#
|
|
2147
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAIAgent AWS API Documentation
|
|
2148
|
+
#
|
|
2149
|
+
# @overload get_ai_agent(params = {})
|
|
2150
|
+
# @param [Hash] params ({})
|
|
2151
|
+
def get_ai_agent(params = {}, options = {})
|
|
2152
|
+
req = build_request(:get_ai_agent, params)
|
|
2153
|
+
req.send_request(options)
|
|
2154
|
+
end
|
|
2155
|
+
|
|
2156
|
+
# Gets and Amazon Q in Connect AI Prompt.
|
|
2157
|
+
#
|
|
2158
|
+
# @option params [required, String] :ai_prompt_id
|
|
2159
|
+
# The identifier of the Amazon Q in Connect AI prompt.
|
|
2160
|
+
#
|
|
2161
|
+
# @option params [required, String] :assistant_id
|
|
2162
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
2163
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
2164
|
+
#
|
|
2165
|
+
# @return [Types::GetAIPromptResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2166
|
+
#
|
|
2167
|
+
# * {Types::GetAIPromptResponse#ai_prompt #ai_prompt} => Types::AIPromptData
|
|
2168
|
+
# * {Types::GetAIPromptResponse#version_number #version_number} => Integer
|
|
2169
|
+
#
|
|
2170
|
+
# @example Request syntax with placeholder values
|
|
2171
|
+
#
|
|
2172
|
+
# resp = client.get_ai_prompt({
|
|
2173
|
+
# ai_prompt_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
2174
|
+
# assistant_id: "UuidOrArn", # required
|
|
2175
|
+
# })
|
|
2176
|
+
#
|
|
2177
|
+
# @example Response structure
|
|
2178
|
+
#
|
|
2179
|
+
# resp.ai_prompt.ai_prompt_arn #=> String
|
|
2180
|
+
# resp.ai_prompt.ai_prompt_id #=> String
|
|
2181
|
+
# resp.ai_prompt.api_format #=> String, one of "ANTHROPIC_CLAUDE_MESSAGES", "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS"
|
|
2182
|
+
# resp.ai_prompt.assistant_arn #=> String
|
|
2183
|
+
# resp.ai_prompt.assistant_id #=> String
|
|
2184
|
+
# resp.ai_prompt.description #=> String
|
|
2185
|
+
# resp.ai_prompt.model_id #=> String
|
|
2186
|
+
# resp.ai_prompt.modified_time #=> Time
|
|
2187
|
+
# resp.ai_prompt.name #=> String
|
|
2188
|
+
# resp.ai_prompt.origin #=> String, one of "SYSTEM", "CUSTOMER"
|
|
2189
|
+
# resp.ai_prompt.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
2190
|
+
# resp.ai_prompt.tags #=> Hash
|
|
2191
|
+
# resp.ai_prompt.tags["TagKey"] #=> String
|
|
2192
|
+
# resp.ai_prompt.template_configuration.text_full_ai_prompt_edit_template_configuration.text #=> String
|
|
2193
|
+
# resp.ai_prompt.template_type #=> String, one of "TEXT"
|
|
2194
|
+
# resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION"
|
|
2195
|
+
# resp.ai_prompt.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
2196
|
+
# resp.version_number #=> Integer
|
|
2197
|
+
#
|
|
2198
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAIPrompt AWS API Documentation
|
|
2199
|
+
#
|
|
2200
|
+
# @overload get_ai_prompt(params = {})
|
|
2201
|
+
# @param [Hash] params ({})
|
|
2202
|
+
def get_ai_prompt(params = {}, options = {})
|
|
2203
|
+
req = build_request(:get_ai_prompt, params)
|
|
2204
|
+
req.send_request(options)
|
|
2205
|
+
end
|
|
2206
|
+
|
|
1385
2207
|
# Retrieves information about an assistant.
|
|
1386
2208
|
#
|
|
1387
2209
|
# @option params [required, String] :assistant_id
|
|
@@ -1400,6 +2222,8 @@ module Aws::QConnect
|
|
|
1400
2222
|
#
|
|
1401
2223
|
# @example Response structure
|
|
1402
2224
|
#
|
|
2225
|
+
# resp.assistant.ai_agent_configuration #=> Hash
|
|
2226
|
+
# resp.assistant.ai_agent_configuration["AIAgentType"].ai_agent_id #=> String
|
|
1403
2227
|
# resp.assistant.assistant_arn #=> String
|
|
1404
2228
|
# resp.assistant.assistant_id #=> String
|
|
1405
2229
|
# resp.assistant.capability_configuration.type #=> String, one of "V1", "V2"
|
|
@@ -1678,9 +2502,12 @@ module Aws::QConnect
|
|
|
1678
2502
|
# @example Response structure
|
|
1679
2503
|
#
|
|
1680
2504
|
# resp.knowledge_base.description #=> String
|
|
2505
|
+
# resp.knowledge_base.ingestion_failure_reasons #=> Array
|
|
2506
|
+
# resp.knowledge_base.ingestion_failure_reasons[0] #=> String
|
|
2507
|
+
# resp.knowledge_base.ingestion_status #=> String, one of "SYNC_FAILED", "SYNCING_IN_PROGRESS", "SYNC_SUCCESS", "CREATE_IN_PROGRESS"
|
|
1681
2508
|
# resp.knowledge_base.knowledge_base_arn #=> String
|
|
1682
2509
|
# resp.knowledge_base.knowledge_base_id #=> String
|
|
1683
|
-
# resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES"
|
|
2510
|
+
# resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES", "MESSAGE_TEMPLATES", "MANAGED"
|
|
1684
2511
|
# resp.knowledge_base.last_content_modification_time #=> Time
|
|
1685
2512
|
# resp.knowledge_base.name #=> String
|
|
1686
2513
|
# resp.knowledge_base.rendering_configuration.template_uri #=> String
|
|
@@ -1688,9 +2515,29 @@ module Aws::QConnect
|
|
|
1688
2515
|
# resp.knowledge_base.source_configuration.app_integrations.app_integration_arn #=> String
|
|
1689
2516
|
# resp.knowledge_base.source_configuration.app_integrations.object_fields #=> Array
|
|
1690
2517
|
# resp.knowledge_base.source_configuration.app_integrations.object_fields[0] #=> String
|
|
2518
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.crawler_limits.rate_limit #=> Integer
|
|
2519
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters #=> Array
|
|
2520
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters[0] #=> String
|
|
2521
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters #=> Array
|
|
2522
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters[0] #=> String
|
|
2523
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.scope #=> String, one of "HOST_ONLY", "SUBDOMAINS"
|
|
2524
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls #=> Array
|
|
2525
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls[0].url #=> String
|
|
1691
2526
|
# resp.knowledge_base.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
1692
2527
|
# resp.knowledge_base.tags #=> Hash
|
|
1693
2528
|
# resp.knowledge_base.tags["TagKey"] #=> String
|
|
2529
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.chunking_strategy #=> String, one of "FIXED_SIZE", "NONE", "HIERARCHICAL", "SEMANTIC"
|
|
2530
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.max_tokens #=> Integer
|
|
2531
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.overlap_percentage #=> Integer
|
|
2532
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations #=> Array
|
|
2533
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations[0].max_tokens #=> Integer
|
|
2534
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.overlap_tokens #=> Integer
|
|
2535
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.breakpoint_percentile_threshold #=> Integer
|
|
2536
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.buffer_size #=> Integer
|
|
2537
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.max_tokens #=> Integer
|
|
2538
|
+
# resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.model_arn #=> String
|
|
2539
|
+
# resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.parsing_prompt.parsing_prompt_text #=> String
|
|
2540
|
+
# resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.parsing_strategy #=> String, one of "BEDROCK_FOUNDATION_MODEL"
|
|
1694
2541
|
#
|
|
1695
2542
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetKnowledgeBase AWS API Documentation
|
|
1696
2543
|
#
|
|
@@ -1825,6 +2672,10 @@ module Aws::QConnect
|
|
|
1825
2672
|
# resp.recommendations[0].data.details.generative_data.ranking_data.relevance_score #=> Float
|
|
1826
2673
|
# resp.recommendations[0].data.details.generative_data.references #=> Array
|
|
1827
2674
|
# resp.recommendations[0].data.details.generative_data.references[0] #=> Types::DataSummary
|
|
2675
|
+
# resp.recommendations[0].data.details.intent_detected_data.intent #=> String
|
|
2676
|
+
# resp.recommendations[0].data.details.intent_detected_data.intent_id #=> String
|
|
2677
|
+
# resp.recommendations[0].data.details.source_content_data.citation_span.begin_offset_inclusive #=> Integer
|
|
2678
|
+
# resp.recommendations[0].data.details.source_content_data.citation_span.end_offset_exclusive #=> Integer
|
|
1828
2679
|
# resp.recommendations[0].data.details.source_content_data.id #=> String
|
|
1829
2680
|
# resp.recommendations[0].data.details.source_content_data.ranking_data.relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
|
|
1830
2681
|
# resp.recommendations[0].data.details.source_content_data.ranking_data.relevance_score #=> Float
|
|
@@ -1841,12 +2692,16 @@ module Aws::QConnect
|
|
|
1841
2692
|
# resp.recommendations[0].data.reference.content_reference.content_id #=> String
|
|
1842
2693
|
# resp.recommendations[0].data.reference.content_reference.knowledge_base_arn #=> String
|
|
1843
2694
|
# resp.recommendations[0].data.reference.content_reference.knowledge_base_id #=> String
|
|
2695
|
+
# resp.recommendations[0].data.reference.content_reference.reference_type #=> String, one of "WEB_CRAWLER", "KNOWLEDGE_BASE"
|
|
2696
|
+
# resp.recommendations[0].data.reference.content_reference.source_url #=> String
|
|
1844
2697
|
# resp.recommendations[0].data.reference.generative_reference.generation_id #=> String
|
|
1845
2698
|
# resp.recommendations[0].data.reference.generative_reference.model_id #=> String
|
|
1846
2699
|
# resp.recommendations[0].document.content_reference.content_arn #=> String
|
|
1847
2700
|
# resp.recommendations[0].document.content_reference.content_id #=> String
|
|
1848
2701
|
# resp.recommendations[0].document.content_reference.knowledge_base_arn #=> String
|
|
1849
2702
|
# resp.recommendations[0].document.content_reference.knowledge_base_id #=> String
|
|
2703
|
+
# resp.recommendations[0].document.content_reference.reference_type #=> String, one of "WEB_CRAWLER", "KNOWLEDGE_BASE"
|
|
2704
|
+
# resp.recommendations[0].document.content_reference.source_url #=> String
|
|
1850
2705
|
# resp.recommendations[0].document.excerpt.highlights #=> Array
|
|
1851
2706
|
# resp.recommendations[0].document.excerpt.highlights[0].begin_offset_inclusive #=> Integer
|
|
1852
2707
|
# resp.recommendations[0].document.excerpt.highlights[0].end_offset_exclusive #=> Integer
|
|
@@ -1858,7 +2713,7 @@ module Aws::QConnect
|
|
|
1858
2713
|
# resp.recommendations[0].recommendation_id #=> String
|
|
1859
2714
|
# resp.recommendations[0].relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
|
|
1860
2715
|
# resp.recommendations[0].relevance_score #=> Float
|
|
1861
|
-
# resp.recommendations[0].type #=> String, one of "KNOWLEDGE_CONTENT", "GENERATIVE_RESPONSE", "GENERATIVE_ANSWER"
|
|
2716
|
+
# resp.recommendations[0].type #=> String, one of "KNOWLEDGE_CONTENT", "GENERATIVE_RESPONSE", "GENERATIVE_ANSWER", "DETECTED_INTENT"
|
|
1862
2717
|
# resp.triggers #=> Array
|
|
1863
2718
|
# resp.triggers[0].data.query.text #=> String
|
|
1864
2719
|
# resp.triggers[0].id #=> String
|
|
@@ -1867,63 +2722,403 @@ module Aws::QConnect
|
|
|
1867
2722
|
# resp.triggers[0].source #=> String, one of "ISSUE_DETECTION", "RULE_EVALUATION", "OTHER"
|
|
1868
2723
|
# resp.triggers[0].type #=> String, one of "QUERY", "GENERATIVE"
|
|
1869
2724
|
#
|
|
1870
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetRecommendations AWS API Documentation
|
|
2725
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetRecommendations AWS API Documentation
|
|
2726
|
+
#
|
|
2727
|
+
# @overload get_recommendations(params = {})
|
|
2728
|
+
# @param [Hash] params ({})
|
|
2729
|
+
def get_recommendations(params = {}, options = {})
|
|
2730
|
+
req = build_request(:get_recommendations, params)
|
|
2731
|
+
req.send_request(options)
|
|
2732
|
+
end
|
|
2733
|
+
|
|
2734
|
+
# Retrieves information for a specified session.
|
|
2735
|
+
#
|
|
2736
|
+
# @option params [required, String] :assistant_id
|
|
2737
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
2738
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
2739
|
+
#
|
|
2740
|
+
# @option params [required, String] :session_id
|
|
2741
|
+
# The identifier of the session. Can be either the ID or the ARN. URLs
|
|
2742
|
+
# cannot contain the ARN.
|
|
2743
|
+
#
|
|
2744
|
+
# @return [Types::GetSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2745
|
+
#
|
|
2746
|
+
# * {Types::GetSessionResponse#session #session} => Types::SessionData
|
|
2747
|
+
#
|
|
2748
|
+
# @example Request syntax with placeholder values
|
|
2749
|
+
#
|
|
2750
|
+
# resp = client.get_session({
|
|
2751
|
+
# assistant_id: "UuidOrArn", # required
|
|
2752
|
+
# session_id: "UuidOrArn", # required
|
|
2753
|
+
# })
|
|
2754
|
+
#
|
|
2755
|
+
# @example Response structure
|
|
2756
|
+
#
|
|
2757
|
+
# resp.session.ai_agent_configuration #=> Hash
|
|
2758
|
+
# resp.session.ai_agent_configuration["AIAgentType"].ai_agent_id #=> String
|
|
2759
|
+
# resp.session.description #=> String
|
|
2760
|
+
# resp.session.integration_configuration.topic_integration_arn #=> String
|
|
2761
|
+
# resp.session.name #=> String
|
|
2762
|
+
# resp.session.session_arn #=> String
|
|
2763
|
+
# resp.session.session_id #=> String
|
|
2764
|
+
# resp.session.tag_filter.and_conditions #=> Array
|
|
2765
|
+
# resp.session.tag_filter.and_conditions[0].key #=> String
|
|
2766
|
+
# resp.session.tag_filter.and_conditions[0].value #=> String
|
|
2767
|
+
# resp.session.tag_filter.or_conditions #=> Array
|
|
2768
|
+
# resp.session.tag_filter.or_conditions[0].and_conditions #=> Array
|
|
2769
|
+
# resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
2770
|
+
# resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
2771
|
+
# resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
2772
|
+
# resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
2773
|
+
# resp.session.tag_filter.tag_condition.key #=> String
|
|
2774
|
+
# resp.session.tag_filter.tag_condition.value #=> String
|
|
2775
|
+
# resp.session.tags #=> Hash
|
|
2776
|
+
# resp.session.tags["TagKey"] #=> String
|
|
2777
|
+
#
|
|
2778
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetSession AWS API Documentation
|
|
2779
|
+
#
|
|
2780
|
+
# @overload get_session(params = {})
|
|
2781
|
+
# @param [Hash] params ({})
|
|
2782
|
+
def get_session(params = {}, options = {})
|
|
2783
|
+
req = build_request(:get_session, params)
|
|
2784
|
+
req.send_request(options)
|
|
2785
|
+
end
|
|
2786
|
+
|
|
2787
|
+
# List AI Agent versions.
|
|
2788
|
+
#
|
|
2789
|
+
# @option params [required, String] :ai_agent_id
|
|
2790
|
+
# The identifier of the Amazon Q in Connect AI Agent for which versions
|
|
2791
|
+
# are to be listed.
|
|
2792
|
+
#
|
|
2793
|
+
# @option params [required, String] :assistant_id
|
|
2794
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
2795
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
2796
|
+
#
|
|
2797
|
+
# @option params [Integer] :max_results
|
|
2798
|
+
# The maximum number of results to return per page.
|
|
2799
|
+
#
|
|
2800
|
+
# @option params [String] :next_token
|
|
2801
|
+
# The token for the next set of results. Use the value returned in the
|
|
2802
|
+
# previous response in the next request to retrieve the next set of
|
|
2803
|
+
# results.
|
|
2804
|
+
#
|
|
2805
|
+
# @option params [String] :origin
|
|
2806
|
+
# The origin of the AI Agent versions to be listed. `SYSTEM` for a
|
|
2807
|
+
# default AI Agent created by Q in Connect or `CUSTOMER` for an AI Agent
|
|
2808
|
+
# created by calling AI Agent creation APIs.
|
|
2809
|
+
#
|
|
2810
|
+
# @return [Types::ListAIAgentVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2811
|
+
#
|
|
2812
|
+
# * {Types::ListAIAgentVersionsResponse#ai_agent_version_summaries #ai_agent_version_summaries} => Array<Types::AIAgentVersionSummary>
|
|
2813
|
+
# * {Types::ListAIAgentVersionsResponse#next_token #next_token} => String
|
|
2814
|
+
#
|
|
2815
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
2816
|
+
#
|
|
2817
|
+
# @example Request syntax with placeholder values
|
|
2818
|
+
#
|
|
2819
|
+
# resp = client.list_ai_agent_versions({
|
|
2820
|
+
# ai_agent_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
2821
|
+
# assistant_id: "UuidOrArn", # required
|
|
2822
|
+
# max_results: 1,
|
|
2823
|
+
# next_token: "NextToken",
|
|
2824
|
+
# origin: "SYSTEM", # accepts SYSTEM, CUSTOMER
|
|
2825
|
+
# })
|
|
2826
|
+
#
|
|
2827
|
+
# @example Response structure
|
|
2828
|
+
#
|
|
2829
|
+
# resp.ai_agent_version_summaries #=> Array
|
|
2830
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.ai_agent_arn #=> String
|
|
2831
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.ai_agent_id #=> String
|
|
2832
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.assistant_arn #=> String
|
|
2833
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.assistant_id #=> String
|
|
2834
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
2835
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
|
|
2836
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
2837
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
2838
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
2839
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
2840
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
2841
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
2842
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
2843
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
2844
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
2845
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
2846
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
2847
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
2848
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
2849
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
2850
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
2851
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
|
|
2852
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
|
|
2853
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
2854
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
|
|
2855
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
2856
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
2857
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
2858
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
2859
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
2860
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
2861
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
2862
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
2863
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
2864
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
2865
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
2866
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
2867
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
2868
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
2869
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
2870
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.description #=> String
|
|
2871
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.modified_time #=> Time
|
|
2872
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.name #=> String
|
|
2873
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.origin #=> String, one of "SYSTEM", "CUSTOMER"
|
|
2874
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
2875
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.tags #=> Hash
|
|
2876
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.tags["TagKey"] #=> String
|
|
2877
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION"
|
|
2878
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
2879
|
+
# resp.ai_agent_version_summaries[0].version_number #=> Integer
|
|
2880
|
+
# resp.next_token #=> String
|
|
2881
|
+
#
|
|
2882
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentVersions AWS API Documentation
|
|
2883
|
+
#
|
|
2884
|
+
# @overload list_ai_agent_versions(params = {})
|
|
2885
|
+
# @param [Hash] params ({})
|
|
2886
|
+
def list_ai_agent_versions(params = {}, options = {})
|
|
2887
|
+
req = build_request(:list_ai_agent_versions, params)
|
|
2888
|
+
req.send_request(options)
|
|
2889
|
+
end
|
|
2890
|
+
|
|
2891
|
+
# Lists AI Agents.
|
|
2892
|
+
#
|
|
2893
|
+
# @option params [required, String] :assistant_id
|
|
2894
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
2895
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
2896
|
+
#
|
|
2897
|
+
# @option params [Integer] :max_results
|
|
2898
|
+
# The maximum number of results to return per page.
|
|
2899
|
+
#
|
|
2900
|
+
# @option params [String] :next_token
|
|
2901
|
+
# The token for the next set of results. Use the value returned in the
|
|
2902
|
+
# previous response in the next request to retrieve the next set of
|
|
2903
|
+
# results.
|
|
2904
|
+
#
|
|
2905
|
+
# @option params [String] :origin
|
|
2906
|
+
# The origin of the AI Agents to be listed. `SYSTEM` for a default AI
|
|
2907
|
+
# Agent created by Q in Connect or `CUSTOMER` for an AI Agent created by
|
|
2908
|
+
# calling AI Agent creation APIs.
|
|
2909
|
+
#
|
|
2910
|
+
# @return [Types::ListAIAgentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2911
|
+
#
|
|
2912
|
+
# * {Types::ListAIAgentsResponse#ai_agent_summaries #ai_agent_summaries} => Array<Types::AIAgentSummary>
|
|
2913
|
+
# * {Types::ListAIAgentsResponse#next_token #next_token} => String
|
|
2914
|
+
#
|
|
2915
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
2916
|
+
#
|
|
2917
|
+
# @example Request syntax with placeholder values
|
|
2918
|
+
#
|
|
2919
|
+
# resp = client.list_ai_agents({
|
|
2920
|
+
# assistant_id: "UuidOrArn", # required
|
|
2921
|
+
# max_results: 1,
|
|
2922
|
+
# next_token: "NextToken",
|
|
2923
|
+
# origin: "SYSTEM", # accepts SYSTEM, CUSTOMER
|
|
2924
|
+
# })
|
|
2925
|
+
#
|
|
2926
|
+
# @example Response structure
|
|
1871
2927
|
#
|
|
1872
|
-
#
|
|
2928
|
+
# resp.ai_agent_summaries #=> Array
|
|
2929
|
+
# resp.ai_agent_summaries[0].ai_agent_arn #=> String
|
|
2930
|
+
# resp.ai_agent_summaries[0].ai_agent_id #=> String
|
|
2931
|
+
# resp.ai_agent_summaries[0].assistant_arn #=> String
|
|
2932
|
+
# resp.ai_agent_summaries[0].assistant_id #=> String
|
|
2933
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
2934
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
|
|
2935
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
2936
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
2937
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
2938
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
2939
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
2940
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
2941
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
2942
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
2943
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
2944
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
2945
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
2946
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
2947
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
2948
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
2949
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
2950
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
|
|
2951
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
|
|
2952
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
2953
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
|
|
2954
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
2955
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
2956
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
2957
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
2958
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
2959
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
2960
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
2961
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
2962
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
2963
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
2964
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
2965
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
2966
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
2967
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
2968
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
2969
|
+
# resp.ai_agent_summaries[0].description #=> String
|
|
2970
|
+
# resp.ai_agent_summaries[0].modified_time #=> Time
|
|
2971
|
+
# resp.ai_agent_summaries[0].name #=> String
|
|
2972
|
+
# resp.ai_agent_summaries[0].origin #=> String, one of "SYSTEM", "CUSTOMER"
|
|
2973
|
+
# resp.ai_agent_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
2974
|
+
# resp.ai_agent_summaries[0].tags #=> Hash
|
|
2975
|
+
# resp.ai_agent_summaries[0].tags["TagKey"] #=> String
|
|
2976
|
+
# resp.ai_agent_summaries[0].type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION"
|
|
2977
|
+
# resp.ai_agent_summaries[0].visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
2978
|
+
# resp.next_token #=> String
|
|
2979
|
+
#
|
|
2980
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgents AWS API Documentation
|
|
2981
|
+
#
|
|
2982
|
+
# @overload list_ai_agents(params = {})
|
|
1873
2983
|
# @param [Hash] params ({})
|
|
1874
|
-
def
|
|
1875
|
-
req = build_request(:
|
|
2984
|
+
def list_ai_agents(params = {}, options = {})
|
|
2985
|
+
req = build_request(:list_ai_agents, params)
|
|
1876
2986
|
req.send_request(options)
|
|
1877
2987
|
end
|
|
1878
2988
|
|
|
1879
|
-
#
|
|
2989
|
+
# Lists AI Prompt versions.
|
|
2990
|
+
#
|
|
2991
|
+
# @option params [required, String] :ai_prompt_id
|
|
2992
|
+
# The identifier of the Amazon Q in Connect AI prompt for which versions
|
|
2993
|
+
# are to be listed.
|
|
1880
2994
|
#
|
|
1881
2995
|
# @option params [required, String] :assistant_id
|
|
1882
2996
|
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
1883
2997
|
# ID or the ARN. URLs cannot contain the ARN.
|
|
1884
2998
|
#
|
|
1885
|
-
# @option params [
|
|
1886
|
-
# The
|
|
1887
|
-
# cannot contain the ARN.
|
|
2999
|
+
# @option params [Integer] :max_results
|
|
3000
|
+
# The maximum number of results to return per page.
|
|
1888
3001
|
#
|
|
1889
|
-
# @
|
|
3002
|
+
# @option params [String] :next_token
|
|
3003
|
+
# The token for the next set of results. Use the value returned in the
|
|
3004
|
+
# previous response in the next request to retrieve the next set of
|
|
3005
|
+
# results.
|
|
1890
3006
|
#
|
|
1891
|
-
#
|
|
3007
|
+
# @option params [String] :origin
|
|
3008
|
+
# The origin of the AI Prompt versions to be listed. `SYSTEM` for a
|
|
3009
|
+
# default AI Agent created by Q in Connect or `CUSTOMER` for an AI Agent
|
|
3010
|
+
# created by calling AI Agent creation APIs.
|
|
3011
|
+
#
|
|
3012
|
+
# @return [Types::ListAIPromptVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3013
|
+
#
|
|
3014
|
+
# * {Types::ListAIPromptVersionsResponse#ai_prompt_version_summaries #ai_prompt_version_summaries} => Array<Types::AIPromptVersionSummary>
|
|
3015
|
+
# * {Types::ListAIPromptVersionsResponse#next_token #next_token} => String
|
|
3016
|
+
#
|
|
3017
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1892
3018
|
#
|
|
1893
3019
|
# @example Request syntax with placeholder values
|
|
1894
3020
|
#
|
|
1895
|
-
# resp = client.
|
|
3021
|
+
# resp = client.list_ai_prompt_versions({
|
|
3022
|
+
# ai_prompt_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
1896
3023
|
# assistant_id: "UuidOrArn", # required
|
|
1897
|
-
#
|
|
3024
|
+
# max_results: 1,
|
|
3025
|
+
# next_token: "NextToken",
|
|
3026
|
+
# origin: "SYSTEM", # accepts SYSTEM, CUSTOMER
|
|
1898
3027
|
# })
|
|
1899
3028
|
#
|
|
1900
3029
|
# @example Response structure
|
|
1901
3030
|
#
|
|
1902
|
-
# resp.
|
|
1903
|
-
# resp.
|
|
1904
|
-
# resp.
|
|
1905
|
-
# resp.
|
|
1906
|
-
# resp.
|
|
1907
|
-
# resp.
|
|
1908
|
-
# resp.
|
|
1909
|
-
# resp.
|
|
1910
|
-
# resp.
|
|
1911
|
-
# resp.
|
|
1912
|
-
# resp.
|
|
1913
|
-
# resp.
|
|
1914
|
-
# resp.
|
|
1915
|
-
# resp.
|
|
1916
|
-
# resp.
|
|
1917
|
-
# resp.
|
|
1918
|
-
# resp.
|
|
1919
|
-
# resp.
|
|
3031
|
+
# resp.ai_prompt_version_summaries #=> Array
|
|
3032
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.ai_prompt_arn #=> String
|
|
3033
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.ai_prompt_id #=> String
|
|
3034
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.api_format #=> String, one of "ANTHROPIC_CLAUDE_MESSAGES", "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS"
|
|
3035
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.assistant_arn #=> String
|
|
3036
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.assistant_id #=> String
|
|
3037
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.description #=> String
|
|
3038
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.model_id #=> String
|
|
3039
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.modified_time #=> Time
|
|
3040
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.name #=> String
|
|
3041
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.origin #=> String, one of "SYSTEM", "CUSTOMER"
|
|
3042
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
3043
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.tags #=> Hash
|
|
3044
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.tags["TagKey"] #=> String
|
|
3045
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.template_type #=> String, one of "TEXT"
|
|
3046
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION"
|
|
3047
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
3048
|
+
# resp.ai_prompt_version_summaries[0].version_number #=> Integer
|
|
3049
|
+
# resp.next_token #=> String
|
|
1920
3050
|
#
|
|
1921
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/
|
|
3051
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIPromptVersions AWS API Documentation
|
|
1922
3052
|
#
|
|
1923
|
-
# @overload
|
|
3053
|
+
# @overload list_ai_prompt_versions(params = {})
|
|
1924
3054
|
# @param [Hash] params ({})
|
|
1925
|
-
def
|
|
1926
|
-
req = build_request(:
|
|
3055
|
+
def list_ai_prompt_versions(params = {}, options = {})
|
|
3056
|
+
req = build_request(:list_ai_prompt_versions, params)
|
|
3057
|
+
req.send_request(options)
|
|
3058
|
+
end
|
|
3059
|
+
|
|
3060
|
+
# Lists the AI Prompts available on the Amazon Q in Connect assistant.
|
|
3061
|
+
#
|
|
3062
|
+
# @option params [required, String] :assistant_id
|
|
3063
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
3064
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
3065
|
+
#
|
|
3066
|
+
# @option params [Integer] :max_results
|
|
3067
|
+
# The maximum number of results to return per page.
|
|
3068
|
+
#
|
|
3069
|
+
# @option params [String] :next_token
|
|
3070
|
+
# The token for the next set of results. Use the value returned in the
|
|
3071
|
+
# previous response in the next request to retrieve the next set of
|
|
3072
|
+
# results.
|
|
3073
|
+
#
|
|
3074
|
+
# @option params [String] :origin
|
|
3075
|
+
# The origin of the AI Prompts to be listed. `SYSTEM` for a default AI
|
|
3076
|
+
# Agent created by Q in Connect or `CUSTOMER` for an AI Agent created by
|
|
3077
|
+
# calling AI Agent creation APIs.
|
|
3078
|
+
#
|
|
3079
|
+
# @return [Types::ListAIPromptsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3080
|
+
#
|
|
3081
|
+
# * {Types::ListAIPromptsResponse#ai_prompt_summaries #ai_prompt_summaries} => Array<Types::AIPromptSummary>
|
|
3082
|
+
# * {Types::ListAIPromptsResponse#next_token #next_token} => String
|
|
3083
|
+
#
|
|
3084
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
3085
|
+
#
|
|
3086
|
+
# @example Request syntax with placeholder values
|
|
3087
|
+
#
|
|
3088
|
+
# resp = client.list_ai_prompts({
|
|
3089
|
+
# assistant_id: "UuidOrArn", # required
|
|
3090
|
+
# max_results: 1,
|
|
3091
|
+
# next_token: "NextToken",
|
|
3092
|
+
# origin: "SYSTEM", # accepts SYSTEM, CUSTOMER
|
|
3093
|
+
# })
|
|
3094
|
+
#
|
|
3095
|
+
# @example Response structure
|
|
3096
|
+
#
|
|
3097
|
+
# resp.ai_prompt_summaries #=> Array
|
|
3098
|
+
# resp.ai_prompt_summaries[0].ai_prompt_arn #=> String
|
|
3099
|
+
# resp.ai_prompt_summaries[0].ai_prompt_id #=> String
|
|
3100
|
+
# resp.ai_prompt_summaries[0].api_format #=> String, one of "ANTHROPIC_CLAUDE_MESSAGES", "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS"
|
|
3101
|
+
# resp.ai_prompt_summaries[0].assistant_arn #=> String
|
|
3102
|
+
# resp.ai_prompt_summaries[0].assistant_id #=> String
|
|
3103
|
+
# resp.ai_prompt_summaries[0].description #=> String
|
|
3104
|
+
# resp.ai_prompt_summaries[0].model_id #=> String
|
|
3105
|
+
# resp.ai_prompt_summaries[0].modified_time #=> Time
|
|
3106
|
+
# resp.ai_prompt_summaries[0].name #=> String
|
|
3107
|
+
# resp.ai_prompt_summaries[0].origin #=> String, one of "SYSTEM", "CUSTOMER"
|
|
3108
|
+
# resp.ai_prompt_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
3109
|
+
# resp.ai_prompt_summaries[0].tags #=> Hash
|
|
3110
|
+
# resp.ai_prompt_summaries[0].tags["TagKey"] #=> String
|
|
3111
|
+
# resp.ai_prompt_summaries[0].template_type #=> String, one of "TEXT"
|
|
3112
|
+
# resp.ai_prompt_summaries[0].type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION"
|
|
3113
|
+
# resp.ai_prompt_summaries[0].visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
3114
|
+
# resp.next_token #=> String
|
|
3115
|
+
#
|
|
3116
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIPrompts AWS API Documentation
|
|
3117
|
+
#
|
|
3118
|
+
# @overload list_ai_prompts(params = {})
|
|
3119
|
+
# @param [Hash] params ({})
|
|
3120
|
+
def list_ai_prompts(params = {}, options = {})
|
|
3121
|
+
req = build_request(:list_ai_prompts, params)
|
|
1927
3122
|
req.send_request(options)
|
|
1928
3123
|
end
|
|
1929
3124
|
|
|
@@ -2006,6 +3201,8 @@ module Aws::QConnect
|
|
|
2006
3201
|
# @example Response structure
|
|
2007
3202
|
#
|
|
2008
3203
|
# resp.assistant_summaries #=> Array
|
|
3204
|
+
# resp.assistant_summaries[0].ai_agent_configuration #=> Hash
|
|
3205
|
+
# resp.assistant_summaries[0].ai_agent_configuration["AIAgentType"].ai_agent_id #=> String
|
|
2009
3206
|
# resp.assistant_summaries[0].assistant_arn #=> String
|
|
2010
3207
|
# resp.assistant_summaries[0].assistant_id #=> String
|
|
2011
3208
|
# resp.assistant_summaries[0].capability_configuration.type #=> String, one of "V1", "V2"
|
|
@@ -2234,16 +3431,36 @@ module Aws::QConnect
|
|
|
2234
3431
|
# resp.knowledge_base_summaries[0].description #=> String
|
|
2235
3432
|
# resp.knowledge_base_summaries[0].knowledge_base_arn #=> String
|
|
2236
3433
|
# resp.knowledge_base_summaries[0].knowledge_base_id #=> String
|
|
2237
|
-
# resp.knowledge_base_summaries[0].knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES"
|
|
3434
|
+
# resp.knowledge_base_summaries[0].knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES", "MESSAGE_TEMPLATES", "MANAGED"
|
|
2238
3435
|
# resp.knowledge_base_summaries[0].name #=> String
|
|
2239
3436
|
# resp.knowledge_base_summaries[0].rendering_configuration.template_uri #=> String
|
|
2240
3437
|
# resp.knowledge_base_summaries[0].server_side_encryption_configuration.kms_key_id #=> String
|
|
2241
3438
|
# resp.knowledge_base_summaries[0].source_configuration.app_integrations.app_integration_arn #=> String
|
|
2242
3439
|
# resp.knowledge_base_summaries[0].source_configuration.app_integrations.object_fields #=> Array
|
|
2243
3440
|
# resp.knowledge_base_summaries[0].source_configuration.app_integrations.object_fields[0] #=> String
|
|
3441
|
+
# resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.crawler_limits.rate_limit #=> Integer
|
|
3442
|
+
# resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters #=> Array
|
|
3443
|
+
# resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters[0] #=> String
|
|
3444
|
+
# resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters #=> Array
|
|
3445
|
+
# resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters[0] #=> String
|
|
3446
|
+
# resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.scope #=> String, one of "HOST_ONLY", "SUBDOMAINS"
|
|
3447
|
+
# resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls #=> Array
|
|
3448
|
+
# resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls[0].url #=> String
|
|
2244
3449
|
# resp.knowledge_base_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
2245
3450
|
# resp.knowledge_base_summaries[0].tags #=> Hash
|
|
2246
3451
|
# resp.knowledge_base_summaries[0].tags["TagKey"] #=> String
|
|
3452
|
+
# resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.chunking_strategy #=> String, one of "FIXED_SIZE", "NONE", "HIERARCHICAL", "SEMANTIC"
|
|
3453
|
+
# resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.max_tokens #=> Integer
|
|
3454
|
+
# resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.overlap_percentage #=> Integer
|
|
3455
|
+
# resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations #=> Array
|
|
3456
|
+
# resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations[0].max_tokens #=> Integer
|
|
3457
|
+
# resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.overlap_tokens #=> Integer
|
|
3458
|
+
# resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.breakpoint_percentile_threshold #=> Integer
|
|
3459
|
+
# resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.buffer_size #=> Integer
|
|
3460
|
+
# resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.max_tokens #=> Integer
|
|
3461
|
+
# resp.knowledge_base_summaries[0].vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.model_arn #=> String
|
|
3462
|
+
# resp.knowledge_base_summaries[0].vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.parsing_prompt.parsing_prompt_text #=> String
|
|
3463
|
+
# resp.knowledge_base_summaries[0].vector_ingestion_configuration.parsing_configuration.parsing_strategy #=> String, one of "BEDROCK_FOUNDATION_MODEL"
|
|
2247
3464
|
# resp.next_token #=> String
|
|
2248
3465
|
#
|
|
2249
3466
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListKnowledgeBases AWS API Documentation
|
|
@@ -2471,10 +3688,18 @@ module Aws::QConnect
|
|
|
2471
3688
|
# previous response in the next request to retrieve the next set of
|
|
2472
3689
|
# results.
|
|
2473
3690
|
#
|
|
3691
|
+
# @option params [String] :override_knowledge_base_search_type
|
|
3692
|
+
# The search type to be used against the Knowledge Base for this
|
|
3693
|
+
# request. The values can be `SEMANTIC` which uses vector embeddings or
|
|
3694
|
+
# `HYBRID` which use vector embeddings and raw text.
|
|
3695
|
+
#
|
|
2474
3696
|
# @option params [Array<Types::QueryCondition>] :query_condition
|
|
2475
3697
|
# Information about how to query content.
|
|
2476
3698
|
#
|
|
2477
|
-
# @option params [
|
|
3699
|
+
# @option params [Types::QueryInputData] :query_input_data
|
|
3700
|
+
# Information about the query.
|
|
3701
|
+
#
|
|
3702
|
+
# @option params [String] :query_text
|
|
2478
3703
|
# The text to search for.
|
|
2479
3704
|
#
|
|
2480
3705
|
# @option params [String] :session_id
|
|
@@ -2494,6 +3719,7 @@ module Aws::QConnect
|
|
|
2494
3719
|
# assistant_id: "UuidOrArn", # required
|
|
2495
3720
|
# max_results: 1,
|
|
2496
3721
|
# next_token: "NextToken",
|
|
3722
|
+
# override_knowledge_base_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
|
|
2497
3723
|
# query_condition: [
|
|
2498
3724
|
# {
|
|
2499
3725
|
# single: {
|
|
@@ -2503,7 +3729,15 @@ module Aws::QConnect
|
|
|
2503
3729
|
# },
|
|
2504
3730
|
# },
|
|
2505
3731
|
# ],
|
|
2506
|
-
#
|
|
3732
|
+
# query_input_data: {
|
|
3733
|
+
# intent_input_data: {
|
|
3734
|
+
# intent_id: "Uuid", # required
|
|
3735
|
+
# },
|
|
3736
|
+
# query_text_input_data: {
|
|
3737
|
+
# text: "QueryText", # required
|
|
3738
|
+
# },
|
|
3739
|
+
# },
|
|
3740
|
+
# query_text: "QueryText",
|
|
2507
3741
|
# session_id: "UuidOrArn",
|
|
2508
3742
|
# })
|
|
2509
3743
|
#
|
|
@@ -2526,6 +3760,10 @@ module Aws::QConnect
|
|
|
2526
3760
|
# resp.results[0].data.details.generative_data.ranking_data.relevance_score #=> Float
|
|
2527
3761
|
# resp.results[0].data.details.generative_data.references #=> Array
|
|
2528
3762
|
# resp.results[0].data.details.generative_data.references[0] #=> Types::DataSummary
|
|
3763
|
+
# resp.results[0].data.details.intent_detected_data.intent #=> String
|
|
3764
|
+
# resp.results[0].data.details.intent_detected_data.intent_id #=> String
|
|
3765
|
+
# resp.results[0].data.details.source_content_data.citation_span.begin_offset_inclusive #=> Integer
|
|
3766
|
+
# resp.results[0].data.details.source_content_data.citation_span.end_offset_exclusive #=> Integer
|
|
2529
3767
|
# resp.results[0].data.details.source_content_data.id #=> String
|
|
2530
3768
|
# resp.results[0].data.details.source_content_data.ranking_data.relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
|
|
2531
3769
|
# resp.results[0].data.details.source_content_data.ranking_data.relevance_score #=> Float
|
|
@@ -2542,12 +3780,16 @@ module Aws::QConnect
|
|
|
2542
3780
|
# resp.results[0].data.reference.content_reference.content_id #=> String
|
|
2543
3781
|
# resp.results[0].data.reference.content_reference.knowledge_base_arn #=> String
|
|
2544
3782
|
# resp.results[0].data.reference.content_reference.knowledge_base_id #=> String
|
|
3783
|
+
# resp.results[0].data.reference.content_reference.reference_type #=> String, one of "WEB_CRAWLER", "KNOWLEDGE_BASE"
|
|
3784
|
+
# resp.results[0].data.reference.content_reference.source_url #=> String
|
|
2545
3785
|
# resp.results[0].data.reference.generative_reference.generation_id #=> String
|
|
2546
3786
|
# resp.results[0].data.reference.generative_reference.model_id #=> String
|
|
2547
3787
|
# resp.results[0].document.content_reference.content_arn #=> String
|
|
2548
3788
|
# resp.results[0].document.content_reference.content_id #=> String
|
|
2549
3789
|
# resp.results[0].document.content_reference.knowledge_base_arn #=> String
|
|
2550
3790
|
# resp.results[0].document.content_reference.knowledge_base_id #=> String
|
|
3791
|
+
# resp.results[0].document.content_reference.reference_type #=> String, one of "WEB_CRAWLER", "KNOWLEDGE_BASE"
|
|
3792
|
+
# resp.results[0].document.content_reference.source_url #=> String
|
|
2551
3793
|
# resp.results[0].document.excerpt.highlights #=> Array
|
|
2552
3794
|
# resp.results[0].document.excerpt.highlights[0].begin_offset_inclusive #=> Integer
|
|
2553
3795
|
# resp.results[0].document.excerpt.highlights[0].end_offset_exclusive #=> Integer
|
|
@@ -2558,7 +3800,7 @@ module Aws::QConnect
|
|
|
2558
3800
|
# resp.results[0].document.title.text #=> String
|
|
2559
3801
|
# resp.results[0].relevance_score #=> Float
|
|
2560
3802
|
# resp.results[0].result_id #=> String
|
|
2561
|
-
# resp.results[0].type #=> String, one of "KNOWLEDGE_CONTENT", "GENERATIVE_ANSWER"
|
|
3803
|
+
# resp.results[0].type #=> String, one of "KNOWLEDGE_CONTENT", "INTENT_ANSWER", "GENERATIVE_ANSWER"
|
|
2562
3804
|
#
|
|
2563
3805
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QueryAssistant AWS API Documentation
|
|
2564
3806
|
#
|
|
@@ -2569,6 +3811,35 @@ module Aws::QConnect
|
|
|
2569
3811
|
req.send_request(options)
|
|
2570
3812
|
end
|
|
2571
3813
|
|
|
3814
|
+
# Removes the AI Agent that is set for use by defafult on an Amazon Q in
|
|
3815
|
+
# Connect Assistant.
|
|
3816
|
+
#
|
|
3817
|
+
# @option params [required, String] :ai_agent_type
|
|
3818
|
+
# The type of the AI Agent being removed for use by default from the
|
|
3819
|
+
# Amazon Q in Connect Assistant.
|
|
3820
|
+
#
|
|
3821
|
+
# @option params [required, String] :assistant_id
|
|
3822
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
3823
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
3824
|
+
#
|
|
3825
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3826
|
+
#
|
|
3827
|
+
# @example Request syntax with placeholder values
|
|
3828
|
+
#
|
|
3829
|
+
# resp = client.remove_assistant_ai_agent({
|
|
3830
|
+
# ai_agent_type: "MANUAL_SEARCH", # required, accepts MANUAL_SEARCH, ANSWER_RECOMMENDATION
|
|
3831
|
+
# assistant_id: "UuidOrArn", # required
|
|
3832
|
+
# })
|
|
3833
|
+
#
|
|
3834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RemoveAssistantAIAgent AWS API Documentation
|
|
3835
|
+
#
|
|
3836
|
+
# @overload remove_assistant_ai_agent(params = {})
|
|
3837
|
+
# @param [Hash] params ({})
|
|
3838
|
+
def remove_assistant_ai_agent(params = {}, options = {})
|
|
3839
|
+
req = build_request(:remove_assistant_ai_agent, params)
|
|
3840
|
+
req.send_request(options)
|
|
3841
|
+
end
|
|
3842
|
+
|
|
2572
3843
|
# Removes a URI template from a knowledge base.
|
|
2573
3844
|
#
|
|
2574
3845
|
# @option params [required, String] :knowledge_base_id
|
|
@@ -3045,6 +4316,331 @@ module Aws::QConnect
|
|
|
3045
4316
|
req.send_request(options)
|
|
3046
4317
|
end
|
|
3047
4318
|
|
|
4319
|
+
# Updates an AI Agent.
|
|
4320
|
+
#
|
|
4321
|
+
# @option params [required, String] :ai_agent_id
|
|
4322
|
+
# The identifier of the Amazon Q in Connect AI Agent.
|
|
4323
|
+
#
|
|
4324
|
+
# @option params [required, String] :assistant_id
|
|
4325
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
4326
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
4327
|
+
#
|
|
4328
|
+
# @option params [String] :client_token
|
|
4329
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
4330
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
|
4331
|
+
# this field. For more information about idempotency, see [Making
|
|
4332
|
+
# retries safe with idempotent APIs][1].
|
|
4333
|
+
#
|
|
4334
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
4335
|
+
# not need to pass this option.**
|
|
4336
|
+
#
|
|
4337
|
+
#
|
|
4338
|
+
#
|
|
4339
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
4340
|
+
#
|
|
4341
|
+
# @option params [Types::AIAgentConfiguration] :configuration
|
|
4342
|
+
# The configuration of the Amazon Q in Connect AI Agent.
|
|
4343
|
+
#
|
|
4344
|
+
# @option params [String] :description
|
|
4345
|
+
# The description of the Amazon Q in Connect AI Agent.
|
|
4346
|
+
#
|
|
4347
|
+
# @option params [required, String] :visibility_status
|
|
4348
|
+
# The visbility status of the Amazon Q in Connect AI Agent.
|
|
4349
|
+
#
|
|
4350
|
+
# @return [Types::UpdateAIAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4351
|
+
#
|
|
4352
|
+
# * {Types::UpdateAIAgentResponse#ai_agent #ai_agent} => Types::AIAgentData
|
|
4353
|
+
#
|
|
4354
|
+
# @example Request syntax with placeholder values
|
|
4355
|
+
#
|
|
4356
|
+
# resp = client.update_ai_agent({
|
|
4357
|
+
# ai_agent_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
4358
|
+
# assistant_id: "UuidOrArn", # required
|
|
4359
|
+
# client_token: "ClientToken",
|
|
4360
|
+
# configuration: {
|
|
4361
|
+
# answer_recommendation_ai_agent_configuration: {
|
|
4362
|
+
# answer_generation_ai_prompt_id: "UuidWithQualifier",
|
|
4363
|
+
# association_configurations: [
|
|
4364
|
+
# {
|
|
4365
|
+
# association_configuration_data: {
|
|
4366
|
+
# knowledge_base_association_configuration_data: {
|
|
4367
|
+
# content_tag_filter: {
|
|
4368
|
+
# and_conditions: [
|
|
4369
|
+
# {
|
|
4370
|
+
# key: "TagKey", # required
|
|
4371
|
+
# value: "TagValue",
|
|
4372
|
+
# },
|
|
4373
|
+
# ],
|
|
4374
|
+
# or_conditions: [
|
|
4375
|
+
# {
|
|
4376
|
+
# and_conditions: [
|
|
4377
|
+
# {
|
|
4378
|
+
# key: "TagKey", # required
|
|
4379
|
+
# value: "TagValue",
|
|
4380
|
+
# },
|
|
4381
|
+
# ],
|
|
4382
|
+
# tag_condition: {
|
|
4383
|
+
# key: "TagKey", # required
|
|
4384
|
+
# value: "TagValue",
|
|
4385
|
+
# },
|
|
4386
|
+
# },
|
|
4387
|
+
# ],
|
|
4388
|
+
# tag_condition: {
|
|
4389
|
+
# key: "TagKey", # required
|
|
4390
|
+
# value: "TagValue",
|
|
4391
|
+
# },
|
|
4392
|
+
# },
|
|
4393
|
+
# max_results: 1,
|
|
4394
|
+
# override_knowledge_base_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
|
|
4395
|
+
# },
|
|
4396
|
+
# },
|
|
4397
|
+
# association_id: "Uuid",
|
|
4398
|
+
# association_type: "KNOWLEDGE_BASE", # accepts KNOWLEDGE_BASE
|
|
4399
|
+
# },
|
|
4400
|
+
# ],
|
|
4401
|
+
# intent_labeling_generation_ai_prompt_id: "UuidWithQualifier",
|
|
4402
|
+
# query_reformulation_ai_prompt_id: "UuidWithQualifier",
|
|
4403
|
+
# },
|
|
4404
|
+
# manual_search_ai_agent_configuration: {
|
|
4405
|
+
# answer_generation_ai_prompt_id: "UuidWithQualifier",
|
|
4406
|
+
# association_configurations: [
|
|
4407
|
+
# {
|
|
4408
|
+
# association_configuration_data: {
|
|
4409
|
+
# knowledge_base_association_configuration_data: {
|
|
4410
|
+
# content_tag_filter: {
|
|
4411
|
+
# and_conditions: [
|
|
4412
|
+
# {
|
|
4413
|
+
# key: "TagKey", # required
|
|
4414
|
+
# value: "TagValue",
|
|
4415
|
+
# },
|
|
4416
|
+
# ],
|
|
4417
|
+
# or_conditions: [
|
|
4418
|
+
# {
|
|
4419
|
+
# and_conditions: [
|
|
4420
|
+
# {
|
|
4421
|
+
# key: "TagKey", # required
|
|
4422
|
+
# value: "TagValue",
|
|
4423
|
+
# },
|
|
4424
|
+
# ],
|
|
4425
|
+
# tag_condition: {
|
|
4426
|
+
# key: "TagKey", # required
|
|
4427
|
+
# value: "TagValue",
|
|
4428
|
+
# },
|
|
4429
|
+
# },
|
|
4430
|
+
# ],
|
|
4431
|
+
# tag_condition: {
|
|
4432
|
+
# key: "TagKey", # required
|
|
4433
|
+
# value: "TagValue",
|
|
4434
|
+
# },
|
|
4435
|
+
# },
|
|
4436
|
+
# max_results: 1,
|
|
4437
|
+
# override_knowledge_base_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
|
|
4438
|
+
# },
|
|
4439
|
+
# },
|
|
4440
|
+
# association_id: "Uuid",
|
|
4441
|
+
# association_type: "KNOWLEDGE_BASE", # accepts KNOWLEDGE_BASE
|
|
4442
|
+
# },
|
|
4443
|
+
# ],
|
|
4444
|
+
# },
|
|
4445
|
+
# },
|
|
4446
|
+
# description: "Description",
|
|
4447
|
+
# visibility_status: "SAVED", # required, accepts SAVED, PUBLISHED
|
|
4448
|
+
# })
|
|
4449
|
+
#
|
|
4450
|
+
# @example Response structure
|
|
4451
|
+
#
|
|
4452
|
+
# resp.ai_agent.ai_agent_arn #=> String
|
|
4453
|
+
# resp.ai_agent.ai_agent_id #=> String
|
|
4454
|
+
# resp.ai_agent.assistant_arn #=> String
|
|
4455
|
+
# resp.ai_agent.assistant_id #=> String
|
|
4456
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
4457
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
|
|
4458
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
4459
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
4460
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
4461
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
4462
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
4463
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
4464
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
4465
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
4466
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
4467
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
4468
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
4469
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
4470
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
4471
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
4472
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
4473
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
|
|
4474
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
|
|
4475
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
4476
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
|
|
4477
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
4478
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
4479
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
4480
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
4481
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
4482
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
4483
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
4484
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
4485
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
4486
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
4487
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
4488
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
4489
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
4490
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
4491
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
4492
|
+
# resp.ai_agent.description #=> String
|
|
4493
|
+
# resp.ai_agent.modified_time #=> Time
|
|
4494
|
+
# resp.ai_agent.name #=> String
|
|
4495
|
+
# resp.ai_agent.origin #=> String, one of "SYSTEM", "CUSTOMER"
|
|
4496
|
+
# resp.ai_agent.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
4497
|
+
# resp.ai_agent.tags #=> Hash
|
|
4498
|
+
# resp.ai_agent.tags["TagKey"] #=> String
|
|
4499
|
+
# resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION"
|
|
4500
|
+
# resp.ai_agent.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
4501
|
+
#
|
|
4502
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAIAgent AWS API Documentation
|
|
4503
|
+
#
|
|
4504
|
+
# @overload update_ai_agent(params = {})
|
|
4505
|
+
# @param [Hash] params ({})
|
|
4506
|
+
def update_ai_agent(params = {}, options = {})
|
|
4507
|
+
req = build_request(:update_ai_agent, params)
|
|
4508
|
+
req.send_request(options)
|
|
4509
|
+
end
|
|
4510
|
+
|
|
4511
|
+
# Updates an AI Prompt.
|
|
4512
|
+
#
|
|
4513
|
+
# @option params [required, String] :ai_prompt_id
|
|
4514
|
+
# The identifier of the Amazon Q in Connect AI Prompt.
|
|
4515
|
+
#
|
|
4516
|
+
# @option params [required, String] :assistant_id
|
|
4517
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
4518
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
4519
|
+
#
|
|
4520
|
+
# @option params [String] :client_token
|
|
4521
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
4522
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
|
4523
|
+
# this field. For more information about idempotency, see [Making
|
|
4524
|
+
# retries safe with idempotent APIs][1].
|
|
4525
|
+
#
|
|
4526
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
4527
|
+
# not need to pass this option.**
|
|
4528
|
+
#
|
|
4529
|
+
#
|
|
4530
|
+
#
|
|
4531
|
+
# [1]: http://aws.amazon.com/https:/aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
4532
|
+
#
|
|
4533
|
+
# @option params [String] :description
|
|
4534
|
+
# The description of the Amazon Q in Connect AI Prompt.
|
|
4535
|
+
#
|
|
4536
|
+
# @option params [Types::AIPromptTemplateConfiguration] :template_configuration
|
|
4537
|
+
# The configuration of the prompt template for this AI Prompt.
|
|
4538
|
+
#
|
|
4539
|
+
# @option params [required, String] :visibility_status
|
|
4540
|
+
# The visibility status of the Amazon Q in Connect AI prompt.
|
|
4541
|
+
#
|
|
4542
|
+
# @return [Types::UpdateAIPromptResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4543
|
+
#
|
|
4544
|
+
# * {Types::UpdateAIPromptResponse#ai_prompt #ai_prompt} => Types::AIPromptData
|
|
4545
|
+
#
|
|
4546
|
+
# @example Request syntax with placeholder values
|
|
4547
|
+
#
|
|
4548
|
+
# resp = client.update_ai_prompt({
|
|
4549
|
+
# ai_prompt_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
4550
|
+
# assistant_id: "UuidOrArn", # required
|
|
4551
|
+
# client_token: "ClientToken",
|
|
4552
|
+
# description: "Description",
|
|
4553
|
+
# template_configuration: {
|
|
4554
|
+
# text_full_ai_prompt_edit_template_configuration: {
|
|
4555
|
+
# text: "TextAIPrompt", # required
|
|
4556
|
+
# },
|
|
4557
|
+
# },
|
|
4558
|
+
# visibility_status: "SAVED", # required, accepts SAVED, PUBLISHED
|
|
4559
|
+
# })
|
|
4560
|
+
#
|
|
4561
|
+
# @example Response structure
|
|
4562
|
+
#
|
|
4563
|
+
# resp.ai_prompt.ai_prompt_arn #=> String
|
|
4564
|
+
# resp.ai_prompt.ai_prompt_id #=> String
|
|
4565
|
+
# resp.ai_prompt.api_format #=> String, one of "ANTHROPIC_CLAUDE_MESSAGES", "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS"
|
|
4566
|
+
# resp.ai_prompt.assistant_arn #=> String
|
|
4567
|
+
# resp.ai_prompt.assistant_id #=> String
|
|
4568
|
+
# resp.ai_prompt.description #=> String
|
|
4569
|
+
# resp.ai_prompt.model_id #=> String
|
|
4570
|
+
# resp.ai_prompt.modified_time #=> Time
|
|
4571
|
+
# resp.ai_prompt.name #=> String
|
|
4572
|
+
# resp.ai_prompt.origin #=> String, one of "SYSTEM", "CUSTOMER"
|
|
4573
|
+
# resp.ai_prompt.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
4574
|
+
# resp.ai_prompt.tags #=> Hash
|
|
4575
|
+
# resp.ai_prompt.tags["TagKey"] #=> String
|
|
4576
|
+
# resp.ai_prompt.template_configuration.text_full_ai_prompt_edit_template_configuration.text #=> String
|
|
4577
|
+
# resp.ai_prompt.template_type #=> String, one of "TEXT"
|
|
4578
|
+
# resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION"
|
|
4579
|
+
# resp.ai_prompt.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
4580
|
+
#
|
|
4581
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAIPrompt AWS API Documentation
|
|
4582
|
+
#
|
|
4583
|
+
# @overload update_ai_prompt(params = {})
|
|
4584
|
+
# @param [Hash] params ({})
|
|
4585
|
+
def update_ai_prompt(params = {}, options = {})
|
|
4586
|
+
req = build_request(:update_ai_prompt, params)
|
|
4587
|
+
req.send_request(options)
|
|
4588
|
+
end
|
|
4589
|
+
|
|
4590
|
+
# Updates the AI Agent that is set for use by defafult on an Amazon Q in
|
|
4591
|
+
# Connect Assistant.
|
|
4592
|
+
#
|
|
4593
|
+
# @option params [required, String] :ai_agent_type
|
|
4594
|
+
# The type of the AI Agent being updated for use by default on the
|
|
4595
|
+
# Amazon Q in Connect Assistant.
|
|
4596
|
+
#
|
|
4597
|
+
# @option params [required, String] :assistant_id
|
|
4598
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
4599
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
4600
|
+
#
|
|
4601
|
+
# @option params [required, Types::AIAgentConfigurationData] :configuration
|
|
4602
|
+
# The configuration of the AI Agent being updated for use by default on
|
|
4603
|
+
# the Amazon Q in Connect Assistant.
|
|
4604
|
+
#
|
|
4605
|
+
# @return [Types::UpdateAssistantAIAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4606
|
+
#
|
|
4607
|
+
# * {Types::UpdateAssistantAIAgentResponse#assistant #assistant} => Types::AssistantData
|
|
4608
|
+
#
|
|
4609
|
+
# @example Request syntax with placeholder values
|
|
4610
|
+
#
|
|
4611
|
+
# resp = client.update_assistant_ai_agent({
|
|
4612
|
+
# ai_agent_type: "MANUAL_SEARCH", # required, accepts MANUAL_SEARCH, ANSWER_RECOMMENDATION
|
|
4613
|
+
# assistant_id: "UuidOrArn", # required
|
|
4614
|
+
# configuration: { # required
|
|
4615
|
+
# ai_agent_id: "UuidWithQualifier", # required
|
|
4616
|
+
# },
|
|
4617
|
+
# })
|
|
4618
|
+
#
|
|
4619
|
+
# @example Response structure
|
|
4620
|
+
#
|
|
4621
|
+
# resp.assistant.ai_agent_configuration #=> Hash
|
|
4622
|
+
# resp.assistant.ai_agent_configuration["AIAgentType"].ai_agent_id #=> String
|
|
4623
|
+
# resp.assistant.assistant_arn #=> String
|
|
4624
|
+
# resp.assistant.assistant_id #=> String
|
|
4625
|
+
# resp.assistant.capability_configuration.type #=> String, one of "V1", "V2"
|
|
4626
|
+
# resp.assistant.description #=> String
|
|
4627
|
+
# resp.assistant.integration_configuration.topic_integration_arn #=> String
|
|
4628
|
+
# resp.assistant.name #=> String
|
|
4629
|
+
# resp.assistant.server_side_encryption_configuration.kms_key_id #=> String
|
|
4630
|
+
# resp.assistant.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
4631
|
+
# resp.assistant.tags #=> Hash
|
|
4632
|
+
# resp.assistant.tags["TagKey"] #=> String
|
|
4633
|
+
# resp.assistant.type #=> String, one of "AGENT"
|
|
4634
|
+
#
|
|
4635
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAssistantAIAgent AWS API Documentation
|
|
4636
|
+
#
|
|
4637
|
+
# @overload update_assistant_ai_agent(params = {})
|
|
4638
|
+
# @param [Hash] params ({})
|
|
4639
|
+
def update_assistant_ai_agent(params = {}, options = {})
|
|
4640
|
+
req = build_request(:update_assistant_ai_agent, params)
|
|
4641
|
+
req.send_request(options)
|
|
4642
|
+
end
|
|
4643
|
+
|
|
3048
4644
|
# Updates information about the content.
|
|
3049
4645
|
#
|
|
3050
4646
|
# @option params [required, String] :content_id
|
|
@@ -3164,9 +4760,12 @@ module Aws::QConnect
|
|
|
3164
4760
|
# @example Response structure
|
|
3165
4761
|
#
|
|
3166
4762
|
# resp.knowledge_base.description #=> String
|
|
4763
|
+
# resp.knowledge_base.ingestion_failure_reasons #=> Array
|
|
4764
|
+
# resp.knowledge_base.ingestion_failure_reasons[0] #=> String
|
|
4765
|
+
# resp.knowledge_base.ingestion_status #=> String, one of "SYNC_FAILED", "SYNCING_IN_PROGRESS", "SYNC_SUCCESS", "CREATE_IN_PROGRESS"
|
|
3167
4766
|
# resp.knowledge_base.knowledge_base_arn #=> String
|
|
3168
4767
|
# resp.knowledge_base.knowledge_base_id #=> String
|
|
3169
|
-
# resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES"
|
|
4768
|
+
# resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES", "MESSAGE_TEMPLATES", "MANAGED"
|
|
3170
4769
|
# resp.knowledge_base.last_content_modification_time #=> Time
|
|
3171
4770
|
# resp.knowledge_base.name #=> String
|
|
3172
4771
|
# resp.knowledge_base.rendering_configuration.template_uri #=> String
|
|
@@ -3174,9 +4773,29 @@ module Aws::QConnect
|
|
|
3174
4773
|
# resp.knowledge_base.source_configuration.app_integrations.app_integration_arn #=> String
|
|
3175
4774
|
# resp.knowledge_base.source_configuration.app_integrations.object_fields #=> Array
|
|
3176
4775
|
# resp.knowledge_base.source_configuration.app_integrations.object_fields[0] #=> String
|
|
4776
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.crawler_limits.rate_limit #=> Integer
|
|
4777
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters #=> Array
|
|
4778
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters[0] #=> String
|
|
4779
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters #=> Array
|
|
4780
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters[0] #=> String
|
|
4781
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.scope #=> String, one of "HOST_ONLY", "SUBDOMAINS"
|
|
4782
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls #=> Array
|
|
4783
|
+
# resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls[0].url #=> String
|
|
3177
4784
|
# resp.knowledge_base.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
3178
4785
|
# resp.knowledge_base.tags #=> Hash
|
|
3179
4786
|
# resp.knowledge_base.tags["TagKey"] #=> String
|
|
4787
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.chunking_strategy #=> String, one of "FIXED_SIZE", "NONE", "HIERARCHICAL", "SEMANTIC"
|
|
4788
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.max_tokens #=> Integer
|
|
4789
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.overlap_percentage #=> Integer
|
|
4790
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations #=> Array
|
|
4791
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations[0].max_tokens #=> Integer
|
|
4792
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.overlap_tokens #=> Integer
|
|
4793
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.breakpoint_percentile_threshold #=> Integer
|
|
4794
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.buffer_size #=> Integer
|
|
4795
|
+
# resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.max_tokens #=> Integer
|
|
4796
|
+
# resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.model_arn #=> String
|
|
4797
|
+
# resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.parsing_prompt.parsing_prompt_text #=> String
|
|
4798
|
+
# resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.parsing_strategy #=> String, one of "BEDROCK_FOUNDATION_MODEL"
|
|
3180
4799
|
#
|
|
3181
4800
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateKnowledgeBaseTemplateUri AWS API Documentation
|
|
3182
4801
|
#
|
|
@@ -3311,6 +4930,11 @@ module Aws::QConnect
|
|
|
3311
4930
|
# Q in Connect session for each contact on which Amazon Q in Connect is
|
|
3312
4931
|
# enabled.
|
|
3313
4932
|
#
|
|
4933
|
+
# @option params [Hash<String,Types::AIAgentConfigurationData>] :ai_agent_configuration
|
|
4934
|
+
# The configuration of the AI Agents (mapped by AI Agent Type to AI
|
|
4935
|
+
# Agent version) that should be used by Amazon Q in Connect for this
|
|
4936
|
+
# Session.
|
|
4937
|
+
#
|
|
3314
4938
|
# @option params [required, String] :assistant_id
|
|
3315
4939
|
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
3316
4940
|
# ID or the ARN. URLs cannot contain the ARN.
|
|
@@ -3332,6 +4956,11 @@ module Aws::QConnect
|
|
|
3332
4956
|
# @example Request syntax with placeholder values
|
|
3333
4957
|
#
|
|
3334
4958
|
# resp = client.update_session({
|
|
4959
|
+
# ai_agent_configuration: {
|
|
4960
|
+
# "MANUAL_SEARCH" => {
|
|
4961
|
+
# ai_agent_id: "UuidWithQualifier", # required
|
|
4962
|
+
# },
|
|
4963
|
+
# },
|
|
3335
4964
|
# assistant_id: "UuidOrArn", # required
|
|
3336
4965
|
# description: "Description",
|
|
3337
4966
|
# session_id: "UuidOrArn", # required
|
|
@@ -3365,6 +4994,8 @@ module Aws::QConnect
|
|
|
3365
4994
|
#
|
|
3366
4995
|
# @example Response structure
|
|
3367
4996
|
#
|
|
4997
|
+
# resp.session.ai_agent_configuration #=> Hash
|
|
4998
|
+
# resp.session.ai_agent_configuration["AIAgentType"].ai_agent_id #=> String
|
|
3368
4999
|
# resp.session.description #=> String
|
|
3369
5000
|
# resp.session.integration_configuration.topic_integration_arn #=> String
|
|
3370
5001
|
# resp.session.name #=> String
|
|
@@ -3393,6 +5024,64 @@ module Aws::QConnect
|
|
|
3393
5024
|
req.send_request(options)
|
|
3394
5025
|
end
|
|
3395
5026
|
|
|
5027
|
+
# Updates the data stored on an Amazon Q in Connect Session.
|
|
5028
|
+
#
|
|
5029
|
+
# @option params [required, String] :assistant_id
|
|
5030
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
5031
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
5032
|
+
#
|
|
5033
|
+
# @option params [required, Array<Types::RuntimeSessionData>] :data
|
|
5034
|
+
# The data stored on the Amazon Q in Connect Session.
|
|
5035
|
+
#
|
|
5036
|
+
# @option params [String] :namespace
|
|
5037
|
+
# The namespace into which the session data is stored. Supported
|
|
5038
|
+
# namespaces are: Custom
|
|
5039
|
+
#
|
|
5040
|
+
# @option params [required, String] :session_id
|
|
5041
|
+
# The identifier of the session. Can be either the ID or the ARN. URLs
|
|
5042
|
+
# cannot contain the ARN.
|
|
5043
|
+
#
|
|
5044
|
+
# @return [Types::UpdateSessionDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5045
|
+
#
|
|
5046
|
+
# * {Types::UpdateSessionDataResponse#data #data} => Array<Types::RuntimeSessionData>
|
|
5047
|
+
# * {Types::UpdateSessionDataResponse#namespace #namespace} => String
|
|
5048
|
+
# * {Types::UpdateSessionDataResponse#session_arn #session_arn} => String
|
|
5049
|
+
# * {Types::UpdateSessionDataResponse#session_id #session_id} => String
|
|
5050
|
+
#
|
|
5051
|
+
# @example Request syntax with placeholder values
|
|
5052
|
+
#
|
|
5053
|
+
# resp = client.update_session_data({
|
|
5054
|
+
# assistant_id: "UuidOrArn", # required
|
|
5055
|
+
# data: [ # required
|
|
5056
|
+
# {
|
|
5057
|
+
# key: "NonEmptySensitiveString", # required
|
|
5058
|
+
# value: { # required
|
|
5059
|
+
# string_value: "NonEmptySensitiveString",
|
|
5060
|
+
# },
|
|
5061
|
+
# },
|
|
5062
|
+
# ],
|
|
5063
|
+
# namespace: "Custom", # accepts Custom
|
|
5064
|
+
# session_id: "UuidOrArn", # required
|
|
5065
|
+
# })
|
|
5066
|
+
#
|
|
5067
|
+
# @example Response structure
|
|
5068
|
+
#
|
|
5069
|
+
# resp.data #=> Array
|
|
5070
|
+
# resp.data[0].key #=> String
|
|
5071
|
+
# resp.data[0].value.string_value #=> String
|
|
5072
|
+
# resp.namespace #=> String, one of "Custom"
|
|
5073
|
+
# resp.session_arn #=> String
|
|
5074
|
+
# resp.session_id #=> String
|
|
5075
|
+
#
|
|
5076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateSessionData AWS API Documentation
|
|
5077
|
+
#
|
|
5078
|
+
# @overload update_session_data(params = {})
|
|
5079
|
+
# @param [Hash] params ({})
|
|
5080
|
+
def update_session_data(params = {}, options = {})
|
|
5081
|
+
req = build_request(:update_session_data, params)
|
|
5082
|
+
req.send_request(options)
|
|
5083
|
+
end
|
|
5084
|
+
|
|
3396
5085
|
# @!endgroup
|
|
3397
5086
|
|
|
3398
5087
|
# @param params ({})
|
|
@@ -3411,7 +5100,7 @@ module Aws::QConnect
|
|
|
3411
5100
|
tracer: tracer
|
|
3412
5101
|
)
|
|
3413
5102
|
context[:gem_name] = 'aws-sdk-qconnect'
|
|
3414
|
-
context[:gem_version] = '1.
|
|
5103
|
+
context[:gem_version] = '1.21.0'
|
|
3415
5104
|
Seahorse::Client::Request.new(handlers, context)
|
|
3416
5105
|
end
|
|
3417
5106
|
|