qconnect/aws.sdk.kotlin.services.qconnect

Package-level declarations

Types

Link copied to clipboard
interface QConnectClient : SdkClient

Powered by Amazon Bedrock: Amazon Web Services implements automated abuse detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI).

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun QConnectClient.createAssistant(crossinline block: CreateAssistantRequest.Builder.() -> Unit): CreateAssistantResponse

Creates an Amazon Q in Connect assistant.

Link copied to clipboard
inline suspend fun QConnectClient.createAssistantAssociation(crossinline block: CreateAssistantAssociationRequest.Builder.() -> Unit): CreateAssistantAssociationResponse

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.

Link copied to clipboard
inline suspend fun QConnectClient.createContent(crossinline block: CreateContentRequest.Builder.() -> Unit): CreateContentResponse

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

Link copied to clipboard
inline suspend fun QConnectClient.createKnowledgeBase(crossinline block: CreateKnowledgeBaseRequest.Builder.() -> Unit): CreateKnowledgeBaseResponse

Creates a knowledge base.

Link copied to clipboard
inline suspend fun QConnectClient.createQuickResponse(crossinline block: CreateQuickResponseRequest.Builder.() -> Unit): CreateQuickResponseResponse

Creates an Amazon Q quick response.

Link copied to clipboard
inline suspend fun QConnectClient.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 Amazon Q session for each contact on which Amazon Q is enabled.

Link copied to clipboard
inline suspend fun QConnectClient.deleteAssistant(crossinline block: DeleteAssistantRequest.Builder.() -> Unit): DeleteAssistantResponse

Deletes an assistant.

Link copied to clipboard
inline suspend fun QConnectClient.deleteAssistantAssociation(crossinline block: DeleteAssistantAssociationRequest.Builder.() -> Unit): DeleteAssistantAssociationResponse

Deletes an assistant association.

Link copied to clipboard
inline suspend fun QConnectClient.deleteContent(crossinline block: DeleteContentRequest.Builder.() -> Unit): DeleteContentResponse

Deletes the content.

Link copied to clipboard
inline suspend fun QConnectClient.deleteImportJob(crossinline block: DeleteImportJobRequest.Builder.() -> Unit): DeleteImportJobResponse

Deletes the quick response import job.

Link copied to clipboard
inline suspend fun QConnectClient.deleteKnowledgeBase(crossinline block: DeleteKnowledgeBaseRequest.Builder.() -> Unit): DeleteKnowledgeBaseResponse

Deletes the knowledge base.

Link copied to clipboard
inline suspend fun QConnectClient.deleteQuickResponse(crossinline block: DeleteQuickResponseRequest.Builder.() -> Unit): DeleteQuickResponseResponse

Deletes a quick response.

Link copied to clipboard
inline suspend fun QConnectClient.getAssistant(crossinline block: GetAssistantRequest.Builder.() -> Unit): GetAssistantResponse

Retrieves information about an assistant.

Link copied to clipboard
inline suspend fun QConnectClient.getAssistantAssociation(crossinline block: GetAssistantAssociationRequest.Builder.() -> Unit): GetAssistantAssociationResponse

Retrieves information about an assistant association.

Link copied to clipboard
inline suspend fun QConnectClient.getContent(crossinline block: GetContentRequest.Builder.() -> Unit): GetContentResponse

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

Link copied to clipboard
inline suspend fun QConnectClient.getContentSummary(crossinline block: GetContentSummaryRequest.Builder.() -> Unit): GetContentSummaryResponse

Retrieves summary information about the content.

Link copied to clipboard
inline suspend fun QConnectClient.getImportJob(crossinline block: GetImportJobRequest.Builder.() -> Unit): GetImportJobResponse

Retrieves the started import job.

Link copied to clipboard
inline suspend fun QConnectClient.getKnowledgeBase(crossinline block: GetKnowledgeBaseRequest.Builder.() -> Unit): GetKnowledgeBaseResponse

Retrieves information about the knowledge base.

