Class VaultCreateParams
-
- All Implemented Interfaces:
-
dev.case.api.core.Params
public final class VaultCreateParams implements Params
Creates a new secure vault with dedicated S3 storage and vector search capabilities. Each vault provides isolated document storage with semantic search, OCR processing, and optional GraphRAG knowledge graph features for legal document analysis and discovery.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classVaultCreateParams.BuilderA builder for VaultCreateParams.
public final classVaultCreateParams.Bodypublic final classVaultCreateParams.EmbeddingModelOptional embedding model for this vault. Defaults to casemark/embed-v1. Determines the S3 Vectors index dimension and which model is used at both ingest and search time. The vault is locked to this model after creation — use a re-embed flow to change later. Ignored when enableIndexing is false. Note:
casemark/llama-nemotron-embed-vl-1b-v2is a deprecated alias forcasemark/embed-v1(retained for SDK backward compatibility); new integrations should usecasemark/embed-v1directly.
-
Method Summary
Modifier and Type Method Description final Stringname()Display name for the vault final Optional<String>description()Optional description of the vault's purpose final Optional<VaultCreateParams.EmbeddingModel>embeddingModel()Optional embedding model for this vault. final Optional<Boolean>enableGraph()Enable knowledge graph for entity relationship mapping. final Optional<Boolean>enableIndexing()Enable vector indexing and search capabilities. final Optional<String>groupId()Assign the vault to a vault group for access control. final JsonValue_metadata()Optional metadata to attach to the vault (e.g. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<VaultCreateParams.EmbeddingModel>_embeddingModel()Returns the raw JSON value of embeddingModel. final JsonField<Boolean>_enableGraph()Returns the raw JSON value of enableGraph. final JsonField<Boolean>_enableIndexing()Returns the raw JSON value of enableIndexing. final JsonField<String>_groupId()Returns the raw JSON value of groupId. 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 VaultCreateParams.BuildertoBuilder()final VaultCreateParams.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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static VaultCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of VaultCreateParams. -
-
Method Detail
-
description
final Optional<String> description()
Optional description of the vault's purpose
-
embeddingModel
final Optional<VaultCreateParams.EmbeddingModel> embeddingModel()
Optional embedding model for this vault. Defaults to casemark/embed-v1. Determines the S3 Vectors index dimension and which model is used at both ingest and search time. The vault is locked to this model after creation — use a re-embed flow to change later. Ignored when enableIndexing is false. Note:
casemark/llama-nemotron-embed-vl-1b-v2is a deprecated alias forcasemark/embed-v1(retained for SDK backward compatibility); new integrations should usecasemark/embed-v1directly.
-
enableGraph
final Optional<Boolean> enableGraph()
Enable knowledge graph for entity relationship mapping. Only applies when enableIndexing is true.
-
enableIndexing
final Optional<Boolean> enableIndexing()
Enable vector indexing and search capabilities. Set to false for storage-only vaults.
-
groupId
final Optional<String> groupId()
Assign the vault to a vault group for access control. Required when using a group-scoped API key.
-
_metadata
final JsonValue _metadata()
Optional metadata to attach to the vault (e.g., { containsPHI: true } for HIPAA compliance tracking)
This arbitrary value can be deserialized into a custom type using the
convertmethod:MyClass myObject = vaultCreateParams.metadata().convert(MyClass.class);
-
_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.
-
_description
final JsonField<String> _description()
Returns the raw JSON value of description.
Unlike description, this method doesn't throw if the JSON field has an unexpected type.
-
_embeddingModel
final JsonField<VaultCreateParams.EmbeddingModel> _embeddingModel()
Returns the raw JSON value of embeddingModel.
Unlike embeddingModel, this method doesn't throw if the JSON field has an unexpected type.
-
_enableGraph
final JsonField<Boolean> _enableGraph()
Returns the raw JSON value of enableGraph.
Unlike enableGraph, this method doesn't throw if the JSON field has an unexpected type.
-
_enableIndexing
final JsonField<Boolean> _enableIndexing()
Returns the raw JSON value of enableIndexing.
Unlike enableIndexing, this method doesn't throw if the JSON field has an unexpected type.
-
_groupId
final JsonField<String> _groupId()
Returns the raw JSON value of groupId.
Unlike groupId, 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 VaultCreateParams.Builder toBuilder()
-
_body
final VaultCreateParams.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.
-
builder
final static VaultCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of VaultCreateParams.
The following fields are required:
.name()
-
-
-
-