simile 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

simile/client.py

@@ -5,10 +5,14 @@ import uuid
 from pydantic import BaseModel
 
 from .models import (
-    Population, Agent, DataItem,
+    Population, Agent as AgentModel, DataItem, DeletionResponse,
+    QualGenerationRequest, QualGenerationResponse, 
+    MCGenerationRequest, MCGenerationResponse,
     CreatePopulationPayload, CreateAgentPayload, CreateDataItemPayload, UpdateDataItemPayload,
-    DeletionResponse, QualGenerationRequest, QualGenerationResponse, MCGenerationRequest, MCGenerationResponse
+    InitialDataItemPayload,
+    SurveySessionCreateResponse
 )
+from .resources import Agent, SurveySession
 from .exceptions import (
     SimileAPIError, SimileAuthenticationError, SimileNotFoundError, SimileBadRequestError
 )
@@ -17,6 +21,11 @@ DEFAULT_BASE_URL = "https://simile-api-3a83be7adae0.herokuapp.com/api/v1"
 TIMEOUT_CONFIG = httpx.Timeout(5.0, read=30.0, write=30.0, pool=30.0)
 
 class Simile:
+    APIError = SimileAPIError
+    AuthenticationError = SimileAuthenticationError
+    NotFoundError = SimileNotFoundError
+    BadRequestError = SimileBadRequestError
+
     def __init__(self, api_key: str, base_url: str = DEFAULT_BASE_URL):
         if not api_key:
             raise ValueError("API key is required.")
@@ -58,8 +67,29 @@ class Simile:
         except httpx.RequestError as e:
             raise SimileAPIError(f"Request error: {e}")
 
-    # --- Population Endpoints ---
-    async def create_population(self, payload: CreatePopulationPayload) -> Population:
+    def agent(self, agent_id: uuid.UUID) -> Agent:
+        """Returns an Agent object to interact with a specific agent."""
+        return Agent(agent_id=agent_id, client=self)
+
+    async def create_survey_session(self, agent_id: uuid.UUID) -> SurveySession:
+        """Creates a new survey session for the given agent and returns a SurveySession object."""
+        endpoint = "sessions/"
+        response_data = await self._request(
+            "POST",
+            endpoint,
+            json={"agent_id": str(agent_id)},
+            response_model=SurveySessionCreateResponse
+        )
+        return SurveySession(
+            id=response_data.id,  
+            agent_id=response_data.agent_id, 
+            status=response_data.status,
+            client=self
+        )
+
+    async def create_population(self, name: str, description: Optional[str] = None) -> Population:
+        """Creates a new population."""
+        payload = CreatePopulationPayload(name=name, description=description)
         response_data = await self._request("POST", "populations/create", json=payload.model_dump(mode='json', exclude_none=True), response_model=Population)
         return response_data
 
@@ -71,21 +101,27 @@ class Simile:
         response_data = await self._request("DELETE", f"populations/delete/{str(population_id)}", response_model=DeletionResponse)
         return response_data
 
-    # --- Agent Endpoints ---
-    async def create_agent(self, payload: CreateAgentPayload) -> Agent:
-        response_data = await self._request("POST", "agents/create", json=payload.model_dump(mode='json', exclude_none=True), response_model=Agent)
+    async def create_agent(self, name: str, population_id: Optional[Union[str, uuid.UUID]] = None, agent_data: Optional[List[Dict[str, Any]]] = None) -> AgentModel:
+        """Creates a new agent, optionally within a population and with initial data items."""
+        pop_id_uuid: Optional[uuid.UUID] = None
+        if population_id:
+            pop_id_uuid = uuid.UUID(str(population_id)) if not isinstance(population_id, uuid.UUID) else population_id
+        
+        payload = CreateAgentPayload(name=name, population_id=pop_id_uuid, agent_data=agent_data)
+        response_data = await self._request("POST", "agents/create", json=payload.model_dump(mode='json', exclude_none=True), response_model=AgentModel)
         return response_data
 
