shiftaiagenticinfra-sdk-python 0.0.10__tar.gz → 0.0.12__tar.gz

{shiftaiagenticinfra_sdk_python-0.0.10/shiftaiagenticinfra_sdk_python.egg-info → shiftaiagenticinfra_sdk_python-0.0.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shiftaiagenticinfra-sdk-python
-Version: 0.0.10
+Version: 0.0.12
 Summary: Shiftai Agentic Infra Python SDK
 Author: ShiftAI
 Author-email: ShiftAI <s.tadakamalla@theshiftai.in>
@@ -162,23 +162,24 @@ async def main():
         username="john_doe",
         message="Hello, how can I help you?",
         agent_name="SupportBot",
-        agent_platform="OpenAI",
-        user_email="john@example.com",
-        agent_version="1.0.0"  # Required: Agent version 
+        user_email="john@example.com",  # Required for message submission
+        agent_platform="OpenAI",        # Optional; when omitted, lookup uses name and project only
+        agent_version="1.0.0"           # Optional; backend defaults to "1.0.0" when omitted
     )
 
     print(f"Message sent! ID: {human_response.messageId}")
+    print(f"Org context: {human_response.orgContext}")  # Optional; may be null if org knowledge is unavailable/not configured
 
     # 3. Send a bot response
     bot_response = await client.messages.send_bot_message(
         username="john_doe",
         message="I can help you with your questions!",
         agent_name="SupportBot",
-        agent_platform="OpenAI",
-        agent_version="1.0.0",  # Required: Agent version 
         reply_message_id=human_response.messageId,
         rag_context="Retrieved context from knowledge base...",
-        user_email="john@example.com"
+        user_email="john@example.com",  # Required for message submission
+        agent_platform="OpenAI",         # Optional
+        agent_version="1.0.0"           # Optional; backend defaults to "1.0.0" when omitted
     )
 
     # 4. Get analytics
@@ -224,14 +225,14 @@ Send a human message with automatic user/agent creation.
 - `username` (str, **required**): User identifier (e.g., "john_doe", "user123")
 - `message` (str, **required**): The actual message content (e.g., "Hello, how can I help you?")
 - `agent_name` (str, **required**): Target agent name (e.g., "SupportBot", "GPT-4")
-- `agent_platform` (str, **required**): Agent platform/provider (e.g., "OpenAI", "Azure", "Anthropic")
-- `user_email` (str, **required**): User's email address for identification (e.g., "john@example.com")
+- `user_email` (str, **required**): User's email address (required for message submission; e.g., "john@example.com")
+- `agent_platform` (str, **optional**): Agent platform/provider (e.g., "OpenAI", "Azure"). When omitted, lookup/creation use name and project only.
 - `user_metadata` (dict, **optional**): Custom user attributes (e.g., `{"role": "premium", "subscription": "gold"}`)
 - `intent` (str, **optional**): Message intent classification (e.g., "question", "complaint", "request")
 - `entities` (dict, **optional**): Extracted named entities (e.g., `{"person": "John", "location": "New York"}`)
 - `annotations` (dict, **optional**): Additional message annotations (e.g., `{"priority": "high", "tags": ["urgent"]}`)
 - `source_event` (dict, **optional**): Original event data from source system
-- `agent_version` (str, **optional**): Agent version/model (e.g., "gpt-4", "claude-2") - **Required in database**
+- `agent_version` (str, **optional**): Agent version/model (e.g., "gpt-4", "claude-2"). Backend defaults to `"1.0.0"` when omitted.
 - `agent_metadata` (dict, **optional**): Agent configuration data (e.g., `{"temperature": 0.7, "max_tokens": 1000}`)
 - `mode` (str, **optional**): Mode identifier for the message. Allowed values: `"SIMPLE"` or `"EXPAND"`
 - `conversation_id` (UUID, **optional**): Conversation ID to store the HUMAN message in. If omitted, backend creates a new conversation automatically.
@@ -245,16 +246,16 @@ Send a bot response to a human message.
 - `username` (str, **required**): User identifier (must match the human message sender)
 - `message` (str, **required**): Bot response content (e.g., "I can help you with that!")
 - `agent_name` (str, **required**): Agent name (must match the human message agent)
-- `agent_platform` (str, **required**): Agent platform (must match the human message platform)
 - `reply_message_id` (UUID, **required**): ID of the human message being replied to
 - `rag_context` (str, **required**): RAG context used for generating the response
-- `user_email` (str, **required**): User's email address for identification
+- `user_email` (str, **required**): User's email address (required for message submission)
+- `agent_platform` (str, **optional**): Agent platform (must match the human message when provided). When omitted, lookup uses name and project only.
 - `user_metadata` (dict, **optional**): User metadata
 - `intent` (str, **optional**): Response intent
 - `entities` (dict, **optional**): Extracted entities from response
 - `annotations` (dict, **optional**): Response annotations
 - `source_event` (dict, **optional**): Source event data
