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

Fields

read onlyvalue:Null<EitherType<String, EitherType<Uri, Location>>>

The value of this reference. The `stringUriLocation` types are used today, but this could expand in the future.

@:optionaloptionalread onlyrange:Null<{start:Int, end:Int}>

The start and end index of the reference in the {@link ChatRequest.prompt 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.

@:optionaloptionalread onlymodelDescription:Null<String>

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

read onlyid:String

A unique identifier for this kind of reference.