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 classFileUpdateParams.BuilderA builder for FileUpdateParams.
public final classFileUpdateParams.Bodypublic final classFileUpdateParams.AttributesSet 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 StringvectorStoreId()final Optional<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()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final FileUpdateParams.BuildertoBuilder()final FileUpdateParams.Body_body()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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static FileUpdateParams.Builderbuilder()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()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final FileUpdateParams.Builder toBuilder()
-
_body
final FileUpdateParams.Body _body()
-
_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.
-
builder
final static FileUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of FileUpdateParams.
The following fields are required:
.vectorStoreId() .attributes()
-
-
-
-