ConnectWisdomService

Client

class ConnectWisdomService.Client

A low-level client representing Amazon Connect Wisdom Service

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>

client = session.create_client('wisdom')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_assistant(**kwargs)

Creates an Amazon Connect Wisdom assistant.

See also: AWS API Documentation

Request Syntax

response = client.create_assistant(
    clientToken='string',
    description='string',
    name='string',
    serverSideEncryptionConfiguration={
        'kmsKeyId': 'string'
    },
    tags={
        'string': 'string'
    },
    type='AGENT'
)
Parameters
  • clientToken (string) --

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  • description (string) -- The description of the assistant.
  • name (string) --

    [REQUIRED]

    The name of the assistant.

  • serverSideEncryptionConfiguration (dict) --

    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 (dict) --

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

    • (string) --
      • (string) --
  • type (string) --

    [REQUIRED]

    The type of assistant.

Return type

dict

Returns

Response Syntax

{
    'assistant': {
        'assistantArn': 'string',
        'assistantId': 'string',
        'description': 'string',
        'name': 'string',
        'serverSideEncryptionConfiguration': {
            'kmsKeyId': 'string'
        },
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
        'tags': {
            'string': 'string'
        },
        'type': 'AGENT'
    }
}

Response Structure

  • (dict) --

    • assistant (dict) --

      Information about the assistant.

      • assistantArn (string) --

        The Amazon Resource Name (ARN) of the Wisdom assistant

      • assistantId (string) --

        The identifier of the Wisdom assistant.

      • description (string) --

        The description.

      • name (string) --

        The name.

      • serverSideEncryptionConfiguration (dict) --

        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 .

      • status (string) --

        The status of the assistant.

      • tags (dict) --

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

        • (string) --
          • (string) --
      • type (string) --

        The type of assistant.

Exceptions

