chore: add missing docstrings

Author: stainless-app[bot]

src/moderation_api/types/actions/execute_execute_response.py

@@ -6,5 +6,7 @@
 
 
 class ExecuteExecuteResponse(BaseModel):
+    """Execution result"""
+
     success: bool
     """Whether the action was executed successfully"""

src/moderation_api/types/author_create_params.py

@@ -41,6 +41,11 @@ class AuthorCreateParams(TypedDict, total=False):
 
 
 class MetadataTyped(TypedDict, total=False):
+    """Additional metadata provided by your system.
+
+    We recommend including any relevant information that may assist in the moderation process.
+    """
+
     email_verified: Optional[bool]
     """Whether the author's email is verified"""
 

src/moderation_api/types/author_create_response.py

@@ -11,6 +11,8 @@
 
 
 class Block(BaseModel):
+    """Block or suspension details, if applicable. Null if the author is enabled."""
+
     reason: Optional[str] = None
     """The moderators reason why the author was blocked or suspended."""
 
@@ -19,6 +21,11 @@ class Block(BaseModel):
 
 
 class Metadata(BaseModel):
+    """Additional metadata provided by your system.
+
+    We recommend including any relevant information that may assist in the moderation process.
+    """
+
     email_verified: Optional[bool] = None
     """Whether the author's email is verified"""
 
@@ -59,6 +66,8 @@ class Metrics(BaseModel):
 
 
 class RiskEvaluation(BaseModel):
+    """Risk assessment details, if available."""
+
     risk_level: Optional[float] = None
     """Calculated risk level based on more than 10 behavioral signals."""
 

src/moderation_api/types/author_list_response.py

@@ -20,6 +20,8 @@
 
 
 class AuthorBlock(BaseModel):
+    """Block or suspension details, if applicable. Null if the author is enabled."""
+
     reason: Optional[str] = None
     """The moderators reason why the author was blocked or suspended."""
 
@@ -28,6 +30,11 @@ class AuthorBlock(BaseModel):
 
 
 class AuthorMetadata(BaseModel):
+    """Additional metadata provided by your system.
+
+    We recommend including any relevant information that may assist in the moderation process.
+    """
+
     email_verified: Optional[bool] = None
     """Whether the author's email is verified"""
 
@@ -68,6 +75,8 @@ class AuthorMetrics(BaseModel):
 
 
 class AuthorRiskEvaluation(BaseModel):
+    """Risk assessment details, if available."""
+
     risk_level: Optional[float] = None
     """Calculated risk level based on more than 10 behavioral signals."""
 

src/moderation_api/types/author_retrieve_response.py

@@ -11,6 +11,8 @@
 
 
 class Block(BaseModel):
+    """Block or suspension details, if applicable. Null if the author is enabled."""
+
     reason: Optional[str] = None
     """The moderators reason why the author was blocked or suspended."""
 
@@ -19,6 +21,11 @@ class Block(BaseModel):
 
 
 class Metadata(BaseModel):
+    """Additional metadata provided by your system.
+
+    We recommend including any relevant information that may assist in the moderation process.
+    """
+
     email_verified: Optional[bool] = None
     """Whether the author's email is verified"""
 
@@ -59,6 +66,8 @@ class Metrics(BaseModel):
 
 
 class RiskEvaluation(BaseModel):
+    """Risk assessment details, if available."""
+
     risk_level: Optional[float] = None
     """Calculated risk level based on more than 10 behavioral signals."""
 

src/moderation_api/types/author_update_params.py

@@ -38,6 +38,11 @@ class AuthorUpdateParams(TypedDict, total=False):
 
 
 class MetadataTyped(TypedDict, total=False):
+    """Additional metadata provided by your system.
+
+    We recommend including any relevant information that may assist in the moderation process.
+    """
+
     email_verified: Optional[bool]
     """Whether the author's email is verified"""
 

src/moderation_api/types/author_update_response.py

@@ -11,6 +11,8 @@
 
 
 class Block(BaseModel):
+    """Block or suspension details, if applicable. Null if the author is enabled."""
+
     reason: Optional[str] = None
     """The moderators reason why the author was blocked or suspended."""
 
@@ -19,6 +21,11 @@ class Block(BaseModel):
 
 
 class Metadata(BaseModel):
+    """Additional metadata provided by your system.
+
+    We recommend including any relevant information that may assist in the moderation process.
+    """
+
     email_verified: Optional[bool] = None
     """Whether the author's email is verified"""
 
@@ -59,6 +66,8 @@ class Metrics(BaseModel):
 
 
 class RiskEvaluation(BaseModel):
+    """Risk assessment details, if available."""
+
     risk_level: Optional[float] = None
     """Calculated risk level based on more than 10 behavioral signals."""
 

src/moderation_api/types/content_submit_params.py

@@ -85,55 +85,71 @@ class ContentSubmitParams(TypedDict, total=False):
 
 
 class ContentText(TypedDict, total=False):
+    """Text"""
+
     text: Required[str]
     """The content text"""
 
     type: Required[Literal["text"]]
 
 
 class ContentImage(TypedDict, total=False):
+    """Image"""
+
     type: Required[Literal["image"]]
 
     url: Required[str]
     """A public URL of the image content"""
 
 
 class ContentVideo(TypedDict, total=False):
