athena-intelligence 0.1.122__py3-none-any.whl → 0.1.123__py3-none-any.whl

athena/__init__.py

@@ -2,6 +2,12 @@
 
 from .types import (
     AssetNotFoundError,
+    Chunk,
+    ChunkContentItem,
+    ChunkContentItem_ImageUrl,
+    ChunkContentItem_Text,
+    ChunkResult,
+    ChunkResultChunkId,
     CustomAgentResponse,
     DataFrameRequestOut,
     DataFrameRequestOutColumnsItem,
@@ -16,12 +22,16 @@ from .types import (
     GeneralAgentConfigEnabledToolsItem,
     GeneralAgentRequest,
     GeneralAgentResponse,
+    ImageUrlContent,
     ParentFolderError,
+    PromptMessage,
     ResearchAgentResponse,
     SaveAssetRequestOut,
     SqlAgentResponse,
-    StructuredDataExtractorReponse,
+    StructuredDataExtractorResponse,
+    TextContent,
     Tool,
+    Type,
 )
 from .errors import (
     BadRequestError,
@@ -42,6 +52,12 @@ __all__ = [
     "AssetNotFoundError",
     "AthenaEnvironment",
     "BadRequestError",
+    "Chunk",
+    "ChunkContentItem",
+    "ChunkContentItem_ImageUrl",
+    "ChunkContentItem_Text",
+    "ChunkResult",
+    "ChunkResultChunkId",
     "ContentTooLargeError",
     "CustomAgentResponse",
     "DataFrameRequestOut",
@@ -57,16 +73,20 @@ __all__ = [
     "GeneralAgentConfigEnabledToolsItem",
     "GeneralAgentRequest",
     "GeneralAgentResponse",
+    "ImageUrlContent",
     "InternalServerError",
     "NotFoundError",
     "ParentFolderError",
+    "PromptMessage",
     "QueryExecuteRequestDatabaseAssetIds",
     "ResearchAgentResponse",
     "SaveAssetRequestOut",
     "SqlAgentResponse",
-    "StructuredDataExtractorReponse",
+    "StructuredDataExtractorResponse",
+    "TextContent",
     "Tool",
     "ToolsDataFrameRequestColumnsItem",
+    "Type",
     "UnauthorizedError",
     "UnprocessableEntityError",
     "UnsupportedMediaTypeError",

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

athena/tools/structured_data_extractor/client.py

@@ -8,7 +8,9 @@ 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 ...types.structured_data_extractor_reponse import StructuredDataExtractorReponse
+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, ...)
@@ -21,58 +23,114 @@ class StructuredDataExtractorClient:
     def invoke(
         self,
         *,
-        asset_ids: typing.Sequence[str],
+        chunks: typing.Sequence[Chunk],
         json_schema: typing.Dict[str, typing.Any],
-        map_: typing.Optional[bool] = OMIT,
+        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
-    ) -> StructuredDataExtractorReponse:
+    ) -> StructuredDataExtractorResponse:
         """
-        Coming soon! Extract structured data from assets of arbitrary length.
+        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
         ----------
-        asset_ids : typing.Sequence[str]
-            The IDs of the assets from which to extract structured data matching `json_schema`.
+        chunks : typing.Sequence[Chunk]
+            The chunks from which to extract structured data.
 
         json_schema : typing.Dict[str, 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).
+            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).
 
-        map_ : typing.Optional[bool]
-            Whether to split the asset into chunks and attempt to extract the schema from each chunk.  Set to false if you know the asset is small.
+        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
         -------
-        StructuredDataExtractorReponse
+        StructuredDataExtractorResponse
             Successful Response
 
         Examples
         --------
+        from athena import Chunk, ChunkContentItem_Text
         from athena.client import Athena
 
         client = Athena(
             api_key="YOUR_API_KEY",
         )
         client.tools.structured_data_extractor.invoke(
-            asset_ids=["asset_ids"],
-            json_schema={"key": "value"},
+            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",
+            },
         )
         """
         _response = self._client_wrapper.httpx_client.request(
             "api/v0/tools/structured-data-extractor/invoke",
             method="POST",
-            json={"asset_ids": asset_ids, "json_schema": json_schema, "map": map_, "reduce": reduce},
+            json={
+                "chunk_messages": chunk_messages,
+                "chunks": chunks,
+                "json_schema": json_schema,
+                "reduce": reduce,
+                "reduce_messages": reduce_messages,
+            },
             request_options=request_options,
             omit=OMIT,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(StructuredDataExtractorReponse, _response.json())  # type: ignore
+            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:
@@ -89,58 +147,114 @@ class AsyncStructuredDataExtractorClient:
     async def invoke(
         self,
         *,
-        asset_ids: typing.Sequence[str],
+        chunks: typing.Sequence[Chunk],
         json_schema: typing.Dict[str, typing.Any],
-        map_: typing.Optional[bool] = OMIT,
+        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
-    ) -> StructuredDataExtractorReponse:
+    ) -> StructuredDataExtractorResponse:
         """
-        Coming soon! Extract structured data from assets of arbitrary length.
+        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
         ----------
-        asset_ids : typing.Sequence[str]
-            The IDs of the assets from which to extract structured data matching `json_schema`.
+        chunks : typing.Sequence[Chunk]
+            The chunks from which to extract structured data.
 
         json_schema : typing.Dict[str, 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).
+            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).
 
-        map_ : typing.Optional[bool]
-            Whether to split the asset into chunks and attempt to extract the schema from each chunk.  Set to false if you know the asset is small.
+        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
         -------
-        StructuredDataExtractorReponse
+        StructuredDataExtractorResponse
             Successful Response
 
         Examples
         --------
+        from athena import Chunk, ChunkContentItem_Text
         from athena.client import AsyncAthena
 
         client = AsyncAthena(
             api_key="YOUR_API_KEY",
         )
         await client.tools.structured_data_extractor.invoke(
-            asset_ids=["asset_ids"],
-            json_schema={"key": "value"},
+            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",
+            },
         )
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/v0/tools/structured-data-extractor/invoke",
             method="POST",
-            json={"asset_ids": asset_ids, "json_schema": json_schema, "map": map_, "reduce": reduce},
+            json={
+                "chunk_messages": chunk_messages,
+                "chunks": chunks,
+                "json_schema": json_schema,
+                "reduce": reduce,
+                "reduce_messages": reduce_messages,
+            },
             request_options=request_options,
             omit=OMIT,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(StructuredDataExtractorReponse, _response.json())  # type: ignore
+            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:

athena/types/__init__.py

@@ -1,6 +1,10 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from .asset_not_found_error import AssetNotFoundError
+from .chunk import Chunk
+from .chunk_content_item import ChunkContentItem, ChunkContentItem_ImageUrl, ChunkContentItem_Text
+from .chunk_result import ChunkResult
+from .chunk_result_chunk_id import ChunkResultChunkId
 from .custom_agent_response import CustomAgentResponse
 from .data_frame_request_out import DataFrameRequestOut
 from .data_frame_request_out_columns_item import DataFrameRequestOutColumnsItem
@@ -15,15 +19,25 @@ from .general_agent_config import GeneralAgentConfig
 from .general_agent_config_enabled_tools_item import GeneralAgentConfigEnabledToolsItem
 from .general_agent_request import GeneralAgentRequest
 from .general_agent_response import GeneralAgentResponse
+from .image_url_content import ImageUrlContent
 from .parent_folder_error import ParentFolderError
+from .prompt_message import PromptMessage
 from .research_agent_response import ResearchAgentResponse
 from .save_asset_request_out import SaveAssetRequestOut
 from .sql_agent_response import SqlAgentResponse
-from .structured_data_extractor_reponse import StructuredDataExtractorReponse
+from .structured_data_extractor_response import StructuredDataExtractorResponse
+from .text_content import TextContent
 from .tool import Tool
+from .type import Type
 
 __all__ = [
     "AssetNotFoundError",
+    "Chunk",
+    "ChunkContentItem",
+    "ChunkContentItem_ImageUrl",
+    "ChunkContentItem_Text",
+    "ChunkResult",
+    "ChunkResultChunkId",
     "CustomAgentResponse",
     "DataFrameRequestOut",
     "DataFrameRequestOutColumnsItem",
@@ -38,10 +52,14 @@ __all__ = [
     "GeneralAgentConfigEnabledToolsItem",
     "GeneralAgentRequest",
     "GeneralAgentResponse",
+    "ImageUrlContent",
     "ParentFolderError",
+    "PromptMessage",
     "ResearchAgentResponse",
     "SaveAssetRequestOut",
     "SqlAgentResponse",
-    "StructuredDataExtractorReponse",
+    "StructuredDataExtractorResponse",
+    "TextContent",
     "Tool",
+    "Type",
 ]

athena/types/chunk.py

@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from .chunk_content_item import ChunkContentItem
+
+
+class Chunk(pydantic_v1.BaseModel):
+    """
+    A chunk of content to extract data from.
+    """
+
+    chunk_id: str
+    content: typing.List[ChunkContentItem]
+    metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

athena/types/chunk_content_item.py

@@ -0,0 +1,58 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+
+
+class ChunkContentItem_Text(pydantic_v1.BaseModel):
+    text: str
+    type: typing.Literal["text"] = "text"
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}
+
+
+class ChunkContentItem_ImageUrl(pydantic_v1.BaseModel):
+    image_url: typing.Dict[str, str]
+    type: typing.Literal["image_url"] = "image_url"
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}
+
+
+ChunkContentItem = typing.Union[ChunkContentItem_Text, ChunkContentItem_ImageUrl]

athena/types/chunk_result.py

@@ -0,0 +1,35 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from .chunk_result_chunk_id import ChunkResultChunkId
+
+
+class ChunkResult(pydantic_v1.BaseModel):
+    """
+    The result of a chunk extraction.
+    """
+
+    chunk_id: ChunkResultChunkId
+    chunk_result: typing.Optional[typing.Dict[str, typing.Any]] = None
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

athena/types/chunk_result_chunk_id.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ChunkResultChunkId = typing.Union[str, int]

athena/types/{structured_data_extractor_reponse.py → image_url_content.py}

@@ -7,15 +7,12 @@ from ..core.datetime_utils import serialize_datetime
 from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 
 
-class StructuredDataExtractorReponse(pydantic_v1.BaseModel):
+class ImageUrlContent(pydantic_v1.BaseModel):
     """
-    The agent's response.
+    An image content item.
     """
 
-    data: typing.Dict[str, typing.Any] = pydantic_v1.Field()
-    """
-    The extracted structured data. Guaranteed to match `json_schema`.
-    """
+    image_url: typing.Dict[str, str]
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

athena/types/prompt_message.py

@@ -0,0 +1,35 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from .type import Type
+
+
+class PromptMessage(pydantic_v1.BaseModel):
+    """
+    A message to use for the structured data extractor.
+    """
+
+    content: str
+    type: Type
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

athena/types/structured_data_extractor_response.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from .chunk_result import ChunkResult
+
+
+class StructuredDataExtractorResponse(pydantic_v1.BaseModel):
+    """
+    The agent's response.
+    """
+
+    chunk_by_chunk_data: typing.Optional[typing.List[ChunkResult]] = pydantic_v1.Field(default=None)
+    """
+    The extracted structured data for each chunk. A list where each element is guaranteed to match `json_schema`.
+    """
+
+    reduced_data: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    If reduce is True, the reduced structured data, otherwise null. Guaranteed to match `json_schema`.
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

athena/types/text_content.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+
+
+class TextContent(pydantic_v1.BaseModel):
+    """
+    A text content item in a multimodal message content.
+    """
+
+    text: str
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

athena/types/type.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class Type(str, enum.Enum):
+    SYSTEM = "system"
+    HUMAN = "human"
+    USER = "user"
+
+    def visit(
+        self,
+        system: typing.Callable[[], T_Result],
+        human: typing.Callable[[], T_Result],
+        user: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is Type.SYSTEM:
+            return system()
+        if self is Type.HUMAN:
+            return human()
+        if self is Type.USER:
+            return user()

{athena_intelligence-0.1.122.dist-info → athena_intelligence-0.1.123.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: athena-intelligence
-Version: 0.1.122
+Version: 0.1.123
 Summary: Athena Intelligence Python Library
 Requires-Python: >=3.8,<4.0
 Classifier: Intended Audience :: Developers

{athena_intelligence-0.1.122.dist-info → athena_intelligence-0.1.123.dist-info}/RECORD

@@ -1,4 +1,4 @@
-athena/__init__.py,sha256=iCOL1NZiVObNQQHMZ47mrTS_r4YuHRGJGLCThyQxVRg,2044
+athena/__init__.py,sha256=-QY5Njk1mv2eVt9CMdJSaU_nMqoXzZ8d5kHjxKCs7jU,2464
 athena/agents/__init__.py,sha256=I6MO2O_hb6KLa8oDHbGNSAhcPE-dsrX6LMcAEhsg3PQ,160
 athena/agents/client.py,sha256=aI8rNhXBSVJ-hvjnIoCK9sKvHB0e95Zkn-3YpXOKFrY,6721
 athena/agents/drive/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
@@ -13,7 +13,7 @@ athena/base_client.py,sha256=-kVdOlIibBz48lxWratdQAzT7fTvZsORvOMF3KoPDPw,5647
 athena/client.py,sha256=4PUPrBPCMTFpHR1yuKVR5eC1AYBl_25SMf6ZH82JHB0,19039
 athena/core/__init__.py,sha256=UFXpYzcGxWQUucU1TkjOQ9mGWN3A5JohluOIWVYKU4I,973
 athena/core/api_error.py,sha256=RE8LELok2QCjABadECTvtDp7qejA1VmINCh6TbqPwSE,426
-athena/core/client_wrapper.py,sha256=GDT2am2KI0l7odoK0jxA57nkA-gmSGfkk6i9sshqImE,1806
+athena/core/client_wrapper.py,sha256=QpWDM_UvxCir-D4qH9GDRZGMoDC2fW-UpSPKEHT3S0o,1806
 athena/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
 athena/core/file.py,sha256=sy1RUGZ3aJYuw998bZytxxo6QdgKmlnlgBaMvwEKCGg,1480
 athena/core/http_client.py,sha256=Z4NuAsJD-51yqmoME17O5sxwx5orSp1wsnd6bPyKcgA,17768
@@ -43,13 +43,17 @@ athena/tools/client.py,sha256=9ec2gnf3z_vhr3EqT_-ZksevTDtFP1jftPY4os0Ty3Q,21166
 athena/tools/email/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
 athena/tools/email/client.py,sha256=epUkV5af3eilVgRR81SFZAf29JuhEWKMkdMuN6qDLUM,7593
 athena/tools/structured_data_extractor/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
-athena/tools/structured_data_extractor/client.py,sha256=yEF-wVyRhebkSlb0r_kcvs4P7TZSlfPTwG-GdZAclvQ,6272
+athena/tools/structured_data_extractor/client.py,sha256=0rEq5bftoWQJwCF9fcP3r8nUSY5hZLy_pOAucena9Go,11235
 athena/tools/tasks/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
 athena/tools/tasks/client.py,sha256=5kT6ulh2YDIbNYiv-knBjtF-ST7p0dUvZyrd7t5O61s,2975
 athena/tools/types/__init__.py,sha256=cA-ZQm6veQAP3_vKu9KkZpISsQqgTBN_Z--FGY1c2iA,197
 athena/tools/types/tools_data_frame_request_columns_item.py,sha256=GA1FUlTV_CfSc-KToTAwFf4Exl0rr4fsweVZupztjw0,138
-athena/types/__init__.py,sha256=0D7plyB40Adtmo5YohNnc7bs7qcwIxslC7LknZd_nK4,1934
+athena/types/__init__.py,sha256=-VA36LN5Q1SLk5IUgw159TBfTtTmvbgAOfaL-3TRY7A,2522
 athena/types/asset_not_found_error.py,sha256=ZcgqRuzvO4Z8vVVxwtDB-QtKhpVIVV3hqQuJeUoOoJE,1121
+athena/types/chunk.py,sha256=M4O7Sj3EMvkXioQneuKbptr1n5XNGCU9fVxYR12XG9o,1340
+athena/types/chunk_content_item.py,sha256=2B1mTc0a4h7jyKRiYwfC573fM4xijhNEgfd_FI-myj4,2251
+athena/types/chunk_result.py,sha256=b74rp4xNKm3r0R76N-VnoaKrEKeBzMWRGI2PVMyiXpc,1310
+athena/types/chunk_result_chunk_id.py,sha256=pzJ6yL6NdUtseoeU4Kw2jlxSTMCVew2TrjhR1MbCuFg,124
 athena/types/custom_agent_response.py,sha256=_Vm_fJq4cETtOawBW7p0cvH4Jmle26lHQZ73A8MdLX0,1263
 athena/types/data_frame_request_out.py,sha256=1CEBe-baDQi0uz_EgMw0TKGYXGj6KV44cL3ViRTZLKM,1669
 athena/types/data_frame_request_out_columns_item.py,sha256=9cjzciFv6C8n8Griytt_q_8ovkzHViS5tvUcMDfkfKE,143
@@ -64,13 +68,17 @@ athena/types/general_agent_config.py,sha256=FaswWVsDTsL5Fs9Tlx4zSK1S8OrsFnzruEt7
 athena/types/general_agent_config_enabled_tools_item.py,sha256=6gYaU7uIDJbgygtBKLdYL-VbPxxbEcxwRsT8VaW5vN8,165
 athena/types/general_agent_request.py,sha256=NnUVtz8U1VoA1SJapbp163Wf_inEQVeFCYWJvM4P-qI,1449
 athena/types/general_agent_response.py,sha256=9BxqXzchSti5O0Ch_WJkvmkawkBhpH03QlZIbKdYbAY,1212
+athena/types/image_url_content.py,sha256=AivFiET-XA7guQ_rWEGOOafDuQBXTvO8-rMGmKucCss,1182
 athena/types/parent_folder_error.py,sha256=ZMF-i3mZY6Mu1n5uQ60Q3mIIfehlWuXtgFUkSYspkx8,1120
+athena/types/prompt_message.py,sha256=0z2qlWbqHCG2j7hvWBDvDpQrHLDCI3h8Z0kg8AOOgKs,1227
 athena/types/research_agent_response.py,sha256=-1mX4M0IEWDFH3alSZdtuhZHSerjWYJQkn74r3Dp26g,1235
 athena/types/save_asset_request_out.py,sha256=5bpBaUV3oeuL_hz4s07c-6MQHkn4cBsyxgT_SD5oi6I,1193
 athena/types/sql_agent_response.py,sha256=DmeG0HPZkPT_gTrtkroVZluGZIV9McB8wmME2iT8PB0,1347
-athena/types/structured_data_extractor_reponse.py,sha256=Fa-54k20UIqHKDsmUpF4wZpaiTb_J35XysY1GZUf63w,1306
+athena/types/structured_data_extractor_response.py,sha256=RBTjR50PWs3NM0GUlENNHaqAMiOatf14Vmvrd94de8s,1647
+athena/types/text_content.py,sha256=uG2poNIkM6o7tFgf-eKzZk9kZHYImY3JdI-NkYiqWgU,1185
 athena/types/tool.py,sha256=6H2BFZiBgQOtYUAwSYBeGZKhwev17IEwnIjgmno6dZw,436
+athena/types/type.py,sha256=JaUIt4ogmO4XxCQ9c56fqKN5qANKkrnpuZGmdqOCIow,581
 athena/version.py,sha256=8aYAOJtVLaJLpRp6mTiEIhnl8gXA7yE0aDtZ-3mKQ4k,87
-athena_intelligence-0.1.122.dist-info/METADATA,sha256=YKzNYjg8r3D0PeORshmkbJ3YWBnl8LMylR_YZg7PNes,5274
-athena_intelligence-0.1.122.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-athena_intelligence-0.1.122.dist-info/RECORD,,
+athena_intelligence-0.1.123.dist-info/METADATA,sha256=Au7QjNP7MXi0igYTXg3ypVp_OHoNiFm-Q8c-E53dEGU,5274
+athena_intelligence-0.1.123.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+athena_intelligence-0.1.123.dist-info/RECORD,,