Package ai.vectros.resources.documents.requests

Class DocumentLookupRequest

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

  • Method Details

    • getType

      public String getType()
      Returns:
      Document type to look up (the type defined by the bound schema).

    • getField

      public String getField()
      Returns:
      The field to look up by. Use externalId to look up by the document's external identifier (no schema declaration required), or the name of any lookup field declared on the bound schema. For a sensitive field, this body variant is required (the GET variant rejects sensitive-field lookups).

    • getValue

      public Optional<String> getValue()
      Returns:
      Exact value to match (equality mode). Mutually exclusive with from/to and prefix.

    • getFrom

      public Optional<String> getFrom()
      Returns:
      Inclusive lower bound for a range lookup (requires to; non-sensitive, range-enabled fields only). Mutually exclusive with value and prefix.

    • getTo

      public Optional<String> getTo()
      Returns:
      Inclusive upper bound for a range lookup (requires from; mutually exclusive with value and prefix).

    • getPrefix

      public Optional<String> getPrefix()
      Returns:
      Prefix to match for a prefix lookup (range-enabled string fields only). Mutually exclusive with value and from/to.

    • getStartFrom

      public Optional<String> getStartFrom()
      Returns:
      Pagination cursor. Pass the nextCursor from the previous page to fetch the next page; omit it for the first page.

    • getLimit

      public Optional<Integer> getLimit()
      Returns:
      Maximum number of documents to return per page (1–100; defaults to 20).

    • getOrder

      public Optional<DocumentLookupRequestOrder> getOrder()
      Returns:
      Sort direction for the returned results: asc (default) or desc.

    • getUserId

      public Optional<String> getUserId()
      Returns:
      Root API key ONLY: resolve type's schema as this user would (basedOn-aware shadowing) instead of the shared base — mirrors GET /v1/schemas?recordType='s userId selector. Ignored for a scoped credential, which always resolves via its own token identity.

    • getScope

      public Optional<String> getScope()
      Returns:
      Root API key ONLY: resolve type's schema as this scope would (basedOn-aware shadowing), as a single namespace:value entry — mirrors GET /v1/schemas?recordType='s scope selector. Ignored for a scoped credential.

    • 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 DocumentLookupRequest.TypeStage builder()