wisdom/aws.sdk.kotlin.services.wisdom

Package-level declarations

Types

Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers. Agents can search across connected repositories from within their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a knowledge base, for example, or manage content by uploading custom files.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createAssistant

inline suspend fun WisdomClient.createAssistant(crossinline block: CreateAssistantRequest.Builder.() -> Unit): CreateAssistantResponse

Creates an Amazon Connect Wisdom assistant.

createAssistantAssociation

inline suspend fun WisdomClient.createAssistantAssociation(crossinline block: CreateAssistantAssociationRequest.Builder.() -> Unit): CreateAssistantAssociationResponse

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

inline suspend fun WisdomClient.createContent(crossinline block: CreateContentRequest.Builder.() -> Unit): CreateContentResponse

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

createKnowledgeBase

inline suspend fun WisdomClient.createKnowledgeBase(crossinline block: CreateKnowledgeBaseRequest.Builder.() -> Unit): CreateKnowledgeBaseResponse

Creates a knowledge base.

createQuickResponse

inline suspend fun WisdomClient.createQuickResponse(crossinline block: CreateQuickResponseRequest.Builder.() -> Unit): CreateQuickResponseResponse

Creates a Wisdom quick response.

createSession

inline suspend fun WisdomClient.createSession(crossinline block: CreateSessionRequest.Builder.() -> Unit): CreateSessionResponse

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

inline suspend fun WisdomClient.deleteAssistant(crossinline block: DeleteAssistantRequest.Builder.() -> Unit): DeleteAssistantResponse

Deletes an assistant.

deleteAssistantAssociation

inline suspend fun WisdomClient.deleteAssistantAssociation(crossinline block: DeleteAssistantAssociationRequest.Builder.() -> Unit): DeleteAssistantAssociationResponse

Deletes an assistant association.

deleteContent

inline suspend fun WisdomClient.deleteContent(crossinline block: DeleteContentRequest.Builder.() -> Unit): DeleteContentResponse

Deletes the content.

deleteImportJob

inline suspend fun WisdomClient.deleteImportJob(crossinline block: DeleteImportJobRequest.Builder.() -> Unit): DeleteImportJobResponse

Deletes the quick response import job.

deleteKnowledgeBase

inline suspend fun WisdomClient.deleteKnowledgeBase(crossinline block: DeleteKnowledgeBaseRequest.Builder.() -> Unit): DeleteKnowledgeBaseResponse

Deletes the knowledge base.

deleteQuickResponse

inline suspend fun WisdomClient.deleteQuickResponse(crossinline block: DeleteQuickResponseRequest.Builder.() -> Unit): DeleteQuickResponseResponse

Deletes a quick response.

getAssistant

inline suspend fun WisdomClient.getAssistant(crossinline block: GetAssistantRequest.Builder.() -> Unit): GetAssistantResponse

Retrieves information about an assistant.

getAssistantAssociation

inline suspend fun WisdomClient.getAssistantAssociation(crossinline block: GetAssistantAssociationRequest.Builder.() -> Unit): GetAssistantAssociationResponse

Retrieves information about an assistant association.

getContent

inline suspend fun WisdomClient.getContent(crossinline block: GetContentRequest.Builder.() -> Unit): GetContentResponse

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

getContentSummary

inline suspend fun WisdomClient.getContentSummary(crossinline block: GetContentSummaryRequest.Builder.() -> Unit): GetContentSummaryResponse

Retrieves summary information about the content.

getImportJob

inline suspend fun WisdomClient.getImportJob(crossinline block: GetImportJobRequest.Builder.() -> Unit): GetImportJobResponse

Retrieves the started import job.

getKnowledgeBase

inline suspend fun WisdomClient.getKnowledgeBase(crossinline block: GetKnowledgeBaseRequest.Builder.() -> Unit): GetKnowledgeBaseResponse

Retrieves information about the knowledge base.

getQuickResponse

inline suspend fun WisdomClient.getQuickResponse(crossinline block: GetQuickResponseRequest.Builder.() -> Unit): GetQuickResponseResponse

Retrieves the quick response.

getRecommendations

inline suspend fun WisdomClient.~~getRecommendations~~(crossinline block: GetRecommendationsRequest.Builder.() -> Unit): GetRecommendationsResponse

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

