Edit on GitHub

Wisdom

This page documents function available when using the Wisdom module, created with @service Wisdom.

Index

Documentation

Main.Wisdom.create_assistant — Method
create_assistant(name, type)
create_assistant(name, type, params::Dict{String,<:Any})

Creates an Amazon Connect Wisdom assistant.

Arguments

  • name: The name of the assistant.
  • type: The type of assistant.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  • "description": The description of the assistant.
  • "serverSideEncryptionConfiguration": The KMS key used for encryption.
  • "tags": The tags used to organize, track, or control access for this resource.
source
Main.Wisdom.create_assistant_association — Method
create_assistant_association(assistant_id, association, association_type)
create_assistant_association(assistant_id, association, association_type, params::Dict{String,<:Any})

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.

Arguments

  • assistant_id: The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • association: The identifier of the associated resource.
  • association_type: The type of association.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  • "tags": The tags used to organize, track, or control access for this resource.
source
Main.Wisdom.create_content — Method
create_content(knowledge_base_id, name, upload_id)
create_content(knowledge_base_id, name, upload_id, params::Dict{String,<:Any})

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

Arguments

  • knowledge_base_id: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • name: 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.
  • upload_id: A pointer to the uploaded asset. This value is returned by StartContentUpload.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  • "metadata": A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
  • "overrideLinkOutUri": The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.
  • "tags": The tags used to organize, track, or control access for this resource.
  • "title": The title of the content. If not set, the title is equal to the name.
source
Main.Wisdom.create_knowledge_base — Method
create_knowledge_base(knowledge_base_type, name)
create_knowledge_base(knowledge_base_type, name, params::Dict{String,<:Any})

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. &lt;p&gt;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:&lt;/p&gt; &lt;ol&gt; &lt;li&gt; &lt;p&gt;Call &lt;a href=&quot;https://docs.aws.amazon.com/wisdom/latest/APIReference/APIDeleteKnowledgeBase.ht ml&quot;&gt;DeleteKnowledgeBase&lt;/a&gt;.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;Call &lt;a href=&quot;https://docs.aws.amazon.com/appintegrations/latest/APIReference/APIDeleteDataInt egration.html&quot;&gt;DeleteDataIntegration&lt;/a&gt;.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;Call &lt;a href=&quot;https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataInt egration.html&quot;&gt;CreateDataIntegration&lt;/a&gt; to recreate the DataIntegration or a create different one.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;Call CreateKnowledgeBase.&lt;/p&gt; &lt;/li&gt; &lt;/ol&gt; &lt;/note&gt;

Arguments

  • knowledge_base_type: 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.
  • name: The name of the knowledge base.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  • "description": The description.
  • "renderingConfiguration": Information about how to render the content.
  • "serverSideEncryptionConfiguration": The KMS key used for encryption.
  • "sourceConfiguration": The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.
  • "tags": The tags used to organize, track, or control access for this resource.
source
Main.Wisdom.create_session — Method
create_session(assistant_id, name)
create_session(assistant_id, name, params::Dict{String,<:Any})

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.

Arguments

  • assistant_id: The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • name: The name of the session.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  • "description": The description.
  • "tags": The tags used to organize, track, or control access for this resource.
source
Main.Wisdom.delete_assistant — Method
delete_assistant(assistant_id)
delete_assistant(assistant_id, params::Dict{String,<:Any})

Deletes an assistant.

Arguments

  • assistant_id: The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
source
Main.Wisdom.delete_assistant_association — Method
delete_assistant_association(assistant_association_id, assistant_id)
delete_assistant_association(assistant_association_id, assistant_id, params::Dict{String,<:Any})

Deletes an assistant association.

Arguments

  • assistant_association_id: The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • assistant_id: The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
source
Main.Wisdom.delete_content — Method
delete_content(content_id, knowledge_base_id)
delete_content(content_id, knowledge_base_id, params::Dict{String,<:Any})

Deletes the content.

Arguments

  • content_id: The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • knowledge_base_id: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
source
Main.Wisdom.delete_knowledge_base — Method
delete_knowledge_base(knowledge_base_id)
delete_knowledge_base(knowledge_base_id, params::Dict{String,<:Any})

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.

Arguments

  • knowledge_base_id: The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
source
Main.Wisdom.get_assistant — Method
get_assistant(assistant_id)
get_assistant(assistant_id, params::Dict{String,<:Any})

Retrieves information about an assistant.

Arguments

  • assistant_id: The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
source
Main.Wisdom.get_assistant_association — Method
get_assistant_association(assistant_association_id, assistant_id)
get_assistant_association(assistant_association_id, assistant_id, params::Dict{String,<:Any})

Retrieves information about an assistant association.

Arguments

  • assistant_association_id: The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • assistant_id: The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
source
Main.Wisdom.get_content — Method
get_content(content_id, knowledge_base_id)
get_content(content_id, knowledge_base_id, params::Dict{String,<:Any})

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

Arguments

  • content_id: The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • knowledge_base_id: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
source
Main.Wisdom.get_content_summary — Method
get_content_summary(content_id, knowledge_base_id)
get_content_summary(content_id, knowledge_base_id, params::Dict{String,<:Any})

Retrieves summary information about the content.

Arguments

  • content_id: The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • knowledge_base_id: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
