Hypergraph is more powerful. Transform unstructured text into structured knowledge with LLMs. Graphs, hypergraphs, and spatio-temporal extractions — with one command.
Provider Configuration Guide
Configure Hyper-Extract to work with OpenAI, Bailian (Alibaba Cloud), DeepSeek, OrcaRouter, Atlas Cloud, Runcrate, Cheaper Inference, or local vLLM deployments.
Unified Example
All three platforms run the same extraction task below. Only the client setup (first 3 lines) changes.
OpenAI
from hyperextract import create_client, AutoGraph
llm, emb = create_client("openai", api_key="sk-xxx")
Alibaba Bailian
from hyperextract import create_client, AutoGraph
llm, emb = create_client("bailian", api_key="sk-xxx")
# Or override model: create_client("bailian:qwen3.6-plus", api_key="sk-xxx")
Anthropic (Claude)
from hyperextract import create_client, AutoGraph
# Anthropic is LLM only — pair it with an OpenAI-compatible embedder.
# Keys: ANTHROPIC_API_KEY (or CLAUDE_API_KEY) for the LLM, OPENAI_API_KEY for embeddings.
llm, emb = create_client(
llm="anthropic", # default model: claude-opus-4-8 (override with "anthropic:<model>")
embedder="openai:text-embedding-3-small",
)
DeepSeek
from hyperextract import create_client, AutoGraph
# DeepSeek is OpenAI-compatible but has no embeddings API — pair it with an
# OpenAI-compatible embedder. The V4 models default to "thinking" mode, which
# Hyper-Extract auto-disables so structured extraction works out of the box.
llm, emb = create_client(
llm="deepseek", # default: deepseek-v4-flash; override with "deepseek:deepseek-v4-pro"
embedder="openai:text-embedding-3-small",
)
OrcaRouter
from hyperextract import create_client, AutoGraph
# OrcaRouter is an OpenAI-compatible gateway routing 150+ models (OpenAI,
# Anthropic, Google, DeepSeek, Qwen, MiniMax, xAI) behind one endpoint and key.
# Key: ORCAROUTER_API_KEY (fallback: OPENAI_API_KEY).
llm, emb = create_client("orcarouter")
# Or override the model: create_client("orcarouter:openai/gpt-4o-mini", ...)
Atlas Cloud
from hyperextract import create_client, AutoGraph
# Atlas Cloud is an OpenAI-compatible gateway (DeepSeek, Z.ai, Moonshot, Qwen,
# MiniMax, OpenAI, Anthropic, Google) with vendor-prefixed model ids.
# LLM only — pair it with an OpenAI-compatible embedder.
# Key: ATLASCLOUD_API_KEY (fallback: OPENAI_API_KEY).
llm, emb = create_client(
llm="atlascloud",
embedder="openai:text-embedding-3-small",
)
# Or override the model: create_client(llm="atlascloud:moonshotai/kimi-k3", ...)
Runcrate
from hyperextract import create_client
# Runcrate is an OpenAI-compatible API for open models with vendor-prefixed ids.
# It also serves embeddings, so one key covers the LLM and the embedder.
# Key: RUNCRATE_API_KEY.
llm, emb = create_client(
llm="runcrate", # default model: deepseek-ai/DeepSeek-V4.1-Flash
embedder="runcrate", # default embedder: BAAI/bge-m3
)
# Or override the model: create_client(llm="runcrate:openai/gpt-oss-120b", ...)
API Route
Set API_ROUTE_API_KEY to a key from API Route.
The preset uses https://global.api-route.com/v1 and defaults to gpt-6.1-sol.
Configure an embedding provider separately:
from hyperextract import create_client
# Keys: API_ROUTE_API_KEY for the LLM, OPENAI_API_KEY for embeddings.
llm, emb = create_client(
llm="api-route", # override with "api-route:<model-id>"
embedder="openai:text-embedding-3-small",
)
Use a model ID from the model catalog or
the authenticated GET https://global.api-route.com/v1/models response.
For CLI configuration:
he config llm -p api-route -m gpt-6.1-sol
he config embedder -p openai -m text-embedding-3-small
Cheaper Inference
from hyperextract import create_client
# Cheaper Inference is an OpenAI-compatible gateway with one key for models
# from several labs. It has no embeddings API, so pair it with another embedder.
# Key: CHEAPER_INFERENCE_API_KEY.
llm, emb = create_client(
llm="cheaperinference", # default model: gpt-5.4-mini
embedder="openai:text-embedding-3-small",
)
Local vLLM
from hyperextract import create_client, AutoGraph
llm, emb = create_client(
llm="vllm:Qwen3.5-9B@http://localhost:8000/v1",
embedder="vllm:bge-m3@http://localhost:8001/v1",
api_key="dummy",
)
Extraction Task (same for all)
graph = AutoGraph(
instruction="Extract people and their relationships",
llm_client=llm,
embedder=emb,
node_key_extractor=lambda n: n.name,
edge_key_extractor=lambda e: (e.source, e.target, e.type),
nodes_in_edge_extractor=lambda e: (e.source, e.target),
)
text = "Zhang San founded ByteDance. Li Si serves as CEO."
graph.parse(text)
print(f"Nodes: {len(graph.nodes)}, Edges: {len(graph.edges)}")
CLI Equivalents
| Platform | Command |
|---|---|
| OpenAI | he config init -p openai -k sk-xxx |
| Bailian | he config init -p bailian -k sk-xxx |
| Anthropic | he config llm -p anthropic -k sk-ant-xxx + he config embedder -p openai -k sk-xxx |
| DeepSeek | he config llm -p deepseek -k sk-xxx + he config embedder -p openai -k sk-xxx |
| OrcaRouter | he config init -p orcarouter -k sk-orca-xxx |
| Cheaper Inference | he config llm -p cheaperinference -m gpt-5.4-mini -k ci_live_xxx + he config embedder -p openai -k sk-xxx |
| Atlas Cloud | he config llm -p atlascloud -k xxx + he config embedder -p openai -k sk-xxx |
| Runcrate | he config init -p runcrate -k rc_live_xxx |
| vLLM | he config init → select "local vLLM" |
| Mixed (LLM=Bailian, Embedder=vLLM) | he config llm -p bailian -k sk-xxx + he config embedder -p vllm -u http://localhost:8001/v1 -k dummy |
String Shorthand Format
create_client() supports a compact string syntax for quick configuration:
| Format | Example | Result |
|---|---|---|
provider |
"bailian" |
Uses preset defaults for LLM + embedder |
provider:model |
"bailian:qwen3.6-plus" |
Overrides LLM model, keeps preset embedder |
provider:model@url |
"vllm:Qwen3.5-9B@localhost:8000/v1" |
Full manual specification |
Using Config File Instead
If you prefer file-based configuration, run he config init once and then use Template.create() or get_client():
from hyperextract import get_client, AutoGraph
llm, emb = get_client() # Reads ~/.he/config.toml
graph = AutoGraph(..., llm_client=llm, embedder=emb)
See Also
- Provider System & Model Compatibility — Full compatibility table and vLLM deployment guide
- CLI Configuration Reference — Complete
he configcommand reference