Constructor Detail

Method Detail

• withRawResponse

   abstract VaultServiceAsync.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• withOptions

   abstract VaultServiceAsync withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• events

   abstract EventServiceAsync events()

• graphrag

   abstract GraphragServiceAsync graphrag()

• groups

   abstract GroupServiceAsync groups()

• multipart

   abstract MultipartServiceAsync multipart()

• objects

   abstract ObjectServiceAsync objects()

• create

   CompletableFuture<VaultCreateResponse> create(VaultCreateParams 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.

• create

   abstract CompletableFuture<VaultCreateResponse> create(VaultCreateParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<VaultRetrieveResponse> retrieve(String id)

  Retrieve detailed information about a specific vault, including storage configuration, chunking strategy, and usage statistics. Returns vault metadata, bucket information, and vector storage details.

• retrieve

   CompletableFuture<VaultRetrieveResponse> retrieve(String id, VaultRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<VaultRetrieveResponse> retrieve(String id, VaultRetrieveParams params)

• retrieve

   abstract CompletableFuture<VaultRetrieveResponse> retrieve(VaultRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<VaultRetrieveResponse> retrieve(VaultRetrieveParams params)

• retrieve

   CompletableFuture<VaultRetrieveResponse> retrieve(String id, RequestOptions requestOptions)

• update

   CompletableFuture<VaultUpdateResponse> update(String id)

  Update vault settings including name, description, and enableGraph. Changing enableGraph only affects future document uploads - existing documents retain their current graph/non-graph state.

• update

   CompletableFuture<VaultUpdateResponse> update(String id, VaultUpdateParams params, RequestOptions requestOptions)

• update

   CompletableFuture<VaultUpdateResponse> update(String id, VaultUpdateParams params)

• update

   abstract CompletableFuture<VaultUpdateResponse> update(VaultUpdateParams params, RequestOptions requestOptions)

• update

   CompletableFuture<VaultUpdateResponse> update(VaultUpdateParams params)

• update

   CompletableFuture<VaultUpdateResponse> update(String id, RequestOptions requestOptions)

• list

   CompletableFuture<VaultListResponse> list()

  List all vaults for the authenticated organization. Returns vault metadata including name, description, storage configuration, and usage statistics.

• list

   abstract CompletableFuture<VaultListResponse> list(VaultListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<VaultListResponse> list(VaultListParams params)

• list

   CompletableFuture<VaultListResponse> list(RequestOptions requestOptions)

• delete

   CompletableFuture<VaultDeleteResponse> delete(String id)

  Permanently deletes a vault and all its contents including documents, vectors, graph data, and S3 buckets. This operation cannot be undone. For large vaults, use the async=true query parameter to queue deletion in the background.

• delete

   CompletableFuture<VaultDeleteResponse> delete(String id, VaultDeleteParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<VaultDeleteResponse> delete(String id, VaultDeleteParams params)

• delete

   abstract CompletableFuture<VaultDeleteResponse> delete(VaultDeleteParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<VaultDeleteResponse> delete(VaultDeleteParams params)

• delete

   CompletableFuture<VaultDeleteResponse> delete(String id, RequestOptions requestOptions)

• confirmUpload

   CompletableFuture<VaultConfirmUploadResponse> confirmUpload(String objectId, VaultConfirmUploadParams params)

  Confirm whether a direct-to-S3 vault upload succeeded or failed. This endpoint emits vault.upload.completed or vault.upload.failed events and is idempotent for repeated confirmations.

• confirmUpload

   CompletableFuture<VaultConfirmUploadResponse> confirmUpload(String objectId, VaultConfirmUploadParams params, RequestOptions requestOptions)

• confirmUpload

   CompletableFuture<VaultConfirmUploadResponse> confirmUpload(VaultConfirmUploadParams params)

• confirmUpload

   abstract CompletableFuture<VaultConfirmUploadResponse> confirmUpload(VaultConfirmUploadParams params, RequestOptions requestOptions)

• ingest

   CompletableFuture<VaultIngestResponse> ingest(String objectId, VaultIngestParams params)

  Triggers ingestion workflow for a vault object to extract text, generate chunks, and create embeddings. For supported file types (PDF, DOCX, TXT, RTF, XML, audio, video), processing happens asynchronously. For unsupported types (images, archives, etc.), the file is marked as completed immediately without text extraction. GraphRAG indexing must be triggered separately via POST /vault/:id/graphrag/:objectId.

• ingest

   CompletableFuture<VaultIngestResponse> ingest(String objectId, VaultIngestParams params, RequestOptions requestOptions)

• ingest

   CompletableFuture<VaultIngestResponse> ingest(VaultIngestParams params)

• ingest

   abstract CompletableFuture<VaultIngestResponse> ingest(VaultIngestParams params, RequestOptions requestOptions)

• search

   CompletableFuture<VaultSearchResponse> search(String id, VaultSearchParams params)

  Search across vault documents using multiple methods including hybrid vector + graph search, GraphRAG global search, entity-based search, and fast similarity search. Returns relevant documents and contextual answers based on the search method.

• search

   CompletableFuture<VaultSearchResponse> search(String id, VaultSearchParams params, RequestOptions requestOptions)

• search

   CompletableFuture<VaultSearchResponse> search(VaultSearchParams params)

• search

   abstract CompletableFuture<VaultSearchResponse> search(VaultSearchParams params, RequestOptions requestOptions)

• upload

   CompletableFuture<VaultUploadResponse> upload(String id, VaultUploadParams params)

  Generate a presigned URL for uploading files directly to a vault's S3 storage. After uploading to S3, confirm the upload result via POST /vault/:vaultId/upload/:objectId/confirm before triggering ingestion.

• upload

   CompletableFuture<VaultUploadResponse> upload(String id, VaultUploadParams params, RequestOptions requestOptions)

• upload

   CompletableFuture<VaultUploadResponse> upload(VaultUploadParams params)

• upload

   abstract CompletableFuture<VaultUploadResponse> upload(VaultUploadParams params, RequestOptions requestOptions)