athena-intelligence 0.1.126__py3-none-any.whl → 0.1.184__py3-none-any.whl

athena/tools/structured_data_extractor/__init__.py

@@ -1,2 +1,4 @@
 # This file was auto-generated by Fern from our API Definition.
 
+# isort: skip_file
+

athena/tools/structured_data_extractor/client.py

@@ -1,17 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
-from ...core.client_wrapper import SyncClientWrapper
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
 from ...types.chunk import Chunk
 from ...types.prompt_message import PromptMessage
-from ...core.request_options import RequestOptions
 from ...types.structured_data_extractor_response import StructuredDataExtractorResponse
-from ...core.serialization import convert_and_respect_annotation_metadata
-from ...core.pydantic_utilities import parse_obj_as
-from ...errors.unprocessable_entity_error import UnprocessableEntityError
-from json.decoder import JSONDecodeError
-from ...core.api_error import ApiError
-from ...core.client_wrapper import AsyncClientWrapper
+from .raw_client import AsyncRawStructuredDataExtractorClient, RawStructuredDataExtractorClient
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -19,7 +15,18 @@ OMIT = typing.cast(typing.Any, ...)
 
 class StructuredDataExtractorClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
-        self._client_wrapper = client_wrapper
+        self._raw_client = RawStructuredDataExtractorClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawStructuredDataExtractorClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawStructuredDataExtractorClient
+        """
+        return self._raw_client
 
     def invoke(
         self,
@@ -118,56 +125,31 @@ class StructuredDataExtractorClient:
             },
         )
         """
-        _response = self._client_wrapper.httpx_client.request(
-            "api/v0/tools/structured-data-extractor/invoke",
-            method="POST",
-            json={
-                "chunk_messages": convert_and_respect_annotation_metadata(
-                    object_=chunk_messages, annotation=typing.Sequence[PromptMessage], direction="write"
-                ),
-                "chunks": convert_and_respect_annotation_metadata(
-                    object_=chunks, annotation=typing.Sequence[Chunk], direction="write"
-                ),
-                "json_schema": json_schema,
-                "reduce": reduce,
-                "reduce_messages": convert_and_respect_annotation_metadata(
-                    object_=reduce_messages, annotation=typing.Sequence[PromptMessage], direction="write"
-                ),
-            },
-            headers={
-                "content-type": "application/json",
-            },
+        _response = self._raw_client.invoke(
+            chunks=chunks,
+            json_schema=json_schema,
+            chunk_messages=chunk_messages,
+            reduce=reduce,
+            reduce_messages=reduce_messages,
             request_options=request_options,
-            omit=OMIT,
         )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    StructuredDataExtractorResponse,
-                    parse_obj_as(
-                        type_=StructuredDataExtractorResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 422:
-                raise UnprocessableEntityError(
-                    typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    )
-                )
-            _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)
+        return _response.data
 
 
 class AsyncStructuredDataExtractorClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._client_wrapper = client_wrapper
+        self._raw_client = AsyncRawStructuredDataExtractorClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawStructuredDataExtractorClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawStructuredDataExtractorClient
+        """
+        return self._raw_client
 
     async def invoke(
         self,
@@ -274,48 +256,12 @@ class AsyncStructuredDataExtractorClient:
 
         asyncio.run(main())
         """
-        _response = await self._client_wrapper.httpx_client.request(
-            "api/v0/tools/structured-data-extractor/invoke",
-            method="POST",
-            json={
-                "chunk_messages": convert_and_respect_annotation_metadata(
-                    object_=chunk_messages, annotation=typing.Sequence[PromptMessage], direction="write"
-                ),
-                "chunks": convert_and_respect_annotation_metadata(
-                    object_=chunks, annotation=typing.Sequence[Chunk], direction="write"
-                ),
-                "json_schema": json_schema,
-                "reduce": reduce,
-                "reduce_messages": convert_and_respect_annotation_metadata(
-                    object_=reduce_messages, annotation=typing.Sequence[PromptMessage], direction="write"
-                ),
-            },
-            headers={
-                "content-type": "application/json",
-            },
+        _response = await self._raw_client.invoke(
+            chunks=chunks,
+            json_schema=json_schema,
+            chunk_messages=chunk_messages,
+            reduce=reduce,
+            reduce_messages=reduce_messages,
             request_options=request_options,
-            omit=OMIT,
         )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    StructuredDataExtractorResponse,
-                    parse_obj_as(
-                        type_=StructuredDataExtractorResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 422:
-                raise UnprocessableEntityError(
-                    typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    )
-                )
-            _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)
+        return _response.data

athena/tools/structured_data_extractor/raw_client.py

