Amazon Connect Wisdom Service

2021/09/27 - Amazon Connect Wisdom Service - 31 new api methods

Changes  Released Amazon Connect Wisdom, a feature of Amazon Connect, which provides real-time recommendations and search functionality in general availability (GA). For more information, see https://docs.aws.amazon.com/wisdom/latest/APIReference/Welcome.html.

GetContentSummary (new) Link ¶

Retrieves summary information about the content.

See also: AWS API Documentation

Request Syntax

client.get_content_summary(
    contentId='string',
    knowledgeBaseId='string'
)
type contentId:

string

param contentId:

[REQUIRED]

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

type knowledgeBaseId:

string

param knowledgeBaseId:

[REQUIRED]

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

rtype:

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.

ListAssistantAssociations (new) Link ¶

Lists information about assistant associations.

See also: AWS API Documentation

Request Syntax

client.list_assistant_associations(
    assistantId='string',
    maxResults=123,
    nextToken='string'
)
type assistantId:

string

param assistantId:

[REQUIRED]

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

type maxResults:

integer

param maxResults:

The maximum number of results to return per page.

type nextToken:

string

param nextToken:

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.

rtype:

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.

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

SearchContent (new) Link ¶

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

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

string

param knowledgeBaseId:

[REQUIRED]

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

type maxResults:

integer

param maxResults:

The maximum number of results to return per page.

type nextToken:

string

param nextToken:

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.

type searchExpression:

dict

param searchExpression:

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

rtype:

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.

GetKnowledgeBase (new) Link ¶

Retrieves information about the knowledge base.

See also: AWS API Documentation

Request Syntax

client.get_knowledge_base(
    knowledgeBaseId='string'
)
type knowledgeBaseId:

string

param knowledgeBaseId:

[REQUIRED]

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

rtype:

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.

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

DeleteContent (new) Link ¶

Deletes the content.

See also: AWS API Documentation

Request Syntax

client.delete_content(
    contentId='string',
    knowledgeBaseId='string'
)
type contentId:

string

param contentId:

[REQUIRED]

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

type knowledgeBaseId:

string

param knowledgeBaseId:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

ListAssistants (new) Link ¶

Lists information about assistants.

See also: AWS API Documentation

Request Syntax

client.list_assistants(
    maxResults=123,
    nextToken='string'
)
type maxResults:

integer

param maxResults:

The maximum number of results to return per page.

type nextToken:

string

param nextToken:

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.

rtype:

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.

CreateSession (new) Link ¶

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

client.create_session(
    assistantId='string',
    clientToken='string',
    description='string',
    name='string',
    tags={
        'string': 'string'
    }
)
type assistantId:

string

param assistantId:

[REQUIRED]

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

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

type description:

string

param description:

The description.

type name:

string

param name:

[REQUIRED]

The name of the session.

type tags:

dict

param tags:

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

  • (string) --

    • (string) --

rtype:

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

CreateAssistantAssociation (new) Link ¶

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

client.create_assistant_association(
    assistantId='string',
    association={
        'knowledgeBaseId': 'string'
    },
    associationType='KNOWLEDGE_BASE',
    clientToken='string',
    tags={
        'string': 'string'
    }
)
type assistantId:

string

param assistantId:

[REQUIRED]

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

type association:

dict

param association:

[REQUIRED]

The identifier of the associated resource.

  • knowledgeBaseId (string) --

    The the identifier of the knowledge base.

type associationType:

string

param associationType:

[REQUIRED]

The type of association.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

type tags:

dict

param tags:

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

  • (string) --

    • (string) --

rtype:

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.

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

GetRecommendations (new) Link ¶

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

client.get_recommendations(
    assistantId='string',
    maxResults=123,
    sessionId='string',
    waitTimeSeconds=123
)
type assistantId:

string

param assistantId:

[REQUIRED]

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

type maxResults:

integer

param maxResults:

The maximum number of results to return per page.

type sessionId:

string

param sessionId:

[REQUIRED]

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

type waitTimeSeconds:

integer

param waitTimeSeconds:

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.

