View Source AWS.Wisdom (aws-elixir 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.

Link to this section Summary

Functions

create_assistant(client, input, options \\ [])

Creates an Amazon Connect Wisdom assistant.

create_assistant_association(client, assistant_id, input, options \\ [])

Creates an association between an Amazon Connect Wisdom assistant and another resource.

create_content(client, knowledge_base_id, input, options \\ [])

Creates Wisdom content.

create_knowledge_base(client, input, options \\ [])

Creates a knowledge base.

create_quick_response(client, knowledge_base_id, input, options \\ [])

Creates a Wisdom quick response.

create_session(client, assistant_id, input, options \\ [])

Creates a session.

delete_assistant(client, assistant_id, input, options \\ [])

Deletes an assistant.

delete_assistant_association(client, assistant_association_id, assistant_id, input, options \\ [])

Deletes an assistant association.

delete_content(client, content_id, knowledge_base_id, input, options \\ [])

Deletes the content.

delete_import_job(client, import_job_id, knowledge_base_id, input, options \\ [])

Deletes the quick response import job.

delete_knowledge_base(client, knowledge_base_id, input, options \\ [])

Deletes the knowledge base.

delete_quick_response(client, knowledge_base_id, quick_response_id, input, options \\ [])

Deletes a quick response.

get_assistant(client, assistant_id, options \\ [])

Retrieves information about an assistant.

get_assistant_association(client, assistant_association_id, assistant_id, options \\ [])

Retrieves information about an assistant association.

get_content(client, content_id, knowledge_base_id, options \\ [])

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

get_content_summary(client, content_id, knowledge_base_id, options \\ [])

Retrieves summary information about the content.

get_import_job(client, import_job_id, knowledge_base_id, options \\ [])

Retrieves the started import job.

get_knowledge_base(client, knowledge_base_id, options \\ [])

Retrieves information about the knowledge base.

get_quick_response(client, knowledge_base_id, quick_response_id, options \\ [])

Retrieves the quick response.

get_recommendations(client, assistant_id, session_id, max_results \\ nil, wait_time_seconds \\ nil, options \\ [])

Retrieves recommendations for the specified session.

get_session(client, assistant_id, session_id, options \\ [])

Retrieves information for a specified session.

list_assistant_associations(client, assistant_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists information about assistant associations.

list_assistants(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists information about assistants.

list_contents(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the content.

list_import_jobs(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists information about import jobs.

list_knowledge_bases(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the knowledge bases.

list_quick_responses(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists information about quick response.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags for the specified resource.

metadata()

notify_recommendations_received(client, assistant_id, session_id, input, options \\ [])

Removes the specified recommendations from the specified assistant's queue of newly available recommendations.

query_assistant(client, assistant_id, input, options \\ [])

Performs a manual search against the specified assistant.

remove_knowledge_base_template_uri(client, knowledge_base_id, input, options \\ [])

Removes a URI template from a knowledge base.

search_content(client, knowledge_base_id, input, options \\ [])

Searches for content in a specified knowledge base.

search_quick_responses(client, knowledge_base_id, input, options \\ [])

Searches existing Wisdom quick responses in a Wisdom knowledge base.

search_sessions(client, assistant_id, input, options \\ [])

Searches for sessions.

start_content_upload(client, knowledge_base_id, input, options \\ [])

Get a URL to upload content to a knowledge base.

start_import_job(client, knowledge_base_id, input, options \\ [])

Start an asynchronous job to import Wisdom resources from an uploaded source file.

tag_resource(client, resource_arn, input, options \\ [])

Adds the specified tags to the specified resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes the specified tags from the specified resource.

update_content(client, content_id, knowledge_base_id, input, options \\ [])

Updates information about the content.

update_knowledge_base_template_uri(client, knowledge_base_id, input, options \\ [])

Updates the template URI of a knowledge base.

update_quick_response(client, knowledge_base_id, quick_response_id, input, options \\ [])

Updates an existing Wisdom quick response.

Link to this section Functions

create_assistant(client, input, options \\ [])

Creates an Amazon Connect Wisdom assistant.

create_assistant_association(client, assistant_id, input, options \\ [])

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_content(client, knowledge_base_id, input, options \\ [])

Creates Wisdom content.

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

create_knowledge_base(client, input, options \\ [])

Creates a knowledge base.

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

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.

Call DeleteDataIntegration.

Call CreateDataIntegration to recreate the DataIntegration or a create different one.

Call CreateKnowledgeBase.

create_quick_response(client, knowledge_base_id, input, options \\ [])

Creates a Wisdom quick response.

create_session(client, assistant_id, input, options \\ [])

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(client, assistant_id, input, options \\ [])

Deletes an assistant.

delete_assistant_association(client, assistant_association_id, assistant_id, input, options \\ [])

Deletes an assistant association.

delete_content(client, content_id, knowledge_base_id, input, options \\ [])

Deletes the content.

delete_import_job(client, import_job_id, knowledge_base_id, input, options \\ [])

Deletes the quick response import job.

delete_knowledge_base(client, knowledge_base_id, input, options \\ [])

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

delete_quick_response(client, knowledge_base_id, quick_response_id, input, options \\ [])

Deletes a quick response.

get_assistant(client, assistant_id, options \\ [])

Retrieves information about an assistant.

get_assistant_association(client, assistant_association_id, assistant_id, options \\ [])

Retrieves information about an assistant association.

get_content(client, content_id, knowledge_base_id, options \\ [])

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

get_content_summary(client, content_id, knowledge_base_id, options \\ [])

Retrieves summary information about the content.

get_import_job(client, import_job_id, knowledge_base_id, options \\ [])

Retrieves the started import job.

get_knowledge_base(client, knowledge_base_id, options \\ [])

Retrieves information about the knowledge base.

get_quick_response(client, knowledge_base_id, quick_response_id, options \\ [])

Retrieves the quick response.

get_recommendations(client, assistant_id, session_id, max_results \\ nil, wait_time_seconds \\ nil, options \\ [])

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.

get_session(client, assistant_id, session_id, options \\ [])

Retrieves information for a specified session.

list_assistant_associations(client, assistant_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists information about assistant associations.

list_assistants(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists information about assistants.

list_contents(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the content.

list_import_jobs(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists information about import jobs.

list_knowledge_bases(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the knowledge bases.

list_quick_responses(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists information about quick response.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags for the specified resource.

metadata()

notify_recommendations_received(client, assistant_id, session_id, input, options \\ [])

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.

query_assistant(client, assistant_id, input, options \\ [])

Performs a manual search against the specified assistant.

To retrieve recommendations for an assistant, use GetRecommendations.

remove_knowledge_base_template_uri(client, knowledge_base_id, input, options \\ [])

Removes a URI template from a knowledge base.

search_content(client, knowledge_base_id, input, options \\ [])

Searches for content in a specified knowledge base.

Can be used to get a specific content resource by its name.

search_quick_responses(client, knowledge_base_id, input, options \\ [])

Searches existing Wisdom quick responses in a Wisdom knowledge base.

search_sessions(client, assistant_id, input, options \\ [])

Searches for sessions.

start_content_upload(client, knowledge_base_id, input, options \\ [])

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.

start_import_job(client, knowledge_base_id, input, options \\ [])

Start an asynchronous job to import Wisdom resources from an uploaded source file.

Before calling this API, use StartContentUpload 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.

tag_resource(client, resource_arn, input, options \\ [])

Adds the specified tags to the specified resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes the specified tags from the specified resource.

update_content(client, content_id, knowledge_base_id, input, options \\ [])

Updates information about the content.

update_knowledge_base_template_uri(client, knowledge_base_id, input, options \\ [])

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.

update_quick_response(client, knowledge_base_id, quick_response_id, input, options \\ [])

Updates an existing Wisdom quick response.

Settings View Source AWS.Wisdom (aws-elixir v1.0.4)

Link to this section Summary

Functions

Link to this section Functions

create_assistant(client, input, options \\ [])

create_assistant_association(client, assistant_id, input, options \\ [])

create_content(client, knowledge_base_id, input, options \\ [])

create_knowledge_base(client, input, options \\ [])

create_quick_response(client, knowledge_base_id, input, options \\ [])

create_session(client, assistant_id, input, options \\ [])

delete_assistant(client, assistant_id, input, options \\ [])

delete_assistant_association(client, assistant_association_id, assistant_id, input, options \\ [])

delete_content(client, content_id, knowledge_base_id, input, options \\ [])

delete_import_job(client, import_job_id, knowledge_base_id, input, options \\ [])

delete_knowledge_base(client, knowledge_base_id, input, options \\ [])

delete_quick_response(client, knowledge_base_id, quick_response_id, input, options \\ [])

get_assistant(client, assistant_id, options \\ [])

get_assistant_association(client, assistant_association_id, assistant_id, options \\ [])

get_content(client, content_id, knowledge_base_id, options \\ [])

get_content_summary(client, content_id, knowledge_base_id, options \\ [])

get_import_job(client, import_job_id, knowledge_base_id, options \\ [])

get_knowledge_base(client, knowledge_base_id, options \\ [])

get_quick_response(client, knowledge_base_id, quick_response_id, options \\ [])

get_recommendations(client, assistant_id, session_id, max_results \\ nil, wait_time_seconds \\ nil, options \\ [])

get_session(client, assistant_id, session_id, options \\ [])

list_assistant_associations(client, assistant_id, max_results \\ nil, next_token \\ nil, options \\ [])

list_assistants(client, max_results \\ nil, next_token \\ nil, options \\ [])

list_contents(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

list_import_jobs(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

list_knowledge_bases(client, max_results \\ nil, next_token \\ nil, options \\ [])

list_quick_responses(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

list_tags_for_resource(client, resource_arn, options \\ [])

metadata()

notify_recommendations_received(client, assistant_id, session_id, input, options \\ [])

query_assistant(client, assistant_id, input, options \\ [])

remove_knowledge_base_template_uri(client, knowledge_base_id, input, options \\ [])

search_content(client, knowledge_base_id, input, options \\ [])

search_quick_responses(client, knowledge_base_id, input, options \\ [])

search_sessions(client, assistant_id, input, options \\ [])

start_content_upload(client, knowledge_base_id, input, options \\ [])

start_import_job(client, knowledge_base_id, input, options \\ [])

tag_resource(client, resource_arn, input, options \\ [])

untag_resource(client, resource_arn, input, options \\ [])

update_content(client, content_id, knowledge_base_id, input, options \\ [])

update_knowledge_base_template_uri(client, knowledge_base_id, input, options \\ [])

update_quick_response(client, knowledge_base_id, quick_response_id, input, options \\ [])

View Source AWS.Wisdom (aws-elixir v1.0.4)