hivetrace 1.3.6__py3-none-any.whl → 1.3.7__py3-none-any.whl

{hivetrace-1.3.6.dist-info → hivetrace-1.3.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hivetrace
-Version: 1.3.6
+Version: 1.3.7
 Summary: Hivetrace SDK for monitoring LLM applications
 Home-page: http://hivetrace.ai
 Author: Raft
@@ -38,45 +38,49 @@ Requires-Dist: openai-agents >=0.1.0 ; extra == 'openai_agents'
 
 ## Overview
 
-Hivetrace SDK is designed for integration with the Hivetrace service, providing monitoring of user prompts and LLM responses.
+The Hivetrace SDK lets you integrate with the Hivetrace service to monitor user prompts and LLM responses. It supports both synchronous and asynchronous workflows and can be configured via environment variables.
+
+---
 
 ## Installation
 
-Install the SDK via pip:
+Install from PyPI:
 
 ```bash
 pip install hivetrace[base]
 ```
 
-## Usage
+---
+
+## Quick Start
 
 ```python
 from hivetrace import SyncHivetraceSDK, AsyncHivetraceSDK
 ```
 
-## Synchronous and Asynchronous Clients
+You can use either the synchronous client (`SyncHivetraceSDK`) or the asynchronous client (`AsyncHivetraceSDK`). Choose the one that fits your runtime.
 
-SDK предоставляет два отдельных клиента: синхронный (`SyncHivetraceSDK`) и асинхронный (`AsyncHivetraceSDK`). Выберите подходящий под ваш режим выполнения.
+---
 
-### Sync Mode
+## Synchronous Client
 
-#### Инициализация (Sync)
+### Initialize (Sync)
 
 ```python
-# Sync client (использует переменные окружения или переданный config)
+# The sync client reads configuration from environment variables or accepts an explicit config
 client = SyncHivetraceSDK()
 ```
 
-#### Отправка пользовательского запроса
+### Send a user prompt (input)
 
 ```python
 response = client.input(
-    application_id="your-application-id",  # получен после регистрации приложения в UI
+    application_id="your-application-id",  # Obtained after registering the application in the UI
     message="User prompt here",
 )
 ```
 
-#### Отправка ответа LLM
+### Send an LLM response (output)
 
 ```python
 response = client.output(
@@ -85,16 +89,18 @@ response = client.output(
 )
 ```
 
-### Async Mode
+---
+
+## Asynchronous Client
 
-#### Инициализация (Async)
+### Initialize (Async)
 
 ```python
-# Async client (можно использовать как контекстный менеджер)
+# The async client can be used as a context manager
 client = AsyncHivetraceSDK()
 ```
 
-#### Отправка пользовательского запроса
+### Send a user prompt (input)
 
 ```python
 response = await client.input(
@@ -103,7 +109,7 @@ response = await client.input(
 )
 ```
 
-#### Отправка ответа LLM
+### Send an LLM response (output)
 
 ```python
 response = await client.output(
@@ -112,11 +118,13 @@ response = await client.output(
 )
 ```
 
+---
+
 ## Example with Additional Parameters
 
 ```python
 response = client.input(
-    application_id="your-application-id", 
+    application_id="your-application-id",
     message="User prompt here",
     additional_parameters={
         "session_id": "your-session-id",
@@ -130,7 +138,9 @@ response = client.input(
 )
 ```
 
-> **Note:** `session_id`, `user_id`, and `agent_id` must be valid UUIDs.
+> **Note:** `session_id`, `user_id`, and all agent IDs must be valid UUIDs.
+
+---
 
 ## API
 
@@ -144,27 +154,29 @@ def input(application_id: str, message: str, additional_parameters: dict | None
 async def input(application_id: str, message: str, additional_parameters: dict | None = None) -> dict: ...
 ```
 
-Sends a user prompt to Hivetrace.
+Sends a **user prompt** to Hivetrace.
 
-* `application_id`: Application identifier (must be a valid UUID, created in the UI)
-* `message`: User prompt
-* `additional_parameters`: Dictionary of additional parameters (optional)
+* `application_id` — Application identifier (must be a valid UUID, created in the UI)
+* `message` — The user prompt
+* `additional_parameters` — Optional dictionary with extra context (session, user, agents, etc.)
 
-**Response Example:**
+**Response example:**
 
 ```json
 {
-    "status": "processed",
-    "monitoring_result": {
-        "is_toxic": false,
-        "type_of_violation": "benign",
-        "token_count": 9,
-        "token_usage_warning": false,
-        "token_usage_unbounded": false
-    }
+  "status": "processed",
+  "monitoring_result": {
+    "is_toxic": false,
+    "type_of_violation": "benign",
+    "token_count": 9,
+    "token_usage_warning": false,
+    "token_usage_unbounded": false
+  }
 }
 ```
 
+---
+
 ### `output`
 
 ```python
@@ -175,39 +187,41 @@ def output(application_id: str, message: str, additional_parameters: dict | None
 async def output(application_id: str, message: str, additional_parameters: dict | None = None) -> dict: ...
 ```
 
-Sends an LLM response to Hivetrace.
+Sends an **LLM response** to Hivetrace.
 
-* `application_id`: Application identifier (must be a valid UUID, created in the UI)
-* `message`: LLM response
-* `additional_parameters`: Dictionary of additional parameters (optional)
+* `application_id` — Application identifier (must be a valid UUID, created in the UI)
+* `message` — The LLM response
+* `additional_parameters` — Optional dictionary with extra context (session, user, agents, etc.)
 
-**Response Example:**
+**Response example:**
 
 ```json
 {
-    "status": "processed",
-    "monitoring_result": {
-        "is_toxic": false,
-        "type_of_violation": "safe",
-        "token_count": 21,
-        "token_usage_warning": false,
-        "token_usage_unbounded": false
-    }
+  "status": "processed",
+  "monitoring_result": {
+    "is_toxic": false,
+    "type_of_violation": "safe",
+    "token_count": 21,
+    "token_usage_warning": false,
+    "token_usage_unbounded": false
+  }
 }
 ```
 
+---
+
 ## Sending Requests in Sync Mode
 
 ```python
 def main():
-    # вариант 1: контекстный менеджер
+    # option 1: context manager
     with SyncHivetraceSDK() as client:
         response = client.input(
             application_id="your-application-id",
             message="User prompt here",
         )
 
-    # вариант 2: явное закрытие
+    # option 2: manual close
     client = SyncHivetraceSDK()
     try:
         response = client.input(
@@ -220,20 +234,22 @@ def main():
 main()
 ```
 
+---
+
 ## Sending Requests in Async Mode
 
 ```python
 import asyncio
 
 async def main():
-    # вариант 1: контекстный менеджер
+    # option 1: context manager
     async with AsyncHivetraceSDK() as client:
         response = await client.input(
             application_id="your-application-id",
             message="User prompt here",
         )
 
-    # вариант 2: явное закрытие
+    # option 2: manual close
     client = AsyncHivetraceSDK()
     try:
         response = await client.input(
@@ -252,9 +268,17 @@ asyncio.run(main())
 await client.close()
 ```
 
+---
+
 ## Configuration
 
-The SDK loads configuration from environment variables. The allowed domain (`HIVETRACE_URL`) and API token (`HIVETRACE_ACCESS_TOKEN`) are automatically retrieved from the environment.
+The SDK reads configuration from environment variables:
+
+* `HIVETRACE_URL` — Base URL allowed to call.
+* `HIVETRACE_ACCESS_TOKEN` — API token used for authentication.
+
+These are loaded automatically when you create a client.
+
 
 ### Configuration Sources
 

{hivetrace-1.3.6.dist-info → hivetrace-1.3.7.dist-info}/RECORD

@@ -38,8 +38,8 @@ hivetrace/models/responses.py,sha256=zTcbCZ8GbIjhswb_yR7O3PmRuZaxGWOVtqSRfCy2jNA
 hivetrace/utils/__init__.py,sha256=BNYbeSuUbrZL7RradjE_OFAxam3L6eexbL2IMfjImv0,747
 hivetrace/utils/error_helpers.py,sha256=egVQpENputLR8exNpV1cui2LSHqbf8pI6SHRbLdxOX8,2661
 hivetrace/utils/uuid_generator.py,sha256=W4i2tUSyClNKNgm4O-bk_Qkkmw3cWIuf29DjwXftx0c,344
-hivetrace-1.3.6.dist-info/LICENSE,sha256=8d3g3prbWPDLQ5AV0dtyWfYTj5QPl8MJ_wlr2l8pjEU,11333
-hivetrace-1.3.6.dist-info/METADATA,sha256=RGRqSBl0bRQhxqF_DnesUru8zPDSNR4aBdmSb-6tIyc,26029
-hivetrace-1.3.6.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-hivetrace-1.3.6.dist-info/top_level.txt,sha256=F6mZCzZ5CSftMc-M0NeOYWbwyTzjybR72P4qSBMyZZM,10
-hivetrace-1.3.6.dist-info/RECORD,,
+hivetrace-1.3.7.dist-info/LICENSE,sha256=8d3g3prbWPDLQ5AV0dtyWfYTj5QPl8MJ_wlr2l8pjEU,11333
+hivetrace-1.3.7.dist-info/METADATA,sha256=FfxxOqtTC2RWlESYdqK-WWr0xRH47el7iUAsjc_cFnk,25793
+hivetrace-1.3.7.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+hivetrace-1.3.7.dist-info/top_level.txt,sha256=F6mZCzZ5CSftMc-M0NeOYWbwyTzjybR72P4qSBMyZZM,10
+hivetrace-1.3.7.dist-info/RECORD,,