Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

KendraRanking

import { KendraRanking } from "https://aws-api.deno.dev/v0.4/services/kendraranking.ts?docs=full";
class KendraRanking {
constructor(apiFactory: client.ApiFactory);
async createRescoreExecutionPlan(params: CreateRescoreExecutionPlanRequest, opts?: client.RequestOptions): Promise<CreateRescoreExecutionPlanResponse>;
async deleteRescoreExecutionPlan(params: DeleteRescoreExecutionPlanRequest, opts?: client.RequestOptions): Promise<void>;
async describeRescoreExecutionPlan(params: DescribeRescoreExecutionPlanRequest, opts?: client.RequestOptions): Promise<DescribeRescoreExecutionPlanResponse>;
async listRescoreExecutionPlans(params?: ListRescoreExecutionPlansRequest, opts?: client.RequestOptions): Promise<ListRescoreExecutionPlansResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async rescore(params: RescoreRequest, opts?: client.RequestOptions): Promise<RescoreResult>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateRescoreExecutionPlan(params: UpdateRescoreExecutionPlanRequest, opts?: client.RequestOptions): Promise<void>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new KendraRanking(apiFactory: client.ApiFactory)
[src]

§Methods

§
createRescoreExecutionPlan(params: CreateRescoreExecutionPlanRequest, opts?: client.RequestOptions): Promise<CreateRescoreExecutionPlanResponse>
[src]

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.

For an example of using the CreateRescoreExecutionPlan API, including using the Python and Java SDKs, see Semantically ranking a search service's results.

§
deleteRescoreExecutionPlan(params: DeleteRescoreExecutionPlanRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
describeRescoreExecutionPlan(params: DescribeRescoreExecutionPlanRequest, opts?: client.RequestOptions): Promise<DescribeRescoreExecutionPlanResponse>
[src]

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

§
listRescoreExecutionPlans(params?: ListRescoreExecutionPlansRequest, opts?: client.RequestOptions): Promise<ListRescoreExecutionPlansResponse>
[src]

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

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

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.

§
rescore(params: RescoreRequest, opts?: client.RequestOptions): Promise<RescoreResult>
[src]

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.

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

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.

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

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.

§
updateRescoreExecutionPlan(params: UpdateRescoreExecutionPlanRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

§Static Properties