simile 0.2.5__py3-none-any.whl → 0.2.7__py3-none-any.whl

simile/client.py

@@ -10,7 +10,7 @@ from .models import (
     MCGenerationRequest, MCGenerationResponse,
     CreatePopulationPayload, CreateAgentPayload, CreateDataItemPayload, UpdateDataItemPayload,
     InitialDataItemPayload,
-    SurveySessionCreateResponse
+    SurveySessionCreateResponse, SurveySessionDetailResponse
 )
 from .resources import Agent, SurveySession
 from .exceptions import (
@@ -94,13 +94,25 @@ class Simile:
             json={"agent_id": str(agent_id)},
             response_model=SurveySessionCreateResponse
         )
+        
+        # Create and return a SurveySession object
         return SurveySession(
-            id=response_data.id,  
-            agent_id=response_data.agent_id, 
+            id=response_data.id,
+            agent_id=response_data.agent_id,
             status=response_data.status,
             client=self
         )
 
+    async def get_survey_session(self, session_id: Union[str, uuid.UUID]) -> SurveySessionDetailResponse:
+        """Retrieves detailed information about a survey session including typed conversation history."""
+        endpoint = f"sessions/{str(session_id)}"
+        response_data = await self._request(
+            "GET",
+            endpoint,
+            response_model=SurveySessionDetailResponse
+        )
+        return response_data
+
     async def create_population(self, name: str, description: Optional[str] = None) -> Population:
         """Creates a new population."""
         payload = CreatePopulationPayload(name=name, description=description)

simile/models.py

@@ -1,6 +1,7 @@
-from typing import List, Dict, Any, Optional
-from pydantic import BaseModel, Field
+from typing import List, Dict, Any, Optional, Union, Literal
+from pydantic import BaseModel, Field, validator
 from datetime import datetime
+from enum import Enum
 import uuid
 
 
@@ -61,7 +62,8 @@ class DeletionResponse(BaseModel):
 # --- Generation Operation Models ---
 class QualGenerationRequest(BaseModel):
     question: str
-    image_url: Optional[str] = None
+    image_url: Optional[str] = None  # For backward compatibility
+    images: Optional[Dict[str, str]] = None  # Dict of {description: url} for multiple images
 
 class QualGenerationResponse(BaseModel):
     question: str
@@ -77,15 +79,80 @@ class MCGenerationResponse(BaseModel):
     options: List[str]
     chosen_option: str
 
+class AddContextRequest(BaseModel):
+    context: str
+
+class AddContextResponse(BaseModel):
+    message: str
+    session_id: uuid.UUID
+
 
 # --- 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 TurnType(str, Enum):
+    """Enum for different types of conversation turns."""
+    CONTEXT = "context"
+    IMAGE = "image"
+    QUALITATIVE_QUESTION = "qualitative_question"
+    MULTIPLE_CHOICE_QUESTION = "multiple_choice_question"
+
+
+class BaseTurn(BaseModel):
+    """Base model for all conversation turns."""
+    timestamp: datetime = Field(default_factory=lambda: datetime.now())
+    type: TurnType
+    
+    class Config:
+        use_enum_values = True
+
+
+class ContextTurn(BaseTurn):
+    """A context turn that provides background information."""
+    type: Literal[TurnType.CONTEXT] = TurnType.CONTEXT
+    user_context: str
+
+
+class ImageTurn(BaseTurn):
+    """A standalone image turn (e.g., for context or reference)."""
+    type: Literal[TurnType.IMAGE] = TurnType.IMAGE
+    image_url: str
+    caption: Optional[str] = None
+
+
+class QualitativeQuestionTurn(BaseTurn):
+    """A qualitative question-answer turn."""
+    type: Literal[TurnType.QUALITATIVE_QUESTION] = TurnType.QUALITATIVE_QUESTION
+    user_question: str
+    user_image_url: Optional[str] = None  # For backward compatibility
+    user_images: Optional[Dict[str, str]] = None  # Dict of {description: url} for multiple images
+    llm_response: Optional[str] = None
+
+
+class MultipleChoiceQuestionTurn(BaseTurn):
+    """A multiple choice question-answer turn."""
+    type: Literal[TurnType.MULTIPLE_CHOICE_QUESTION] = TurnType.MULTIPLE_CHOICE_QUESTION
+    user_question: str
+    user_options: List[str]
+    user_image_url: Optional[str] = None
+    llm_chosen_option: Optional[str] = None
+    
+    @validator('user_options')
+    def validate_options(cls, v):
+        if not v:
+            raise ValueError("Multiple choice questions must have at least one option")
+        if len(v) < 2:
+            raise ValueError("Multiple choice questions should have at least two options")
+        return v
+    
+    @validator('llm_chosen_option')
+    def validate_chosen_option(cls, v, values):
+        if v is not None and 'user_options' in values and v not in values['user_options']:
+            raise ValueError(f"Chosen option '{v}' must be one of the provided options")
+        return v
+
+
+# Union type for all possible turn types
+SurveySessionTurn = Union[ContextTurn, ImageTurn, QualitativeQuestionTurn, MultipleChoiceQuestionTurn]
+
 
 class SurveySessionCreateResponse(BaseModel):
     id: uuid.UUID # Session ID
