profound 0.6.0__py3-none-any.whl → 0.8.0__py3-none-any.whl

profound/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "profound"
-__version__ = "0.6.0"  # x-release-please-version
+__version__ = "0.8.0"  # x-release-please-version

profound/resources/logs/raw.py

@@ -96,8 +96,7 @@ class RawResource(SyncAPIResource):
           end_date: End date for logs. Accepts same formats as start_date. Defaults to now if
               omitted.
 
-          filters: List of filters to apply to the report. Each filter has an operator, field, and
-              value.
+          filters: List of filters to apply to the bots logs query.
 
           order_by: Custom ordering of the report results.
 
@@ -195,8 +194,7 @@ class RawResource(SyncAPIResource):
           end_date: End date for logs. Accepts same formats as start_date. Defaults to now if
               omitted.
 
-          filters: List of filters to apply to the report. Each filter has an operator, field, and
-              value.
+          filters: Filters to apply to the logs query.
 
           order_by: Custom ordering of the report results.
 
@@ -314,8 +312,7 @@ class AsyncRawResource(AsyncAPIResource):
           end_date: End date for logs. Accepts same formats as start_date. Defaults to now if
               omitted.
 
-          filters: List of filters to apply to the report. Each filter has an operator, field, and
-              value.
+          filters: List of filters to apply to the bots logs query.
 
           order_by: Custom ordering of the report results.
 
@@ -413,8 +410,7 @@ class AsyncRawResource(AsyncAPIResource):
           end_date: End date for logs. Accepts same formats as start_date. Defaults to now if
               omitted.
 
-          filters: List of filters to apply to the report. Each filter has an operator, field, and
-              value.
+          filters: Filters to apply to the logs query.
 
           order_by: Custom ordering of the report results.
 

profound/resources/prompts.py

@@ -65,6 +65,8 @@ class PromptsResource(SyncAPIResource):
         Get the answers for the prompts.
 
         Args:
+          filters: List of filters to apply to the answers report.
+
           pagination: Pagination parameters for the results. Default is 10,000 rows with no offset.
 
           extra_headers: Send extra headers
@@ -135,6 +137,8 @@ class AsyncPromptsResource(AsyncAPIResource):
         Get the answers for the prompts.
 
         Args:
+          filters: List of filters to apply to the answers report.
+
           pagination: Pagination parameters for the results. Default is 10,000 rows with no offset.
 
           extra_headers: Send extra headers

profound/resources/reports.py

@@ -84,8 +84,7 @@ class ReportsResource(SyncAPIResource):
 
           dimensions: Dimensions to group the report by.
 
-          filters: List of filters to apply to the report. Each filter has an operator, field, and
-              value.
+          filters: List of filters to apply to the citations report.
 
           order_by: Custom ordering of the report results.
 
@@ -135,10 +134,12 @@ class ReportsResource(SyncAPIResource):
         *,
         category_id: str,
         end_date: Union[str, datetime],
-        metrics: List[Literal["positive", "negative"]],
+        metrics: List[Literal["positive", "negative", "ocurrences"]],
         start_date: Union[str, datetime],
         date_interval: Literal["day", "week", "month", "year"] | Omit = omit,
-        dimensions: List[Literal["theme", "date", "region", "topic", "model", "asset_name", "tag", "prompt"]]
+        dimensions: List[
+            Literal["theme", "date", "region", "topic", "model", "asset_name", "tag", "prompt", "sentiment_type"]
+        ]
         | Omit = omit,
         filters: Iterable[report_sentiment_params.Filter] | Omit = omit,
         order_by: Dict[str, Literal["asc", "desc"]] | Omit = omit,
@@ -165,8 +166,7 @@ class ReportsResource(SyncAPIResource):
 
           dimensions: Dimensions to group the report by.
 
-          filters: List of filters to apply to the report. Each filter has an operator, field, and
-              value.
+          filters: List of filters to apply to the sentiment report.
 
           order_by: Custom ordering of the report results.
 
@@ -245,8 +245,7 @@ class ReportsResource(SyncAPIResource):
 
           dimensions: Dimensions to group the report by.
 
-          filters: List of filters to apply to the report. Each filter has an operator, field, and
-              value.
+          filters: List of filters to apply to the visibility report.
 
           order_by: Custom ordering of the report results.
 
@@ -349,8 +348,7 @@ class AsyncReportsResource(AsyncAPIResource):
 
           dimensions: Dimensions to group the report by.
 
-          filters: List of filters to apply to the report. Each filter has an operator, field, and
-              value.
+          filters: List of filters to apply to the citations report.
 
           order_by: Custom ordering of the report results.
 
