@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_PREFIX
public CreateAssistantResult createAssistant(CreateAssistantRequest request)
AmazonQConnect
Creates an Amazon Q in Connect assistant.
createAssistant
in interface AmazonQConnect
public CreateAssistantAssociationResult createAssistantAssociation(CreateAssistantAssociationRequest request)
AmazonQConnect
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.
createAssistantAssociation
in interface AmazonQConnect
public CreateContentResult createContent(CreateContentRequest request)
AmazonQConnect
Creates Amazon Q content. Before to calling this API, use StartContentUpload to upload an asset.
createContent
in interface AmazonQConnect
public CreateKnowledgeBaseResult createKnowledgeBase(CreateKnowledgeBaseRequest request)
AmazonQConnect
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.
createKnowledgeBase
in interface AmazonQConnect
public CreateQuickResponseResult createQuickResponse(CreateQuickResponseRequest request)
AmazonQConnect
Creates an Amazon Q quick response.
createQuickResponse
in interface AmazonQConnect
public CreateSessionResult createSession(CreateSessionRequest request)
AmazonQConnect
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.
createSession
in interface AmazonQConnect
public DeleteAssistantResult deleteAssistant(DeleteAssistantRequest request)
AmazonQConnect
Deletes an assistant.
deleteAssistant
in interface AmazonQConnect
public DeleteAssistantAssociationResult deleteAssistantAssociation(DeleteAssistantAssociationRequest request)
AmazonQConnect
Deletes an assistant association.
deleteAssistantAssociation
in interface AmazonQConnect
public DeleteContentResult deleteContent(DeleteContentRequest request)
AmazonQConnect
Deletes the content.
deleteContent
in interface AmazonQConnect
public DeleteImportJobResult deleteImportJob(DeleteImportJobRequest request)
AmazonQConnect
Deletes the quick response import job.
deleteImportJob
in interface AmazonQConnect
public DeleteKnowledgeBaseResult deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)
AmazonQConnect
Deletes 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 AmazonQConnect
public DeleteQuickResponseResult deleteQuickResponse(DeleteQuickResponseRequest request)
AmazonQConnect
Deletes a quick response.
deleteQuickResponse
in interface AmazonQConnect
public GetAssistantResult getAssistant(GetAssistantRequest request)
AmazonQConnect
Retrieves information about an assistant.
getAssistant
in interface AmazonQConnect
public GetAssistantAssociationResult getAssistantAssociation(GetAssistantAssociationRequest request)
AmazonQConnect
Retrieves information about an assistant association.
getAssistantAssociation
in interface AmazonQConnect
public GetContentResult getContent(GetContentRequest request)
AmazonQConnect
Retrieves content, including a pre-signed URL to download the content.
getContent
in interface AmazonQConnect
public GetContentSummaryResult getContentSummary(GetContentSummaryRequest request)
AmazonQConnect
Retrieves summary information about the content.
getContentSummary
in interface AmazonQConnect
public GetImportJobResult getImportJob(GetImportJobRequest request)
AmazonQConnect
Retrieves the started import job.
getImportJob
in interface AmazonQConnect
public GetKnowledgeBaseResult getKnowledgeBase(GetKnowledgeBaseRequest request)
AmazonQConnect
Retrieves information about the knowledge base.
getKnowledgeBase
in interface AmazonQConnect
public GetQuickResponseResult getQuickResponse(GetQuickResponseRequest request)
AmazonQConnect
Retrieves the quick response.
getQuickResponse
in interface AmazonQConnect
@Deprecated public GetRecommendationsResult getRecommendations(GetRecommendationsRequest request)
AmazonQConnect
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 AmazonQConnect
public GetSessionResult getSession(GetSessionRequest request)
AmazonQConnect
Retrieves information for a specified session.
getSession
in interface AmazonQConnect
public ListAssistantAssociationsResult listAssistantAssociations(ListAssistantAssociationsRequest request)
AmazonQConnect
Lists information about assistant associations.
listAssistantAssociations
in interface AmazonQConnect
public ListAssistantsResult listAssistants(ListAssistantsRequest request)
AmazonQConnect
Lists information about assistants.
listAssistants
in interface AmazonQConnect
public ListContentsResult listContents(ListContentsRequest request)
AmazonQConnect
Lists the content.
listContents
in interface AmazonQConnect
public ListImportJobsResult listImportJobs(ListImportJobsRequest request)
AmazonQConnect
Lists information about import jobs.
listImportJobs
in interface AmazonQConnect
public ListKnowledgeBasesResult listKnowledgeBases(ListKnowledgeBasesRequest request)
AmazonQConnect
Lists the knowledge bases.
listKnowledgeBases
in interface AmazonQConnect
public ListQuickResponsesResult listQuickResponses(ListQuickResponsesRequest request)
AmazonQConnect
Lists information about quick response.
listQuickResponses
in interface AmazonQConnect
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonQConnect
Lists the tags for the specified resource.
listTagsForResource
in interface AmazonQConnect
public 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 AmazonQConnect
public PutFeedbackResult putFeedback(PutFeedbackRequest request)
AmazonQConnect
Provides 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)
AmazonQConnect
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
queryAssistant
in interface AmazonQConnect
public RemoveKnowledgeBaseTemplateUriResult removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest request)
AmazonQConnect
Removes a URI template from a knowledge base.
removeKnowledgeBaseTemplateUri
in interface AmazonQConnect
public SearchContentResult searchContent(SearchContentRequest request)
AmazonQConnect
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
searchContent
in interface AmazonQConnect
public SearchQuickResponsesResult searchQuickResponses(SearchQuickResponsesRequest request)
AmazonQConnect
Searches existing Amazon Q quick responses in an Amazon Q knowledge base.
searchQuickResponses
in interface AmazonQConnect
public SearchSessionsResult searchSessions(SearchSessionsRequest request)
AmazonQConnect
Searches for sessions.
searchSessions
in interface AmazonQConnect
public StartContentUploadResult startContentUpload(StartContentUploadRequest request)
AmazonQConnect
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.
startContentUpload
in interface AmazonQConnect
public StartImportJobResult startImportJob(StartImportJobRequest request)
AmazonQConnect
Start an asynchronous job to import Amazon Q 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 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 AmazonQConnect
public TagResourceResult tagResource(TagResourceRequest request)
AmazonQConnect
Adds the specified tags to the specified resource.
tagResource
in interface AmazonQConnect
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonQConnect
Removes the specified tags from the specified resource.
untagResource
in interface AmazonQConnect
public UpdateContentResult updateContent(UpdateContentRequest request)
AmazonQConnect
Updates information about the content.
updateContent
in interface AmazonQConnect
public 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 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 AmazonQConnect
public UpdateQuickResponseResult updateQuickResponse(UpdateQuickResponseRequest request)
AmazonQConnect
Updates an existing Amazon Q quick response.
updateQuickResponse
in interface AmazonQConnect
public void shutdown()
AmazonQConnect
shutdown
in interface AmazonQConnect
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonQConnect
Response 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 AmazonQConnect
request
- The originally executed request.