Documentation

Python SDK

The official BIE client for Python. Built on top of httpx and Pydantic, it fits naturally into data pipelines, notebooks, and backend services.

Note

The Python SDK is currently in scaffold stage. The surface below matches the TypeScript SDK one-for-one; track the package on PyPI once the first release is published.

Install

bash

pip install bie-sdk

Initialize

python

from bie import BIEClient

bie = BIEClient(api_key="bie_your_key_here")

analyze(events, pipeline="auto")

One-shot ingest-and-wait. The most common usage pattern.

python

events = [
    {
        "actor_id": "reviewer_1",
        "content": "Great pizza, fast delivery",
        "timestamp": "2026-04-01T18:00:00Z",
    },
    {
        "actor_id": "reviewer_2",
        "content": "Cold food, will not return",
        "timestamp": "2026-04-02T19:00:00Z",
    },
]

intelligence = bie.analyze(events)
print(intelligence.plain_summary)
for rec in intelligence.plain_recommendations:
    print("-", rec)

ingest and wait_for_intelligence

Split the two calls when you want to handle polling yourself or hand the session off to a background worker.

python

session = bie.ingest(events, deployment_id="cx_chatbot_prod")
intelligence = bie.wait_for_intelligence(session.session_id, timeout_seconds=120)

register_webhook(url, events=None)

python

webhook = bie.register_webhook("https://yourapp.com/webhooks/bie")
print(webhook.secret)  # save this, shown once

TODO

Publish to PyPI, add type stubs, document async variants (AsyncBIEClient), and round out the cookbook with notebook examples.