Link copied to clipboard
inline suspend fun QConnectClient.getQuickResponse(crossinline block: GetQuickResponseRequest.Builder.() -> Unit): GetQuickResponseResponse

Retrieves the quick response.

Link copied to clipboard
inline suspend fun QConnectClient.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.

Link copied to clipboard
inline suspend fun QConnectClient.getSession(crossinline block: GetSessionRequest.Builder.() -> Unit): GetSessionResponse

Retrieves information for a specified session.

Link copied to clipboard
inline suspend fun QConnectClient.listAssistantAssociations(crossinline block: ListAssistantAssociationsRequest.Builder.() -> Unit): ListAssistantAssociationsResponse

Lists information about assistant associations.

Link copied to clipboard
inline suspend fun QConnectClient.listAssistants(crossinline block: ListAssistantsRequest.Builder.() -> Unit): ListAssistantsResponse

Lists information about assistants.

Link copied to clipboard
inline suspend fun QConnectClient.listContents(crossinline block: ListContentsRequest.Builder.() -> Unit): ListContentsResponse

Lists the content.

Link copied to clipboard
inline suspend fun QConnectClient.listImportJobs(crossinline block: ListImportJobsRequest.Builder.() -> Unit): ListImportJobsResponse

Lists information about import jobs.

Link copied to clipboard
inline suspend fun QConnectClient.listKnowledgeBases(crossinline block: ListKnowledgeBasesRequest.Builder.() -> Unit): ListKnowledgeBasesResponse

Lists the knowledge bases.

Link copied to clipboard
inline suspend fun QConnectClient.listQuickResponses(crossinline block: ListQuickResponsesRequest.Builder.() -> Unit): ListQuickResponsesResponse

Lists information about quick response.

Link copied to clipboard
inline suspend fun QConnectClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags for the specified resource.

Link copied to clipboard
inline suspend fun QConnectClient.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.

Link copied to clipboard
inline suspend fun QConnectClient.putFeedback(crossinline block: PutFeedbackRequest.Builder.() -> Unit): PutFeedbackResponse

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

Link copied to clipboard
inline suspend fun QConnectClient.queryAssistant(crossinline block: QueryAssistantRequest.Builder.() -> Unit): QueryAssistantResponse

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

Link copied to clipboard
inline suspend fun QConnectClient.removeKnowledgeBaseTemplateUri(crossinline block: RemoveKnowledgeBaseTemplateUriRequest.Builder.() -> Unit): RemoveKnowledgeBaseTemplateUriResponse

Removes a URI template from a knowledge base.

Link copied to clipboard
inline suspend fun QConnectClient.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.

Link copied to clipboard
inline suspend fun QConnectClient.searchQuickResponses(crossinline block: SearchQuickResponsesRequest.Builder.() -> Unit): SearchQuickResponsesResponse

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

Link copied to clipboard
inline suspend fun QConnectClient.searchSessions(crossinline block: SearchSessionsRequest.Builder.() -> Unit): SearchSessionsResponse

Searches for sessions.

Link copied to clipboard
inline suspend fun QConnectClient.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.

Link copied to clipboard
inline suspend fun QConnectClient.startImportJob(crossinline block: StartImportJobRequest.Builder.() -> Unit): StartImportJobResponse

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

Link copied to clipboard
inline suspend fun QConnectClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds the specified tags to the specified resource.

Link copied to clipboard
inline suspend fun QConnectClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the specified tags from the specified resource.

Link copied to clipboard
inline suspend fun QConnectClient.updateContent(crossinline block: UpdateContentRequest.Builder.() -> Unit): UpdateContentResponse

Updates information about the content.

Link copied to clipboard
inline suspend fun QConnectClient.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 Amazon Q 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.

Link copied to clipboard
inline suspend fun QConnectClient.updateQuickResponse(crossinline block: UpdateQuickResponseRequest.Builder.() -> Unit): UpdateQuickResponseResponse

Updates an existing Amazon Q quick response.

Link copied to clipboard
fun QConnectClient.withConfig(block: QConnectClient.Config.Builder.() -> Unit): QConnectClient

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.