Module Awso_wisdom.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule HighlightOffset : sig ... end
Sourcemodule Highlight : sig ... end

Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

Sourcemodule NonEmptyString : sig ... end
Sourcemodule GroupingValue : sig ... end
Sourcemodule QuickResponseContent : sig ... end
Sourcemodule QuickResponseFilterValue : sig ... end
Sourcemodule QuickResponseQueryValue : sig ... end
Sourcemodule Arn : sig ... end
Sourcemodule Uuid : sig ... end
Sourcemodule Highlights : sig ... end
Sourcemodule SensitiveString : sig ... end
Sourcemodule GenericArn : sig ... end
Sourcemodule ObjectFieldsList : sig ... end
Sourcemodule ConnectConfiguration : sig ... end

The configuration information of the Amazon Connect data source.

Sourcemodule QueryText : sig ... end
Sourcemodule FilterField : sig ... end
Sourcemodule FilterOperator : sig ... end
Sourcemodule Channel : sig ... end
Sourcemodule ContactAttributeKey : sig ... end
Sourcemodule GroupingCriteria : sig ... end
Sourcemodule GroupingValues : sig ... end

The container quick response content.

Sourcemodule TagKey : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule Boolean : sig ... end
Sourcemodule Priority : sig ... end
Sourcemodule ContentReference : sig ... end

Reference information about the content.

Sourcemodule DocumentText : sig ... end

The text of the document.

Sourcemodule Uri_ : sig ... end

Configuration information for Amazon AppIntegrations to automatically ingest content.

Sourcemodule Configuration : sig ... end

The configuration information of the external data source.

Sourcemodule ExternalSource : sig ... end

Association information about the knowledge base.

Sourcemodule String_ : sig ... end

Data associated with the QUERY RecommendationTriggerType.

Sourcemodule Filter : sig ... end

A search filter.

Sourcemodule Channels : sig ... end
Sourcemodule ContactAttributeKeys : sig ... end
Sourcemodule GroupingConfiguration : sig ... end

The configuration information of the grouping of Wisdom users.

Sourcemodule LanguageCode : sig ... end
Sourcemodule QuickResponseContents : sig ... end

The content of the quick response stored in different media types.

Sourcemodule QuickResponseDescription : sig ... end
Sourcemodule QuickResponseName : sig ... end
Sourcemodule QuickResponseStatus : sig ... end
Sourcemodule QuickResponseType : sig ... end
Sourcemodule ShortCutKey : sig ... end
Sourcemodule Tags : sig ... end
Sourcemodule QuickResponseFilterField : sig ... end

The quick response fields to filter the quick response query results by. The following is the list of supported field names. name description shortcutKey isActive channels language contentType createdTime lastModifiedTime lastModifiedBy groupingConfiguration.criteria groupingConfiguration.values

Sourcemodule Order : sig ... end
Sourcemodule QuickResponseQueryField : sig ... end

The quick response fields to query quick responses by. The following is the list of supported field names. content name description shortcutKey

Sourcemodule ContentMetadata : sig ... end
Sourcemodule ContentStatus : sig ... end
Sourcemodule ContentTitle : sig ... end
Sourcemodule ContentType : sig ... end
Sourcemodule Name : sig ... end
Sourcemodule Document : sig ... end

The document.

Sourcemodule RelevanceScore : sig ... end
Sourcemodule Description : sig ... end
Sourcemodule KnowledgeBaseStatus : sig ... end
Sourcemodule KnowledgeBaseType : sig ... end
Sourcemodule RenderingConfiguration : sig ... end

Information about how to render the content.

The configuration information for the customer managed key used for encryption.

Sourcemodule SourceConfiguration : sig ... end

Configuration information about the external data source.

The configuration information of the external data source.

Sourcemodule ImportJobStatus : sig ... end
Sourcemodule ImportJobType : sig ... end
Sourcemodule UploadId : sig ... end

The configuration information for the Wisdom assistant integration.

Sourcemodule AssistantStatus : sig ... end
Sourcemodule AssistantType : sig ... end

The data that is output as a result of the assistant association.

Sourcemodule AssociationType : sig ... end
Sourcemodule RecommendationType : sig ... end
Sourcemodule RelevanceLevel : sig ... end
Sourcemodule RecommendationIdList : sig ... end
Sourcemodule RecommendationSourceType : sig ... end
Sourcemodule RecommendationTriggerData : sig ... end

A union type containing information related to the trigger.

Sourcemodule RecommendationTriggerType : sig ... end
Sourcemodule Url : sig ... end
Sourcemodule SessionSummary : sig ... end