-    async def get_agent(self, agent_id: Union[str, uuid.UUID]) -> Agent:
-        response_data = await self._request("GET", f"agents/get/{str(agent_id)}", response_model=Agent)
+    async def get_agent(self, agent_id: Union[str, uuid.UUID]) -> AgentModel:
+        response_data = await self._request("GET", f"agents/get/{str(agent_id)}", response_model=AgentModel)
         return response_data
 
     async def delete_agent(self, agent_id: Union[str, uuid.UUID]) -> DeletionResponse:
         response_data = await self._request("DELETE", f"agents/delete/{str(agent_id)}", response_model=DeletionResponse)
         return response_data
 
-    # --- Data Item Endpoints ---
-    async def create_data_item(self, agent_id: Union[str, uuid.UUID], payload: CreateDataItemPayload) -> DataItem:
+    async def create_data_item(self, agent_id: Union[str, uuid.UUID], data_type: str, content: Any) -> DataItem:
+        """Creates a new data item for a specific agent."""
+        payload = CreateDataItemPayload(data_type=data_type, content=content)
         response_data = await self._request("POST", f"data_item/create/{str(agent_id)}", json=payload.model_dump(mode='json'), response_model=DataItem)
         return response_data
 
@@ -97,20 +133,24 @@ class Simile:
         params = {}
         if data_type:
             params["data_type"] = data_type
-        raw_response = await self._request("GET", f"data_item/list/{str(agent_id)}", params=params) 
+        agent_id_str = str(agent_id)
+        raw_response = await self._request("GET", f"data_item/list/{agent_id_str}", params=params) 
         return [DataItem(**item) for item in raw_response.json()] 
 
-    async def update_data_item(self, data_item_id: Union[str, uuid.UUID], payload: UpdateDataItemPayload) -> DataItem:
-        response_data = await self._request("POST", f"data_item/update/{data_item_id}", json=payload.model_dump(), response_model=DataItem)
+    async def update_data_item(self, data_item_id: Union[str, uuid.UUID], content: Any) -> DataItem:
+        """Updates an existing data item."""
+        payload = UpdateDataItemPayload(content=content)
+        response_data = await self._request("POST", f"data_item/update/{str(data_item_id)}", json=payload.model_dump(), response_model=DataItem)
         return response_data
 
     async def delete_data_item(self, data_item_id: Union[str, uuid.UUID]) -> DeletionResponse:
         response_data = await self._request("DELETE", f"data_item/delete/{str(data_item_id)}", response_model=DeletionResponse)
         return response_data
 
-    # --- LLM Generation Methods ---
-    async def generate_qual_response(self, agent_id: uuid.UUID, request_payload: QualGenerationRequest) -> QualGenerationResponse:
+    async def generate_qual_response(self, agent_id: uuid.UUID, question: str) -> QualGenerationResponse:
+        """Generates a qualitative response from an agent based on a question."""
         endpoint = f"/generation/qual/{str(agent_id)}"
+        request_payload = QualGenerationRequest(question=question)
         response_data = await self._request(
             "POST", 
             endpoint, 
@@ -119,9 +159,16 @@ class Simile:
         )
         return response_data
 
-    async def generate_mc_response(self, agent_id: uuid.UUID, request_payload: MCGenerationRequest) -> MCGenerationResponse:
-        endpoint = f"generation/mc/{agent_id}" 
-        response_data = await self._request("POST", endpoint, json=request_payload.model_dump(), response_model=MCGenerationResponse)
+    async def generate_mc_response(self, agent_id: uuid.UUID, question: str, options: List[str]) -> MCGenerationResponse:
+        """Generates a multiple-choice response from an agent."""
+        endpoint = f"generation/mc/{str(agent_id)}"
+        request_payload = MCGenerationRequest(question=question, options=options)
+        response_data = await self._request(
+            "POST", 
+            endpoint, 
+            json=request_payload.model_dump(), 
+            response_model=MCGenerationResponse
+        )
         return response_data
 
     async def aclose(self):

