Interface ChatPromptReference

A reference to a value that the user added to their chat request.

Stubbed

interface ChatPromptReference {
    id: string;
    modelDescription?: string;
    range?: [start: number, end: number];
    value: unknown;
}

Properties

id modelDescription? range? value

Properties

Readonly id

id: string

A unique identifier for this kind of reference.

Optional Readonly modelDescription

modelDescription?: string

A description of this value that could be used in an LLM prompt.

Optional Readonly range

range?: [start: number, end: number]

The start and end index of the reference in the prompt. When undefined, the reference was not part of the prompt text.

Note that the indices take the leading #-character into account which means they can used to modify the prompt as-is.

Readonly value

value: unknown

The value of this reference. The string | Uri | Location types are used today, but this could expand in the future.

Settings

Member Visibility

Theme

On This Page

idmodelDescriptionrangevalue