V1 Client Options

Predict Options

class PredictOptions(cropper=False, full_text=False, include_words=False)

Options to pass to a prediction.

Parameters:
  • cropper (bool)

  • full_text (bool)

  • include_words (bool)

Workflow Options

class WorkflowOptions(alias=None, priority=None, full_text=False, public_url=None, rag=False)

Options to pass to a workflow execution.

Parameters:
  • alias (str | None)

  • priority (ExecutionPriority | None)

  • full_text (bool)

  • public_url (str | None)

  • rag (bool)

alias: str | None

Alias for the document.

full_text: bool

Whether to include the full OCR text response in compatible APIs.

priority: ExecutionPriority | None

Priority of the document.

public_url: str | None

A unique, encrypted URL for accessing the document validation interface without requiring authentication.

rag: bool

Whether to enable Retrieval-Augmented Generation.