@@ -400,10 +398,12 @@ class AsyncReportsResource(AsyncAPIResource):
         *,
         category_id: str,
         end_date: Union[str, datetime],
-        metrics: List[Literal["positive", "negative"]],
+        metrics: List[Literal["positive", "negative", "ocurrences"]],
         start_date: Union[str, datetime],
         date_interval: Literal["day", "week", "month", "year"] | Omit = omit,
-        dimensions: List[Literal["theme", "date", "region", "topic", "model", "asset_name", "tag", "prompt"]]
+        dimensions: List[
+            Literal["theme", "date", "region", "topic", "model", "asset_name", "tag", "prompt", "sentiment_type"]
+        ]
         | Omit = omit,
         filters: Iterable[report_sentiment_params.Filter] | Omit = omit,
         order_by: Dict[str, Literal["asc", "desc"]] | Omit = omit,
@@ -430,8 +430,7 @@ class AsyncReportsResource(AsyncAPIResource):
 
           dimensions: Dimensions to group the report by.
 
-          filters: List of filters to apply to the report. Each filter has an operator, field, and
-              value.
+          filters: List of filters to apply to the sentiment report.
 
           order_by: Custom ordering of the report results.
 
@@ -510,8 +509,7 @@ class AsyncReportsResource(AsyncAPIResource):
 
           dimensions: Dimensions to group the report by.
 
-          filters: List of filters to apply to the report. Each filter has an operator, field, and
-              value.
+          filters: List of filters to apply to the visibility report.
 
           order_by: Custom ordering of the report results.
 

profound/types/logs/raw_bots_params.py

@@ -4,13 +4,26 @@ from __future__ import annotations
 
 from typing import Dict, List, Union, Iterable
 from datetime import datetime
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
 
 from ..._types import SequenceNotStr
 from ..._utils import PropertyInfo
 from ..shared_params.pagination import Pagination
 
-__all__ = ["RawBotsParams", "Filter"]
+__all__ = [
+    "RawBotsParams",
+    "Filter",
+    "FilterBotNameFilter",
+    "FilterBotProviderFilter",
+    "FilterBotTypesFilter",
+    "FilterMethodFilter",
+    "FilterAppModelsAgentAnalyticsFiltersPathFilter",
+    "FilterStatusCodeFilter",
+    "FilterIPFilter",
+    "FilterUserAgentFilter",
+    "FilterRefererFilter",
+    "FilterQueryParamsFilter",
+]
 
 
 class RawBotsParams(TypedDict, total=False):
@@ -52,10 +65,7 @@ class RawBotsParams(TypedDict, total=False):
     """
 
     filters: Iterable[Filter]
-    """List of filters to apply to the report.
-
-    Each filter has an operator, field, and value.
-    """
+    """List of filters to apply to the bots logs query."""
 
     order_by: Dict[str, Literal["asc", "desc"]]
     """Custom ordering of the report results.
@@ -74,22 +84,49 @@ class RawBotsParams(TypedDict, total=False):
     """Pagination settings for the report results."""
 
 
