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: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_CreateContent.html to finalize the content creation process or UpdateContent: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_UpdateContent.html to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.View Source aws_qconnect (aws v1.0.4)
Powered by Amazon Bedrock: Amazon Web Services implements automated abuse detection: https://docs.aws.amazon.com/bedrock/latest/userguide/abuse-detection.html.
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 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 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: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-q-connect.html 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 content.
Creates a knowledge base.
Creates an Amazon Q 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.
Retrieves recommendations for the specified session.
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.
Performs a manual search against the specified assistant.
Removes a URI template from a knowledge base.
Searches for content in a specified knowledge base.
Searches existing Amazon Q quick responses in an Amazon Q knowledge base.
Searches for sessions.
Get a URL to upload content to a knowledge base.
Start an asynchronous job to import Amazon Q 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 quick response.
Functions
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.
Link to this function
create_assistant_association(Client, AssistantId, Input0, Options0)
View SourceCreates Amazon Q content.
Before to calling this API, use StartContentUpload: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html to upload an asset.Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations: https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html 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: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_DeleteKnowledgeBase.html.
Call DeleteDataIntegration: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html.
Call CreateDataIntegration: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html to recreate the DataIntegration or a create different one.
Call CreateKnowledgeBase.Creates a session.
A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q session for each contact on which Amazon Q is enabled.
Link to this function
delete_assistant_association(Client, AssistantAssociationId, AssistantId, Input)
View Source
Link to this function
delete_assistant_association(Client, AssistantAssociationId, AssistantId, Input0, Options0)
View Source
Link to this function
delete_content(Client, ContentId, KnowledgeBaseId, Input0, Options0)
View Source
Link to this function
delete_import_job(Client, ImportJobId, KnowledgeBaseId, Input0, Options0)
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: https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html 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: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html and CreateDataIntegration: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html in the Amazon AppIntegrations API Reference.
Link to this function
delete_quick_response(Client, KnowledgeBaseId, QuickResponseId, Input)
View Source
Link to this function
delete_quick_response(Client, KnowledgeBaseId, QuickResponseId, Input0, Options0)
View Source
Link to this function
get_assistant(Client, AssistantId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_assistant_association(Client, AssistantAssociationId, AssistantId)
View Source
Link to this function
get_assistant_association(Client, AssistantAssociationId, AssistantId, QueryMap, HeadersMap)
View Source
Link to this function
get_assistant_association(Client, AssistantAssociationId, AssistantId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_content(Client, ContentId, KnowledgeBaseId, QueryMap, HeadersMap)
View Source
Link to this function
get_content(Client, ContentId, KnowledgeBaseId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_content_summary(Client, ContentId, KnowledgeBaseId, QueryMap, HeadersMap)
View Source
Link to this function
get_content_summary(Client, ContentId, KnowledgeBaseId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_import_job(Client, ImportJobId, KnowledgeBaseId, QueryMap, HeadersMap)
View Source
Link to this function
get_import_job(Client, ImportJobId, KnowledgeBaseId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_knowledge_base(Client, KnowledgeBaseId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_quick_response(Client, KnowledgeBaseId, QuickResponseId, QueryMap, HeadersMap)
View Source
Link to this function
get_quick_response(Client, KnowledgeBaseId, QuickResponseId, QueryMap, HeadersMap, Options0)
View SourceRetrieves recommendations for the specified session.
To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_NotifyRecommendationsReceived.html. This API supports long-polling behavior with thewaitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_QueryAssistant.html.
Link to this function
get_recommendations(Client, AssistantId, SessionId, QueryMap, HeadersMap)
View Source
Link to this function
get_recommendations(Client, AssistantId, SessionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_session(Client, AssistantId, SessionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_assistant_associations(Client, AssistantId, QueryMap, HeadersMap)
View Source
Link to this function
list_assistant_associations(Client, AssistantId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_contents(Client, KnowledgeBaseId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_import_jobs(Client, KnowledgeBaseId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_quick_responses(Client, KnowledgeBaseId, QueryMap, HeadersMap)
View Source
Link to this function
list_quick_responses(Client, KnowledgeBaseId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View Source
Link to this function
notify_recommendations_received(Client, AssistantId, SessionId, Input)
View SourceRemoves the specified recommendations from the specified assistant's queue of newly available recommendations.
You can use this API in conjunction with GetRecommendations: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html and awaitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.
Link to this function
notify_recommendations_received(Client, AssistantId, SessionId, Input0, Options0)
View SourceProvides feedback against the specified assistant for the specified target.
This API only supports generative targets.Performs a manual search against the specified assistant.
To retrieve recommendations for an assistant, use GetRecommendations: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html.
Link to this function
remove_knowledge_base_template_uri(Client, KnowledgeBaseId, Input)
View Source
Link to this function
remove_knowledge_base_template_uri(Client, KnowledgeBaseId, Input0, Options0)
View SourceSearches for content in a specified knowledge base.
Can be used to get a specific content resource by its name.Start an asynchronous job to import Amazon Q resources from an uploaded source file.
Before calling this API, use StartContentUpload: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html to upload an asset that contains the resource data.
For importing Amazon Q 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: https://docs.aws.amazon.com/console/connect/quick-responses/add-data.
Link to this function
update_content(Client, ContentId, KnowledgeBaseId, Input0, Options0)
View Source
Link to this function
update_knowledge_base_template_uri(Client, KnowledgeBaseId, Input)
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 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.
Link to this function
update_knowledge_base_template_uri(Client, KnowledgeBaseId, Input0, Options0)
View Source
Link to this function
update_quick_response(Client, KnowledgeBaseId, QuickResponseId, Input)
View Source
Link to this function