View Source AWS.QConnect (aws-elixir v1.0.0)
Powered by Amazon Bedrock: Amazon Web Services implements automated abuse detection.
Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI).
Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately.
Amazon Q in Connect automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer customer requests.
Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.
For more information, see Use Amazon Q in Connect for generative AI powered agent assistance in real-time in the Amazon Connect Administrator Guide.
Summary
Functions
Creates an Amazon Q in Connect assistant.
Creates an association between an Amazon Q in Connect assistant and another resource.
Creates Amazon Q in Connect content.
Creates a knowledge base.
Creates an Amazon Q in Connect quick response.
Creates a session.
Deletes an assistant.
Deletes an assistant association.
Deletes the content.
Deletes the quick response import job.
Deletes the knowledge base.
Deletes a quick response.
Retrieves information about an assistant.
Retrieves information about an assistant association.
Retrieves content, including a pre-signed URL to download the content.
Retrieves summary information about the content.
Retrieves the started import job.
Retrieves information about the knowledge base.
Retrieves the quick response.
This API will be discontinued starting June 1, 2024.
Retrieves information for a specified session.
Lists information about assistant associations.
Lists information about assistants.
Lists the content.
Lists information about import jobs.
Lists the knowledge bases.
Lists information about quick response.
Lists the tags for the specified resource.
Removes the specified recommendations from the specified assistant's queue of newly available recommendations.
Provides feedback against the specified assistant for the specified target.
This API will be discontinued starting June 1, 2024.
Removes a URI template from a knowledge base.
Searches for content in a specified knowledge base.
Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
Searches for sessions.
Get a URL to upload content to a knowledge base.
Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file.
Adds the specified tags to the specified resource.
Removes the specified tags from the specified resource.
Updates information about the content.
Updates the template URI of a knowledge base.
Updates an existing Amazon Q in Connect quick response.
Updates a session.
Functions
Creates an Amazon Q in Connect assistant.
create_assistant_association(client, assistant_id, input, options \\ [])
View SourceCreates 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.
Creates Amazon Q in Connect content.
Before to calling this API, use StartContentUpload to upload an asset.
Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations
DataIntegrations with external knowledge bases such as Salesforce and
ServiceNow. If you do,
you'll get an 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.
create_quick_response(client, knowledge_base_id, input, options \\ [])
View SourceCreates an Amazon Q in Connect quick response.
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.
Deletes an assistant.
delete_assistant_association(client, assistant_association_id, assistant_id, input, options \\ [])
View SourceDeletes an assistant association.
delete_content(client, content_id, knowledge_base_id, input, options \\ [])
View SourceDeletes the content.
delete_import_job(client, import_job_id, knowledge_base_id, input, options \\ [])
View SourceDeletes the quick response import job.
delete_knowledge_base(client, knowledge_base_id, input, options \\ [])
View SourceDeletes the knowledge base.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
delete_quick_response(client, knowledge_base_id, quick_response_id, input, options \\ [])
View SourceDeletes a quick response.
Retrieves information about an assistant.
get_assistant_association(client, assistant_association_id, assistant_id, options \\ [])
View SourceRetrieves information about an assistant association.
Retrieves content, including a pre-signed URL to download the content.
get_content_summary(client, content_id, knowledge_base_id, options \\ [])
View SourceRetrieves summary information about the content.
get_import_job(client, import_job_id, knowledge_base_id, options \\ [])
View SourceRetrieves the started import job.
Retrieves information about the knowledge base.
get_quick_response(client, knowledge_base_id, quick_response_id, options \\ [])
View SourceRetrieves the quick response.
get_recommendations(client, assistant_id, session_id, max_results \\ nil, wait_time_seconds \\ nil, options \\ [])
View SourceThis 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.
Retrieves information for a specified session.
list_assistant_associations(client, assistant_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists information about assistant associations.
list_assistants(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists information about assistants.
list_contents(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the content.
list_import_jobs(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists information about import jobs.
list_knowledge_bases(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the knowledge bases.
list_quick_responses(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists information about quick response.
Lists the tags for the specified resource.
notify_recommendations_received(client, assistant_id, session_id, input, options \\ [])
View SourceRemoves 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.
Provides feedback against the specified assistant for the specified target.
This API only supports generative targets.
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.
remove_knowledge_base_template_uri(client, knowledge_base_id, input, options \\ [])
View SourceRemoves a URI template from a knowledge base.
Searches for content in a specified knowledge base.
Can be used to get a specific content resource by its name.
search_quick_responses(client, knowledge_base_id, input, options \\ [])
View SourceSearches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
Searches for sessions.
start_content_upload(client, knowledge_base_id, input, options \\ [])
View SourceGet 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.
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.
Adds the specified tags to the specified resource.
Removes the specified tags from the specified resource.
update_content(client, content_id, knowledge_base_id, input, options \\ [])
View SourceUpdates information about the content.
update_knowledge_base_template_uri(client, knowledge_base_id, input, options \\ [])
View SourceUpdates the template URI of a knowledge base.
This is only supported for knowledge bases
of type EXTERNAL. Include a single variable in ${variable}
format; this
interpolated by Amazon Q in Connect using ingested content. For example, if you
ingest a Salesforce
article, it has an Id
value, and you can set the template URI to
https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view
.
update_quick_response(client, knowledge_base_id, quick_response_id, input, options \\ [])
View SourceUpdates an existing Amazon Q in Connect quick response.
update_session(client, assistant_id, session_id, input, options \\ [])
View SourceUpdates a session.
A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.