# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.Wisdom do
@moduledoc """
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.
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
start_content_upload_response() :: %{
required("headersToInclude") => map(),
required("uploadId") => String.t() | atom(),
required("url") => String.t() | atom(),
required("urlExpiry") => [non_neg_integer()]
}
"""
@type start_content_upload_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_knowledge_base_template_uri_request() :: %{
required("templateUri") => String.t() | atom()
}
"""
@type update_knowledge_base_template_uri_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
query_assistant_response() :: %{
optional("nextToken") => String.t() | atom(),
required("results") => list(result_data())
}
"""
@type query_assistant_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
required("tags") => map()
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
session_summary() :: %{
"assistantArn" => String.t() | atom(),
"assistantId" => String.t() | atom(),
"sessionArn" => String.t() | atom(),
"sessionId" => String.t() | atom()
}
"""
@type session_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_quick_response_response() :: %{
"quickResponse" => quick_response_data()
}
"""
@type create_quick_response_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_session_response() :: %{
optional("session") => session_data()
}
"""
@type get_session_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
search_quick_responses_request() :: %{
optional("attributes") => map(),
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
required("searchExpression") => quick_response_search_expression()
}
"""
@type search_quick_responses_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_response() :: %{}
"""
@type untag_resource_response() :: %{}
@typedoc """
## Example:
quick_response_search_expression() :: %{
"filters" => list(quick_response_filter_field()),
"orderOnField" => quick_response_order_field(),
"queries" => list(quick_response_query_field())
}
"""
@type quick_response_search_expression() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
highlight() :: %{
"beginOffsetInclusive" => integer(),
"endOffsetExclusive" => integer()
}
"""
@type highlight() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
app_integrations_configuration() :: %{
"appIntegrationArn" => String.t() | atom(),
"objectFields" => list(String.t() | atom())
}
"""
@type app_integrations_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_contents_response() :: %{
optional("nextToken") => String.t() | atom(),
required("contentSummaries") => list(content_summary())
}
"""
@type list_contents_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
quick_response_filter_field() :: %{
"includeNoExistence" => [boolean()],
"name" => String.t() | atom(),
"operator" => String.t() | atom(),
"values" => list(String.t() | atom())
}
"""
@type quick_response_filter_field() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
external_source_configuration() :: %{
"configuration" => list(),
"source" => String.t() | atom()
}
"""
@type external_source_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
recommendation_data() :: %{
"document" => document(),
"recommendationId" => [String.t() | atom()],
"relevanceLevel" => String.t() | atom(),
"relevanceScore" => float(),
"type" => String.t() | atom()
}
"""
@type recommendation_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_contents_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_contents_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
remove_knowledge_base_template_uri_response() :: %{}
"""
@type remove_knowledge_base_template_uri_response() :: %{}
@typedoc """
## Example:
delete_assistant_association_request() :: %{}
"""
@type delete_assistant_association_request() :: %{}
@typedoc """
## Example:
get_content_summary_response() :: %{
optional("contentSummary") => content_summary()
}
"""
@type get_content_summary_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
assistant_integration_configuration() :: %{
"topicIntegrationArn" => String.t() | atom()
}
"""
@type assistant_integration_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_knowledge_base_response() :: %{}
"""
@type delete_knowledge_base_response() :: %{}
@typedoc """
## Example:
create_content_response() :: %{
optional("content") => content_data()
}
"""
@type create_content_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_assistant_response() :: %{
optional("assistant") => assistant_data()
}
"""
@type get_assistant_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_recommendations_response() :: %{
optional("triggers") => list(recommendation_trigger()),
required("recommendations") => list(recommendation_data())
}
"""
@type get_recommendations_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
request_timeout_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type request_timeout_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_import_job_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("externalSourceConfiguration") => external_source_configuration(),
optional("metadata") => map(),
required("importJobType") => String.t() | atom(),
required("uploadId") => String.t() | atom()
}
"""
@type start_import_job_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_knowledge_base_response() :: %{
optional("knowledgeBase") => knowledge_base_data()
}
"""
@type create_knowledge_base_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("tagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_assistant_association_response() :: %{
optional("assistantAssociation") => assistant_association_data()
}
"""
@type get_assistant_association_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_quick_response_request() :: %{
optional("channels") => list(String.t() | atom()),
optional("clientToken") => String.t() | atom(),
optional("contentType") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("groupingConfiguration") => grouping_configuration(),
optional("isActive") => [boolean()],
optional("language") => String.t() | atom(),
optional("shortcutKey") => String.t() | atom(),
optional("tags") => map(),
required("content") => list(),
required("name") => String.t() | atom()
}
"""
@type create_quick_response_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
connect_configuration() :: %{
"instanceId" => String.t() | atom()
}
"""
@type connect_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
search_content_response() :: %{
optional("nextToken") => String.t() | atom(),
required("contentSummaries") => list(content_summary())
}
"""
@type search_content_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_session_request() :: %{}
"""
@type get_session_request() :: %{}
@typedoc """
## Example:
list_quick_responses_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_quick_responses_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_content_upload_request() :: %{
optional("presignedUrlTimeToLive") => integer(),
required("contentType") => String.t() | atom()
}
"""
@type start_content_upload_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_assistant_request() :: %{}
"""
@type delete_assistant_request() :: %{}
@typedoc """
## Example:
create_session_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("tags") => map(),
required("name") => String.t() | atom()
}
"""
@type create_session_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_knowledge_base_template_uri_response() :: %{
optional("knowledgeBase") => knowledge_base_data()
}
"""
@type update_knowledge_base_template_uri_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_knowledge_base_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("renderingConfiguration") => rendering_configuration(),
optional("serverSideEncryptionConfiguration") => server_side_encryption_configuration(),
optional("sourceConfiguration") => list(),
optional("tags") => map(),
required("knowledgeBaseType") => String.t() | atom(),
required("name") => String.t() | atom()
}
"""
@type create_knowledge_base_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_import_jobs_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_import_jobs_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
knowledge_base_summary() :: %{
"description" => String.t() | atom(),
"knowledgeBaseArn" => String.t() | atom(),
"knowledgeBaseId" => String.t() | atom(),
"knowledgeBaseType" => String.t() | atom(),
"name" => String.t() | atom(),
"renderingConfiguration" => rendering_configuration(),
"serverSideEncryptionConfiguration" => server_side_encryption_configuration(),
"sourceConfiguration" => list(),
"status" => String.t() | atom(),
"tags" => map()
}
"""
@type knowledge_base_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_quick_responses_response() :: %{
"nextToken" => String.t() | atom(),
"quickResponseSummaries" => list(quick_response_summary())
}
"""
@type list_quick_responses_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_knowledge_bases_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_knowledge_bases_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
conflict_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_not_found_exception() :: %{
"message" => [String.t() | atom()],
"resourceName" => [String.t() | atom()]
}
"""
@type resource_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
import_job_data() :: %{
"createdTime" => [non_neg_integer()],
"externalSourceConfiguration" => external_source_configuration(),
"failedRecordReport" => String.t() | atom(),
"importJobId" => String.t() | atom(),
"importJobType" => String.t() | atom(),
"knowledgeBaseArn" => String.t() | atom(),
"knowledgeBaseId" => String.t() | atom(),
"lastModifiedTime" => [non_neg_integer()],
"metadata" => map(),
"status" => String.t() | atom(),
"uploadId" => String.t() | atom(),
"url" => String.t() | atom(),
"urlExpiry" => [non_neg_integer()]
}
"""
@type import_job_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
knowledge_base_data() :: %{
"description" => String.t() | atom(),
"knowledgeBaseArn" => String.t() | atom(),
"knowledgeBaseId" => String.t() | atom(),
"knowledgeBaseType" => String.t() | atom(),
"lastContentModificationTime" => [non_neg_integer()],
"name" => String.t() | atom(),
"renderingConfiguration" => rendering_configuration(),
"serverSideEncryptionConfiguration" => server_side_encryption_configuration(),
"sourceConfiguration" => list(),
"status" => String.t() | atom(),
"tags" => map()
}
"""
@type knowledge_base_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
assistant_association_data() :: %{
"assistantArn" => String.t() | atom(),
"assistantAssociationArn" => String.t() | atom(),
"assistantAssociationId" => String.t() | atom(),
"assistantId" => String.t() | atom(),
"associationData" => list(),
"associationType" => String.t() | atom(),
"tags" => map()
}
"""
@type assistant_association_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
document_text() :: %{
"highlights" => list(highlight()),
"text" => String.t() | atom()
}
"""
@type document_text() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_assistant_request() :: %{}
"""
@type get_assistant_request() :: %{}
@typedoc """
## Example:
delete_assistant_response() :: %{}
"""
@type delete_assistant_response() :: %{}
@typedoc """
## Example:
quick_response_contents() :: %{
"markdown" => list(),
"plainText" => list()
}
"""
@type quick_response_contents() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_import_job_request() :: %{}
"""
@type delete_import_job_request() :: %{}
@typedoc """
## Example:
assistant_data() :: %{
"assistantArn" => String.t() | atom(),
"assistantId" => String.t() | atom(),
"description" => String.t() | atom(),
"integrationConfiguration" => assistant_integration_configuration(),
"name" => String.t() | atom(),
"serverSideEncryptionConfiguration" => server_side_encryption_configuration(),
"status" => String.t() | atom(),
"tags" => map(),
"type" => String.t() | atom()
}
"""
@type assistant_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_quota_exceeded_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type service_quota_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_assistant_response() :: %{
optional("assistant") => assistant_data()
}
"""
@type create_assistant_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
quick_response_summary() :: %{
"channels" => list(String.t() | atom()),
"contentType" => String.t() | atom(),
"createdTime" => [non_neg_integer()],
"description" => String.t() | atom(),
"isActive" => [boolean()],
"knowledgeBaseArn" => String.t() | atom(),
"knowledgeBaseId" => String.t() | atom(),
"lastModifiedBy" => String.t() | atom(),
"lastModifiedTime" => [non_neg_integer()],
"name" => String.t() | atom(),
"quickResponseArn" => String.t() | atom(),
"quickResponseId" => String.t() | atom(),
"status" => String.t() | atom(),
"tags" => map()
}
"""
@type quick_response_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_quick_response_response() :: %{
"quickResponse" => quick_response_data()
}
"""
@type get_quick_response_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_import_job_request() :: %{}
"""
@type get_import_job_request() :: %{}
@typedoc """
## Example:
create_assistant_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("serverSideEncryptionConfiguration") => server_side_encryption_configuration(),
optional("tags") => map(),
required("name") => String.t() | atom(),
required("type") => String.t() | atom()
}
"""
@type create_assistant_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_recommendations_request() :: %{
optional("maxResults") => integer(),
optional("waitTimeSeconds") => integer()
}
"""
@type get_recommendations_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
query_recommendation_trigger_data() :: %{
"text" => String.t() | atom()
}
"""
@type query_recommendation_trigger_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
search_sessions_response() :: %{
optional("nextToken") => String.t() | atom(),
required("sessionSummaries") => list(session_summary())
}
"""
@type search_sessions_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
notify_recommendations_received_response() :: %{
optional("errors") => list(notify_recommendations_received_error()),
optional("recommendationIds") => list([String.t() | atom()]())
}
"""
@type notify_recommendations_received_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_quick_response_request() :: %{
optional("channels") => list(String.t() | atom()),
optional("content") => list(),
optional("contentType") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("groupingConfiguration") => grouping_configuration(),
optional("isActive") => [boolean()],
optional("language") => String.t() | atom(),
optional("name") => String.t() | atom(),
optional("removeDescription") => [boolean()],
optional("removeGroupingConfiguration") => [boolean()],
optional("removeShortcutKey") => [boolean()],
optional("shortcutKey") => String.t() | atom()
}
"""
@type update_quick_response_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
quick_response_data() :: %{
"channels" => list(String.t() | atom()),
"contentType" => String.t() | atom(),
"contents" => quick_response_contents(),
"createdTime" => [non_neg_integer()],
"description" => String.t() | atom(),
"groupingConfiguration" => grouping_configuration(),
"isActive" => [boolean()],
"knowledgeBaseArn" => String.t() | atom(),
"knowledgeBaseId" => String.t() | atom(),
"language" => String.t() | atom(),
"lastModifiedBy" => String.t() | atom(),
"lastModifiedTime" => [non_neg_integer()],
"name" => String.t() | atom(),
"quickResponseArn" => String.t() | atom(),
"quickResponseId" => String.t() | atom(),
"shortcutKey" => String.t() | atom(),
"status" => String.t() | atom(),
"tags" => map()
}
"""
@type quick_response_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
knowledge_base_association_data() :: %{
"knowledgeBaseArn" => String.t() | atom(),
"knowledgeBaseId" => String.t() | atom()
}
"""
@type knowledge_base_association_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
optional("tags") => map()
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_assistant_associations_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_assistant_associations_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_knowledge_base_request() :: %{}
"""
@type delete_knowledge_base_request() :: %{}
@typedoc """
## Example:
update_quick_response_response() :: %{
"quickResponse" => quick_response_data()
}
"""
@type update_quick_response_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
assistant_summary() :: %{
"assistantArn" => String.t() | atom(),
"assistantId" => String.t() | atom(),
"description" => String.t() | atom(),
"integrationConfiguration" => assistant_integration_configuration(),
"name" => String.t() | atom(),
"serverSideEncryptionConfiguration" => server_side_encryption_configuration(),
"status" => String.t() | atom(),
"tags" => map(),
"type" => String.t() | atom()
}
"""
@type assistant_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
search_expression() :: %{
"filters" => list(filter())
}
"""
@type search_expression() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
filter() :: %{
"field" => String.t() | atom(),
"operator" => String.t() | atom(),
"value" => String.t() | atom()
}
"""
@type filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
server_side_encryption_configuration() :: %{
"kmsKeyId" => String.t() | atom()
}
"""
@type server_side_encryption_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
session_data() :: %{
"description" => String.t() | atom(),
"integrationConfiguration" => session_integration_configuration(),
"name" => String.t() | atom(),
"sessionArn" => String.t() | atom(),
"sessionId" => String.t() | atom(),
"tags" => map()
}
"""
@type session_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
search_sessions_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
required("searchExpression") => search_expression()
}
"""
@type search_sessions_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_import_jobs_response() :: %{
"importJobSummaries" => list(import_job_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_import_jobs_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
remove_knowledge_base_template_uri_request() :: %{}
"""
@type remove_knowledge_base_template_uri_request() :: %{}
@typedoc """
## Example:
search_quick_responses_response() :: %{
"nextToken" => String.t() | atom(),
"results" => list(quick_response_search_result_data())
}
"""
@type search_quick_responses_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
notify_recommendations_received_error() :: %{
"message" => String.t() | atom(),
"recommendationId" => [String.t() | atom()]
}
"""
@type notify_recommendations_received_error() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_import_job_response() :: %{
"importJob" => import_job_data()
}
"""
@type get_import_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_content_response() :: %{
optional("content") => content_data()
}
"""
@type update_content_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_quick_response_request() :: %{}
"""
@type get_quick_response_request() :: %{}
@typedoc """
## Example:
access_denied_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type access_denied_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_assistant_association_response() :: %{
optional("assistantAssociation") => assistant_association_data()
}
"""
@type create_assistant_association_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_content_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("metadata") => map(),
optional("overrideLinkOutUri") => String.t() | atom(),
optional("tags") => map(),
optional("title") => String.t() | atom(),
required("name") => String.t() | atom(),
required("uploadId") => String.t() | atom()
}
"""
@type create_content_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_response() :: %{}
"""
@type tag_resource_response() :: %{}
@typedoc """
## Example:
import_job_summary() :: %{
"createdTime" => [non_neg_integer()],
"externalSourceConfiguration" => external_source_configuration(),
"importJobId" => String.t() | atom(),
"importJobType" => String.t() | atom(),
"knowledgeBaseArn" => String.t() | atom(),
"knowledgeBaseId" => String.t() | atom(),
"lastModifiedTime" => [non_neg_integer()],
"metadata" => map(),
"status" => String.t() | atom(),
"uploadId" => String.t() | atom()
}
"""
@type import_job_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
query_assistant_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
required("queryText") => String.t() | atom()
}
"""
@type query_assistant_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
quick_response_search_result_data() :: %{
"attributesInterpolated" => list(String.t() | atom()),
"attributesNotInterpolated" => list(String.t() | atom()),
"channels" => list(String.t() | atom()),
"contentType" => String.t() | atom(),
"contents" => quick_response_contents(),
"createdTime" => [non_neg_integer()],
"description" => String.t() | atom(),
"groupingConfiguration" => grouping_configuration(),
"isActive" => [boolean()],
"knowledgeBaseArn" => String.t() | atom(),
"knowledgeBaseId" => String.t() | atom(),
"language" => String.t() | atom(),
"lastModifiedBy" => String.t() | atom(),
"lastModifiedTime" => [non_neg_integer()],
"name" => String.t() | atom(),
"quickResponseArn" => String.t() | atom(),
"quickResponseId" => String.t() | atom(),
"shortcutKey" => String.t() | atom(),
"status" => String.t() | atom(),
"tags" => map()
}
"""
@type quick_response_search_result_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rendering_configuration() :: %{
"templateUri" => String.t() | atom()
}
"""
@type rendering_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_content_request() :: %{}
"""
@type delete_content_request() :: %{}
@typedoc """
## Example:
get_content_request() :: %{}
"""
@type get_content_request() :: %{}
@typedoc """
## Example:
delete_quick_response_request() :: %{}
"""
@type delete_quick_response_request() :: %{}
@typedoc """
## Example:
validation_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type validation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{}
"""
@type list_tags_for_resource_request() :: %{}
@typedoc """
## Example:
content_reference() :: %{
"contentArn" => String.t() | atom(),
"contentId" => String.t() | atom(),
"knowledgeBaseArn" => String.t() | atom(),
"knowledgeBaseId" => String.t() | atom()
}
"""
@type content_reference() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
content_data() :: %{
"contentArn" => String.t() | atom(),
"contentId" => String.t() | atom(),
"contentType" => String.t() | atom(),
"knowledgeBaseArn" => String.t() | atom(),
"knowledgeBaseId" => String.t() | atom(),
"linkOutUri" => String.t() | atom(),
"metadata" => map(),
"name" => String.t() | atom(),
"revisionId" => String.t() | atom(),
"status" => String.t() | atom(),
"tags" => map(),
"title" => String.t() | atom(),
"url" => String.t() | atom(),
"urlExpiry" => [non_neg_integer()]
}
"""
@type content_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
content_summary() :: %{
"contentArn" => String.t() | atom(),
"contentId" => String.t() | atom(),
"contentType" => String.t() | atom(),
"knowledgeBaseArn" => String.t() | atom(),
"knowledgeBaseId" => String.t() | atom(),
"metadata" => map(),
"name" => String.t() | atom(),
"revisionId" => String.t() | atom(),
"status" => String.t() | atom(),
"tags" => map(),
"title" => String.t() | atom()
}
"""
@type content_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_content_response() :: %{
optional("content") => content_data()
}
"""
@type get_content_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
recommendation_trigger() :: %{
"data" => list(),
"id" => String.t() | atom(),
"recommendationIds" => list([String.t() | atom()]()),
"source" => String.t() | atom(),
"type" => String.t() | atom()
}
"""
@type recommendation_trigger() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
notify_recommendations_received_request() :: %{
required("recommendationIds") => list([String.t() | atom()]())
}
"""
@type notify_recommendations_received_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_knowledge_bases_response() :: %{
optional("nextToken") => String.t() | atom(),
required("knowledgeBaseSummaries") => list(knowledge_base_summary())
}
"""
@type list_knowledge_bases_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_knowledge_base_response() :: %{
optional("knowledgeBase") => knowledge_base_data()
}
"""
@type get_knowledge_base_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_assistant_associations_response() :: %{
optional("nextToken") => String.t() | atom(),
required("assistantAssociationSummaries") => list(assistant_association_summary())
}
"""
@type list_assistant_associations_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
result_data() :: %{
"document" => document(),
"relevanceScore" => float(),
"resultId" => String.t() | atom()
}
"""
@type result_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_import_job_response() :: %{
"importJob" => import_job_data()
}
"""
@type start_import_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_content_request() :: %{
optional("metadata") => map(),
optional("overrideLinkOutUri") => String.t() | atom(),
optional("removeOverrideLinkOutUri") => [boolean()],
optional("revisionId") => String.t() | atom(),
optional("title") => String.t() | atom(),
optional("uploadId") => String.t() | atom()
}
"""
@type update_content_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
assistant_association_summary() :: %{
"assistantArn" => String.t() | atom(),
"assistantAssociationArn" => String.t() | atom(),
"assistantAssociationId" => String.t() | atom(),
"assistantId" => String.t() | atom(),
"associationData" => list(),
"associationType" => String.t() | atom(),
"tags" => map()
}
"""
@type assistant_association_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_content_summary_request() :: %{}
"""
@type get_content_summary_request() :: %{}
@typedoc """
## Example:
quick_response_query_field() :: %{
"allowFuzziness" => [boolean()],
"name" => String.t() | atom(),
"operator" => String.t() | atom(),
"priority" => String.t() | atom(),
"values" => list(String.t() | atom())
}
"""
@type quick_response_query_field() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_assistant_association_request() :: %{}
"""
@type get_assistant_association_request() :: %{}
@typedoc """
## Example:
delete_content_response() :: %{}
"""
@type delete_content_response() :: %{}
@typedoc """
## Example:
get_knowledge_base_request() :: %{}
"""
@type get_knowledge_base_request() :: %{}
@typedoc """
## Example:
quick_response_order_field() :: %{
"name" => String.t() | atom(),
"order" => String.t() | atom()
}
"""
@type quick_response_order_field() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_assistants_response() :: %{
optional("nextToken") => String.t() | atom(),
required("assistantSummaries") => list(assistant_summary())
}
"""
@type list_assistants_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_quick_response_response() :: %{}
"""
@type delete_quick_response_response() :: %{}
@typedoc """
## Example:
search_content_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
required("searchExpression") => search_expression()
}
"""
@type search_content_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
grouping_configuration() :: %{
"criteria" => String.t() | atom(),
"values" => list(String.t() | atom())
}
"""
@type grouping_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_assistant_association_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("tags") => map(),
required("association") => list(),
required("associationType") => String.t() | atom()
}
"""
@type create_assistant_association_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_session_response() :: %{
optional("session") => session_data()
}
"""
@type create_session_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
precondition_failed_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type precondition_failed_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_assistant_association_response() :: %{}
"""
@type delete_assistant_association_response() :: %{}
@typedoc """
## Example:
document() :: %{
"contentReference" => content_reference(),
"excerpt" => document_text(),
"title" => document_text()
}
"""
@type document() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_assistants_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_assistants_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
session_integration_configuration() :: %{
"topicIntegrationArn" => String.t() | atom()
}
"""
@type session_integration_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_import_job_response() :: %{}
"""
@type delete_import_job_response() :: %{}
@typedoc """
## Example:
too_many_tags_exception() :: %{
"message" => [String.t() | atom()],
"resourceName" => [String.t() | atom()]
}
"""
@type too_many_tags_exception() :: %{(String.t() | atom()) => any()}
@type create_assistant_errors() ::
validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type create_assistant_association_errors() ::
validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_content_errors() ::
validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_knowledge_base_errors() ::
validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type create_quick_response_errors() ::
validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_session_errors() ::
validation_exception() | resource_not_found_exception() | conflict_exception()
@type delete_assistant_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type delete_assistant_association_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type delete_content_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type delete_import_job_errors() ::
validation_exception()
| access_denied_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_knowledge_base_errors() ::
validation_exception()
| access_denied_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_quick_response_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type get_assistant_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type get_assistant_association_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type get_content_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type get_content_summary_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type get_import_job_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type get_knowledge_base_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type get_quick_response_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type get_recommendations_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type get_session_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type list_assistant_associations_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type list_assistants_errors() :: validation_exception() | access_denied_exception()
@type list_contents_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type list_import_jobs_errors() :: validation_exception() | access_denied_exception()
@type list_knowledge_bases_errors() :: validation_exception() | access_denied_exception()
@type list_quick_responses_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type list_tags_for_resource_errors() :: resource_not_found_exception()
@type notify_recommendations_received_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type query_assistant_errors() ::
validation_exception()
| access_denied_exception()
| resource_not_found_exception()
| request_timeout_exception()
@type remove_knowledge_base_template_uri_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type search_content_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type search_quick_responses_errors() ::
validation_exception()
| access_denied_exception()
| resource_not_found_exception()
| request_timeout_exception()
@type search_sessions_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type start_content_upload_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type start_import_job_errors() ::
validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type tag_resource_errors() :: too_many_tags_exception() | resource_not_found_exception()
@type untag_resource_errors() :: resource_not_found_exception()
@type update_content_errors() ::
precondition_failed_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
@type update_knowledge_base_template_uri_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type update_quick_response_errors() ::
precondition_failed_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
| conflict_exception()
def metadata do
%{
api_version: "2020-10-19",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "wisdom",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "Wisdom",
signature_version: "v4",
signing_name: "wisdom",
target_prefix: nil
}
end
@doc """
Creates an Amazon Connect Wisdom assistant.
"""
@spec create_assistant(map(), create_assistant_request(), list()) ::
{:ok, create_assistant_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_assistant_errors()}
def create_assistant(%Client{} = client, input, options \\ []) do
url_path = "/assistants"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec create_assistant_association(
map(),
String.t() | atom(),
create_assistant_association_request(),
list()
) ::
{:ok, create_assistant_association_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_assistant_association_errors()}
def create_assistant_association(%Client{} = client, assistant_id, input, options \\ []) do
url_path = "/assistants/#{AWS.Util.encode_uri(assistant_id)}/associations"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates Wisdom content.
Before to calling this API, use
[StartContentUpload](https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html)
to
upload an asset.
"""
@spec create_content(map(), String.t() | atom(), create_content_request(), list()) ::
{:ok, create_content_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_content_errors()}
def create_content(%Client{} = client, knowledge_base_id, input, options \\ []) do
url_path = "/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/contents"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec create_knowledge_base(map(), create_knowledge_base_request(), list()) ::
{:ok, create_knowledge_base_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_knowledge_base_errors()}
def create_knowledge_base(%Client{} = client, input, options \\ []) do
url_path = "/knowledgeBases"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a Wisdom quick response.
"""
@spec create_quick_response(map(), String.t() | atom(), create_quick_response_request(), list()) ::
{:ok, create_quick_response_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_quick_response_errors()}
def create_quick_response(%Client{} = client, knowledge_base_id, input, options \\ []) do
url_path = "/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/quickResponses"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec create_session(map(), String.t() | atom(), create_session_request(), list()) ::
{:ok, create_session_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_session_errors()}
def create_session(%Client{} = client, assistant_id, input, options \\ []) do
url_path = "/assistants/#{AWS.Util.encode_uri(assistant_id)}/sessions"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes an assistant.
"""
@spec delete_assistant(map(), String.t() | atom(), delete_assistant_request(), list()) ::
{:ok, delete_assistant_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_assistant_errors()}
def delete_assistant(%Client{} = client, assistant_id, input, options \\ []) do
url_path = "/assistants/#{AWS.Util.encode_uri(assistant_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Deletes an assistant association.
"""
@spec delete_assistant_association(
map(),
String.t() | atom(),
String.t() | atom(),
delete_assistant_association_request(),
list()
) ::
{:ok, delete_assistant_association_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_assistant_association_errors()}
def delete_assistant_association(
%Client{} = client,
assistant_association_id,
assistant_id,
input,
options \\ []
) do
url_path =
"/assistants/#{AWS.Util.encode_uri(assistant_id)}/associations/#{AWS.Util.encode_uri(assistant_association_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Deletes the content.
"""
@spec delete_content(
map(),
String.t() | atom(),
String.t() | atom(),
delete_content_request(),
list()
) ::
{:ok, delete_content_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_content_errors()}
def delete_content(%Client{} = client, content_id, knowledge_base_id, input, options \\ []) do
url_path =
"/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/contents/#{AWS.Util.encode_uri(content_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Deletes the quick response import job.
"""
@spec delete_import_job(
map(),
String.t() | atom(),
String.t() | atom(),
delete_import_job_request(),
list()
) ::
{:ok, delete_import_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_import_job_errors()}
def delete_import_job(
%Client{} = client,
import_job_id,
knowledge_base_id,
input,
options \\ []
) do
url_path =
"/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/importJobs/#{AWS.Util.encode_uri(import_job_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
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](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*.
"""
@spec delete_knowledge_base(map(), String.t() | atom(), delete_knowledge_base_request(), list()) ::
{:ok, delete_knowledge_base_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_knowledge_base_errors()}
def delete_knowledge_base(%Client{} = client, knowledge_base_id, input, options \\ []) do
url_path = "/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Deletes a quick response.
"""
@spec delete_quick_response(
map(),
String.t() | atom(),
String.t() | atom(),
delete_quick_response_request(),
list()
) ::
{:ok, delete_quick_response_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_quick_response_errors()}
def delete_quick_response(
%Client{} = client,
knowledge_base_id,
quick_response_id,
input,
options \\ []
) do
url_path =
"/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/quickResponses/#{AWS.Util.encode_uri(quick_response_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Retrieves information about an assistant.
"""
@spec get_assistant(map(), String.t() | atom(), list()) ::
{:ok, get_assistant_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_assistant_errors()}
def get_assistant(%Client{} = client, assistant_id, options \\ []) do
url_path = "/assistants/#{AWS.Util.encode_uri(assistant_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves information about an assistant association.
"""
@spec get_assistant_association(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_assistant_association_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_assistant_association_errors()}
def get_assistant_association(
%Client{} = client,
assistant_association_id,
assistant_id,
options \\ []
) do
url_path =
"/assistants/#{AWS.Util.encode_uri(assistant_id)}/associations/#{AWS.Util.encode_uri(assistant_association_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves content, including a pre-signed URL to download the content.
"""
@spec get_content(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_content_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_content_errors()}
def get_content(%Client{} = client, content_id, knowledge_base_id, options \\ []) do
url_path =
"/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/contents/#{AWS.Util.encode_uri(content_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves summary information about the content.
"""
@spec get_content_summary(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_content_summary_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_content_summary_errors()}
def get_content_summary(%Client{} = client, content_id, knowledge_base_id, options \\ []) do
url_path =
"/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/contents/#{AWS.Util.encode_uri(content_id)}/summary"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves the started import job.
"""
@spec get_import_job(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_import_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_import_job_errors()}
def get_import_job(%Client{} = client, import_job_id, knowledge_base_id, options \\ []) do
url_path =
"/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/importJobs/#{AWS.Util.encode_uri(import_job_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves information about the knowledge base.
"""
@spec get_knowledge_base(map(), String.t() | atom(), list()) ::
{:ok, get_knowledge_base_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_knowledge_base_errors()}
def get_knowledge_base(%Client{} = client, knowledge_base_id, options \\ []) do
url_path = "/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves the quick response.
"""
@spec get_quick_response(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_quick_response_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_quick_response_errors()}
def get_quick_response(%Client{} = client, knowledge_base_id, quick_response_id, options \\ []) do
url_path =
"/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/quickResponses/#{AWS.Util.encode_uri(quick_response_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves 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 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](https://docs.aws.amazon.com/wisdom/latest/APIReference/API_QueryAssistant.html).
"""
@spec get_recommendations(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, get_recommendations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_recommendations_errors()}
def get_recommendations(
%Client{} = client,
assistant_id,
session_id,
max_results \\ nil,
wait_time_seconds \\ nil,
options \\ []
) do
url_path =
"/assistants/#{AWS.Util.encode_uri(assistant_id)}/sessions/#{AWS.Util.encode_uri(session_id)}/recommendations"
headers = []
query_params = []
query_params =
if !is_nil(wait_time_seconds) do
[{"waitTimeSeconds", wait_time_seconds} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves information for a specified session.
"""
@spec get_session(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_session_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_session_errors()}
def get_session(%Client{} = client, assistant_id, session_id, options \\ []) do
url_path =
"/assistants/#{AWS.Util.encode_uri(assistant_id)}/sessions/#{AWS.Util.encode_uri(session_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists information about assistant associations.
"""
@spec list_assistant_associations(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_assistant_associations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_assistant_associations_errors()}
def list_assistant_associations(
%Client{} = client,
assistant_id,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/assistants/#{AWS.Util.encode_uri(assistant_id)}/associations"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists information about assistants.
"""
@spec list_assistants(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_assistants_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_assistants_errors()}
def list_assistants(%Client{} = client, max_results \\ nil, next_token \\ nil, options \\ []) do
url_path = "/assistants"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the content.
"""
@spec list_contents(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_contents_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_contents_errors()}
def list_contents(
%Client{} = client,
knowledge_base_id,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/contents"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists information about import jobs.
"""
@spec list_import_jobs(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_import_jobs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_import_jobs_errors()}
def list_import_jobs(
%Client{} = client,
knowledge_base_id,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/importJobs"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the knowledge bases.
"""
@spec list_knowledge_bases(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_knowledge_bases_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_knowledge_bases_errors()}
def list_knowledge_bases(
%Client{} = client,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/knowledgeBases"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists information about quick response.
"""
@spec list_quick_responses(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_quick_responses_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_quick_responses_errors()}
def list_quick_responses(
%Client{} = client,
knowledge_base_id,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/quickResponses"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the tags for the specified resource.
"""
@spec list_tags_for_resource(map(), String.t() | atom(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, resource_arn, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Removes 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 a `waitTimeSeconds` input for long-polling
behavior and avoiding duplicate recommendations.
"""
@spec notify_recommendations_received(
map(),
String.t() | atom(),
String.t() | atom(),
notify_recommendations_received_request(),
list()
) ::
{:ok, notify_recommendations_received_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, notify_recommendations_received_errors()}
def notify_recommendations_received(
%Client{} = client,
assistant_id,
session_id,
input,
options \\ []
) do
url_path =
"/assistants/#{AWS.Util.encode_uri(assistant_id)}/sessions/#{AWS.Util.encode_uri(session_id)}/recommendations/notify"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Performs 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).
"""
@spec query_assistant(map(), String.t() | atom(), query_assistant_request(), list()) ::
{:ok, query_assistant_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, query_assistant_errors()}
def query_assistant(%Client{} = client, assistant_id, input, options \\ []) do
url_path = "/assistants/#{AWS.Util.encode_uri(assistant_id)}/query"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Removes a URI template from a knowledge base.
"""
@spec remove_knowledge_base_template_uri(
map(),
String.t() | atom(),
remove_knowledge_base_template_uri_request(),
list()
) ::
{:ok, remove_knowledge_base_template_uri_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, remove_knowledge_base_template_uri_errors()}
def remove_knowledge_base_template_uri(
%Client{} = client,
knowledge_base_id,
input,
options \\ []
) do
url_path = "/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/templateUri"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Searches for content in a specified knowledge base.
Can be used to get a specific content
resource by its name.
"""
@spec search_content(map(), String.t() | atom(), search_content_request(), list()) ::
{:ok, search_content_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, search_content_errors()}
def search_content(%Client{} = client, knowledge_base_id, input, options \\ []) do
url_path = "/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/search"
headers = []
custom_headers = []
{query_params, input} =
[
{"maxResults", "maxResults"},
{"nextToken", "nextToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Searches existing Wisdom quick responses in a Wisdom knowledge base.
"""
@spec search_quick_responses(
map(),
String.t() | atom(),
search_quick_responses_request(),
list()
) ::
{:ok, search_quick_responses_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, search_quick_responses_errors()}
def search_quick_responses(%Client{} = client, knowledge_base_id, input, options \\ []) do
url_path = "/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/search/quickResponses"
headers = []
custom_headers = []
{query_params, input} =
[
{"maxResults", "maxResults"},
{"nextToken", "nextToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Searches for sessions.
"""
@spec search_sessions(map(), String.t() | atom(), search_sessions_request(), list()) ::
{:ok, search_sessions_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, search_sessions_errors()}
def search_sessions(%Client{} = client, assistant_id, input, options \\ []) do
url_path = "/assistants/#{AWS.Util.encode_uri(assistant_id)}/searchSessions"
headers = []
custom_headers = []
{query_params, input} =
[
{"maxResults", "maxResults"},
{"nextToken", "nextToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec start_content_upload(map(), String.t() | atom(), start_content_upload_request(), list()) ::
{:ok, start_content_upload_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, start_content_upload_errors()}
def start_content_upload(%Client{} = client, knowledge_base_id, input, options \\ []) do
url_path = "/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/upload"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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).
"""
@spec start_import_job(map(), String.t() | atom(), start_import_job_request(), list()) ::
{:ok, start_import_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, start_import_job_errors()}
def start_import_job(%Client{} = client, knowledge_base_id, input, options \\ []) do
url_path = "/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/importJobs"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Adds the specified tags to the specified resource.
"""
@spec tag_resource(map(), String.t() | atom(), tag_resource_request(), list()) ::
{:ok, tag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Removes the specified tags from the specified resource.
"""
@spec untag_resource(map(), String.t() | atom(), untag_resource_request(), list()) ::
{:ok, untag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"tagKeys", "tagKeys"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates information about the content.
"""
@spec update_content(
map(),
String.t() | atom(),
String.t() | atom(),
update_content_request(),
list()
) ::
{:ok, update_content_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_content_errors()}
def update_content(%Client{} = client, content_id, knowledge_base_id, input, options \\ []) do
url_path =
"/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/contents/#{AWS.Util.encode_uri(content_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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`.
"""
@spec update_knowledge_base_template_uri(
map(),
String.t() | atom(),
update_knowledge_base_template_uri_request(),
list()
) ::
{:ok, update_knowledge_base_template_uri_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_knowledge_base_template_uri_errors()}
def update_knowledge_base_template_uri(
%Client{} = client,
knowledge_base_id,
input,
options \\ []
) do
url_path = "/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/templateUri"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing Wisdom quick response.
"""
@spec update_quick_response(
map(),
String.t() | atom(),
String.t() | atom(),
update_quick_response_request(),
list()
) ::
{:ok, update_quick_response_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_quick_response_errors()}
def update_quick_response(
%Client{} = client,
knowledge_base_id,
quick_response_id,
input,
options \\ []
) do
url_path =
"/knowledgeBases/#{AWS.Util.encode_uri(knowledge_base_id)}/quickResponses/#{AWS.Util.encode_uri(quick_response_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end