rtype:

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.

CreateKnowledgeBase (new) Link ¶

Creates a knowledge base.

See also: AWS API Documentation

Request Syntax

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'
    }
)
type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

type description:

string

param description:

The description.

type knowledgeBaseType:

string

param knowledgeBaseType:

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

type name:

string

param name:

[REQUIRED]

The name of the knowledge base.

type renderingConfiguration:

dict

param renderingConfiguration:

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

type serverSideEncryptionConfiguration:

dict

param serverSideEncryptionConfiguration:

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.

type sourceConfiguration:

dict

param sourceConfiguration:

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

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

type tags:

dict

param tags:

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

  • (string) --

    • (string) --

rtype:

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.

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

QueryAssistant (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.query_assistant(
    assistantId='string',
    maxResults=123,
    nextToken='string',
    queryText='string'
)
type assistantId:

string

param assistantId:

[REQUIRED]

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

type maxResults:

integer

param maxResults:

The maximum number of results to return per page.

type nextToken:

string

param nextToken:

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.

type queryText:

string

param queryText:

[REQUIRED]

The text to search for.

rtype:

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.

NotifyRecommendationsReceived (new) Link ¶

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

client.notify_recommendations_received(
    assistantId='string',
    recommendationIds=[
        'string',
    ],
    sessionId='string'
)
type assistantId:

string

param assistantId:

[REQUIRED]

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

type recommendationIds:

list

param recommendationIds:

[REQUIRED]

The identifiers of the recommendations.

  • (string) --

type sessionId:

string

param sessionId:

[REQUIRED]

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

rtype:

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

CreateContent (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

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

string

param clientToken:

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

This field is autopopulated if not provided.

type knowledgeBaseId:

string

param knowledgeBaseId:

[REQUIRED]

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

type metadata:

dict

param metadata:

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

type name:

string

param name:

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

type overrideLinkOutUri:

string

param overrideLinkOutUri:

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.

type tags:

dict

param tags:

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

  • (string) --

    • (string) --

type title:

string

param title:

The title of the content. If not set, the title is equal to the name.

type uploadId:

string

param uploadId:

[REQUIRED]

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

rtype:

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.

RemoveKnowledgeBaseTemplateUri (new) Link ¶

Removes a URI template from a knowledge base.

See also: AWS API Documentation

Request Syntax

client.remove_knowledge_base_template_uri(
    knowledgeBaseId='string'
)
type knowledgeBaseId:

string

param knowledgeBaseId:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

GetAssistant (new) Link ¶

Retrieves information about an assistant.

See also: AWS API Documentation

Request Syntax

client.get_assistant(
    assistantId='string'
)
type assistantId:

string

param assistantId:

[REQUIRED]

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

rtype:

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.

ListKnowledgeBases (new) Link ¶

Lists the knowledge bases.

See also: AWS API Documentation

Request Syntax

client.list_knowledge_bases(
    maxResults=123,
    nextToken='string'
)
type maxResults:

integer

param maxResults:

The maximum number of results to return per page.

type nextToken:

string

param nextToken:

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.

rtype:

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]

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

DeleteKnowledgeBase (new) Link ¶

Deletes the knowledge base.

See also: AWS API Documentation

Request Syntax

client.delete_knowledge_base(
    knowledgeBaseId='string'
)
type knowledgeBaseId:

string

param knowledgeBaseId:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

TagResource (new) Link ¶

Adds the specified tags to the specified resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

type tags:

dict

param tags:

[REQUIRED]

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

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

GetContent (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_content(
    contentId='string',
    knowledgeBaseId='string'
)
type contentId:

string

param contentId:

[REQUIRED]

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

type knowledgeBaseId:

string

param knowledgeBaseId:

[REQUIRED]

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

rtype:

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.

StartContentUpload (new) Link ¶

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

client.start_content_upload(
    contentType='string',
    knowledgeBaseId='string'
)
type contentType:

string

param contentType:

[REQUIRED]

The type of content to upload.

type knowledgeBaseId:

string

param knowledgeBaseId:

[REQUIRED]

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

rtype:

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.

UpdateContent (new) Link ¶

Updates information about the content.

See also: AWS API Documentation

Request Syntax

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

string

param contentId:

[REQUIRED]

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

type knowledgeBaseId:

string

param knowledgeBaseId:

[REQUIRED]

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

type metadata:

dict

param metadata:

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

type overrideLinkOutUri:

string

param overrideLinkOutUri:

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.

type removeOverrideLinkOutUri:

boolean

param removeOverrideLinkOutUri:

Unset the existing overrideLinkOutUri if it exists.

type revisionId:

string

param revisionId:

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.

type title:

string

param title:

The title of the content.

type uploadId:

string

param uploadId:

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

rtype:

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.

ListContents (new) Link ¶

Lists the content.

See also: AWS API Documentation

Request Syntax

client.list_contents(
    knowledgeBaseId='string',
    maxResults=123,
    nextToken='string'
)
type knowledgeBaseId:

string

param knowledgeBaseId:

[REQUIRED]

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

type maxResults:

integer

param maxResults:

The maximum number of results to return per page.

type nextToken:

string

param nextToken:

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.

rtype:

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.

UpdateKnowledgeBaseTemplateUri (new) Link ¶

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

client.update_knowledge_base_template_uri(
    knowledgeBaseId='string',
    templateUri='string'
)
type knowledgeBaseId:

string

param knowledgeBaseId:

[REQUIRED]

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

type templateUri:

string

param templateUri:

[REQUIRED]

The template URI to update.

rtype:

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.

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

DeleteAssistant (new) Link ¶

Deletes an assistant.

See also: AWS API Documentation

Request Syntax

client.delete_assistant(
    assistantId='string'
)
type assistantId:

string

param assistantId:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

ListTagsForResource (new) Link ¶

Lists the tags for the specified resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

rtype:

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

SearchSessions (new) Link ¶

Searches for sessions.

See also: AWS API Documentation

Request Syntax

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

string

param assistantId:

[REQUIRED]

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

type maxResults:

integer

param maxResults:

The maximum number of results to return per page.

type nextToken:

string

param nextToken:

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.

type searchExpression:

dict

param searchExpression:

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

rtype:

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.

CreateAssistant (new) Link ¶

Creates an Amazon Connect Wisdom assistant.

See also: AWS API Documentation

Request Syntax

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

string

param clientToken:

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

This field is autopopulated if not provided.

type description:

string

param description:

The description of the assistant.

type name:

string

param name:

[REQUIRED]

The name of the assistant.

type serverSideEncryptionConfiguration:

dict

param serverSideEncryptionConfiguration:

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.

type tags:

dict

param tags:

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

  • (string) --

    • (string) --

type type:

string

param type:

[REQUIRED]

The type of assistant.

rtype:

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.

GetAssistantAssociation (new) Link ¶

Retrieves information about an assistant association.

See also: AWS API Documentation

Request Syntax

client.get_assistant_association(
    assistantAssociationId='string',
    assistantId='string'
)
type assistantAssociationId:

string

param assistantAssociationId:

[REQUIRED]

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

type assistantId:

string

param assistantId:

[REQUIRED]

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

rtype:

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.

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

DeleteAssistantAssociation (new) Link ¶

Deletes an assistant association.

See also: AWS API Documentation

Request Syntax

client.delete_assistant_association(
    assistantAssociationId='string',
    assistantId='string'
)
type assistantAssociationId:

string

param assistantAssociationId:

[REQUIRED]

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

type assistantId:

string

param assistantId:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

UntagResource (new) Link ¶

Removes the specified tags from the specified resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

type tagKeys:

list

param tagKeys:

[REQUIRED]

The tag keys.

  • (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

GetSession (new) Link ¶

Retrieves information for a specified session.

See also: AWS API Documentation

Request Syntax

client.get_session(
    assistantId='string',
    sessionId='string'
)
type assistantId:

string

param assistantId:

[REQUIRED]

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

type sessionId:

string

param sessionId:

[REQUIRED]

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

rtype:

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