Package ai.vectros.resources.documents.requests

Interface FileUploadRequest._FinalStage

All Known Implementing Classes:
FileUploadRequest.Builder
Enclosing class:
FileUploadRequest
public static interface FileUploadRequest._FinalStage

  • Method Details

    • build

      FileUploadRequest build()

    • additionalProperty

      FileUploadRequest._FinalStage additionalProperty(String key, Object value)

    • additionalProperties

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

    • upsert

      FileUploadRequest._FinalStage upsert(Optional<Boolean> upsert)

      When true and a document with the same externalId already exists, apply the submitted payload/title to that existing document (a metadata upsert) before re-issuing the presigned URL. The file body is replaced inherently by the re-upload; it cannot be diffed at upload-init. Defaults to false. Requires the documents:u scope in addition to documents:c.

    • upsert

      FileUploadRequest._FinalStage upsert(Boolean upsert)

    • 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)

    • storeText

      FileUploadRequest._FinalStage storeText(Optional<Boolean> storeText)

      Whether the text extracted from this file is retained after indexing. Defaults to true: the extracted text stays retrievable via GET /v1/documents/{id}/text and usable by POST /v1/documents/{id}/ask. Set false to discard the extracted text once indexing completes — search results and the original file download are unaffected, but /text returns 404 and /ask returns 409 for the document. Fixed at ingest time: it cannot be changed later, and a re-upload to the same document keeps the original choice.

    • storeText

      FileUploadRequest._FinalStage storeText(Boolean storeText)

    • 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)

    • scopes

      FileUploadRequest._FinalStage scopes(Optional<List<String>> scopes)

      The document's scope ownership, as namespace:value entries (at most 2 namespaces) — for example ["org:6ba7b810-9dad-11d1-80b4-00c04fd430c8", "group:eng-team"]. org and client are built-in namespaces; others are custom scopes you define (lowercase, 2-32 chars). Resolve a namespace's UUID from your own identifier with GET /v1/entities/{namespace}?externalId=. When supplied, this is the document's COMPLETE scope declaration: for a token that stamps identity, entries must match the token's identity values, and an empty array creates a document owned by the calling user alone (the private tier). Omit the field to inherit the token's full identity — the default. Filter lists by these values with ?scope=.

    • scopes

      FileUploadRequest._FinalStage scopes(List<String> scopes)

    • 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)