client.hub

Hub API Reference

The client.hub object provides access to domains and schemas for structured data extraction.

List Domains

from vlmrun.client import VLMRun
from vlmrun.client.types import HubDomainInfo, HubSchemaResponse

client = VLMRun()

# List all available domains
domains: List[HubDomainInfo] = client.hub.list_domains()

# Print domain information
for domain in domains:
    print(f"Domain: {domain.domain}")

Get Schema

# Get schema for a specific domain
schema: HubSchemaResponse = client.hub.get_schema("document.invoice")
print(f"version={schema.version}, hash={schema.hash}, json_schema={schema.json_schema}")