athena-intelligence 0.1.82__tar.gz → 0.1.83__tar.gz

{athena_intelligence-0.1.82 → athena_intelligence-0.1.83}/PKG-INFO

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

{athena_intelligence-0.1.82 → athena_intelligence-0.1.83}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "athena-intelligence"
-version = "0.1.82"
+version = "0.1.83"
 description = ""
 readme = "README.md"
 authors = []
@@ -20,6 +20,8 @@ mypy = "1.9.0"
 pytest = "^7.4.0"
 pytest-asyncio = "^0.23.5"
 python-dateutil = "^2.9.0"
+pandas = ">= 1.5.3"
+pandas-stubs = ">= 1.5.3"
 
 [tool.pytest.ini_options]
 testpaths = [ "tests" ]

{athena_intelligence-0.1.82 → athena_intelligence-0.1.83}/src/athena/base_client.py

@@ -22,21 +22,32 @@ class BaseAthena:
     """
     Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propogate to these functions.
 
-    Parameters:
-        - base_url: typing.Optional[str]. The base url to use for requests from the client.
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
 
-        - environment: AthenaEnvironment. The environment to use for requests from the client. from .environment import AthenaEnvironment
+    environment : AthenaEnvironment
+        The environment to use for requests from the client. from .environment import AthenaEnvironment
 
-                                          Defaults to AthenaEnvironment.DEFAULT
 
-        - api_key: str.
 
-        - timeout: typing.Optional[float]. The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
+        Defaults to AthenaEnvironment.DEFAULT
 
-        - follow_redirects: typing.Optional[bool]. Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
 
-        - httpx_client: typing.Optional[httpx.Client]. The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
-    ---
+
+    api_key : str
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.Client]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    Examples
+    --------
     from athena.client import Athena
 
     client = Athena(
@@ -81,21 +92,32 @@ class AsyncBaseAthena:
     """
     Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propogate to these functions.
 
-    Parameters:
-        - base_url: typing.Optional[str]. The base url to use for requests from the client.
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : AthenaEnvironment
+        The environment to use for requests from the client. from .environment import AthenaEnvironment
+
+
+
+        Defaults to AthenaEnvironment.DEFAULT
 
-        - environment: AthenaEnvironment. The environment to use for requests from the client. from .environment import AthenaEnvironment
 
-                                          Defaults to AthenaEnvironment.DEFAULT
 
-        - api_key: str.
+    api_key : str
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
 
-        - timeout: typing.Optional[float]. The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
 
-        - follow_redirects: typing.Optional[bool]. Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+    httpx_client : typing.Optional[httpx.AsyncClient]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
 
-        - httpx_client: typing.Optional[httpx.AsyncClient]. The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
-    ---
+    Examples
+    --------
     from athena.client import AsyncAthena
 
     client = AsyncAthena(

{athena_intelligence-0.1.82 → athena_intelligence-0.1.83}/src/athena/chain/client.py

@@ -34,15 +34,26 @@ class ChainClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> StructuredParseResult:
         """
-        Parameters:
-            - text_input: str. The text input to be parsed.
+        Parameters
+        ----------
+        text_input : str
+            The text input to be parsed.
 
-            - custom_type_dict: typing.Dict[str, typing.Any]. A dictionary of field names and their default values.
+        custom_type_dict : typing.Dict[str, typing.Any]
+            A dictionary of field names and their default values.
 
-            - model: LlmModel.
+        model : LlmModel
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        StructuredParseResult
+            Successful Response
+
+        Examples
+        --------
         from athena import LlmModel
         from athena.client import Athena
 
@@ -104,19 +115,28 @@ class ChainClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> MapReduceChainOut:
         """
-        Parameters:
-            - documents: typing.Sequence[Document].
+        Parameters
+        ----------
+        documents : typing.Sequence[Document]
+
+        model : LlmModel
+
+        operator_prompt : str
 
-            - model: LlmModel.
+        reducer_prompt : str
 
-            - operator_prompt: str.
+        input : str
 
-            - reducer_prompt: str.
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - input: str.
+        Returns
+        -------
+        MapReduceChainOut
+            Successful Response
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Examples
+        --------
         from athena import Document, LlmModel
         from athena.client import Athena
 
@@ -204,15 +224,26 @@ class AsyncChainClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> StructuredParseResult:
         """
-        Parameters:
-            - text_input: str. The text input to be parsed.
+        Parameters
+        ----------
+        text_input : str
+            The text input to be parsed.
 
-            - custom_type_dict: typing.Dict[str, typing.Any]. A dictionary of field names and their default values.
+        custom_type_dict : typing.Dict[str, typing.Any]
+            A dictionary of field names and their default values.
 
-            - model: LlmModel.
+        model : LlmModel
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        StructuredParseResult
+            Successful Response
+
+        Examples
+        --------
         from athena import LlmModel
         from athena.client import AsyncAthena
 
@@ -274,19 +305,28 @@ class AsyncChainClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> MapReduceChainOut:
         """
-        Parameters:
-            - documents: typing.Sequence[Document].
+        Parameters
+        ----------
+        documents : typing.Sequence[Document]
+
+        model : LlmModel
+
+        operator_prompt : str
 
-            - model: LlmModel.
+        reducer_prompt : str
 
-            - operator_prompt: str.
+        input : str
 
-            - reducer_prompt: str.
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - input: str.
+        Returns
+        -------
+        MapReduceChainOut
+            Successful Response
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Examples
+        --------
         from athena import Document, LlmModel
         from athena.client import AsyncAthena
 

{athena_intelligence-0.1.82 → athena_intelligence-0.1.83}/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.82",
+            "X-Fern-SDK-Version": "0.1.83",
         }
         headers["X-API-KEY"] = self.api_key
         return headers

