Class FileUpdateParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class FileUpdateParams implements Params
Update attributes on a vector store file.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
FileUpdateParams.Body
public final class
FileUpdateParams.Builder
A builder for FileUpdateParams.
public final class
FileUpdateParams.Attributes
Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.
-
Method Summary
Modifier and Type Method Description final String
vectorStoreId()
final String
fileId()
final Optional<FileUpdateParams.Attributes>
attributes()
Set of 16 key-value pairs that can be attached to an object. final JsonField<FileUpdateParams.Attributes>
_attributes()
Returns the raw JSON value of attributes. final Map<String, JsonValue>
_additionalBodyProperties()
final Headers
_additionalHeaders()
final QueryParams
_additionalQueryParams()
final String
_pathParam(Integer index)
Headers
_headers()
The full set of headers in the parameters, including both fixed and additional headers. QueryParams
_queryParams()
The full set of query params in the parameters, including both fixed and additional query params. final FileUpdateParams.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static FileUpdateParams.Builder
builder()
Returns a mutable builder for constructing an instance of FileUpdateParams. -
-
Method Detail
-
vectorStoreId
final String vectorStoreId()
-
attributes
final Optional<FileUpdateParams.Attributes> attributes()
Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.
-
_attributes
final JsonField<FileUpdateParams.Attributes> _attributes()
Returns the raw JSON value of attributes.
Unlike attributes, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
_pathParam
final String _pathParam(Integer index)
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
toBuilder
final FileUpdateParams.Builder toBuilder()
-
builder
final static FileUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of FileUpdateParams.
The following fields are required:
.vectorStoreId() .fileId() .attributes()
-
-
-
-