Interface ConversationalSearchItemCitation

Citations for text generated by an AI to provide the user with relevant source information and context.

interface ConversationalSearchItemCitation {
    range_end?: number;
    range_start?: number;
    ranges?: { end: number; start: number }[];
    search_result_idx?: number;
    text?: string;
    title?: string;
    url?: string;
}

Properties

range_end? range_start? ranges? search_result_idx? text? title? url?

Properties

Optionalrange_end

range_end?: number

Optional zero index based integer indicating where in `text`` the citation ends at. Exclusive. So the word "hi", would have the range_start of 0 and range_end of 2.

Optionalrange_start

range_start?: number

Optional zero index based integer indicating where in text the citation starts from.

Optionalranges

ranges?: { end: number; start: number }[]

Optional array of ranges indicating where in text the citation is located.

Optionalsearch_result_idx

search_result_idx?: number

A number corresponding to the index of the matching search result. This can be used to gather extra info about a specific citation from the matching search result.

Optionaltext

text?: string

Optional explanation text for the citation.

Optionaltitle

title?: string

Optional title of the citation URL.

Optionalurl

url?: string

Optional url of the citation. May not be a valid URL.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR