Class: AWS.Wisdom
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.Wisdom
- Identifier:
- wisdom
- API Version:
- 2020-10-19
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
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.
Sending a Request Using Wisdom
var wisdom = new AWS.Wisdom();
wisdom.createAssistant(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the Wisdom object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var wisdom = new AWS.Wisdom({apiVersion: '2020-10-19'});
You can also set the API version globally in AWS.config.apiVersions
using
the wisdom service identifier:
AWS.config.apiVersions = {
wisdom: '2020-10-19',
// other service API versions
};
var wisdom = new AWS.Wisdom();
Version:
-
2020-10-19
Constructor Summary collapse
-
new AWS.Wisdom(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
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.
-
createContent(params = {}, callback) ⇒ AWS.Request
Creates Wisdom content.
-
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.- createQuickResponse(params = {}, callback) ⇒ AWS.Request
Creates a Wisdom quick response.
.
- createSession(params = {}, callback) ⇒ AWS.Request
Creates a session.
- deleteAssistant(params = {}, callback) ⇒ AWS.Request
Deletes an assistant.
.
- deleteAssistantAssociation(params = {}, callback) ⇒ AWS.Request
Deletes an assistant association.
.
- deleteContent(params = {}, callback) ⇒ AWS.Request
Deletes the content.
.
- 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.- 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.
- 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.
.
- listContents(params = {}, callback) ⇒ AWS.Request
Lists the content.
.
- 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.
- queryAssistant(params = {}, callback) ⇒ AWS.Request
Performs a manual search against the specified assistant.
- 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.
- searchQuickResponses(params = {}, callback) ⇒ AWS.Request
Searches existing Wisdom quick responses in a Wisdom knowledge base.
.
- searchSessions(params = {}, callback) ⇒ AWS.Request
Searches for sessions.
.
- startContentUpload(params = {}, callback) ⇒ AWS.Request
Get a URL to upload content to a knowledge base.
- startImportJob(params = {}, callback) ⇒ AWS.Request
Start an asynchronous job to import Wisdom resources from an uploaded source file.
- 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.
- updateQuickResponse(params = {}, callback) ⇒ AWS.Request
Updates an existing Wisdom quick response.
.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.Wisdom(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Examples:
Constructing a Wisdom object
var wisdom = new AWS.Wisdom({apiVersion: '2020-10-19'});
Options Hash (options):
-
params
(map)
—
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
-
endpoint
(String|AWS.Endpoint)
—
The endpoint URI to send requests to. The default endpoint is built from the configured
region
. The endpoint should be a string like'https://{service}.{region}.amazonaws.com'
or an Endpoint object. -
accessKeyId
(String)
—
your AWS access key ID.
-
secretAccessKey
(String)
—
your AWS secret access key.
-
sessionToken
(AWS.Credentials)
—
the optional AWS session token to sign requests with.
-
credentials
(AWS.Credentials)
—
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
-
credentialProvider
(AWS.CredentialProviderChain)
—
the provider chain used to resolve credentials if no static
credentials
property is set. -
region
(String)
—
the region to send service requests to. See AWS.Wisdom.region for more information.
-
maxRetries
(Integer)
—
the maximum amount of retries to attempt with a request. See AWS.Wisdom.maxRetries for more information.
-
maxRedirects
(Integer)
—
the maximum amount of redirects to follow with a request. See AWS.Wisdom.maxRedirects for more information.
-
sslEnabled
(Boolean)
—
whether to enable SSL for requests.
-
paramValidation
(Boolean|map)
—
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
true
. - max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
computeChecksums
(Boolean)
—
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
-
convertResponseTypes
(Boolean)
—
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to
true
. -
correctClockSkew
(Boolean)
—
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to
false
. -
s3ForcePathStyle
(Boolean)
—
whether to force path style URLs for S3 objects.
-
s3BucketEndpoint
(Boolean)
—
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an
endpoint
to be provided explicitly to the service constructor. -
s3DisableBodySigning
(Boolean)
—
whether S3 body signing should be disabled when using signature version
v4
. Body signing can only be disabled when using https. Defaults totrue
. -
s3UsEast1RegionalEndpoint
('legacy'|'regional')
—
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to
legacy
-
s3UseArnRegion
(Boolean)
—
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to
true
-
retryDelayOptions
(map)
—
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a
retry count and error and returns the amount of time to delay in
milliseconds. If the result is a non-zero negative value, no further
retry attempts will be made. The
base
option will be ignored if this option is supplied. The function is only called for retryable errors.
-
httpOptions
(map)
—
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform
HTTP requests with. Used for connection pooling. Defaults to the global
agent (
http.globalAgent
) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment. - connectTimeout [Integer] — Sets the socket to timeout after
failing to establish a connection with the server after
connectTimeout
milliseconds. This timeout has no effect once a socket connection has been established. - timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
-
apiVersion
(String, Date)
—
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by
apiVersions
). Specify 'latest' to use the latest possible version. -
apiVersions
(map<String, String|Date>)
—
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
-
logger
(#write, #log)
—
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
-
systemClockOffset
(Number)
—
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global
AWS.config
object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds. -
signatureVersion
(String)
—
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
-
signatureCache
(Boolean)
—
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to
true
. -
dynamoDbCrc32
(Boolean)
—
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default:
true
. -
useAccelerateEndpoint
(Boolean)
—
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default:
false
. -
clientSideMonitoring
(Boolean)
—
whether to collect and publish this client's performance metrics of all its API requests.
-
endpointDiscoveryEnabled
(Boolean|undefined)
—
whether to call operations with endpoints given by service dynamically. Setting this
-
endpointCacheSize
(Number)
—
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
-
hostPrefixEnabled
(Boolean)
—
whether to marshal request parameters to the prefix of hostname. Defaults to
true
. -
stsRegionalEndpoints
('legacy'|'regional')
—
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
-
useFipsEndpoint
(Boolean)
—
Enables FIPS compatible endpoints. Defaults to
false
. -
useDualstackEndpoint
(Boolean)
—
Enables IPv6 dualstack endpoint. Defaults to
false
.
Property Details
Method Details
createAssistant(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Connect Wisdom assistant.
Service Reference:
Examples:
Calling the createAssistant operation
var params = { name: 'STRING_VALUE', /* required */ type: AGENT, /* required */ clientToken: 'STRING_VALUE', description: 'STRING_VALUE', serverSideEncryptionConfiguration: { kmsKeyId: 'STRING_VALUE' }, tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; wisdom.createAssistant(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
If a token is not provided, the SDK will use a version 4 UUID.description
— (String
)The description of the assistant.
name
— (String
)The name of the assistant.
serverSideEncryptionConfiguration
— (map
)The configuration information for the customer managed key used for encryption.
The customer managed key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
, andkms:Decrypt/kms:GenerateDataKey
permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allowkms:Decrypt
,kms:GenerateDataKey*
, andkms:DescribeKey
permissions to theconnect.amazonaws.com
service principal.For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
kmsKeyId
— (String
)The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId).
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
type
— (String
)The type of assistant.
Possible values include:"AGENT"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:assistant
— (map
)Information about the assistant.
assistantArn
— required — (String
)The Amazon Resource Name (ARN) of the Wisdom assistant.
assistantId
— required — (String
)The identifier of the Wisdom assistant.
description
— (String
)The description.
integrationConfiguration
— (map
)The configuration information for the Wisdom assistant integration.
topicIntegrationArn
— (String
)The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
name
— required — (String
)The name.
serverSideEncryptionConfiguration
— (map
)The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
, andkms:Decrypt/kms:GenerateDataKey
permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allowkms:Decrypt
,kms:GenerateDataKey*
, andkms:DescribeKey
permissions to theconnect.amazonaws.com
service principal.For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
kmsKeyId
— (String
)The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId).
status
— required — (String
)The status of the assistant.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"ACTIVE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
type
— required — (String
)The type of assistant.
Possible values include:"AGENT"
-
(AWS.Response)
—
Returns:
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.
Service Reference:
Examples:
Calling the createAssistantAssociation operation
var params = { assistantId: 'STRING_VALUE', /* required */ association: { /* required */ knowledgeBaseId: 'STRING_VALUE' }, associationType: KNOWLEDGE_BASE, /* required */ clientToken: 'STRING_VALUE', tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; wisdom.createAssistantAssociation(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
assistantId
— (String
)The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
association
— (map
)The identifier of the associated resource.
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
associationType
— (String
)The type of association.
Possible values include:"KNOWLEDGE_BASE"
clientToken
— (String
)A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
If a token is not provided, the SDK will use a version 4 UUID.tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:assistantAssociation
— (map
)The assistant association.
assistantArn
— required — (String
)The Amazon Resource Name (ARN) of the Wisdom assistant.
assistantAssociationArn
— required — (String
)The Amazon Resource Name (ARN) of the assistant association.
assistantAssociationId
— required — (String
)The identifier of the assistant association.
assistantId
— required — (String
)The identifier of the Wisdom assistant.
associationData
— required — (map
)A union type that currently has a single argument, the knowledge base ID.
knowledgeBaseAssociation
— (map
)The knowledge base where output data is sent.
knowledgeBaseArn
— (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
associationType
— required — (String
)The type of association.
Possible values include:"KNOWLEDGE_BASE"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
-
(AWS.Response)
—
Returns:
createContent(params = {}, callback) ⇒ AWS.Request
Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.
Service Reference:
Examples:
Calling the createContent operation
var params = { knowledgeBaseId: 'STRING_VALUE', /* required */ name: 'STRING_VALUE', /* required */ uploadId: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', metadata: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ }, overrideLinkOutUri: 'STRING_VALUE', tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ }, title: 'STRING_VALUE' }; wisdom.createContent(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
If a token is not provided, the SDK will use a version 4 UUID.knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
metadata
— (map<String>
)A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
name
— (String
)The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.
overrideLinkOutUri
— (String
)The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
title
— (String
)The title of the content. If not set, the title is equal to the name.
uploadId
— (String
)A pointer to the uploaded asset. This value is returned by StartContentUpload.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:content
— (map
)The content.
contentArn
— required — (String
)The Amazon Resource Name (ARN) of the content.
contentId
— required — (String
)The identifier of the content.
contentType
— required — (String
)The media type of the content.
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
linkOutUri
— (String
)The URI of the content.
metadata
— required — (map<String>
)A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
name
— required — (String
)The name of the content.
revisionId
— required — (String
)The identifier of the content revision.
status
— required — (String
)The status of the content.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"ACTIVE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
"UPDATE_FAILED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
title
— required — (String
)The title of the content.
url
— required — (String
)The URL of the content.
urlExpiry
— required — (Date
)The expiration time of the URL as an epoch timestamp.
-
(AWS.Response)
—
Returns:
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 anInvalidRequestException
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.
Service Reference:
Examples:
Calling the createKnowledgeBase operation
var params = { knowledgeBaseType: EXTERNAL | CUSTOM | QUICK_RESPONSES, /* required */ name: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', description: 'STRING_VALUE', renderingConfiguration: { templateUri: 'STRING_VALUE' }, serverSideEncryptionConfiguration: { kmsKeyId: 'STRING_VALUE' }, sourceConfiguration: { appIntegrations: { appIntegrationArn: 'STRING_VALUE', /* required */ objectFields: [ 'STRING_VALUE', /* more items */ ] } }, tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; wisdom.createKnowledgeBase(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
If a token is not provided, the SDK will use a version 4 UUID.description
— (String
)The description.
knowledgeBaseType
— (String
)The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
Possible values include:"EXTERNAL"
"CUSTOM"
"QUICK_RESPONSES"
name
— (String
)The name of the knowledge base.
renderingConfiguration
— (map
)Information about how to render the content.
templateUri
— (String
)A URI template containing exactly one variable in
${variableName}
format. This can only be set forEXTERNAL
knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:-
Salesforce:
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, orIsDeleted
-
ServiceNow:
number
,short_description
,sys_mod_count
,workflow_state
, oractive
-
Zendesk:
id
,title
,updated_at
, ordraft
The variable is replaced with the actual value for a piece of content when calling GetContent.
-
serverSideEncryptionConfiguration
— (map
)The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
, andkms:Decrypt/kms:GenerateDataKey
permissions to the IAM identity using the key to invoke Wisdom.For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
kmsKeyId
— (String
)The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId).
sourceConfiguration
— (map
)The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.
appIntegrations
— (map
)Configuration information for Amazon AppIntegrations to automatically ingest content.
appIntegrationArn
— required — (String
)The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
-
For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
as source fields. -
For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least
number
,short_description
,sys_mod_count
,workflow_state
, andactive
as source fields. -
For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if
objectFields
is not provided, including at leastid
,title
,updated_at
, anddraft
as source fields. -
For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among
docx
,pdf
,html
,htm
, andtxt
. -
For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The
SourceURI
of your DataIntegration must use the following format:s3://your_s3_bucket_name
.The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal
app-integrations.amazonaws.com
to performs3:ListBucket
,s3:GetObject
, ands3:GetBucketLocation
against the bucket.
-
objectFields
— (Array<String>
)The fields from the source that are made available to your agents in Wisdom. Optional if ObjectConfiguration is included in the provided DataIntegration.
-
For Salesforce, you must include at least
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
. -
For ServiceNow, you must include at least
number
,short_description
,sys_mod_count
,workflow_state
, andactive
. -
For Zendesk, you must include at least
id
,title
,updated_at
, anddraft
.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
-
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:knowledgeBase
— (map
)The knowledge base.
description
— (String
)The description.
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
knowledgeBaseType
— required — (String
)The type of knowledge base.
Possible values include:"EXTERNAL"
"CUSTOM"
"QUICK_RESPONSES"
lastContentModificationTime
— (Date
)An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
name
— required — (String
)The name of the knowledge base.
renderingConfiguration
— (map
)Information about how to render the content.
templateUri
— (String
)A URI template containing exactly one variable in
${variableName}
format. This can only be set forEXTERNAL
knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:-
Salesforce:
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, orIsDeleted
-
ServiceNow:
number
,short_description
,sys_mod_count
,workflow_state
, oractive
-
Zendesk:
id
,title
,updated_at
, ordraft
The variable is replaced with the actual value for a piece of content when calling GetContent.
-
serverSideEncryptionConfiguration
— (map
)The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
, andkms:Decrypt/kms:GenerateDataKey
permissions to the IAM identity using the key to invoke Wisdom.For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
kmsKeyId
— (String
)The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId).
sourceConfiguration
— (map
)Source configuration information about the knowledge base.
appIntegrations
— (map
)Configuration information for Amazon AppIntegrations to automatically ingest content.
appIntegrationArn
— required — (String
)The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
-
For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
as source fields. -
For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least
number
,short_description
,sys_mod_count
,workflow_state
, andactive
as source fields. -
For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if
objectFields
is not provided, including at leastid
,title
,updated_at
, anddraft
as source fields. -
For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among
docx
,pdf
,html
,htm
, andtxt
. -
For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The
SourceURI
of your DataIntegration must use the following format:s3://your_s3_bucket_name
.The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal
app-integrations.amazonaws.com
to performs3:ListBucket
,s3:GetObject
, ands3:GetBucketLocation
against the bucket.
-
objectFields
— (Array<String>
)The fields from the source that are made available to your agents in Wisdom. Optional if ObjectConfiguration is included in the provided DataIntegration.
-
For Salesforce, you must include at least
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
. -
For ServiceNow, you must include at least
number
,short_description
,sys_mod_count
,workflow_state
, andactive
. -
For Zendesk, you must include at least
id
,title
,updated_at
, anddraft
.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
-
status
— required — (String
)The status of the knowledge base.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"ACTIVE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
-
(AWS.Response)
—
Returns:
createQuickResponse(params = {}, callback) ⇒ AWS.Request
Creates a Wisdom quick response.
Service Reference:
Examples:
Calling the createQuickResponse operation
var params = { content: { /* required */ content: 'STRING_VALUE' }, knowledgeBaseId: 'STRING_VALUE', /* required */ name: 'STRING_VALUE', /* required */ channels: [ 'STRING_VALUE', /* more items */ ], clientToken: 'STRING_VALUE', contentType: 'STRING_VALUE', description: 'STRING_VALUE', groupingConfiguration: { criteria: 'STRING_VALUE', values: [ 'STRING_VALUE', /* more items */ ] }, isActive: true || false, language: 'STRING_VALUE', shortcutKey: 'STRING_VALUE', tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; wisdom.createQuickResponse(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
channels
— (Array<String>
)The Amazon Connect channels this quick response applies to.
clientToken
— (String
)A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
If a token is not provided, the SDK will use a version 4 UUID.content
— (map
)The content of the quick response.
content
— (String
)The content of the quick response.
contentType
— (String
)The media type of the quick response content.
-
Use
application/x.quickresponse;format=plain
for a quick response written in plain text. -
Use
application/x.quickresponse;format=markdown
for a quick response written in richtext.
-
description
— (String
)The description of the quick response.
groupingConfiguration
— (map
)The configuration information of the user groups that the quick response is accessible to.
criteria
— (String
)The criteria used for grouping Wisdom users.
The following is the list of supported criteria values.
-
RoutingProfileArn
: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
-
values
— (Array<String>
)The list of values that define different groups of Wisdom users.
-
When setting
criteria
toRoutingProfileArn
, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
-
isActive
— (Boolean
)Whether the quick response is active.
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
language
— (String
)The language code value for the language in which the quick response is written. The supported language codes include
de_DE
,en_US
,es_ES
,fr_FR
,id_ID
,it_IT
,ja_JP
,ko_KR
,pt_BR
,zh_CN
,zh_TW
name
— (String
)The name of the quick response.
shortcutKey
— (String
)The shortcut key of the quick response. The value should be unique across the knowledge base.
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:quickResponse
— (map
)The quick response.
channels
— (Array<String>
)The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
Chat
.contentType
— required — (String
)The media type of the quick response content.
-
Use
application/x.quickresponse;format=plain
for quick response written in plain text. -
Use
application/x.quickresponse;format=markdown
for quick response written in richtext.
-
contents
— (map
)The contents of the quick response.
markdown
— (map
)The container quick response content.
content
— (String
)The content of the quick response.
plainText
— (map
)The container quick response content.
content
— (String
)The content of the quick response.
createdTime
— required — (Date
)The timestamp when the quick response was created.
description
— (String
)The description of the quick response.
groupingConfiguration
— (map
)The configuration information of the user groups that the quick response is accessible to.
criteria
— (String
)The criteria used for grouping Wisdom users.
The following is the list of supported criteria values.
-
RoutingProfileArn
: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
-
values
— (Array<String>
)The list of values that define different groups of Wisdom users.
-
When setting
criteria
toRoutingProfileArn
, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
-
isActive
— (Boolean
)Whether the quick response is active.
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
language
— (String
)The language code value for the language in which the quick response is written.
lastModifiedBy
— (String
)The Amazon Resource Name (ARN) of the user who last updated the quick response data.
lastModifiedTime
— required — (Date
)The timestamp when the quick response data was last modified.
name
— required — (String
)The name of the quick response.
quickResponseArn
— required — (String
)The Amazon Resource Name (ARN) of the quick response.
quickResponseId
— required — (String
)The identifier of the quick response.
shortcutKey
— (String
)The shortcut key of the quick response. The value should be unique across the knowledge base.
status
— required — (String
)The status of the quick response data.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"CREATED"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
"UPDATE_IN_PROGRESS"
"UPDATE_FAILED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
-
(AWS.Response)
—
Returns:
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.
Service Reference:
Examples:
Calling the createSession operation
var params = { assistantId: 'STRING_VALUE', /* required */ name: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', description: 'STRING_VALUE', tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; wisdom.createSession(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
assistantId
— (String
)The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
clientToken
— (String
)A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
If a token is not provided, the SDK will use a version 4 UUID.description
— (String
)The description.
name
— (String
)The name of the session.
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:session
— (map
)The session.
description
— (String
)The description of the session.
integrationConfiguration
— (map
)The configuration information for the session integration.
topicIntegrationArn
— (String
)The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
name
— required — (String
)The name of the session.
sessionArn
— required — (String
)The Amazon Resource Name (ARN) of the session.
sessionId
— required — (String
)The identifier of the session.
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
-
(AWS.Response)
—
Returns:
deleteAssistant(params = {}, callback) ⇒ AWS.Request
Deletes an assistant.
Service Reference:
Examples:
Calling the deleteAssistant operation
var params = { assistantId: 'STRING_VALUE' /* required */ }; wisdom.deleteAssistant(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
assistantId
— (String
)The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteAssistantAssociation(params = {}, callback) ⇒ AWS.Request
Deletes an assistant association.
Service Reference:
Examples:
Calling the deleteAssistantAssociation operation
var params = { assistantAssociationId: 'STRING_VALUE', /* required */ assistantId: 'STRING_VALUE' /* required */ }; wisdom.deleteAssistantAssociation(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
assistantAssociationId
— (String
)The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
assistantId
— (String
)The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteContent(params = {}, callback) ⇒ AWS.Request
Deletes the content.
Service Reference:
Examples:
Calling the deleteContent operation
var params = { contentId: 'STRING_VALUE', /* required */ knowledgeBaseId: 'STRING_VALUE' /* required */ }; wisdom.deleteContent(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
contentId
— (String
)The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteImportJob(params = {}, callback) ⇒ AWS.Request
Deletes the quick response import job.
Service Reference:
Examples:
Calling the deleteImportJob operation
var params = { importJobId: 'STRING_VALUE', /* required */ knowledgeBaseId: 'STRING_VALUE' /* required */ }; wisdom.deleteImportJob(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
importJobId
— (String
)The identifier of the import job to be deleted.
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
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.Service Reference:
Examples:
Calling the deleteKnowledgeBase operation
var params = { knowledgeBaseId: 'STRING_VALUE' /* required */ }; wisdom.deleteKnowledgeBase(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
knowledgeBaseId
— (String
)The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteQuickResponse(params = {}, callback) ⇒ AWS.Request
Deletes a quick response.
Service Reference:
Examples:
Calling the deleteQuickResponse operation
var params = { knowledgeBaseId: 'STRING_VALUE', /* required */ quickResponseId: 'STRING_VALUE' /* required */ }; wisdom.deleteQuickResponse(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
knowledgeBaseId
— (String
)The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
quickResponseId
— (String
)The identifier of the quick response to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
getAssistant(params = {}, callback) ⇒ AWS.Request
Retrieves information about an assistant.
Service Reference:
Examples:
Calling the getAssistant operation
var params = { assistantId: 'STRING_VALUE' /* required */ }; wisdom.getAssistant(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
assistantId
— (String
)The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:assistant
— (map
)Information about the assistant.
assistantArn
— required — (String
)The Amazon Resource Name (ARN) of the Wisdom assistant.
assistantId
— required — (String
)The identifier of the Wisdom assistant.
description
— (String
)The description.
integrationConfiguration
— (map
)The configuration information for the Wisdom assistant integration.
topicIntegrationArn
— (String
)The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
name
— required — (String
)The name.
serverSideEncryptionConfiguration
— (map
)The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
, andkms:Decrypt/kms:GenerateDataKey
permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allowkms:Decrypt
,kms:GenerateDataKey*
, andkms:DescribeKey
permissions to theconnect.amazonaws.com
service principal.For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
kmsKeyId
— (String
)The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId).
status
— required — (String
)The status of the assistant.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"ACTIVE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
type
— required — (String
)The type of assistant.
Possible values include:"AGENT"
-
(AWS.Response)
—
Returns:
getAssistantAssociation(params = {}, callback) ⇒ AWS.Request
Retrieves information about an assistant association.
Service Reference:
Examples:
Calling the getAssistantAssociation operation
var params = { assistantAssociationId: 'STRING_VALUE', /* required */ assistantId: 'STRING_VALUE' /* required */ }; wisdom.getAssistantAssociation(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
assistantAssociationId
— (String
)The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
assistantId
— (String
)The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:assistantAssociation
— (map
)The assistant association.
assistantArn
— required — (String
)The Amazon Resource Name (ARN) of the Wisdom assistant.
assistantAssociationArn
— required — (String
)The Amazon Resource Name (ARN) of the assistant association.
assistantAssociationId
— required — (String
)The identifier of the assistant association.
assistantId
— required — (String
)The identifier of the Wisdom assistant.
associationData
— required — (map
)A union type that currently has a single argument, the knowledge base ID.
knowledgeBaseAssociation
— (map
)The knowledge base where output data is sent.
knowledgeBaseArn
— (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
associationType
— required — (String
)The type of association.
Possible values include:"KNOWLEDGE_BASE"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
-
(AWS.Response)
—
Returns:
getContent(params = {}, callback) ⇒ AWS.Request
Retrieves content, including a pre-signed URL to download the content.
Service Reference:
Examples:
Calling the getContent operation
var params = { contentId: 'STRING_VALUE', /* required */ knowledgeBaseId: 'STRING_VALUE' /* required */ }; wisdom.getContent(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
contentId
— (String
)The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:content
— (map
)The content.
contentArn
— required — (String
)The Amazon Resource Name (ARN) of the content.
contentId
— required — (String
)The identifier of the content.
contentType
— required — (String
)The media type of the content.
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
linkOutUri
— (String
)The URI of the content.
metadata
— required — (map<String>
)A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
name
— required — (String
)The name of the content.
revisionId
— required — (String
)The identifier of the content revision.
status
— required — (String
)The status of the content.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"ACTIVE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
"UPDATE_FAILED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
title
— required — (String
)The title of the content.
url
— required — (String
)The URL of the content.
urlExpiry
— required — (Date
)The expiration time of the URL as an epoch timestamp.
-
(AWS.Response)
—
Returns:
getContentSummary(params = {}, callback) ⇒ AWS.Request
Retrieves summary information about the content.
Service Reference:
Examples:
Calling the getContentSummary operation
var params = { contentId: 'STRING_VALUE', /* required */ knowledgeBaseId: 'STRING_VALUE' /* required */ }; wisdom.getContentSummary(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
contentId
— (String
)The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:contentSummary
— (map
)The content summary.
contentArn
— required — (String
)The Amazon Resource Name (ARN) of the content.
contentId
— required — (String
)The identifier of the content.
contentType
— required — (String
)The media type of the content.
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
metadata
— required — (map<String>
)A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
name
— required — (String
)The name of the content.
revisionId
— required — (String
)The identifier of the revision of the content.
status
— required — (String
)The status of the content.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"ACTIVE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
"UPDATE_FAILED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
title
— required — (String
)The title of the content.
-
(AWS.Response)
—
Returns:
getImportJob(params = {}, callback) ⇒ AWS.Request
Retrieves the started import job.
Service Reference:
Examples:
Calling the getImportJob operation
var params = { importJobId: 'STRING_VALUE', /* required */ knowledgeBaseId: 'STRING_VALUE' /* required */ }; wisdom.getImportJob(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
importJobId
— (String
)The identifier of the import job to retrieve.
knowledgeBaseId
— (String
)The identifier of the knowledge base that the import job belongs to.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:importJob
— (map
)The import job.
createdTime
— required — (Date
)The timestamp when the import job was created.
externalSourceConfiguration
— (map
)The configuration information of the external data source.
configuration
— required — (map
)The configuration information of the external data source.
connectConfiguration
— (map
)The configuration information of the Amazon Connect data source.
instanceId
— (String
)The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
— required — (String
)The type of the external data source.
Possible values include:"AMAZON_CONNECT"
failedRecordReport
— (String
)The link to donwload the information of resource data that failed to be imported.
importJobId
— required — (String
)The identifier of the import job.
importJobType
— required — (String
)The type of the import job.
Possible values include:"QUICK_RESPONSES"
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
lastModifiedTime
— required — (Date
)The timestamp when the import job data was last modified.
metadata
— (map<String>
)The metadata fields of the imported Wisdom resources.
status
— required — (String
)The status of the import job.
Possible values include:"START_IN_PROGRESS"
"FAILED"
"COMPLETE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
uploadId
— required — (String
)A pointer to the uploaded asset. This value is returned by StartContentUpload.
url
— required — (String
)The download link to the resource file that is uploaded to the import job.
urlExpiry
— required — (Date
)The expiration time of the URL as an epoch timestamp.
-
(AWS.Response)
—
Returns:
getKnowledgeBase(params = {}, callback) ⇒ AWS.Request
Retrieves information about the knowledge base.
Service Reference:
Examples:
Calling the getKnowledgeBase operation
var params = { knowledgeBaseId: 'STRING_VALUE' /* required */ }; wisdom.getKnowledgeBase(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:knowledgeBase
— (map
)The knowledge base.
description
— (String
)The description.
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
knowledgeBaseType
— required — (String
)The type of knowledge base.
Possible values include:"EXTERNAL"
"CUSTOM"
"QUICK_RESPONSES"
lastContentModificationTime
— (Date
)An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
name
— required — (String
)The name of the knowledge base.
renderingConfiguration
— (map
)Information about how to render the content.
templateUri
— (String
)A URI template containing exactly one variable in
${variableName}
format. This can only be set forEXTERNAL
knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:-
Salesforce:
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, orIsDeleted
-
ServiceNow:
number
,short_description
,sys_mod_count
,workflow_state
, oractive
-
Zendesk:
id
,title
,updated_at
, ordraft
The variable is replaced with the actual value for a piece of content when calling GetContent.
-
serverSideEncryptionConfiguration
— (map
)The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
, andkms:Decrypt/kms:GenerateDataKey
permissions to the IAM identity using the key to invoke Wisdom.For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
kmsKeyId
— (String
)The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId).
sourceConfiguration
— (map
)Source configuration information about the knowledge base.
appIntegrations
— (map
)Configuration information for Amazon AppIntegrations to automatically ingest content.
appIntegrationArn
— required — (String
)The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
-
For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
as source fields. -
For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least
number
,short_description
,sys_mod_count
,workflow_state
, andactive
as source fields. -
For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if
objectFields
is not provided, including at leastid
,title
,updated_at
, anddraft
as source fields. -
For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among
docx
,pdf
,html
,htm
, andtxt
. -
For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The
SourceURI
of your DataIntegration must use the following format:s3://your_s3_bucket_name
.The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal
app-integrations.amazonaws.com
to performs3:ListBucket
,s3:GetObject
, ands3:GetBucketLocation
against the bucket.
-
objectFields
— (Array<String>
)The fields from the source that are made available to your agents in Wisdom. Optional if ObjectConfiguration is included in the provided DataIntegration.
-
For Salesforce, you must include at least
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
. -
For ServiceNow, you must include at least
number
,short_description
,sys_mod_count
,workflow_state
, andactive
. -
For Zendesk, you must include at least
id
,title
,updated_at
, anddraft
.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
-
status
— required — (String
)The status of the knowledge base.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"ACTIVE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
-
(AWS.Response)
—
Returns:
getQuickResponse(params = {}, callback) ⇒ AWS.Request
Retrieves the quick response.
Service Reference:
Examples:
Calling the getQuickResponse operation
var params = { knowledgeBaseId: 'STRING_VALUE', /* required */ quickResponseId: 'STRING_VALUE' /* required */ }; wisdom.getQuickResponse(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.
quickResponseId
— (String
)The identifier of the quick response.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:quickResponse
— (map
)The quick response.
channels
— (Array<String>
)The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
Chat
.contentType
— required — (String
)The media type of the quick response content.
-
Use
application/x.quickresponse;format=plain
for quick response written in plain text. -
Use
application/x.quickresponse;format=markdown
for quick response written in richtext.
-
contents
— (map
)The contents of the quick response.
markdown
— (map
)The container quick response content.
content
— (String
)The content of the quick response.
plainText
— (map
)The container quick response content.
content
— (String
)The content of the quick response.
createdTime
— required — (Date
)The timestamp when the quick response was created.
description
— (String
)The description of the quick response.
groupingConfiguration
— (map
)The configuration information of the user groups that the quick response is accessible to.
criteria
— (String
)The criteria used for grouping Wisdom users.
The following is the list of supported criteria values.
-
RoutingProfileArn
: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
-
values
— (Array<String>
)The list of values that define different groups of Wisdom users.
-
When setting
criteria
toRoutingProfileArn
, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
-
isActive
— (Boolean
)Whether the quick response is active.
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
language
— (String
)The language code value for the language in which the quick response is written.
lastModifiedBy
— (String
)The Amazon Resource Name (ARN) of the user who last updated the quick response data.
lastModifiedTime
— required — (Date
)The timestamp when the quick response data was last modified.
name
— required — (String
)The name of the quick response.
quickResponseArn
— required — (String
)The Amazon Resource Name (ARN) of the quick response.
quickResponseId
— required — (String
)The identifier of the quick response.
shortcutKey
— (String
)The shortcut key of the quick response. The value should be unique across the knowledge base.
status
— required — (String
)The status of the quick response data.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"CREATED"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
"UPDATE_IN_PROGRESS"
"UPDATE_FAILED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
-
(AWS.Response)
—
Returns:
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.Service Reference:
Examples:
Calling the getRecommendations operation
var params = { assistantId: 'STRING_VALUE', /* required */ sessionId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', waitTimeSeconds: 'NUMBER_VALUE' }; wisdom.getRecommendations(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
assistantId
— (String
)The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
maxResults
— (Integer
)The maximum number of results to return per page.
sessionId
— (String
)The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
waitTimeSeconds
— (Integer
)The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than
WaitTimeSeconds
. If no messages are available and the wait time expires, the call returns successfully with an empty list.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:recommendations
— (Array<map>
)The recommendations.
document
— required — (map
)The recommended document.
contentReference
— required — (map
)A reference to the content resource.
contentArn
— (String
)The Amazon Resource Name (ARN) of the content.
contentId
— (String
)The identifier of the content.
knowledgeBaseArn
— (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
excerpt
— (map
)The excerpt from the document.
highlights
— (Array<map>
)Highlights in the document text.
beginOffsetInclusive
— (Integer
)The offset for the start of the highlight.
endOffsetExclusive
— (Integer
)The offset for the end of the highlight.
text
— (String
)Text in the document.
title
— (map
)The title of the document.
highlights
— (Array<map>
)Highlights in the document text.
beginOffsetInclusive
— (Integer
)The offset for the start of the highlight.
endOffsetExclusive
— (Integer
)The offset for the end of the highlight.
text
— (String
)Text in the document.
recommendationId
— required — (String
)The identifier of the recommendation.
relevanceLevel
— (String
)The relevance level of the recommendation.
Possible values include:"HIGH"
"MEDIUM"
"LOW"
relevanceScore
— (Float
)The relevance score of the recommendation.
type
— (String
)The type of recommendation.
Possible values include:"KNOWLEDGE_CONTENT"
triggers
— (Array<map>
)The triggers corresponding to recommendations.
data
— required — (map
)A union type containing information related to the trigger.
query
— (map
)Data associated with the QUERY RecommendationTriggerType.
text
— (String
)The text associated with the recommendation trigger.
id
— required — (String
)The identifier of the recommendation trigger.
recommendationIds
— required — (Array<String>
)The identifiers of the recommendations.
source
— required — (String
)The source of the recommendation trigger.
-
ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.
-
RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.
"ISSUE_DETECTION"
"RULE_EVALUATION"
"OTHER"
-
type
— required — (String
)The type of recommendation trigger.
Possible values include:"QUERY"
-
(AWS.Response)
—
Returns:
getSession(params = {}, callback) ⇒ AWS.Request
Retrieves information for a specified session.
Service Reference:
Examples:
Calling the getSession operation
var params = { assistantId: 'STRING_VALUE', /* required */ sessionId: 'STRING_VALUE' /* required */ }; wisdom.getSession(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
assistantId
— (String
)The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
sessionId
— (String
)The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:session
— (map
)The session.
description
— (String
)The description of the session.
integrationConfiguration
— (map
)The configuration information for the session integration.
topicIntegrationArn
— (String
)The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
name
— required — (String
)The name of the session.
sessionArn
— required — (String
)The Amazon Resource Name (ARN) of the session.
sessionId
— required — (String
)The identifier of the session.
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
-
(AWS.Response)
—
Returns:
listAssistantAssociations(params = {}, callback) ⇒ AWS.Request
Lists information about assistant associations.
Service Reference:
Examples:
Calling the listAssistantAssociations operation
var params = { assistantId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; wisdom.listAssistantAssociations(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
assistantId
— (String
)The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
maxResults
— (Integer
)The maximum number of results to return per page.
nextToken
— (String
)The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:assistantAssociationSummaries
— (Array<map>
)Summary information about assistant associations.
assistantArn
— required — (String
)The Amazon Resource Name (ARN) of the Wisdom assistant.
assistantAssociationArn
— required — (String
)The Amazon Resource Name (ARN) of the assistant association.
assistantAssociationId
— required — (String
)The identifier of the assistant association.
assistantId
— required — (String
)The identifier of the Wisdom assistant.
associationData
— required — (map
)The association data.
knowledgeBaseAssociation
— (map
)The knowledge base where output data is sent.
knowledgeBaseArn
— (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
associationType
— required — (String
)The type of association.
Possible values include:"KNOWLEDGE_BASE"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
nextToken
— (String
)If there are additional results, this is the token for the next set of results.
-
(AWS.Response)
—
Returns:
listAssistants(params = {}, callback) ⇒ AWS.Request
Lists information about assistants.
Service Reference:
Examples:
Calling the listAssistants operation
var params = { maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; wisdom.listAssistants(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
maxResults
— (Integer
)The maximum number of results to return per page.
nextToken
— (String
)The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:assistantSummaries
— (Array<map>
)Information about the assistants.
assistantArn
— required — (String
)The Amazon Resource Name (ARN) of the Wisdom assistant.
assistantId
— required — (String
)The identifier of the Wisdom assistant.
description
— (String
)The description of the assistant.
integrationConfiguration
— (map
)The configuration information for the Wisdom assistant integration.
topicIntegrationArn
— (String
)The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
name
— required — (String
)The name of the assistant.
serverSideEncryptionConfiguration
— (map
)The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
, andkms:Decrypt/kms:GenerateDataKey
permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allowkms:Decrypt
,kms:GenerateDataKey*
, andkms:DescribeKey
permissions to theconnect.amazonaws.com
service principal.For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
kmsKeyId
— (String
)The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId).
status
— required — (String
)The status of the assistant.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"ACTIVE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
type
— required — (String
)The type of the assistant.
Possible values include:"AGENT"
nextToken
— (String
)If there are additional results, this is the token for the next set of results.
-
(AWS.Response)
—
Returns:
listContents(params = {}, callback) ⇒ AWS.Request
Lists the content.
Service Reference:
Examples:
Calling the listContents operation
var params = { knowledgeBaseId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; wisdom.listContents(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
maxResults
— (Integer
)The maximum number of results to return per page.
nextToken
— (String
)The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:contentSummaries
— (Array<map>
)Information about the content.
contentArn
— required — (String
)The Amazon Resource Name (ARN) of the content.
contentId
— required — (String
)The identifier of the content.
contentType
— required — (String
)The media type of the content.
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
metadata
— required — (map<String>
)A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
name
— required — (String
)The name of the content.
revisionId
— required — (String
)The identifier of the revision of the content.
status
— required — (String
)The status of the content.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"ACTIVE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
"UPDATE_FAILED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
title
— required — (String
)The title of the content.
nextToken
— (String
)If there are additional results, this is the token for the next set of results.
-
(AWS.Response)
—
Returns:
listImportJobs(params = {}, callback) ⇒ AWS.Request
Lists information about import jobs.
Service Reference:
Examples:
Calling the listImportJobs operation
var params = { knowledgeBaseId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; wisdom.listImportJobs(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
maxResults
— (Integer
)The maximum number of results to return per page.
nextToken
— (String
)The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:importJobSummaries
— (Array<map>
)Summary information about the import jobs.
createdTime
— required — (Date
)The timestamp when the import job was created.
externalSourceConfiguration
— (map
)The configuration information of the external source that the resource data are imported from.
configuration
— required — (map
)The configuration information of the external data source.
connectConfiguration
— (map
)The configuration information of the Amazon Connect data source.
instanceId
— (String
)The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
— required — (String
)The type of the external data source.
Possible values include:"AMAZON_CONNECT"
importJobId
— required — (String
)The identifier of the import job.
importJobType
— required — (String
)The type of import job.
Possible values include:"QUICK_RESPONSES"
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
lastModifiedTime
— required — (Date
)The timestamp when the import job was last modified.
metadata
— (map<String>
)The metadata fields of the imported Wisdom resources.
status
— required — (String
)The status of the import job.
Possible values include:"START_IN_PROGRESS"
"FAILED"
"COMPLETE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
uploadId
— required — (String
)A pointer to the uploaded asset. This value is returned by StartContentUpload.
nextToken
— (String
)The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
-
(AWS.Response)
—
Returns:
listKnowledgeBases(params = {}, callback) ⇒ AWS.Request
Lists the knowledge bases.
Service Reference:
Examples:
Calling the listKnowledgeBases operation
var params = { maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; wisdom.listKnowledgeBases(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
maxResults
— (Integer
)The maximum number of results to return per page.
nextToken
— (String
)The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:knowledgeBaseSummaries
— (Array<map>
)Information about the knowledge bases.
description
— (String
)The description of the knowledge base.
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
knowledgeBaseType
— required — (String
)The type of knowledge base.
Possible values include:"EXTERNAL"
"CUSTOM"
"QUICK_RESPONSES"
name
— required — (String
)The name of the knowledge base.
renderingConfiguration
— (map
)Information about how to render the content.
templateUri
— (String
)A URI template containing exactly one variable in
${variableName}
format. This can only be set forEXTERNAL
knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:-
Salesforce:
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, orIsDeleted
-
ServiceNow:
number
,short_description
,sys_mod_count
,workflow_state
, oractive
-
Zendesk:
id
,title
,updated_at
, ordraft
The variable is replaced with the actual value for a piece of content when calling GetContent.
-
serverSideEncryptionConfiguration
— (map
)The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
,kms:Decrypt/kms:GenerateDataKey
permissions to the IAM identity using the key to invoke Wisdom.For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
kmsKeyId
— (String
)The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId).
sourceConfiguration
— (map
)Configuration information about the external data source.
appIntegrations
— (map
)Configuration information for Amazon AppIntegrations to automatically ingest content.
appIntegrationArn
— required — (String
)The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
-
For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
as source fields. -
For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least
number
,short_description
,sys_mod_count
,workflow_state
, andactive
as source fields. -
For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if
objectFields
is not provided, including at leastid
,title
,updated_at
, anddraft
as source fields. -
For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among
docx
,pdf
,html
,htm
, andtxt
. -
For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The
SourceURI
of your DataIntegration must use the following format:s3://your_s3_bucket_name
.The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal
app-integrations.amazonaws.com
to performs3:ListBucket
,s3:GetObject
, ands3:GetBucketLocation
against the bucket.
-
objectFields
— (Array<String>
)The fields from the source that are made available to your agents in Wisdom. Optional if ObjectConfiguration is included in the provided DataIntegration.
-
For Salesforce, you must include at least
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
. -
For ServiceNow, you must include at least
number
,short_description
,sys_mod_count
,workflow_state
, andactive
. -
For Zendesk, you must include at least
id
,title
,updated_at
, anddraft
.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
-
status
— required — (String
)The status of the knowledge base summary.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"ACTIVE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
nextToken
— (String
)If there are additional results, this is the token for the next set of results.
-
(AWS.Response)
—
Returns:
listQuickResponses(params = {}, callback) ⇒ AWS.Request
Lists information about quick response.
Service Reference:
Examples:
Calling the listQuickResponses operation
var params = { knowledgeBaseId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; wisdom.listQuickResponses(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
maxResults
— (Integer
)The maximum number of results to return per page.
nextToken
— (String
)The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
quickResponseSummaries
— (Array<map>
)Summary information about the quick responses.
channels
— (Array<String>
)The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
Chat
.contentType
— required — (String
)The media type of the quick response content.
-
Use
application/x.quickresponse;format=plain
for quick response written in plain text. -
Use
application/x.quickresponse;format=markdown
for quick response written in richtext.
-
createdTime
— required — (Date
)The timestamp when the quick response was created.
description
— (String
)The description of the quick response.
isActive
— (Boolean
)Whether the quick response is active.
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
lastModifiedBy
— (String
)The Amazon Resource Name (ARN) of the user who last updated the quick response data.
lastModifiedTime
— required — (Date
)The timestamp when the quick response summary was last modified.
name
— required — (String
)The name of the quick response.
quickResponseArn
— required — (String
)The Amazon Resource Name (ARN) of the quick response.
quickResponseId
— required — (String
)The identifier of the quick response.
status
— required — (String
)The resource status of the quick response.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"CREATED"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
"UPDATE_IN_PROGRESS"
"UPDATE_FAILED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
-
(AWS.Response)
—
Returns:
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the tags for the specified resource.
Service Reference:
Examples:
Calling the listTagsForResource operation
var params = { resourceArn: 'STRING_VALUE' /* required */ }; wisdom.listTagsForResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceArn
— (String
)The Amazon Resource Name (ARN) of the resource.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
-
(AWS.Response)
—
Returns:
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.Service Reference:
Examples:
Calling the notifyRecommendationsReceived operation
var params = { assistantId: 'STRING_VALUE', /* required */ recommendationIds: [ /* required */ 'STRING_VALUE', /* more items */ ], sessionId: 'STRING_VALUE' /* required */ }; wisdom.notifyRecommendationsReceived(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
assistantId
— (String
)The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
recommendationIds
— (Array<String>
)The identifiers of the recommendations.
sessionId
— (String
)The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:errors
— (Array<map>
)The identifiers of recommendations that are causing errors.
message
— (String
)A recommendation is causing an error.
recommendationId
— (String
)The identifier of the recommendation that is in error.
recommendationIds
— (Array<String>
)The identifiers of the recommendations.
-
(AWS.Response)
—
Returns:
queryAssistant(params = {}, callback) ⇒ AWS.Request
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
Service Reference:
Examples:
Calling the queryAssistant operation
var params = { assistantId: 'STRING_VALUE', /* required */ queryText: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; wisdom.queryAssistant(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
assistantId
— (String
)The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
maxResults
— (Integer
)The maximum number of results to return per page.
nextToken
— (String
)The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
queryText
— (String
)The text to search for.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)If there are additional results, this is the token for the next set of results.
results
— (Array<map>
)The results of the query.
document
— required — (map
)The document.
contentReference
— required — (map
)A reference to the content resource.
contentArn
— (String
)The Amazon Resource Name (ARN) of the content.
contentId
— (String
)The identifier of the content.
knowledgeBaseArn
— (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
excerpt
— (map
)The excerpt from the document.
highlights
— (Array<map>
)Highlights in the document text.
beginOffsetInclusive
— (Integer
)The offset for the start of the highlight.
endOffsetExclusive
— (Integer
)The offset for the end of the highlight.
text
— (String
)Text in the document.
title
— (map
)The title of the document.
highlights
— (Array<map>
)Highlights in the document text.
beginOffsetInclusive
— (Integer
)The offset for the start of the highlight.
endOffsetExclusive
— (Integer
)The offset for the end of the highlight.
text
— (String
)Text in the document.
relevanceScore
— (Float
)The relevance score of the results.
resultId
— required — (String
)The identifier of the result data.
-
(AWS.Response)
—
Returns:
removeKnowledgeBaseTemplateUri(params = {}, callback) ⇒ AWS.Request
Removes a URI template from a knowledge base.
Service Reference:
Examples:
Calling the removeKnowledgeBaseTemplateUri operation
var params = { knowledgeBaseId: 'STRING_VALUE' /* required */ }; wisdom.removeKnowledgeBaseTemplateUri(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
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.
Service Reference:
Examples:
Calling the searchContent operation
var params = { knowledgeBaseId: 'STRING_VALUE', /* required */ searchExpression: { /* required */ filters: [ /* required */ { field: NAME, /* required */ operator: EQUALS, /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ] }, maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; wisdom.searchContent(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
maxResults
— (Integer
)The maximum number of results to return per page.
nextToken
— (String
)The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
searchExpression
— (map
)The search expression to filter results.
filters
— required — (Array<map>
)The search expression filters.
field
— required — (String
)The field on which to filter.
Possible values include:"NAME"
operator
— required — (String
)The operator to use for comparing the field’s value with the provided value.
Possible values include:"EQUALS"
value
— required — (String
)The desired field value on which to filter.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:contentSummaries
— (Array<map>
)Summary information about the content.
contentArn
— required — (String
)The Amazon Resource Name (ARN) of the content.
contentId
— required — (String
)The identifier of the content.
contentType
— required — (String
)The media type of the content.
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
metadata
— required — (map<String>
)A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
name
— required — (String
)The name of the content.
revisionId
— required — (String
)The identifier of the revision of the content.
status
— required — (String
)The status of the content.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"ACTIVE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
"UPDATE_FAILED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
title
— required — (String
)The title of the content.
nextToken
— (String
)If there are additional results, this is the token for the next set of results.
-
(AWS.Response)
—
Returns:
searchQuickResponses(params = {}, callback) ⇒ AWS.Request
Searches existing Wisdom quick responses in a Wisdom knowledge base.
Service Reference:
Examples:
Calling the searchQuickResponses operation
var params = { knowledgeBaseId: 'STRING_VALUE', /* required */ searchExpression: { /* required */ filters: [ { name: 'STRING_VALUE', /* required */ operator: EQUALS | PREFIX, /* required */ includeNoExistence: true || false, values: [ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], orderOnField: { name: 'STRING_VALUE', /* required */ order: ASC | DESC }, queries: [ { name: 'STRING_VALUE', /* required */ operator: CONTAINS | CONTAINS_AND_PREFIX, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ], allowFuzziness: true || false, priority: HIGH | MEDIUM | LOW }, /* more items */ ] }, attributes: { '<ContactAttributeKey>': 'STRING_VALUE', /* '<ContactAttributeKey>': ... */ }, maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; wisdom.searchQuickResponses(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
attributes
— (map<String>
)The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
maxResults
— (Integer
)The maximum number of results to return per page.
nextToken
— (String
)The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
searchExpression
— (map
)The search expression for querying the quick response.
filters
— (Array<map>
)The configuration of filtering rules applied to quick response query results.
includeNoExistence
— (Boolean
)Whether to treat null value as a match for the attribute field.
name
— required — (String
)The name of the attribute field to filter the quick responses by.
operator
— required — (String
)The operator to use for filtering.
Possible values include:"EQUALS"
"PREFIX"
values
— (Array<String>
)The values of attribute field to filter the quick response by.
orderOnField
— (map
)The quick response attribute fields on which the query results are ordered.
name
— required — (String
)The name of the attribute to order the quick response query results by.
order
— (String
)The order at which the quick responses are sorted by.
Possible values include:"ASC"
"DESC"
queries
— (Array<map>
)The quick response query expressions.
allowFuzziness
— (Boolean
)Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.
name
— required — (String
)The name of the attribute to query the quick responses by.
operator
— required — (String
)The operator to use for matching attribute field values in the query.
Possible values include:"CONTAINS"
"CONTAINS_AND_PREFIX"
priority
— (String
)The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.
Possible values include:"HIGH"
"MEDIUM"
"LOW"
values
— required — (Array<String>
)The values of the attribute to query the quick responses by.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
results
— (Array<map>
)The results of the quick response search.
attributesInterpolated
— (Array<String>
)The user defined contact attributes that are resolved when the search result is returned.
attributesNotInterpolated
— (Array<String>
)The user defined contact attributes that are not resolved when the search result is returned.
channels
— (Array<String>
)The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
Chat
.contentType
— required — (String
)The media type of the quick response content.
-
Use
application/x.quickresponse;format=plain
for quick response written in plain text. -
Use
application/x.quickresponse;format=markdown
for quick response written in richtext.
-
contents
— required — (map
)The contents of the quick response.
markdown
— (map
)The container quick response content.
content
— (String
)The content of the quick response.
plainText
— (map
)The container quick response content.
content
— (String
)The content of the quick response.
createdTime
— required — (Date
)The timestamp when the quick response was created.
description
— (String
)The description of the quick response.
groupingConfiguration
— (map
)The configuration information of the user groups that the quick response is accessible to.
criteria
— (String
)The criteria used for grouping Wisdom users.
The following is the list of supported criteria values.
-
RoutingProfileArn
: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
-
values
— (Array<String>
)The list of values that define different groups of Wisdom users.
-
When setting
criteria
toRoutingProfileArn
, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
-
isActive
— required — (Boolean
)Whether the quick response is active.
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
language
— (String
)The language code value for the language in which the quick response is written.
lastModifiedBy
— (String
)The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.
lastModifiedTime
— required — (Date
)The timestamp when the quick response search result data was last modified.
name
— required — (String
)The name of the quick response.
quickResponseArn
— required — (String
)The Amazon Resource Name (ARN) of the quick response.
quickResponseId
— required — (String
)The identifier of the quick response.
shortcutKey
— (String
)The shortcut key of the quick response. The value should be unique across the knowledge base.
status
— required — (String
)The resource status of the quick response.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"CREATED"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
"UPDATE_IN_PROGRESS"
"UPDATE_FAILED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
-
(AWS.Response)
—
Returns:
searchSessions(params = {}, callback) ⇒ AWS.Request
Searches for sessions.
Service Reference:
Examples:
Calling the searchSessions operation
var params = { assistantId: 'STRING_VALUE', /* required */ searchExpression: { /* required */ filters: [ /* required */ { field: NAME, /* required */ operator: EQUALS, /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ] }, maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; wisdom.searchSessions(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
assistantId
— (String
)The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
maxResults
— (Integer
)The maximum number of results to return per page.
nextToken
— (String
)The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
searchExpression
— (map
)The search expression to filter results.
filters
— required — (Array<map>
)The search expression filters.
field
— required — (String
)The field on which to filter.
Possible values include:"NAME"
operator
— required — (String
)The operator to use for comparing the field’s value with the provided value.
Possible values include:"EQUALS"
value
— required — (String
)The desired field value on which to filter.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)If there are additional results, this is the token for the next set of results.
sessionSummaries
— (Array<map>
)Summary information about the sessions.
assistantArn
— required — (String
)The Amazon Resource Name (ARN) of the Wisdom assistant.
assistantId
— required — (String
)The identifier of the Wisdom assistant.
sessionArn
— required — (String
)The Amazon Resource Name (ARN) of the session.
sessionId
— required — (String
)The identifier of the session.
-
(AWS.Response)
—
Returns:
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.
Service Reference:
Examples:
Calling the startContentUpload operation
var params = { contentType: 'STRING_VALUE', /* required */ knowledgeBaseId: 'STRING_VALUE', /* required */ presignedUrlTimeToLive: 'NUMBER_VALUE' }; wisdom.startContentUpload(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
contentType
— (String
)The type of content to upload.
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
presignedUrlTimeToLive
— (Integer
)The expected expiration time of the generated presigned URL, specified in minutes.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:headersToInclude
— (map<String>
)The headers to include in the upload.
uploadId
— (String
)The identifier of the upload.
url
— (String
)The URL of the upload.
urlExpiry
— (Date
)The expiration time of the URL as an epoch timestamp.
-
(AWS.Response)
—
Returns:
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.
Service Reference:
Examples:
Calling the startImportJob operation
var params = { importJobType: QUICK_RESPONSES, /* required */ knowledgeBaseId: 'STRING_VALUE', /* required */ uploadId: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', externalSourceConfiguration: { configuration: { /* required */ connectConfiguration: { instanceId: 'STRING_VALUE' } }, source: AMAZON_CONNECT /* required */ }, metadata: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }; wisdom.startImportJob(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The tags used to organize, track, or control access for this resource.
If a token is not provided, the SDK will use a version 4 UUID.externalSourceConfiguration
— (map
)The configuration information of the external source that the resource data are imported from.
configuration
— required — (map
)The configuration information of the external data source.
connectConfiguration
— (map
)The configuration information of the Amazon Connect data source.
instanceId
— (String
)The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
— required — (String
)The type of the external data source.
Possible values include:"AMAZON_CONNECT"
importJobType
— (String
)The type of the import job.
-
For importing quick response resource, set the value to
QUICK_RESPONSES
.
"QUICK_RESPONSES"
-
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
-
For importing Wisdom quick responses, this should be a
QUICK_RESPONSES
type knowledge base.
-
metadata
— (map<String>
)The metadata fields of the imported Wisdom resources.
uploadId
— (String
)A pointer to the uploaded asset. This value is returned by StartContentUpload.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:importJob
— (map
)The import job.
createdTime
— required — (Date
)The timestamp when the import job was created.
externalSourceConfiguration
— (map
)The configuration information of the external data source.
configuration
— required — (map
)The configuration information of the external data source.
connectConfiguration
— (map
)The configuration information of the Amazon Connect data source.
instanceId
— (String
)The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
— required — (String
)The type of the external data source.
Possible values include:"AMAZON_CONNECT"
failedRecordReport
— (String
)The link to donwload the information of resource data that failed to be imported.
importJobId
— required — (String
)The identifier of the import job.
importJobType
— required — (String
)The type of the import job.
Possible values include:"QUICK_RESPONSES"
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
lastModifiedTime
— required — (Date
)The timestamp when the import job data was last modified.
metadata
— (map<String>
)The metadata fields of the imported Wisdom resources.
status
— required — (String
)The status of the import job.
Possible values include:"START_IN_PROGRESS"
"FAILED"
"COMPLETE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
uploadId
— required — (String
)A pointer to the uploaded asset. This value is returned by StartContentUpload.
url
— required — (String
)The download link to the resource file that is uploaded to the import job.
urlExpiry
— required — (Date
)The expiration time of the URL as an epoch timestamp.
-
(AWS.Response)
—
Returns:
tagResource(params = {}, callback) ⇒ AWS.Request
Adds the specified tags to the specified resource.
Service Reference:
Examples:
Calling the tagResource operation
var params = { resourceArn: 'STRING_VALUE', /* required */ tags: { /* required */ '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; wisdom.tagResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceArn
— (String
)The Amazon Resource Name (ARN) of the resource.
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
untagResource(params = {}, callback) ⇒ AWS.Request
Removes the specified tags from the specified resource.
Service Reference:
Examples:
Calling the untagResource operation
var params = { resourceArn: 'STRING_VALUE', /* required */ tagKeys: [ /* required */ 'STRING_VALUE', /* more items */ ] }; wisdom.untagResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceArn
— (String
)The Amazon Resource Name (ARN) of the resource.
tagKeys
— (Array<String>
)The tag keys.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateContent(params = {}, callback) ⇒ AWS.Request
Updates information about the content.
Service Reference:
Examples:
Calling the updateContent operation
var params = { contentId: 'STRING_VALUE', /* required */ knowledgeBaseId: 'STRING_VALUE', /* required */ metadata: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ }, overrideLinkOutUri: 'STRING_VALUE', removeOverrideLinkOutUri: true || false, revisionId: 'STRING_VALUE', title: 'STRING_VALUE', uploadId: 'STRING_VALUE' }; wisdom.updateContent(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
contentId
— (String
)The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN
metadata
— (map<String>
)A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
overrideLinkOutUri
— (String
)The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing
overrideLinkOurUri
, exclude this argument and setremoveOverrideLinkOutUri
to true.removeOverrideLinkOutUri
— (Boolean
)Unset the existing
overrideLinkOutUri
if it exists.revisionId
— (String
)The
revisionId
of the content resource to update, taken from an earlier call toGetContent
,GetContentSummary
,SearchContent
, orListContents
. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws aPreconditionFailedException
.title
— (String
)The title of the content.
uploadId
— (String
)A pointer to the uploaded asset. This value is returned by StartContentUpload.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:content
— (map
)The content.
contentArn
— required — (String
)The Amazon Resource Name (ARN) of the content.
contentId
— required — (String
)The identifier of the content.
contentType
— required — (String
)The media type of the content.
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
linkOutUri
— (String
)The URI of the content.
metadata
— required — (map<String>
)A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
name
— required — (String
)The name of the content.
revisionId
— required — (String
)The identifier of the content revision.
status
— required — (String
)The status of the content.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"ACTIVE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
"UPDATE_FAILED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
title
— required — (String
)The title of the content.
url
— required — (String
)The URL of the content.
urlExpiry
— required — (Date
)The expiration time of the URL as an epoch timestamp.
-
(AWS.Response)
—
Returns:
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 anId
value, and you can set the template URI tohttps://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view
.Service Reference:
Examples:
Calling the updateKnowledgeBaseTemplateUri operation
var params = { knowledgeBaseId: 'STRING_VALUE', /* required */ templateUri: 'STRING_VALUE' /* required */ }; wisdom.updateKnowledgeBaseTemplateUri(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
templateUri
— (String
)The template URI to update.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:knowledgeBase
— (map
)The knowledge base to update.
description
— (String
)The description.
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
knowledgeBaseType
— required — (String
)The type of knowledge base.
Possible values include:"EXTERNAL"
"CUSTOM"
"QUICK_RESPONSES"
lastContentModificationTime
— (Date
)An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
name
— required — (String
)The name of the knowledge base.
renderingConfiguration
— (map
)Information about how to render the content.
templateUri
— (String
)A URI template containing exactly one variable in
${variableName}
format. This can only be set forEXTERNAL
knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:-
Salesforce:
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, orIsDeleted
-
ServiceNow:
number
,short_description
,sys_mod_count
,workflow_state
, oractive
-
Zendesk:
id
,title
,updated_at
, ordraft
The variable is replaced with the actual value for a piece of content when calling GetContent.
-
serverSideEncryptionConfiguration
— (map
)The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
, andkms:Decrypt/kms:GenerateDataKey
permissions to the IAM identity using the key to invoke Wisdom.For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
kmsKeyId
— (String
)The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId).
sourceConfiguration
— (map
)Source configuration information about the knowledge base.
appIntegrations
— (map
)Configuration information for Amazon AppIntegrations to automatically ingest content.
appIntegrationArn
— required — (String
)The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
-
For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
as source fields. -
For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least
number
,short_description
,sys_mod_count
,workflow_state
, andactive
as source fields. -
For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if
objectFields
is not provided, including at leastid
,title
,updated_at
, anddraft
as source fields. -
For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among
docx
,pdf
,html
,htm
, andtxt
. -
For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The
SourceURI
of your DataIntegration must use the following format:s3://your_s3_bucket_name
.The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal
app-integrations.amazonaws.com
to performs3:ListBucket
,s3:GetObject
, ands3:GetBucketLocation
against the bucket.
-
objectFields
— (Array<String>
)The fields from the source that are made available to your agents in Wisdom. Optional if ObjectConfiguration is included in the provided DataIntegration.
-
For Salesforce, you must include at least
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
. -
For ServiceNow, you must include at least
number
,short_description
,sys_mod_count
,workflow_state
, andactive
. -
For Zendesk, you must include at least
id
,title
,updated_at
, anddraft
.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
-
status
— required — (String
)The status of the knowledge base.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"ACTIVE"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
-
(AWS.Response)
—
Returns:
updateQuickResponse(params = {}, callback) ⇒ AWS.Request
Updates an existing Wisdom quick response.
Service Reference:
Examples:
Calling the updateQuickResponse operation
var params = { knowledgeBaseId: 'STRING_VALUE', /* required */ quickResponseId: 'STRING_VALUE', /* required */ channels: [ 'STRING_VALUE', /* more items */ ], content: { content: 'STRING_VALUE' }, contentType: 'STRING_VALUE', description: 'STRING_VALUE', groupingConfiguration: { criteria: 'STRING_VALUE', values: [ 'STRING_VALUE', /* more items */ ] }, isActive: true || false, language: 'STRING_VALUE', name: 'STRING_VALUE', removeDescription: true || false, removeGroupingConfiguration: true || false, removeShortcutKey: true || false, shortcutKey: 'STRING_VALUE' }; wisdom.updateQuickResponse(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
channels
— (Array<String>
)The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
Chat
.content
— (map
)The updated content of the quick response.
content
— (String
)The content of the quick response.
contentType
— (String
)The media type of the quick response content.
-
Use
application/x.quickresponse;format=plain
for quick response written in plain text. -
Use
application/x.quickresponse;format=markdown
for quick response written in richtext.
-
description
— (String
)The updated description of the quick response.
groupingConfiguration
— (map
)The updated grouping configuration of the quick response.
criteria
— (String
)The criteria used for grouping Wisdom users.
The following is the list of supported criteria values.
-
RoutingProfileArn
: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
-
values
— (Array<String>
)The list of values that define different groups of Wisdom users.
-
When setting
criteria
toRoutingProfileArn
, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
-
isActive
— (Boolean
)Whether the quick response is active.
knowledgeBaseId
— (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
language
— (String
)The language code value for the language in which the quick response is written. The supported language codes include
de_DE
,en_US
,es_ES
,fr_FR
,id_ID
,it_IT
,ja_JP
,ko_KR
,pt_BR
,zh_CN
,zh_TW
name
— (String
)The name of the quick response.
quickResponseId
— (String
)The identifier of the quick response.
removeDescription
— (Boolean
)Whether to remove the description from the quick response.
removeGroupingConfiguration
— (Boolean
)Whether to remove the grouping configuration of the quick response.
removeShortcutKey
— (Boolean
)Whether to remove the shortcut key of the quick response.
shortcutKey
— (String
)The shortcut key of the quick response. The value should be unique across the knowledge base.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:quickResponse
— (map
)The quick response.
channels
— (Array<String>
)The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
Chat
.contentType
— required — (String
)The media type of the quick response content.
-
Use
application/x.quickresponse;format=plain
for quick response written in plain text. -
Use
application/x.quickresponse;format=markdown
for quick response written in richtext.
-
contents
— (map
)The contents of the quick response.
markdown
— (map
)The container quick response content.
content
— (String
)The content of the quick response.
plainText
— (map
)The container quick response content.
content
— (String
)The content of the quick response.
createdTime
— required — (Date
)The timestamp when the quick response was created.
description
— (String
)The description of the quick response.
groupingConfiguration
— (map
)The configuration information of the user groups that the quick response is accessible to.
criteria
— (String
)The criteria used for grouping Wisdom users.
The following is the list of supported criteria values.
-
RoutingProfileArn
: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
-
values
— (Array<String>
)The list of values that define different groups of Wisdom users.
-
When setting
criteria
toRoutingProfileArn
, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
-
isActive
— (Boolean
)Whether the quick response is active.
knowledgeBaseArn
— required — (String
)The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId
— required — (String
)The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
language
— (String
)The language code value for the language in which the quick response is written.
lastModifiedBy
— (String
)The Amazon Resource Name (ARN) of the user who last updated the quick response data.
lastModifiedTime
— required — (Date
)The timestamp when the quick response data was last modified.
name
— required — (String
)The name of the quick response.
quickResponseArn
— required — (String
)The Amazon Resource Name (ARN) of the quick response.
quickResponseId
— required — (String
)The identifier of the quick response.
shortcutKey
— (String
)The shortcut key of the quick response. The value should be unique across the knowledge base.
status
— required — (String
)The status of the quick response data.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"CREATED"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
"DELETED"
"UPDATE_IN_PROGRESS"
"UPDATE_FAILED"
tags
— (map<String>
)The tags used to organize, track, or control access for this resource.
-
(AWS.Response)
—
Returns:
Generated on Thu Aug 22 18:45:47 2024 by yard 0.9.36 (ruby-2.5.1). - createQuickResponse(params = {}, callback) ⇒ AWS.Request