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

athena/tools/email/client.py

@@ -1,19 +1,19 @@
 # This file was auto-generated by Fern from our API Definition.
 
+from ...core.client_wrapper import SyncClientWrapper
 import typing
+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, SyncClientWrapper
-from ...core.pydantic_utilities import pydantic_v1
-from ...core.request_options import RequestOptions
+from ...core.client_wrapper import AsyncClientWrapper
 
 
 class EmailClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    def create_draft(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+    def create_draft(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Optional[typing.Any]:
         """
         Coming soon! Create email drafts with specified content and recipients.
 
@@ -24,12 +24,12 @@ class EmailClient:
 
         Returns
         -------
-        typing.Any
+        typing.Optional[typing.Any]
             Successful Response
 
         Examples
         --------
-        from athena.client import Athena
+        from athena import Athena
 
         client = Athena(
             api_key="YOUR_API_KEY",
@@ -37,17 +37,25 @@ class EmailClient:
         client.tools.email.create_draft()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/v0/tools/email/draft", method="POST", request_options=request_options
+            "api/v0/tools/email/draft",
+            method="POST",
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(typing.Any, _response.json())  # type: ignore
         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)
 
-    def search(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+    def search(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Optional[typing.Any]:
         """
         Coming soon! Search through emails with configurable filters.
 
@@ -58,12 +66,12 @@ class EmailClient:
 
         Returns
         -------
-        typing.Any
+        typing.Optional[typing.Any]
             Successful Response
 
         Examples
         --------
-        from athena.client import Athena
+        from athena import Athena
 
         client = Athena(
             api_key="YOUR_API_KEY",
@@ -71,17 +79,25 @@ class EmailClient:
         client.tools.email.search()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/v0/tools/email/search", method="GET", request_options=request_options
+            "api/v0/tools/email/search",
+            method="GET",
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(typing.Any, _response.json())  # type: ignore
         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)
 
-    def send(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+    def send(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Optional[typing.Any]:
         """
         Coming soon! Send emails to specified recipients.
 
@@ -92,12 +108,12 @@ class EmailClient:
 
         Returns
         -------
-        typing.Any
+        typing.Optional[typing.Any]
             Successful Response
 
         Examples
         --------
-        from athena.client import Athena
+        from athena import Athena
 
         client = Athena(
             api_key="YOUR_API_KEY",
@@ -105,11 +121,19 @@ class EmailClient:
         client.tools.email.send()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/v0/tools/email/send", method="POST", request_options=request_options
+            "api/v0/tools/email/send",
+            method="POST",
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(typing.Any, _response.json())  # type: ignore
         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)
@@ -120,7 +144,9 @@ class AsyncEmailClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    async def create_draft(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+    async def create_draft(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.Optional[typing.Any]:
         """
         Coming soon! Create email drafts with specified content and recipients.
 
@@ -131,30 +157,46 @@ class AsyncEmailClient:
 
         Returns
         -------
-        typing.Any
+        typing.Optional[typing.Any]
             Successful Response
 
         Examples
         --------
-        from athena.client import AsyncAthena
+        import asyncio
+
+        from athena import AsyncAthena
 
         client = AsyncAthena(
             api_key="YOUR_API_KEY",
         )
-        await client.tools.email.create_draft()
+
+
+        async def main() -> None:
+            await client.tools.email.create_draft()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/v0/tools/email/draft", method="POST", request_options=request_options
+            "api/v0/tools/email/draft",
+            method="POST",
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(typing.Any, _response.json())  # type: ignore
         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)
 
-    async def search(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+    async def search(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Optional[typing.Any]:
         """
         Coming soon! Search through emails with configurable filters.
 
@@ -165,30 +207,46 @@ class AsyncEmailClient:
 
         Returns
         -------
-        typing.Any
+        typing.Optional[typing.Any]
             Successful Response
 
         Examples
         --------
-        from athena.client import AsyncAthena
+        import asyncio
+
+        from athena import AsyncAthena
 
         client = AsyncAthena(
             api_key="YOUR_API_KEY",
         )
-        await client.tools.email.search()
+
+
+        async def main() -> None:
+            await client.tools.email.search()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/v0/tools/email/search", method="GET", request_options=request_options
+            "api/v0/tools/email/search",
+            method="GET",
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(typing.Any, _response.json())  # type: ignore
         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)
 
-    async def send(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+    async def send(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Optional[typing.Any]:
         """
         Coming soon! Send emails to specified recipients.
 
@@ -199,24 +257,40 @@ class AsyncEmailClient:
 
         Returns
         -------
-        typing.Any
+        typing.Optional[typing.Any]
             Successful Response
 
         Examples
         --------
-        from athena.client import AsyncAthena
+        import asyncio
+
+        from athena import AsyncAthena
 
         client = AsyncAthena(
             api_key="YOUR_API_KEY",
         )
-        await client.tools.email.send()
+
+
+        async def main() -> None:
+            await client.tools.email.send()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/v0/tools/email/send", method="POST", request_options=request_options
+            "api/v0/tools/email/send",
+            method="POST",
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(typing.Any, _response.json())  # type: ignore
         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)

athena/tools/structured_data_extractor/client.py

@@ -1,16 +1,17 @@
 # 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.pydantic_utilities import pydantic_v1
-from ...core.request_options import RequestOptions
-from ...errors.unprocessable_entity_error import UnprocessableEntityError
+from ...core.client_wrapper import SyncClientWrapper
 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
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -24,17 +25,16 @@ class StructuredDataExtractorClient:
         self,
         *,
         chunks: typing.Sequence[Chunk],
-        json_schema: typing.Dict[str, typing.Any],
+        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
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> 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
@@ -49,8 +49,8 @@ class StructuredDataExtractorClient:
 
         - 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).
+            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.
 
@@ -59,7 +59,7 @@ class StructuredDataExtractorClient:
         chunks : typing.Sequence[Chunk]
             The chunks from which to extract structured data.
 
-        json_schema : typing.Dict[str, typing.Any]
+        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]]
@@ -81,8 +81,7 @@ class StructuredDataExtractorClient:
 
         Examples
         --------
-        from athena import Chunk, ChunkContentItem_Text
-        from athena.client import Athena
+        from athena import Athena, Chunk, ChunkContentItem_Text
 
         client = Athena(
             api_key="YOUR_API_KEY",
@@ -123,20 +122,43 @@ class StructuredDataExtractorClient:
             "api/v0/tools/structured-data-extractor/invoke",
             method="POST",
             json={
-                "chunk_messages": chunk_messages,
-                "chunks": chunks,
+                "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": reduce_messages,
+                "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,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(StructuredDataExtractorResponse, _response.json())  # type: ignore
-        if _response.status_code == 422:
-            raise UnprocessableEntityError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
         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)
@@ -151,17 +173,16 @@ class AsyncStructuredDataExtractorClient:
         self,
         *,
         chunks: typing.Sequence[Chunk],
-        json_schema: typing.Dict[str, typing.Any],
+        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
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> 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
@@ -176,8 +197,8 @@ class AsyncStructuredDataExtractorClient:
 
         - 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).
+            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.
 
@@ -186,7 +207,7 @@ class AsyncStructuredDataExtractorClient:
         chunks : typing.Sequence[Chunk]
             The chunks from which to extract structured data.
 
-        json_schema : typing.Dict[str, typing.Any]
+        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]]
@@ -208,62 +229,92 @@ class AsyncStructuredDataExtractorClient:
 
         Examples
         --------
