Table of Contents
ConnectWisdomService.Client¶A low-level client representing Amazon Connect Wisdom Service
Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers. Agents can search across connected repositories from within their agent desktop to find answers quickly. Use the Amazon Connect Wisdom APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.
import boto3
client = boto3.client('wisdom')
These are the available methods:
can_paginate()close()create_assistant()create_assistant_association()create_content()create_knowledge_base()create_session()delete_assistant()delete_assistant_association()delete_content()delete_knowledge_base()get_assistant()get_assistant_association()get_content()get_content_summary()get_knowledge_base()get_paginator()get_recommendations()get_session()get_waiter()list_assistant_associations()list_assistants()list_contents()list_knowledge_bases()list_tags_for_resource()notify_recommendations_received()query_assistant()remove_knowledge_base_template_uri()search_content()search_sessions()start_content_upload()tag_resource()untag_resource()update_content()update_knowledge_base_template_uri()can_paginate(operation_name)¶Check if an operation can be paginated.
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").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
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'
)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The name of the assistant.
The KMS key used for encryption.
The KMS key. For information about valid ID values, see Key identifiers (KeyId).
The tags used to organize, track, or control access for this resource.
[REQUIRED]
The type of assistant.
dict
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).
status (string) --
The status of the assistant.
tags (dict) --
The tags used to organize, track, or control access for this resource.
type (string) --
The type of assistant.
Exceptions
ConnectWisdomService.Client.exceptions.ConflictExceptionConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.ServiceQuotaExceededExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptioncreate_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'
}
)
[REQUIRED]
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
[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.
The identifier of the knowledge base.
[REQUIRED]
The type of association.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
The tags used to organize, track, or control access for this resource.
dict
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 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.
Exceptions
ConnectWisdomService.Client.exceptions.ConflictExceptionConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.ServiceQuotaExceededExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptioncreate_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'
)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
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.
[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.
The tags used to organize, track, or control access for this resource.
[REQUIRED]
A pointer to the uploaded asset. This value is returned by StartContentUpload.
dict
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 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.
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.
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
ConnectWisdomService.Client.exceptions.ConflictExceptionConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.ServiceQuotaExceededExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptioncreate_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'
}
)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
[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.
[REQUIRED]
The name of the knowledge base.
Information about how to render the content.
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:
Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeletednumber , 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>
The KMS key used for encryption.
The KMS key. For information about valid ID values, see Key identifiers (KeyId).
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.
Configuration information for Amazon AppIntegrations to automatically ingest content.
The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
The fields from the source that are made available to your agents in Wisdom.
Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .number , short_description , sys_mod_count , workflow_state , and active .Make sure to include additional fields. These fields are indexed and used to source recommendations.
The tags used to organize, track, or control access for this resource.
dict
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 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:
Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeletednumber , 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).
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.
Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .number , short_description , sys_mod_count , workflow_state , and active .Make sure to include additional fields. These fields are indexed and used to source recommendations.
status (string) --
The status of the knowledge base.
tags (dict) --
The tags used to organize, track, or control access for this resource.
Exceptions
ConnectWisdomService.Client.exceptions.ConflictExceptionConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.ServiceQuotaExceededExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptioncreate_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'
}
)
[REQUIRED]
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The name of the session.
The tags used to organize, track, or control access for this resource.
dict
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.
Exceptions
ConnectWisdomService.Client.exceptions.ConflictExceptionConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptiondelete_assistant(**kwargs)¶Deletes an assistant.
See also: AWS API Documentation
Request Syntax
response = client.delete_assistant(
assistantId='string'
)
[REQUIRED]
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
{}
Response Structure
Exceptions
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptiondelete_assistant_association(**kwargs)¶Deletes an assistant association.
See also: AWS API Documentation
Request Syntax
response = client.delete_assistant_association(
assistantAssociationId='string',
assistantId='string'
)
[REQUIRED]
The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
dict
Response Syntax
{}
Response Structure
Exceptions
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptiondelete_content(**kwargs)¶Deletes the content.
See also: AWS API Documentation
Request Syntax
response = client.delete_content(
contentId='string',
knowledgeBaseId='string'
)
[REQUIRED]
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
dict
Response Syntax
{}
Response Structure
Exceptions
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptiondelete_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'
)
[REQUIRED]
The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
{}
Response Structure
Exceptions
ConnectWisdomService.Client.exceptions.ConflictExceptionConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionget_assistant(**kwargs)¶Retrieves information about an assistant.
See also: AWS API Documentation
Request Syntax
response = client.get_assistant(
assistantId='string'
)
[REQUIRED]
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
{
'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
Information about the assistant.
The Amazon Resource Name (ARN) of the Wisdom assistant.
The identifier of the Wisdom assistant.
The description.
The name.
The KMS key used for encryption.
The KMS key. For information about valid ID values, see Key identifiers (KeyId).
The status of the assistant.
The tags used to organize, track, or control access for this resource.
The type of assistant.
Exceptions
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionget_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'
)
[REQUIRED]
The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
dict
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 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.
Exceptions
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionget_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'
)
[REQUIRED]
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
dict
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 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.
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.
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
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionget_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'
)
[REQUIRED]
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
dict
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 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.
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.
title (string) --
The title of the content.
Exceptions
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionget_knowledge_base(**kwargs)¶Retrieves information about the knowledge base.
See also: AWS API Documentation
Request Syntax
response = client.get_knowledge_base(
knowledgeBaseId='string'
)
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
{
'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
The knowledge base.
The description.
The Amazon Resource Name (ARN) of the knowledge base.
The identifier of the knowledge base.
The type of knowledge base.
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.
The name of the knowledge base.
Information about how to render the content.
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:
Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeletednumber , 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>
The KMS key used for encryption.
The KMS key. For information about valid ID values, see Key identifiers (KeyId).
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'}
Configuration information for Amazon AppIntegrations to automatically ingest content.
The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
The fields from the source that are made available to your agents in Wisdom.
Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .number , short_description , sys_mod_count , workflow_state , and active .Make sure to include additional fields. These fields are indexed and used to source recommendations.
The status of the knowledge base.
The tags used to organize, track, or control access for this resource.
Exceptions
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.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
)
[REQUIRED]
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
WaitTimeSeconds . If no messages are available and the wait time expires, the call returns successfully with an empty list.dict
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,
'type': 'KNOWLEDGE_CONTENT'
},
],
'triggers': [
{
'data': {
'query': {
'text': 'string'
}
},
'id': 'string',
'recommendationIds': [
'string',
],
'source': 'ISSUE_DETECTION'|'RULE_EVALUATION'|'OTHER',
'type': 'QUERY'
},
]
}
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 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.
type (string) --
The type of recommendation.
triggers (list) --
The triggers corresponding to recommendations.
(dict) --
A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.
data (dict) --
A union type containing information related to the trigger.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: query. 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'}
query (dict) --
Data associated with the QUERY RecommendationTriggerType.
text (string) --
The text associated with the recommendation trigger.
id (string) --
The identifier of the recommendation trigger.
recommendationIds (list) --
The identifiers of the recommendations.
source (string) --
The source of the recommendation trigger.
type (string) --
The type of recommendation trigger.
Exceptions
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionget_session(**kwargs)¶Retrieves information for a specified session.
See also: AWS API Documentation
Request Syntax
response = client.get_session(
assistantId='string',
sessionId='string'
)
[REQUIRED]
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
dict
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.
Exceptions
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
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'
)
[REQUIRED]
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
dict
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 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.
nextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionlist_assistants(**kwargs)¶Lists information about assistants.
See also: AWS API Documentation
Request Syntax
response = client.list_assistants(
maxResults=123,
nextToken='string'
)
dict
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).
status (string) --
The status of the assistant.
tags (dict) --
The tags used to organize, track, or control access for this resource.
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
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionlist_contents(**kwargs)¶Lists the content.
See also: AWS API Documentation
Request Syntax
response = client.list_contents(
knowledgeBaseId='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
dict
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 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.
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.
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
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionlist_knowledge_bases(**kwargs)¶Lists the knowledge bases.
See also: AWS API Documentation
Request Syntax
response = client.list_knowledge_bases(
maxResults=123,
nextToken='string'
)
dict
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 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:
Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeletednumber , 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).
sourceConfiguration (dict) --
Configuration information about the external data source.
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.
Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .number , short_description , sys_mod_count , workflow_state , and active .Make sure to include additional fields. These fields are indexed and used to source recommendations.
status (string) --
The status of the knowledge base summary.
tags (dict) --
The tags used to organize, track, or control access for this resource.
nextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionLists the tags for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
{
'tags': {
'string': 'string'
}
}
Response Structure
The tags used to organize, track, or control access for this resource.
Exceptions
ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionnotify_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'
)
[REQUIRED]
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The identifiers of the recommendations.
[REQUIRED]
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
dict
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.
Exceptions
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionquery_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'
)
[REQUIRED]
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The text to search for.
dict
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 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
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionremove_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'
)
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
{}
Response Structure
Exceptions
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionsearch_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'
},
]
}
)
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The search expression to filter results.
The search expression filters.
A search filter.
The field on which to filter.
The operator to use for comparing the field’s value with the provided value.
The desired field value on which to filter.
dict
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 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.
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.
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
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionsearch_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'
},
]
}
)
[REQUIRED]
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The search expression to filter results.
The search expression filters.
A search filter.
The field on which to filter.
The operator to use for comparing the field’s value with the provided value.
The desired field value on which to filter.
dict
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
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionstart_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'
)
[REQUIRED]
The type of content to upload.
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
dict
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.
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
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptiontag_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'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tags used to organize, track, or control access for this resource.
dict
Response Syntax
{}
Response Structure
Exceptions
ConnectWisdomService.Client.exceptions.TooManyTagsExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionuntag_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',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tag keys.
dict
Response Syntax
{}
Response Structure
Exceptions
ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionupdate_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'
)
[REQUIRED]
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN
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.
overrideLinkOurUri , exclude this argument and set removeOverrideLinkOutUri to true.overrideLinkOutUri if it exists.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 .dict
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 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.
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.
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
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.PreconditionFailedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionupdate_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'
)
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The template URI to update.
dict
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 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:
Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeletednumber , 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).
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.
Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .number , short_description , sys_mod_count , workflow_state , and active .Make sure to include additional fields. These fields are indexed and used to source recommendations.
status (string) --
The status of the knowledge base.
tags (dict) --
The tags used to organize, track, or control access for this resource.
Exceptions
ConnectWisdomService.Client.exceptions.ValidationExceptionConnectWisdomService.Client.exceptions.AccessDeniedExceptionConnectWisdomService.Client.exceptions.ResourceNotFoundExceptionThe available paginators are:
ConnectWisdomService.Paginator.ListAssistantAssociationsConnectWisdomService.Paginator.ListAssistantsConnectWisdomService.Paginator.ListContentsConnectWisdomService.Paginator.ListKnowledgeBasesConnectWisdomService.Paginator.QueryAssistantConnectWisdomService.Paginator.SearchContentConnectWisdomService.Paginator.SearchSessionsConnectWisdomService.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'
}
)
[REQUIRED]
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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 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.
NextToken (string) --
A token to resume pagination.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'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
Information about the assistants.
Summary information about the assistant.
The Amazon Resource Name (ARN) of the Wisdom assistant.
The identifier of the Wisdom assistant.
The description of the assistant.
The name of the assistant.
The KMS key used for encryption.
The KMS key. For information about valid ID values, see Key identifiers (KeyId).
The status of the assistant.
The tags used to organize, track, or control access for this resource.
The type of the assistant.
A token to resume pagination.
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'
}
)
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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 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.
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.
title (string) --
The title of the content.
NextToken (string) --
A token to resume pagination.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'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
Information about the knowledge bases.
Summary information about the knowledge base.
The description of the knowledge base.
The Amazon Resource Name (ARN) of the knowledge base.
The identifier of the knowledge base.
The type of knowledge base.
The name of the knowledge base.
Information about how to render the content.
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:
Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeletednumber , 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>
The KMS key used for encryption.
The KMS key. For information about valid ID values, see Key identifiers (KeyId).
Configuration information about the external data source.
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'}
Configuration information for Amazon AppIntegrations to automatically ingest content.
The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
The fields from the source that are made available to your agents in Wisdom.
Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .number , short_description , sys_mod_count , workflow_state , and active .Make sure to include additional fields. These fields are indexed and used to source recommendations.
The status of the knowledge base summary.
The tags used to organize, track, or control access for this resource.
A token to resume pagination.
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'
}
)
[REQUIRED]
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The text to search for.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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 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.
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'
}
)
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The search expression to filter results.
The search expression filters.
A search filter.
The field on which to filter.
The operator to use for comparing the field’s value with the provided value.
The desired field value on which to filter.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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 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.
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.
title (string) --
The title of the content.
NextToken (string) --
A token to resume pagination.
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'
}
)
[REQUIRED]
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
[REQUIRED]
The search expression to filter results.
The search expression filters.
A search filter.
The field on which to filter.
The operator to use for comparing the field’s value with the provided value.
The desired field value on which to filter.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.