You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Wisdom

Inherits:
AWS.Service show all
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

All Amazon Connect Wisdom functionality is accessible using the API. For example, you can create an assistant and a knowledge base.

 <p>Some more advanced features are only accessible using the Wisdom API. For example, you can manually manage content by uploading custom files and control their lifecycle. </p> 

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

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.
  • 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 to true.

  • 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

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

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 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 KMS key used for encryption.

      • kmsKeyId — (String)

        The KMS key. For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide.

    • 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. The data object has the following properties:

      • assistant — (map)

        Information about the assistant.

        • assistantArnrequired — (String)

          The Amazon Resource Name (ARN) of the Wisdom assistant

        • assistantIdrequired — (String)

          The identifier of the Wisdom assistant.

        • description — (String)

          The description.

        • namerequired — (String)

          The name.

        • serverSideEncryptionConfiguration — (map)

          The KMS key used for encryption.

          • kmsKeyId — (String)

            The KMS key. For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide.

        • statusrequired — (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.

        • typerequired — (String)

          The type of assistant.

          Possible values include:
          • "AGENT"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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 the identifier of the knowledge base.

    • 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 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. The data object has the following properties:

      • assistantAssociation — (map)

        The assistant association.

        • assistantArnrequired — (String)

          The Amazon Resource Name (ARN) of the Wisdom assistant

        • assistantAssociationArnrequired — (String)

          The Amazon Resource Name (ARN) of the assistant association.

        • assistantAssociationIdrequired — (String)

          The identifier of the assistant association.

        • assistantIdrequired — (String)

          The identifier of the Wisdom assistant.

        • associationDatarequired — (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 the identifier of the knowledge base.

        • associationTyperequired — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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 a token is not provided, the SDK will use a version 4 UUID.
    • knowledgeBaseId — (String)

      The the identifier of the knowledge base. 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. The data object has the following properties:

      • content — (map)

        The content.

        • contentArnrequired — (String)

          The Amazon Resource Name (ARN) of the content.

        • contentIdrequired — (String)

          The identifier of the content.

        • contentTyperequired — (String)

          The media type of the content.

        • knowledgeBaseArnrequired — (String)

          The Amazon Resource Name (ARN) of the knowledge base.

        • knowledgeBaseIdrequired — (String)

          The the identifier of the knowledge base.

        • linkOutUri — (String)

          The URI of the content.

        • metadatarequired — (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.

        • namerequired — (String)

          The name of the content.

        • revisionIdrequired — (String)

          The identifier of the content revision.

        • statusrequired — (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.

        • titlerequired — (String)

          The title of the content.

        • urlrequired — (String)

          The URL of the content.

        • urlExpiryrequired — (Date)

          The expiration time of the URL as an epoch timestamp.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates a knowledge base.

When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.

 <p>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:</p> <ol> <li> <p>Call <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API&#95;DeleteKnowledgeBase.html&quot;&gt;DeleteKnowledgeBase&lt;/a&gt;.&lt;/p&gt; </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API&#95;DeleteDataIntegration.html&quot;&gt;DeleteDataIntegration&lt;/a&gt;.&lt;/p&gt; </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API&#95;CreateDataIntegration.html&quot;&gt;CreateDataIntegration&lt;/a&gt; to recreate the DataIntegration or a create different one.</p> </li> <li> <p>Call CreateKnowledgeBase.</p> </li> </ol> </note> 

Service Reference:

Examples:

Calling the createKnowledgeBase operation

var params = {
  knowledgeBaseType: EXTERNAL | CUSTOM, /* 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: [ /* required */
        '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 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"
    • 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 for EXTERNAL knowledge bases. For Salesforce and ServiceNow, the variable must be one of the following:

        • Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted

        • ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

         <p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API&#95;GetContent.html&quot;&gt;GetContent&lt;/a&gt;. </p> 
    • serverSideEncryptionConfiguration — (map)

      The KMS key used for encryption.

      • kmsKeyId — (String)

        The KMS key. For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide.

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

        • appIntegrationArnrequired — (String)

          The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

        • objectFieldsrequired — (Array<String>)

          The fields from the source that are made available to your agents in Wisdom.

          • For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.

          • For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

          Make sure to include additional field(s); these 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. The data object has the following properties:

      • knowledgeBase — (map)

        The knowledge base.

        • description — (String)

          The description.

        • knowledgeBaseArnrequired — (String)

          The Amazon Resource Name (ARN) of the knowledge base.

        • knowledgeBaseIdrequired — (String)

          The the identifier of the knowledge base.

        • knowledgeBaseTyperequired — (String)

          The type of knowledge base.

          Possible values include:
          • "EXTERNAL"
          • "CUSTOM"
        • 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.

        • namerequired — (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 for EXTERNAL knowledge bases. For Salesforce and ServiceNow, the variable must be one of the following:

            • Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted

            • ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

             <p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API&#95;GetContent.html&quot;&gt;GetContent&lt;/a&gt;. </p> 
        • serverSideEncryptionConfiguration — (map)

          The KMS key used for encryption.

          • kmsKeyId — (String)

            The KMS key. For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide.

        • sourceConfiguration — (map)

          Source configuration information about the knowledge base.

          • appIntegrations — (map)

            Configuration information for Amazon AppIntegrations to automatically ingest content.

            • appIntegrationArnrequired — (String)

              The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

            • objectFieldsrequired — (Array<String>)

              The fields from the source that are made available to your agents in Wisdom.

              • For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.

              • For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

              Make sure to include additional field(s); these are indexed and used to source recommendations.

        • statusrequired — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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 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. The data object has the following properties:

      • session — (map)

        The session.

        • description — (String)

          The description of the session.

        • namerequired — (String)

          The name of the session.

        • sessionArnrequired — (String)

          The Amazon Resource Name (ARN) of the session.

        • sessionIdrequired — (String)

          The identifier of the session.

        • tags — (map<String>)

          The tags used to organize, track, or control access for this resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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 the identifier of the knowledge base. 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

      • assistant — (map)

        Information about the assistant.

        • assistantArnrequired — (String)

          The Amazon Resource Name (ARN) of the Wisdom assistant

        • assistantIdrequired — (String)

          The identifier of the Wisdom assistant.

        • description — (String)

          The description.

        • namerequired — (String)

          The name.

        • serverSideEncryptionConfiguration — (map)

          The KMS key used for encryption.

          • kmsKeyId — (String)

            The KMS key. For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide.

        • statusrequired — (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.

        • typerequired — (String)

          The type of assistant.

          Possible values include:
          • "AGENT"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

      • assistantAssociation — (map)

        The assistant association.

        • assistantArnrequired — (String)

          The Amazon Resource Name (ARN) of the Wisdom assistant

        • assistantAssociationArnrequired — (String)

          The Amazon Resource Name (ARN) of the assistant association.

        • assistantAssociationIdrequired — (String)

          The identifier of the assistant association.

        • assistantIdrequired — (String)

          The identifier of the Wisdom assistant.

        • associationDatarequired — (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 the identifier of the knowledge base.

        • associationTyperequired — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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 the identifier of the knowledge base. 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. The data object has the following properties:

      • content — (map)

        The content.

        • contentArnrequired — (String)

          The Amazon Resource Name (ARN) of the content.

        • contentIdrequired — (String)

          The identifier of the content.

        • contentTyperequired — (String)

          The media type of the content.

        • knowledgeBaseArnrequired — (String)

          The Amazon Resource Name (ARN) of the knowledge base.

        • knowledgeBaseIdrequired — (String)

          The the identifier of the knowledge base.

        • linkOutUri — (String)

          The URI of the content.

        • metadatarequired — (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.

        • namerequired — (String)

          The name of the content.

        • revisionIdrequired — (String)

          The identifier of the content revision.

        • statusrequired — (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.

        • titlerequired — (String)

          The title of the content.

        • urlrequired — (String)

          The URL of the content.

        • urlExpiryrequired — (Date)

          The expiration time of the URL as an epoch timestamp.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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 the identifier of the knowledge base. 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. The data object has the following properties:

      • contentSummary — (map)

        The content summary.

        • contentArnrequired — (String)

          The Amazon Resource Name (ARN) of the content.

        • contentIdrequired — (String)

          The identifier of the content.

        • contentTyperequired — (String)

          The media type of the content.

        • knowledgeBaseArnrequired — (String)

          The Amazon Resource Name (ARN) of the knowledge base.

        • knowledgeBaseIdrequired — (String)

          The the identifier of the knowledge base.

        • metadatarequired — (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.

        • namerequired — (String)

          The name of the content.

        • revisionIdrequired — (String)

          The identifier of the revision of the content.

        • statusrequired — (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.

        • titlerequired — (String)

          The title of the content.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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 the identifier of the knowledge base. 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. The data object has the following properties:

      • knowledgeBase — (map)

        The knowledge base.

        • description — (String)

          The description.

        • knowledgeBaseArnrequired — (String)

          The Amazon Resource Name (ARN) of the knowledge base.

        • knowledgeBaseIdrequired — (String)

          The the identifier of the knowledge base.

        • knowledgeBaseTyperequired — (String)

          The type of knowledge base.

          Possible values include:
          • "EXTERNAL"
          • "CUSTOM"
        • 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.

        • namerequired — (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 for EXTERNAL knowledge bases. For Salesforce and ServiceNow, the variable must be one of the following:

            • Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted

            • ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

             <p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API&#95;GetContent.html&quot;&gt;GetContent&lt;/a&gt;. </p> 
        • serverSideEncryptionConfiguration — (map)

          The KMS key used for encryption.

          • kmsKeyId — (String)

            The KMS key. For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide.

        • sourceConfiguration — (map)

          Source configuration information about the knowledge base.

          • appIntegrations — (map)

            Configuration information for Amazon AppIntegrations to automatically ingest content.

            • appIntegrationArnrequired — (String)

              The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

            • objectFieldsrequired — (Array<String>)

              The fields from the source that are made available to your agents in Wisdom.

              • For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.

              • For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

              Make sure to include additional field(s); these are indexed and used to source recommendations.

        • statusrequired — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

      • recommendations — (Array<map>)

        The recommendations.

        • documentrequired — (map)

          The recommended document.

          • contentReferencerequired — (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 the identifier of the knowledge base.

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

        • recommendationIdrequired — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

      • session — (map)

        The session.

        • description — (String)

          The description of the session.

        • namerequired — (String)

          The name of the session.

        • sessionArnrequired — (String)

          The Amazon Resource Name (ARN) of the session.

        • sessionIdrequired — (String)

          The identifier of the session.

        • tags — (map<String>)

          The tags used to organize, track, or control access for this resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

      • assistantAssociationSummaries — (Array<map>)

        Summary information about assistant associations.

        • assistantArnrequired — (String)

          The Amazon Resource Name (ARN) of the Wisdom assistant

        • assistantAssociationArnrequired — (String)

          The Amazon Resource Name (ARN) of the assistant association.

        • assistantAssociationIdrequired — (String)

          The identifier of the assistant association.

        • assistantIdrequired — (String)

          The identifier of the Wisdom assistant.

        • associationDatarequired — (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 the identifier of the knowledge base.

        • associationTyperequired — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

      • assistantSummaries — (Array<map>)

        Information about the assistants.

        • assistantArnrequired — (String)

          The Amazon Resource Name (ARN) of the Wisdom assistant

        • assistantIdrequired — (String)

          The identifier of the Wisdom assistant.

        • description — (String)

          The description of the assistant.

        • namerequired — (String)

          The name of the assistant.

        • serverSideEncryptionConfiguration — (map)

          The KMS key used for encryption.

          • kmsKeyId — (String)

            The KMS key. For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide.

        • statusrequired — (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.

        • typerequired — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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 the identifier of the 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.

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. The data object has the following properties:

      • contentSummaries — (Array<map>)

        Information about the content.

        • contentArnrequired — (String)

          The Amazon Resource Name (ARN) of the content.

        • contentIdrequired — (String)

          The identifier of the content.

        • contentTyperequired — (String)

          The media type of the content.

        • knowledgeBaseArnrequired — (String)

          The Amazon Resource Name (ARN) of the knowledge base.

        • knowledgeBaseIdrequired — (String)

          The the identifier of the knowledge base.

        • metadatarequired — (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.

        • namerequired — (String)

          The name of the content.

        • revisionIdrequired — (String)

          The identifier of the revision of the content.

        • statusrequired — (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.

        • titlerequired — (String)

          The title of the content.

      • nextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

      • knowledgeBaseSummaries — (Array<map>)

        Information about the knowledge bases.

        • description — (String)

          The description of the knowledge base.

        • knowledgeBaseArnrequired — (String)

          The Amazon Resource Name (ARN) of the knowledge base.

        • knowledgeBaseIdrequired — (String)

          The the identifier of the knowledge base.

        • knowledgeBaseTyperequired — (String)

          The type of knowledge base.

          Possible values include:
          • "EXTERNAL"
          • "CUSTOM"
        • namerequired — (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 for EXTERNAL knowledge bases. For Salesforce and ServiceNow, the variable must be one of the following:

            • Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted

            • ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

             <p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API&#95;GetContent.html&quot;&gt;GetContent&lt;/a&gt;. </p> 
        • serverSideEncryptionConfiguration — (map)

          The KMS key used for encryption.

          • kmsKeyId — (String)

            The KMS key. For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide.

        • sourceConfiguration — (map)

          [KEVIN]

          • appIntegrations — (map)

            Configuration information for Amazon AppIntegrations to automatically ingest content.

            • appIntegrationArnrequired — (String)

              The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

            • objectFieldsrequired — (Array<String>)

              The fields from the source that are made available to your agents in Wisdom.

              • For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.

              • For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

              Make sure to include additional field(s); these are indexed and used to source recommendations.

        • statusrequired — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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. The data 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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. The data 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.

        • documentrequired — (map)

          The document.

          • contentReferencerequired — (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 the identifier of the knowledge base.

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

        • resultIdrequired — (String)

          The identifier of the result data.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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 the identifier of the knowledge base. 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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 the identifier of the 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 to filter results.

      • filtersrequired — (Array<map>)

        The search expression filters.

        • fieldrequired — (String)

          The field on which to filter.

          Possible values include:
          • "NAME"
        • operatorrequired — (String)

          The operator to use for comparing the field’s value with the provided value.

          Possible values include:
          • "EQUALS"
        • valuerequired — (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. The data object has the following properties:

      • contentSummaries — (Array<map>)

        Summary information about the content.

        • contentArnrequired — (String)

          The Amazon Resource Name (ARN) of the content.

        • contentIdrequired — (String)

          The identifier of the content.

        • contentTyperequired — (String)

          The media type of the content.

        • knowledgeBaseArnrequired — (String)

          The Amazon Resource Name (ARN) of the knowledge base.

        • knowledgeBaseIdrequired — (String)

          The the identifier of the knowledge base.

        • metadatarequired — (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.

        • namerequired — (String)

          The name of the content.

        • revisionIdrequired — (String)

          The identifier of the revision of the content.

        • statusrequired — (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.

        • titlerequired — (String)

          The title of the content.

      • nextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

      • filtersrequired — (Array<map>)

        The search expression filters.

        • fieldrequired — (String)

          The field on which to filter.

          Possible values include:
          • "NAME"
        • operatorrequired — (String)

          The operator to use for comparing the field’s value with the provided value.

          Possible values include:
          • "EQUALS"
        • valuerequired — (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. The data 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.

        • assistantArnrequired — (String)

          The Amazon Resource Name (ARN) of the Wisdom assistant

        • assistantIdrequired — (String)

          The identifier of the Wisdom assistant.

        • sessionArnrequired — (String)

          The Amazon Resource Name (ARN) of the session.

        • sessionIdrequired — (String)

          The identifier of the session.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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 */
};
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 the identifier of the knowledge base. 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. The data 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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 the identifier of the knowledge base. 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 set removeOverrideLinkOutUri 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 to GetContent, GetContentSummary, SearchContent, or ListContents. 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 a PreconditionFailedException.

    • 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. The data object has the following properties:

      • content — (map)

        The content.

        • contentArnrequired — (String)

          The Amazon Resource Name (ARN) of the content.

        • contentIdrequired — (String)

          The identifier of the content.

        • contentTyperequired — (String)

          The media type of the content.

        • knowledgeBaseArnrequired — (String)

          The Amazon Resource Name (ARN) of the knowledge base.

        • knowledgeBaseIdrequired — (String)

          The the identifier of the knowledge base.

        • linkOutUri — (String)

          The URI of the content.

        • metadatarequired — (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.

        • namerequired — (String)

          The name of the content.

        • revisionIdrequired — (String)

          The identifier of the content revision.

        • statusrequired — (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.

        • titlerequired — (String)

          The title of the content.

        • urlrequired — (String)

          The URL of the content.

        • urlExpiryrequired — (Date)

          The expiration time of the URL as an epoch timestamp.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.

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 the identifier of the knowledge base. 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. The data object has the following properties:

      • knowledgeBase — (map)

        The knowledge base to update.

        • description — (String)

          The description.

        • knowledgeBaseArnrequired — (String)

          The Amazon Resource Name (ARN) of the knowledge base.

        • knowledgeBaseIdrequired — (String)

          The the identifier of the knowledge base.

        • knowledgeBaseTyperequired — (String)

          The type of knowledge base.

          Possible values include:
          • "EXTERNAL"
          • "CUSTOM"
        • 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.

        • namerequired — (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 for EXTERNAL knowledge bases. For Salesforce and ServiceNow, the variable must be one of the following:

            • Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted

            • ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

             <p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API&#95;GetContent.html&quot;&gt;GetContent&lt;/a&gt;. </p> 
        • serverSideEncryptionConfiguration — (map)

          The KMS key used for encryption.

          • kmsKeyId — (String)

            The KMS key. For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide.

        • sourceConfiguration — (map)

          Source configuration information about the knowledge base.

          • appIntegrations — (map)

            Configuration information for Amazon AppIntegrations to automatically ingest content.

            • appIntegrationArnrequired — (String)

              The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

            • objectFieldsrequired — (Array<String>)

              The fields from the source that are made available to your agents in Wisdom.

              • For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.

              • For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

              Make sure to include additional field(s); these are indexed and used to source recommendations.

        • statusrequired — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.