View Source aws_wisdom (aws v1.0.4)
Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers.
Agents can search across connected repositories from within their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a knowledge base, for example, or manage content by uploading custom files.Summary
Functions
Creates an association between an Amazon Connect Wisdom assistant and another resource.
Creates Wisdom content.
Creates a knowledge base.
Creates a session.
Deletes the knowledge base.
Retrieves recommendations for the specified session.
Removes the specified recommendations from the specified assistant's queue of newly available recommendations.
Performs a manual search against the specified assistant.
Searches for content in a specified knowledge base.
Get a URL to upload content to a knowledge base.
Start an asynchronous job to import Wisdom resources from an uploaded source file.
Updates the template URI of a knowledge base.
Functions
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.create_assistant_association(Client, AssistantId, Input0, Options0)
View SourceCreates Wisdom content.
Before to calling this API, use StartContentUpload: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html to upload an asset.Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations: https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException
error.
For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
Call DeleteKnowledgeBase: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_DeleteKnowledgeBase.html.
Call DeleteDataIntegration: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html.
Call CreateDataIntegration: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html to recreate the DataIntegration or a create different one.
Call CreateKnowledgeBase.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.delete_assistant_association(Client, AssistantAssociationId, AssistantId, Input)
View Sourcedelete_assistant_association(Client, AssistantAssociationId, AssistantId, Input0, Options0)
View Sourcedelete_content(Client, ContentId, KnowledgeBaseId, Input0, Options0)
View Sourcedelete_import_job(Client, ImportJobId, KnowledgeBaseId, Input0, Options0)
View SourceDeletes the knowledge base.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations: https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html 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: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html and CreateDataIntegration: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html in the Amazon AppIntegrations API Reference.delete_quick_response(Client, KnowledgeBaseId, QuickResponseId, Input)
View Sourcedelete_quick_response(Client, KnowledgeBaseId, QuickResponseId, Input0, Options0)
View Sourceget_assistant(Client, AssistantId, QueryMap, HeadersMap, Options0)
View Sourceget_assistant_association(Client, AssistantAssociationId, AssistantId)
View Sourceget_assistant_association(Client, AssistantAssociationId, AssistantId, QueryMap, HeadersMap)
View Sourceget_assistant_association(Client, AssistantAssociationId, AssistantId, QueryMap, HeadersMap, Options0)
View Sourceget_content(Client, ContentId, KnowledgeBaseId, QueryMap, HeadersMap)
View Sourceget_content(Client, ContentId, KnowledgeBaseId, QueryMap, HeadersMap, Options0)
View Sourceget_content_summary(Client, ContentId, KnowledgeBaseId, QueryMap, HeadersMap)
View Sourceget_content_summary(Client, ContentId, KnowledgeBaseId, QueryMap, HeadersMap, Options0)
View Sourceget_import_job(Client, ImportJobId, KnowledgeBaseId, QueryMap, HeadersMap)
View Sourceget_import_job(Client, ImportJobId, KnowledgeBaseId, QueryMap, HeadersMap, Options0)
View Sourceget_knowledge_base(Client, KnowledgeBaseId, QueryMap, HeadersMap, Options0)
View Sourceget_quick_response(Client, KnowledgeBaseId, QuickResponseId, QueryMap, HeadersMap)
View Sourceget_quick_response(Client, KnowledgeBaseId, QuickResponseId, QueryMap, HeadersMap, Options0)
View SourceRetrieves recommendations for the specified session.
To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_NotifyRecommendationsReceived.html. This API supports long-polling behavior with thewaitTimeSeconds
parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_QueryAssistant.html.
get_recommendations(Client, AssistantId, SessionId, QueryMap, HeadersMap)
View Sourceget_recommendations(Client, AssistantId, SessionId, QueryMap, HeadersMap, Options0)
View Sourceget_session(Client, AssistantId, SessionId, QueryMap, HeadersMap, Options0)
View Sourcelist_assistant_associations(Client, AssistantId, QueryMap, HeadersMap)
View Sourcelist_assistant_associations(Client, AssistantId, QueryMap, HeadersMap, Options0)
View Sourcelist_contents(Client, KnowledgeBaseId, QueryMap, HeadersMap, Options0)
View Sourcelist_import_jobs(Client, KnowledgeBaseId, QueryMap, HeadersMap, Options0)
View Sourcelist_quick_responses(Client, KnowledgeBaseId, QueryMap, HeadersMap)
View Sourcelist_quick_responses(Client, KnowledgeBaseId, QueryMap, HeadersMap, Options0)
View Sourcelist_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View Sourcenotify_recommendations_received(Client, AssistantId, SessionId, Input)
View SourceRemoves the specified recommendations from the specified assistant's queue of newly available recommendations.
You can use this API in conjunction with GetRecommendations: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html and awaitTimeSeconds
input for long-polling behavior and avoiding duplicate recommendations.
notify_recommendations_received(Client, AssistantId, SessionId, Input0, Options0)
View SourcePerforms a manual search against the specified assistant.
To retrieve recommendations for an assistant, use GetRecommendations: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html.remove_knowledge_base_template_uri(Client, KnowledgeBaseId, Input)
View Sourceremove_knowledge_base_template_uri(Client, KnowledgeBaseId, Input0, Options0)
View SourceSearches for content in a specified knowledge base.
Can be used to get a specific content resource by its name.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: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_CreateContent.html to finalize the content creation process or UpdateContent: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_UpdateContent.html to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.Start an asynchronous job to import Wisdom resources from an uploaded source file.
Before calling this API, use StartContentUpload: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html to upload an asset that contains the resource data.
For importing Wisdom quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses: https://docs.aws.amazon.com/console/connect/quick-responses/add-data.
update_content(Client, ContentId, KnowledgeBaseId, Input0, Options0)
View Sourceupdate_knowledge_base_template_uri(Client, KnowledgeBaseId, Input)
View SourceUpdates 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
.