shiftaiagenticinfra-sdk-python 0.0.4__tar.gz → 0.0.6__tar.gz

{shiftaiagenticinfra_sdk_python-0.0.4/shiftaiagenticinfra_sdk_python.egg-info → shiftaiagenticinfra_sdk_python-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shiftaiagenticinfra-sdk-python
-Version: 0.0.4
+Version: 0.0.6
 Summary: Shiftai Agentic Infra Python SDK
 Author: ShiftAI
 Author-email: ShiftAI <s.tadakamalla@theshiftai.in>
@@ -31,6 +31,84 @@ Dynamic: requires-python
 
 This SDK is the official gateway to the Shift AI Agentic Infra services, enabling developers to directly integrate and use agentic capabilities in their applications.
 
+## About ShiftAI
+
+<p align="center">
+  <a href="https://theshiftai.in">
+    <img src="https://img.shields.io/badge/Website-theshiftai.in-blue?style=for-the-badge">
+  </a>
+  <a href="https://github.com/shiftaitop">
+    <img src="https://img.shields.io/badge/GitHub-shiftaitop-black?style=for-the-badge">
+  </a>
+  <a href="https://www.linkedin.com/company/theshiftai-in/">
+    <img src="https://img.shields.io/badge/LinkedIn-ShiftAI-blue?style=for-the-badge&logo=linkedin">
+  </a>
+  <a href="https://x.com/shift_ai_first">
+    <img src="https://img.shields.io/badge/X(Twitter)-@shift__ai__first-black?style=for-the-badge&logo=x">
+  </a>
+</p>
+
+**ShiftAI** is an AI infrastructure and consulting company focused on building
+**production-ready AI systems** that help organizations transform business
+operations using AI.
+
+ShiftAI works with enterprises and product teams to design, integrate, and deploy
+AI-driven systems that move beyond experimentation into real-world production.
+
+---
+
+## Official ShiftAI Links
+
+- 🌐 Website: https://theshiftai.in  
+- 🐙 GitHub Organization: https://github.com/shiftaitop  
+- 💼 LinkedIn (Company): https://www.linkedin.com/company/theshiftai-in/  
+- 🐦 Twitter (X): https://x.com/shift_ai_first  
+
+### Founder
+- **Suresh Gokarakonda**
+- LinkedIn: https://www.linkedin.com/in/gokarakonda/
+
+---
+
+## About ShiftAI Agentic Infrastructure
+
+**ShiftAI Agentic Infrastructure** is a **multi-tenant platform** for managing
+AI-powered conversations, agents, and workflows.
+
+Organizations register as isolated tenants and receive secure API keys for access.
+The platform automatically manages conversation sessions, threads messages between
+humans and agents, and maintains complete conversation history.
+
+It supports multiple LLM providers through a **pluggable architecture**, enabling
+provider switching without application-level changes.
+
+On every interaction, the platform generates AI-enhanced contextual prompts derived
+from conversation history, summarizing conversation flow, key facts, and resolved
+ambiguities. This context is returned to clients and stored for future interactions.
+
+The platform also includes built-in **evaluation and analytics** capabilities that
+assess response quality, relevance, and reasoning across user–agent interactions,
+providing visibility into conversation performance over time.
+
+---
+
+## Platform Usage Overview
+
+Using ShiftAI Agentic Infrastructure through this SDK, applications typically:
+
+1. Initialize the SDK client using project credentials  
+2. Submit human messages to start or continue conversations  
+3. Receive contextual intelligence generated from conversation history  
+4. Generate agent responses using the provided context  
+5. Submit agent responses linked to prior human messages  
+6. Monitor conversations and performance using built-in analytics  
+
+All operations are automatically scoped to the authenticated project, ensuring
+secure isolation between organizations using the platform.
+
+---
+
+
 
 
 
@@ -76,6 +154,7 @@ async def main():
         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 
     )
 
@@ -89,7 +168,8 @@ async def main():
         agent_platform="OpenAI",
         agent_version="1.0.0",  # Required: Agent version 
         reply_message_id=human_response.messageId,
-        rag_context="Retrieved context from knowledge base..."
+        rag_context="Retrieved context from knowledge base...",
+        user_email="john@example.com"
     )
 
     # 4. Get analytics
@@ -145,6 +225,7 @@ Send a human message with automatic user/agent creation.
 - `agent_version` (str, **optional**): Agent version/model (e.g., "gpt-4", "claude-2") - **Required in database**
 - `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.
 
 **Return Type:** `PlatformMessageSubmissionResponse`
 
@@ -170,6 +251,28 @@ Send a bot response to a human message.
 
 **Return Type:** `PlatformMessageSubmissionResponse`
 
+**Response Notes (Cache):**
+- `cacheHit` / `cacheResponse` may be present when the backend cache API was checked (typically for HUMAN messages).
+
+### Platform Session API
+
+#### `await platform_session.initiate_session(request=None)`
+Initiate a new conversation session.
+
+POST `/api/platformsession/initiate`
+
+**Return Type:** `Dict[str, Any]` (raw response body as returned by the server)
+
+#### `await platform_session.end_conversation(conversation_id)`
+End an active conversation session explicitly.
+
+POST `/api/platformsession/endconversation`
+
+**Parameters:**
+- `conversation_id` (UUID, **required**): Conversation identifier to end
+
+**Return Type:** `EndConversationResponse`
+
 #### `await messages.submit(request)`
 Low-level message submission with full control.