Skip to content

EigenLake Python Client

eigenlake is the Python SDK for interacting with EigenLake API servers.

Install

pip install eigenlake

Quickstart

import eigenlake
from eigenlake import schema as s

with eigenlake.connect(
    url="https://api.eigenlake.dev",
    api_key="<sk_sbx_your_api_key_here>",
) as client:
    schema, index_options = (
        s.SchemaBuilder(additional_properties=False)
        .add("document_id", s.string(required=True, filterable=True))
        .add("text", s.string(filterable=False))
        .build()
    )

    idx = client.indexes.create_or_get(
        namespace="demo-namespace",
        index="demo-index",
        dimensions=128,
        schema=schema,
        index_options=index_options,
    )

    idx.records.add(
        properties={"document_id": "doc-1", "text": "hello"},
        vector=[0.1] * 128,
    )

Concepts

  • namespace: top-level logical grouping for indexes.
  • index: vector index name inside a namespace.
  • record: one item with properties + vector.
  • cluster: a group of matching records found by vector similarity.
  • agent query: a natural language request that EigenLake maps to filtering or clustering.

Next Steps