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
public final class
Annotation.Deserializer
public final class
Annotation.Serializer
-
Method Summary
Modifier and Type Method Description final Optional<FileCitationAnnotation>
fileCitationAnnotation()
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>
filePathAnnotation()
A URL for the file that's generated when the assistant used the code_interpreter
tool to generate a file.final Boolean
isFileCitationAnnotation()
final Boolean
isFilePathAnnotation()
final FileCitationAnnotation
asFileCitationAnnotation()
A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. final FilePathAnnotation
asFilePathAnnotation()
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()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static Annotation
ofFileCitationAnnotation(FileCitationAnnotation fileCitationAnnotation)
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
ofFilePathAnnotation(FilePathAnnotation filePathAnnotation)
A URL for the file that's generated when the assistant used the code_interpreter
tool to generate a file.-
-
Method Detail
-
fileCitationAnnotation
final Optional<FileCitationAnnotation> fileCitationAnnotation()
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.
-
filePathAnnotation
final Optional<FilePathAnnotation> filePathAnnotation()
A URL for the file that's generated when the assistant used the
code_interpreter
tool to generate a file.
-
isFileCitationAnnotation
final Boolean isFileCitationAnnotation()
-
isFilePathAnnotation
final Boolean isFilePathAnnotation()
-
asFileCitationAnnotation
final FileCitationAnnotation asFileCitationAnnotation()
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.
-
asFilePathAnnotation
final FilePathAnnotation asFilePathAnnotation()
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()
-
ofFileCitationAnnotation
final static Annotation ofFileCitationAnnotation(FileCitationAnnotation fileCitationAnnotation)
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.
-
ofFilePathAnnotation
final static Annotation ofFilePathAnnotation(FilePathAnnotation filePathAnnotation)
A URL for the file that's generated when the assistant used the
code_interpreter
tool to generate a file.
-
-
-
-