athena-intelligence 0.1.81__py3-none-any.whl → 0.1.83__py3-none-any.whl

athena/__init__.py

@@ -7,6 +7,7 @@ from .types import (
     DataFrameRequestOutColumnsItem,
     DataFrameRequestOutDataItemItem,
     DataFrameRequestOutIndexItem,
+    DataFrameUnknownFormatError,
     Dataset,
     Document,
     ExcecuteToolFirstWorkflowOut,
@@ -43,7 +44,7 @@ from .types import (
     ValidationErrorLocItem,
     WorkflowStatusOut,
 )
-from .errors import InternalServerError, NotFoundError, UnprocessableEntityError
+from .errors import InternalServerError, NotFoundError, UnprocessableEntityError, UnsupportedMediaTypeError
 from . import chain, dataset, message, query, report, search, snippet, tools, upload, workflow
 from .environment import AthenaEnvironment
 from .tools import ToolsDataFrameRequestColumnsItem
@@ -57,6 +58,7 @@ __all__ = [
     "DataFrameRequestOutColumnsItem",
     "DataFrameRequestOutDataItemItem",
     "DataFrameRequestOutIndexItem",
+    "DataFrameUnknownFormatError",
     "Dataset",
     "Document",
     "ExcecuteToolFirstWorkflowOut",
@@ -91,6 +93,7 @@ __all__ = [
     "Tools",
     "ToolsDataFrameRequestColumnsItem",
     "UnprocessableEntityError",
+    "UnsupportedMediaTypeError",
     "UploadDocumentsOut",
     "UrlResult",
     "ValidationError",

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/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
 
@@ -51,7 +62,7 @@ class ChainClient:
         )
         client.chain.structured_parse(
             text_input='Athena is an AI-native analytics platform and artificial employee built to accelerate analytics workflows\n                by offering enterprise teams co-pilot and auto-pilot modes. Athena learns your workflow as a co-pilot,\n                allowing you to hand over controls to her for autonomous execution with confidence."\n\n                Give me all of the modes Athena provides.',
-            custom_type_dict={"modes": {}},
+            custom_type_dict={},
             model=LlmModel.GPT_4_TURBO,
         )
         """
@@ -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
 
@@ -127,6 +147,7 @@ class ChainClient:
             documents=[
                 Document(
                     page_content="Athena is an AI-native analytics platform and artificial employee built to accelerate analytics workflows by offering enterprise teams co-pilot and auto-pilot modes. Athena learns your workflow as a co-pilot, allowing you to hand over controls to her for autonomous execution with confidence.",
+                    metadata={"key": "value"},
                 )
             ],
             model=LlmModel.MISTRAL_LARGE_0224,
@@ -203,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
 
@@ -220,7 +252,7 @@ class AsyncChainClient:
         )
         await client.chain.structured_parse(
             text_input='Athena is an AI-native analytics platform and artificial employee built to accelerate analytics workflows\n                by offering enterprise teams co-pilot and auto-pilot modes. Athena learns your workflow as a co-pilot,\n                allowing you to hand over controls to her for autonomous execution with confidence."\n\n                Give me all of the modes Athena provides.',
-            custom_type_dict={"modes": {}},
+            custom_type_dict={},
             model=LlmModel.GPT_4_TURBO,
         )
         """
@@ -273,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
 
@@ -296,6 +337,7 @@ class AsyncChainClient:
             documents=[
                 Document(
                     page_content="Athena is an AI-native analytics platform and artificial employee built to accelerate analytics workflows by offering enterprise teams co-pilot and auto-pilot modes. Athena learns your workflow as a co-pilot, allowing you to hand over controls to her for autonomous execution with confidence.",
+                    metadata={"key": "value"},
                 )
             ],
             model=LlmModel.MISTRAL_LARGE_0224,

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

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/errors/__init__.py

@@ -3,5 +3,6 @@
 from .internal_server_error import InternalServerError
 from .not_found_error import NotFoundError
 from .unprocessable_entity_error import UnprocessableEntityError
+from .unsupported_media_type_error import UnsupportedMediaTypeError
 
-__all__ = ["InternalServerError", "NotFoundError", "UnprocessableEntityError"]
+__all__ = ["InternalServerError", "NotFoundError", "UnprocessableEntityError", "UnsupportedMediaTypeError"]

athena/errors/unsupported_media_type_error.py

@@ -0,0 +1,9 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.api_error import ApiError
+from ..types.data_frame_unknown_format_error import DataFrameUnknownFormatError
+
+
+class UnsupportedMediaTypeError(ApiError):
+    def __init__(self, body: DataFrameUnknownFormatError):
+        super().__init__(status_code=415, body=body)

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/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/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(