Practical overview
When it fits
Use it when an existing or planned VLM workflow needs a reusable structured output model, such as an invoice schema for document extraction.
Who it is for
- Python developers building document-processing or visual ETL workflows
- Teams that need consistent typed fields from VLM-based image, video or document extraction
Documented uses
- Select an industry- or document-specific schema for visual extraction.
- Define validated, typed output structures for downstream processing.
- Connect a reusable schema to a VLM integration.
Requirements & limits
The public GitHub repository declares an Apache-2.0 license. The README documents installation through pip.
- The library supplies schemas; a separate VLM provider or integration performs inference.
- The README demonstrates both the VLM Run Python SDK and Instructor with OpenAI.
- The schema catalog includes document-processing examples, with additional visual-input use cases described for images, videos and documents.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Set up invoice extraction with Instructor and OpenAI
Use the hub’s Invoice Pydantic schema as the response model in an Instructor/OpenAI image-extraction request.
Before you start
- Python and the vlmrun-hub package
- Instructor and the OpenAI Python client
- An OpenAI client configured for access
- An invoice image URL
Steps
Install the schema package with the command below.
pip install vlmrun-hubImport
Invoicefromvlmrun.hub.schemas.document.invoice.Create an Instructor-wrapped OpenAI client using the documented
MD_JSONmode.Submit a chat completion with the invoice image and set
response_model=Invoice.
Expected outcome
The request is configured to return invoice information in the structure defined by the Invoice schema.
Guide limitations
- The hub supplies the schema, not the model inference service.
- The README example uses OpenAI and Instructor; it does not document setup for other providers in this recipe.
Set up invoice extraction with the VLM Run Python SDK
Configure the documented SDK example to send an invoice image for the `document.invoice` domain.
Before you start
- Python, the vlmrun-hub package and the VLM Run Python SDK
- A VLM Run API key and the documented API base URL
- An invoice image
Steps
Install the schema package with the command below.
pip install vlmrun-hubConfigure the SDK client with the VLM Run base URL and API key.
Load an invoice image and call
client.image.generatewith the image anddomain="document.invoice".
Expected outcome
The example submits the invoice image to the SDK using the invoice domain and receives a prediction response.
Guide limitations
- This recipe uses VLM Run’s separate SDK and service; the hub itself provides schemas.
- The README example uses a specific public sample image URL.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 14 October 2026
- Original website title
- vlm-run/vlmrun-hub · Official homepage title · retained in its source language

