Package ai.vectros.types

Class DocumentResponse.Builder

java.lang.Object

ai.vectros.types.DocumentResponse.Builder

Enclosing class:

DocumentResponse

public static final class DocumentResponse.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
DocumentResponse.Builder	additionalProperties(Map<String,Object> additionalProperties)
DocumentResponse.Builder	additionalProperty(String key, Object value)
DocumentResponse	build()
DocumentResponse.Builder	clientId(String clientId)
DocumentResponse.Builder	clientId(Optional<String> clientId)	The associated client — the Vectros-assigned UUID of a client in your account.
DocumentResponse.Builder	createdAt(String createdAt)
DocumentResponse.Builder	createdAt(Optional<String> createdAt)	When the document was created, as an ISO-8601 UTC timestamp.
DocumentResponse.Builder	externalId(String externalId)
DocumentResponse.Builder	externalId(Optional<String> externalId)	Your own stable identifier for this document (immutable, and unique within your context).
DocumentResponse.Builder	fileSize(Long fileSize)
DocumentResponse.Builder	fileSize(Optional<Long> fileSize)	Size of the uploaded file, in bytes.
DocumentResponse.Builder	fileType(String fileType)
DocumentResponse.Builder	fileType(Optional<String> fileType)	MIME type of the uploaded file.
DocumentResponse.Builder	folderId(String folderId)
DocumentResponse.Builder	folderId(Optional<String> folderId)	The ID of the folder that contains this document.
DocumentResponse.Builder	from(DocumentResponse other)
DocumentResponse.Builder	id(String id)
DocumentResponse.Builder	id(Optional<String> id)	The Vectros-assigned unique ID of the document.
DocumentResponse.Builder	indexMode(DocumentResponseIndexMode indexMode)
DocumentResponse.Builder	indexMode(Optional<DocumentResponseIndexMode> indexMode)	How this document is indexed.
DocumentResponse.Builder	lastModified(String lastModified)
DocumentResponse.Builder	lastModified(Optional<String> lastModified)	When the document was last modified, as an ISO-8601 UTC timestamp.
DocumentResponse.Builder	orgId(String orgId)
DocumentResponse.Builder	orgId(Optional<String> orgId)	The owning organization — the Vectros-assigned UUID of an organization in your account.
DocumentResponse.Builder	payload(Map<String,Object> payload)
DocumentResponse.Builder	payload(Optional<Map<String,Object>> payload)	The document's structured payload, as a JSON object.
DocumentResponse.Builder	payloadExternalized(Boolean payloadExternalized)
DocumentResponse.Builder	payloadExternalized(Optional<Boolean> payloadExternalized)	True when this document's structured payload is large enough to be stored externally rather than inline.
DocumentResponse.Builder	schemaId(String schemaId)
DocumentResponse.Builder	schemaId(Optional<String> schemaId)	The ID of the record schema this document's payload is validated and indexed against.
DocumentResponse.Builder	schemaVersion(Integer schemaVersion)
DocumentResponse.Builder	schemaVersion(Optional<Integer> schemaVersion)	The version of the bound schema in effect when this document was written.
DocumentResponse.Builder	status(DocumentResponseStatus status)
DocumentResponse.Builder	status(Optional<DocumentResponseStatus> status)	Processing status of the document.
DocumentResponse.Builder	storeText(Boolean storeText)
DocumentResponse.Builder	storeText(Optional<Boolean> storeText)	Whether the raw text is stored and retrievable via GET /v1/documents/{id}/text.
DocumentResponse.Builder	textBytes(Long textBytes)
DocumentResponse.Builder	textBytes(Optional<Long> textBytes)	Size of the extracted text, in bytes.
DocumentResponse.Builder	title(String title)
DocumentResponse.Builder	title(Optional<String> title)	The document's title.
DocumentResponse.Builder	userId(String userId)
DocumentResponse.Builder	userId(Optional<String> userId)	The owning user — the Vectros-assigned UUID of a user in your account.
DocumentResponse.Builder	version(Long version)
DocumentResponse.Builder	version(Optional<Long> version)	Optimistic-concurrency version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public DocumentResponse.Builder from(DocumentResponse other)

id

public DocumentResponse.Builder id(Optional<String> id)

The Vectros-assigned unique ID of the document.

id

public DocumentResponse.Builder id(String id)

title

public DocumentResponse.Builder title(Optional<String> title)

The document's title.

title

public DocumentResponse.Builder title(String title)

externalId

public DocumentResponse.Builder externalId(Optional<String> externalId)

Your own stable identifier for this document (immutable, and unique within your context). Null if the document was created without one.

externalId

public DocumentResponse.Builder externalId(String externalId)

status

public DocumentResponse.Builder status(Optional<DocumentResponseStatus> status)

