Package ai.vectros.resources.documents.requests

Class FileUploadRequest

java.lang.Object
ai.vectros.resources.documents.requests.FileUploadRequest
public final class FileUploadRequest extends Object

  • Method Details

    • getUpsert

      public Optional<Boolean> getUpsert()
      Returns:
      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.

    • getFileName

      public String getFileName()
      Returns:
      Original file name, including its extension. Used as the document title when no separate title is provided.

    • getFileType

      public String getFileType()
      Returns:
      MIME type of the file being uploaded. Used to set the correct Content-Type on the stored object.

    • getIndexMode

      public Optional<FileUploadRequestIndexMode> getIndexMode()
      Returns:
      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.

    • getStoreText

      public Optional<Boolean> getStoreText()
      Returns:
      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.

    • getFolderId

      public Optional<String> getFolderId()
      Returns:
      ID of the folder in which to place this document. Omit to use your account's default root folder.

    • getPayload

      public Optional<Map<String,Object>> getPayload()
      Returns:
      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.

    • getSchemaId

      public Optional<String> getSchemaId()
      Returns:
      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).

    • getUserId

      public Optional<String> getUserId()
      Returns:
      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 the owning user is attributed by the server from your credential and cannot be set to a different user; supplying one that conflicts is rejected.

    • getScopes

      public Optional<List<String>> getScopes()
      Returns:
      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 reserved namespace names, registered like any other; others are namespaces you registered yourself (lowercase, 2-32 chars). A value is 1-128 characters: a letter or digit first, then letters, digits, _ or -. 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: each entry must fall inside the data_scope of a single clause of your credential that also grants this write — your identity supplies the DEFAULT value when you state none, it does not limit which value you may state. An empty array creates a document owned by the calling user alone (the private tier), and requires a credential whose identity carries a user. Omit the field to inherit the token's full identity — the default. Filter lists by these values with ?scope=.

    • getExternalId

      public Optional<String> getExternalId()
      Returns:
      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.

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static FileUploadRequest.FileNameStage builder()