@@ -93,6 +160,37 @@ class SurveySessionCreateResponse(BaseModel):
     created_at: datetime
     status: str
     
+
+class SurveySessionDetailResponse(BaseModel):
+    """Detailed survey session response with typed conversation turns."""
+    id: uuid.UUID
+    agent_id: uuid.UUID
+    created_at: datetime
+    updated_at: datetime
+    status: str
+    conversation_history: List[SurveySessionTurn] = Field(default_factory=list)
+    
+    class Config:
+        json_encoders = {
+            datetime: lambda v: v.isoformat()
+        }
+
+
+class SurveySessionListItemResponse(BaseModel):
+    """Summary response for listing survey sessions."""
+    id: uuid.UUID
+    agent_id: uuid.UUID
+    created_at: datetime
+    updated_at: datetime
+    status: str
+    turn_count: int = Field(description="Number of turns in conversation history")
+    
+    class Config:
+        json_encoders = {
+            datetime: lambda v: v.isoformat()
+        }
+
+
 class SurveySessionCloseResponse(BaseModel):
     id: uuid.UUID # Session ID
     status: str 

simile/resources.py

@@ -1,20 +1,25 @@
 import uuid
-from typing import TYPE_CHECKING, List, Optional
+from typing import TYPE_CHECKING, List, Optional, Dict
 
 from .models import (
     QualGenerationRequest,
     QualGenerationResponse,
     MCGenerationRequest,
     MCGenerationResponse,
-    SurveySessionCloseResponse
+    SurveySessionCloseResponse,
+    AddContextRequest,
+    AddContextResponse,
+    SurveySessionDetailResponse,
 )
 
 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'):
+
+    def __init__(self, agent_id: uuid.UUID, client: "Simile"):
         self._agent_id = agent_id
         self._client = client
 
@@ -22,18 +27,32 @@ class Agent:
     def id(self) -> uuid.UUID:
         return self._agent_id
 
-    async def generate_qual_response(self, question: str, image_url: Optional[str] = None) -> QualGenerationResponse:
+    async def generate_qual_response(
+        self, question: str, image_url: Optional[str] = None
+    ) -> 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, image_url=image_url)
+        return await self._client.generate_qual_response(
+            agent_id=self._agent_id, question=question, image_url=image_url
+        )
 
-    async def generate_mc_response(self, question: str, options: List[str], image_url: Optional[str] = None) -> MCGenerationResponse:
+    async def generate_mc_response(
+        self, question: str, options: List[str], image_url: Optional[str] = None
+    ) -> 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, image_url=image_url)
+        return await self._client.generate_mc_response(
+            agent_id=self._agent_id,
+            question=question,
+            options=options,
+            image_url=image_url,
+        )
 
 
 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'):
+
+    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
@@ -51,33 +70,57 @@ class SurveySession:
     def status(self) -> str:
         return self._status
 
-    async def generate_qual_response(self, question: str, image_url: Optional[str] = None) -> QualGenerationResponse:
+    async def get_details(self) -> SurveySessionDetailResponse:
+        """Retrieves detailed information about this survey session including typed conversation history."""
+        return await self._client.get_survey_session(self._id)
+
+    async def generate_qual_response(
+        self,
+        question: str,
+        image_url: Optional[str] = None,
+        images: Optional[Dict[str, str]] = None,
+    ) -> QualGenerationResponse:
         """Generates a qualitative response within this survey session."""
         endpoint = f"sessions/{str(self._id)}/qual"
-        payload = QualGenerationRequest(question=question, image_url=image_url) 
+        payload = QualGenerationRequest(
+            question=question, image_url=image_url, images=images
+        )
         return await self._client._request(
             "POST",
             endpoint,
-            json=payload.model_dump(), 
-            response_model=QualGenerationResponse
+            json=payload.model_dump(),
+            response_model=QualGenerationResponse,
         )
 
