QConnect

import { QConnect } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/qconnect.ts?docs=full";

class QConnect {

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 createContentAssociation(params: CreateContentAssociationRequest, opts?: client.RequestOptions): Promise<CreateContentAssociationResponse>;

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

async createQuickResponse(params: CreateQuickResponseRequest, opts?: client.RequestOptions): Promise<CreateQuickResponseResponse>;

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 deleteContentAssociation(params: DeleteContentAssociationRequest, opts?: client.RequestOptions): Promise<void>;

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

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

async deleteQuickResponse(params: DeleteQuickResponseRequest, 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 getContentAssociation(params: GetContentAssociationRequest, opts?: client.RequestOptions): Promise<GetContentAssociationResponse>;

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

async getImportJob(params: GetImportJobRequest, opts?: client.RequestOptions): Promise<GetImportJobResponse>;

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

async getQuickResponse(params: GetQuickResponseRequest, opts?: client.RequestOptions): Promise<GetQuickResponseResponse>;

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 listContentAssociations(params: ListContentAssociationsRequest, opts?: client.RequestOptions): Promise<ListContentAssociationsResponse>;

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

async listImportJobs(params: ListImportJobsRequest, opts?: client.RequestOptions): Promise<ListImportJobsResponse>;

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

async listQuickResponses(params: ListQuickResponsesRequest, opts?: client.RequestOptions): Promise<ListQuickResponsesResponse>;

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

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

async putFeedback(params: PutFeedbackRequest, opts?: client.RequestOptions): Promise<PutFeedbackResponse>;

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 searchQuickResponses(params: SearchQuickResponsesRequest, opts?: client.RequestOptions): Promise<SearchQuickResponsesResponse>;

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

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

async startImportJob(params: StartImportJobRequest, opts?: client.RequestOptions): Promise<StartImportJobResponse>;

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>;

async updateQuickResponse(params: UpdateQuickResponseRequest, opts?: client.RequestOptions): Promise<UpdateQuickResponseResponse>;

async updateSession(params: UpdateSessionRequest, opts?: client.RequestOptions): Promise<UpdateSessionResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new QConnect(apiFactory: client.ApiFactory)

[src]

§Methods

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

[src]

Creates an Amazon Q in Connect assistant.

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

[src]

Creates an association between an Amazon Q in Connect 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 Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.

createContentAssociation(params: CreateContentAssociationRequest, opts?: client.RequestOptions): Promise<CreateContentAssociationResponse>

[src]

Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides.

After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.

Note the following limitations:

You can create only one content association for each content resource in a knowledge base.
You can associate a step-by-step guide with multiple content resources.

For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

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

[src]

Creates a knowledge base.

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

createQuickResponse(params: CreateQuickResponseRequest, opts?: client.RequestOptions): Promise<CreateQuickResponseResponse>

[src]

Creates an Amazon Q in Connect quick response.

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 Amazon Q in Connect session for each contact on which Amazon Q in Connect 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.

deleteContentAssociation(params: DeleteContentAssociationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the content association.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

deleteImportJob(params: DeleteImportJobRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the quick response import job.

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.

deleteQuickResponse(params: DeleteQuickResponseRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a quick response.

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.

getContentAssociation(params: GetContentAssociationRequest, opts?: client.RequestOptions): Promise<GetContentAssociationResponse>

[src]

Returns the content association.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

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

[src]

Retrieves summary information about the content.

getImportJob(params: GetImportJobRequest, opts?: client.RequestOptions): Promise<GetImportJobResponse>

[src]

Retrieves the started import job.

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

[src]

Retrieves information about the knowledge base.

getQuickResponse(params: GetQuickResponseRequest, opts?: client.RequestOptions): Promise<GetQuickResponseResponse>

[src]

Retrieves the quick response.

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

[src]

! IMPORTANT: ! This API will be discontinued starting June 1, 2024. ! To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

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.

listContentAssociations(params: ListContentAssociationsRequest, opts?: client.RequestOptions): Promise<ListContentAssociationsResponse>

[src]

Lists the content associations.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

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

[src]

Lists the content.

listImportJobs(params: ListImportJobsRequest, opts?: client.RequestOptions): Promise<ListImportJobsResponse>

[src]

Lists information about import jobs.

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

[src]

Lists the knowledge bases.

listQuickResponses(params: ListQuickResponsesRequest, opts?: client.RequestOptions): Promise<ListQuickResponsesResponse>

[src]

Lists information about quick response.

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.

putFeedback(params: PutFeedbackRequest, opts?: client.RequestOptions): Promise<PutFeedbackResponse>

[src]

Provides feedback against the specified assistant for the specified target. This API only supports generative targets.

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.

searchQuickResponses(params: SearchQuickResponsesRequest, opts?: client.RequestOptions): Promise<SearchQuickResponsesResponse>

[src]

Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.

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.

startImportJob(params: StartImportJobRequest, opts?: client.RequestOptions): Promise<StartImportJobResponse>

[src]

Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.

For importing Amazon Q in Connect 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.

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 Amazon Q in Connect 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.

updateQuickResponse(params: UpdateQuickResponseRequest, opts?: client.RequestOptions): Promise<UpdateQuickResponseResponse>

[src]

Updates an existing Amazon Q in Connect quick response.

updateSession(params: UpdateSessionRequest, opts?: client.RequestOptions): Promise<UpdateSessionResponse>

[src]

Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]