moderation_api 1.0.0__py3-none-any.whl

moderation_api/types/queue/item_list_response.py

@@ -0,0 +1,90 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ItemListResponse", "Item", "ItemLabel", "ItemAction", "Pagination"]
+
+
+class ItemLabel(BaseModel):
+    flagged: bool
+    """Whether this label caused a flag"""
+
+    label: str
+    """Label name"""
+
+    score: float
+    """Confidence score of the label"""
+
+
+class ItemAction(BaseModel):
+    id: str
+    """Action ID"""
+
+    name: str
+    """Action name"""
+
+    timestamp: float
+    """Unix timestamp of when the action was taken"""
+
+    comment: Optional[str] = None
+    """Action comment"""
+
+    reviewer: Optional[str] = None
+    """Moderator userID"""
+
+
+class Item(BaseModel):
+    id: str
+    """Content ID"""
+
+    content: str
+    """The content to be moderated"""
+
+    flagged: bool
+    """Whether the item is flagged by any label"""
+
+    labels: List[ItemLabel]
+
+    status: Literal["pending", "resolved"]
+    """Status of the item"""
+
+    timestamp: float
+    """Unix timestamp of when the item was created"""
+
+    actions: Optional[List[ItemAction]] = None
+    """Action IDs taken on this item"""
+
+    author_id: Optional[str] = FieldInfo(alias="authorId", default=None)
+    """Author ID"""
+
+    content_type: Optional[str] = FieldInfo(alias="contentType", default=None)
+    """Type of the content object"""
+
+    conversation_id: Optional[str] = FieldInfo(alias="conversationId", default=None)
+    """Conversation ID"""
+
+    language: Optional[str] = None
+    """Content language"""
+
+
+class Pagination(BaseModel):
+    current_page: float = FieldInfo(alias="currentPage")
+
+    has_next_page: bool = FieldInfo(alias="hasNextPage")
+
+    has_previous_page: bool = FieldInfo(alias="hasPreviousPage")
+
+    total_items: float = FieldInfo(alias="totalItems")
+
+    total_pages: float = FieldInfo(alias="totalPages")
+
+
+class ItemListResponse(BaseModel):
+    items: List[Item]
+
+    pagination: Pagination

moderation_api/types/queue/item_resolve_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["ItemResolveParams"]
+
+
+class ItemResolveParams(TypedDict, total=False):
+    id: Required[str]
+    """The queue ID"""
+
+    comment: str
+    """Optional comment"""

moderation_api/types/queue/item_resolve_response.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ItemResolveResponse"]
+
+
+class ItemResolveResponse(BaseModel):
+    resolved_at: str = FieldInfo(alias="resolvedAt")
+    """Timestamp when the item was resolved"""
+
+    success: bool
+
+    comment: Optional[str] = None
+    """Optional comment"""

moderation_api/types/queue/item_unresolve_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["ItemUnresolveParams"]
+
+
+class ItemUnresolveParams(TypedDict, total=False):
+    id: Required[str]
+    """The queue ID"""
+
+    comment: str
+    """Optional reason for unresolving the item"""

moderation_api/types/queue/item_unresolve_response.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ItemUnresolveResponse"]
+
+
+class ItemUnresolveResponse(BaseModel):
+    status: str
+    """New status of the item"""
+
+    success: bool
+
+    unresolved_at: str = FieldInfo(alias="unresolvedAt")
+    """Timestamp when the item was unresolved"""

moderation_api/types/queue_get_stats_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["QueueGetStatsParams"]
+
+
+class QueueGetStatsParams(TypedDict, total=False):
+    within_days: Annotated[str, PropertyInfo(alias="withinDays")]
+    """Number of days to analyze statistics for"""

moderation_api/types/queue_get_stats_response.py

