Interface: PerformOCROptions
Defined in: packages/agentos/src/api/performOCR.ts:50
Options accepted by performOCR.
Properties
apiKey?
optionalapiKey:string
Defined in: packages/agentos/src/api/performOCR.ts:103
API key for the cloud provider. It goes to provider, or to the provider
a model prefix names (openai:gpt-4o), and is refused with neither, so
it never reaches a provider picked from the environment. When omitted
the key is read from the standard environment variable for the provider.
baseUrl?
optionalbaseUrl:string
Defined in: packages/agentos/src/api/performOCR.ts:110
Base URL for the cloud provider, such as a proxy. It needs a named
provider, as apiKey does. An empty or whitespace-only value is unset
and needs none: the call runs as one with no baseUrl does.
confidenceThreshold?
optionalconfidenceThreshold:number
Defined in: packages/agentos/src/api/performOCR.ts:82
Minimum confidence threshold (0-1) to accept an OCR result from a local tier without escalating to the next tier.
Only meaningful for the 'progressive' strategy.
Default
0.7
image
image:
string|Buffer
Defined in: packages/agentos/src/api/performOCR.ts:59
Image source. Accepts any of:
- File path — absolute or relative filesystem path (e.g.
/tmp/scan.png). - URL — HTTP(S) URL to fetch the image from.
- Base64 string — raw base64-encoded image data (with or without a
data:image/...;base64,prefix). - Buffer — in-memory image bytes.
model?
optionalmodel:string
Defined in: packages/agentos/src/api/performOCR.ts:95
Cloud LLM model override. When omitted the provider's default vision
model is used (e.g. gpt-4o for OpenAI).
provider?
optionalprovider:string
Defined in: packages/agentos/src/api/performOCR.ts:89
Cloud LLM provider for tier-3 fallback (e.g. 'openai', 'anthropic',
'google'). When omitted the provider is auto-detected from environment
variables (OPENAI_API_KEY, ANTHROPIC_API_KEY, etc.).
strategy?
optionalstrategy:"progressive"|"local-only"|"cloud-only"
Defined in: packages/agentos/src/api/performOCR.ts:72
Vision strategy controlling which tiers are used.
'progressive'— start local, escalate to cloud only when confidence is below confidenceThreshold. Best cost/quality balance.'local-only'— never call cloud APIs. For air-gapped / privacy use.'cloud-only'— skip local processing, send straight to a cloud LLM. Highest quality but highest cost.
Default
'progressive'