Share via

MessageTextFileCitationAnnotationOutput interface

  • Reference
Package:
@azure/ai-projects

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

Extends
MessageTextAnnotationOutputParent

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 agent uses the "file_search" tool to search files.
startIndex

The first text index associated with this text annotation.
type

The object type, which is always 'file_citation'.

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

fileCitation

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

fileCitation: MessageTextFileCitationDetailsOutput

Property Value

MessageTextFileCitationDetailsOutput

startIndex

The first text index associated with this text annotation.

startIndex?: number

Property Value

number

type

The object type, which is always 'file_citation'.

type: "file_citation"

Property Value

"file_citation"

Inherited Property Details

text

The textual content associated with this text annotation item.

text: string

Property Value

string

Inherited From MessageTextAnnotationOutputParent.text