QueryResultItem

import type { QueryResultItem } from "https://aws-api.deno.dev/v0.3/services/kendra.ts?docs=full";

A single query result.

A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.

interface QueryResultItem {

AdditionalAttributes?: AdditionalResultAttribute[] | null;

DocumentAttributes?: DocumentAttribute[] | null;

DocumentExcerpt?: TextWithHighlights | null;

DocumentId?: string | null;

DocumentTitle?: TextWithHighlights | null;

DocumentURI?: string | null;

FeedbackToken?: string | null;

Id?: string | null;

ScoreAttributes?: ScoreAttributes | null;

Type?: QueryResultType | null;

}

§Properties

AdditionalAttributes?: AdditionalResultAttribute[] | null

[src]

One or more additional attributes associated with the query result.

DocumentAttributes?: DocumentAttribute[] | null

[src]

An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.

DocumentExcerpt?: TextWithHighlights | null

[src]

An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

DocumentId?: string | null

[src]

The unique identifier for the document.

DocumentTitle?: TextWithHighlights | null

[src]

The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

DocumentURI?: string | null

[src]

The URI of the original location of the document.

FeedbackToken?: string | null

[src]

A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.

Id?: string | null

[src]

The unique identifier for the query result.

ScoreAttributes?: ScoreAttributes | null

[src]

Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.

Type?: QueryResultType | null

[src]

The type of document.