Class Annotation
-
- All Implemented Interfaces:
public final class Annotation
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 "file_search" tool to search files.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interface
Annotation.Visitor
An interface that defines how to map each variant of Annotation to a value of type T.
-
Method Summary
Modifier and Type Method Description final Optional<FileCitationAnnotation>
fileCitation()
A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. final Optional<FilePathAnnotation>
filePath()
A URL for the file that's generated when the assistant used the code_interpreter
tool to generate a file.final Boolean
isFileCitation()
final Boolean
isFilePath()
final FileCitationAnnotation
asFileCitation()
A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. final FilePathAnnotation
asFilePath()
A URL for the file that's generated when the assistant used the code_interpreter
tool to generate a file.final Optional<JsonValue>
_json()
final <T extends Any> T
accept(Annotation.Visitor<T> visitor)
final Annotation
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static Annotation
ofFileCitation(FileCitationAnnotation fileCitation)
A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. final static Annotation
ofFilePath(FilePathAnnotation filePath)
A URL for the file that's generated when the assistant used the code_interpreter
tool to generate a file.-
-
Method Detail
-
fileCitation
final Optional<FileCitationAnnotation> fileCitation()
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 "file_search" tool to search files.
-
filePath
final Optional<FilePathAnnotation> filePath()
A URL for the file that's generated when the assistant used the
code_interpreter
tool to generate a file.
-
isFileCitation
final Boolean isFileCitation()
-
isFilePath
final Boolean isFilePath()
-
asFileCitation
final FileCitationAnnotation asFileCitation()
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 "file_search" tool to search files.
-
asFilePath
final FilePathAnnotation asFilePath()
A URL for the file that's generated when the assistant used the
code_interpreter
tool to generate a file.
-
accept
final <T extends Any> T accept(Annotation.Visitor<T> visitor)
-
validate
final Annotation validate()
-
ofFileCitation
final static Annotation ofFileCitation(FileCitationAnnotation fileCitation)
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 "file_search" tool to search files.
-
ofFilePath
final static Annotation ofFilePath(FilePathAnnotation filePath)
A URL for the file that's generated when the assistant used the
code_interpreter
tool to generate a file.
-
-
-
-