Share via

MessageDeltaTextFilePathAnnotation interface

  • Reference
Package:
@azure/ai-projects

Represents a streamed file path annotation applied to a streaming text content part.

Extends
MessageDeltaTextAnnotationParent

Properties

endIndex

The end index of this annotation in the content text.
filePath

The file path information.
startIndex

The start index of this annotation in the content text.
text

The text in the message content that needs to be replaced
type

The type of the text content annotation, which is always "file_path."

Inherited Properties

index

The index of the annotation within a text content part.

Property Details

endIndex

The end index of this annotation in the content text.

endIndex?: number

Property Value

number

filePath

The file path information.

filePath?: MessageDeltaTextFilePathAnnotationObject

Property Value

MessageDeltaTextFilePathAnnotationObject

startIndex

The start index of this annotation in the content text.

startIndex?: number

Property Value

number

text

The text in the message content that needs to be replaced

text?: string

Property Value

string

type

The type of the text content annotation, which is always "file_path."

type: "file_path"

Property Value

"file_path"

Inherited Property Details

index

The index of the annotation within a text content part.

index: number

Property Value

number

Inherited From MessageDeltaTextAnnotationParent.index