ChatGPT-Java-API/com.cjcrafter.openai.threads.message/TextAnnotation/FileCitation

FileCitation

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

File citations are created by the RetrievalTool and define references to a specific quote in a specific file that used by the Assistant to generate the response.

Constructors

Link copied to clipboard
constructor(text: String, fileCitation: TextAnnotation.FileCitation.FileQuote, startIndex: Int, endIndex: Int)

Types

Link copied to clipboard
data class FileQuote(val fileId: String, val quote: String)

Holds data about the file quote generated by the retrieval tool.

Properties

Link copied to clipboard
val endIndex: Int

The index of the first character that does not need to be replaced

Link copied to clipboard
val fileCitation: TextAnnotation.FileCitation.FileQuote

The specific quote that was used in retrieval

Link copied to clipboard
val startIndex: Int

The index of the first character that needs to be replaced

Link copied to clipboard
val text: String

The text in the message content that needs to be replaced