{athena_intelligence-0.1.82 → athena_intelligence-0.1.83}/src/athena/dataset/client.py

@@ -27,13 +27,24 @@ class DatasetClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GetDatasetsResponse:
         """
-        Parameters:
-            - page: typing.Optional[int]. Page number starting from 1
+        Parameters
+        ----------
+        page : typing.Optional[int]
+            Page number starting from 1
 
-            - page_size: typing.Optional[int]. Number of items per page
+        page_size : typing.Optional[int]
+            Number of items per page
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetDatasetsResponse
+            Successful Response
+
+        Examples
+        --------
         from athena.client import Athena
 
         client = Athena(
@@ -96,13 +107,24 @@ class AsyncDatasetClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GetDatasetsResponse:
         """
-        Parameters:
-            - page: typing.Optional[int]. Page number starting from 1
+        Parameters
+        ----------
+        page : typing.Optional[int]
+            Page number starting from 1
+
+        page_size : typing.Optional[int]
+            Number of items per page
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - page_size: typing.Optional[int]. Number of items per page
+        Returns
+        -------
+        GetDatasetsResponse
+            Successful Response
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Examples
+        --------
         from athena.client import AsyncAthena
 
         client = AsyncAthena(

{athena_intelligence-0.1.82 → athena_intelligence-0.1.83}/src/athena/message/client.py

@@ -36,19 +36,28 @@ class MessageClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> MessageOut:
         """
-        Parameters:
-            - content: str.
+        Parameters
+        ----------
+        content : str
 
-            - model: typing.Optional[Model].
+        model : typing.Optional[Model]
 
-            - tools: typing.Optional[typing.Sequence[Tools]].
+        tools : typing.Optional[typing.Sequence[Tools]]
 
-            - conversation_id: typing.Optional[str].
+        conversation_id : typing.Optional[str]
 
-            - conversation_name: typing.Optional[str].
+        conversation_name : typing.Optional[str]
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        MessageOut
+            Successful Response
+
+        Examples
+        --------
         from athena import Model, Tools
         from athena.client import Athena
 
@@ -110,11 +119,20 @@ class MessageClient:
 
     def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> MessageOutDto:
         """
-        Parameters:
-            - id: str.
+        Parameters
+        ----------
+        id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        MessageOutDto
+            Successful Response
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Examples
+        --------
         from athena.client import Athena
 
         client = Athena(
@@ -174,19 +192,28 @@ class AsyncMessageClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> MessageOut:
         """
-        Parameters:
-            - content: str.
+        Parameters
+        ----------
+        content : str
 
-            - model: typing.Optional[Model].
+        model : typing.Optional[Model]
 
-            - tools: typing.Optional[typing.Sequence[Tools]].
+        tools : typing.Optional[typing.Sequence[Tools]]
 
-            - conversation_id: typing.Optional[str].
+        conversation_id : typing.Optional[str]
 
-            - conversation_name: typing.Optional[str].
+        conversation_name : typing.Optional[str]
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        MessageOut
+            Successful Response
+
+        Examples
+        --------
         from athena import Model, Tools
         from athena.client import AsyncAthena
 
@@ -248,11 +275,20 @@ class AsyncMessageClient:
 
     async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> MessageOutDto:
         """
-        Parameters:
-            - id: str.
+        Parameters
+        ----------
+        id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        MessageOutDto
+            Successful Response
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Examples
+        --------
         from athena.client import AsyncAthena
 
         client = AsyncAthena(

{athena_intelligence-0.1.82 → athena_intelligence-0.1.83}/src/athena/query/client.py

@@ -26,13 +26,22 @@ class QueryClient:
         self, *, sql_command: str, database_id: int, request_options: typing.Optional[RequestOptions] = None
     ) -> SqlResults:
         """
-        Parameters:
-            - sql_command: str.
+        Parameters
+        ----------
+        sql_command : str
 
-            - database_id: int.
+        database_id : int
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SqlResults
+            Successful Response
+
+        Examples
+        --------
         from athena.client import Athena
 
         client = Athena(
@@ -90,13 +99,22 @@ class AsyncQueryClient:
         self, *, sql_command: str, database_id: int, request_options: typing.Optional[RequestOptions] = None
     ) -> SqlResults:
         """
-        Parameters:
-            - sql_command: str.
+        Parameters
+        ----------
+        sql_command : str
+
+        database_id : int
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - database_id: int.
+        Returns
+        -------
+        SqlResults
+            Successful Response
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Examples
+        --------
         from athena.client import AsyncAthena
 
         client = AsyncAthena(

{athena_intelligence-0.1.82 → athena_intelligence-0.1.83}/src/athena/report/client.py

@@ -30,13 +30,22 @@ class ReportClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Report:
         """
-        Parameters:
-            - name: typing.Optional[str].
+        Parameters
+        ----------
+        name : typing.Optional[str]
 
-            - workspace_access: typing.Optional[bool].
+        workspace_access : typing.Optional[bool]
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Report
+            Successful Response
+
+        Examples
+        --------
         from athena.client import Athena
 
         client = Athena(
@@ -100,13 +109,22 @@ class AsyncReportClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Report:
         """
-        Parameters:
-            - name: typing.Optional[str].
+        Parameters
+        ----------
+        name : typing.Optional[str]
+
+        workspace_access : typing.Optional[bool]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - workspace_access: typing.Optional[bool].
+        Returns
+        -------
+        Report
+            Successful Response
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Examples
+        --------
         from athena.client import AsyncAthena
 
         client = AsyncAthena(

{athena_intelligence-0.1.82 → athena_intelligence-0.1.83}/src/athena/search/client.py

@@ -34,21 +34,30 @@ class SearchClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> UrlResult:
         """
-        Parameters:
-            - query: str.
+        Parameters
+        ----------
+        query : str
 
-            - num_urls: int.
+        num_urls : int
 
-            - tbs: str.
+        tbs : str
 
-            - country_code: typing.Optional[str].
+        country_code : typing.Optional[str]
 
-            - country_restrict: typing.Optional[str].
+        country_restrict : typing.Optional[str]
 
-            - site: typing.Optional[str].
+        site : typing.Optional[str]
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UrlResult
+            Successful Response
+
+        Examples
+        --------
         from athena.client import Athena
 
         client = Athena(
@@ -122,21 +131,30 @@ class AsyncSearchClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> UrlResult:
         """
-        Parameters:
-            - query: str.
+        Parameters
+        ----------
+        query : str
+
+        num_urls : int
+
+        tbs : str
 
-            - num_urls: int.
+        country_code : typing.Optional[str]
 
-            - tbs: str.
+        country_restrict : typing.Optional[str]
 
-            - country_code: typing.Optional[str].
+        site : typing.Optional[str]
 
-            - country_restrict: typing.Optional[str].
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - site: typing.Optional[str].
+        Returns
+        -------
+        UrlResult
+            Successful Response
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Examples
+        --------
         from athena.client import AsyncAthena
 
         client = AsyncAthena(