openai-core/com.aallam.openai.api.message/FileCitationAnnotation

FileCitationAnnotation

@Serializable

@SerialName(value = "file_citation")

data class FileCitationAnnotation(val text: String, val startIndex: Int, val endIndex: Int, val fileCitation: FileCitation) : TextAnnotation

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.

Constructors

FileCitationAnnotation

constructor(text: String, startIndex: Int, endIndex: Int, fileCitation: FileCitation)

Properties

endIndex

@SerialName(value = "end_index")

open override val endIndex: Int

End index.

fileCitation

@SerialName(value = "file_citation")

val fileCitation: FileCitation

The specific quote in the file.

startIndex

@SerialName(value = "start_index")

open override val startIndex: Int

Start index.

text

@SerialName(value = "text")

open override val text: String

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