Constructor Detail

Method Detail

• withRawResponse

   abstract ObjectServiceAsync.WithRawResponse withRawResponse()

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

• withOptions

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

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

  The original service is not modified.

• retrieve

   CompletableFuture<ObjectRetrieveResponse> retrieve(String objectId, ObjectRetrieveParams params)

  Retrieves metadata for a specific document in a vault and generates a temporary download URL. The download URL expires after 1 hour for security. This endpoint also updates the file size if it wasn't previously calculated.

• retrieve

   CompletableFuture<ObjectRetrieveResponse> retrieve(String objectId, ObjectRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<ObjectRetrieveResponse> retrieve(ObjectRetrieveParams params)

• retrieve

   abstract CompletableFuture<ObjectRetrieveResponse> retrieve(ObjectRetrieveParams params, RequestOptions requestOptions)

• update

   CompletableFuture<ObjectUpdateResponse> update(String objectId, ObjectUpdateParams params)

  Update a document's filename, path, or metadata. Use this to rename files or organize them into virtual folders. The path is stored in metadata.path and can be used to build folder hierarchies in your application.

• update

   CompletableFuture<ObjectUpdateResponse> update(String objectId, ObjectUpdateParams params, RequestOptions requestOptions)

• update

   CompletableFuture<ObjectUpdateResponse> update(ObjectUpdateParams params)

• update

   abstract CompletableFuture<ObjectUpdateResponse> update(ObjectUpdateParams params, RequestOptions requestOptions)

• list

   CompletableFuture<ObjectListResponse> list(String id)

  Retrieve all objects stored in a specific vault, including document metadata, ingestion status, and processing statistics.

• list

   CompletableFuture<ObjectListResponse> list(String id, ObjectListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<ObjectListResponse> list(String id, ObjectListParams params)

• list

   abstract CompletableFuture<ObjectListResponse> list(ObjectListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<ObjectListResponse> list(ObjectListParams params)

• list

   CompletableFuture<ObjectListResponse> list(String id, RequestOptions requestOptions)

• delete

   CompletableFuture<ObjectDeleteResponse> delete(String objectId, ObjectDeleteParams params)

  Permanently deletes a document from the vault including all associated vectors, chunks, graph data, and the original file. This operation cannot be undone.

• delete

   CompletableFuture<ObjectDeleteResponse> delete(String objectId, ObjectDeleteParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<ObjectDeleteResponse> delete(ObjectDeleteParams params)

• delete

   abstract CompletableFuture<ObjectDeleteResponse> delete(ObjectDeleteParams params, RequestOptions requestOptions)

• createPresignedUrl

   CompletableFuture<ObjectCreatePresignedUrlResponse> createPresignedUrl(String objectId, ObjectCreatePresignedUrlParams params)

  Generate presigned URLs for direct S3 operations (GET, PUT, DELETE, HEAD) on vault objects. This allows secure, time-limited access to files without proxying through the API. Essential for large document uploads/downloads in legal workflows.

• createPresignedUrl

   CompletableFuture<ObjectCreatePresignedUrlResponse> createPresignedUrl(String objectId, ObjectCreatePresignedUrlParams params, RequestOptions requestOptions)

• createPresignedUrl

   CompletableFuture<ObjectCreatePresignedUrlResponse> createPresignedUrl(ObjectCreatePresignedUrlParams params)

• createPresignedUrl

   abstract CompletableFuture<ObjectCreatePresignedUrlResponse> createPresignedUrl(ObjectCreatePresignedUrlParams params, RequestOptions requestOptions)

• download

   CompletableFuture<HttpResponse> download(String objectId, ObjectDownloadParams params)

  Downloads a file from a vault. Returns the actual file content as a binary stream with appropriate headers for file download. Useful for retrieving contracts, depositions, case files, and other legal documents stored in your vault.

• download

   CompletableFuture<HttpResponse> download(String objectId, ObjectDownloadParams params, RequestOptions requestOptions)

• download

   CompletableFuture<HttpResponse> download(ObjectDownloadParams params)

• download

   abstract CompletableFuture<HttpResponse> download(ObjectDownloadParams params, RequestOptions requestOptions)

• getOcrWords

   CompletableFuture<ObjectGetOcrWordsResponse> getOcrWords(String objectId, ObjectGetOcrWordsParams params)

  Retrieves word-level OCR bounding box data for a processed PDF document. Each word includes its text, normalized bounding box coordinates (0-1 range), confidence score, and global word index. Use this data to highlight specific text ranges in a PDF viewer based on word indices from search results.

• getOcrWords

   CompletableFuture<ObjectGetOcrWordsResponse> getOcrWords(String objectId, ObjectGetOcrWordsParams params, RequestOptions requestOptions)

• getOcrWords

   CompletableFuture<ObjectGetOcrWordsResponse> getOcrWords(ObjectGetOcrWordsParams params)

• getOcrWords

   abstract CompletableFuture<ObjectGetOcrWordsResponse> getOcrWords(ObjectGetOcrWordsParams params, RequestOptions requestOptions)

• getSummarizeJob

   CompletableFuture<ObjectGetSummarizeJobResponse> getSummarizeJob(String jobId, ObjectGetSummarizeJobParams params)

  Get the status of a CaseMark summary workflow job.

• getSummarizeJob

   CompletableFuture<ObjectGetSummarizeJobResponse> getSummarizeJob(String jobId, ObjectGetSummarizeJobParams params, RequestOptions requestOptions)

• getSummarizeJob

   CompletableFuture<ObjectGetSummarizeJobResponse> getSummarizeJob(ObjectGetSummarizeJobParams params)

• getSummarizeJob

   abstract CompletableFuture<ObjectGetSummarizeJobResponse> getSummarizeJob(ObjectGetSummarizeJobParams params, RequestOptions requestOptions)

• getText

   CompletableFuture<ObjectGetTextResponse> getText(String objectId, ObjectGetTextParams params)

  Retrieves the full extracted text content from a processed vault object. Returns the concatenated text from all chunks, useful for document review, analysis, or export. The object must have completed processing before text can be retrieved.

• getText

   CompletableFuture<ObjectGetTextResponse> getText(String objectId, ObjectGetTextParams params, RequestOptions requestOptions)

• getText

   CompletableFuture<ObjectGetTextResponse> getText(ObjectGetTextParams params)

• getText

   abstract CompletableFuture<ObjectGetTextResponse> getText(ObjectGetTextParams params, RequestOptions requestOptions)