Highlight

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

Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

interface Highlight {

BeginOffset: number;

EndOffset: number;

TopAnswer?: boolean | null;

Type?: HighlightType | null;

}

§Properties

BeginOffset: number

The zero-based location in the response string where the highlight starts.

EndOffset: number

The zero-based location in the response string where the highlight ends.

TopAnswer?: boolean | null

Indicates whether the response is the best response. True if this is the best response; otherwise, false.

Type?: HighlightType | null

The highlight type.