kendraranking/aws.sdk.kotlin.services.kendraranking

Package-level declarations

Types

Link copied to clipboard
interface KendraRankingClient : SdkClient

Amazon Kendra Intelligent Ranking uses Amazon Kendra semantic search capabilities to intelligently re-rank a search service's results.

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 KendraRankingClient.createRescoreExecutionPlan(crossinline block: CreateRescoreExecutionPlanRequest.Builder.() -> Unit): CreateRescoreExecutionPlanResponse

Creates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You set the number of capacity units that you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results.

Link copied to clipboard
inline suspend fun KendraRankingClient.deleteRescoreExecutionPlan(crossinline block: DeleteRescoreExecutionPlanRequest.Builder.() -> Unit): DeleteRescoreExecutionPlanResponse

Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Link copied to clipboard
inline suspend fun KendraRankingClient.describeRescoreExecutionPlan(crossinline block: DescribeRescoreExecutionPlanRequest.Builder.() -> Unit): DescribeRescoreExecutionPlanResponse

Gets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Link copied to clipboard
inline suspend fun KendraRankingClient.listRescoreExecutionPlans(crossinline block: ListRescoreExecutionPlansRequest.Builder.() -> Unit): ListRescoreExecutionPlansResponse

Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

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

Gets a list of tags associated with a specified resource. A rescore execution plan is an example of a resource that can have tags associated with it.

Link copied to clipboard
inline suspend fun KendraRankingClient.rescore(crossinline block: RescoreRequest.Builder.() -> Unit): RescoreResponse

Rescores or re-ranks search results from a search service such as OpenSearch (self managed). You use the semantic search capabilities of Amazon Kendra Intelligent Ranking to improve the search service's results.

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

Adds a specified tag to a specified rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. If the tag already exists, the existing value is replaced with the new value.

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

Removes a tag from a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore operation.

Link copied to clipboard
inline suspend fun KendraRankingClient.updateRescoreExecutionPlan(crossinline block: UpdateRescoreExecutionPlanRequest.Builder.() -> Unit): UpdateRescoreExecutionPlanResponse

Updates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can update the number of capacity units you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results.

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

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.