+    """Video"""
+
     type: Required[Literal["video"]]
 
     url: Required[str]
     """A public URL of the video content"""
 
 
 class ContentAudio(TypedDict, total=False):
+    """Audio"""
+
     type: Required[Literal["audio"]]
 
     url: Required[str]
     """The URL of the audio content"""
 
 
 class ContentObjectDataText(TypedDict, total=False):
+    """Text"""
+
     text: Required[str]
     """The content text"""
 
     type: Required[Literal["text"]]
 
 
 class ContentObjectDataImage(TypedDict, total=False):
+    """Image"""
+
     type: Required[Literal["image"]]
 
     url: Required[str]
     """A public URL of the image content"""
 
 
 class ContentObjectDataVideo(TypedDict, total=False):
+    """Video"""
+
     type: Required[Literal["video"]]
 
     url: Required[str]
     """A public URL of the video content"""
 
 
 class ContentObjectDataAudio(TypedDict, total=False):
+    """Audio"""
+
     type: Required[Literal["audio"]]
 
     url: Required[str]
@@ -146,6 +162,8 @@ class ContentObjectDataAudio(TypedDict, total=False):
 
 
 class ContentObject(TypedDict, total=False):
+    """Object"""
+
     data: Required[Dict[str, ContentObjectData]]
     """Values in the object. Can be mixed content types."""
 

src/moderation_api/types/content_submit_response.py

@@ -32,6 +32,8 @@
 
 
 class AuthorBlock(BaseModel):
+    """Block or suspension details, if applicable. Null if the author is enabled."""
+
     reason: Optional[str] = None
     """The moderators reason why the author was blocked or suspended."""
 
@@ -48,6 +50,11 @@ class AuthorTrustLevel(BaseModel):
 
 
 class Author(BaseModel):
+    """The author of the content if your account has authors enabled.
+
+    Requires you to send authorId when submitting content.
+    """
+
     id: str
     """Author ID in Moderation API"""
 
@@ -64,27 +71,35 @@ class Author(BaseModel):
 
 
 class ContentModifiedModifiedNestedObjectContentContentModifiedModifiedNestedObjectContentItemText(BaseModel):
+    """Text"""
+
     text: str
     """The content text"""
 
     type: Literal["text"]
 
 
 class ContentModifiedModifiedNestedObjectContentContentModifiedModifiedNestedObjectContentItemImage(BaseModel):
+    """Image"""
+
     type: Literal["image"]
 
     url: str
     """A public URL of the image content"""
 
 
 class ContentModifiedModifiedNestedObjectContentContentModifiedModifiedNestedObjectContentItemVideo(BaseModel):
+    """Video"""
+
     type: Literal["video"]
 
     url: str
     """A public URL of the video content"""
 
 
 class ContentModifiedModifiedNestedObjectContentContentModifiedModifiedNestedObjectContentItemAudio(BaseModel):
+    """Audio"""
+
     type: Literal["audio"]
 
     url: str
@@ -100,6 +115,8 @@ class ContentModifiedModifiedNestedObjectContentContentModifiedModifiedNestedObj
 
 
 class Content(BaseModel):
+    """Potentially modified content."""
+
     id: str
     """The unique identifier for the content.
 
@@ -119,6 +136,8 @@ class Content(BaseModel):
 
 
 class Evaluation(BaseModel):
+    """The evaluation of the content after running the channel policies."""
+
     flag_probability: float
     """The probability that the content should be flagged."""
 
@@ -136,6 +155,8 @@ class Evaluation(BaseModel):
 
 
 class InsightSentimentInsight(BaseModel):
+    """Sentiment insight"""
+
     id: Literal["sentiment"]
 
     probability: float
@@ -146,6 +167,8 @@ class InsightSentimentInsight(BaseModel):
 
 
 class InsightLanguageInsight(BaseModel):
+    """Language insight"""
+
     id: Literal["language"]
 
     probability: float
@@ -159,6 +182,8 @@ class InsightLanguageInsight(BaseModel):
 
 
 class Meta(BaseModel):
+    """Metadata about the moderation request"""
+
     channel_key: str
     """The unique key of the channel where the content was handled.
 
@@ -183,6 +208,8 @@ class PolicyClassifierOutputLabel(BaseModel):
 
 
 class PolicyClassifierOutput(BaseModel):
+    """Classifier policy."""
+
     id: str
     """The unique identifier for the classifier output."""
 
@@ -207,6 +234,8 @@ class PolicyEntityMatcherOutputMatch(BaseModel):
 
 
 class PolicyEntityMatcherOutput(BaseModel):
+    """Entity matcher policy."""
+
     id: str
 
     flagged: bool
@@ -224,6 +253,8 @@ class PolicyEntityMatcherOutput(BaseModel):
 
 
 class Recommendation(BaseModel):
+    """The recommendation for the content based on the evaluation."""
+
     action: Literal["review", "allow", "reject"]
     """The action to take based on the recommendation"""
 

src/moderation_api/types/wordlist_get_embedding_status_response.py

@@ -8,6 +8,8 @@
 
 
 class WordlistGetEmbeddingStatusResponse(BaseModel):
+    """Embedding status details"""
+
     progress: float
     """Percentage of words that have been embedded (0-100)"""