simile/models.py

@@ -34,10 +34,15 @@ class CreatePopulationPayload(BaseModel):
     description: Optional[str] = None
 
 
+class InitialDataItemPayload(BaseModel):
+    data_type: str
+    content: Any
+
+
 class CreateAgentPayload(BaseModel):
     name: str
     population_id: Optional[uuid.UUID] = None
-    agent_data: Optional[List[Dict[str, Any]]] = None # For initial data items
+    agent_data: Optional[List[InitialDataItemPayload]] = None
 
 
 class CreateDataItemPayload(BaseModel):
@@ -53,13 +58,11 @@ class DeletionResponse(BaseModel):
     message: str
 
 
-# --- LLM Generation Models ---
-
+# --- Generation Operation Models ---
 class QualGenerationRequest(BaseModel):
     question: str
 
 class QualGenerationResponse(BaseModel):
-    agent_id: uuid.UUID
     question: str
     answer: str
 
@@ -68,7 +71,28 @@ class MCGenerationRequest(BaseModel):
     options: List[str]
 
 class MCGenerationResponse(BaseModel):
-    agent_id: uuid.UUID
     question: str
     options: List[str]
     chosen_option: str
+
+
+# --- Survey Session Models ---
+class ConversationTurn(BaseModel):
+    type: str # "qual" or "mc"
+    question: str
+    options: Optional[List[str]] = None
+    answer: Optional[str] = None
+    chosen_option: Optional[str] = None
+    timestamp: datetime
+
+class SurveySessionCreateResponse(BaseModel):
+    id: uuid.UUID # Session ID
+    agent_id: uuid.UUID
+    created_at: datetime
+    status: str
+    
+class SurveySessionCloseResponse(BaseModel):
+    id: uuid.UUID # Session ID
+    status: str 
+    updated_at: datetime 
+    message: Optional[str] = None

simile/resources.py

@@ -0,0 +1,83 @@
+import uuid
+from typing import TYPE_CHECKING, List
+
+from .models import (
+    QualGenerationRequest,
+    QualGenerationResponse,
+    MCGenerationRequest,
+    MCGenerationResponse,
+    SurveySessionCloseResponse
+)
+
+if TYPE_CHECKING:
+    from .client import Simile
+
+class Agent:
+    """Represents an agent and provides methods for interacting with it directly."""
+    def __init__(self, agent_id: uuid.UUID, client: 'Simile'):
+        self._agent_id = agent_id
+        self._client = client
+
+    @property
+    def id(self) -> uuid.UUID:
+        return self._agent_id
+
+    async def generate_qual_response(self, question: str) -> QualGenerationResponse:
+        """Generates a qualitative response from this agent based on a question."""
+        return await self._client.generate_qual_response(agent_id=self._agent_id, question=question)
+
+    async def generate_mc_response(self, question: str, options: List[str]) -> MCGenerationResponse:
+        """Generates a multiple-choice response from this agent."""
+        return await self._client.generate_mc_response(agent_id=self._agent_id, question=question, options=options)
+
+
+class SurveySession:
+    """Represents an active survey session with an agent, allowing for contextual multi-turn generation."""
+    def __init__(self, id: uuid.UUID, agent_id: uuid.UUID, status: str, client: 'Simile'):
+        self._id = id
+        self._agent_id = agent_id
+        self._status = status
+        self._client = client
+
+    @property
+    def id(self) -> uuid.UUID:
+        return self._id
+
+    @property
+    def agent_id(self) -> uuid.UUID:
+        return self._agent_id
+
+    @property
+    def status(self) -> str:
+        return self._status
+
+    async def generate_qual_response(self, question: str) -> QualGenerationResponse:
+        """Generates a qualitative response within this survey session."""
+        endpoint = f"sessions/{str(self._id)}/qual"
+        payload = QualGenerationRequest(question=question) 
+        return await self._client._request(
+            "POST",
+            endpoint,
+            json=payload.model_dump(), 
+            response_model=QualGenerationResponse
+        )
+
+    async def generate_mc_response(self, question: str, options: List[str]) -> MCGenerationResponse:
+        """Generates a multiple-choice response within this survey session."""
+        endpoint = f"sessions/{str(self._id)}/mc"
+        payload = MCGenerationRequest(question=question, options=options) 
+        return await self._client._request(
+            "POST",
+            endpoint,
+            json=payload.model_dump(), 
+            response_model=MCGenerationResponse
+        )
+
+    async def close(self) -> SurveySessionCloseResponse:
+        """Closes this survey session on the server."""
+        endpoint = f"sessions/{str(self._id)}/close"
+        return await self._client._request(
+            "POST",
+            endpoint,
+            response_model=SurveySessionCloseResponse
+        )

