MessageTextFilePathAnnotation interface

A citation within the message that points to a file located at a specific path.

Properties

endIndex

The last text index associated with this text annotation.

filePath

A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.

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_path'.

Property Details

endIndex

The last text index associated with this text annotation.

endIndex: number

Property Value

number

filePath

A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.

filePath: MessageTextFilePathDetails

Property Value

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_path'.

type: "file_path"

Property Value

"file_path"