Trieve Python Client

0.12.12 verified Fri May 01 auth: no python

Official Python client for the Trieve API, a search and recommendation platform. Current version 0.12.12. Actively maintained with frequent releases.

pip install trieve-py-client

Common errors

error 'module' object has no attribute 'Trieve' ↓

cause Wrong import: using 'import trieve_py_client' without from.

fix

Use: from trieve_py_client import Trieve

error TypeError: __init__() missing 1 required positional argument: 'api_client' ↓

cause Passing Configuration directly to Trieve instead of ApiClient.

fix

client = Trieve(ApiClient(config))

error 'Trieve' object has no attribute 'search' ↓

cause Trying to call search on the Trieve instance after API changes.

fix

Use client.search_api.search(...)

Warnings

breaking In version 0.12.0, the 'search' method signature changed. 'search_query' is now required as a named parameter. ↓

fix Use client.search_api.search(tr_dataset='...', search_query='...').

gotcha The 'Trieve' class constructor expects an 'ApiClient' instance, not a 'Configuration' directly. ↓

fix client = Trieve(ApiClient(config))

deprecated The method 'search' on the 'Trieve' class directly was deprecated in favor of 'search_api.search'. ↓

fix Use client.search_api.search(...) instead of client.search(...).

Imports

Trieve
```
from trieve_py_client import Trieve
```
ApiClient
```
from trieve_py_client import ApiClient
```

Configuration

from trieve_py_client import Configuration

SearchApi

from trieve_py_client.api.search_api import SearchApi

Quickstart

Initialize client with API key and perform a search.

import os
from trieve_py_client import Trieve, ApiClient, Configuration

api_key = os.environ.get('TRIEVE_API_KEY', 'your-api-key')
config = Configuration(api_key={'ApiKey': api_key})
client = Trieve(ApiClient(config))

# Example: search
query = 'python client'
results = client.search_api.search(
    tr_dataset='your-dataset-id',
    search_query=query,
    page_size=10
)
print(results)