chore: add missing docstrings

Author: stainless-app[bot]

src/contextual/types/agent_configs.py

@@ -13,6 +13,8 @@
 
 
 class ACLConfig(BaseModel):
+    """Parameters that affect the agent's ACL workflow"""
+
     acl_active: Optional[bool] = None
     """Whether to enable ACL."""
 
@@ -21,6 +23,8 @@ class ACLConfig(BaseModel):
 
 
 class ReformulationConfig(BaseModel):
+    """Parameters that affect the agent's query reformulation"""
+
     enable_query_decomposition: Optional[bool] = None
     """Whether to enable query decomposition."""
 
@@ -35,6 +39,8 @@ class ReformulationConfig(BaseModel):
 
 
 class TranslationConfig(BaseModel):
+    """Parameters that affect the agent's translation workflow"""
+
     translate_confidence: Optional[float] = None
     """The confidence threshold for translation."""
 
@@ -43,6 +49,8 @@ class TranslationConfig(BaseModel):
 
 
 class AgentConfigs(BaseModel):
+    """Response to configs for different components"""
+
     acl_config: Optional[ACLConfig] = None
     """Parameters that affect the agent's ACL workflow"""
 

src/contextual/types/agent_configs_param.py

@@ -12,6 +12,8 @@
 
 
 class ACLConfig(TypedDict, total=False):
+    """Parameters that affect the agent's ACL workflow"""
+
     acl_active: bool
     """Whether to enable ACL."""
 
@@ -20,6 +22,8 @@ class ACLConfig(TypedDict, total=False):
 
 
 class ReformulationConfig(TypedDict, total=False):
+    """Parameters that affect the agent's query reformulation"""
+
     enable_query_decomposition: bool
     """Whether to enable query decomposition."""
 
@@ -34,6 +38,8 @@ class ReformulationConfig(TypedDict, total=False):
 
 
 class TranslationConfig(TypedDict, total=False):
+    """Parameters that affect the agent's translation workflow"""
+
     translate_confidence: float
     """The confidence threshold for translation."""
 
@@ -42,6 +48,8 @@ class TranslationConfig(TypedDict, total=False):
 
 
 class AgentConfigsParam(TypedDict, total=False):
+    """Response to configs for different components"""
+
     acl_config: ACLConfig
     """Parameters that affect the agent's ACL workflow"""
 

src/contextual/types/agent_metadata.py

@@ -10,6 +10,8 @@
 
 
 class AgentUsages(BaseModel):
+    """Total API request counts for the agent."""
+
     eval: int
     """eval request count"""
 
@@ -21,6 +23,8 @@ class AgentUsages(BaseModel):
 
 
 class AgentMetadata(BaseModel):
+    """Response to GET Agent request"""
+
     datastore_ids: List[str]
     """The IDs of the datastore(s) associated with the agent"""
 

src/contextual/types/agent_metadata_response.py

@@ -11,6 +11,8 @@
 
 
 class GetTwilightAgentResponseAgentUsages(BaseModel):
+    """Total API request counts for the agent."""
+
     eval: int
     """eval request count"""
 
@@ -22,6 +24,8 @@ class GetTwilightAgentResponseAgentUsages(BaseModel):
 
 
 class GetTwilightAgentResponse(BaseModel):
+    """Response to GET Agent request"""
+
     datastore_ids: List[str]
     """The IDs of the datastore(s) associated with the agent"""
 

src/contextual/types/agents/query_create_params.py

@@ -102,6 +102,8 @@ class QueryCreateParams(TypedDict, total=False):
 
 
 class Message(TypedDict, total=False):
+    """Message object for a message sent or received in a conversation"""
+
     content: Required[str]
     """Content of the message"""
 
@@ -116,6 +118,10 @@ class Message(TypedDict, total=False):
 
 
 class OverrideConfiguration(TypedDict, total=False):
