Class: Aws::QConnect::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::QConnect::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb
Overview
An API client for QConnect. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::QConnect::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_ai_agent(params = {}) ⇒ Types::CreateAIAgentResponse
Creates an Amazon Q in Connect AI Agent.
-
#create_ai_agent_version(params = {}) ⇒ Types::CreateAIAgentVersionResponse
Creates and Amazon Q in Connect AI Agent version.
-
#create_ai_prompt(params = {}) ⇒ Types::CreateAIPromptResponse
Creates an Amazon Q in Connect AI Prompt.
-
#create_ai_prompt_version(params = {}) ⇒ Types::CreateAIPromptVersionResponse
Creates an Amazon Q in Connect AI Prompt version.
-
#create_assistant(params = {}) ⇒ Types::CreateAssistantResponse
Creates an Amazon Q in Connect assistant.
-
#create_assistant_association(params = {}) ⇒ Types::CreateAssistantAssociationResponse
Creates an association between an Amazon Q in Connect assistant and another resource.
-
#create_content(params = {}) ⇒ Types::CreateContentResponse
Creates Amazon Q in Connect content.
-
#create_content_association(params = {}) ⇒ Types::CreateContentAssociationResponse
Creates an association between a content resource in a knowledge base and [step-by-step guides][1].
-
#create_knowledge_base(params = {}) ⇒ Types::CreateKnowledgeBaseResponse
Creates a knowledge base.
-
#create_quick_response(params = {}) ⇒ Types::CreateQuickResponseResponse
Creates an Amazon Q in Connect quick response.
-
#create_session(params = {}) ⇒ Types::CreateSessionResponse
Creates a session.
-
#delete_ai_agent(params = {}) ⇒ Struct
Deletes an Amazon Q in Connect AI Agent.
-
#delete_ai_agent_version(params = {}) ⇒ Struct
Deletes an Amazon Q in Connect AI Agent Version.
-
#delete_ai_prompt(params = {}) ⇒ Struct
Deletes an Amazon Q in Connect AI Prompt.
-
#delete_ai_prompt_version(params = {}) ⇒ Struct
Delete and Amazon Q in Connect AI Prompt version.
-
#delete_assistant(params = {}) ⇒ Struct
Deletes an assistant.
-
#delete_assistant_association(params = {}) ⇒ Struct
Deletes an assistant association.
-
#delete_content(params = {}) ⇒ Struct
Deletes the content.
-
#delete_content_association(params = {}) ⇒ Struct
Deletes the content association.
-
#delete_import_job(params = {}) ⇒ Struct
Deletes the quick response import job.
-
#delete_knowledge_base(params = {}) ⇒ Struct
Deletes the knowledge base.
-
#delete_quick_response(params = {}) ⇒ Struct
Deletes a quick response.
-
#get_ai_agent(params = {}) ⇒ Types::GetAIAgentResponse
Gets an Amazon Q in Connect AI Agent.
-
#get_ai_prompt(params = {}) ⇒ Types::GetAIPromptResponse
Gets and Amazon Q in Connect AI Prompt.
-
#get_assistant(params = {}) ⇒ Types::GetAssistantResponse
Retrieves information about an assistant.
-
#get_assistant_association(params = {}) ⇒ Types::GetAssistantAssociationResponse
Retrieves information about an assistant association.
-
#get_content(params = {}) ⇒ Types::GetContentResponse
Retrieves content, including a pre-signed URL to download the content.
-
#get_content_association(params = {}) ⇒ Types::GetContentAssociationResponse
Returns the content association.
-
#get_content_summary(params = {}) ⇒ Types::GetContentSummaryResponse
Retrieves summary information about the content.
-
#get_import_job(params = {}) ⇒ Types::GetImportJobResponse
Retrieves the started import job.
-
#get_knowledge_base(params = {}) ⇒ Types::GetKnowledgeBaseResponse
Retrieves information about the knowledge base.
-
#get_quick_response(params = {}) ⇒ Types::GetQuickResponseResponse
Retrieves the quick response.
-
#get_recommendations(params = {}) ⇒ Types::GetRecommendationsResponse
This API will be discontinued starting June 1, 2024.
-
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves information for a specified session.
-
#list_ai_agent_versions(params = {}) ⇒ Types::ListAIAgentVersionsResponse
List AI Agent versions.
-
#list_ai_agents(params = {}) ⇒ Types::ListAIAgentsResponse
Lists AI Agents.
-
#list_ai_prompt_versions(params = {}) ⇒ Types::ListAIPromptVersionsResponse
Lists AI Prompt versions.
-
#list_ai_prompts(params = {}) ⇒ Types::ListAIPromptsResponse
Lists the AI Prompts available on the Amazon Q in Connect assistant.
-
#list_assistant_associations(params = {}) ⇒ Types::ListAssistantAssociationsResponse
Lists information about assistant associations.
-
#list_assistants(params = {}) ⇒ Types::ListAssistantsResponse
Lists information about assistants.
-
#list_content_associations(params = {}) ⇒ Types::ListContentAssociationsResponse
Lists the content associations.
-
#list_contents(params = {}) ⇒ Types::ListContentsResponse
Lists the content.
-
#list_import_jobs(params = {}) ⇒ Types::ListImportJobsResponse
Lists information about import jobs.
-
#list_knowledge_bases(params = {}) ⇒ Types::ListKnowledgeBasesResponse
Lists the knowledge bases.
-
#list_quick_responses(params = {}) ⇒ Types::ListQuickResponsesResponse
Lists information about quick response.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
-
#notify_recommendations_received(params = {}) ⇒ Types::NotifyRecommendationsReceivedResponse
Removes the specified recommendations from the specified assistant's queue of newly available recommendations.
-
#put_feedback(params = {}) ⇒ Types::PutFeedbackResponse
Provides feedback against the specified assistant for the specified target.
-
#query_assistant(params = {}) ⇒ Types::QueryAssistantResponse
This API will be discontinued starting June 1, 2024.
-
#remove_assistant_ai_agent(params = {}) ⇒ Struct
Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
-
#remove_knowledge_base_template_uri(params = {}) ⇒ Struct
Removes a URI template from a knowledge base.
-
#search_content(params = {}) ⇒ Types::SearchContentResponse
Searches for content in a specified knowledge base.
-
#search_quick_responses(params = {}) ⇒ Types::SearchQuickResponsesResponse
Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
-
#search_sessions(params = {}) ⇒ Types::SearchSessionsResponse
Searches for sessions.
-
#start_content_upload(params = {}) ⇒ Types::StartContentUploadResponse
Get a URL to upload content to a knowledge base.
-
#start_import_job(params = {}) ⇒ Types::StartImportJobResponse
Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file.
-
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
-
#update_ai_agent(params = {}) ⇒ Types::UpdateAIAgentResponse
Updates an AI Agent.
-
#update_ai_prompt(params = {}) ⇒ Types::UpdateAIPromptResponse
Updates an AI Prompt.
-
#update_assistant_ai_agent(params = {}) ⇒ Types::UpdateAssistantAIAgentResponse
Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
-
#update_content(params = {}) ⇒ Types::UpdateContentResponse
Updates information about the content.
-
#update_knowledge_base_template_uri(params = {}) ⇒ Types::UpdateKnowledgeBaseTemplateUriResponse
Updates the template URI of a knowledge base.
-
#update_quick_response(params = {}) ⇒ Types::UpdateQuickResponseResponse
Updates an existing Amazon Q in Connect quick response.
-
#update_session(params = {}) ⇒ Types::UpdateSessionResponse
Updates a session.
-
#update_session_data(params = {}) ⇒ Types::UpdateSessionDataResponse
Updates the data stored on an Amazon Q in Connect Session.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
444 445 446 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 444 def initialize(*args) super end |
Instance Method Details
#create_ai_agent(params = {}) ⇒ Types::CreateAIAgentResponse
Creates an Amazon Q in Connect AI Agent.
647 648 649 650 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 647 def create_ai_agent(params = {}, = {}) req = build_request(:create_ai_agent, params) req.send_request() end |
#create_ai_agent_version(params = {}) ⇒ Types::CreateAIAgentVersionResponse
Creates and Amazon Q in Connect AI Agent version.
753 754 755 756 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 753 def create_ai_agent_version(params = {}, = {}) req = build_request(:create_ai_agent_version, params) req.send_request() end |
#create_ai_prompt(params = {}) ⇒ Types::CreateAIPromptResponse
Creates an Amazon Q in Connect AI Prompt.
855 856 857 858 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 855 def create_ai_prompt(params = {}, = {}) req = build_request(:create_ai_prompt, params) req.send_request() end |
#create_ai_prompt_version(params = {}) ⇒ Types::CreateAIPromptVersionResponse
Creates an Amazon Q in Connect AI Prompt version.
924 925 926 927 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 924 def create_ai_prompt_version(params = {}, = {}) req = build_request(:create_ai_prompt_version, params) req.send_request() end |
#create_assistant(params = {}) ⇒ Types::CreateAssistantResponse
Creates an Amazon Q in Connect assistant.
1015 1016 1017 1018 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1015 def create_assistant(params = {}, = {}) req = build_request(:create_assistant, params) req.send_request() end |
#create_assistant_association(params = {}) ⇒ Types::CreateAssistantAssociationResponse
Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
1084 1085 1086 1087 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1084 def create_assistant_association(params = {}, = {}) req = build_request(:create_assistant_association, params) req.send_request() end |
#create_content(params = {}) ⇒ Types::CreateContentResponse
Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
1192 1193 1194 1195 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1192 def create_content(params = {}, = {}) req = build_request(:create_content, params) req.send_request() end |
#create_content_association(params = {}) ⇒ Types::CreateContentAssociationResponse
Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides.
After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.
Note the following limitations:
You can create only one content association for each content resource in a knowledge base.
You can associate a step-by-step guide with multiple content resources.
For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
1289 1290 1291 1292 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1289 def create_content_association(params = {}, = {}) req = build_request(:create_content_association, params) req.send_request() end |
#create_knowledge_base(params = {}) ⇒ Types::CreateKnowledgeBaseResponse
Creates a knowledge base.
InvalidRequestException
error.
For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
Call DeleteKnowledgeBase.
Call DeleteDataIntegration.
Call CreateDataIntegration to recreate the DataIntegration or a create different one.
Call CreateKnowledgeBase.
1496 1497 1498 1499 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1496 def create_knowledge_base(params = {}, = {}) req = build_request(:create_knowledge_base, params) req.send_request() end |
#create_quick_response(params = {}) ⇒ Types::CreateQuickResponseResponse
Creates an Amazon Q in Connect quick response.
1619 1620 1621 1622 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1619 def create_quick_response(params = {}, = {}) req = build_request(:create_quick_response, params) req.send_request() end |
#create_session(params = {}) ⇒ Types::CreateSessionResponse
Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
1737 1738 1739 1740 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1737 def create_session(params = {}, = {}) req = build_request(:create_session, params) req.send_request() end |
#delete_ai_agent(params = {}) ⇒ Struct
Deletes an Amazon Q in Connect AI Agent.
1765 1766 1767 1768 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1765 def delete_ai_agent(params = {}, = {}) req = build_request(:delete_ai_agent, params) req.send_request() end |
#delete_ai_agent_version(params = {}) ⇒ Struct
Deletes an Amazon Q in Connect AI Agent Version.
1797 1798 1799 1800 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1797 def delete_ai_agent_version(params = {}, = {}) req = build_request(:delete_ai_agent_version, params) req.send_request() end |
#delete_ai_prompt(params = {}) ⇒ Struct
Deletes an Amazon Q in Connect AI Prompt.
1825 1826 1827 1828 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1825 def delete_ai_prompt(params = {}, = {}) req = build_request(:delete_ai_prompt, params) req.send_request() end |
#delete_ai_prompt_version(params = {}) ⇒ Struct
Delete and Amazon Q in Connect AI Prompt version.
1856 1857 1858 1859 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1856 def delete_ai_prompt_version(params = {}, = {}) req = build_request(:delete_ai_prompt_version, params) req.send_request() end |
#delete_assistant(params = {}) ⇒ Struct
Deletes an assistant.
1879 1880 1881 1882 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1879 def delete_assistant(params = {}, = {}) req = build_request(:delete_assistant, params) req.send_request() end |
#delete_assistant_association(params = {}) ⇒ Struct
Deletes an assistant association.
1907 1908 1909 1910 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1907 def delete_assistant_association(params = {}, = {}) req = build_request(:delete_assistant_association, params) req.send_request() end |
#delete_content(params = {}) ⇒ Struct
Deletes the content.
1935 1936 1937 1938 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1935 def delete_content(params = {}, = {}) req = build_request(:delete_content, params) req.send_request() end |
#delete_content_association(params = {}) ⇒ Struct
Deletes the content association.
For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
1974 1975 1976 1977 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1974 def delete_content_association(params = {}, = {}) req = build_request(:delete_content_association, params) req.send_request() end |
#delete_import_job(params = {}) ⇒ Struct
Deletes the quick response import job.
2000 2001 2002 2003 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2000 def delete_import_job(params = {}, = {}) req = build_request(:delete_import_job, params) req.send_request() end |
#delete_knowledge_base(params = {}) ⇒ Struct
Deletes the knowledge base.
2039 2040 2041 2042 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2039 def delete_knowledge_base(params = {}, = {}) req = build_request(:delete_knowledge_base, params) req.send_request() end |
#delete_quick_response(params = {}) ⇒ Struct
Deletes a quick response.
2066 2067 2068 2069 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2066 def delete_quick_response(params = {}, = {}) req = build_request(:delete_quick_response, params) req.send_request() end |
#get_ai_agent(params = {}) ⇒ Types::GetAIAgentResponse
Gets an Amazon Q in Connect AI Agent.
2151 2152 2153 2154 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2151 def get_ai_agent(params = {}, = {}) req = build_request(:get_ai_agent, params) req.send_request() end |
#get_ai_prompt(params = {}) ⇒ Types::GetAIPromptResponse
Gets and Amazon Q in Connect AI Prompt.
2202 2203 2204 2205 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2202 def get_ai_prompt(params = {}, = {}) req = build_request(:get_ai_prompt, params) req.send_request() end |
#get_assistant(params = {}) ⇒ Types::GetAssistantResponse
Retrieves information about an assistant.
2243 2244 2245 2246 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2243 def get_assistant(params = {}, = {}) req = build_request(:get_assistant, params) req.send_request() end |
#get_assistant_association(params = {}) ⇒ Types::GetAssistantAssociationResponse
Retrieves information about an assistant association.
2285 2286 2287 2288 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2285 def get_assistant_association(params = {}, = {}) req = build_request(:get_assistant_association, params) req.send_request() end |
#get_content(params = {}) ⇒ Types::GetContentResponse
Retrieves content, including a pre-signed URL to download the content.
2335 2336 2337 2338 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2335 def get_content(params = {}, = {}) req = build_request(:get_content, params) req.send_request() end |
#get_content_association(params = {}) ⇒ Types::GetContentAssociationResponse
Returns the content association.
For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
2389 2390 2391 2392 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2389 def get_content_association(params = {}, = {}) req = build_request(:get_content_association, params) req.send_request() end |
#get_content_summary(params = {}) ⇒ Types::GetContentSummaryResponse
Retrieves summary information about the content.
2435 2436 2437 2438 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2435 def get_content_summary(params = {}, = {}) req = build_request(:get_content_summary, params) req.send_request() end |
#get_import_job(params = {}) ⇒ Types::GetImportJobResponse
Retrieves the started import job.
2481 2482 2483 2484 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2481 def get_import_job(params = {}, = {}) req = build_request(:get_import_job, params) req.send_request() end |
#get_knowledge_base(params = {}) ⇒ Types::GetKnowledgeBaseResponse
Retrieves information about the knowledge base.
2546 2547 2548 2549 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2546 def get_knowledge_base(params = {}, = {}) req = build_request(:get_knowledge_base, params) req.send_request() end |
#get_quick_response(params = {}) ⇒ Types::GetQuickResponseResponse
Retrieves the quick response.
2601 2602 2603 2604 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2601 def get_quick_response(params = {}, = {}) req = build_request(:get_quick_response, params) req.send_request() end |
#get_recommendations(params = {}) ⇒ Types::GetRecommendationsResponse
This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.
Retrieves recommendations for the specified session. To avoid
retrieving the same recommendations in subsequent calls, use
NotifyRecommendationsReceived. This API supports long-polling
behavior with the waitTimeSeconds
parameter. Short poll is the
default behavior and only returns recommendations already available.
To perform a manual query against an assistant, use
QueryAssistant.
2729 2730 2731 2732 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2729 def get_recommendations(params = {}, = {}) req = build_request(:get_recommendations, params) req.send_request() end |
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves information for a specified session.
2782 2783 2784 2785 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2782 def get_session(params = {}, = {}) req = build_request(:get_session, params) req.send_request() end |
#list_ai_agent_versions(params = {}) ⇒ Types::ListAIAgentVersionsResponse
List AI Agent versions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2886 2887 2888 2889 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2886 def list_ai_agent_versions(params = {}, = {}) req = build_request(:list_ai_agent_versions, params) req.send_request() end |
#list_ai_agents(params = {}) ⇒ Types::ListAIAgentsResponse
Lists AI Agents.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2984 2985 2986 2987 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2984 def list_ai_agents(params = {}, = {}) req = build_request(:list_ai_agents, params) req.send_request() end |
#list_ai_prompt_versions(params = {}) ⇒ Types::ListAIPromptVersionsResponse
Lists AI Prompt versions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3055 3056 3057 3058 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3055 def list_ai_prompt_versions(params = {}, = {}) req = build_request(:list_ai_prompt_versions, params) req.send_request() end |
#list_ai_prompts(params = {}) ⇒ Types::ListAIPromptsResponse
Lists the AI Prompts available on the Amazon Q in Connect assistant.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3120 3121 3122 3123 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3120 def list_ai_prompts(params = {}, = {}) req = build_request(:list_ai_prompts, params) req.send_request() end |
#list_assistant_associations(params = {}) ⇒ Types::ListAssistantAssociationsResponse
Lists information about assistant associations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3172 3173 3174 3175 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3172 def list_assistant_associations(params = {}, = {}) req = build_request(:list_assistant_associations, params) req.send_request() end |
#list_assistants(params = {}) ⇒ Types::ListAssistantsResponse
Lists information about assistants.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3223 3224 3225 3226 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3223 def list_assistants(params = {}, = {}) req = build_request(:list_assistants, params) req.send_request() end |
#list_content_associations(params = {}) ⇒ Types::ListContentAssociationsResponse
Lists the content associations.
For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3287 3288 3289 3290 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3287 def list_content_associations(params = {}, = {}) req = build_request(:list_content_associations, params) req.send_request() end |
#list_contents(params = {}) ⇒ Types::ListContentsResponse
Lists the content.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3344 3345 3346 3347 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3344 def list_contents(params = {}, = {}) req = build_request(:list_contents, params) req.send_request() end |
#list_import_jobs(params = {}) ⇒ Types::ListImportJobsResponse
Lists information about import jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3399 3400 3401 3402 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3399 def list_import_jobs(params = {}, = {}) req = build_request(:list_import_jobs, params) req.send_request() end |
#list_knowledge_bases(params = {}) ⇒ Types::ListKnowledgeBasesResponse
Lists the knowledge bases.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3470 3471 3472 3473 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3470 def list_knowledge_bases(params = {}, = {}) req = build_request(:list_knowledge_bases, params) req.send_request() end |
#list_quick_responses(params = {}) ⇒ Types::ListQuickResponsesResponse
Lists information about quick response.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3529 3530 3531 3532 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3529 def list_quick_responses(params = {}, = {}) req = build_request(:list_quick_responses, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
3558 3559 3560 3561 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3558 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#notify_recommendations_received(params = {}) ⇒ Types::NotifyRecommendationsReceivedResponse
Removes the specified recommendations from the specified assistant's
queue of newly available recommendations. You can use this API in
conjunction with GetRecommendations and a waitTimeSeconds
input
for long-polling behavior and avoiding duplicate recommendations.
3608 3609 3610 3611 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3608 def notify_recommendations_received(params = {}, = {}) req = build_request(:notify_recommendations_received, params) req.send_request() end |
#put_feedback(params = {}) ⇒ Types::PutFeedbackResponse
Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
3661 3662 3663 3664 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3661 def put_feedback(params = {}, = {}) req = build_request(:put_feedback, params) req.send_request() end |
#query_assistant(params = {}) ⇒ Types::QueryAssistantResponse
This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3809 3810 3811 3812 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3809 def query_assistant(params = {}, = {}) req = build_request(:query_assistant, params) req.send_request() end |
#remove_assistant_ai_agent(params = {}) ⇒ Struct
Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
3838 3839 3840 3841 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3838 def remove_assistant_ai_agent(params = {}, = {}) req = build_request(:remove_assistant_ai_agent, params) req.send_request() end |
#remove_knowledge_base_template_uri(params = {}) ⇒ Struct
Removes a URI template from a knowledge base.
3861 3862 3863 3864 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3861 def remove_knowledge_base_template_uri(params = {}, = {}) req = build_request(:remove_knowledge_base_template_uri, params) req.send_request() end |
#search_content(params = {}) ⇒ Types::SearchContentResponse
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3931 3932 3933 3934 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3931 def search_content(params = {}, = {}) req = build_request(:search_content, params) req.send_request() end |
#search_quick_responses(params = {}) ⇒ Types::SearchQuickResponsesResponse
Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4040 4041 4042 4043 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4040 def search_quick_responses(params = {}, = {}) req = build_request(:search_quick_responses, params) req.send_request() end |
#search_sessions(params = {}) ⇒ Types::SearchSessionsResponse
Searches for sessions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4099 4100 4101 4102 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4099 def search_sessions(params = {}, = {}) req = build_request(:search_sessions, params) req.send_request() end |
#start_content_upload(params = {}) ⇒ Types::StartContentUploadResponse
Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
4154 4155 4156 4157 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4154 def start_content_upload(params = {}, = {}) req = build_request(:start_content_upload, params) req.send_request() end |
#start_import_job(params = {}) ⇒ Types::StartImportJobResponse
Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.
- For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.
^