@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonQConnect extends Object implements AmazonQConnect
AmazonQConnect. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIXpublic CreateAssistantResult createAssistant(CreateAssistantRequest request)
AmazonQConnectCreates an Amazon Q in Connect assistant.
createAssistant in interface AmazonQConnectpublic CreateAssistantAssociationResult createAssistantAssociation(CreateAssistantAssociationRequest request)
AmazonQConnectCreates 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.
createAssistantAssociation in interface AmazonQConnectpublic CreateContentResult createContent(CreateContentRequest request)
AmazonQConnectCreates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
createContent in interface AmazonQConnectpublic CreateContentAssociationResult createContentAssociation(CreateContentAssociationRequest request)
AmazonQConnectCreates 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.
createContentAssociation in interface AmazonQConnectpublic CreateKnowledgeBaseResult createKnowledgeBase(CreateKnowledgeBaseRequest request)
AmazonQConnectCreates 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.
createKnowledgeBase in interface AmazonQConnectpublic CreateQuickResponseResult createQuickResponse(CreateQuickResponseRequest request)
AmazonQConnectCreates an Amazon Q in Connect quick response.
createQuickResponse in interface AmazonQConnectpublic CreateSessionResult createSession(CreateSessionRequest request)
AmazonQConnectCreates 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.
createSession in interface AmazonQConnectpublic DeleteAssistantResult deleteAssistant(DeleteAssistantRequest request)
AmazonQConnectDeletes an assistant.
deleteAssistant in interface AmazonQConnectpublic DeleteAssistantAssociationResult deleteAssistantAssociation(DeleteAssistantAssociationRequest request)
AmazonQConnectDeletes an assistant association.
deleteAssistantAssociation in interface AmazonQConnectpublic DeleteContentResult deleteContent(DeleteContentRequest request)
AmazonQConnectDeletes the content.
deleteContent in interface AmazonQConnectpublic DeleteContentAssociationResult deleteContentAssociation(DeleteContentAssociationRequest request)
AmazonQConnectDeletes 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.
deleteContentAssociation in interface AmazonQConnectpublic DeleteImportJobResult deleteImportJob(DeleteImportJobRequest request)
AmazonQConnectDeletes the quick response import job.
deleteImportJob in interface AmazonQConnectpublic DeleteKnowledgeBaseResult deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)
AmazonQConnectDeletes 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.
deleteKnowledgeBase in interface AmazonQConnectpublic DeleteQuickResponseResult deleteQuickResponse(DeleteQuickResponseRequest request)
AmazonQConnectDeletes a quick response.
deleteQuickResponse in interface AmazonQConnectpublic GetAssistantResult getAssistant(GetAssistantRequest request)
AmazonQConnectRetrieves information about an assistant.
getAssistant in interface AmazonQConnectpublic GetAssistantAssociationResult getAssistantAssociation(GetAssistantAssociationRequest request)
AmazonQConnectRetrieves information about an assistant association.
getAssistantAssociation in interface AmazonQConnectpublic GetContentResult getContent(GetContentRequest request)
AmazonQConnectRetrieves content, including a pre-signed URL to download the content.
getContent in interface AmazonQConnectpublic GetContentAssociationResult getContentAssociation(GetContentAssociationRequest request)
AmazonQConnectReturns 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.
getContentAssociation in interface AmazonQConnectpublic GetContentSummaryResult getContentSummary(GetContentSummaryRequest request)
AmazonQConnectRetrieves summary information about the content.
getContentSummary in interface AmazonQConnectpublic GetImportJobResult getImportJob(GetImportJobRequest request)
AmazonQConnectRetrieves the started import job.
getImportJob in interface AmazonQConnectpublic GetKnowledgeBaseResult getKnowledgeBase(GetKnowledgeBaseRequest request)
AmazonQConnectRetrieves information about the knowledge base.
getKnowledgeBase in interface AmazonQConnectpublic GetQuickResponseResult getQuickResponse(GetQuickResponseRequest request)
AmazonQConnectRetrieves the quick response.
getQuickResponse in interface AmazonQConnect@Deprecated public GetRecommendationsResult getRecommendations(GetRecommendationsRequest request)
AmazonQConnectThis 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.
getRecommendations in interface AmazonQConnectpublic GetSessionResult getSession(GetSessionRequest request)
AmazonQConnectRetrieves information for a specified session.
getSession in interface AmazonQConnectpublic ListAssistantAssociationsResult listAssistantAssociations(ListAssistantAssociationsRequest request)
AmazonQConnectLists information about assistant associations.
listAssistantAssociations in interface AmazonQConnectpublic ListAssistantsResult listAssistants(ListAssistantsRequest request)
AmazonQConnectLists information about assistants.
listAssistants in interface AmazonQConnectpublic ListContentAssociationsResult listContentAssociations(ListContentAssociationsRequest request)
AmazonQConnectLists 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.
listContentAssociations in interface AmazonQConnectpublic ListContentsResult listContents(ListContentsRequest request)
AmazonQConnectLists the content.
listContents in interface AmazonQConnectpublic ListImportJobsResult listImportJobs(ListImportJobsRequest request)
AmazonQConnectLists information about import jobs.
listImportJobs in interface AmazonQConnectpublic ListKnowledgeBasesResult listKnowledgeBases(ListKnowledgeBasesRequest request)
AmazonQConnectLists the knowledge bases.
listKnowledgeBases in interface AmazonQConnectpublic ListQuickResponsesResult listQuickResponses(ListQuickResponsesRequest request)
AmazonQConnectLists information about quick response.
listQuickResponses in interface AmazonQConnectpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonQConnectLists the tags for the specified resource.
listTagsForResource in interface AmazonQConnectpublic NotifyRecommendationsReceivedResult notifyRecommendationsReceived(NotifyRecommendationsReceivedRequest request)
AmazonQConnect
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.
notifyRecommendationsReceived in interface AmazonQConnectpublic PutFeedbackResult putFeedback(PutFeedbackRequest request)
AmazonQConnectProvides feedback against the specified assistant for the specified target. This API only supports generative targets.
putFeedback in interface AmazonQConnect@Deprecated public QueryAssistantResult queryAssistant(QueryAssistantRequest request)
AmazonQConnectThis 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.
queryAssistant in interface AmazonQConnectpublic RemoveKnowledgeBaseTemplateUriResult removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest request)
AmazonQConnectRemoves a URI template from a knowledge base.
removeKnowledgeBaseTemplateUri in interface AmazonQConnectpublic SearchContentResult searchContent(SearchContentRequest request)
AmazonQConnectSearches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
searchContent in interface AmazonQConnectpublic SearchQuickResponsesResult searchQuickResponses(SearchQuickResponsesRequest request)
AmazonQConnectSearches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
searchQuickResponses in interface AmazonQConnectpublic SearchSessionsResult searchSessions(SearchSessionsRequest request)
AmazonQConnectSearches for sessions.
searchSessions in interface AmazonQConnectpublic StartContentUploadResult startContentUpload(StartContentUploadRequest request)
AmazonQConnectGet 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.
startContentUpload in interface AmazonQConnectpublic StartImportJobResult startImportJob(StartImportJobRequest request)
AmazonQConnectStart 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.
startImportJob in interface AmazonQConnectpublic TagResourceResult tagResource(TagResourceRequest request)
AmazonQConnectAdds the specified tags to the specified resource.
tagResource in interface AmazonQConnectpublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonQConnectRemoves the specified tags from the specified resource.
untagResource in interface AmazonQConnectpublic UpdateContentResult updateContent(UpdateContentRequest request)
AmazonQConnectUpdates information about the content.
updateContent in interface AmazonQConnectpublic UpdateKnowledgeBaseTemplateUriResult updateKnowledgeBaseTemplateUri(UpdateKnowledgeBaseTemplateUriRequest request)
AmazonQConnect
Updates 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.
updateKnowledgeBaseTemplateUri in interface AmazonQConnectpublic UpdateQuickResponseResult updateQuickResponse(UpdateQuickResponseRequest request)
AmazonQConnectUpdates an existing Amazon Q in Connect quick response.
updateQuickResponse in interface AmazonQConnectpublic UpdateSessionResult updateSession(UpdateSessionRequest request)
AmazonQConnectUpdates 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.
updateSession in interface AmazonQConnectpublic void shutdown()
AmazonQConnectshutdown in interface AmazonQConnectpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonQConnectResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonQConnectrequest - The originally executed request.