mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-13 07:12:57 +00:00
6fa1f37506
Address usage mistakes in https://github.com/lancedb/lancedb/issues/2135. * Add example of how to use `LanceModel` and `Vector` decorator * Add test for pydantic doc * Fix the example to directly use LanceModel instead of calling `MyModel.to_arrow_schema()` in the example. * Add cross-reference link to pydantic doc site * Configure mkdocs to watch code changes in python directory.
48 lines
1.6 KiB
Markdown
48 lines
1.6 KiB
Markdown
# Pydantic
|
|
|
|
[Pydantic](https://docs.pydantic.dev/latest/) is a data validation library in Python.
|
|
LanceDB integrates with Pydantic for schema inference, data ingestion, and query result casting.
|
|
Using [LanceModel][lancedb.pydantic.LanceModel], users can seamlessly
|
|
integrate Pydantic with the rest of the LanceDB APIs.
|
|
|
|
```python
|
|
|
|
--8<-- "python/python/tests/docs/test_pydantic_integration.py:imports"
|
|
|
|
--8<-- "python/python/tests/docs/test_pydantic_integration.py:base_model"
|
|
|
|
--8<-- "python/python/tests/docs/test_pydantic_integration.py:set_url"
|
|
--8<-- "python/python/tests/docs/test_pydantic_integration.py:base_example"
|
|
```
|
|
|
|
|
|
## Vector Field
|
|
|
|
LanceDB provides a [`Vector(dim)`](python.md#lancedb.pydantic.Vector) method to define a
|
|
vector Field in a Pydantic Model.
|
|
|
|
::: lancedb.pydantic.Vector
|
|
|
|
## Type Conversion
|
|
|
|
LanceDB automatically convert Pydantic fields to
|
|
[Apache Arrow DataType](https://arrow.apache.org/docs/python/generated/pyarrow.DataType.html#pyarrow.DataType).
|
|
|
|
Current supported type conversions:
|
|
|
|
| Pydantic Field Type | PyArrow Data Type |
|
|
| ------------------- | ----------------- |
|
|
| `int` | `pyarrow.int64` |
|
|
| `float` | `pyarrow.float64` |
|
|
| `bool` | `pyarrow.bool` |
|
|
| `str` | `pyarrow.utf8()` |
|
|
| `list` | `pyarrow.List` |
|
|
| `BaseModel` | `pyarrow.Struct` |
|
|
| `Vector(n)` | `pyarrow.FixedSizeList(float32, n)` |
|
|
|
|
LanceDB supports to create Apache Arrow Schema from a
|
|
[Pydantic BaseModel][pydantic.BaseModel]
|
|
via [pydantic_to_schema()](python.md#lancedb.pydantic.pydantic_to_schema) method.
|
|
|
|
::: lancedb.pydantic.pydantic_to_schema
|