Interface ObjectService
-
- All Implemented Interfaces:
public interface ObjectServiceSecure document storage with semantic search and GraphRAG
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceObjectService.WithRawResponseA view of ObjectService that provides access to raw HTTP responses for each method.
-
Method Summary
-
-
Method Detail
-
withRawResponse
abstract ObjectService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract ObjectService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
retrieve
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
ObjectRetrieveResponse retrieve(String objectId, ObjectRetrieveParams params, RequestOptions requestOptions)
-
retrieve
ObjectRetrieveResponse retrieve(ObjectRetrieveParams params)
-
retrieve
abstract ObjectRetrieveResponse retrieve(ObjectRetrieveParams params, RequestOptions requestOptions)
-
update
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
ObjectUpdateResponse update(String objectId, ObjectUpdateParams params, RequestOptions requestOptions)
-
update
ObjectUpdateResponse update(ObjectUpdateParams params)
-
update
abstract ObjectUpdateResponse update(ObjectUpdateParams params, RequestOptions requestOptions)
-
list
ObjectListResponse list(String id)
Retrieve all objects stored in a specific vault, including document metadata, ingestion status, and processing statistics.
-
list
ObjectListResponse list(String id, ObjectListParams params, RequestOptions requestOptions)
-
list
ObjectListResponse list(String id, ObjectListParams params)
-
list
abstract ObjectListResponse list(ObjectListParams params, RequestOptions requestOptions)
-
list
ObjectListResponse list(ObjectListParams params)
-
list
ObjectListResponse list(String id, RequestOptions requestOptions)
-
delete
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
ObjectDeleteResponse delete(String objectId, ObjectDeleteParams params, RequestOptions requestOptions)
-
delete
ObjectDeleteResponse delete(ObjectDeleteParams params)
-
delete
abstract ObjectDeleteResponse delete(ObjectDeleteParams params, RequestOptions requestOptions)
-
createPresignedUrl
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
ObjectCreatePresignedUrlResponse createPresignedUrl(String objectId, ObjectCreatePresignedUrlParams params, RequestOptions requestOptions)
-
createPresignedUrl
ObjectCreatePresignedUrlResponse createPresignedUrl(ObjectCreatePresignedUrlParams params)
-
createPresignedUrl
abstract ObjectCreatePresignedUrlResponse createPresignedUrl(ObjectCreatePresignedUrlParams params, RequestOptions requestOptions)
-
download
@MustBeClosed() 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
@MustBeClosed() HttpResponse download(String objectId, ObjectDownloadParams params, RequestOptions requestOptions)
-
download
@MustBeClosed() HttpResponse download(ObjectDownloadParams params)
-
download
@MustBeClosed() abstract HttpResponse download(ObjectDownloadParams params, RequestOptions requestOptions)
-
getChunks
ObjectGetChunksResponse getChunks(String objectId, ObjectGetChunksParams params)
Retrieves full extracted chunk text for a processed vault object. Use this after search when a truncated preview is not enough and you need the exact chunk text or adjacent chunks for surrounding context such as tables, exhibit lists, or multi-part passages.
-
getChunks
ObjectGetChunksResponse getChunks(String objectId, ObjectGetChunksParams params, RequestOptions requestOptions)
-
getChunks
ObjectGetChunksResponse getChunks(ObjectGetChunksParams params)
-
getChunks
abstract ObjectGetChunksResponse getChunks(ObjectGetChunksParams params, RequestOptions requestOptions)
-
getOcrWords
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
ObjectGetOcrWordsResponse getOcrWords(String objectId, ObjectGetOcrWordsParams params, RequestOptions requestOptions)
-
getOcrWords
ObjectGetOcrWordsResponse getOcrWords(ObjectGetOcrWordsParams params)
-
getOcrWords
abstract ObjectGetOcrWordsResponse getOcrWords(ObjectGetOcrWordsParams params, RequestOptions requestOptions)
-
getPages
ObjectGetPagesResponse getPages(String objectId, ObjectGetPagesParams params)
Retrieves the raw text of a processed vault object split by page. The object must have completed ingestion before pages can be retrieved — for PDFs this requires the OCR pipeline to have finished writing the per-page sidecar, so freshly uploaded PDFs return 400 with the current
ingestionStatusuntil processing completes. For PDFs this returns the per-page OCR text. For plain text files (txt, md, source code, court reporter transcripts) the text is split using right-aligned page-number markers when present (preserving the original document numbering, including continuations like Volume 2 starting at page 234), falling back to form-feed (\f) page-break characters, and finally a single page if neither signal is present. Use the optionalstartandendquery parameters to fetch a specific inclusive page range. Pages with no text are omitted.
-
getPages
ObjectGetPagesResponse getPages(String objectId, ObjectGetPagesParams params, RequestOptions requestOptions)
-
getPages
ObjectGetPagesResponse getPages(ObjectGetPagesParams params)
-
getPages
abstract ObjectGetPagesResponse getPages(ObjectGetPagesParams params, RequestOptions requestOptions)
-
getSummarizeJob
ObjectGetSummarizeJobResponse getSummarizeJob(String jobId, ObjectGetSummarizeJobParams params)
Get the status of a CaseMark summary workflow job.
-
getSummarizeJob
ObjectGetSummarizeJobResponse getSummarizeJob(String jobId, ObjectGetSummarizeJobParams params, RequestOptions requestOptions)
-
getSummarizeJob
ObjectGetSummarizeJobResponse getSummarizeJob(ObjectGetSummarizeJobParams params)
-
getSummarizeJob
abstract ObjectGetSummarizeJobResponse getSummarizeJob(ObjectGetSummarizeJobParams params, RequestOptions requestOptions)
-
getText
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
ObjectGetTextResponse getText(String objectId, ObjectGetTextParams params, RequestOptions requestOptions)
-
getText
ObjectGetTextResponse getText(ObjectGetTextParams params)
-
getText
abstract ObjectGetTextResponse getText(ObjectGetTextParams params, RequestOptions requestOptions)
-
-
-
-