Class Annotation
- 
                    
                    
- All Implemented Interfaces:
 
public final class AnnotationA 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 interfaceAnnotation.VisitorAn 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_interpretertool to generate a file.final BooleanisFileCitation()final BooleanisFilePath()final FileCitationAnnotationasFileCitation()A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. final FilePathAnnotationasFilePath()A URL for the file that's generated when the assistant used the code_interpretertool to generate a file.final Optional<JsonValue>_json()final <T extends Any> Taccept(Annotation.Visitor<T> visitor)final Annotationvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static AnnotationofFileCitation(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 AnnotationofFilePath(FilePathAnnotation filePath)A URL for the file that's generated when the assistant used the code_interpretertool 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_interpretertool 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_interpretertool 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_interpretertool to generate a file. 
 - 
                                        
 
 - 
                                
                            
                                
 
 - 
                    
                    
                    
 
 -