Class VectorStoreCreateParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class VectorStoreCreateParams implements Params
Create a vector store.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
VectorStoreCreateParams.Builder
A builder for VectorStoreCreateParams.
public final class
VectorStoreCreateParams.Body
public final class
VectorStoreCreateParams.ExpiresAfter
The expiration policy for a vector store.
public final class
VectorStoreCreateParams.Metadata
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.
-
Method Summary
Modifier and Type Method Description final Optional<FileChunkingStrategyParam>
chunkingStrategy()
The chunking strategy used to chunk the file(s). final Optional<VectorStoreCreateParams.ExpiresAfter>
expiresAfter()
The expiration policy for a vector store. final Optional<List<String>>
fileIds()
A list of File IDs that the vector store should use. final Optional<VectorStoreCreateParams.Metadata>
metadata()
Set of 16 key-value pairs that can be attached to an object. final Optional<String>
name()
The name of the vector store. final JsonField<FileChunkingStrategyParam>
_chunkingStrategy()
Returns the raw JSON value of chunkingStrategy. final JsonField<VectorStoreCreateParams.ExpiresAfter>
_expiresAfter()
Returns the raw JSON value of expiresAfter. final JsonField<List<String>>
_fileIds()
Returns the raw JSON value of fileIds. final JsonField<VectorStoreCreateParams.Metadata>
_metadata()
Returns the raw JSON value of metadata. final JsonField<String>
_name()
Returns the raw JSON value of name. final Map<String, JsonValue>
_additionalBodyProperties()
final Headers
_additionalHeaders()
final QueryParams
_additionalQueryParams()
final VectorStoreCreateParams.Builder
toBuilder()
final VectorStoreCreateParams.Body
_body()
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. Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static VectorStoreCreateParams
none()
final static VectorStoreCreateParams.Builder
builder()
Returns a mutable builder for constructing an instance of VectorStoreCreateParams. -
-
Method Detail
-
chunkingStrategy
final Optional<FileChunkingStrategyParam> chunkingStrategy()
The chunking strategy used to chunk the file(s). If not set, will use the
auto
strategy. Only applicable iffile_ids
is non-empty.
-
expiresAfter
final Optional<VectorStoreCreateParams.ExpiresAfter> expiresAfter()
The expiration policy for a vector store.
-
fileIds
final Optional<List<String>> fileIds()
A list of File IDs that the vector store should use. Useful for tools like
file_search
that can access files.
-
metadata
final Optional<VectorStoreCreateParams.Metadata> metadata()
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.
-
_chunkingStrategy
final JsonField<FileChunkingStrategyParam> _chunkingStrategy()
Returns the raw JSON value of chunkingStrategy.
Unlike chunkingStrategy, this method doesn't throw if the JSON field has an unexpected type.
-
_expiresAfter
final JsonField<VectorStoreCreateParams.ExpiresAfter> _expiresAfter()
Returns the raw JSON value of expiresAfter.
Unlike expiresAfter, this method doesn't throw if the JSON field has an unexpected type.
-
_fileIds
final JsonField<List<String>> _fileIds()
Returns the raw JSON value of fileIds.
Unlike fileIds, this method doesn't throw if the JSON field has an unexpected type.
-
_metadata
final JsonField<VectorStoreCreateParams.Metadata> _metadata()
Returns the raw JSON value of metadata.
Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, 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()
-
toBuilder
final VectorStoreCreateParams.Builder toBuilder()
-
_body
final VectorStoreCreateParams.Body _body()
-
_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.
-
none
final static VectorStoreCreateParams none()
-
builder
final static VectorStoreCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of VectorStoreCreateParams.
-
-
-
-