Package com.openai.models.responses
Class ResponseOutputText.Annotation.FileCitation
-
- All Implemented Interfaces:
public final class ResponseOutputText.Annotation.FileCitation
A citation to a file.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseOutputText.Annotation.FileCitation.Builder
A builder for FileCitation.
-
Method Summary
Modifier and Type Method Description final String
fileId()
The ID of the file. final String
filename()
The filename of the file cited. final Long
index()
The index of the file in the list of files. final JsonValue
_type()
The type of the file citation. final JsonField<String>
_fileId()
Returns the raw JSON value of fileId. final JsonField<String>
_filename()
Returns the raw JSON value of filename. final JsonField<Long>
_index()
Returns the raw JSON value of index. final Map<String, JsonValue>
_additionalProperties()
final ResponseOutputText.Annotation.FileCitation.Builder
toBuilder()
final ResponseOutputText.Annotation.FileCitation
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseOutputText.Annotation.FileCitation.Builder
builder()
Returns a mutable builder for constructing an instance of FileCitation. -
-
Method Detail
-
_type
final JsonValue _type()
The type of the file citation. Always
file_citation
.Expected to always return the following:
JsonValue.from("file_citation")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_fileId
final JsonField<String> _fileId()
Returns the raw JSON value of fileId.
Unlike fileId, this method doesn't throw if the JSON field has an unexpected type.
-
_filename
final JsonField<String> _filename()
Returns the raw JSON value of filename.
Unlike filename, this method doesn't throw if the JSON field has an unexpected type.
-
_index
final JsonField<Long> _index()
Returns the raw JSON value of index.
Unlike index, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseOutputText.Annotation.FileCitation.Builder toBuilder()
-
validate
final ResponseOutputText.Annotation.FileCitation validate()
-
builder
final static ResponseOutputText.Annotation.FileCitation.Builder builder()
Returns a mutable builder for constructing an instance of FileCitation.
The following fields are required:
.fileId() .filename() .index()
-
-
-
-