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

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 Amazon Connect Wisdom assistant.

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

Retrieves information about an assistant.

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

Retrieves summary information about the content.

Retrieves information about the knowledge base.

Retrieves information for a specified session.

Lists the tags for the specified resource.

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.

Searches existing Wisdom quick responses in a Wisdom 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.

Adds the specified tags to the specified resource.

Removes the specified tags from the specified resource.

Functions

Link to this function

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

View Source

Creates an Amazon Connect Wisdom assistant.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Creates Wisdom content.

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

Link to this function

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

View Source

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.

Link to this function

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

View Source

Creates a Wisdom quick response.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Deletes an assistant.

Link to this function

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

View Source

Deletes an assistant association.

Link to this function

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

View Source

Deletes the content.

Link to this function

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

View Source

Deletes the quick response import job.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Deletes a quick response.

Link to this function

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

View Source

Retrieves information about an assistant.

Link to this function

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

View Source

Retrieves information about an assistant association.

Link to this function

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

View Source

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

Link to this function

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

View Source

Retrieves summary information about the content.

Link to this function

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

View Source

Retrieves the started import job.

Link to this function

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

View Source

Retrieves information about the knowledge base.

Link to this function

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

View Source

Retrieves the quick response.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Retrieves information for a specified session.

Link to this function

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

View Source

Lists information about assistant associations.

Link to this function

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

View Source

Lists information about assistants.

Link to this function

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

View Source

Lists the content.

Link to this function

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

View Source

Lists information about import jobs.

Link to this function

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

View Source

Lists the knowledge bases.

Link to this function

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

View Source

Lists information about quick response.

Link to this function

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

View Source

Lists the tags for the specified resource.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Performs a manual search against the specified assistant.

To retrieve recommendations for an assistant, use GetRecommendations.

Link to this function

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

View Source

Removes a URI template from a knowledge base.

Link to this function

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

View Source

Searches for content in a specified knowledge base.

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

Link to this function

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

View Source

Searches existing Wisdom quick responses in a Wisdom knowledge base.

Link to this function

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

View Source

Searches for sessions.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Adds the specified tags to the specified resource.

Link to this function

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

View Source

Removes the specified tags from the specified resource.

Link to this function

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

View Source

Updates information about the content.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Updates an existing Wisdom quick response.