TrueRecord SDK for Python

TrueRecord keeps a record of every interaction with an AI system in your app. This SDK sends those records. Each message is encrypted before it leaves your process, so only TrueRecord can process it. See the TrueRecord SDK docs for setup and guides.

Requires Python 3.9+.

Install

pip install truerecord-sdk

Quick start

from truerecord_sdk import TrueRecordClient, TrueRecordError

client = TrueRecordClient(
    api_key="tr_sk_...",
    public_key=open("truerecord_public.pem").read(),
    application_guid="...",
    interaction_guid="...",
)

try:
    # Send the message your user sends to the LLM
    client.send(user_message, "user", conversation_ref="session-42")

    # Send a message from the LLM to the user
    client.send(llm_message, "llm", conversation_ref="session-42")
except TrueRecordError as e:
    print(e)

What to send

Each call to send creates a record of one message, either what the user sent ("user") or what the LLM sent ("llm"). Use the same conversation_ref for both so TrueRecord can pair them.

client.send(message, origin, message_datetime=None, conversation_ref=None, hook=None)

Implementation details

Non-blocking (recommended)

Sending data to TrueRecord runs in the background so the rest of your code continues without waiting for TrueRecord to respond.

Synchronous apps

For apps using Flask, Django or scripts and CLI tools. Use a thread pool to send in the background.

from concurrent.futures import ThreadPoolExecutor

executor = ThreadPoolExecutor(max_workers=4)

executor.submit(client.send, user_message, "user", conversation_ref="session-42")
executor.submit(client.send, llm_message, "llm", conversation_ref="session-42")

Asynchronous apps

For apps using FastAPI, Starlette, aiohttp or functions defined with async. Use asyncio.create_task to send in the background.

import asyncio

asyncio.create_task(client.asend(user_message, "user", conversation_ref="session-42"))
asyncio.create_task(client.asend(llm_message, "llm", conversation_ref="session-42"))

Blocking

Sending data to TrueRecord waits for TrueRecord to respond before the rest of your code continues.

Synchronous apps

client.send(user_message, "user", conversation_ref="session-42")
client.send(llm_message, "llm", conversation_ref="session-42")

Asynchronous apps

await client.asend(user_message, "user", conversation_ref="session-42")
await client.asend(llm_message, "llm", conversation_ref="session-42")

Errors

All errors extend TrueRecordError, so you can catch them in one place.

License

MIT