Wisdom

import { Wisdom } from "https://aws-api.deno.dev/v0.3/services/wisdom.ts?docs=full";

class Wisdom {

constructor(apiFactory: client.ApiFactory);

async createAssistant(params: CreateAssistantRequest, opts?: client.RequestOptions): Promise<CreateAssistantResponse>;

async createAssistantAssociation(params: CreateAssistantAssociationRequest, opts?: client.RequestOptions): Promise<CreateAssistantAssociationResponse>;

async createContent(params: CreateContentRequest, opts?: client.RequestOptions): Promise<CreateContentResponse>;

async createKnowledgeBase(params: CreateKnowledgeBaseRequest, opts?: client.RequestOptions): Promise<CreateKnowledgeBaseResponse>;

async createSession(params: CreateSessionRequest, opts?: client.RequestOptions): Promise<CreateSessionResponse>;

async deleteAssistant(params: DeleteAssistantRequest, opts?: client.RequestOptions): Promise<void>;

async deleteAssistantAssociation(params: DeleteAssistantAssociationRequest, opts?: client.RequestOptions): Promise<void>;

async deleteContent(params: DeleteContentRequest, opts?: client.RequestOptions): Promise<void>;

async deleteKnowledgeBase(params: DeleteKnowledgeBaseRequest, opts?: client.RequestOptions): Promise<void>;

async getAssistant(params: GetAssistantRequest, opts?: client.RequestOptions): Promise<GetAssistantResponse>;

async getAssistantAssociation(params: GetAssistantAssociationRequest, opts?: client.RequestOptions): Promise<GetAssistantAssociationResponse>;

async getContent(params: GetContentRequest, opts?: client.RequestOptions): Promise<GetContentResponse>;

async getContentSummary(params: GetContentSummaryRequest, opts?: client.RequestOptions): Promise<GetContentSummaryResponse>;

async getKnowledgeBase(params: GetKnowledgeBaseRequest, opts?: client.RequestOptions): Promise<GetKnowledgeBaseResponse>;

async getRecommendations(params: GetRecommendationsRequest, opts?: client.RequestOptions): Promise<GetRecommendationsResponse>;

async getSession(params: GetSessionRequest, opts?: client.RequestOptions): Promise<GetSessionResponse>;

async listAssistantAssociations(params: ListAssistantAssociationsRequest, opts?: client.RequestOptions): Promise<ListAssistantAssociationsResponse>;

async listAssistants(params?: ListAssistantsRequest, opts?: client.RequestOptions): Promise<ListAssistantsResponse>;

async listContents(params: ListContentsRequest, opts?: client.RequestOptions): Promise<ListContentsResponse>;

async listKnowledgeBases(params?: ListKnowledgeBasesRequest, opts?: client.RequestOptions): Promise<ListKnowledgeBasesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async notifyRecommendationsReceived(params: NotifyRecommendationsReceivedRequest, opts?: client.RequestOptions): Promise<NotifyRecommendationsReceivedResponse>;

async queryAssistant(params: QueryAssistantRequest, opts?: client.RequestOptions): Promise<QueryAssistantResponse>;

async removeKnowledgeBaseTemplateUri(params: RemoveKnowledgeBaseTemplateUriRequest, opts?: client.RequestOptions): Promise<void>;

async searchContent(params: SearchContentRequest, opts?: client.RequestOptions): Promise<SearchContentResponse>;

async searchSessions(params: SearchSessionsRequest, opts?: client.RequestOptions): Promise<SearchSessionsResponse>;

async startContentUpload(params: StartContentUploadRequest, opts?: client.RequestOptions): Promise<StartContentUploadResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateContent(params: UpdateContentRequest, opts?: client.RequestOptions): Promise<UpdateContentResponse>;

async updateKnowledgeBaseTemplateUri(params: UpdateKnowledgeBaseTemplateUriRequest, opts?: client.RequestOptions): Promise<UpdateKnowledgeBaseTemplateUriResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Wisdom(apiFactory: client.ApiFactory)

[src]

§Methods

createAssistant(params: CreateAssistantRequest, opts?: client.RequestOptions): Promise<CreateAssistantResponse>

[src]

Creates an Amazon Connect Wisdom assistant.

createAssistantAssociation(params: CreateAssistantAssociationRequest, opts?: client.RequestOptions): Promise<CreateAssistantAssociationResponse>

[src]

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.

createContent(params: CreateContentRequest, opts?: client.RequestOptions): Promise<CreateContentResponse>

[src]

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

createKnowledgeBase(params: CreateKnowledgeBaseRequest, opts?: client.RequestOptions): Promise<CreateKnowledgeBaseResponse>

[src]

TODO: Failed to render documentation: unhandled top level doc tag pre

createSession(params: CreateSessionRequest, opts?: client.RequestOptions): Promise<CreateSessionResponse>

[src]

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.

deleteAssistant(params: DeleteAssistantRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an assistant.

deleteAssistantAssociation(params: DeleteAssistantAssociationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an assistant association.

deleteContent(params: DeleteContentRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the content.

deleteKnowledgeBase(params: DeleteKnowledgeBaseRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the knowledge base.

Note: 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.

getAssistant(params: GetAssistantRequest, opts?: client.RequestOptions): Promise<GetAssistantResponse>

[src]

Retrieves information about an assistant.

getAssistantAssociation(params: GetAssistantAssociationRequest, opts?: client.RequestOptions): Promise<GetAssistantAssociationResponse>

[src]

Retrieves information about an assistant association.

getContent(params: GetContentRequest, opts?: client.RequestOptions): Promise<GetContentResponse>

[src]

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

getContentSummary(params: GetContentSummaryRequest, opts?: client.RequestOptions): Promise<GetContentSummaryResponse>

[src]

Retrieves summary information about the content.

getKnowledgeBase(params: GetKnowledgeBaseRequest, opts?: client.RequestOptions): Promise<GetKnowledgeBaseResponse>

[src]

Retrieves information about the knowledge base.

getRecommendations(params: GetRecommendationsRequest, opts?: client.RequestOptions): Promise<GetRecommendationsResponse>

[src]

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.

getSession(params: GetSessionRequest, opts?: client.RequestOptions): Promise<GetSessionResponse>

[src]

Retrieves information for a specified session.

listAssistantAssociations(params: ListAssistantAssociationsRequest, opts?: client.RequestOptions): Promise<ListAssistantAssociationsResponse>

[src]

Lists information about assistant associations.

listAssistants(params?: ListAssistantsRequest, opts?: client.RequestOptions): Promise<ListAssistantsResponse>

[src]

Lists information about assistants.

listContents(params: ListContentsRequest, opts?: client.RequestOptions): Promise<ListContentsResponse>

[src]

Lists the content.

listKnowledgeBases(params?: ListKnowledgeBasesRequest, opts?: client.RequestOptions): Promise<ListKnowledgeBasesResponse>

[src]

Lists the knowledge bases.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists the tags for the specified resource.

notifyRecommendationsReceived(params: NotifyRecommendationsReceivedRequest, opts?: client.RequestOptions): Promise<NotifyRecommendationsReceivedResponse>

[src]

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.

queryAssistant(params: QueryAssistantRequest, opts?: client.RequestOptions): Promise<QueryAssistantResponse>

[src]

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

removeKnowledgeBaseTemplateUri(params: RemoveKnowledgeBaseTemplateUriRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes a URI template from a knowledge base.

searchContent(params: SearchContentRequest, opts?: client.RequestOptions): Promise<SearchContentResponse>

[src]

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

searchSessions(params: SearchSessionsRequest, opts?: client.RequestOptions): Promise<SearchSessionsResponse>

[src]

Searches for sessions.

startContentUpload(params: StartContentUploadRequest, opts?: client.RequestOptions): Promise<StartContentUploadResponse>

[src]

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.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds the specified tags to the specified resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes the specified tags from the specified resource.

updateContent(params: UpdateContentRequest, opts?: client.RequestOptions): Promise<UpdateContentResponse>

[src]

Updates information about the content.

updateKnowledgeBaseTemplateUri(params: UpdateKnowledgeBaseTemplateUriRequest, opts?: client.RequestOptions): Promise<UpdateKnowledgeBaseTemplateUriResponse>

[src]

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.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]