Summary information about the session.

Sourcemodule FilterList : sig ... end

The result of quick response search.

Sourcemodule ContactAttributeValue : sig ... end
Sourcemodule QuickResponseOrderField : sig ... end

The quick response fields to order the quick response query results by. The following is the list of supported field names. name description shortcutKey isActive channels language contentType createdTime lastModifiedTime lastModifiedBy groupingConfiguration.criteria groupingConfiguration.values

Sourcemodule ContentSummary : sig ... end

Summary information about the content.

Sourcemodule ResultData : sig ... end

Information about the result.

An error occurred when creating a recommendation.

Sourcemodule QuickResponseSummary : sig ... end

The summary information about the quick response.

Sourcemodule KnowledgeBaseSummary : sig ... end

Summary information about the knowledge base.

Sourcemodule ImportJobSummary : sig ... end

Summary information about the import job.

Sourcemodule AssistantSummary : sig ... end

Summary information about the assistant.

Summary information about the assistant association.

The configuration information for the session integration.

Sourcemodule RecommendationData : sig ... end

Information about the recommendation.

Sourcemodule RecommendationTrigger : sig ... end

A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.

Sourcemodule AccessDeniedException : sig ... end

You do not have sufficient access to perform this action.

Sourcemodule ConflictException : sig ... end

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

The provided revisionId does not match, indicating the content has been modified since it was last read.

Sourcemodule QuickResponseData : sig ... end

Information about the quick response.

Sourcemodule ResourceNotFoundException : sig ... end

The specified resource does not exist.

Sourcemodule ValidationException : sig ... end

The input fails to satisfy the constraints specified by a service.

Sourcemodule QuickResponseDataProvider : sig ... end

The container of quick response data.

Sourcemodule UuidOrArn : sig ... end
Sourcemodule KnowledgeBaseData : sig ... end

Information about the knowledge base.

Sourcemodule ContentData : sig ... end

Information about the content.

Sourcemodule TagKeyList : sig ... end
Sourcemodule TooManyTagsException : sig ... end

Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.

Sourcemodule ImportJobData : sig ... end

Summary information about the import job.

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

Sourcemodule Headers : sig ... end
Sourcemodule TimeToLive : sig ... end

Expiration time in minutes

Sourcemodule NextToken : sig ... end
Sourcemodule SessionSummaries : sig ... end
Sourcemodule MaxResults : sig ... end
Sourcemodule SearchExpression : sig ... end

The search expression.

Sourcemodule RequestTimeoutException : sig ... end

The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.

Sourcemodule ContactAttributes : sig ... end

Information about the import job.

Sourcemodule ContentSummaryList : sig ... end
Sourcemodule QueryResultsList : sig ... end
Sourcemodule QuickResponseSummaryList : sig ... end
Sourcemodule KnowledgeBaseList : sig ... end
Sourcemodule ImportJobList : sig ... end
Sourcemodule AssistantList : sig ... end
Sourcemodule SessionData : sig ... end

Information about the session.

Sourcemodule RecommendationList : sig ... end
Sourcemodule RecommendationTriggerList : sig ... end
Sourcemodule WaitTimeSeconds : sig ... end
Sourcemodule AssistantData : sig ... end

The assistant data.

Sourcemodule AssistantAssociationData : sig ... end

Information about the assistant association.

Sourcemodule ClientToken : sig ... end

The data that is input into Wisdom as a result of the assistant association.

Updates an existing Wisdom quick response.

Updates an existing Wisdom quick response.

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.

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.

Sourcemodule UpdateContentResponse : sig ... end

Updates information about the content.

Sourcemodule UpdateContentRequest : sig ... end

Updates information about the content.

Sourcemodule UntagResourceResponse : sig ... end

Removes the specified tags from the specified resource.

Sourcemodule UntagResourceRequest : sig ... end

Removes the specified tags from the specified resource.

Sourcemodule TagResourceResponse : sig ... end

Adds the specified tags to the specified resource.

Sourcemodule TagResourceRequest : sig ... end

Adds the specified tags to the specified resource.

Sourcemodule StartImportJobResponse : sig ... end

Start an asynchronous job to import Wisdom resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data. For importing Wisdom quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.

Sourcemodule StartImportJobRequest : sig ... end

Start an asynchronous job to import Wisdom resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data. For importing Wisdom quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.

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.

Sourcemodule StartContentUploadRequest : sig ... end

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.

Sourcemodule SearchSessionsResponse : sig ... end