create_assistant_association(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_assistant_association(
    assistantId='string',
    association={
        'knowledgeBaseId': 'string'
    },
    associationType='KNOWLEDGE_BASE',
    clientToken='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • assistantId (string) --

    [REQUIRED]

    The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • association (dict) --

    [REQUIRED]

    The identifier of the associated resource.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: knowledgeBaseId.

    • knowledgeBaseId (string) --

      The the identifier of the knowledge base.

  • associationType (string) --

    [REQUIRED]

    The type of association.

  • clientToken (string) --

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  • tags (dict) --

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

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'assistantAssociation': {
        'assistantArn': 'string',
        'assistantAssociationArn': 'string',
        'assistantAssociationId': 'string',
        'assistantId': 'string',
        'associationData': {
            'knowledgeBaseAssociation': {
                'knowledgeBaseArn': 'string',
                'knowledgeBaseId': 'string'
            }
        },
        'associationType': 'KNOWLEDGE_BASE',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • assistantAssociation (dict) --

      The assistant association.

      • assistantArn (string) --

        The Amazon Resource Name (ARN) of the Wisdom assistant

      • assistantAssociationArn (string) --

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

      • assistantAssociationId (string) --

        The identifier of the assistant association.

      • assistantId (string) --

        The identifier of the Wisdom assistant.

      • associationData (dict) --

        A union type that currently has a single argument, the knowledge base ID.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: knowledgeBaseAssociation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        • knowledgeBaseAssociation (dict) --

          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.

      • associationType (string) --

        The type of association.

      • tags (dict) --

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

        • (string) --
          • (string) --

Exceptions

create_content(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_content(
    clientToken='string',
    knowledgeBaseId='string',
    metadata={
        'string': 'string'
    },
    name='string',
    overrideLinkOutUri='string',
    tags={
        'string': 'string'
    },
    title='string',
    uploadId='string'
)
Parameters
  • clientToken (string) --

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  • knowledgeBaseId (string) --

    [REQUIRED]

    The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • metadata (dict) --

    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.

    • (string) --
      • (string) --
  • name (string) --

    [REQUIRED]

    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 (dict) --

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

    • (string) --
      • (string) --
  • title (string) -- The title of the content. If not set, the title is equal to the name.
  • uploadId (string) --

    [REQUIRED]

    A pointer to the uploaded asset. This value is returned by StartContentUpload .

Return type

dict

Returns

Response Syntax

{
    'content': {
        'contentArn': 'string',
        'contentId': 'string',
        'contentType': 'string',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'linkOutUri': 'string',
        'metadata': {
            'string': 'string'
        },
        'name': 'string',
        'revisionId': 'string',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED',
        'tags': {
            'string': 'string'
        },
        'title': 'string',
        'url': 'string',
        'urlExpiry': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • content (dict) --

      The content.

      • contentArn (string) --

        The Amazon Resource Name (ARN) of the content.

      • contentId (string) --

        The identifier of the content.

      • contentType (string) --

        The media type of the content.

      • knowledgeBaseArn (string) --

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

      • knowledgeBaseId (string) --

        The the identifier of the knowledge base.

      • linkOutUri (string) --

        The URI of the content.

      • metadata (dict) --

        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.

        • (string) --
          • (string) --
      • name (string) --

        The name of the content.

      • revisionId (string) --

        The identifier of the content revision.

      • status (string) --

        The status of the content.

      • tags (dict) --

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

        • (string) --
          • (string) --
      • title (string) --

        The title of the content.

      • url (string) --

        The URL of the content.

      • urlExpiry (datetime) --

        The expiration time of the URL as an epoch timestamp.

Exceptions

create_knowledge_base(**kwargs)

Creates a knowledge base.

Note

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

<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_DeleteKnowledgeBase.html">DeleteKnowledgeBase</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html">DeleteDataIntegration</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html">CreateDataIntegration</a> to recreate the DataIntegration or a create different one.</p> </li> <li> <p>Call CreateKnowledgeBase.</p> </li> </ol> </note>

See also: AWS API Documentation

Request Syntax

response = client.create_knowledge_base(
    clientToken='string',
    description='string',
    knowledgeBaseType='EXTERNAL'|'CUSTOM',
    name='string',
    renderingConfiguration={
        'templateUri': 'string'
    },
    serverSideEncryptionConfiguration={
        'kmsKeyId': 'string'
    },
    sourceConfiguration={
        'appIntegrations': {
            'appIntegrationArn': 'string',
            'objectFields': [
                'string',
            ]
        }
    },
    tags={
        'string': 'string'
    }
)
Parameters
  • clientToken (string) --

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  • description (string) -- The description.
  • knowledgeBaseType (string) --

    [REQUIRED]

    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.

  • name (string) --

    [REQUIRED]

    The name of the knowledge base.

  • renderingConfiguration (dict) --

    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_GetContent.html">GetContent</a>. </p>
  • serverSideEncryptionConfiguration (dict) --

    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 (dict) --

    The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: appIntegrations.

    • appIntegrations (dict) --

      Configuration information for Amazon AppIntegrations to automatically ingest content.

      • appIntegrationArn (string) -- [REQUIRED]

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

      • objectFields (list) -- [REQUIRED]

        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.

        • (string) --
  • tags (dict) --

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

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'knowledgeBase': {
        'description': 'string',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'knowledgeBaseType': 'EXTERNAL'|'CUSTOM',
        'lastContentModificationTime': datetime(2015, 1, 1),
        'name': 'string',
        'renderingConfiguration': {
            'templateUri': 'string'
        },
        'serverSideEncryptionConfiguration': {
            'kmsKeyId': 'string'
        },
        'sourceConfiguration': {
            'appIntegrations': {
                'appIntegrationArn': 'string',
                'objectFields': [
                    'string',
                ]
            }
        },
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • knowledgeBase (dict) --

      The knowledge base.

      • description (string) --

        The description.

      • knowledgeBaseArn (string) --

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

      • knowledgeBaseId (string) --

        The the identifier of the knowledge base.

      • knowledgeBaseType (string) --

        The type of knowledge base.

      • lastContentModificationTime (datetime) --

        An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.

      • name (string) --

        The name of the knowledge base.

      • renderingConfiguration (dict) --

        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_GetContent.html">GetContent</a>. </p>

      • serverSideEncryptionConfiguration (dict) --

        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 (dict) --

        Source configuration information about the knowledge base.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: appIntegrations. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        • appIntegrations (dict) --

          Configuration information for Amazon AppIntegrations to automatically ingest content.

          • appIntegrationArn (string) --

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

          • objectFields (list) --

            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.

            • (string) --
      • status (string) --

        The status of the knowledge base.

      • tags (dict) --

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

        • (string) --
          • (string) --

Exceptions

create_session(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_session(
    assistantId='string',
    clientToken='string',
    description='string',
    name='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • assistantId (string) --

    [REQUIRED]

    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.

    This field is autopopulated if not provided.

  • description (string) -- The description.
  • name (string) --

    [REQUIRED]

    The name of the session.

  • tags (dict) --

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

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'session': {
        'description': 'string',
        'name': 'string',
        'sessionArn': 'string',
        'sessionId': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • session (dict) --

      The session.

      • description (string) --

        The description of the session.

      • name (string) --

        The name of the session.

      • sessionArn (string) --

        The Amazon Resource Name (ARN) of the session.

      • sessionId (string) --

        The identifier of the session.

      • tags (dict) --

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

        • (string) --
          • (string) --

Exceptions

delete_assistant(**kwargs)

Deletes an assistant.

See also: AWS API Documentation

Request Syntax

response = client.delete_assistant(
    assistantId='string'
)
Parameters
assistantId (string) --

[REQUIRED]

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_assistant_association(**kwargs)

Deletes an assistant association.

See also: AWS API Documentation

Request Syntax

response = client.delete_assistant_association(
    assistantAssociationId='string',
    assistantId='string'
)
Parameters
  • assistantAssociationId (string) --

    [REQUIRED]

    The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • assistantId (string) --

    [REQUIRED]

    The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_content(**kwargs)

Deletes the content.

See also: AWS API Documentation

Request Syntax

response = client.delete_content(
    contentId='string',
    knowledgeBaseId='string'
)
Parameters
  • contentId (string) --

    [REQUIRED]

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • knowledgeBaseId (string) --

    [REQUIRED]

    The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_knowledge_base(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.delete_knowledge_base(
    knowledgeBaseId='string'
)
Parameters
knowledgeBaseId (string) --

[REQUIRED]

The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

get_assistant(**kwargs)

Retrieves information about an assistant.

See also: AWS API Documentation

Request Syntax

response = client.get_assistant(
    assistantId='string'
)
Parameters
assistantId (string) --

[REQUIRED]

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type
dict
Returns
Response Syntax
{
    'assistant': {
        'assistantArn': 'string',
        'assistantId': 'string',
        'description': 'string',
        'name': 'string',
        'serverSideEncryptionConfiguration': {
            'kmsKeyId': 'string'
        },
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
        'tags': {
            'string': 'string'
        },
        'type': 'AGENT'
    }
}

Response Structure

  • (dict) --
    • assistant (dict) --

      Information about the assistant.

      • assistantArn (string) --

        The Amazon Resource Name (ARN) of the Wisdom assistant

      • assistantId (string) --

        The identifier of the Wisdom assistant.

      • description (string) --

        The description.

      • name (string) --

        The name.

      • serverSideEncryptionConfiguration (dict) --

        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 .

      • status (string) --

        The status of the assistant.

      • tags (dict) --

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

        • (string) --
          • (string) --
      • type (string) --

        The type of assistant.

Exceptions

get_assistant_association(**kwargs)

Retrieves information about an assistant association.

See also: AWS API Documentation

Request Syntax

response = client.get_assistant_association(
    assistantAssociationId='string',
    assistantId='string'
)
Parameters
  • assistantAssociationId (string) --

    [REQUIRED]

    The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • assistantId (string) --

    [REQUIRED]

    The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type

dict

Returns

Response Syntax

{
    'assistantAssociation': {
        'assistantArn': 'string',
        'assistantAssociationArn': 'string',
        'assistantAssociationId': 'string',
        'assistantId': 'string',
        'associationData': {
            'knowledgeBaseAssociation': {
                'knowledgeBaseArn': 'string',
                'knowledgeBaseId': 'string'
            }
        },
        'associationType': 'KNOWLEDGE_BASE',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • assistantAssociation (dict) --

      The assistant association.

      • assistantArn (string) --

        The Amazon Resource Name (ARN) of the Wisdom assistant

      • assistantAssociationArn (string) --

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

      • assistantAssociationId (string) --

        The identifier of the assistant association.

      • assistantId (string) --

        The identifier of the Wisdom assistant.

      • associationData (dict) --

        A union type that currently has a single argument, the knowledge base ID.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: knowledgeBaseAssociation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        • knowledgeBaseAssociation (dict) --

          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.

      • associationType (string) --

        The type of association.

      • tags (dict) --

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

        • (string) --
          • (string) --

Exceptions

get_content(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_content(
    contentId='string',
    knowledgeBaseId='string'
)
Parameters
  • contentId (string) --

    [REQUIRED]

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • knowledgeBaseId (string) --

    [REQUIRED]

    The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type

dict

Returns

Response Syntax

{
    'content': {
        'contentArn': 'string',
        'contentId': 'string',
        'contentType': 'string',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'linkOutUri': 'string',
        'metadata': {
            'string': 'string'
        },
        'name': 'string',
        'revisionId': 'string',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED',
        'tags': {
            'string': 'string'
        },
        'title': 'string',
        'url': 'string',
        'urlExpiry': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • content (dict) --

      The content.

      • contentArn (string) --

        The Amazon Resource Name (ARN) of the content.

      • contentId (string) --

        The identifier of the content.

      • contentType (string) --

        The media type of the content.

      • knowledgeBaseArn (string) --

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

      • knowledgeBaseId (string) --

        The the identifier of the knowledge base.

      • linkOutUri (string) --

        The URI of the content.

      • metadata (dict) --

        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.

        • (string) --
          • (string) --
      • name (string) --

        The name of the content.

      • revisionId (string) --

        The identifier of the content revision.

      • status (string) --

        The status of the content.

      • tags (dict) --

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

        • (string) --
          • (string) --
      • title (string) --

        The title of the content.

      • url (string) --

        The URL of the content.

      • urlExpiry (datetime) --

        The expiration time of the URL as an epoch timestamp.

Exceptions

get_content_summary(**kwargs)

Retrieves summary information about the content.

See also: AWS API Documentation

Request Syntax

response = client.get_content_summary(
    contentId='string',
    knowledgeBaseId='string'
)
Parameters
  • contentId (string) --

    [REQUIRED]

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • knowledgeBaseId (string) --

    [REQUIRED]

    The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type

dict

Returns

Response Syntax

{
    'contentSummary': {
        'contentArn': 'string',
        'contentId': 'string',
        'contentType': 'string',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'metadata': {
            'string': 'string'
        },
        'name': 'string',
        'revisionId': 'string',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED',
        'tags': {
            'string': 'string'
        },
        'title': 'string'
    }
}

Response Structure

  • (dict) --

    • contentSummary (dict) --

      The content summary.

      • contentArn (string) --

        The Amazon Resource Name (ARN) of the content.

      • contentId (string) --

        The identifier of the content.

      • contentType (string) --

        The media type of the content.

      • knowledgeBaseArn (string) --

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

      • knowledgeBaseId (string) --

        The the identifier of the knowledge base.

      • metadata (dict) --

        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.

        • (string) --
          • (string) --
      • name (string) --

        The name of the content.

      • revisionId (string) --

        The identifier of the revision of the content.

      • status (string) --

        The status of the content.

      • tags (dict) --

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

        • (string) --
          • (string) --
      • title (string) --

        The title of the content.

Exceptions

get_knowledge_base(**kwargs)

Retrieves information about the knowledge base.

See also: AWS API Documentation

Request Syntax

response = client.get_knowledge_base(
    knowledgeBaseId='string'
)
Parameters
knowledgeBaseId (string) --

[REQUIRED]

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type
dict
Returns
Response Syntax
{
    'knowledgeBase': {
        'description': 'string',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'knowledgeBaseType': 'EXTERNAL'|'CUSTOM',
        'lastContentModificationTime': datetime(2015, 1, 1),
        'name': 'string',
        'renderingConfiguration': {
            'templateUri': 'string'
        },
        'serverSideEncryptionConfiguration': {
            'kmsKeyId': 'string'
        },
        'sourceConfiguration': {
            'appIntegrations': {
                'appIntegrationArn': 'string',
                'objectFields': [
                    'string',
                ]
            }
        },
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • knowledgeBase (dict) --

      The knowledge base.

      • description (string) --

        The description.

      • knowledgeBaseArn (string) --

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

      • knowledgeBaseId (string) --

        The the identifier of the knowledge base.

      • knowledgeBaseType (string) --

        The type of knowledge base.

      • lastContentModificationTime (datetime) --

        An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.

      • name (string) --

        The name of the knowledge base.

      • renderingConfiguration (dict) --

        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_GetContent.html">GetContent</a>. </p>
      • serverSideEncryptionConfiguration (dict) --

        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 (dict) --

        Source configuration information about the knowledge base.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: appIntegrations. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        • appIntegrations (dict) --

          Configuration information for Amazon AppIntegrations to automatically ingest content.

          • appIntegrationArn (string) --

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

          • objectFields (list) --

            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.

            • (string) --
      • status (string) --

        The status of the knowledge base.

      • tags (dict) --

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

        • (string) --
          • (string) --

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_recommendations(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.get_recommendations(
    assistantId='string',
    maxResults=123,
    sessionId='string',
    waitTimeSeconds=123
)
Parameters
  • assistantId (string) --

    [REQUIRED]

    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) --

    [REQUIRED]

    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.
Return type

dict

Returns

Response Syntax

{
    'recommendations': [
        {
            'document': {
                'contentReference': {
                    'contentArn': 'string',
                    'contentId': 'string',
                    'knowledgeBaseArn': 'string',
                    'knowledgeBaseId': 'string'
                },
                'excerpt': {
                    'highlights': [
                        {
                            'beginOffsetInclusive': 123,
                            'endOffsetExclusive': 123
                        },
                    ],
                    'text': 'string'
                },
                'title': {
                    'highlights': [
                        {
                            'beginOffsetInclusive': 123,
                            'endOffsetExclusive': 123
                        },
                    ],
                    'text': 'string'
                }
            },
            'recommendationId': 'string',
            'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW',
            'relevanceScore': 123.0
        },
    ]
}

Response Structure

  • (dict) --

    • recommendations (list) --

      The recommendations.

      • (dict) --

        Information about the recommendation.

        • document (dict) --

          The recommended document.

          • contentReference (dict) --

            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 (dict) --

            The excerpt from the document.

            • highlights (list) --

              Highlights in the document text.

              • (dict) --

                Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

                • 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 (dict) --

            The title of the document.

            • highlights (list) --

              Highlights in the document text.

              • (dict) --

                Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

                • beginOffsetInclusive (integer) --

                  The offset for the start of the highlight.

                • endOffsetExclusive (integer) --

                  The offset for the end of the highlight.

            • text (string) --

              Text in the document.

        • recommendationId (string) --

          The identifier of the recommendation.

        • relevanceLevel (string) --

          The relevance level of the recommendation.

        • relevanceScore (float) --

          The relevance score of the recommendation.

Exceptions

get_session(**kwargs)

Retrieves information for a specified session.

See also: AWS API Documentation

Request Syntax

response = client.get_session(
    assistantId='string',
    sessionId='string'
)
Parameters
  • assistantId (string) --

    [REQUIRED]

    The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • sessionId (string) --

    [REQUIRED]

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type

dict

Returns

Response Syntax

{
    'session': {
        'description': 'string',
        'name': 'string',
        'sessionArn': 'string',
        'sessionId': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • session (dict) --

      The session.

      • description (string) --

        The description of the session.

      • name (string) --

        The name of the session.

      • sessionArn (string) --

        The Amazon Resource Name (ARN) of the session.

      • sessionId (string) --

        The identifier of the session.

      • tags (dict) --

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

        • (string) --
          • (string) --

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_assistant_associations(**kwargs)

Lists information about assistant associations.

See also: AWS API Documentation

Request Syntax

response = client.list_assistant_associations(
    assistantId='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • assistantId (string) --

    [REQUIRED]

    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.
Return type

dict

Returns

Response Syntax

{
    'assistantAssociationSummaries': [
        {
            'assistantArn': 'string',
            'assistantAssociationArn': 'string',
            'assistantAssociationId': 'string',
            'assistantId': 'string',
            'associationData': {
                'knowledgeBaseAssociation': {
                    'knowledgeBaseArn': 'string',
                    'knowledgeBaseId': 'string'
                }
            },
            'associationType': 'KNOWLEDGE_BASE',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • assistantAssociationSummaries (list) --

      Summary information about assistant associations.

      • (dict) --

        Summary information about the assistant association.

        • assistantArn (string) --

          The Amazon Resource Name (ARN) of the Wisdom assistant

        • assistantAssociationArn (string) --

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

        • assistantAssociationId (string) --

          The identifier of the assistant association.

        • assistantId (string) --

          The identifier of the Wisdom assistant.

        • associationData (dict) --

          The association data.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: knowledgeBaseAssociation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • knowledgeBaseAssociation (dict) --

            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.

        • associationType (string) --

          The type of association.

        • tags (dict) --

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

          • (string) --
            • (string) --
    • nextToken (string) --

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

Exceptions

list_assistants(**kwargs)

Lists information about assistants.

See also: AWS API Documentation

Request Syntax

response = client.list_assistants(
    maxResults=123,
    nextToken='string'
)
Parameters
  • 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.
Return type

dict

Returns

Response Syntax

{
    'assistantSummaries': [
        {
            'assistantArn': 'string',
            'assistantId': 'string',
            'description': 'string',
            'name': 'string',
            'serverSideEncryptionConfiguration': {
                'kmsKeyId': 'string'
            },
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
            'tags': {
                'string': 'string'
            },
            'type': 'AGENT'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • assistantSummaries (list) --

      Information about the assistants.

      • (dict) --

        Summary information about the assistant.

        • assistantArn (string) --

          The Amazon Resource Name (ARN) of the Wisdom assistant

        • assistantId (string) --

          The identifier of the Wisdom assistant.

        • description (string) --

          The description of the assistant.

        • name (string) --

          The name of the assistant.

        • serverSideEncryptionConfiguration (dict) --

          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 .

        • status (string) --

          The status of the assistant.

        • tags (dict) --

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

          • (string) --
            • (string) --
        • type (string) --

          The type of the assistant.

    • nextToken (string) --

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

Exceptions

list_contents(**kwargs)

Lists the content.

See also: AWS API Documentation

Request Syntax

response = client.list_contents(
    knowledgeBaseId='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • knowledgeBaseId (string) --

    [REQUIRED]

    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.
Return type

dict

Returns

Response Syntax

{
    'contentSummaries': [
        {
            'contentArn': 'string',
            'contentId': 'string',
            'contentType': 'string',
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'metadata': {
                'string': 'string'
            },
            'name': 'string',
            'revisionId': 'string',
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED',
            'tags': {
                'string': 'string'
            },
            'title': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • contentSummaries (list) --

      Information about the content.

      • (dict) --

        Summary information about the content.

        • contentArn (string) --

          The Amazon Resource Name (ARN) of the content.

        • contentId (string) --

          The identifier of the content.

        • contentType (string) --

          The media type of the content.

        • knowledgeBaseArn (string) --

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

        • knowledgeBaseId (string) --

          The the identifier of the knowledge base.

        • metadata (dict) --

          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.

          • (string) --
            • (string) --
        • name (string) --

          The name of the content.

        • revisionId (string) --

          The identifier of the revision of the content.

        • status (string) --

          The status of the content.

        • tags (dict) --

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

          • (string) --
            • (string) --
        • title (string) --

          The title of the content.

    • nextToken (string) --

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

Exceptions

list_knowledge_bases(**kwargs)

Lists the knowledge bases.

See also: AWS API Documentation

Request Syntax

response = client.list_knowledge_bases(
    maxResults=123,
    nextToken='string'
)
Parameters
  • 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.
Return type

dict

Returns

Response Syntax

{
    'knowledgeBaseSummaries': [
        {
            'description': 'string',
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'knowledgeBaseType': 'EXTERNAL'|'CUSTOM',
            'name': 'string',
            'renderingConfiguration': {
                'templateUri': 'string'
            },
            'serverSideEncryptionConfiguration': {
                'kmsKeyId': 'string'
            },
            'sourceConfiguration': {
                'appIntegrations': {
                    'appIntegrationArn': 'string',
                    'objectFields': [
                        'string',
                    ]
                }
            },
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • knowledgeBaseSummaries (list) --

      Information about the knowledge bases.

      • (dict) --

        Summary information about the knowledge base.

        • description (string) --

          The description of the knowledge base.

        • knowledgeBaseArn (string) --

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

        • knowledgeBaseId (string) --

          The the identifier of the knowledge base.

        • knowledgeBaseType (string) --

          The type of knowledge base.

        • name (string) --

          The name of the knowledge base.

        • renderingConfiguration (dict) --

          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_GetContent.html">GetContent</a>. </p>

        • serverSideEncryptionConfiguration (dict) --

          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 (dict) --

          [KEVIN]

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: appIntegrations. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • appIntegrations (dict) --

            Configuration information for Amazon AppIntegrations to automatically ingest content.

            • appIntegrationArn (string) --

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

            • objectFields (list) --

              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.

              • (string) --
        • status (string) --

          The status of the knowledge base summary.

        • tags (dict) --

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

          • (string) --
            • (string) --
    • nextToken (string) --

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

Exceptions

list_tags_for_resource(**kwargs)

Lists the tags for the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --

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

      • (string) --
        • (string) --

Exceptions

notify_recommendations_received(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.notify_recommendations_received(
    assistantId='string',
    recommendationIds=[
        'string',
    ],
    sessionId='string'
)
Parameters
  • assistantId (string) --

    [REQUIRED]

    The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • recommendationIds (list) --

    [REQUIRED]

    The identifiers of the recommendations.

    • (string) --
  • sessionId (string) --

    [REQUIRED]

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type

dict

Returns

Response Syntax

{
    'errors': [
        {
            'message': 'string',
            'recommendationId': 'string'
        },
    ],
    'recommendationIds': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • errors (list) --

      The identifiers of recommendations that are causing errors.

      • (dict) --

        An error occurred when creating a recommendation.

        • message (string) --

          A recommendation is causing an error.

        • recommendationId (string) --

          The identifier of the recommendation that is in error.

    • recommendationIds (list) --

      The identifiers of the recommendations.

      • (string) --

Exceptions

query_assistant(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.query_assistant(
    assistantId='string',
    maxResults=123,
    nextToken='string',
    queryText='string'
)
Parameters
  • assistantId (string) --

    [REQUIRED]

    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) --

    [REQUIRED]

    The text to search for.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'results': [
        {
            'document': {
                'contentReference': {
                    'contentArn': 'string',
                    'contentId': 'string',
                    'knowledgeBaseArn': 'string',
                    'knowledgeBaseId': 'string'
                },
                'excerpt': {
                    'highlights': [
                        {
                            'beginOffsetInclusive': 123,
                            'endOffsetExclusive': 123
                        },
                    ],
                    'text': 'string'
                },
                'title': {
                    'highlights': [
                        {
                            'beginOffsetInclusive': 123,
                            'endOffsetExclusive': 123
                        },
                    ],
                    'text': 'string'
                }
            },
            'relevanceScore': 123.0,
            'resultId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

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

    • results (list) --

      The results of the query.

      • (dict) --

        Information about the result.

        • document (dict) --

          The document.

          • contentReference (dict) --

            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 (dict) --

            The excerpt from the document.

            • highlights (list) --

              Highlights in the document text.

              • (dict) --

                Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

                • 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 (dict) --

            The title of the document.

            • highlights (list) --

              Highlights in the document text.

              • (dict) --

                Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

                • beginOffsetInclusive (integer) --

                  The offset for the start of the highlight.

                • endOffsetExclusive (integer) --

                  The offset for the end of the highlight.

            • text (string) --

              Text in the document.

        • relevanceScore (float) --

          The relevance score of the results.

        • resultId (string) --

          The identifier of the result data.

Exceptions

remove_knowledge_base_template_uri(**kwargs)

Removes a URI template from a knowledge base.

See also: AWS API Documentation

Request Syntax

response = client.remove_knowledge_base_template_uri(
    knowledgeBaseId='string'
)
Parameters
knowledgeBaseId (string) --

[REQUIRED]

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

search_content(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.search_content(
    knowledgeBaseId='string',
    maxResults=123,
    nextToken='string',
    searchExpression={
        'filters': [
            {
                'field': 'NAME',
                'operator': 'EQUALS',
                'value': 'string'
            },
        ]
    }
)
Parameters
  • knowledgeBaseId (string) --

    [REQUIRED]

    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 (dict) --

    [REQUIRED]

    The search expression to filter results.

    • filters (list) -- [REQUIRED]

      The search expression filters.

      • (dict) --

        A search filter.

        • field (string) -- [REQUIRED]

          The field on which to filter.

        • operator (string) -- [REQUIRED]

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

        • value (string) -- [REQUIRED]

          The desired field value on which to filter.

Return type

dict

Returns

Response Syntax

{
    'contentSummaries': [
        {
            'contentArn': 'string',
            'contentId': 'string',
            'contentType': 'string',
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'metadata': {
                'string': 'string'
            },
            'name': 'string',
            'revisionId': 'string',
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED',
            'tags': {
                'string': 'string'
            },
            'title': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • contentSummaries (list) --

      Summary information about the content.

      • (dict) --

        Summary information about the content.

        • contentArn (string) --

          The Amazon Resource Name (ARN) of the content.

        • contentId (string) --

          The identifier of the content.

        • contentType (string) --

          The media type of the content.

        • knowledgeBaseArn (string) --

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

        • knowledgeBaseId (string) --

          The the identifier of the knowledge base.

        • metadata (dict) --

          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.

          • (string) --
            • (string) --
        • name (string) --

          The name of the content.

        • revisionId (string) --

          The identifier of the revision of the content.

        • status (string) --

          The status of the content.

        • tags (dict) --

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

          • (string) --
            • (string) --
        • title (string) --

          The title of the content.

    • nextToken (string) --

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

Exceptions

search_sessions(**kwargs)

Searches for sessions.

See also: AWS API Documentation

Request Syntax

response = client.search_sessions(
    assistantId='string',
    maxResults=123,
    nextToken='string',
    searchExpression={
        'filters': [
            {
                'field': 'NAME',
                'operator': 'EQUALS',
                'value': 'string'
            },
        ]
    }
)
Parameters
  • assistantId (string) --

    [REQUIRED]

    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 (dict) --

    [REQUIRED]

    The search expression to filter results.

    • filters (list) -- [REQUIRED]

      The search expression filters.

      • (dict) --

        A search filter.

        • field (string) -- [REQUIRED]

          The field on which to filter.

        • operator (string) -- [REQUIRED]

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

        • value (string) -- [REQUIRED]

          The desired field value on which to filter.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'sessionSummaries': [
        {
            'assistantArn': 'string',
            'assistantId': 'string',
            'sessionArn': 'string',
            'sessionId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

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

    • sessionSummaries (list) --

      Summary information about the sessions.

      • (dict) --

        Summary information about the session.

        • assistantArn (string) --

          The Amazon Resource Name (ARN) of the Wisdom assistant

        • assistantId (string) --

          The identifier of the Wisdom assistant.

        • sessionArn (string) --

          The Amazon Resource Name (ARN) of the session.

        • sessionId (string) --

          The identifier of the session.

Exceptions

start_content_upload(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.start_content_upload(
    contentType='string',
    knowledgeBaseId='string'
)
Parameters
  • contentType (string) --

    [REQUIRED]

    The type of content to upload.

  • knowledgeBaseId (string) --

    [REQUIRED]

    The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type

dict

Returns

Response Syntax

{
    'headersToInclude': {
        'string': 'string'
    },
    'uploadId': 'string',
    'url': 'string',
    'urlExpiry': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • headersToInclude (dict) --

      The headers to include in the upload.

      • (string) --
        • (string) --
    • uploadId (string) --

      The identifier of the upload.

    • url (string) --

      The URL of the upload.

    • urlExpiry (datetime) --

      The expiration time of the URL as an epoch timestamp.

Exceptions

tag_resource(**kwargs)

Adds the specified tags to the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • tags (dict) --

    [REQUIRED]

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

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes the specified tags from the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • tagKeys (list) --

    [REQUIRED]

    The tag keys.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_content(**kwargs)

Updates information about the content.

See also: AWS API Documentation

Request Syntax

response = client.update_content(
    contentId='string',
    knowledgeBaseId='string',
    metadata={
        'string': 'string'
    },
    overrideLinkOutUri='string',
    removeOverrideLinkOutUri=True|False,
    revisionId='string',
    title='string',
    uploadId='string'
)
Parameters
  • contentId (string) --

    [REQUIRED]

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • knowledgeBaseId (string) --

    [REQUIRED]

    The the identifier of the knowledge base. Can be either the ID or the ARN

  • metadata (dict) --

    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.

    • (string) --
      • (string) --
  • 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 .
Return type

dict

Returns

Response Syntax

{
    'content': {
        'contentArn': 'string',
        'contentId': 'string',
        'contentType': 'string',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'linkOutUri': 'string',
        'metadata': {
            'string': 'string'
        },
        'name': 'string',
        'revisionId': 'string',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED',
        'tags': {
            'string': 'string'
        },
        'title': 'string',
        'url': 'string',
        'urlExpiry': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • content (dict) --

      The content.

      • contentArn (string) --

        The Amazon Resource Name (ARN) of the content.

      • contentId (string) --

        The identifier of the content.

      • contentType (string) --

        The media type of the content.

      • knowledgeBaseArn (string) --

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

      • knowledgeBaseId (string) --

        The the identifier of the knowledge base.

      • linkOutUri (string) --

        The URI of the content.

      • metadata (dict) --

        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.

        • (string) --
          • (string) --
      • name (string) --

        The name of the content.

      • revisionId (string) --

        The identifier of the content revision.

      • status (string) --

        The status of the content.

      • tags (dict) --

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

        • (string) --
          • (string) --
      • title (string) --

        The title of the content.

      • url (string) --

        The URL of the content.

      • urlExpiry (datetime) --

        The expiration time of the URL as an epoch timestamp.

Exceptions

update_knowledge_base_template_uri(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.update_knowledge_base_template_uri(
    knowledgeBaseId='string',
    templateUri='string'
)
Parameters
  • knowledgeBaseId (string) --

    [REQUIRED]

    The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • templateUri (string) --

    [REQUIRED]

    The template URI to update.

Return type

dict

Returns

Response Syntax

{
    'knowledgeBase': {
        'description': 'string',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'knowledgeBaseType': 'EXTERNAL'|'CUSTOM',
        'lastContentModificationTime': datetime(2015, 1, 1),
        'name': 'string',
        'renderingConfiguration': {
            'templateUri': 'string'
        },
        'serverSideEncryptionConfiguration': {
            'kmsKeyId': 'string'
        },
        'sourceConfiguration': {
            'appIntegrations': {
                'appIntegrationArn': 'string',
                'objectFields': [
                    'string',
                ]
            }
        },
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • knowledgeBase (dict) --

      The knowledge base to update.

      • description (string) --

        The description.

      • knowledgeBaseArn (string) --

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

      • knowledgeBaseId (string) --

        The the identifier of the knowledge base.

      • knowledgeBaseType (string) --

        The type of knowledge base.

      • lastContentModificationTime (datetime) --

        An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.

      • name (string) --

        The name of the knowledge base.

      • renderingConfiguration (dict) --

        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_GetContent.html">GetContent</a>. </p>

      • serverSideEncryptionConfiguration (dict) --

        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 (dict) --

        Source configuration information about the knowledge base.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: appIntegrations. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        • appIntegrations (dict) --

          Configuration information for Amazon AppIntegrations to automatically ingest content.

          • appIntegrationArn (string) --

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

          • objectFields (list) --

            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.

            • (string) --
      • status (string) --

        The status of the knowledge base.

      • tags (dict) --

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

        • (string) --
          • (string) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class ConnectWisdomService.Client.exceptions.AccessDeniedException

You do not have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient access to perform this action.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ConnectWisdomService.Client.exceptions.ConflictException

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant ) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant ) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ConnectWisdomService.Client.exceptions.PreconditionFailedException

The provided revisionId does not match, indicating the content has been modified since it was last read.

Example

try:
  ...
except client.exceptions.PreconditionFailedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The provided revisionId does not match, indicating the content has been modified since it was last read.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ConnectWisdomService.Client.exceptions.ResourceNotFoundException

The specified resource does not exist.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceName': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified resource does not exist.

    • message (string) --

    • resourceName (string) --

      The specified resource name.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ConnectWisdomService.Client.exceptions.ServiceQuotaExceededException

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ConnectWisdomService.Client.exceptions.TooManyTagsException

Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.

Example

try:
  ...
except client.exceptions.TooManyTagsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceName': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.

    • message (string) --

    • resourceName (string) --

      The specified resource name.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ConnectWisdomService.Client.exceptions.ValidationException

The input fails to satisfy the constraints specified by an AWS service.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The input fails to satisfy the constraints specified by an AWS service.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class ConnectWisdomService.Paginator.ListAssistantAssociations
paginator = client.get_paginator('list_assistant_associations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ConnectWisdomService.Client.list_assistant_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    assistantId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • assistantId (string) --

    [REQUIRED]

    The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'assistantAssociationSummaries': [
        {
            'assistantArn': 'string',
            'assistantAssociationArn': 'string',
            'assistantAssociationId': 'string',
            'assistantId': 'string',
            'associationData': {
                'knowledgeBaseAssociation': {
                    'knowledgeBaseArn': 'string',
                    'knowledgeBaseId': 'string'
                }
            },
            'associationType': 'KNOWLEDGE_BASE',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • assistantAssociationSummaries (list) --

      Summary information about assistant associations.

      • (dict) --

        Summary information about the assistant association.

        • assistantArn (string) --

          The Amazon Resource Name (ARN) of the Wisdom assistant

        • assistantAssociationArn (string) --

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

        • assistantAssociationId (string) --

          The identifier of the assistant association.

        • assistantId (string) --

          The identifier of the Wisdom assistant.

        • associationData (dict) --

          The association data.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: knowledgeBaseAssociation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • knowledgeBaseAssociation (dict) --

            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.

        • associationType (string) --

          The type of association.

        • tags (dict) --

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

          • (string) --
            • (string) --
    • NextToken (string) --

      A token to resume pagination.

class ConnectWisdomService.Paginator.ListAssistants
paginator = client.get_paginator('list_assistants')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ConnectWisdomService.Client.list_assistants().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'assistantSummaries': [
        {
            'assistantArn': 'string',
            'assistantId': 'string',
            'description': 'string',
            'name': 'string',
            'serverSideEncryptionConfiguration': {
                'kmsKeyId': 'string'
            },
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
            'tags': {
                'string': 'string'
            },
            'type': 'AGENT'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • assistantSummaries (list) --

      Information about the assistants.

      • (dict) --

        Summary information about the assistant.

        • assistantArn (string) --

          The Amazon Resource Name (ARN) of the Wisdom assistant

        • assistantId (string) --

          The identifier of the Wisdom assistant.

        • description (string) --

          The description of the assistant.

        • name (string) --

          The name of the assistant.

        • serverSideEncryptionConfiguration (dict) --

          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 .

        • status (string) --

          The status of the assistant.

        • tags (dict) --

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

          • (string) --
            • (string) --
        • type (string) --

          The type of the assistant.

    • NextToken (string) --

      A token to resume pagination.

class ConnectWisdomService.Paginator.ListContents
paginator = client.get_paginator('list_contents')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ConnectWisdomService.Client.list_contents().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    knowledgeBaseId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • knowledgeBaseId (string) --

    [REQUIRED]

    The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'contentSummaries': [
        {
            'contentArn': 'string',
            'contentId': 'string',
            'contentType': 'string',
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'metadata': {
                'string': 'string'
            },
            'name': 'string',
            'revisionId': 'string',
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED',
            'tags': {
                'string': 'string'
            },
            'title': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • contentSummaries (list) --

      Information about the content.

      • (dict) --

        Summary information about the content.

        • contentArn (string) --

          The Amazon Resource Name (ARN) of the content.

        • contentId (string) --

          The identifier of the content.

        • contentType (string) --

          The media type of the content.

        • knowledgeBaseArn (string) --

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

        • knowledgeBaseId (string) --

          The the identifier of the knowledge base.

        • metadata (dict) --

          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.

          • (string) --
            • (string) --
        • name (string) --

          The name of the content.

        • revisionId (string) --

          The identifier of the revision of the content.

        • status (string) --

          The status of the content.

        • tags (dict) --

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

          • (string) --
            • (string) --
        • title (string) --

          The title of the content.

    • NextToken (string) --

      A token to resume pagination.

class ConnectWisdomService.Paginator.ListKnowledgeBases
paginator = client.get_paginator('list_knowledge_bases')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ConnectWisdomService.Client.list_knowledge_bases().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'knowledgeBaseSummaries': [
        {
            'description': 'string',
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'knowledgeBaseType': 'EXTERNAL'|'CUSTOM',
            'name': 'string',
            'renderingConfiguration': {
                'templateUri': 'string'
            },
            'serverSideEncryptionConfiguration': {
                'kmsKeyId': 'string'
            },
            'sourceConfiguration': {
                'appIntegrations': {
                    'appIntegrationArn': 'string',
                    'objectFields': [
                        'string',
                    ]
                }
            },
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • knowledgeBaseSummaries (list) --

      Information about the knowledge bases.

      • (dict) --

        Summary information about the knowledge base.

        • description (string) --

          The description of the knowledge base.

        • knowledgeBaseArn (string) --

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

        • knowledgeBaseId (string) --

          The the identifier of the knowledge base.

        • knowledgeBaseType (string) --

          The type of knowledge base.

        • name (string) --

          The name of the knowledge base.

        • renderingConfiguration (dict) --

          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_GetContent.html">GetContent</a>. </p>
        • serverSideEncryptionConfiguration (dict) --

          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 (dict) --

          [KEVIN]

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: appIntegrations. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • appIntegrations (dict) --

            Configuration information for Amazon AppIntegrations to automatically ingest content.

            • appIntegrationArn (string) --

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

            • objectFields (list) --

              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.

              • (string) --
        • status (string) --

          The status of the knowledge base summary.

        • tags (dict) --

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

          • (string) --
            • (string) --
    • NextToken (string) --

      A token to resume pagination.

class ConnectWisdomService.Paginator.QueryAssistant
paginator = client.get_paginator('query_assistant')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ConnectWisdomService.Client.query_assistant().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    assistantId='string',
    queryText='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • assistantId (string) --

    [REQUIRED]

    The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • queryText (string) --

    [REQUIRED]

    The text to search for.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'results': [
        {
            'document': {
                'contentReference': {
                    'contentArn': 'string',
                    'contentId': 'string',
                    'knowledgeBaseArn': 'string',
                    'knowledgeBaseId': 'string'
                },
                'excerpt': {
                    'highlights': [
                        {
                            'beginOffsetInclusive': 123,
                            'endOffsetExclusive': 123
                        },
                    ],
                    'text': 'string'
                },
                'title': {
                    'highlights': [
                        {
                            'beginOffsetInclusive': 123,
                            'endOffsetExclusive': 123
                        },
                    ],
                    'text': 'string'
                }
            },
            'relevanceScore': 123.0,
            'resultId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • results (list) --

      The results of the query.

      • (dict) --

        Information about the result.

        • document (dict) --

          The document.

          • contentReference (dict) --

            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 (dict) --

            The excerpt from the document.

            • highlights (list) --

              Highlights in the document text.

              • (dict) --

                Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

                • 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 (dict) --

            The title of the document.

            • highlights (list) --

              Highlights in the document text.

              • (dict) --

                Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

                • beginOffsetInclusive (integer) --

                  The offset for the start of the highlight.

                • endOffsetExclusive (integer) --

                  The offset for the end of the highlight.

            • text (string) --

              Text in the document.

        • relevanceScore (float) --

          The relevance score of the results.

        • resultId (string) --

          The identifier of the result data.

    • NextToken (string) --

      A token to resume pagination.

class ConnectWisdomService.Paginator.SearchContent
paginator = client.get_paginator('search_content')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ConnectWisdomService.Client.search_content().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    knowledgeBaseId='string',
    searchExpression={
        'filters': [
            {
                'field': 'NAME',
                'operator': 'EQUALS',
                'value': 'string'
            },
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • knowledgeBaseId (string) --

    [REQUIRED]

    The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • searchExpression (dict) --

    [REQUIRED]

    The search expression to filter results.

    • filters (list) -- [REQUIRED]

      The search expression filters.

      • (dict) --

        A search filter.

        • field (string) -- [REQUIRED]

          The field on which to filter.

        • operator (string) -- [REQUIRED]

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

        • value (string) -- [REQUIRED]

          The desired field value on which to filter.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'contentSummaries': [
        {
            'contentArn': 'string',
            'contentId': 'string',
            'contentType': 'string',
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'metadata': {
                'string': 'string'
            },
            'name': 'string',
            'revisionId': 'string',
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED',
            'tags': {
                'string': 'string'
            },
            'title': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • contentSummaries (list) --

      Summary information about the content.

      • (dict) --

        Summary information about the content.

        • contentArn (string) --

          The Amazon Resource Name (ARN) of the content.

        • contentId (string) --

          The identifier of the content.

        • contentType (string) --

          The media type of the content.

        • knowledgeBaseArn (string) --

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

        • knowledgeBaseId (string) --

          The the identifier of the knowledge base.

        • metadata (dict) --

          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.

          • (string) --
            • (string) --
        • name (string) --

          The name of the content.

        • revisionId (string) --

          The identifier of the revision of the content.

        • status (string) --

          The status of the content.

        • tags (dict) --

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

          • (string) --
            • (string) --
        • title (string) --

          The title of the content.

    • NextToken (string) --

      A token to resume pagination.

class ConnectWisdomService.Paginator.SearchSessions
paginator = client.get_paginator('search_sessions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ConnectWisdomService.Client.search_sessions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    assistantId='string',
    searchExpression={
        'filters': [
            {
                'field': 'NAME',
                'operator': 'EQUALS',
                'value': 'string'
            },
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • assistantId (string) --

    [REQUIRED]

    The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • searchExpression (dict) --

    [REQUIRED]

    The search expression to filter results.

    • filters (list) -- [REQUIRED]

      The search expression filters.

      • (dict) --

        A search filter.

        • field (string) -- [REQUIRED]

          The field on which to filter.

        • operator (string) -- [REQUIRED]

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

        • value (string) -- [REQUIRED]

          The desired field value on which to filter.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'sessionSummaries': [
        {
            'assistantArn': 'string',
            'assistantId': 'string',
            'sessionArn': 'string',
            'sessionId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • sessionSummaries (list) --

      Summary information about the sessions.

      • (dict) --

        Summary information about the session.

        • assistantArn (string) --

          The Amazon Resource Name (ARN) of the Wisdom assistant

        • assistantId (string) --

          The identifier of the Wisdom assistant.

        • sessionArn (string) --

          The Amazon Resource Name (ARN) of the session.

        • sessionId (string) --

          The identifier of the session.

    • NextToken (string) --

      A token to resume pagination.