+    """
+    This will modify select configuration parameters for the agent during the response generation.
+    """
+
     enable_filter: bool
     """Override the filter_retrievals for the query.
 
@@ -184,6 +190,8 @@ class OverrideConfiguration(TypedDict, total=False):
 
 
 class StructuredOutput(TypedDict, total=False):
+    """Custom output structure format."""
+
     json_schema: Required[Dict[str, object]]
     """The output json structure."""
 

src/contextual/types/agents/query_feedback_response.py

@@ -6,5 +6,7 @@
 
 
 class QueryFeedbackResponse(BaseModel):
+    """Response schema for feedback submission endpoint."""
+
     feedback_id: str
     """ID of the submitted or updated feedback."""

src/contextual/types/agents/query_response.py

@@ -19,6 +19,8 @@
 
 
 class RetrievalContentCtxlMetadata(BaseModel):
+    """Default metadata from the retrieval"""
+
     chunk_id: Optional[str] = None
     """Unique identifier for the chunk."""
 
@@ -80,6 +82,8 @@ class RetrievalContentCustomMetadataConfig(BaseModel):
 
 
 class RetrievalContent(BaseModel):
+    """Retrieval content object typing for v0.1 API."""
+
     content_id: str
     """Unique identifier of the retrieved content"""
 
@@ -146,6 +150,8 @@ class RetrievalContent(BaseModel):
 
 
 class Attribution(BaseModel):
+    """Attribution for some claim made in a generated message`."""
+
     content_ids: List[str]
     """Content IDs of the sources for the attributed text"""
 
@@ -157,6 +163,8 @@ class Attribution(BaseModel):
 
 
 class GroundednessScore(BaseModel):
+    """Groundedness scores in a generated message`."""
+
     end_idx: int
     """End index of the span in the generated message"""
 
@@ -168,6 +176,8 @@ class GroundednessScore(BaseModel):
 
 
 class Message(BaseModel):
+    """Response to the query request"""
+
     content: str
     """Content of the message"""
 
@@ -179,6 +189,8 @@ class Message(BaseModel):
 
 
 class QueryResponse(BaseModel):
+    """Response body for POST /query"""
+
     conversation_id: str
     """A unique identifier for the conversation.
 

src/contextual/types/create_agent_output.py

@@ -8,6 +8,8 @@
 
 
 class CreateAgentOutput(BaseModel):
+    """Response to POST /agents request"""
+
     id: str
     """ID of the agent"""
 

src/contextual/types/datastore.py

@@ -10,6 +10,8 @@
 
 
 class ConfigurationChunking(BaseModel):
+    """Configuration for document chunking"""
+
     chunking_mode: Optional[Literal["hierarchy_depth", "hierarchy_heading", "static_length", "page_level"]] = None
     """Chunking mode to use.
 
@@ -41,6 +43,8 @@ class ConfigurationChunking(BaseModel):
 
 
 class ConfigurationHTMLConfig(BaseModel):
+    """Configuration for HTML Extraction"""
+
     max_chunk_length_tokens: Optional[int] = None
     """Target maximum length of text tokens chunks for chunking.
 
@@ -49,6 +53,8 @@ class ConfigurationHTMLConfig(BaseModel):
 
 
 class ConfigurationParsing(BaseModel):
+    """Configuration for document parsing"""
+
     enable_split_tables: Optional[bool] = None
     """
     Whether to enable table splitting, which splits large tables into smaller tables
@@ -79,6 +85,8 @@ class ConfigurationParsing(BaseModel):
 
 
 class Configuration(BaseModel):
+    """Configuration of the datastore"""
+
     chunking: Optional[ConfigurationChunking] = None
     """Configuration for document chunking"""
 
@@ -90,6 +98,8 @@ class Configuration(BaseModel):
 
 
 class Datastore(BaseModel):
+    """Datastore output entry with additional fields for public API."""
+
     id: str
     """ID of the datastore"""
 

src/contextual/types/datastore_create_params.py

@@ -22,6 +22,8 @@ class DatastoreCreateParams(TypedDict, total=False):
 
 
 class ConfigurationChunking(TypedDict, total=False):
+    """Configuration for document chunking"""
+
     chunking_mode: Literal["hierarchy_depth", "hierarchy_heading", "static_length", "page_level"]
     """Chunking mode to use.
 
@@ -53,6 +55,8 @@ class ConfigurationChunking(TypedDict, total=False):
 
 
 class ConfigurationHTMLConfig(TypedDict, total=False):
+    """Configuration for HTML Extraction"""
+
     max_chunk_length_tokens: int
     """Target maximum length of text tokens chunks for chunking.
 
@@ -61,6 +65,8 @@ class ConfigurationHTMLConfig(TypedDict, total=False):
 
 
 class ConfigurationParsing(TypedDict, total=False):
+    """Configuration for document parsing"""
+
     enable_split_tables: bool
     """
     Whether to enable table splitting, which splits large tables into smaller tables
@@ -91,6 +97,8 @@ class ConfigurationParsing(TypedDict, total=False):
 
 
 class Configuration(TypedDict, total=False):
+    """Configuration of the datastore. If not provided, default configuration is used."""
+
     chunking: ConfigurationChunking
     """Configuration for document chunking"""