@@ -0,0 +1,110 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = [
+    "QueueGetStatsResponse",
+    "ActionStat",
+    "ReviewStats",
+    "TopReviewer",
+    "TopReviewerTopAction",
+    "Trends",
+    "TrendsDailyReviewCount",
+    "TrendsFlaggedContentTrend",
+]
+
+
+class ActionStat(BaseModel):
+    action_id: str = FieldInfo(alias="actionId")
+    """ID of the moderation action"""
+
+    action_name: str = FieldInfo(alias="actionName")
+    """Name of the moderation action"""
+
+    count: float
+    """Number of times this action was taken"""
+
+    percentage_of_total: float = FieldInfo(alias="percentageOfTotal")
+    """Percentage this action represents of all actions"""
+
+
+class ReviewStats(BaseModel):
+    average_time_to_review: float = FieldInfo(alias="averageTimeToReview")
+    """Average time in milliseconds to review an item"""
+
+    total_pending: float = FieldInfo(alias="totalPending")
+    """Total number of items pending review"""
+
+    total_reviewed: float = FieldInfo(alias="totalReviewed")
+    """Total number of items reviewed"""
+
+
+class TopReviewerTopAction(BaseModel):
+    action_id: str = FieldInfo(alias="actionId")
+    """Most used action by this reviewer"""
+
+    action_name: str = FieldInfo(alias="actionName")
+    """Name of the most used action"""
+
+    count: float
+    """Number of times this action was used"""
+
+
+class TopReviewer(BaseModel):
+    average_time_per_review: float = FieldInfo(alias="averageTimePerReview")
+    """Average review time in milliseconds"""
+
+    name: str
+    """Name of the reviewer"""
+
+    review_count: float = FieldInfo(alias="reviewCount")
+    """Number of items reviewed"""
+
+    top_actions: List[TopReviewerTopAction] = FieldInfo(alias="topActions")
+    """Most common actions taken by this reviewer"""
+
+    user_id: str = FieldInfo(alias="userId")
+    """ID of the reviewer"""
+
+    accuracy_score: Optional[float] = FieldInfo(alias="accuracyScore", default=None)
+    """Optional accuracy score based on review quality metrics"""
+
+
+class TrendsDailyReviewCount(BaseModel):
+    count: float
+    """Number of reviews on this date"""
+
+    date: str
+    """Date in YYYY-MM-DD format"""
+
+
+class TrendsFlaggedContentTrend(BaseModel):
+    label: str
+    """Content flag/label"""
+
+    trend: float
+    """
+    Trend indicator (-1 to 1) showing if this type of flagged content is increasing
+    or decreasing
+    """
+
+
+class Trends(BaseModel):
+    daily_review_counts: List[TrendsDailyReviewCount] = FieldInfo(alias="dailyReviewCounts")
+
+    flagged_content_trends: List[TrendsFlaggedContentTrend] = FieldInfo(alias="flaggedContentTrends")
+
+
+class QueueGetStatsResponse(BaseModel):
+    action_stats: List[ActionStat] = FieldInfo(alias="actionStats")
+
+    review_stats: ReviewStats = FieldInfo(alias="reviewStats")
+
+    top_reviewers: List[TopReviewer] = FieldInfo(alias="topReviewers")
+    """List of top reviewers and their statistics"""
+
+    trends: Trends

moderation_api/types/queue_retrieve_response.py

@@ -0,0 +1,64 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["QueueRetrieveResponse", "Queue", "QueueFilter", "QueueFilterFilterLabel"]
+
+
+class QueueFilterFilterLabel(BaseModel):
+    label: str
+
+    type: Literal["FLAGGED", "NOT_FLAGGED", "THRESHOLDS"]
+
+    max_threshold: Optional[float] = FieldInfo(alias="maxThreshold", default=None)
+
+    min_threshold: Optional[float] = FieldInfo(alias="minThreshold", default=None)
+
+
+class QueueFilter(BaseModel):
+    after_date: Optional[str] = FieldInfo(alias="afterDate", default=None)
+
+    author_id: Optional[str] = FieldInfo(alias="authorID", default=None)
+
+    before_date: Optional[str] = FieldInfo(alias="beforeDate", default=None)
+
+    conversation_ids: Optional[List[Optional[str]]] = FieldInfo(alias="conversationIds", default=None)
+
+    filtered_action_ids: Optional[List[str]] = FieldInfo(alias="filteredActionIds", default=None)
+
+    filtered_channel_ids: Optional[List[str]] = FieldInfo(alias="filteredChannelIds", default=None)
+
+    filter_labels: Optional[List[QueueFilterFilterLabel]] = FieldInfo(alias="filterLabels", default=None)
+
+    labels: Optional[List[str]] = None
+
+    recommendation_actions: Optional[List[Literal["review", "allow", "reject"]]] = FieldInfo(
+        alias="recommendationActions", default=None
+    )
+
+    show_checked: Optional[bool] = FieldInfo(alias="showChecked", default=None)
+
+
+class Queue(BaseModel):
+    id: str
+
+    description: str
+
+    filter: QueueFilter
+
+    name: str
+
+    resolved_items_count: float = FieldInfo(alias="resolvedItemsCount")
+
+    total_items_count: float = FieldInfo(alias="totalItemsCount")
+
+    unresolved_items_count: float = FieldInfo(alias="unresolvedItemsCount")
+
+
+class QueueRetrieveResponse(BaseModel):
+    queue: Queue

moderation_api/types/wordlist/__init__.py

@@ -0,0 +1,8 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .word_add_params import WordAddParams as WordAddParams
+from .word_add_response import WordAddResponse as WordAddResponse
+from .word_remove_params import WordRemoveParams as WordRemoveParams
+from .word_remove_response import WordRemoveResponse as WordRemoveResponse

