profound 0.1.0__py3-none-any.whl

profound/types/logs/raw_bots_params.py

@@ -0,0 +1,111 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, List, Union, Iterable
+from datetime import datetime
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._types import SequenceNotStr
+from ..._utils import PropertyInfo
+from ..pagination_param import PaginationParam
+
+__all__ = ["RawBotsParams", "Filter"]
+
+
+class RawBotsParams(TypedDict, total=False):
+    domain: Required[str]
+    """Domain to query logs for."""
+
+    metrics: Required[List[Literal["count"]]]
+
+    start_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """Start date for logs.
+
+    Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS, or full ISO
+    timestamp.
+    """
+
+    date_interval: Literal["day", "week", "month", "year"]
+    """Date interval for the report. (only used with date dimension)"""
+
+    dimensions: List[
+        Literal[
+            "method",
+            "path",
+            "status_code",
+            "ip",
+            "user_agent",
+            "referer",
+            "query_params",
+            "bot_name",
+            "bot_provider",
+            "bot_types",
+        ]
+    ]
+    """Dimensions to group the report by."""
+
+    end_date: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """End date for logs.
+
+    Accepts same formats as start_date. Defaults to now if omitted.
+    """
+
+    filters: Iterable[Filter]
+    """List of filters to apply to the report.
+
+    Each filter has an operator, field, and value.
+    """
+
+    order_by: Dict[str, Literal["asc", "desc"]]
+    """Custom ordering of the report results.
+
+    The order is a record of key-value pairs where:
+
+    - key is the field to order by, which can be a metric or dimension
+    - value is the direction of the order, either 'asc' for ascending or 'desc' for
+      descending.
+
+    When not specified, the default order is the first metric in the query
+    descending.
+    """
+
+    pagination: PaginationParam
+    """Pagination settings for the report results."""
+
+
+class Filter(TypedDict, total=False):
+    field: Required[
+        Literal[
+            "method",
+            "path",
+            "status_code",
+            "ip",
+            "user_agent",
+            "referer",
+            "query_params",
+            "bot_name",
+            "bot_provider",
+            "bot_types",
+        ]
+    ]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+            "matches",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str], int, Iterable[int]]]
+    """Value for the filter.
+
+    Can be a single value or a list of depending on the operator.
+    """

profound/types/logs/raw_bots_response.py

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, TypeAlias
+
+from ..._models import BaseModel
+from ..response import Response
+
+__all__ = ["RawBotsResponse", "LogVisitBotList"]
+
+
+class LogVisitBotList(BaseModel):
+    bot_name: str
+
+    bot_provider: str
+
+    bot_types: List[Literal["ai_assistant", "ai_training", "index"]]
+
+    host: str
+
+    ip: str
+
+    method: str
+
+    org_id: str
+
+    path: str
+
+    status_code: int
+
+    timestamp: datetime
+
+    user_agent: str
+
+    bytes_sent: Optional[int] = None
+
+    duration_ms: Optional[int] = None
+
+    query_params: Optional[Dict[str, str]] = None
+
+    referer: Optional[str] = None
+
+
+RawBotsResponse: TypeAlias = Union[List[LogVisitBotList], Response]

profound/types/logs/raw_logs_params.py

@@ -0,0 +1,99 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, List, Union, Iterable
+from datetime import datetime
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._types import SequenceNotStr
+from ..._utils import PropertyInfo
+from ..pagination_param import PaginationParam
+
+__all__ = ["RawLogsParams", "Filter"]
+
+
+class RawLogsParams(TypedDict, total=False):
+    domain: Required[str]
+    """Domain to query logs for."""
+
+    metrics: Required[List[Literal["count"]]]
+
+    start_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """Start date for logs.
+
+    Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS, or full ISO
+    timestamp.
+    """
+
+    date_interval: Literal["day", "week", "month", "year"]
+    """Date interval for the report. (only used with date dimension)"""
+
+    dimensions: List[
+        Literal[
+            "timestamp",
+            "method",
+            "host",
+            "path",
+            "status_code",
+            "ip",
+            "user_agent",
+            "referer",
+            "bytes_sent",
+            "duration_ms",
+            "query_params",
+        ]
+    ]
+    """Dimensions to group the report by."""
+
+    end_date: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """End date for logs.
+
+    Accepts same formats as start_date. Defaults to now if omitted.
+    """
+
+    filters: Iterable[Filter]
+    """List of filters to apply to the report.
+
+    Each filter has an operator, field, and value.
+    """
+
+    order_by: Dict[str, Literal["asc", "desc"]]
+    """Custom ordering of the report results.
+
+    The order is a record of key-value pairs where:
+
+    - key is the field to order by, which can be a metric or dimension
+    - value is the direction of the order, either 'asc' for ascending or 'desc' for
+      descending.
+
+    When not specified, the default order is the first metric in the query
+    descending.
+    """
+
+    pagination: PaginationParam
+    """Pagination settings for the report results."""
+
+
+class Filter(TypedDict, total=False):
+    field: Required[Literal["method", "path", "status_code", "ip", "user_agent", "referer", "query_params"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+            "matches",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str], int, Iterable[int]]]
+    """Value for the filter.
+
+    Can be a single value or a list of depending on the operator.
+    """

