Package com.openai.models.responses
Class ResponseTextAnnotationDeltaEvent.Annotation.FilePath
-
- All Implemented Interfaces:
public final class ResponseTextAnnotationDeltaEvent.Annotation.FilePath
A path to a file.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseTextAnnotationDeltaEvent.Annotation.FilePath.Builder
A builder for FilePath.
-
Method Summary
Modifier and Type Method Description final String
fileId()
The ID of the file. final Long
index()
The index of the file in the list of files. final JsonValue
_type()
The type of the file path. 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.FilePath.Builder
toBuilder()
final ResponseTextAnnotationDeltaEvent.Annotation.FilePath
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseTextAnnotationDeltaEvent.Annotation.FilePath.Builder
builder()
Returns a mutable builder for constructing an instance of FilePath. -
-
Method Detail
-
_type
final JsonValue _type()
The type of the file path. Always
file_path
.Expected to always return the following:
JsonValue.from("file_path")
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.FilePath.Builder toBuilder()
-
validate
final ResponseTextAnnotationDeltaEvent.Annotation.FilePath validate()
-
builder
final static ResponseTextAnnotationDeltaEvent.Annotation.FilePath.Builder builder()
Returns a mutable builder for constructing an instance of FilePath.
The following fields are required:
.fileId() .index()
-
-
-
-