rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2025-12-26 06:39:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f2f0739f8c8889858533eb01a5b1fae02e626ab5
lancedb/docs/src/python/pydantic.md
Lei Xu b315ea3978 [Python] Pydantic vector field with default value (#474) 
Rename `lance.pydantic.vector` to `Vector` and deprecate `vector(dim)`
2023-09-08 22:35:31 -07:00

1.3 KiB
Raw Blame History

Pydantic

Pydantic is a data validation library in Python. LanceDB integrates with Pydantic for schema inference, data ingestion, and query result casting.

Schema

LanceDB supports to create Apache Arrow Schema from a Pydantic BaseModel via pydantic_to_schema() method.

::: lancedb.pydantic.pydantic_to_schema

Vector Field

LanceDB provides a Vector(dim) method to define a vector Field in a Pydantic Model.

::: lancedb.pydantic.Vector

Type Conversion

LanceDB automatically convert Pydantic fields to Apache Arrow 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)