Package com.openai.models.responses
Class ResponseTextAnnotationDeltaEvent.Annotation.FileCitation
-
- All Implemented Interfaces:
public final class ResponseTextAnnotationDeltaEvent.Annotation.FileCitationA citation to a file.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseTextAnnotationDeltaEvent.Annotation.FileCitation.BuilderA builder for FileCitation.
-
Method Summary
Modifier and Type Method Description final StringfileId()The ID of the file. final Longindex()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<Long>_index()Returns the raw JSON value of index. final Map<String, JsonValue>_additionalProperties()final ResponseTextAnnotationDeltaEvent.Annotation.FileCitation.BuildertoBuilder()final ResponseTextAnnotationDeltaEvent.Annotation.FileCitationvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseTextAnnotationDeltaEvent.Annotation.FileCitation.Builderbuilder()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.
-
_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 ResponseTextAnnotationDeltaEvent.Annotation.FileCitation.Builder toBuilder()
-
validate
final ResponseTextAnnotationDeltaEvent.Annotation.FileCitation validate()
-
builder
final static ResponseTextAnnotationDeltaEvent.Annotation.FileCitation.Builder builder()
Returns a mutable builder for constructing an instance of FileCitation.
The following fields are required:
.fileId() .index()
-
-
-
-