Package ai.vectros.resources.documents.requests

Interface FileUploadRequest._FinalStage

All Known Implementing Classes:

FileUploadRequest.Builder

Enclosing class:

FileUploadRequest

public static interface FileUploadRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
FileUploadRequest._FinalStage	additionalProperties(Map<String,Object> additionalProperties)
FileUploadRequest._FinalStage	additionalProperty(String key, Object value)
FileUploadRequest	build()
FileUploadRequest._FinalStage	clientId(String clientId)
FileUploadRequest._FinalStage	clientId(Optional<String> clientId)	Associated client ID — the Vectros-assigned UUID of a client in your account.
FileUploadRequest._FinalStage	externalId(String externalId)
FileUploadRequest._FinalStage	externalId(Optional<String> externalId)	Stable, caller-supplied identifier for this document.
FileUploadRequest._FinalStage	folderId(String folderId)
FileUploadRequest._FinalStage	folderId(Optional<String> folderId)	ID of the folder in which to place this document.
FileUploadRequest._FinalStage	indexMode(FileUploadRequestIndexMode indexMode)
FileUploadRequest._FinalStage	indexMode(Optional<FileUploadRequestIndexMode> indexMode)	Indexing strategy applied after the file is processed and its text is extracted.
FileUploadRequest._FinalStage	orgId(String orgId)
FileUploadRequest._FinalStage	orgId(Optional<String> orgId)	Owning organization ID — the Vectros-assigned UUID of an organization in your account.
FileUploadRequest._FinalStage	payload(Map<String,Object> payload)
FileUploadRequest._FinalStage	payload(Optional<Map<String,Object>> payload)	The document's structured data, as a flat key/value object.
FileUploadRequest._FinalStage	schemaId(String schemaId)
FileUploadRequest._FinalStage	schemaId(Optional<String> schemaId)	Optional ID of a record schema to bind this document to.
FileUploadRequest._FinalStage	userId(String userId)
FileUploadRequest._FinalStage	userId(Optional<String> userId)	Owning user ID — the Vectros-assigned UUID of a user in your account.

Method Details

build

FileUploadRequest build()

additionalProperty

FileUploadRequest._FinalStage additionalProperty(String key,
 Object value)

additionalProperties

FileUploadRequest._FinalStage additionalProperties(Map<String,Object> additionalProperties)

indexMode

FileUploadRequest._FinalStage indexMode(Optional<FileUploadRequestIndexMode> indexMode)

Indexing strategy applied after the file is processed and its text is extracted. HYBRID runs both BM25 keyword and dense-vector semantic indexing (recommended). SEMANTIC indexes only as dense vectors. TEXT indexes only with BM25. NONE is store-only (archival): the file is still uploaded and its text extracted, but it is not search-indexed — retrievable by id/download and structured-field lookup only. Optional: omit to inherit the bound schema's default index mode. If neither this field nor the schema specifies one, the request is rejected. When both are set, this per-file value wins.

indexMode

FileUploadRequest._FinalStage indexMode(FileUploadRequestIndexMode indexMode)

folderId

FileUploadRequest._FinalStage folderId(Optional<String> folderId)

ID of the folder in which to place this document. Omit to use your account's default root folder.

folderId

FileUploadRequest._FinalStage folderId(String folderId)

payload

FileUploadRequest._FinalStage payload(Optional<Map<String,Object>> payload)

The document's structured data, as a flat key/value object. When schemaId is set, declared fields are validated against the schema and its lookup fields become directly queryable (matching record and text-ingest behavior); undeclared keys pass through as free-form and are searchable via the filters parameter on POST /v1/search.

payload

FileUploadRequest._FinalStage payload(Map<String,Object> payload)

schemaId

FileUploadRequest._FinalStage schemaId(Optional<String> schemaId)

Optional ID of a record schema to bind this document to. When set, the document's payload is validated against the schema and its lookup fields become directly queryable (matching record and text-ingest behavior).

schemaId

FileUploadRequest._FinalStage schemaId(String schemaId)

userId

FileUploadRequest._FinalStage userId(Optional<String> userId)

Owning user ID — the Vectros-assigned UUID of a user in your account. Optional. With an API key, sets the document's owner explicitly. With a scoped token, must match the token's identity claim (if set) or fall within its data scope.

userId

FileUploadRequest._FinalStage userId(String userId)

orgId

FileUploadRequest._FinalStage orgId(Optional<String> orgId)

Owning organization ID — the Vectros-assigned UUID of an organization in your account. Optional. With an API key, sets the document's owning organization explicitly. With a scoped token, must match the token's identity claim (if set) or fall within its data scope.

orgId

FileUploadRequest._FinalStage orgId(String orgId)

clientId

FileUploadRequest._FinalStage clientId(Optional<String> clientId)

Associated client ID — the Vectros-assigned UUID of a client in your account. Optional. With an API key, sets the document's client explicitly. With a scoped token, must match the token's identity claim (if set) or fall within its data scope.

clientId

FileUploadRequest._FinalStage clientId(String clientId)

externalId

FileUploadRequest._FinalStage externalId(Optional<String> externalId)

Stable, caller-supplied identifier for this document. Optional. Immutable after create. Unique within your account and context: initiating an upload again with the same externalId returns the same document plus a fresh presigned URL (idempotent — no duplicate), and it is the key other records use to reference this one. Max 256 characters.

externalId

FileUploadRequest._FinalStage externalId(String externalId)