-- `agent_version` (str, **optional**): Agent version/model - **Required in database**
+- `agent_version` (str, **optional**): Agent version/model. Backend defaults to `"1.0.0"` when omitted.
 - `agent_metadata` (dict, **optional**): Agent configuration
 - `mode` (str, **optional**): Mode identifier for the message. Allowed values: `"SIMPLE"` or `"EXPAND"`
 
@@ -262,6 +263,7 @@ Send a bot response to a human message.
 
 **Response Notes (Cache):**
 - `cacheHit` / `cacheResponse` may be present when the backend cache API was checked (typically for HUMAN messages).
+- `orgContext` may be present in submission response (typically HUMAN flow). May be null if org knowledge is unavailable, or not configured.
 
 ### Platform Session API
 
@@ -286,10 +288,17 @@ POST `/api/platformsession/endconversation`
 Low-level message submission with full control.
 
 **Parameters:**
-- `request` (PlatformMessageSubmissionRequest, **required**): Complete message request object
+- `request` (PlatformMessageSubmissionRequest, **required**): Complete message request object. `email` is required for message submission; the SDK raises `ValueError` if it is missing or blank.
 
 **Return Type:** `PlatformMessageSubmissionResponse`
 
+**Response fields to expect in `PlatformMessageSubmissionResponse`:**
+- `success`, `messageId`, `conversationId`, `message`
+- `contextualPrompt`, `humanQuery`, `previousKConversations`, `similarConversations`
+- `operationStatus`, `conversationTitle`
+- `cacheResponse`, `cacheHit`
+- `orgContext` (optional; typically HUMAN flow. May be null if org knowledge is unavailable, or not configured.)
+
 #### `await messages.get_all()`
 Get all messages for the authenticated project.
 
@@ -396,6 +405,42 @@ Get latest feedback submissions for the project, most recent first.
 
 **Return Type:** `LatestFeedbacksResponse` (`.feedbacks` list of `LatestFeedbackItemResponse`; optional `.message` when time window is used and there are no feedbacks)
 
+#### User preferences (tenant-isolated; require Api-Key)
+
+**Categories:** `USER_PERSONAL` (tone, style, formatting), `METRICS` (structure, visualization), `CALCULATION` (formulas, methods). Use value `"DELETE"` (case-insensitive) to remove the item at the given index.
+
+#### `await analytics.update_user_preference(request)`
+Update one user preference item (or remove with value `"DELETE"`).
+
+**Endpoint:** POST `/api/analytics/user-preferences/update`
+
+**Parameters:**
+- `request` (`UserPreferenceUpdateRequest`, **required**): `profileId` (UUID), `category` (USER_PERSONAL | METRICS | CALCULATION), `index` (0-based, non-negative), `value` (new text or `"DELETE"` to remove item at index)
+
+**Return Type:** `UserPreferenceItemResponse` (includes `updatedAt` on success)
+
+#### `await analytics.list_user_preferences_by_email(email)`
+List preferences for one user by email.
+
+**Endpoint:** POST `/api/analytics/user-preferences/list`
+
+**Parameters:**
+- `email` (str, **required**): User email in the tenant (e.g. `"john@example.com"`)
+
+**Return Type:** `UserPreferenceListResponse` (`.userpreferences` list of `UserPreferenceItemResponse`)
+
+#### `await analytics.list_all_user_preferences(limit=None)`
+List all user preferences in the tenant with optional limit.
+
+**Endpoint:** POST `/api/analytics/user-preferences/list/all`
+
+**Parameters:**
+- `limit` (int, **optional**): Max profiles to return (default 50, max 500). Omit or `None` for default.
+
+**Return Type:** `UserPreferenceListResponse` (`.userpreferences` list of `UserPreferenceItemResponse`)
+
+**Response shape (single profile):** `UserPreferenceItemResponse` has `profileId`, `username`, `userEmail`, `botName`, `userPreferences` (object with `userPersonalFeedbacks`, `metricsFeedbacks`, `calculationFeedbacks` arrays of strings), `createdAt`, `updatedAt` (ISO-8601).
+
 #### `await analytics.get_dashboard()`
 Get project dashboard metrics (includes cache analytics: `cacheServed`, `estimatedTokensSaved`, `estimatedCostSaved` when available).
 
@@ -500,7 +545,8 @@ try:
         username="user",
         message="Hello",
         agent_name="Bot",
-        agent_platform="OpenAI"
+        user_email="user@example.com",  # Required for message submission
+        agent_platform="OpenAI"         # Optional
     )
 except BadRequestException as e:
     print(f"Invalid request: {e}")