Share via


MessageTextFilePathAnnotationOutput interface

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

Extends

Properties

endIndex

The last text index associated with this text annotation.

filePath

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

startIndex

The first text index associated with this text annotation.

type

The object type, which is always 'file_path'.

Inherited Properties

text

The textual content associated with this text annotation item.

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 agent used the code_interpreter tool to generate a file.

filePath: MessageTextFilePathDetailsOutput

Property Value

startIndex

The first text index associated with this text annotation.

startIndex?: number

Property Value

number

type

The object type, which is always 'file_path'.

type: "file_path"

Property Value

"file_path"

Inherited Property Details

text

The textual content associated with this text annotation item.

text: string

Property Value

string

Inherited From MessageTextAnnotationOutputParent.text