yifanfeng97/hyper-extract/graph-designer

Graph Designer: graph/hypergraph/temporal/spatial

Input from Brainstorm

Receive design specs from brainstorm:

• Entity types and fields
• Relation types and fields
• Hypergraph grouping strategy
• Time/location requirements

Workflow

1. Confirm type based on brainstorm specs
2. Design entities (output.entities)
3. Design relations (output.relations)
4. Configure identifiers (identifiers)
5. Set display (display)
6. Write guideline (guideline)
7. Review and output YAML

Critical: Output vs Guideline

Key Principle: Schema defines "WHAT", Guideline defines "HOW TO DO WELL". DO NOT repeat schema definitions in guideline.

Type Confirmation

Output Template

language: en
 
name: [TemplateName]
type: [type]
tags: [...]
description: '...'
 
output:
  entities:
    description: '...'
    fields:
      - name: name
        type: str
      - name: category
        type: str
  relations:
    description: '...'
    fields:
      # Type-specific fields
 
guideline:
  target: 'You are a [domain] expert...'
  rules_for_entities: [...]
  rules_for_relations: [...]
 
identifiers:
  entity_id: name
  relation_id: '...'
  relation_members: ...
 
display:
  entity_label: '{name} ({category})'
  relation_label: '...'

Display Design Principles

Important: display.label is used for graph visualization. Edges connect two nodes (source/target), so the edge label should NOT repeat this information.

Design Principles

Recommended relation_label by Type

Length Reference

• entity_label: Recommended 5-20 characters
• relation_label: Recommended 10-30 characters

Quick Config Reference

Binary Relations (graph)

identifiers:
  relation_members:
    source: source
    target: target

Hypergraph Simple

identifiers:
  relation_members: participants  # STRING

Hypergraph Nested

identifiers:
  relation_members: [group_a, group_b]  # LIST

Temporal

identifiers:
  time_field: event_date

Spatial

identifiers:
  location_field: location

Cases by Type

Important: Load only the case matching user's selected type.

Reference Files

Important: Check these files only when needed for the specific design task.

Design Checklist

Entities

• [ ] Entity types cover key concepts?
• [ ] Entity granularity appropriate?
• [ ] Multi-type nodes handled?
• [ ] No redundant fields?

Relations

• [ ] Relation types semantically clear?
• [ ] source/target reference entities?
• [ ] No ambiguous relations?

Guideline (Must Check)

• [ ] No field definitions repeated from schema?
• [ ] Extraction strategy defined?
• [ ] Quality requirements specified (naming consistency)?
• [ ] Creation conditions clear ("only when text explicitly states")?
• [ ] Common mistakes warned?

Hypergraph

• [ ] Participant count reasonable?
• [ ] Grouping strategy clear?
• [ ] Outcome defined?

Identifiers

• [ ] entity_id references name field?
• [ ] relation_id template correct?
• [ ] relation_members configured?
• [ ] time/location_field specified?

Multi-language

• [ ] zh descriptions use pure Chinese (no English terms like entity(...))
• [ ] en descriptions use pure English (no Chinese characters)

Entity-Relation Consistency

• [ ] source/target types match entities definition

Relation Type Design

For generic templates: Use open-ended description

en: 'Relation type, concisely describing the connection between entities'

For domain-specific templates: Can use predefined types

en: 'Relation type: type_a/type_b/type_c'