{simile-0.2.0.dist-info → simile-0.2.2.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: simile
-Version: 0.2.0
+Version: 0.2.2
 Summary: Package for interfacing with Simile AI agents for simulation
 Author-email: Simile AI <cqz@simile.ai>
-License: MIT
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/simile-team/simile-sdk
 Keywords: api,sdk,simile,ai-agent,simulation
 Classifier: Development Status :: 3 - Alpha

simile-0.2.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+simile/__init__.py,sha256=2OZ1LQIkAEtSs0EI5Fzlg7QGKduCgCe_nTh9FfIuHlQ,865
+simile/client.py,sha256=rBXGfuD1kMlzHCXaqaPNzuzoqqDe5tTWH28Szg6DMCI,8534
+simile/exceptions.py,sha256=-rJ3KZcpvNRi9JXbDpxWDSL2lU1mEJX2piwYRZvhKmg,1406
+simile/models.py,sha256=bdvKNT10VlZHC51S5U1vpm2i-HV-2hVVeQZFOB-5jmQ,2104
+simile/resources.py,sha256=n6TSuqEplO0Gyim-pqhrrxg8yPqsHWcFflOcZpd-uVo,2950
+simile-0.2.2.dist-info/licenses/LICENSE,sha256=tpxX3bpODfyOQVyEM6kCMvPHFCpkjFDj0AICRqKqOFA,1066
+simile-0.2.2.dist-info/METADATA,sha256=MCSE0Rjd8xR-WdsU3Igz0YLY6Bvh7NM64mC6T9753AA,1256
+simile-0.2.2.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+simile-0.2.2.dist-info/top_level.txt,sha256=41lJneubAG4-ZOAs5qn7iDtDb-MDxa6DdvgBKwNX84M,7
+simile-0.2.2.dist-info/RECORD,,

simile-0.2.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-simile/__init__.py,sha256=2OZ1LQIkAEtSs0EI5Fzlg7QGKduCgCe_nTh9FfIuHlQ,865
-simile/client.py,sha256=8FMhdyi35CQPJFh7pMLf6c9pczN7IlcCvnBh8kocOiI,6377
-simile/exceptions.py,sha256=-rJ3KZcpvNRi9JXbDpxWDSL2lU1mEJX2piwYRZvhKmg,1406
-simile/models.py,sha256=3T1UYCPp3KWMBD-u7lZEMahm4fS4ltm9h0oPUWs_oyI,1530
-simile-0.2.0.dist-info/licenses/LICENSE,sha256=tpxX3bpODfyOQVyEM6kCMvPHFCpkjFDj0AICRqKqOFA,1066
-simile-0.2.0.dist-info/METADATA,sha256=CTeN0Kl12ehJhMPbvra6o7ruVuojOyfpPB7uvUHuHjw,1245
-simile-0.2.0.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
-simile-0.2.0.dist-info/top_level.txt,sha256=41lJneubAG4-ZOAs5qn7iDtDb-MDxa6DdvgBKwNX84M,7
-simile-0.2.0.dist-info/RECORD,,