aws-sdk
Version:
AWS SDK for JavaScript
943 lines • 99.8 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Wisdom extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Wisdom.Types.ClientConfiguration)
config: Config & Wisdom.Types.ClientConfiguration;
/**
* Creates an Amazon Connect Wisdom assistant.
*/
createAssistant(params: Wisdom.Types.CreateAssistantRequest, callback?: (err: AWSError, data: Wisdom.Types.CreateAssistantResponse) => void): Request<Wisdom.Types.CreateAssistantResponse, AWSError>;
/**
* Creates an Amazon Connect Wisdom assistant.
*/
createAssistant(callback?: (err: AWSError, data: Wisdom.Types.CreateAssistantResponse) => void): Request<Wisdom.Types.CreateAssistantResponse, AWSError>;
/**
* 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.
*/
createAssistantAssociation(params: Wisdom.Types.CreateAssistantAssociationRequest, callback?: (err: AWSError, data: Wisdom.Types.CreateAssistantAssociationResponse) => void): Request<Wisdom.Types.CreateAssistantAssociationResponse, AWSError>;
/**
* 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.
*/
createAssistantAssociation(callback?: (err: AWSError, data: Wisdom.Types.CreateAssistantAssociationResponse) => void): Request<Wisdom.Types.CreateAssistantAssociationResponse, AWSError>;
/**
* Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.
*/
createContent(params: Wisdom.Types.CreateContentRequest, callback?: (err: AWSError, data: Wisdom.Types.CreateContentResponse) => void): Request<Wisdom.Types.CreateContentResponse, AWSError>;
/**
* Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.
*/
createContent(callback?: (err: AWSError, data: Wisdom.Types.CreateContentResponse) => void): Request<Wisdom.Types.CreateContentResponse, AWSError>;
/**
* 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.
*/
createKnowledgeBase(params: Wisdom.Types.CreateKnowledgeBaseRequest, callback?: (err: AWSError, data: Wisdom.Types.CreateKnowledgeBaseResponse) => void): Request<Wisdom.Types.CreateKnowledgeBaseResponse, AWSError>;
/**
* 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.
*/
createKnowledgeBase(callback?: (err: AWSError, data: Wisdom.Types.CreateKnowledgeBaseResponse) => void): Request<Wisdom.Types.CreateKnowledgeBaseResponse, AWSError>;
/**
* Creates a Wisdom quick response.
*/
createQuickResponse(params: Wisdom.Types.CreateQuickResponseRequest, callback?: (err: AWSError, data: Wisdom.Types.CreateQuickResponseResponse) => void): Request<Wisdom.Types.CreateQuickResponseResponse, AWSError>;
/**
* Creates a Wisdom quick response.
*/
createQuickResponse(callback?: (err: AWSError, data: Wisdom.Types.CreateQuickResponseResponse) => void): Request<Wisdom.Types.CreateQuickResponseResponse, AWSError>;
/**
* 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.
*/
createSession(params: Wisdom.Types.CreateSessionRequest, callback?: (err: AWSError, data: Wisdom.Types.CreateSessionResponse) => void): Request<Wisdom.Types.CreateSessionResponse, AWSError>;
/**
* 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.
*/
createSession(callback?: (err: AWSError, data: Wisdom.Types.CreateSessionResponse) => void): Request<Wisdom.Types.CreateSessionResponse, AWSError>;
/**
* Deletes an assistant.
*/
deleteAssistant(params: Wisdom.Types.DeleteAssistantRequest, callback?: (err: AWSError, data: Wisdom.Types.DeleteAssistantResponse) => void): Request<Wisdom.Types.DeleteAssistantResponse, AWSError>;
/**
* Deletes an assistant.
*/
deleteAssistant(callback?: (err: AWSError, data: Wisdom.Types.DeleteAssistantResponse) => void): Request<Wisdom.Types.DeleteAssistantResponse, AWSError>;
/**
* Deletes an assistant association.
*/
deleteAssistantAssociation(params: Wisdom.Types.DeleteAssistantAssociationRequest, callback?: (err: AWSError, data: Wisdom.Types.DeleteAssistantAssociationResponse) => void): Request<Wisdom.Types.DeleteAssistantAssociationResponse, AWSError>;
/**
* Deletes an assistant association.
*/
deleteAssistantAssociation(callback?: (err: AWSError, data: Wisdom.Types.DeleteAssistantAssociationResponse) => void): Request<Wisdom.Types.DeleteAssistantAssociationResponse, AWSError>;
/**
* Deletes the content.
*/
deleteContent(params: Wisdom.Types.DeleteContentRequest, callback?: (err: AWSError, data: Wisdom.Types.DeleteContentResponse) => void): Request<Wisdom.Types.DeleteContentResponse, AWSError>;
/**
* Deletes the content.
*/
deleteContent(callback?: (err: AWSError, data: Wisdom.Types.DeleteContentResponse) => void): Request<Wisdom.Types.DeleteContentResponse, AWSError>;
/**
* Deletes the quick response import job.
*/
deleteImportJob(params: Wisdom.Types.DeleteImportJobRequest, callback?: (err: AWSError, data: Wisdom.Types.DeleteImportJobResponse) => void): Request<Wisdom.Types.DeleteImportJobResponse, AWSError>;
/**
* Deletes the quick response import job.
*/
deleteImportJob(callback?: (err: AWSError, data: Wisdom.Types.DeleteImportJobResponse) => void): Request<Wisdom.Types.DeleteImportJobResponse, AWSError>;
/**
* 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.
*/
deleteKnowledgeBase(params: Wisdom.Types.DeleteKnowledgeBaseRequest, callback?: (err: AWSError, data: Wisdom.Types.DeleteKnowledgeBaseResponse) => void): Request<Wisdom.Types.DeleteKnowledgeBaseResponse, AWSError>;
/**
* 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.
*/
deleteKnowledgeBase(callback?: (err: AWSError, data: Wisdom.Types.DeleteKnowledgeBaseResponse) => void): Request<Wisdom.Types.DeleteKnowledgeBaseResponse, AWSError>;
/**
* Deletes a quick response.
*/
deleteQuickResponse(params: Wisdom.Types.DeleteQuickResponseRequest, callback?: (err: AWSError, data: Wisdom.Types.DeleteQuickResponseResponse) => void): Request<Wisdom.Types.DeleteQuickResponseResponse, AWSError>;
/**
* Deletes a quick response.
*/
deleteQuickResponse(callback?: (err: AWSError, data: Wisdom.Types.DeleteQuickResponseResponse) => void): Request<Wisdom.Types.DeleteQuickResponseResponse, AWSError>;
/**
* Retrieves information about an assistant.
*/
getAssistant(params: Wisdom.Types.GetAssistantRequest, callback?: (err: AWSError, data: Wisdom.Types.GetAssistantResponse) => void): Request<Wisdom.Types.GetAssistantResponse, AWSError>;
/**
* Retrieves information about an assistant.
*/
getAssistant(callback?: (err: AWSError, data: Wisdom.Types.GetAssistantResponse) => void): Request<Wisdom.Types.GetAssistantResponse, AWSError>;
/**
* Retrieves information about an assistant association.
*/
getAssistantAssociation(params: Wisdom.Types.GetAssistantAssociationRequest, callback?: (err: AWSError, data: Wisdom.Types.GetAssistantAssociationResponse) => void): Request<Wisdom.Types.GetAssistantAssociationResponse, AWSError>;
/**
* Retrieves information about an assistant association.
*/
getAssistantAssociation(callback?: (err: AWSError, data: Wisdom.Types.GetAssistantAssociationResponse) => void): Request<Wisdom.Types.GetAssistantAssociationResponse, AWSError>;
/**
* Retrieves content, including a pre-signed URL to download the content.
*/
getContent(params: Wisdom.Types.GetContentRequest, callback?: (err: AWSError, data: Wisdom.Types.GetContentResponse) => void): Request<Wisdom.Types.GetContentResponse, AWSError>;
/**
* Retrieves content, including a pre-signed URL to download the content.
*/
getContent(callback?: (err: AWSError, data: Wisdom.Types.GetContentResponse) => void): Request<Wisdom.Types.GetContentResponse, AWSError>;
/**
* Retrieves summary information about the content.
*/
getContentSummary(params: Wisdom.Types.GetContentSummaryRequest, callback?: (err: AWSError, data: Wisdom.Types.GetContentSummaryResponse) => void): Request<Wisdom.Types.GetContentSummaryResponse, AWSError>;
/**
* Retrieves summary information about the content.
*/
getContentSummary(callback?: (err: AWSError, data: Wisdom.Types.GetContentSummaryResponse) => void): Request<Wisdom.Types.GetContentSummaryResponse, AWSError>;
/**
* Retrieves the started import job.
*/
getImportJob(params: Wisdom.Types.GetImportJobRequest, callback?: (err: AWSError, data: Wisdom.Types.GetImportJobResponse) => void): Request<Wisdom.Types.GetImportJobResponse, AWSError>;
/**
* Retrieves the started import job.
*/
getImportJob(callback?: (err: AWSError, data: Wisdom.Types.GetImportJobResponse) => void): Request<Wisdom.Types.GetImportJobResponse, AWSError>;
/**
* Retrieves information about the knowledge base.
*/
getKnowledgeBase(params: Wisdom.Types.GetKnowledgeBaseRequest, callback?: (err: AWSError, data: Wisdom.Types.GetKnowledgeBaseResponse) => void): Request<Wisdom.Types.GetKnowledgeBaseResponse, AWSError>;
/**
* Retrieves information about the knowledge base.
*/
getKnowledgeBase(callback?: (err: AWSError, data: Wisdom.Types.GetKnowledgeBaseResponse) => void): Request<Wisdom.Types.GetKnowledgeBaseResponse, AWSError>;
/**
* Retrieves the quick response.
*/
getQuickResponse(params: Wisdom.Types.GetQuickResponseRequest, callback?: (err: AWSError, data: Wisdom.Types.GetQuickResponseResponse) => void): Request<Wisdom.Types.GetQuickResponseResponse, AWSError>;
/**
* Retrieves the quick response.
*/
getQuickResponse(callback?: (err: AWSError, data: Wisdom.Types.GetQuickResponseResponse) => void): Request<Wisdom.Types.GetQuickResponseResponse, AWSError>;
/**
* 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.
*/
getRecommendations(params: Wisdom.Types.GetRecommendationsRequest, callback?: (err: AWSError, data: Wisdom.Types.GetRecommendationsResponse) => void): Request<Wisdom.Types.GetRecommendationsResponse, AWSError>;
/**
* 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.
*/
getRecommendations(callback?: (err: AWSError, data: Wisdom.Types.GetRecommendationsResponse) => void): Request<Wisdom.Types.GetRecommendationsResponse, AWSError>;
/**
* Retrieves information for a specified session.
*/
getSession(params: Wisdom.Types.GetSessionRequest, callback?: (err: AWSError, data: Wisdom.Types.GetSessionResponse) => void): Request<Wisdom.Types.GetSessionResponse, AWSError>;
/**
* Retrieves information for a specified session.
*/
getSession(callback?: (err: AWSError, data: Wisdom.Types.GetSessionResponse) => void): Request<Wisdom.Types.GetSessionResponse, AWSError>;
/**
* Lists information about assistant associations.
*/
listAssistantAssociations(params: Wisdom.Types.ListAssistantAssociationsRequest, callback?: (err: AWSError, data: Wisdom.Types.ListAssistantAssociationsResponse) => void): Request<Wisdom.Types.ListAssistantAssociationsResponse, AWSError>;
/**
* Lists information about assistant associations.
*/
listAssistantAssociations(callback?: (err: AWSError, data: Wisdom.Types.ListAssistantAssociationsResponse) => void): Request<Wisdom.Types.ListAssistantAssociationsResponse, AWSError>;
/**
* Lists information about assistants.
*/
listAssistants(params: Wisdom.Types.ListAssistantsRequest, callback?: (err: AWSError, data: Wisdom.Types.ListAssistantsResponse) => void): Request<Wisdom.Types.ListAssistantsResponse, AWSError>;
/**
* Lists information about assistants.
*/
listAssistants(callback?: (err: AWSError, data: Wisdom.Types.ListAssistantsResponse) => void): Request<Wisdom.Types.ListAssistantsResponse, AWSError>;
/**
* Lists the content.
*/
listContents(params: Wisdom.Types.ListContentsRequest, callback?: (err: AWSError, data: Wisdom.Types.ListContentsResponse) => void): Request<Wisdom.Types.ListContentsResponse, AWSError>;
/**
* Lists the content.
*/
listContents(callback?: (err: AWSError, data: Wisdom.Types.ListContentsResponse) => void): Request<Wisdom.Types.ListContentsResponse, AWSError>;
/**
* Lists information about import jobs.
*/
listImportJobs(params: Wisdom.Types.ListImportJobsRequest, callback?: (err: AWSError, data: Wisdom.Types.ListImportJobsResponse) => void): Request<Wisdom.Types.ListImportJobsResponse, AWSError>;
/**
* Lists information about import jobs.
*/
listImportJobs(callback?: (err: AWSError, data: Wisdom.Types.ListImportJobsResponse) => void): Request<Wisdom.Types.ListImportJobsResponse, AWSError>;
/**
* Lists the knowledge bases.
*/
listKnowledgeBases(params: Wisdom.Types.ListKnowledgeBasesRequest, callback?: (err: AWSError, data: Wisdom.Types.ListKnowledgeBasesResponse) => void): Request<Wisdom.Types.ListKnowledgeBasesResponse, AWSError>;
/**
* Lists the knowledge bases.
*/
listKnowledgeBases(callback?: (err: AWSError, data: Wisdom.Types.ListKnowledgeBasesResponse) => void): Request<Wisdom.Types.ListKnowledgeBasesResponse, AWSError>;
/**
* Lists information about quick response.
*/
listQuickResponses(params: Wisdom.Types.ListQuickResponsesRequest, callback?: (err: AWSError, data: Wisdom.Types.ListQuickResponsesResponse) => void): Request<Wisdom.Types.ListQuickResponsesResponse, AWSError>;
/**
* Lists information about quick response.
*/
listQuickResponses(callback?: (err: AWSError, data: Wisdom.Types.ListQuickResponsesResponse) => void): Request<Wisdom.Types.ListQuickResponsesResponse, AWSError>;
/**
* Lists the tags for the specified resource.
*/
listTagsForResource(params: Wisdom.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Wisdom.Types.ListTagsForResourceResponse) => void): Request<Wisdom.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags for the specified resource.
*/
listTagsForResource(callback?: (err: AWSError, data: Wisdom.Types.ListTagsForResourceResponse) => void): Request<Wisdom.Types.ListTagsForResourceResponse, AWSError>;
/**
* 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.
*/
notifyRecommendationsReceived(params: Wisdom.Types.NotifyRecommendationsReceivedRequest, callback?: (err: AWSError, data: Wisdom.Types.NotifyRecommendationsReceivedResponse) => void): Request<Wisdom.Types.NotifyRecommendationsReceivedResponse, AWSError>;
/**
* 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.
*/
notifyRecommendationsReceived(callback?: (err: AWSError, data: Wisdom.Types.NotifyRecommendationsReceivedResponse) => void): Request<Wisdom.Types.NotifyRecommendationsReceivedResponse, AWSError>;
/**
* Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
*/
queryAssistant(params: Wisdom.Types.QueryAssistantRequest, callback?: (err: AWSError, data: Wisdom.Types.QueryAssistantResponse) => void): Request<Wisdom.Types.QueryAssistantResponse, AWSError>;
/**
* Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
*/
queryAssistant(callback?: (err: AWSError, data: Wisdom.Types.QueryAssistantResponse) => void): Request<Wisdom.Types.QueryAssistantResponse, AWSError>;
/**
* Removes a URI template from a knowledge base.
*/
removeKnowledgeBaseTemplateUri(params: Wisdom.Types.RemoveKnowledgeBaseTemplateUriRequest, callback?: (err: AWSError, data: Wisdom.Types.RemoveKnowledgeBaseTemplateUriResponse) => void): Request<Wisdom.Types.RemoveKnowledgeBaseTemplateUriResponse, AWSError>;
/**
* Removes a URI template from a knowledge base.
*/
removeKnowledgeBaseTemplateUri(callback?: (err: AWSError, data: Wisdom.Types.RemoveKnowledgeBaseTemplateUriResponse) => void): Request<Wisdom.Types.RemoveKnowledgeBaseTemplateUriResponse, AWSError>;
/**
* Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
*/
searchContent(params: Wisdom.Types.SearchContentRequest, callback?: (err: AWSError, data: Wisdom.Types.SearchContentResponse) => void): Request<Wisdom.Types.SearchContentResponse, AWSError>;
/**
* Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
*/
searchContent(callback?: (err: AWSError, data: Wisdom.Types.SearchContentResponse) => void): Request<Wisdom.Types.SearchContentResponse, AWSError>;
/**
* Searches existing Wisdom quick responses in a Wisdom knowledge base.
*/
searchQuickResponses(params: Wisdom.Types.SearchQuickResponsesRequest, callback?: (err: AWSError, data: Wisdom.Types.SearchQuickResponsesResponse) => void): Request<Wisdom.Types.SearchQuickResponsesResponse, AWSError>;
/**
* Searches existing Wisdom quick responses in a Wisdom knowledge base.
*/
searchQuickResponses(callback?: (err: AWSError, data: Wisdom.Types.SearchQuickResponsesResponse) => void): Request<Wisdom.Types.SearchQuickResponsesResponse, AWSError>;
/**
* Searches for sessions.
*/
searchSessions(params: Wisdom.Types.SearchSessionsRequest, callback?: (err: AWSError, data: Wisdom.Types.SearchSessionsResponse) => void): Request<Wisdom.Types.SearchSessionsResponse, AWSError>;
/**
* Searches for sessions.
*/
searchSessions(callback?: (err: AWSError, data: Wisdom.Types.SearchSessionsResponse) => void): Request<Wisdom.Types.SearchSessionsResponse, AWSError>;
/**
* 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.
*/
startContentUpload(params: Wisdom.Types.StartContentUploadRequest, callback?: (err: AWSError, data: Wisdom.Types.StartContentUploadResponse) => void): Request<Wisdom.Types.StartContentUploadResponse, AWSError>;
/**
* 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.
*/
startContentUpload(callback?: (err: AWSError, data: Wisdom.Types.StartContentUploadResponse) => void): Request<Wisdom.Types.StartContentUploadResponse, AWSError>;
/**
* 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.
*/
startImportJob(params: Wisdom.Types.StartImportJobRequest, callback?: (err: AWSError, data: Wisdom.Types.StartImportJobResponse) => void): Request<Wisdom.Types.StartImportJobResponse, AWSError>;
/**
* 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.
*/
startImportJob(callback?: (err: AWSError, data: Wisdom.Types.StartImportJobResponse) => void): Request<Wisdom.Types.StartImportJobResponse, AWSError>;
/**
* Adds the specified tags to the specified resource.
*/
tagResource(params: Wisdom.Types.TagResourceRequest, callback?: (err: AWSError, data: Wisdom.Types.TagResourceResponse) => void): Request<Wisdom.Types.TagResourceResponse, AWSError>;
/**
* Adds the specified tags to the specified resource.
*/
tagResource(callback?: (err: AWSError, data: Wisdom.Types.TagResourceResponse) => void): Request<Wisdom.Types.TagResourceResponse, AWSError>;
/**
* Removes the specified tags from the specified resource.
*/
untagResource(params: Wisdom.Types.UntagResourceRequest, callback?: (err: AWSError, data: Wisdom.Types.UntagResourceResponse) => void): Request<Wisdom.Types.UntagResourceResponse, AWSError>;
/**
* Removes the specified tags from the specified resource.
*/
untagResource(callback?: (err: AWSError, data: Wisdom.Types.UntagResourceResponse) => void): Request<Wisdom.Types.UntagResourceResponse, AWSError>;
/**
* Updates information about the content.
*/
updateContent(params: Wisdom.Types.UpdateContentRequest, callback?: (err: AWSError, data: Wisdom.Types.UpdateContentResponse) => void): Request<Wisdom.Types.UpdateContentResponse, AWSError>;
/**
* Updates information about the content.
*/
updateContent(callback?: (err: AWSError, data: Wisdom.Types.UpdateContentResponse) => void): Request<Wisdom.Types.UpdateContentResponse, AWSError>;
/**
* 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.
*/
updateKnowledgeBaseTemplateUri(params: Wisdom.Types.UpdateKnowledgeBaseTemplateUriRequest, callback?: (err: AWSError, data: Wisdom.Types.UpdateKnowledgeBaseTemplateUriResponse) => void): Request<Wisdom.Types.UpdateKnowledgeBaseTemplateUriResponse, AWSError>;
/**
* 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.
*/
updateKnowledgeBaseTemplateUri(callback?: (err: AWSError, data: Wisdom.Types.UpdateKnowledgeBaseTemplateUriResponse) => void): Request<Wisdom.Types.UpdateKnowledgeBaseTemplateUriResponse, AWSError>;
/**
* Updates an existing Wisdom quick response.
*/
updateQuickResponse(params: Wisdom.Types.UpdateQuickResponseRequest, callback?: (err: AWSError, data: Wisdom.Types.UpdateQuickResponseResponse) => void): Request<Wisdom.Types.UpdateQuickResponseResponse, AWSError>;
/**
* Updates an existing Wisdom quick response.
*/
updateQuickResponse(callback?: (err: AWSError, data: Wisdom.Types.UpdateQuickResponseResponse) => void): Request<Wisdom.Types.UpdateQuickResponseResponse, AWSError>;
}
declare namespace Wisdom {
export interface AppIntegrationsConfiguration {
/**
* The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content. For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields. For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields. For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields. For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt. For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name. The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.
*/
appIntegrationArn: GenericArn;
/**
* The fields from the source that are made available to your agents in Wisdom. Optional if ObjectConfiguration is included in the provided DataIntegration. For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted. For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active. For Zendesk, you must include at least id, title, updated_at, and draft. Make sure to include additional fields. These fields are indexed and used to source recommendations.
*/
objectFields?: ObjectFieldsList;
}
export type Arn = string;
export interface AssistantAssociationData {
/**
* The Amazon Resource Name (ARN) of the Wisdom assistant.
*/
assistantArn: Arn;
/**
* The Amazon Resource Name (ARN) of the assistant association.
*/
assistantAssociationArn: Arn;
/**
* The identifier of the assistant association.
*/
assistantAssociationId: Uuid;
/**
* The identifier of the Wisdom assistant.
*/
assistantId: Uuid;
/**
* A union type that currently has a single argument, the knowledge base ID.
*/
associationData: AssistantAssociationOutputData;
/**
* The type of association.
*/
associationType: AssociationType;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
}
export interface AssistantAssociationInputData {
/**
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
*/
knowledgeBaseId?: Uuid;
}
export interface AssistantAssociationOutputData {
/**
* The knowledge base where output data is sent.
*/
knowledgeBaseAssociation?: KnowledgeBaseAssociationData;
}
export interface AssistantAssociationSummary {
/**
* The Amazon Resource Name (ARN) of the Wisdom assistant.
*/
assistantArn: Arn;
/**
* The Amazon Resource Name (ARN) of the assistant association.
*/
assistantAssociationArn: Arn;
/**
* The identifier of the assistant association.
*/
assistantAssociationId: Uuid;
/**
* The identifier of the Wisdom assistant.
*/
assistantId: Uuid;
/**
* The association data.
*/
associationData: AssistantAssociationOutputData;
/**
* The type of association.
*/
associationType: AssociationType;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
}
export type AssistantAssociationSummaryList = AssistantAssociationSummary[];
export interface AssistantData {
/**
* The Amazon Resource Name (ARN) of the Wisdom assistant.
*/
assistantArn: Arn;
/**
* The identifier of the Wisdom assistant.
*/
assistantId: Uuid;
/**
* The description.
*/
description?: Description;
/**
* The configuration information for the Wisdom assistant integration.
*/
integrationConfiguration?: AssistantIntegrationConfiguration;
/**
* The name.
*/
name: Name;
/**
* The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
*/
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
/**
* The status of the assistant.
*/
status: AssistantStatus;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
/**
* The type of assistant.
*/
type: AssistantType;
}
export interface AssistantIntegrationConfiguration {
/**
* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
*/
topicIntegrationArn?: GenericArn;
}
export type AssistantList = AssistantSummary[];
export type AssistantStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"ACTIVE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETED"|string;
export interface AssistantSummary {
/**
* The Amazon Resource Name (ARN) of the Wisdom assistant.
*/
assistantArn: Arn;
/**
* The identifier of the Wisdom assistant.
*/
assistantId: Uuid;
/**
* The description of the assistant.
*/
description?: Description;
/**
* The configuration information for the Wisdom assistant integration.
*/
integrationConfiguration?: AssistantIntegrationConfiguration;
/**
* The name of the assistant.
*/
name: Name;
/**
* The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
*/
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
/**
* The status of the assistant.
*/
status: AssistantStatus;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
/**
* The type of the assistant.
*/
type: AssistantType;
}
export type AssistantType = "AGENT"|string;
export type AssociationType = "KNOWLEDGE_BASE"|string;
export type Boolean = boolean;
export type Channel = string;
export type Channels = Channel[];
export type ClientToken = string;
export interface Configuration {
/**
* The configuration information of the Amazon Connect data source.
*/
connectConfiguration?: ConnectConfiguration;
}
export interface ConnectConfiguration {
/**
* The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
*/
instanceId?: NonEmptyString;
}
export type ContactAttributeKey = string;
export type ContactAttributeKeys = ContactAttributeKey[];
export type ContactAttributeValue = string;
export type ContactAttributes = {[key: string]: ContactAttributeValue};
export interface ContentData {
/**
* The Amazon Resource Name (ARN) of the content.
*/
contentArn: Arn;
/**
* The identifier of the content.
*/
contentId: Uuid;
/**
* The media type of the content.
*/
contentType: ContentType;
/**
* The Amazon Resource Name (ARN) of the knowledge base.
*/
knowledgeBaseArn: Arn;
/**
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
*/
knowledgeBaseId: Uuid;
/**
* The URI of the content.
*/
linkOutUri?: Uri;
/**
* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
*/
metadata: ContentMetadata;
/**
* The name of the content.
*/
name: Name;
/**
* The identifier of the content revision.
*/
revisionId: NonEmptyString;
/**
* The status of the content.
*/
status: ContentStatus;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
/**
* The title of the content.
*/
title: ContentTitle;
/**
* The URL of the content.
*/
url: Url;
/**
* The expiration time of the URL as an epoch timestamp.
*/
urlExpiry: SyntheticTimestamp_epoch_seconds;
}
export type ContentMetadata = {[key: string]: NonEmptyString};
export interface ContentReference {
/**
* The Amazon Resource Name (ARN) of the content.
*/
contentArn?: Arn;
/**
* The identifier of the content.
*/
contentId?: Uuid;
/**
* The Amazon Resource Name (ARN) of the knowledge base.
*/
knowledgeBaseArn?: Arn;
/**
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
*/
knowledgeBaseId?: Uuid;
}
export type ContentStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"ACTIVE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETED"|"UPDATE_FAILED"|string;
export interface ContentSummary {
/**
* The Amazon Resource Name (ARN) of the content.
*/
contentArn: Arn;
/**
* The identifier of the content.
*/
contentId: Uuid;
/**
* The media type of the content.
*/
contentType: ContentType;
/**
* The Amazon Resource Name (ARN) of the knowledge base.
*/
knowledgeBaseArn: Arn;
/**
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
*/
knowledgeBaseId: Uuid;
/**
* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
*/
metadata: ContentMetadata;
/**
* The name of the content.
*/
name: Name;
/**
* The identifier of the revision of the content.
*/
revisionId: NonEmptyString;
/**
* The status of the content.
*/
status: ContentStatus;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
/**
* The title of the content.
*/
title: ContentTitle;
}
export type ContentSummaryList = ContentSummary[];
export type ContentTitle = string;
export type ContentType = string;
export interface CreateAssistantAssociationRequest {
/**
* The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
assistantId: UuidOrArn;
/**
* The identifier of the associated resource.
*/
association: AssistantAssociationInputData;
/**
* The type of association.
*/
associationType: AssociationType;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
*/
clientToken?: ClientToken;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
}
export interface CreateAssistantAssociationResponse {
/**
* The assistant association.
*/
assistantAssociation?: AssistantAssociationData;
}
export interface CreateAssistantRequest {
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
*/
clientToken?: ClientToken;
/**
* The description of the assistant.
*/
description?: Description;
/**
* The name of the assistant.
*/
name: Name;
/**
* The configuration information for the customer managed key used for encryption. The customer managed key must have a policy that allows kms:CreateGrant, kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
*/
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
/**
* The type of assistant.
*/
type: AssistantType;
}
export interface CreateAssistantResponse {
/**
* Information about the assistant.
*/
assistant?: AssistantData;
}
export interface CreateContentRequest {
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
*/
clientToken?: NonEmptyString;
/**
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
knowledgeBaseId: UuidOrArn;
/**
* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
*/
metadata?: ContentMetadata;
/**
* The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.
*/
name: Name;
/**
* The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.
*/
overrideLinkOutUri?: Uri;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
/**
* The title of the content. If not set, the title is equal to the name.
*/
title?: ContentTitle;
/**
* A pointer to the uploaded asset. This value is returned by StartContentUpload.
*/
uploadId: UploadId;
}
export interface CreateContentResponse {
/**
* The content.
*/
content?: ContentData;
}
export interface CreateKnowledgeBaseRequest {
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
*/
clientToken?: NonEmptyString;
/**
* The description.
*/
description?: Description;
/**
* The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
*/
knowledgeBaseType: KnowledgeBaseType;
/**
* The name of the knowledge base.
*/
name: Name;
/**
* Information about how to render the content.
*/
renderingConfiguration?: RenderingConfiguration;
/**
* The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
*/
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
/**
* The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.
*/
sourceConfiguration?: SourceConfiguration;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
}
export interface CreateKnowledgeBaseResponse {
/**
* The knowledge base.
*/
knowledgeBase?: KnowledgeBaseData;
}
export interface CreateQuickResponseRequest {
/**
* The Amazon Connect channels this quick response applies to.
*/
channels?: Channels;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
*/
clientToken?: NonEmptyString;
/**
* The content of the quick response.
*/
content: QuickResponseDataProvider;
/**
* The media type of the quick response content. Use application/x.quickresponse;format=plain for a quick response written in plain text. Use application/x.quickresponse;format=markdown for a quick response written in richtext.
*/
contentType?: QuickResponseType;
/**
* The description of the quick response.
*/
description?: QuickResponseDescription;
/**
* The configuration information of the user groups that the quick response is accessible to.
*/
groupingConfiguration?: GroupingConfiguration;
/**
* Whether the quick response is active.
*/
isActive?: Boolean;
/**
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
knowledgeBaseId: UuidOrArn;
/**
* The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
*/
language?: LanguageCode;
/**
* The name of the quick response.
*/
name: QuickResponseName;
/**
* The shortcut key of the quick response. The value should be unique across the knowledge base.
*/
shortcutKey?: ShortCutKey;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
}
export interface CreateQuickResponseResponse {
/**
* The quick response.
*/
quickResponse?: QuickResponseData;
}
export interface CreateSessionRequest {
/**
* The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
assistantId: UuidOrArn;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
*/
clientToken?: ClientToken;
/**
* The description.
*/
description?: Description;
/**
* The name of the session.
*/
name: Name;
/**
* The tags used to organize, track, or control access for this resource.
*/
tags?: Tags;
}
export interface CreateSessionResponse {
/**
* The session.
*/
session?: SessionData;
}
export interface DeleteAssistantAssociationRequest {
/**
* The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
assistantAssociationId: UuidOrArn;
/**
* The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
assistantId: UuidOrArn;
}
export interface DeleteAssistantAssociationResponse {
}
export interface DeleteAssistantRequest {
/**
* The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
assistantId: UuidOrArn;
}
export interface DeleteAssistantResponse {
}
export interface DeleteContentRequest {
/**
* The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
contentId: UuidOrArn;
/**
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
knowledgeBaseId: UuidOrArn;
}
export interface DeleteContentResponse {
}
export interface DeleteImportJobRequest {
/**
* The identifier of the import job to be deleted.
*/
importJobId: Uuid;
/**
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
*/
knowledgeBaseId: UuidOrArn;
}
export interface DeleteImportJobResponse {
}
export interface DeleteKnowledgeBaseRequest {
/**
* The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
knowledgeBaseId: UuidOrArn;
}
export interface DeleteKnowledgeBaseResponse {
}
export interface DeleteQuickResponseRequest {
/**
* The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
*/
knowledgeBaseId: UuidOrArn;
/**
* T