-    async def generate_mc_response(self, question: str, options: List[str], image_url: Optional[str] = None) -> MCGenerationResponse:
+    async def generate_mc_response(
+        self, question: str, options: List[str], image_url: Optional[str] = None
+    ) -> MCGenerationResponse:
         """Generates a multiple-choice response within this survey session."""
         endpoint = f"sessions/{str(self._id)}/mc"
-        payload = MCGenerationRequest(question=question, options=options, image_url=image_url) 
+        payload = MCGenerationRequest(
+            question=question, options=options, image_url=image_url
+        )
         return await self._client._request(
             "POST",
             endpoint,
-            json=payload.model_dump(), 
-            response_model=MCGenerationResponse
+            json=payload.model_dump(),
+            response_model=MCGenerationResponse,
+        )
+
+    async def add_context(self, ctx: str) -> AddContextResponse:
+        """Adds text to the SurveySession without requesting a response."""
+        endpoint = f"sessions/{str(self._id)}/context"
+        payload = AddContextRequest(context=ctx)
+        return await self._client._request(
+            "POST",
+            endpoint,
+            json=payload.model_dump(),
+            response_model=AddContextResponse,
         )
 
     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
+            "POST", endpoint, response_model=SurveySessionCloseResponse
         )

{simile-0.2.5.dist-info → simile-0.2.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simile
-Version: 0.2.5
+Version: 0.2.7
 Summary: Package for interfacing with Simile AI agents for simulation
 Author-email: Simile AI <cqz@simile.ai>
 License: MIT

simile-0.2.7.dist-info/RECORD

@@ -0,0 +1,10 @@
+simile/__init__.py,sha256=2OZ1LQIkAEtSs0EI5Fzlg7QGKduCgCe_nTh9FfIuHlQ,865
+simile/client.py,sha256=Bw9KML7S-V8gB8-ctitDvgesAkgI5w6cqasRL8Z_070,10394
+simile/exceptions.py,sha256=-rJ3KZcpvNRi9JXbDpxWDSL2lU1mEJX2piwYRZvhKmg,1406
+simile/models.py,sha256=gM6QqVySJe6sG-X7deDcpQYo0JMhfxtfZtBHFP-ZqSI,5376
+simile/resources.py,sha256=4SgiA24lYPCZi_DlJZzX-nUbE8rPMoDSPR65VT0YoW0,4181
+simile-0.2.7.dist-info/licenses/LICENSE,sha256=tpxX3bpODfyOQVyEM6kCMvPHFCpkjFDj0AICRqKqOFA,1066
+simile-0.2.7.dist-info/METADATA,sha256=Upzlhf06MRQThgSVZnzls4liEPX4dJrHvYILAJ-uKf0,1276
+simile-0.2.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+simile-0.2.7.dist-info/top_level.txt,sha256=41lJneubAG4-ZOAs5qn7iDtDb-MDxa6DdvgBKwNX84M,7
+simile-0.2.7.dist-info/RECORD,,

simile-0.2.5.dist-info/RECORD

@@ -1,10 +0,0 @@
-simile/__init__.py,sha256=2OZ1LQIkAEtSs0EI5Fzlg7QGKduCgCe_nTh9FfIuHlQ,865
-simile/client.py,sha256=_XsrdDHO25Fsnap6uhUlbMrKO8vMJGJaDCeym8xBs8o,9866
-simile/exceptions.py,sha256=-rJ3KZcpvNRi9JXbDpxWDSL2lU1mEJX2piwYRZvhKmg,1406
-simile/models.py,sha256=SRlQWU4Q1i7f-7rqDl4E84zanMhokpeOq9TD8ks4qtU,2176
-simile/resources.py,sha256=jF7sYm7ZjFTpeHYqa69b1rmEbCbuR8IhuXbeHmpsoUw,3176
-simile-0.2.5.dist-info/licenses/LICENSE,sha256=tpxX3bpODfyOQVyEM6kCMvPHFCpkjFDj0AICRqKqOFA,1066
-simile-0.2.5.dist-info/METADATA,sha256=lkzqUyOA9gQ3Nu1Z8ufnI7U-M6T5iItj50NumhWZ2FI,1276
-simile-0.2.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-simile-0.2.5.dist-info/top_level.txt,sha256=41lJneubAG4-ZOAs5qn7iDtDb-MDxa6DdvgBKwNX84M,7
-simile-0.2.5.dist-info/RECORD,,