MessageTextFileCitationAnnotation interface

Package:

@azure/openai-assistants

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files.

Properties

endIndex	The last text index associated with this text annotation.
fileCitation	A citation within the message that points to a specific quote from a specific file. Generated when the assistant uses the "retrieval" tool to search files.
startIndex	The first text index associated with this text annotation.
text	The textual content associated with this text annotation item.
type	The object type, which is always 'file_citation'.

Property Details

endIndex

The last text index associated with this text annotation.

endIndex: number

Property Value

number

fileCitation

A citation within the message that points to a specific quote from a specific file. Generated when the assistant uses the "retrieval" tool to search files.

fileCitation: MessageTextFileCitationDetails

Property Value

MessageTextFileCitationDetails

startIndex

The first text index associated with this text annotation.

startIndex: number

Property Value

number

text

The textual content associated with this text annotation item.

text: string

Property Value

string

type

The object type, which is always 'file_citation'.

type: "file_citation"

Property Value

"file_citation"