examples

Hyper-Extract Examples

Examples directory with bilingual demos (English & Chinese).

Quick Start

Provider Setup (choose one)

cd examples

# OpenAI
python providers/openai_demo.py

# Bailian (Alibaba Cloud)
python providers/bailian_demo.py

# DeepSeek
python providers/deepseek_demo.py

# Local vLLM
python providers/vllm_demo.py

Full Auto-Type Demos

cd examples

# English
python en/autotypes/graph_demo.py

# Chinese
python zh/autotypes/graph_demo.py

Directory Structure

examples/
├── README.md
├── providers/                   # Provider configuration demos
│   ├── openai_demo.py          # OpenAI setup
│   ├── bailian_demo.py         # Bailian (Alibaba Cloud) setup
│   ├── deepseek_demo.py        # DeepSeek setup
│   └── vllm_demo.py            # Local vLLM setup
├── en/                          # English demos
│   ├── tesla.md                # Tesla biography data
│   ├── tesla_question.md       # Query questions
│   ├── autotypes/             # AutoType demos
│   │   ├── graph_demo.py       # Knowledge graph
│   │   ├── list_demo.py        # List extraction
│   │   ├── set_demo.py         # Set extraction
│   │   ├── model_demo.py       # Model extraction
│   │   ├── temporal_graph_demo.py     # Temporal graph
│   │   ├── spatial_graph_demo.py      # Spatial graph
│   │   ├── spatio_temporal_graph_demo.py  # Spatio-temporal
│   │   └── hypergraph_demo.py  # Hypergraph
│   ├── methods/               # RAG method demos
│   │   ├── atom_demo.py
│   │   ├── cog_rag_demo.py
│   │   ├── graph_rag_demo.py
│   │   ├── hyper_rag_demo.py
│   │   ├── hypergraph_rag_demo.py
│   │   ├── itext2kg_demo.py
│   │   ├── itext2kg_star_demo.py
│   │   ├── kg_gen_demo.py
│   │   └── light_rag_demo.py
│   └── templates/             # Template demos
│       ├── finance_template.py
│       ├── general_template.py
│       ├── industry_template.py
│       ├── legal_template.py
│       ├── list_templates.py
│       ├── medicine_template.py
│       └── tcm_template.py
│
└── zh/                          # Chinese demos
    ├── sushi.md               # Su Shi biography data
    ├── sushi_question.md      # Query questions
    ├── autotypes/             # AutoType demos
    │   ├── graph_demo.py
    │   ├── list_demo.py
    │   ├── set_demo.py
    │   ├── model_demo.py
    │   ├── temporal_graph_demo.py
    │   ├── spatial_graph_demo.py
    │   ├── spatio_temporal_graph_demo.py
    │   └── hypergraph_demo.py
    ├── methods/               # RAG method demos
    │   ├── atom_demo.py
    │   ├── cog_rag_demo.py
    │   ├── graph_rag_demo.py
    │   ├── hyper_rag_demo.py
    │   ├── hypergraph_rag_demo.py
    │   ├── itext2kg_demo.py
    │   ├── itext2kg_star_demo.py
    │   ├── kg_gen_demo.py
    │   └── light_rag_demo.py
    └── templates/             # Template demos
        ├── finance_template.py
        ├── general_template.py
        ├── industry_template.py
        ├── legal_template.py
        ├── list_templates.py
        ├── medicine_template.py
        └── tcm_template.py

AutoType Demos

Each demo showcases a specific extraction type:

Demo	Description
graph_demo.py	Extract entities & relationships (knowledge graph)
list_demo.py	Extract list of items
set_demo.py	Extract deduplicated set
model_demo.py	Extract structured summary
temporal_graph_demo.py	Extract temporal relationships
spatial_graph_demo.py	Extract spatial relationships
spatio_temporal_graph_demo.py	Extract both time & space
hypergraph_demo.py	Extract multi-entity relationships

Data Files

Tesla (en/tesla.md)

Nikola Tesla biography (1856-1943):

• Early life & education
• Work with Edison
• War of Currents
• Colorado Springs experiments
• Wardenclyffe Tower

Su Shi (zh/sushi.md)

苏轼传记 (1037-1101):

• 早年与家学
• 仕途与起伏
• 乌台诗案
• 与佛印的友谊
• 杭州岁月
• 晚年与贬谪

Requirements

# Install hyperextract (dependencies are automatically installed)
uv pip install hyperextract

# Configure API key
# Option 1: Use .env file (recommended)
cp .env.example .env
# Then edit .env with your OPENAI_API_KEY and OPENAI_BASE_URL

# Option 2: Set environment variable
export OPENAI_API_KEY=your-key