-class Filter(TypedDict, total=False):
-    field: Required[
+class FilterBotNameFilter(TypedDict, total=False):
+    field: Required[Literal["bot_name"]]
+
+    operator: Required[
         Literal[
-            "method",
-            "path",
-            "status_code",
-            "ip",
-            "user_agent",
-            "referer",
-            "query_params",
-            "bot_name",
-            "bot_provider",
-            "bot_types",
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterBotProviderFilter(TypedDict, total=False):
+    field: Required[Literal["bot_provider"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
         ]
     ]
 
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterBotTypesFilter(TypedDict, total=False):
+    field: Required[Literal["bot_types"]]
+
     operator: Required[
         Literal[
             "is",
@@ -98,14 +135,154 @@ class Filter(TypedDict, total=False):
             "not_in",
             "contains",
             "not_contains",
+            "matches",
             "contains_case_insensitive",
             "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[
+        Union[Literal["ai_assistant", "ai_training", "index"], List[Literal["ai_assistant", "ai_training", "index"]]]
+    ]
+
+
+class FilterMethodFilter(TypedDict, total=False):
+    field: Required[Literal["method"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
             "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
         ]
     ]
 
-    value: Required[Union[str, SequenceNotStr[str], int, Iterable[int]]]
-    """Value for the filter.
+    value: Required[Union[str, SequenceNotStr[str]]]
 
-    Can be a single value or a list of depending on the operator.
-    """
+
+class FilterAppModelsAgentAnalyticsFiltersPathFilter(TypedDict, total=False):
+    field: Required[Literal["path"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterStatusCodeFilter(TypedDict, total=False):
+    field: Required[Literal["status_code"]]
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[int, Iterable[int]]]
+
+
+class FilterIPFilter(TypedDict, total=False):
+    field: Required[Literal["ip"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterUserAgentFilter(TypedDict, total=False):
+    field: Required[Literal["user_agent"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterRefererFilter(TypedDict, total=False):
+    field: Required[Literal["referer"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterQueryParamsFilter(TypedDict, total=False):
+    field: Required[Literal["query_params"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+Filter: TypeAlias = Union[
+    FilterBotNameFilter,
+    FilterBotProviderFilter,
+    FilterBotTypesFilter,
+    FilterMethodFilter,
+    FilterAppModelsAgentAnalyticsFiltersPathFilter,
+    FilterStatusCodeFilter,
+    FilterIPFilter,
+    FilterUserAgentFilter,
+    FilterRefererFilter,
+    FilterQueryParamsFilter,
+]

profound/types/logs/raw_logs_params.py

@@ -4,13 +4,27 @@ from __future__ import annotations
 
 from typing import Dict, List, Union, Iterable
 from datetime import datetime
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
 
 from ..._types import SequenceNotStr
 from ..._utils import PropertyInfo
 from ..shared_params.pagination import Pagination
 
-__all__ = ["RawLogsParams", "Filter"]
+__all__ = [
+    "RawLogsParams",
+    "Filter",
+    "FilterMethodFilter",
+    "FilterHostFilter",
+    "FilterAppModelsAgentAnalyticsFiltersPathFilter",
+    "FilterStatusCodeFilter",
+    "FilterIPFilter",
+    "FilterUserAgentFilter",
+    "FilterRefererFilter",
+    "FilterProviderFilter",
+    "FilterQueryParamsFilter",
+    "FilterBytesSentFilter",
+    "FilterDurationMsFilter",
+]
 
 
 class RawLogsParams(TypedDict, total=False):
@@ -53,10 +67,7 @@ class RawLogsParams(TypedDict, total=False):
     """
 
     filters: Iterable[Filter]
-    """List of filters to apply to the report.
-
-    Each filter has an operator, field, and value.
-    """
+    """Filters to apply to the logs query."""
 
     order_by: Dict[str, Literal["asc", "desc"]]
     """Custom ordering of the report results.
@@ -75,8 +86,8 @@ class RawLogsParams(TypedDict, total=False):
     """Pagination settings for the report results."""
 
 
-class Filter(TypedDict, total=False):
-    field: Required[Literal["method", "path", "status_code", "ip", "user_agent", "referer", "query_params"]]
+class FilterMethodFilter(TypedDict, total=False):
+    field: Required[Literal["method"]]
 
     operator: Required[
         Literal[
@@ -86,14 +97,189 @@ class Filter(TypedDict, total=False):
             "not_in",
             "contains",
             "not_contains",
+            "matches",
             "contains_case_insensitive",
             "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterHostFilter(TypedDict, total=False):
+    field: Required[Literal["host"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
             "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
         ]
     ]
 
-    value: Required[Union[str, SequenceNotStr[str], int, Iterable[int]]]
-    """Value for the filter.
+    value: Required[Union[str, SequenceNotStr[str]]]
 
-    Can be a single value or a list of depending on the operator.
-    """
+
+class FilterAppModelsAgentAnalyticsFiltersPathFilter(TypedDict, total=False):
+    field: Required[Literal["path"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterStatusCodeFilter(TypedDict, total=False):
+    field: Required[Literal["status_code"]]
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[int, Iterable[int]]]
+
+
+class FilterIPFilter(TypedDict, total=False):
+    field: Required[Literal["ip"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterUserAgentFilter(TypedDict, total=False):
+    field: Required[Literal["user_agent"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterRefererFilter(TypedDict, total=False):
+    field: Required[Literal["referer"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterProviderFilter(TypedDict, total=False):
+    field: Required[Literal["provider"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterQueryParamsFilter(TypedDict, total=False):
+    field: Required[Literal["query_params"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterBytesSentFilter(TypedDict, total=False):
+    field: Required[Literal["bytes_sent"]]
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[int, Iterable[int]]]
+
+
+class FilterDurationMsFilter(TypedDict, total=False):
+    field: Required[Literal["duration_ms"]]
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[int, Iterable[int]]]
+
+
+Filter: TypeAlias = Union[
+    FilterMethodFilter,
+    FilterHostFilter,
+    FilterAppModelsAgentAnalyticsFiltersPathFilter,
+    FilterStatusCodeFilter,
+    FilterIPFilter,
+    FilterUserAgentFilter,
+    FilterRefererFilter,
+    FilterProviderFilter,
+    FilterQueryParamsFilter,
+    FilterBytesSentFilter,
+    FilterDurationMsFilter,
+]

profound/types/prompt_answers_params.py

@@ -2,15 +2,24 @@
 
 from __future__ import annotations
 
-from typing import Union, Iterable
+from typing import List, Union, Iterable
 from datetime import datetime
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
 
 from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 from .shared_params.pagination import Pagination
 
-__all__ = ["PromptAnswersParams", "Filter", "Include"]
+__all__ = [
+    "PromptAnswersParams",
+    "Filter",
+    "FilterRegionIDFilter",
+    "FilterModelIDFilter",
+    "FilterTagIDFilter",
+    "FilterPromptTypeFilter",
+    "FilterPromptFilter",
+    "Include",
+]
 
 
 class PromptAnswersParams(TypedDict, total=False):
@@ -21,6 +30,7 @@ class PromptAnswersParams(TypedDict, total=False):
     start_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
 
     filters: Iterable[Filter]
+    """List of filters to apply to the answers report."""
 
     include: Include
 
@@ -28,8 +38,35 @@ class PromptAnswersParams(TypedDict, total=False):
     """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"]]
+class FilterRegionIDFilter(TypedDict, total=False):
+    field: Required[Literal["region_id", "region"]]
+    """- `region` - Deprecated"""
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterModelIDFilter(TypedDict, total=False):
+    field: Required[Literal["model_id", "model"]]
+    """- `model` - Deprecated"""
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterTagIDFilter(TypedDict, total=False):
+    field: Required[Literal["tag_id", "tag"]]
+    """- `tag` - Deprecated"""
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterPromptTypeFilter(TypedDict, total=False):
+    field: Required[Literal["prompt_type"]]
 
     operator: Required[
         Literal[
@@ -39,17 +76,38 @@ class Filter(TypedDict, total=False):
             "not_in",
             "contains",
             "not_contains",
+            "matches",
             "contains_case_insensitive",
             "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[Literal["visibility", "sentiment"], List[Literal["visibility", "sentiment"]]]]
+
+
+class FilterPromptFilter(TypedDict, total=False):
+    field: Required[Literal["prompt"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
             "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
         ]
     ]
 
-    value: Required[Union[str, SequenceNotStr[str], int, Iterable[int]]]
-    """Value for the filter.
+    value: Required[Union[str, SequenceNotStr[str]]]
+
 
-    Can be a single value or a list of depending on the operator.
-    """
+Filter: TypeAlias = Union[
+    FilterRegionIDFilter, FilterModelIDFilter, FilterTagIDFilter, FilterPromptTypeFilter, FilterPromptFilter
+]
 
 
 class Include(TypedDict, total=False):

profound/types/report_citations_params.py

@@ -4,13 +4,25 @@ from __future__ import annotations
 
 from typing import Dict, List, Union, Iterable
 from datetime import datetime
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
 
 from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 from .shared_params.pagination import Pagination
 
-__all__ = ["ReportCitationsParams", "Filter"]
+__all__ = [
+    "ReportCitationsParams",
+    "Filter",
+    "FilterHostnameFilter",
+    "FilterAppModelsAnswerEngineInsightsFiltersPathFilter",
+    "FilterRegionIDFilter",
+    "FilterTopicIDFilter",
+    "FilterModelIDFilter",
+    "FilterTagIDFilter",
+    "FilterURLFilter",
+    "FilterRootDomainFilter",
+    "FilterPromptTypeFilter",
+]
 
 
 class ReportCitationsParams(TypedDict, total=False):
@@ -39,10 +51,7 @@ class ReportCitationsParams(TypedDict, total=False):
     """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.
-    """
+    """List of filters to apply to the citations report."""
 
     order_by: Dict[str, Literal["asc", "desc"]]
     """Custom ordering of the report results.
@@ -61,8 +70,8 @@ class ReportCitationsParams(TypedDict, total=False):
     """Pagination settings for the report results."""
 
 
-class Filter(TypedDict, total=False):
-    field: Required[Literal["hostname", "path", "region", "topic", "model", "tag", "url", "root_domain", "prompt_type"]]
+class FilterHostnameFilter(TypedDict, total=False):
+    field: Required[Literal["hostname"]]
 
     operator: Required[
         Literal[
@@ -72,14 +81,139 @@ class Filter(TypedDict, total=False):
             "not_in",
             "contains",
             "not_contains",
+            "matches",
             "contains_case_insensitive",
             "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterAppModelsAnswerEngineInsightsFiltersPathFilter(TypedDict, total=False):
+    field: Required[Literal["path"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
             "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
         ]
     ]
 
-    value: Required[Union[str, SequenceNotStr[str], int, Iterable[int]]]
-    """Value for the filter.
+    value: Required[Union[str, SequenceNotStr[str]]]
 
-    Can be a single value or a list of depending on the operator.
-    """
+
+class FilterRegionIDFilter(TypedDict, total=False):
+    field: Required[Literal["region_id", "region"]]
+    """- `region` - Deprecated"""
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterTopicIDFilter(TypedDict, total=False):
+    field: Required[Literal["topic_id", "topic"]]
+    """- `topic` - Deprecated"""
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterModelIDFilter(TypedDict, total=False):
+    field: Required[Literal["model_id", "model"]]
+    """- `model` - Deprecated"""
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterTagIDFilter(TypedDict, total=False):
+    field: Required[Literal["tag_id", "tag"]]
+    """- `tag` - Deprecated"""
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterURLFilter(TypedDict, total=False):
+    field: Required[Literal["url"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterRootDomainFilter(TypedDict, total=False):
+    field: Required[Literal["root_domain"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterPromptTypeFilter(TypedDict, total=False):
+    field: Required[Literal["prompt_type"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[Literal["visibility", "sentiment"], List[Literal["visibility", "sentiment"]]]]
+
+
+Filter: TypeAlias = Union[
+    FilterHostnameFilter,
+    FilterAppModelsAnswerEngineInsightsFiltersPathFilter,
+    FilterRegionIDFilter,
+    FilterTopicIDFilter,
+    FilterModelIDFilter,
+    FilterTagIDFilter,
+    FilterURLFilter,
+    FilterRootDomainFilter,
+    FilterPromptTypeFilter,
+]

profound/types/report_sentiment_params.py

@@ -4,13 +4,23 @@ from __future__ import annotations
 
 from typing import Dict, List, Union, Iterable
 from datetime import datetime
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
 
 from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 from .shared_params.pagination import Pagination
 
-__all__ = ["ReportSentimentParams", "Filter"]
+__all__ = [
+    "ReportSentimentParams",
+    "Filter",
+    "FilterAssetNameFilter",
+    "FilterThemeFilter",
+    "FilterRegionIDFilter",
+    "FilterTopicIDFilter",
+    "FilterModelIDFilter",
+    "FilterTagIDFilter",
+    "FilterPromptFilter",
+]
 
 
 class ReportSentimentParams(TypedDict, total=False):
@@ -22,7 +32,7 @@ class ReportSentimentParams(TypedDict, total=False):
     Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.
     """
 
-    metrics: Required[List[Literal["positive", "negative"]]]
+    metrics: Required[List[Literal["positive", "negative", "ocurrences"]]]
 
     start_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
     """Start date for the report.
@@ -33,14 +43,13 @@ class ReportSentimentParams(TypedDict, total=False):
     date_interval: Literal["day", "week", "month", "year"]
     """Date interval for the report. (only used with date dimension)"""
 
-    dimensions: List[Literal["theme", "date", "region", "topic", "model", "asset_name", "tag", "prompt"]]
+    dimensions: List[
+        Literal["theme", "date", "region", "topic", "model", "asset_name", "tag", "prompt", "sentiment_type"]
+    ]
     """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.
-    """
+    """List of filters to apply to the sentiment report."""
 
     order_by: Dict[str, Literal["asc", "desc"]]
     """Custom ordering of the report results.
@@ -59,8 +68,8 @@ class ReportSentimentParams(TypedDict, total=False):
     """Pagination settings for the report results."""
 
 
-class Filter(TypedDict, total=False):
-    field: Required[Literal["asset_name", "theme", "region", "topic", "model", "tag"]]
+class FilterAssetNameFilter(TypedDict, total=False):
+    field: Required[Literal["asset_name"]]
 
     operator: Required[
         Literal[
@@ -70,14 +79,97 @@ class Filter(TypedDict, total=False):
             "not_in",
             "contains",
             "not_contains",
+            "matches",
             "contains_case_insensitive",
             "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterThemeFilter(TypedDict, total=False):
+    field: Required[Literal["theme"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
             "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
         ]
     ]
 
-    value: Required[Union[str, SequenceNotStr[str], int, Iterable[int]]]
-    """Value for the filter.
+    value: Required[Union[str, SequenceNotStr[str]]]
 
-    Can be a single value or a list of depending on the operator.
-    """
+
+class FilterRegionIDFilter(TypedDict, total=False):
+    field: Required[Literal["region_id", "region"]]
+    """- `region` - Deprecated"""
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterTopicIDFilter(TypedDict, total=False):
+    field: Required[Literal["topic_id", "topic"]]
+    """- `topic` - Deprecated"""
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterModelIDFilter(TypedDict, total=False):
+    field: Required[Literal["model_id", "model"]]
+    """- `model` - Deprecated"""
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterTagIDFilter(TypedDict, total=False):
+    field: Required[Literal["tag_id", "tag"]]
+    """- `tag` - Deprecated"""
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterPromptFilter(TypedDict, total=False):
+    field: Required[Literal["prompt"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
+            "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+Filter: TypeAlias = Union[
+    FilterAssetNameFilter,
+    FilterThemeFilter,
+    FilterRegionIDFilter,
+    FilterTopicIDFilter,
+    FilterModelIDFilter,
+    FilterTagIDFilter,
+    FilterPromptFilter,
+]

profound/types/report_visibility_params.py

@@ -4,13 +4,22 @@ from __future__ import annotations
 
 from typing import Dict, List, Union, Iterable
 from datetime import datetime
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
 
 from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 from .shared_params.pagination import Pagination
 
-__all__ = ["ReportVisibilityParams", "Filter"]
+__all__ = [
+    "ReportVisibilityParams",
+    "Filter",
+    "FilterRegionIDFilter",
+    "FilterModelIDFilter",
+    "FilterTopicIDFilter",
+    "FilterAssetNameFilter",
+    "FilterTagIDFilter",
+    "FilterPromptFilter",
+]
 
 
 class ReportVisibilityParams(TypedDict, total=False):
@@ -37,10 +46,7 @@ class ReportVisibilityParams(TypedDict, total=False):
     """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.
-    """
+    """List of filters to apply to the visibility report."""
 
     order_by: Dict[str, Literal["asc", "desc"]]
     """Custom ordering of the report results.
@@ -59,8 +65,35 @@ class ReportVisibilityParams(TypedDict, total=False):
     """Pagination settings for the report results."""
 
 
-class Filter(TypedDict, total=False):
-    field: Required[Literal["region", "topic", "model", "asset_name", "prompt", "tag"]]
+class FilterRegionIDFilter(TypedDict, total=False):
+    field: Required[Literal["region_id", "region"]]
+    """- `region` - Deprecated"""
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterModelIDFilter(TypedDict, total=False):
+    field: Required[Literal["model_id", "model"]]
+    """- `model` - Deprecated"""
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterTopicIDFilter(TypedDict, total=False):
+    field: Required[Literal["topic_id", "topic"]]
+    """- `topic` - Deprecated"""
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterAssetNameFilter(TypedDict, total=False):
+    field: Required[Literal["asset_name"]]
 
     operator: Required[
         Literal[
@@ -70,14 +103,49 @@ class Filter(TypedDict, total=False):
             "not_in",
             "contains",
             "not_contains",
+            "matches",
             "contains_case_insensitive",
             "not_contains_case_insensitive",
+        ]
+    ]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterTagIDFilter(TypedDict, total=False):
+    field: Required[Literal["tag_id", "tag"]]
+    """- `tag` - Deprecated"""
+
+    operator: Required[Literal["is", "not_is", "in", "not_in"]]
+
+    value: Required[Union[str, SequenceNotStr[str]]]
+
+
+class FilterPromptFilter(TypedDict, total=False):
+    field: Required[Literal["prompt"]]
+
+    operator: Required[
+        Literal[
+            "is",
+            "not_is",
+            "in",
+            "not_in",
+            "contains",
+            "not_contains",
             "matches",
+            "contains_case_insensitive",
+            "not_contains_case_insensitive",
         ]
     ]
 
-    value: Required[Union[str, SequenceNotStr[str], int, Iterable[int]]]
-    """Value for the filter.
+    value: Required[Union[str, SequenceNotStr[str]]]
 
-    Can be a single value or a list of depending on the operator.
-    """
+
+Filter: TypeAlias = Union[
+    FilterRegionIDFilter,
+    FilterModelIDFilter,
+    FilterTopicIDFilter,
+    FilterAssetNameFilter,
+    FilterTagIDFilter,
+    FilterPromptFilter,
+]

{profound-0.6.0.dist-info → profound-0.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: profound
-Version: 0.6.0
+Version: 0.8.0
 Summary: The official Python library for the profound API
 Project-URL: Homepage, https://github.com/cooper-square-technologies/profound-python-sdk
 Project-URL: Repository, https://github.com/cooper-square-technologies/profound-python-sdk

{profound-0.6.0.dist-info → profound-0.8.0.dist-info}/RECORD

@@ -11,7 +11,7 @@ profound/_resource.py,sha256=YhL4zPjSsRL1L5E5naES_gV6TkUELjzC6kVxaY0PdHw,1112
 profound/_response.py,sha256=x5yzUWG_0y3G0zsq7LymfLwgqaQmwvOA5-JptD0VOyA,28800
 profound/_streaming.py,sha256=lmBTdPkE-WAfFtBQgTYup0lycgeOMOKKILPflxXzomg,10108
 profound/_types.py,sha256=lpu9B2IW_aKN4UH2Wy6tCjfci53t1MckP0ymxKwiWbY,7238
-profound/_version.py,sha256=p4a8XSqCa5dMv6dUlVwRIIcgdynEltt_gQzFoOvaxbo,160
+profound/_version.py,sha256=aBMA3KiAdn93YMw92t85B0BtR4QtJjfy-hQw3B74Hk0,160
 profound/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 profound/_utils/__init__.py,sha256=7fch0GT9zpNnErbciSpUNa-SjTxxjY6kxHxKMOM4AGs,2305
 profound/_utils/_compat.py,sha256=D8gtAvjJQrDWt9upS0XaG9Rr5l1QhiAx_I_1utT_tt0,1195
@@ -27,11 +27,11 @@ profound/_utils/_typing.py,sha256=N_5PPuFNsaygbtA_npZd98SVN1LQQvFTKL6bkWPBZGU,47
 profound/_utils/_utils.py,sha256=0dDqauUbVZEXV0NVl7Bwu904Wwo5eyFCZpQThhFNhyA,12253
 profound/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
 profound/resources/__init__.py,sha256=W12BGTFhkNpAkkWMKyAXrUuOf0IYrxInKvM8PQtEFIs,1993
-profound/resources/prompts.py,sha256=XhERp4L4FVE4xTngslgmV7AVRh6SZzGcQzHO1lP02Hg,7525
-profound/resources/reports.py,sha256=9f0aQTNJre0xQqe0CVYqPoUKzk2zlGlZm67wc9nehdc,24551
+profound/resources/prompts.py,sha256=kVyuNMqddyBbqmV3YBnP_lF_MBRfMsrc72x7840SygM,7661
+profound/resources/reports.py,sha256=87eBPsS8Q0clC3wEZuyx8XaqeW0QDlt2GyvgsfxqbmI,24355
 profound/resources/logs/__init__.py,sha256=O6f6TO4gow2FymLgYAZIzT_thUVOIf0MNWKIoHbyo0Q,937
 profound/resources/logs/logs.py,sha256=5ZJXn0glWvBhgW6vzba0b-0g_bKGssW1Lo2spM-mz3s,3528
-profound/resources/logs/raw.py,sha256=Kt8qDBKXe8qvSi0pxPMOok72_7UQ1qczle8nka1aVWg,18950
+profound/resources/logs/raw.py,sha256=Y0mOQE-95rVa89CpUemCb-_DRc66q-JXapIj-QWlgYE,18716
 profound/resources/organizations/__init__.py,sha256=emv6wKVQMAX4fIUAee0XkQDQzwvpnrAZHrv9WPhDLIA,1145
 profound/resources/organizations/categories.py,sha256=gHwuYsuHMX-JzgOZFO-Eft_O7rdBiwJ_V0iCf3kdkC4,14540
 profound/resources/organizations/organizations.py,sha256=4EbpHSaS_wU05HOgAi_YRwB7A-PfO-PuQ4RQzcbyMog,10852
@@ -39,19 +39,19 @@ profound/types/__init__.py,sha256=NUlK_Mn9QqsbVgmbye_CO8XsHnUPvORzVb6_RflpK0k,11
 profound/types/organization_domains_response.py,sha256=vpXf7RJnU8CoSbpeAgRzBPeDw7pVnr4LHOjsxdh17oc,478
 profound/types/organization_models_response.py,sha256=7k8rbvmOA-iusEiTOfK7ZCC4d4BKBwDkKCUTjC3MCRM,293
 profound/types/organization_regions_response.py,sha256=3rQ20rxQs7qGuHVx8W5P6y1dGSM9Qds3vwCQLm6Xqpk,295
-profound/types/prompt_answers_params.py,sha256=J_JNRqxGA8tIYgnVc_YKgUA8tDQfjKgJ96gUEv8y8Zw,1805
+profound/types/prompt_answers_params.py,sha256=9yacCEt_gShcMeF_I7SDR08OUtW3OkfvundGID5sODE,3275
 profound/types/prompt_answers_response.py,sha256=n9UVrTwAUmX4wi_OzlszPuZ3Vv80rey5k5_1ESR8spc,918
-profound/types/report_citations_params.py,sha256=GlZx0pcTQ1I_y4_uPEZnrOPXNlyR_7rTzZp3z2FcGiQ,2597
+profound/types/report_citations_params.py,sha256=5byUSS3rG3v_YcFKJfZBszmn1E5FbK6d8FCNN3j4E7w,5839
 profound/types/report_citations_response.py,sha256=x7cWeAIS8coXoYmk0KxPB8idvnC-Qrdnhkubes7qWiI,399
 profound/types/report_info.py,sha256=UCM4Ip1JQSjcO_0UfRivj1aLBSDbiynJxbZnp9UAc2k,278
 profound/types/report_response.py,sha256=a9ffmdhkvoBQ8RiyV76XJ7kxIofm1t2d6QhDPQofPf0,381
 profound/types/report_result.py,sha256=JOqZQb5keNw9wfaNF4YHGRgV3RTXgwfWhs1VM8Prqsk,257
-profound/types/report_sentiment_params.py,sha256=YdGw_Aa3rRJZPQkjpvQwMWDnPNOc5acDVk2Zj4eIjrQ,2527
-profound/types/report_visibility_params.py,sha256=gdaXNw3xOSMlV1B_jGcdlv1r8973plWTM96JxZkI-yo,2567
+profound/types/report_sentiment_params.py,sha256=q1tktT-BHWcAutBg25Xr30WJKeeeECvPL1n8O8iiACI,4688
+profound/types/report_visibility_params.py,sha256=jbbidv2X3aC2AJSdBpTgRn7-2yipoXhZoH14-LCye_w,4192
 profound/types/logs/__init__.py,sha256=s00zfNR32tlguLjmtxhC_YcH8a1GVzhJEZOC6cYzr28,375
-profound/types/logs/raw_bots_params.py,sha256=ZDD82DcyNzbA4qlZsg9ApsfXKl0b2zsqXcYSpWAxwLo,2917
+profound/types/logs/raw_bots_params.py,sha256=SYhtdZnhO3GFOx-kL52diVKLyGmmLdrihDzrtOkEZOE,7058
 profound/types/logs/raw_bots_response.py,sha256=7Qoh5rt6UTlJaz2I3EZHIDK8J_l1slc-Codl9AwULz4,885
-profound/types/logs/raw_logs_params.py,sha256=I1enumH8pAiOp7EZoE5FPu5ed_eP-3vTJFmwA_6wlMY,2752
+profound/types/logs/raw_logs_params.py,sha256=RVlWxR2Sml9YJrrNz-inwvzSm-n_-nFcFL75AAsTO5w,6983
 profound/types/logs/raw_logs_response.py,sha256=Z3qafXC6qUZ8e_sG7x9PBKXU4Uu8eqBt2kb27FU3tAU,743
 profound/types/organizations/__init__.py,sha256=feq64-7LJFh2pvyzJGJzAL-q8DG_KPkMC06dL5J-35g,503
 profound/types/organizations/category_list_response.py,sha256=AvLmruxYC42Pn9ibXNiUah7idFW-tpn1HCBd399zkl4,267
@@ -63,7 +63,7 @@ profound/types/shared/__init__.py,sha256=Htv0wQd-4CHTwCC1FaroMpYcWIGFM2KdvXF8ay0
 profound/types/shared/pagination.py,sha256=JU0XsGFY16yro_-uEvzI9rP0uMO583Q475htFoFeHjQ,412
 profound/types/shared_params/__init__.py,sha256=Htv0wQd-4CHTwCC1FaroMpYcWIGFM2KdvXF8ay0nYuE,136
 profound/types/shared_params/pagination.py,sha256=F8KqTI_WcSmLpLaGg8Vp4wEuNifrOBPY5MZV-GNy11E,405
-profound-0.6.0.dist-info/METADATA,sha256=RDIsyXXPBMGjS0l626Bkkrv9X16SBBRNY3KsK-SSXdE,14203
-profound-0.6.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-profound-0.6.0.dist-info/licenses/LICENSE,sha256=mQrIrzZE8kr7w7NuHiw98Xz-EopSKzbT0MKGCsSRuPI,11338
-profound-0.6.0.dist-info/RECORD,,
+profound-0.8.0.dist-info/METADATA,sha256=RhHOGBMgy5Nl4_0WaEg9gcps1bSL4NEFe06ymt4vCKU,14203
+profound-0.8.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+profound-0.8.0.dist-info/licenses/LICENSE,sha256=mQrIrzZE8kr7w7NuHiw98Xz-EopSKzbT0MKGCsSRuPI,11338
+profound-0.8.0.dist-info/RECORD,,