Processing status of the document. PENDING_UPLOAD, UPLOADED, EXTRACTING, and PENDING_INDEX are in-flight states; INDEXED means the document is indexed and searchable; SKIPPED means extraction produced no indexable text so there was nothing to index — the document is stored and retrievable, just not searchable (not an error); STORED means it is store-only (indexMode=NONE) — persisted and retrievable but by design not searchable; FAILED means processing failed.

status

public DocumentResponse.Builder status(DocumentResponseStatus status)

indexMode

public DocumentResponse.Builder indexMode(Optional<DocumentResponseIndexMode> indexMode)

How this document is indexed. HYBRID, SEMANTIC, and TEXT are searchable; NONE is store-only (not indexed for search).

indexMode

public DocumentResponse.Builder indexMode(DocumentResponseIndexMode indexMode)

storeText

public DocumentResponse.Builder storeText(Optional<Boolean> storeText)

Whether the raw text is stored and retrievable via GET /v1/documents/{id}/text.

storeText

public DocumentResponse.Builder storeText(Boolean storeText)

folderId

public DocumentResponse.Builder folderId(Optional<String> folderId)

The ID of the folder that contains this document.

folderId

public DocumentResponse.Builder folderId(String folderId)

payload

public DocumentResponse.Builder payload(Optional<Map<String,Object>> payload)

The document's structured payload, as a JSON object. When schemaId is set, schema-declared fields are validated and indexed for lookup; undeclared keys pass through as free-form. A by-id GET returns the full payload; on list responses this may be only the inline subset of fields (see payloadExternalized).

payload

public DocumentResponse.Builder payload(Map<String,Object> payload)

payloadExternalized

public DocumentResponse.Builder payloadExternalized(Optional<Boolean> payloadExternalized)

True when this document's structured payload is large enough to be stored externally rather than inline. In that case payload on a list response holds only the inline subset of fields; fetch the full payload with a by-id GET.

payloadExternalized

public DocumentResponse.Builder payloadExternalized(Boolean payloadExternalized)

schemaId

public DocumentResponse.Builder schemaId(Optional<String> schemaId)

The ID of the record schema this document's payload is validated and indexed against. Null if the document is schemaless.

schemaId

public DocumentResponse.Builder schemaId(String schemaId)

schemaVersion

public DocumentResponse.Builder schemaVersion(Optional<Integer> schemaVersion)

The version of the bound schema in effect when this document was written. A document keeps the version it was stamped with at write time, even after the schema is later edited. Null when the document is schemaless.

schemaVersion

public DocumentResponse.Builder schemaVersion(Integer schemaVersion)

textBytes

public DocumentResponse.Builder textBytes(Optional<Long> textBytes)

Size of the extracted text, in bytes.

textBytes

public DocumentResponse.Builder textBytes(Long textBytes)

userId

public DocumentResponse.Builder userId(Optional<String> userId)

The owning user — the Vectros-assigned UUID of a user in your account.

userId

public DocumentResponse.Builder userId(String userId)

orgId

public DocumentResponse.Builder orgId(Optional<String> orgId)

The owning organization — the Vectros-assigned UUID of an organization in your account.

orgId

public DocumentResponse.Builder orgId(String orgId)

clientId

public DocumentResponse.Builder clientId(Optional<String> clientId)

The associated client — the Vectros-assigned UUID of a client in your account.

clientId

public DocumentResponse.Builder clientId(String clientId)

fileType

public DocumentResponse.Builder fileType(Optional<String> fileType)

MIME type of the uploaded file. Present only for file-backed documents.

fileType

public DocumentResponse.Builder fileType(String fileType)

fileSize

public DocumentResponse.Builder fileSize(Optional<Long> fileSize)

Size of the uploaded file, in bytes. Present only for file-backed documents.

fileSize

public DocumentResponse.Builder fileSize(Long fileSize)

createdAt

public DocumentResponse.Builder createdAt(Optional<String> createdAt)

When the document was created, as an ISO-8601 UTC timestamp.

createdAt

public DocumentResponse.Builder createdAt(String createdAt)

lastModified

public DocumentResponse.Builder lastModified(Optional<String> lastModified)

When the document was last modified, as an ISO-8601 UTC timestamp.

lastModified

public DocumentResponse.Builder lastModified(String lastModified)

version

public DocumentResponse.Builder version(Optional<Long> version)

Optimistic-concurrency version. Pass this back as expectedVersion on a later update to avoid silently overwriting a concurrent change — the update is rejected with 409 if the document has moved on. Incremented on every successful write.

version

public DocumentResponse.Builder version(Long version)

build

public DocumentResponse build()

additionalProperty

public DocumentResponse.Builder additionalProperty(String key,
 Object value)

additionalProperties

public DocumentResponse.Builder additionalProperties(Map<String,Object> additionalProperties)