# Information Extraction Schema

`ie-schema` provides a flexible schema specification and parser for information extraction tasks.

```{toctree}
:maxdepth: 2
:caption: Contents

usage
Python API Reference <autoapi/ie_schema/index>
rust
```

## Installation

```bash
uv add ie_schema
```

## Quick start

```python
from dataclasses import dataclass
from ie_schema import IESchema

@dataclass
class BusinessRecord:
    business_name: str
    address_line1: str

# Native JSON schema, or a dataclass / Pydantic v2 model class/instance (install `pydantic`):
schema = IESchema.loads(BusinessRecord)
# schema = IESchema.loads('{"json_structures": ... }')

print(schema.prompt())
```

Install `pydantic` (e.g. `uv add 'ie_schema[model]'`) to use `IESchema.loads` with dataclass/Pydantic model classes or instances.