Searches for sessions.

Sourcemodule SearchSessionsRequest : sig ... end

Searches for sessions.

Searches existing Wisdom quick responses in a Wisdom knowledge base.

Searches existing Wisdom quick responses in a Wisdom knowledge base.

Sourcemodule SearchContentResponse : sig ... end

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

Sourcemodule SearchContentRequest : sig ... end

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

Removes a URI template from a knowledge base.

Removes a URI template from a knowledge base.

Sourcemodule QueryAssistantResponse : sig ... end

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

Sourcemodule QueryAssistantRequest : sig ... end

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

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.

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.

Lists the tags for the specified resource.

Lists the tags for the specified resource.

Lists information about quick response.

Sourcemodule ListQuickResponsesRequest : sig ... end

Lists information about quick response.

Lists the knowledge bases.

Sourcemodule ListKnowledgeBasesRequest : sig ... end

Lists the knowledge bases.

Sourcemodule ListImportJobsResponse : sig ... end

Lists information about import jobs.

Sourcemodule ListImportJobsRequest : sig ... end

Lists information about import jobs.

Sourcemodule ListContentsResponse : sig ... end

Lists the content.

Sourcemodule ListContentsRequest : sig ... end

Lists the content.

Sourcemodule ListAssistantsResponse : sig ... end

Lists information about assistants.

Sourcemodule ListAssistantsRequest : sig ... end

Lists information about assistants.

Lists information about assistant associations.

Lists information about assistant associations.

Sourcemodule GetSessionResponse : sig ... end

Retrieves information for a specified session.

Sourcemodule GetSessionRequest : sig ... end

Retrieves information for a specified session.

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.

Sourcemodule GetRecommendationsRequest : sig ... end

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.

Sourcemodule GetQuickResponseResponse : sig ... end

Retrieves the quick response.

Sourcemodule GetQuickResponseRequest : sig ... end

Retrieves the quick response.

Sourcemodule GetKnowledgeBaseResponse : sig ... end

Retrieves information about the knowledge base.

Sourcemodule GetKnowledgeBaseRequest : sig ... end

Retrieves information about the knowledge base.

Sourcemodule GetImportJobResponse : sig ... end

Retrieves the started import job.

Sourcemodule GetImportJobRequest : sig ... end

Retrieves the started import job.

Sourcemodule GetContentSummaryResponse : sig ... end

Retrieves summary information about the content.

Sourcemodule GetContentSummaryRequest : sig ... end

Retrieves summary information about the content.

Sourcemodule GetContentResponse : sig ... end

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

Sourcemodule GetContentRequest : sig ... end

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

Sourcemodule GetAssistantResponse : sig ... end

Retrieves information about an assistant.

Sourcemodule GetAssistantRequest : sig ... end

Retrieves information about an assistant.

Retrieves information about an assistant association.

Retrieves information about an assistant association.

Deletes a quick response.

Deletes a quick response.

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.

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.

Sourcemodule DeleteImportJobResponse : sig ... end

Deletes the quick response import job.

Sourcemodule DeleteImportJobRequest : sig ... end

Deletes the quick response import job.

Sourcemodule DeleteContentResponse : sig ... end

Deletes the content.

Sourcemodule DeleteContentRequest : sig ... end

Deletes the content.

Sourcemodule DeleteAssistantResponse : sig ... end

Deletes an assistant.

Sourcemodule DeleteAssistantRequest : sig ... end

Deletes an assistant.

Deletes an assistant association.

Deletes an assistant association.

Sourcemodule CreateSessionResponse : sig ... end

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.

Sourcemodule CreateSessionRequest : sig ... end

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.

Creates a Wisdom quick response.

Creates a Wisdom quick response.

Creates a knowledge base. When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error. For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following: Call DeleteKnowledgeBase. Call DeleteDataIntegration. Call CreateDataIntegration to recreate the DataIntegration or a create different one. Call CreateKnowledgeBase.

Creates a knowledge base. When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error. For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following: Call DeleteKnowledgeBase. Call DeleteDataIntegration. Call CreateDataIntegration to recreate the DataIntegration or a create different one. Call CreateKnowledgeBase.

Sourcemodule CreateContentResponse : sig ... end

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

Sourcemodule CreateContentRequest : sig ... end

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

Sourcemodule CreateAssistantResponse : sig ... end

Creates an Amazon Connect Wisdom assistant.

Sourcemodule CreateAssistantRequest : sig ... end

Creates an Amazon Connect Wisdom assistant.

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.

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.