moderation_api/types/wordlist/word_add_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+from ..._types import SequenceNotStr
+
+__all__ = ["WordAddParams"]
+
+
+class WordAddParams(TypedDict, total=False):
+    words: Required[SequenceNotStr[str]]
+    """Array of words to add to the wordlist. Duplicate words will be ignored."""

moderation_api/types/wordlist/word_add_response.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["WordAddResponse"]
+
+
+class WordAddResponse(BaseModel):
+    added_count: float = FieldInfo(alias="addedCount")
+    """Number of words added"""
+
+    added_words: List[str] = FieldInfo(alias="addedWords")
+    """List of words that were added"""
+
+    total_count: float = FieldInfo(alias="totalCount")
+    """Total number of words in wordlist"""

moderation_api/types/wordlist/word_remove_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+from ..._types import SequenceNotStr
+
+__all__ = ["WordRemoveParams"]
+
+
+class WordRemoveParams(TypedDict, total=False):
+    words: Required[SequenceNotStr[str]]
+    """Array of words to remove from the wordlist"""

moderation_api/types/wordlist/word_remove_response.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["WordRemoveResponse"]
+
+
+class WordRemoveResponse(BaseModel):
+    removed_count: float = FieldInfo(alias="removedCount")
+    """Number of words removed"""
+
+    removed_words: List[str] = FieldInfo(alias="removedWords")
+    """List of words removed"""
+
+    total_count: float = FieldInfo(alias="totalCount")
+    """Total number of words in wordlist"""

moderation_api/types/wordlist_get_embedding_status_response.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["WordlistGetEmbeddingStatusResponse"]
+
+
+class WordlistGetEmbeddingStatusResponse(BaseModel):
+    progress: float
+    """Percentage of words that have been embedded (0-100)"""
+
+    remaining_words: float = FieldInfo(alias="remainingWords")
+    """Number of words still waiting to be embedded"""
+
+    total_words: float = FieldInfo(alias="totalWords")
+    """Total number of words in the wordlist"""

moderation_api/types/wordlist_list_response.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["WordlistListResponse", "WordlistListResponseItem"]
+
+
+class WordlistListResponseItem(BaseModel):
+    id: str
+    """Unique identifier of the wordlist"""
+
+    created_at: Optional[str] = FieldInfo(alias="createdAt", default=None)
+    """When the wordlist was created"""
+
+    description: Optional[str] = None
+    """Description of the wordlist"""
+
+    name: Optional[str] = None
+    """Name of the wordlist"""
+
+    user_id: Optional[str] = FieldInfo(alias="userId", default=None)
+    """User who created the wordlist"""
+
+
+WordlistListResponse: TypeAlias = List[WordlistListResponseItem]

moderation_api/types/wordlist_retrieve_response.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["WordlistRetrieveResponse"]
+
+
+class WordlistRetrieveResponse(BaseModel):
+    id: str
+    """ID of the wordlist"""
+
+    created_at: str = FieldInfo(alias="createdAt")
+    """Creation date of the wordlist"""
+
+    name: Optional[str] = None
+    """Name of the wordlist"""
+
+    organization_id: str = FieldInfo(alias="organizationId")
+    """ID of the organization"""
+
+    strict: bool
+    """Strict mode"""
+
+    user_id: Optional[str] = FieldInfo(alias="userId", default=None)
+    """ID of the user"""
+
+    words: List[str]
+    """Words in the wordlist"""

moderation_api/types/wordlist_update_params.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = ["WordlistUpdateParams"]
+
+
+class WordlistUpdateParams(TypedDict, total=False):
+    description: str
+    """New description for the wordlist"""
+
+    key: str
+    """New key for the wordlist"""
+
+    name: str
+    """New name for the wordlist"""
+
+    strict: bool
+    """Deprecated. Now using threshold in project settings."""
+
+    words: SequenceNotStr[str]
+    """New words for the wordlist.
+
+    Replace the existing words with these new ones. Duplicate words will be ignored.
+    """

moderation_api/types/wordlist_update_response.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["WordlistUpdateResponse"]
+
+
+class WordlistUpdateResponse(BaseModel):
+    id: str
+    """ID of the wordlist"""
+
+    created_at: str = FieldInfo(alias="createdAt")
+    """Creation date of the wordlist"""
+
+    name: Optional[str] = None
+    """Name of the wordlist"""
+
+    organization_id: str = FieldInfo(alias="organizationId")
+    """ID of the organization"""
+
+    strict: bool
+    """Strict mode"""
+
+    user_id: Optional[str] = FieldInfo(alias="userId", default=None)
+    """ID of the user"""
+
+    words: List[str]
+    """Words in the wordlist"""