Basic Configuration
Initialize the SDK with your organization ID:Configuration Options
SDK Initialization (agnost.init)
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | str | Required | - | Your organization ID from the Agnost AI dashboard |
debug | bool | No | False | Enable debug logging for troubleshooting |
Begin/End Tracking (agnost.begin)
Start interaction with agnost.begin():| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | str | No | "" | Identifier for the user |
agent_name | str | No | "default" | Name of the AI agent or model |
input | str | No | None | Input text or prompt (can also set later with set_input()) |
conversation_id | str | No | None | ID to group related messages in a conversation |
properties | dict | No | None | Additional metadata as key-value pairs |
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
output | str | No | None | Output or response from the AI agent |
success | bool | No | True | Whether the interaction was successful |
latency | int | No | Auto-calculated | Execution time in milliseconds (auto-calculated from begin time if not provided) |
User Identification (agnost.identify)
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | str | Required | - | Identifier for the user |
traits | dict | Required | - | User characteristics (e.g., name, email, plan, role) |
Debug Mode
Enable debug mode to see detailed logging of SDK operations:Next Steps
- Learn about tracking AI interactions
- Check out the Quickstart guide
