Quickstart

pip install viscribe

from pydantic import BaseModel, Field
from viscribe.images import extract

class Receipt(BaseModel):
merchant_name: str | None = Field(description="Store or business name")
total_amount: float | None = Field(description="Final total on the receipt")
date: str | None = Field(description="Receipt date if visible")
line_items: list[str] = Field(description="Visible purchased items")

result = extract(
image_path="examples/receipt.png",
output_schema=Receipt,
instruction="Extract the receipt fields visible in the image.",
model_config={
"model": "gpt-5-mini",
"temperature": 1,
},
)

print(result.data.model_dump())

extract(image_path="examples/receipt.png", output_schema=Receipt)
extract(image_url="https://example.com/receipt.png", output_schema=Receipt)
extract(image_base64="iVBORw0KGgo...", output_schema=Receipt)