WisdomClient

Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers. Agents can search across connected repositories from within their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a knowledge base, for example, or manage content by uploading custom files.

Installation

NPM
npm install @aws-sdk/client-wisdom
Yarn
yarn add @aws-sdk/client-wisdom
pnpm
pnpm add @aws-sdk/client-wisdom

WisdomClient Operations

Command
Summary
CreateAssistantAssociationCommand

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.

CreateAssistantCommand

Creates an Amazon Connect Wisdom assistant.

CreateContentCommand

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

CreateKnowledgeBaseCommand

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:

  1. Call DeleteKnowledgeBase .

  2. Call DeleteDataIntegration .

  3. Call CreateDataIntegration  to recreate the DataIntegration or a create different one.

  4. Call CreateKnowledgeBase.

CreateQuickResponseCommand

Creates a Wisdom quick response.

CreateSessionCommand

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.

DeleteAssistantAssociationCommand

Deletes an assistant association.

DeleteAssistantCommand

Deletes an assistant.

DeleteContentCommand

Deletes the content.

DeleteImportJobCommand

Deletes the quick response import job.

DeleteKnowledgeBaseCommand

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.

DeleteQuickResponseCommand

Deletes a quick response.

GetAssistantAssociationCommand

Retrieves information about an assistant association.

GetAssistantCommand

Retrieves information about an assistant.

GetContentCommand

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

GetContentSummaryCommand

Retrieves summary information about the content.

GetImportJobCommand

Retrieves the started import job.

GetKnowledgeBaseCommand

Retrieves information about the knowledge base.

GetQuickResponseCommand

Retrieves the quick response.

GetRecommendationsCommand

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 .

GetSessionCommand

Retrieves information for a specified session.

ListAssistantAssociationsCommand

Lists information about assistant associations.

ListAssistantsCommand

Lists information about assistants.

ListContentsCommand

Lists the content.

ListImportJobsCommand

Lists information about import jobs.

ListKnowledgeBasesCommand

Lists the knowledge bases.

ListQuickResponsesCommand

Lists information about quick response.

ListTagsForResourceCommand

Lists the tags for the specified resource.

NotifyRecommendationsReceivedCommand

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.

QueryAssistantCommand

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

RemoveKnowledgeBaseTemplateUriCommand

Removes a URI template from a knowledge base.

SearchContentCommand

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

SearchQuickResponsesCommand

Searches existing Wisdom quick responses in a Wisdom knowledge base.

SearchSessionsCommand

Searches for sessions.

StartContentUploadCommand

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.

StartImportJobCommand

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 .

TagResourceCommand

Adds the specified tags to the specified resource.

UntagResourceCommand

Removes the specified tags from the specified resource.

UpdateContentCommand

Updates information about the content.

UpdateKnowledgeBaseTemplateUriCommand

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.

UpdateQuickResponseCommand

Updates an existing Wisdom quick response.

WisdomClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: WisdomClientConfig