@@ -0,0 +1,240 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.http_response import AsyncHttpResponse, HttpResponse
+from ...core.pydantic_utilities import parse_obj_as
+from ...core.request_options import RequestOptions
+from ...core.serialization import convert_and_respect_annotation_metadata
+from ...errors.unprocessable_entity_error import UnprocessableEntityError
+from ...types.chunk import Chunk
+from ...types.prompt_message import PromptMessage
+from ...types.structured_data_extractor_response import StructuredDataExtractorResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawStructuredDataExtractorClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def invoke(
+        self,
+        *,
+        chunks: typing.Sequence[Chunk],
+        json_schema: typing.Dict[str, typing.Optional[typing.Any]],
+        chunk_messages: typing.Optional[typing.Sequence[PromptMessage]] = OMIT,
+        reduce: typing.Optional[bool] = OMIT,
+        reduce_messages: typing.Optional[typing.Sequence[PromptMessage]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[StructuredDataExtractorResponse]:
+        """
+        Extract structured data.
+
+        tl;dr:
+        - pass a valid JSON schema in `json_schema`
+        - pass the page chunks as a list of `Chunk` objects, by default: `{"type": "text", "content": "..."}`
+        - leave all other fields as default
+
+        Detailed configuration (only relevant for complex use cases):
+
+        The structured data extractor's architecture follows the map-reduce pattern,
+        where the asset is divided into chunks, the schema is extracted from each chunk,
+        and the chunks are then reduced to a single structured data object.
+
+        In some applications, you may not want to:
+
+        - map (if your input asset is small enough)
+        - reduce (if your output object is large enough that it will overflow the output length;
+            if you're extracting a long list of entities; if youre )
+            to extract all instances of the schema).
+
+        You can configure these behaviors with the `map` and `reduce` fields.
+
+        Parameters
+        ----------
+        chunks : typing.Sequence[Chunk]
+            The chunks from which to extract structured data.
+
+        json_schema : typing.Dict[str, typing.Optional[typing.Any]]
+            The JSON schema to use for validation (version draft 2020-12). See the docs [here](https://json-schema.org/learn/getting-started-step-by-step).
+
+        chunk_messages : typing.Optional[typing.Sequence[PromptMessage]]
+            The prompt to use for the data extraction over *each individual chunk*. It must be a list of messages.  The chunk content will be appended as a list of human messages.
+
+        reduce : typing.Optional[bool]
+            If `map`, whether to reduce the chunks to a single structured object (true) or return the full list (false).  Use True unless you want to preserve duplicates from each page or expect the object to overflow the output context.
+
+        reduce_messages : typing.Optional[typing.Sequence[PromptMessage]]
+            The prompt to use for the reduce steps. It must be a list of messages. The two extraction attempts will be appended as a list of human messages.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[StructuredDataExtractorResponse]
+            Successful Response
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/v0/tools/structured-data-extractor/invoke",
+            method="POST",
+            json={
+                "chunk_messages": convert_and_respect_annotation_metadata(
+                    object_=chunk_messages, annotation=typing.Sequence[PromptMessage], direction="write"
+                ),
+                "chunks": convert_and_respect_annotation_metadata(
+                    object_=chunks, annotation=typing.Sequence[Chunk], direction="write"
+                ),
+                "json_schema": json_schema,
+                "reduce": reduce,
+                "reduce_messages": convert_and_respect_annotation_metadata(
+                    object_=reduce_messages, annotation=typing.Sequence[PromptMessage], direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    StructuredDataExtractorResponse,
+                    parse_obj_as(
+                        type_=StructuredDataExtractorResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawStructuredDataExtractorClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def invoke(
+        self,
+        *,
+        chunks: typing.Sequence[Chunk],
+        json_schema: typing.Dict[str, typing.Optional[typing.Any]],
+        chunk_messages: typing.Optional[typing.Sequence[PromptMessage]] = OMIT,
+        reduce: typing.Optional[bool] = OMIT,
+        reduce_messages: typing.Optional[typing.Sequence[PromptMessage]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[StructuredDataExtractorResponse]:
+        """
+        Extract structured data.
+
+        tl;dr:
+        - pass a valid JSON schema in `json_schema`
+        - pass the page chunks as a list of `Chunk` objects, by default: `{"type": "text", "content": "..."}`
+        - leave all other fields as default
+
+        Detailed configuration (only relevant for complex use cases):
+
+        The structured data extractor's architecture follows the map-reduce pattern,
+        where the asset is divided into chunks, the schema is extracted from each chunk,
+        and the chunks are then reduced to a single structured data object.
+
+        In some applications, you may not want to:
+
+        - map (if your input asset is small enough)
+        - reduce (if your output object is large enough that it will overflow the output length;
+            if you're extracting a long list of entities; if youre )
+            to extract all instances of the schema).
+
+        You can configure these behaviors with the `map` and `reduce` fields.
+
+        Parameters
+        ----------
+        chunks : typing.Sequence[Chunk]
+            The chunks from which to extract structured data.
+
+        json_schema : typing.Dict[str, typing.Optional[typing.Any]]
+            The JSON schema to use for validation (version draft 2020-12). See the docs [here](https://json-schema.org/learn/getting-started-step-by-step).
+
+        chunk_messages : typing.Optional[typing.Sequence[PromptMessage]]
+            The prompt to use for the data extraction over *each individual chunk*. It must be a list of messages.  The chunk content will be appended as a list of human messages.
+
+        reduce : typing.Optional[bool]
+            If `map`, whether to reduce the chunks to a single structured object (true) or return the full list (false).  Use True unless you want to preserve duplicates from each page or expect the object to overflow the output context.
+
+        reduce_messages : typing.Optional[typing.Sequence[PromptMessage]]
+            The prompt to use for the reduce steps. It must be a list of messages. The two extraction attempts will be appended as a list of human messages.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[StructuredDataExtractorResponse]
+            Successful Response
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/v0/tools/structured-data-extractor/invoke",
+            method="POST",
+            json={
+                "chunk_messages": convert_and_respect_annotation_metadata(
+                    object_=chunk_messages, annotation=typing.Sequence[PromptMessage], direction="write"
+                ),
+                "chunks": convert_and_respect_annotation_metadata(
+                    object_=chunks, annotation=typing.Sequence[Chunk], direction="write"
+                ),
+                "json_schema": json_schema,
+                "reduce": reduce,
+                "reduce_messages": convert_and_respect_annotation_metadata(
+                    object_=reduce_messages, annotation=typing.Sequence[PromptMessage], direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    StructuredDataExtractorResponse,
+                    parse_obj_as(
+                        type_=StructuredDataExtractorResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

athena/tools/tasks/__init__.py

@@ -1,2 +1,4 @@
 # This file was auto-generated by Fern from our API Definition.
 
+# isort: skip_file
+

athena/tools/tasks/client.py

@@ -1,17 +1,26 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ...core.client_wrapper import SyncClientWrapper
 import typing
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ...core.request_options import RequestOptions
-from ...core.pydantic_utilities import parse_obj_as
-from json.decoder import JSONDecodeError
-from ...core.api_error import ApiError
-from ...core.client_wrapper import AsyncClientWrapper
+from .raw_client import AsyncRawTasksClient, RawTasksClient
 
 
 class TasksClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
-        self._client_wrapper = client_wrapper
+        self._raw_client = RawTasksClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawTasksClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawTasksClient
+        """
+        return self._raw_client
 
     def run_task(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Optional[typing.Any]:
         """
@@ -36,29 +45,24 @@ class TasksClient:
         )
         client.tools.tasks.run_task()
         """
-        _response = self._client_wrapper.httpx_client.request(
-            "api/v0/tools/tasks/run",
-            method="POST",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    typing.Optional[typing.Any],
-                    parse_obj_as(
-                        type_=typing.Optional[typing.Any],  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            _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)
+        _response = self._raw_client.run_task(request_options=request_options)
+        return _response.data
 
 
 class AsyncTasksClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._client_wrapper = client_wrapper
+        self._raw_client = AsyncRawTasksClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawTasksClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawTasksClient
+        """
+        return self._raw_client
 
     async def run_task(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Optional[typing.Any]:
         """
@@ -91,21 +95,5 @@ class AsyncTasksClient:
 
         asyncio.run(main())
         """
-        _response = await self._client_wrapper.httpx_client.request(
-            "api/v0/tools/tasks/run",
-            method="POST",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    typing.Optional[typing.Any],
-                    parse_obj_as(
-                        type_=typing.Optional[typing.Any],  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            _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)
+        _response = await self._raw_client.run_task(request_options=request_options)
+        return _response.data

athena/tools/tasks/raw_client.py

@@ -0,0 +1,96 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.http_response import AsyncHttpResponse, HttpResponse
+from ...core.pydantic_utilities import parse_obj_as
+from ...core.request_options import RequestOptions
+
+
+class RawTasksClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def run_task(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[typing.Optional[typing.Any]]:
+        """
+        Coming soon! Run a [task](https://resources.athenaintel.com/docs/task-studio/home).
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[typing.Optional[typing.Any]]
+            Successful Response
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/v0/tools/tasks/run",
+            method="POST",
+            request_options=request_options,
+        )
+        try:
+            if _response is None or not _response.text.strip():
+                return HttpResponse(response=_response, data=None)
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.Optional[typing.Any],
+                    parse_obj_as(
+                        type_=typing.Optional[typing.Any],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawTasksClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def run_task(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[typing.Optional[typing.Any]]:
+        """
+        Coming soon! Run a [task](https://resources.athenaintel.com/docs/task-studio/home).
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[typing.Optional[typing.Any]]
+            Successful Response
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/v0/tools/tasks/run",
+            method="POST",
+            request_options=request_options,
+        )
+        try:
+            if _response is None or not _response.text.strip():
+                return AsyncHttpResponse(response=_response, data=None)
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.Optional[typing.Any],
+                    parse_obj_as(
+                        type_=typing.Optional[typing.Any],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

athena/tools/types/__init__.py

@@ -1,5 +1,7 @@
 # This file was auto-generated by Fern from our API Definition.
 
+# isort: skip_file
+
 from .tools_data_frame_request_columns_item import ToolsDataFrameRequestColumnsItem
 
 __all__ = ["ToolsDataFrameRequestColumnsItem"]