profound/types/logs/raw_logs_response.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+from datetime import datetime
+from typing_extensions import TypeAlias
+
+from ..._models import BaseModel
+from ..response import Response
+
+__all__ = ["RawLogsResponse", "LogVisitList"]
+
+
+class LogVisitList(BaseModel):
+    host: str
+
+    ip: str
+
+    method: str
+
+    org_id: str
+
+    path: str
+
+    status_code: int
+
+    timestamp: datetime
+
+    user_agent: str
+
+    bytes_sent: Optional[int] = None
+
+    duration_ms: Optional[int] = None
+
+    query_params: Optional[Dict[str, str]] = None
+
+    referer: Optional[str] = None
+
+
+RawLogsResponse: TypeAlias = Union[List[LogVisitList], Response]

profound/types/organization_domains_response.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from datetime import datetime
+from typing_extensions import TypeAlias
+
+from .._models import BaseModel
+
+__all__ = ["OrganizationDomainsResponse", "OrganizationDomainsResponseItem"]
+
+
+class OrganizationDomainsResponseItem(BaseModel):
+    id: str
+
+    created_at: datetime
+
+    name: str
+
+
+OrganizationDomainsResponse: TypeAlias = List[OrganizationDomainsResponseItem]

profound/types/organization_models_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .organizations.org_item import OrgItem
+
+__all__ = ["OrganizationModelsResponse"]
+
+OrganizationModelsResponse: TypeAlias = List[OrgItem]

profound/types/organization_regions_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .organizations.org_item import OrgItem
+
+__all__ = ["OrganizationRegionsResponse"]
+
+OrganizationRegionsResponse: TypeAlias = List[OrgItem]

profound/types/organizations/__init__.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .org_item import OrgItem as OrgItem
+from .category_list_response import CategoryListResponse as CategoryListResponse
+from .category_tags_response import CategoryTagsResponse as CategoryTagsResponse
+from .category_topics_response import CategoryTopicsResponse as CategoryTopicsResponse
+from .category_prompts_response import CategoryPromptsResponse as CategoryPromptsResponse

profound/types/organizations/category_list_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .org_item import OrgItem
+
+__all__ = ["CategoryListResponse"]
+
+CategoryListResponse: TypeAlias = List[OrgItem]

profound/types/organizations/category_prompts_response.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from .org_item import OrgItem
+from ..._models import BaseModel
+
+__all__ = ["CategoryPromptsResponse", "Data"]
+
+
+class Data(BaseModel):
+    id: str
+
+    created_at: datetime
+
+    platforms: List[OrgItem]
+
+    prompt: str
+
+    prompt_type: str
+
+    regions: List[OrgItem]
+
+    topic: OrgItem
+
+    tags: Optional[List[OrgItem]] = None
+
+
+class CategoryPromptsResponse(BaseModel):
+    data: List[Data]

profound/types/organizations/category_tags_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .org_item import OrgItem
+
+__all__ = ["CategoryTagsResponse"]
+
+CategoryTagsResponse: TypeAlias = List[OrgItem]

profound/types/organizations/category_topics_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .org_item import OrgItem
+
+__all__ = ["CategoryTopicsResponse"]
+
+CategoryTopicsResponse: TypeAlias = List[OrgItem]

profound/types/organizations/org_item.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["OrgItem"]
+
+
+class OrgItem(BaseModel):
+    id: str
+
+    name: str

