Package com.openai.models
Class FileCitationAnnotation
-
- All Implemented Interfaces:
public final class 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
FileCitationAnnotation.Builder
public final class
FileCitationAnnotation.FileCitation
public final class
FileCitationAnnotation.Type
Always
file_citation
.
-
Method Summary
Modifier and Type Method Description final Long
endIndex()
final FileCitationAnnotation.FileCitation
fileCitation()
final Long
startIndex()
final String
text()
The text in the message content that needs to be replaced. final FileCitationAnnotation.Type
type()
Always file_citation
.final JsonField<Long>
_endIndex()
final JsonField<FileCitationAnnotation.FileCitation>
_fileCitation()
final JsonField<Long>
_startIndex()
final JsonField<String>
_text()
The text in the message content that needs to be replaced. final JsonField<FileCitationAnnotation.Type>
_type()
Always file_citation
.final Map<String, JsonValue>
_additionalProperties()
final FileCitationAnnotation
validate()
final FileCitationAnnotation.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static FileCitationAnnotation.Builder
builder()
-
-
Method Detail
-
fileCitation
final FileCitationAnnotation.FileCitation fileCitation()
-
startIndex
final Long startIndex()
-
type
final FileCitationAnnotation.Type type()
Always
file_citation
.
-
_fileCitation
final JsonField<FileCitationAnnotation.FileCitation> _fileCitation()
-
_startIndex
final JsonField<Long> _startIndex()
-
_type
final JsonField<FileCitationAnnotation.Type> _type()
Always
file_citation
.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
validate
final FileCitationAnnotation validate()
-
toBuilder
final FileCitationAnnotation.Builder toBuilder()
-
builder
final static FileCitationAnnotation.Builder builder()
-
-
-
-