-        from athena import Chunk, ChunkContentItem_Text
-        from athena.client import AsyncAthena
+        import asyncio
+
+        from athena import AsyncAthena, Chunk, ChunkContentItem_Text
 
         client = AsyncAthena(
             api_key="YOUR_API_KEY",
         )
-        await client.tools.structured_data_extractor.invoke(
-            chunks=[
-                Chunk(
-                    chunk_id="1",
-                    content=[
-                        ChunkContentItem_Text(
-                            text="John Smith is a 35 year old developer. You can reach him at john.smith@example.com",
-                        )
-                    ],
-                ),
-                Chunk(
-                    chunk_id="2",
-                    content=[
-                        ChunkContentItem_Text(
-                            text="Jane Doe is a 25 year old developer. You can reach her at jane@example.com",
-                        )
-                    ],
-                ),
-            ],
-            json_schema={
-                "description": "A person",
-                "properties": {
-                    "age": {"type": "integer"},
-                    "email": {"type": "string"},
-                    "name": {"type": "string"},
+
+
+        async def main() -> None:
+            await client.tools.structured_data_extractor.invoke(
+                chunks=[
+                    Chunk(
+                        chunk_id="1",
+                        content=[
+                            ChunkContentItem_Text(
+                                text="John Smith is a 35 year old developer. You can reach him at john.smith@example.com",
+                            )
+                        ],
+                    ),
+                    Chunk(
+                        chunk_id="2",
+                        content=[
+                            ChunkContentItem_Text(
+                                text="Jane Doe is a 25 year old developer. You can reach her at jane@example.com",
+                            )
+                        ],
+                    ),
+                ],
+                json_schema={
+                    "description": "A person",
+                    "properties": {
+                        "age": {"type": "integer"},
+                        "email": {"type": "string"},
+                        "name": {"type": "string"},
+                    },
+                    "required": ["name"],
+                    "title": "Person",
+                    "type": "object",
                 },
-                "required": ["name"],
-                "title": "Person",
-                "type": "object",
-            },
-        )
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/v0/tools/structured-data-extractor/invoke",
             method="POST",
             json={
-                "chunk_messages": chunk_messages,
-                "chunks": chunks,
+                "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": reduce_messages,
+                "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,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(StructuredDataExtractorResponse, _response.json())  # type: ignore
-        if _response.status_code == 422:
-            raise UnprocessableEntityError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
         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)