profound/types/pagination_param.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 TypedDict
+
+__all__ = ["PaginationParam"]
+
+
+class PaginationParam(TypedDict, total=False):
+    limit: int
+    """Maximum number of results to return. Default is 10,000, maximum is 50,000."""
+
+    offset: int
+    """Offset for the results. Used for pagination."""

profound/types/prompt_answers_params.py

@@ -0,0 +1,82 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable
+from datetime import datetime
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+from .pagination_param import PaginationParam
+
+__all__ = ["PromptAnswersParams", "Filter", "Include"]
+
+
+class PromptAnswersParams(TypedDict, total=False):
+    category_id: Required[str]
+
+    end_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+
+    start_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+
+    filters: Iterable[Filter]
+
+    include: Include
+
+    pagination: PaginationParam
+    """Pagination parameters for the results. Default is 10,000 rows with no offset."""
+
+
+class Filter(TypedDict, total=False):
+    field: Required[Literal["region", "topic", "model", "prompt_type", "prompt", "tag"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+            "matches",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str], int, Iterable[int]]]
+    """Value for the filter.
+
+    Can be a single value or a list of depending on the operator.
+    """
+
+
+class Include(TypedDict, total=False):
+    asset: bool
+
+    citations: bool
+
+    created_at: bool
+
+    mentions: bool
+
+    model: bool
+
+    prompt: bool
+
+    prompt_id: bool
+
+    prompt_type: bool
+
+    region: bool
+
+    response: bool
+
+    run_id: bool
+
+    tags: bool
+
+    themes: bool
+
+    topic: bool

profound/types/prompt_answers_response.py

@@ -0,0 +1,44 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from datetime import datetime
+
+from .._models import BaseModel
+
+__all__ = ["PromptAnswersResponse", "Data"]
+
+
+class Data(BaseModel):
+    asset: Optional[str] = None
+
+    citations: Optional[List[str]] = None
+
+    created_at: Optional[datetime] = None
+
+    mentions: Optional[List[str]] = None
+
+    model: Optional[str] = None
+
+    prompt: Optional[str] = None
+
+    prompt_id: Optional[str] = None
+
+    prompt_type: Optional[str] = None
+
+    region: Optional[str] = None
+
+    response: Optional[str] = None
+
+    run_id: Optional[str] = None
+
+    tags: Optional[List[str]] = None
+
+    themes: Optional[List[str]] = None
+
+    topic: Optional[str] = None
+
+
+class PromptAnswersResponse(BaseModel):
+    data: List[Data]
+
+    info: Dict[str, object]

profound/types/report_citations_params.py

@@ -0,0 +1,83 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, List, Union, Iterable
+from datetime import datetime
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+from .pagination_param import PaginationParam
+
+__all__ = ["ReportCitationsParams", "Filter"]
+
+
+class ReportCitationsParams(TypedDict, total=False):
+    category_id: Required[str]
+
+    end_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """End date for the report.
+
+    Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.
+    """
+
+    metrics: Required[List[Literal["count", "share_of_voice"]]]
+
+    start_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """Start date for the report.
+
+    Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.
+    """
+
+    date_interval: Literal["day", "week", "month", "year"]
+    """Date interval for the report. (only used with date dimension)"""
+
+    dimensions: List[Literal["hostname", "path", "date", "region", "topic", "model", "tag"]]
+    """Dimensions to group the report by."""
+
+    filters: Iterable[Filter]
+    """List of filters to apply to the report.
+
+    Each filter has an operator, field, and value.
+    """
+
+    order_by: Dict[str, Literal["asc", "desc"]]
+    """Custom ordering of the report results.
+
+    The order is a record of key-value pairs where:
+
+    - key is the field to order by, which can be a metric or dimension
+    - value is the direction of the order, either 'asc' for ascending or 'desc' for
+      descending.
+
+    When not specified, the default order is the first metric in the query
+    descending.
+    """
+
+    pagination: PaginationParam
+    """Pagination settings for the report results."""
+
+
+class Filter(TypedDict, total=False):
+    field: Required[Literal["hostname", "path", "region", "topic", "model", "tag"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+            "matches",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str], int, Iterable[int]]]
+    """Value for the filter.
+
+    Can be a single value or a list of depending on the operator.
+    """

profound/types/report_citations_response.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .info import Info
+from .result import Result
+from .._models import BaseModel
+
+__all__ = ["ReportCitationsResponse"]
+
+
+class ReportCitationsResponse(BaseModel):
+    data: List[Result]
+
+    info: Info
+    """Base model for report information."""