athena-intelligence 0.1.72__tar.gz → 0.1.74__tar.gz

{athena_intelligence-0.1.72 → athena_intelligence-0.1.74}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: athena-intelligence
-Version: 0.1.72
+Version: 0.1.74
 Summary: 
 Requires-Python: >=3.8,<4.0
 Classifier: Programming Language :: Python :: 3

{athena_intelligence-0.1.72 → athena_intelligence-0.1.74}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "athena-intelligence"
-version = "0.1.72"
+version = "0.1.74"
 description = ""
 readme = "README.md"
 authors = []

{athena_intelligence-0.1.72 → athena_intelligence-0.1.74}/src/athena/__init__.py

@@ -6,6 +6,8 @@ from .types import (
     Document,
     ExcecuteToolFirstWorkflowOut,
     FileDataResponse,
+    FilterModel,
+    FilterOperator,
     FirecrawlScrapeUrlDataReponseDto,
     FirecrawlScrapeUrlMetadata,
     GetDatasetsResponse,
@@ -19,12 +21,15 @@ from .types import (
     MessageOutDto,
     Model,
     PublishFormats,
+    QueryModel,
     Report,
     ResearcherOut,
+    SemanticQueryOut,
     Snippet,
     SqlResults,
     StatusEnum,
     StructuredParseResult,
+    TimeDimensionModel,
     Tools,
     UploadDocumentsOut,
     UrlResult,
@@ -44,6 +49,8 @@ __all__ = [
     "Document",
     "ExcecuteToolFirstWorkflowOut",
     "FileDataResponse",
+    "FilterModel",
+    "FilterOperator",
     "FirecrawlScrapeUrlDataReponseDto",
     "FirecrawlScrapeUrlMetadata",
     "GetDatasetsResponse",
@@ -57,12 +64,15 @@ __all__ = [
     "MessageOutDto",
     "Model",
     "PublishFormats",
+    "QueryModel",
     "Report",
     "ResearcherOut",
+    "SemanticQueryOut",
     "Snippet",
     "SqlResults",
     "StatusEnum",
     "StructuredParseResult",
+    "TimeDimensionModel",
     "Tools",
     "UnprocessableEntityError",
     "UploadDocumentsOut",

{athena_intelligence-0.1.72 → athena_intelligence-0.1.74}/src/athena/core/client_wrapper.py

@@ -17,7 +17,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "athena-intelligence",
-            "X-Fern-SDK-Version": "0.1.72",
+            "X-Fern-SDK-Version": "0.1.74",
         }
         headers["X-API-KEY"] = self.api_key
         return headers

{athena_intelligence-0.1.72 → athena_intelligence-0.1.74}/src/athena/tools/client.py

@@ -18,7 +18,9 @@ from ..types.http_validation_error import HttpValidationError
 from ..types.langchain_documents_request_out import LangchainDocumentsRequestOut
 from ..types.llm_model import LlmModel
 from ..types.publish_formats import PublishFormats
+from ..types.query_model import QueryModel
 from ..types.researcher_out import ResearcherOut
+from ..types.semantic_query_out import SemanticQueryOut
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -399,6 +401,89 @@ class ToolsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def semantic_query(
+        self,
+        *,
+        query: QueryModel,
+        table_name: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SemanticQueryOut:
+        """
+        Parameters:
+            - query: QueryModel.
+
+            - table_name: typing.Optional[str].
+
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
+        ---
+        from athena import FilterModel, FilterOperator, QueryModel, TimeDimensionModel
+        from athena.client import Athena
+
+        client = Athena(
+            api_key="YOUR_API_KEY",
+        )
+        client.tools.semantic_query(
+            query=QueryModel(
+                measures=["count"],
+                time_dimensions=[
+                    TimeDimensionModel(
+                        dimension="dimension",
+                        granularity="granularity",
+                        date_range=["dateRange"],
+                    )
+                ],
+                dimensions=["manufacturer"],
+                filters=[
+                    FilterModel(
+                        dimension="manufacturer",
+                        operator=FilterOperator.EQUALS,
+                        values=["Athena"],
+                    )
+                ],
+            ),
+        )
+        """
+        _request: typing.Dict[str, typing.Any] = {"query": query}
+        if table_name is not OMIT:
+            _request["table_name"] = table_name
+        _response = self._client_wrapper.httpx_client.request(
+            method="POST",
+            url=urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", "api/v0/tools/strict-semantic-query"),
+            params=jsonable_encoder(
+                request_options.get("additional_query_parameters") if request_options is not None else None
+            ),
+            json=jsonable_encoder(_request)
+            if request_options is None or request_options.get("additional_body_parameters") is None
+            else {
+                **jsonable_encoder(_request),
+                **(jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_parameters", {})))),
+            },
+            headers=jsonable_encoder(
+                remove_none_from_dict(
+                    {
+                        **self._client_wrapper.get_headers(),
+                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
+                    }
+                )
+            ),
+            timeout=request_options.get("timeout_in_seconds")
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
+            else self._client_wrapper.get_timeout(),
+            retries=0,
+            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic_v1.parse_obj_as(SemanticQueryOut, _response.json())  # type: ignore
+        if _response.status_code == 422:
+            raise UnprocessableEntityError(
+                pydantic_v1.parse_obj_as(HttpValidationError, _response.json())  # type: ignore
+            )
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
 
 class AsyncToolsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -774,3 +859,86 @@ class AsyncToolsClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def semantic_query(
+        self,
+        *,
+        query: QueryModel,
+        table_name: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SemanticQueryOut:
+        """
+        Parameters:
+            - query: QueryModel.
+
+            - table_name: typing.Optional[str].
+
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
+        ---
+        from athena import FilterModel, FilterOperator, QueryModel, TimeDimensionModel
+        from athena.client import AsyncAthena
+
+        client = AsyncAthena(
+            api_key="YOUR_API_KEY",
+        )
+        await client.tools.semantic_query(
+            query=QueryModel(
+                measures=["count"],
+                time_dimensions=[
+                    TimeDimensionModel(
+                        dimension="dimension",
+                        granularity="granularity",
+                        date_range=["dateRange"],
+                    )
+                ],
+                dimensions=["manufacturer"],
+                filters=[
+                    FilterModel(
+                        dimension="manufacturer",
+                        operator=FilterOperator.EQUALS,
+                        values=["Athena"],
+                    )
+                ],
+            ),
+        )
+        """
+        _request: typing.Dict[str, typing.Any] = {"query": query}
+        if table_name is not OMIT:
+            _request["table_name"] = table_name
+        _response = await self._client_wrapper.httpx_client.request(
+            method="POST",
+            url=urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", "api/v0/tools/strict-semantic-query"),
+            params=jsonable_encoder(
+                request_options.get("additional_query_parameters") if request_options is not None else None
+            ),
+            json=jsonable_encoder(_request)
+            if request_options is None or request_options.get("additional_body_parameters") is None
+            else {
+                **jsonable_encoder(_request),
+                **(jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_parameters", {})))),
+            },
+            headers=jsonable_encoder(
+                remove_none_from_dict(
+                    {
+                        **self._client_wrapper.get_headers(),
+                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
+                    }
+                )
+            ),
+            timeout=request_options.get("timeout_in_seconds")
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
+            else self._client_wrapper.get_timeout(),
+            retries=0,
+            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic_v1.parse_obj_as(SemanticQueryOut, _response.json())  # type: ignore
+        if _response.status_code == 422:
+            raise UnprocessableEntityError(
+                pydantic_v1.parse_obj_as(HttpValidationError, _response.json())  # type: ignore
+            )
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)

{athena_intelligence-0.1.72 → athena_intelligence-0.1.74}/src/athena/types/__init__.py

@@ -5,6 +5,8 @@ from .dataset import Dataset
 from .document import Document
 from .excecute_tool_first_workflow_out import ExcecuteToolFirstWorkflowOut
 from .file_data_response import FileDataResponse
+from .filter_model import FilterModel
+from .filter_operator import FilterOperator
 from .firecrawl_scrape_url_data_reponse_dto import FirecrawlScrapeUrlDataReponseDto
 from .firecrawl_scrape_url_metadata import FirecrawlScrapeUrlMetadata
 from .get_datasets_response import GetDatasetsResponse
@@ -18,12 +20,15 @@ from .message_out import MessageOut
 from .message_out_dto import MessageOutDto
 from .model import Model
 from .publish_formats import PublishFormats
+from .query_model import QueryModel
 from .report import Report
 from .researcher_out import ResearcherOut
+from .semantic_query_out import SemanticQueryOut
 from .snippet import Snippet
 from .sql_results import SqlResults
 from .status_enum import StatusEnum
 from .structured_parse_result import StructuredParseResult
+from .time_dimension_model import TimeDimensionModel
 from .tools import Tools
 from .upload_documents_out import UploadDocumentsOut
 from .url_result import UrlResult
@@ -37,6 +42,8 @@ __all__ = [
     "Document",
     "ExcecuteToolFirstWorkflowOut",
     "FileDataResponse",
+    "FilterModel",
+    "FilterOperator",
     "FirecrawlScrapeUrlDataReponseDto",
     "FirecrawlScrapeUrlMetadata",
     "GetDatasetsResponse",
@@ -50,12 +57,15 @@ __all__ = [
     "MessageOutDto",
     "Model",
     "PublishFormats",
+    "QueryModel",
     "Report",
     "ResearcherOut",
+    "SemanticQueryOut",
     "Snippet",
     "SqlResults",
     "StatusEnum",
     "StructuredParseResult",
+    "TimeDimensionModel",
     "Tools",
     "UploadDocumentsOut",
     "UrlResult",

athena_intelligence-0.1.74/src/athena/types/filter_model.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+from .filter_operator import FilterOperator
+
+
+class FilterModel(pydantic_v1.BaseModel):
+    dimension: str
+    operator: FilterOperator
+    values: typing.List[str]
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

athena_intelligence-0.1.74/src/athena/types/filter_operator.py

@@ -0,0 +1,73 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class FilterOperator(str, enum.Enum):
+    """
+    An enumeration.
+    """
+
+    EQUALS = "equals"
+    NOT_EQUALS = "notEquals"
+    CONTAINS = "contains"
+    NOT_CONTAINS = "notContains"
+    STARTS_WITH = "startsWith"
+    ENDS_WITH = "endsWith"
+    GT = "gt"
+    GTE = "gte"
+    LT = "lt"
+    LTE = "lte"
+    SET = "set"
+    NOT_SET = "notSet"
+    IN = "in"
+    NOT_IN = "notIn"
+
+    def visit(
+        self,
+        equals: typing.Callable[[], T_Result],
+        not_equals: typing.Callable[[], T_Result],
+        contains: typing.Callable[[], T_Result],
+        not_contains: typing.Callable[[], T_Result],
+        starts_with: typing.Callable[[], T_Result],
+        ends_with: typing.Callable[[], T_Result],
+        gt: typing.Callable[[], T_Result],
+        gte: typing.Callable[[], T_Result],
+        lt: typing.Callable[[], T_Result],
+        lte: typing.Callable[[], T_Result],
+        set_: typing.Callable[[], T_Result],
+        not_set: typing.Callable[[], T_Result],
+        in_: typing.Callable[[], T_Result],
+        not_in: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is FilterOperator.EQUALS:
+            return equals()
+        if self is FilterOperator.NOT_EQUALS:
+            return not_equals()
+        if self is FilterOperator.CONTAINS:
+            return contains()
+        if self is FilterOperator.NOT_CONTAINS:
+            return not_contains()
+        if self is FilterOperator.STARTS_WITH:
+            return starts_with()
+        if self is FilterOperator.ENDS_WITH:
+            return ends_with()
+        if self is FilterOperator.GT:
+            return gt()
+        if self is FilterOperator.GTE:
+            return gte()
+        if self is FilterOperator.LT:
+            return lt()
+        if self is FilterOperator.LTE:
+            return lte()
+        if self is FilterOperator.SET:
+            return set_()
+        if self is FilterOperator.NOT_SET:
+            return not_set()
+        if self is FilterOperator.IN:
+            return in_()
+        if self is FilterOperator.NOT_IN:
+            return not_in()

athena_intelligence-0.1.74/src/athena/types/query_model.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+from .filter_model import FilterModel
+from .time_dimension_model import TimeDimensionModel
+
+
+class QueryModel(pydantic_v1.BaseModel):
+    measures: typing.Optional[typing.List[str]] = None
+    time_dimensions: typing.Optional[typing.List[TimeDimensionModel]] = pydantic_v1.Field(
+        alias="timeDimensions", default=None
+    )
+    dimensions: typing.Optional[typing.List[str]] = None
+    filters: typing.Optional[typing.List[FilterModel]] = None
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

athena_intelligence-0.1.74/src/athena/types/semantic_query_out.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+
+
+class SemanticQueryOut(pydantic_v1.BaseModel):
+    output: typing.Dict[str, typing.Any]
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

athena_intelligence-0.1.74/src/athena/types/time_dimension_model.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+
+
+class TimeDimensionModel(pydantic_v1.BaseModel):
+    dimension: str
+    granularity: str
+    date_range: typing.List[str] = pydantic_v1.Field(alias="dateRange")
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}