NucliaDB

6.13.0.post6240 verified Sat May 09 auth: no python

NucliaDB is a semantic database for managing and querying unstructured data with AI-powered search. Version 6.13.0.post6240 supports Python >=3.10, <4.

pip install nucliadb

Common errors

error ModuleNotFoundError: No module named 'nucliadb_client' ↓

cause Package renamed; old import path no longer exists.

fix

Run 'import nucliadb' and use 'from nucliadb import NucliaDBClient'.

error ImportError: cannot import name 'NucliaDBSearch' from 'nucliadb.search' ↓

cause Search class moved to top-level package in v6.

fix

Use 'from nucliadb import NucliaDBSearch' instead.

error AttributeError: 'NucliaDBClient' object has no attribute 'list_resources' ↓

cause Method renamed or not available in older versions.

fix

Check documentation for correct method name; use 'client.resources.list()' if appropriate.

error ValueError: Invalid API key format ↓

cause API key not set or incorrect encoding.

fix

Ensure NUCLIADB_API_KEY environment variable is set and valid. For local development, set a dummy key.

Warnings

breaking Python 3.10 minimum: versions <3.10 are not supported. ↓

fix Upgrade to Python >=3.10.

deprecated Old nucliadb_client package is deprecated. Use top-level nucliadb module. ↓

fix Replace 'from nucliadb_client import ...' with 'from nucliadb import ...'.

gotcha Access/secret keys: Provide via environment variables or config, not hardcoded. ↓

fix Use os.environ.get('NUCLIADB_ACCESS_KEY', '') and NUCLIADB_SECRET_KEY.

gotcha Async vs sync client: Misusing blocking calls in async context. ↓

fix Use NucliaDBClient for sync, NucliaDBAsyncClient for async; await methods appropriately.

Imports

NucliaDBClient

wrong

from nucliadb_client import NucliaDBClient

correct

from nucliadb import NucliaDBClient

Old client package was renamed in v6.

NucliaDBSearch

wrong

from nucliadb.search import NucliaDBSearch

correct

from nucliadb import NucliaDBSearch

Search class moved to top-level in v6.

Quickstart

Initialize client and list resources.

import os
from nucliadb import NucliaDBClient
client = NucliaDBClient(
    url=os.environ.get('NUCLIADB_URL', 'http://localhost:8080'),
    api_key=os.environ.get('NUCLIADB_API_KEY', '')
)
resources = client.list_resources()
print(resources)