inline suspend fun WisdomClient.getSession(crossinline block: GetSessionRequest.Builder.() -> Unit): GetSessionResponse

Retrieves information for a specified session.

listAssistantAssociations

inline suspend fun WisdomClient.listAssistantAssociations(crossinline block: ListAssistantAssociationsRequest.Builder.() -> Unit): ListAssistantAssociationsResponse

Lists information about assistant associations.

listAssistants

inline suspend fun WisdomClient.listAssistants(crossinline block: ListAssistantsRequest.Builder.() -> Unit): ListAssistantsResponse

Lists information about assistants.

listContents

inline suspend fun WisdomClient.listContents(crossinline block: ListContentsRequest.Builder.() -> Unit): ListContentsResponse

Lists the content.

listImportJobs

inline suspend fun WisdomClient.listImportJobs(crossinline block: ListImportJobsRequest.Builder.() -> Unit): ListImportJobsResponse

Lists information about import jobs.

listKnowledgeBases

inline suspend fun WisdomClient.listKnowledgeBases(crossinline block: ListKnowledgeBasesRequest.Builder.() -> Unit): ListKnowledgeBasesResponse

Lists the knowledge bases.

listQuickResponses

inline suspend fun WisdomClient.listQuickResponses(crossinline block: ListQuickResponsesRequest.Builder.() -> Unit): ListQuickResponsesResponse

Lists information about quick response.

listTagsForResource

inline suspend fun WisdomClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags for the specified resource.

notifyRecommendationsReceived

inline suspend fun WisdomClient.notifyRecommendationsReceived(crossinline block: NotifyRecommendationsReceivedRequest.Builder.() -> Unit): NotifyRecommendationsReceivedResponse

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

inline suspend fun WisdomClient.~~queryAssistant~~(crossinline block: QueryAssistantRequest.Builder.() -> Unit): QueryAssistantResponse

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

removeKnowledgeBaseTemplateUri

inline suspend fun WisdomClient.removeKnowledgeBaseTemplateUri(crossinline block: RemoveKnowledgeBaseTemplateUriRequest.Builder.() -> Unit): RemoveKnowledgeBaseTemplateUriResponse

Removes a URI template from a knowledge base.

searchContent

inline suspend fun WisdomClient.searchContent(crossinline block: SearchContentRequest.Builder.() -> Unit): SearchContentResponse

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

searchQuickResponses

inline suspend fun WisdomClient.searchQuickResponses(crossinline block: SearchQuickResponsesRequest.Builder.() -> Unit): SearchQuickResponsesResponse

Searches existing Wisdom quick responses in a Wisdom knowledge base.

searchSessions

inline suspend fun WisdomClient.searchSessions(crossinline block: SearchSessionsRequest.Builder.() -> Unit): SearchSessionsResponse

Searches for sessions.

startContentUpload

inline suspend fun WisdomClient.startContentUpload(crossinline block: StartContentUploadRequest.Builder.() -> Unit): StartContentUploadResponse

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

inline suspend fun WisdomClient.startImportJob(crossinline block: StartImportJobRequest.Builder.() -> Unit): StartImportJobResponse

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.

tagResource

inline suspend fun WisdomClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds the specified tags to the specified resource.

untagResource

inline suspend fun WisdomClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the specified tags from the specified resource.

updateContent

inline suspend fun WisdomClient.updateContent(crossinline block: UpdateContentRequest.Builder.() -> Unit): UpdateContentResponse

Updates information about the content.

updateKnowledgeBaseTemplateUri

inline suspend fun WisdomClient.updateKnowledgeBaseTemplateUri(crossinline block: UpdateKnowledgeBaseTemplateUriRequest.Builder.() -> Unit): UpdateKnowledgeBaseTemplateUriResponse

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 http://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.

updateQuickResponse

inline suspend fun WisdomClient.updateQuickResponse(crossinline block: UpdateQuickResponseRequest.Builder.() -> Unit): UpdateQuickResponseResponse

Updates an existing Wisdom quick response.

withConfig

fun WisdomClient.withConfig(block: WisdomClient.Config.Builder.() -> Unit): WisdomClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.