source
Main.Wisdom.get_knowledge_base — Method
get_knowledge_base(knowledge_base_id)
get_knowledge_base(knowledge_base_id, params::Dict{String,<:Any})

Retrieves information about the knowledge base.

Arguments

  • knowledge_base_id: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
source
Main.Wisdom.get_recommendations — Method
get_recommendations(assistant_id, session_id)
get_recommendations(assistant_id, session_id, params::Dict{String,<:Any})

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.

Arguments

  • assistant_id: The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • session_id: The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "waitTimeSeconds": The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.
source
Main.Wisdom.get_session — Method
get_session(assistant_id, session_id)
get_session(assistant_id, session_id, params::Dict{String,<:Any})

Retrieves information for a specified session.

Arguments

  • assistant_id: The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • session_id: The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
source
Main.Wisdom.list_assistant_associations — Method
list_assistant_associations(assistant_id)
list_assistant_associations(assistant_id, params::Dict{String,<:Any})

Lists information about assistant associations.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
source
Main.Wisdom.list_assistants — Method
list_assistants()
list_assistants(params::Dict{String,<:Any})

Lists information about assistants.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
source
Main.Wisdom.list_contents — Method
list_contents(knowledge_base_id)
list_contents(knowledge_base_id, params::Dict{String,<:Any})

Lists the content.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
source
Main.Wisdom.list_knowledge_bases — Method
list_knowledge_bases()
list_knowledge_bases(params::Dict{String,<:Any})

Lists the knowledge bases.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
source
Main.Wisdom.list_tags_for_resource — Method
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists the tags for the specified resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource.
source
Main.Wisdom.notify_recommendations_received — Method
notify_recommendations_received(assistant_id, recommendation_ids, session_id)
notify_recommendations_received(assistant_id, recommendation_ids, session_id, params::Dict{String,<:Any})

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.

Arguments

  • assistant_id: The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • recommendation_ids: The identifiers of the recommendations.
  • session_id: The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
source
Main.Wisdom.put_feedback — Method
put_feedback(assistant_id, feedback, target_id, target_type)
put_feedback(assistant_id, feedback, target_id, target_type, params::Dict{String,<:Any})

Submits feedback to Wisdom. The feedback is used to improve future recommendations from GetRecommendations or results from QueryAssistant. Feedback can be resubmitted up to 6 hours after submission.

Arguments

  • assistant_id: The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • feedback: The feedback.
  • target_id: The identifier of a recommendation. or The identifier of the result data.
  • target_type: The type of the targetId for which The feedback. is targeted.
source
Main.Wisdom.query_assistant — Method
query_assistant(assistant_id, query_text)
query_assistant(assistant_id, query_text, params::Dict{String,<:Any})

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

Arguments

  • assistant_id: The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • query_text: The text to search for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
source
Main.Wisdom.remove_knowledge_base_template_uri — Method
remove_knowledge_base_template_uri(knowledge_base_id)
remove_knowledge_base_template_uri(knowledge_base_id, params::Dict{String,<:Any})

Removes a URI template from a knowledge base.

Arguments

  • knowledge_base_id: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
source
Main.Wisdom.search_content — Method
search_content(knowledge_base_id, search_expression)
search_content(knowledge_base_id, search_expression, params::Dict{String,<:Any})

Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.

Arguments

  • knowledge_base_id: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • search_expression: The search expression to filter results.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
source
Main.Wisdom.search_sessions — Method
search_sessions(assistant_id, search_expression)
search_sessions(assistant_id, search_expression, params::Dict{String,<:Any})

Searches for sessions.

Arguments

  • assistant_id: The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • search_expression: The search expression to filter results.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
source
Main.Wisdom.start_content_upload — Method
start_content_upload(content_type, knowledge_base_id)
start_content_upload(content_type, knowledge_base_id, params::Dict{String,<:Any})

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.

Arguments

  • content_type: The type of content to upload.
  • knowledge_base_id: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
source
Main.Wisdom.tag_resource — Method
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds the specified tags to the specified resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource.
  • tags: The tags used to organize, track, or control access for this resource.
source
Main.Wisdom.untag_resource — Method
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes the specified tags from the specified resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource.
  • tag_keys: The tag keys.
source
Main.Wisdom.update_content — Method
update_content(content_id, knowledge_base_id)
update_content(content_id, knowledge_base_id, params::Dict{String,<:Any})

Updates information about the content.

Arguments

  • content_id: The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • knowledge_base_id: The identifier of the knowledge base. Can be either the ID or the ARN

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "metadata": A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
  • "overrideLinkOutUri": The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to true.
  • "removeOverrideLinkOutUri": Unset the existing overrideLinkOutUri if it exists.
  • "revisionId": The revisionId of the content resource to update, taken from an earlier call to GetContent, GetContentSummary, SearchContent, or ListContents. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a PreconditionFailedException.
  • "title": The title of the content.
  • "uploadId": A pointer to the uploaded asset. This value is returned by StartContentUpload.
source
Main.Wisdom.update_knowledge_base_template_uri — Method
update_knowledge_base_template_uri(knowledge_base_id, template_uri)
update_knowledge_base_template_uri(knowledge_base_id, template_uri, params::Dict{String,<:Any})

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.

Arguments

  • knowledge_base_id: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
  • template_uri: The template URI to update.
source