AWS.Wisdom — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createAssistant(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Connect Wisdom assistant.

createAssistantAssociation(params = {}, callback) ⇒ AWS.Request

Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.

createContent(params = {}, callback) ⇒ AWS.Request

Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.

createKnowledgeBase(params = {}, callback) ⇒ AWS.Request

Creates a knowledge base.

Note: 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:

1. Call DeleteKnowledgeBase.
2. Call DeleteDataIntegration.
3. Call CreateDataIntegration to recreate the DataIntegration or a create different one.
4. Call CreateKnowledgeBase.

createQuickResponse(params = {}, callback) ⇒ AWS.Request

Creates a Wisdom quick response.

createSession(params = {}, callback) ⇒ AWS.Request

Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.

deleteAssistant(params = {}, callback) ⇒ AWS.Request

deleteAssistantAssociation(params = {}, callback) ⇒ AWS.Request

Deletes an assistant association.

deleteContent(params = {}, callback) ⇒ AWS.Request

deleteImportJob(params = {}, callback) ⇒ AWS.Request

Deletes the quick response import job.

deleteKnowledgeBase(params = {}, callback) ⇒ AWS.Request

Deletes the knowledge base.

Note: 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.

deleteQuickResponse(params = {}, callback) ⇒ AWS.Request

Deletes a quick response.

getAssistant(params = {}, callback) ⇒ AWS.Request

Retrieves information about an assistant.

getAssistantAssociation(params = {}, callback) ⇒ AWS.Request

Retrieves information about an assistant association.

getContent(params = {}, callback) ⇒ AWS.Request

Retrieves content, including a pre-signed URL to download the content.

getContentSummary(params = {}, callback) ⇒ AWS.Request

Retrieves summary information about the content.

getImportJob(params = {}, callback) ⇒ AWS.Request

Retrieves the started import job.

getKnowledgeBase(params = {}, callback) ⇒ AWS.Request

Retrieves information about the knowledge base.

getQuickResponse(params = {}, callback) ⇒ AWS.Request

Retrieves the quick response.

getRecommendations(params = {}, callback) ⇒ AWS.Request

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.

getSession(params = {}, callback) ⇒ AWS.Request

Retrieves information for a specified session.

listAssistantAssociations(params = {}, callback) ⇒ AWS.Request

Lists information about assistant associations.

listAssistants(params = {}, callback) ⇒ AWS.Request

Lists information about assistants.

listImportJobs(params = {}, callback) ⇒ AWS.Request

Lists information about import jobs.

listKnowledgeBases(params = {}, callback) ⇒ AWS.Request

Lists the knowledge bases.

listQuickResponses(params = {}, callback) ⇒ AWS.Request

Lists information about quick response.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags for the specified resource.

notifyRecommendationsReceived(params = {}, callback) ⇒ AWS.Request

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.

queryAssistant(params = {}, callback) ⇒ AWS.Request

Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.

removeKnowledgeBaseTemplateUri(params = {}, callback) ⇒ AWS.Request

Removes a URI template from a knowledge base.

searchContent(params = {}, callback) ⇒ AWS.Request

Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.

searchQuickResponses(params = {}, callback) ⇒ AWS.Request

Searches existing Wisdom quick responses in a Wisdom knowledge base.

searchSessions(params = {}, callback) ⇒ AWS.Request

startContentUpload(params = {}, callback) ⇒ AWS.Request

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.

startImportJob(params = {}, callback) ⇒ AWS.Request

Start an asynchronous job to import Wisdom resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.

• For importing Wisdom 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.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds the specified tags to the specified resource.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes the specified tags from the specified resource.

updateContent(params = {}, callback) ⇒ AWS.Request

Updates information about the content.

updateKnowledgeBaseTemplateUri(params = {}, callback) ⇒ AWS.Request

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 Wisdom 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.

updateQuickResponse(params = {}, callback) ⇒ AWS.Request

Updates an existing Wisdom quick response.