pydantic-ai-slim 0.0.6__py3-none-any.whl

pydantic_ai/result.py

@@ -0,0 +1,314 @@
+from __future__ import annotations as _annotations
+
+from abc import ABC, abstractmethod
+from collections.abc import AsyncIterator
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Generic, TypeVar, cast
+
+import logfire_api
+
+from . import _result, _utils, exceptions, messages, models
+from .dependencies import AgentDeps
+
+__all__ = (
+    'ResultData',
+    'Cost',
+    'RunResult',
+    'StreamedRunResult',
+)
+
+
+ResultData = TypeVar('ResultData')
+"""Type variable for the result data of a run."""
+
+_logfire = logfire_api.Logfire(otel_scope='pydantic-ai')
+
+
+@dataclass
+class Cost:
+    """Cost of a request or run.
+
+    Responsibility for calculating costs is on the model used, PydanticAI simply sums the cost of requests.
+
+    You'll need to look up the documentation of the model you're using to convent "token count" costs to monetary costs.
+    """
+
+    request_tokens: int | None = None
+    """Tokens used in processing the request."""
+    response_tokens: int | None = None
+    """Tokens used in generating the response."""
+    total_tokens: int | None = None
+    """Total tokens used in the whole run, should generally be equal to `request_tokens + response_tokens`."""
+    details: dict[str, int] | None = None
+    """Any extra details returned by the model."""
+
+    def __add__(self, other: Cost) -> Cost:
+        """Add two costs together.
+
+        This is provided so it's trivial to sum costs from multiple requests and runs.
+        """
+        counts: dict[str, int] = {}
+        for field in 'request_tokens', 'response_tokens', 'total_tokens':
+            self_value = getattr(self, field)
+            other_value = getattr(other, field)
+            if self_value is not None or other_value is not None:
+                counts[field] = (self_value or 0) + (other_value or 0)
+
+        details = self.details.copy() if self.details is not None else None
+        if other.details is not None:
+            details = details or {}
+            for key, value in other.details.items():
+                details[key] = details.get(key, 0) + value
+
+        return Cost(**counts, details=details or None)
+
+
+@dataclass
+class _BaseRunResult(ABC, Generic[ResultData]):
+    """Base type for results.
+
+    You should not import or use this type directly, instead use its subclasses `RunResult` and `StreamedRunResult`.
+    """
+
+    _all_messages: list[messages.Message]
+    _new_message_index: int
+
+    def all_messages(self) -> list[messages.Message]:
+        """Return the history of messages."""
+        # this is a method to be consistent with the other methods
+        return self._all_messages
+
+    def all_messages_json(self) -> bytes:
+        """Return all messages from [`all_messages`][..all_messages] as JSON bytes."""
+        return messages.MessagesTypeAdapter.dump_json(self.all_messages())
+
+    def new_messages(self) -> list[messages.Message]:
+        """Return new messages associated with this run.
+
+        System prompts and any messages from older runs are excluded.
+        """
+        return self.all_messages()[self._new_message_index :]
+
+    def new_messages_json(self) -> bytes:
+        """Return new messages from [`new_messages`][..new_messages] as JSON bytes."""
+        return messages.MessagesTypeAdapter.dump_json(self.new_messages())
+
+    @abstractmethod
+    def cost(self) -> Cost:
+        raise NotImplementedError()
+
+
+@dataclass
+class RunResult(_BaseRunResult[ResultData]):
+    """Result of a non-streamed run."""
+
+    data: ResultData
+    """Data from the final response in the run."""
+    _cost: Cost
+
+    def cost(self) -> Cost:
+        """Return the cost of the whole run."""
+        return self._cost
+
+
+@dataclass
+class StreamedRunResult(_BaseRunResult[ResultData], Generic[AgentDeps, ResultData]):
+    """Result of a streamed run that returns structured data via a tool call."""
+
+    cost_so_far: Cost
+    """Cost of the run up until the last request."""
+    _stream_response: models.EitherStreamedResponse
+    _result_schema: _result.ResultSchema[ResultData] | None
+    _deps: AgentDeps
+    _result_validators: list[_result.ResultValidator[AgentDeps, ResultData]]
+    is_complete: bool = False
+    """Whether the stream has all been received.
+
+    This is set to `True` when one of
+    [`stream`][pydantic_ai.result.StreamedRunResult.stream],
+    [`stream_text`][pydantic_ai.result.StreamedRunResult.stream_text],
+    [`stream_structured`][pydantic_ai.result.StreamedRunResult.stream_structured] or
+    [`get_data`][pydantic_ai.result.StreamedRunResult.get_data] completes.
+    """
+
+    async def stream(self, *, debounce_by: float | None = 0.1) -> AsyncIterator[ResultData]:
+        """Stream the response as an async iterable.
+
+        The pydantic validator for structured data will be called in
+        [partial mode](https://docs.pydantic.dev/dev/concepts/experimental/#partial-validation)
+        on each iteration.
+
+        Args:
+            debounce_by: by how much (if at all) to debounce/group the response chunks by. `None` means no debouncing.
+                Debouncing is particularly important for long structured responses to reduce the overhead of
+                performing validation as each token is received.
+
+        Returns:
+            An async iterable of the response data.
+        """
+        if isinstance(self._stream_response, models.StreamTextResponse):
+            async for text in self.stream_text(debounce_by=debounce_by):
+                yield cast(ResultData, text)
+        else:
+            async for structured_message, is_last in self.stream_structured(debounce_by=debounce_by):
+                yield await self.validate_structured_result(structured_message, allow_partial=not is_last)
+
+    async def stream_text(self, *, delta: bool = False, debounce_by: float | None = 0.1) -> AsyncIterator[str]:
+        """Stream the text result as an async iterable.
+
+        !!! note
+            This method will fail if the response is structured,
+            e.g. if [`is_structured`][pydantic_ai.result.StreamedRunResult.is_structured] returns `True`.
+
+        !!! note
+            Result validators will NOT be called on the text result if `delta=True`.
+
+        Args:
+            delta: if `True`, yield each chunk of text as it is received, if `False` (default), yield the full text
+                up to the current point.
+            debounce_by: by how much (if at all) to debounce/group the response chunks by. `None` means no debouncing.
+                Debouncing is particularly important for long structured responses to reduce the overhead of
+                performing validation as each token is received.
+        """
+        with _logfire.span('response stream text') as lf_span:
+            if isinstance(self._stream_response, models.StreamStructuredResponse):
+                raise exceptions.UserError('stream_text() can only be used with text responses')
+            if delta:
+                async with _utils.group_by_temporal(self._stream_response, debounce_by) as group_iter:
+                    async for _ in group_iter:
+                        yield ''.join(self._stream_response.get())
+                final_delta = ''.join(self._stream_response.get(final=True))
+                if final_delta:
+                    yield final_delta
+            else:
+                # a quick benchmark shows it's faster to build up a string with concat when we're
+                # yielding at each step
+                chunks: list[str] = []
+                combined = ''
+                async with _utils.group_by_temporal(self._stream_response, debounce_by) as group_iter:
+                    async for _ in group_iter:
+                        new = False
+                        for chunk in self._stream_response.get():
+                            chunks.append(chunk)
+                            new = True
+                        if new:
+                            combined = await self._validate_text_result(''.join(chunks))
+                            yield combined
+
+                new = False
+                for chunk in self._stream_response.get(final=True):
+                    chunks.append(chunk)
+                    new = True
+                if new:
+                    combined = await self._validate_text_result(''.join(chunks))
+                    yield combined
+                lf_span.set_attribute('combined_text', combined)
+                self._marked_completed(text=combined)
+
+    async def stream_structured(
+        self, *, debounce_by: float | None = 0.1
+    ) -> AsyncIterator[tuple[messages.ModelStructuredResponse, bool]]:
+        """Stream the response as an async iterable of Structured LLM Messages.
+
+        !!! note
+            This method will fail if the response is text,
+            e.g. if [`is_structured`][pydantic_ai.result.StreamedRunResult.is_structured] returns `False`.
+
+        Args:
+            debounce_by: by how much (if at all) to debounce/group the response chunks by. `None` means no debouncing.
+                Debouncing is particularly important for long structured responses to reduce the overhead of
+                performing validation as each token is received.
+
+        Returns:
+            An async iterable of the structured response message and whether that is the last message.
+        """
+        with _logfire.span('response stream structured') as lf_span:
+            if isinstance(self._stream_response, models.StreamTextResponse):
+                raise exceptions.UserError('stream_structured() can only be used with structured responses')
+            else:
+                # we should already have a message at this point, yield that first if it has any content
+                msg = self._stream_response.get()
+                if any(call.has_content() for call in msg.calls):
+                    yield msg, False
+                async with _utils.group_by_temporal(self._stream_response, debounce_by) as group_iter:
+                    async for _ in group_iter:
+                        msg = self._stream_response.get()
+                        if any(call.has_content() for call in msg.calls):
+                            yield msg, False
+                msg = self._stream_response.get(final=True)
+                yield msg, True
+                lf_span.set_attribute('structured_response', msg)
+                self._marked_completed(structured_message=msg)
+
+    async def get_data(self) -> ResultData:
+        """Stream the whole response, validate and return it."""
+        async for _ in self._stream_response:
+            pass
+        if isinstance(self._stream_response, models.StreamTextResponse):
+            text = ''.join(self._stream_response.get(final=True))
+            text = await self._validate_text_result(text)
+            self._marked_completed(text=text)
+            return cast(ResultData, text)
+        else:
+            structured_message = self._stream_response.get(final=True)
+            self._marked_completed(structured_message=structured_message)
+            return await self.validate_structured_result(structured_message)
+
+    @property
+    def is_structured(self) -> bool:
+        """Return whether the stream response contains structured data (as opposed to text)."""
+        return isinstance(self._stream_response, models.StreamStructuredResponse)
+
+    def cost(self) -> Cost:
+        """Return the cost of the whole run.
+
+        !!! note
+            This won't return the full cost until the stream is finished.
+        """
+        return self.cost_so_far + self._stream_response.cost()
+
+    def timestamp(self) -> datetime:
+        """Get the timestamp of the response."""
+        return self._stream_response.timestamp()
+
+    async def validate_structured_result(
+        self, message: messages.ModelStructuredResponse, *, allow_partial: bool = False
+    ) -> ResultData:
+        """Validate a structured result message."""
+        assert self._result_schema is not None, 'Expected _result_schema to not be None'
+        match = self._result_schema.find_tool(message)
+        if match is None:
+            raise exceptions.UnexpectedModelBehavior(
+                f'Invalid message, unable to find tool: {self._result_schema.tool_names()}'
+            )
+
+        call, result_tool = match
+        result_data = result_tool.validate(call, allow_partial=allow_partial, wrap_validation_errors=False)
+
+        for validator in self._result_validators:
+            result_data = await validator.validate(result_data, self._deps, 0, call)
+        return result_data
+
+    async def _validate_text_result(self, text: str) -> str:
+        for validator in self._result_validators:
+            text = await validator.validate(  # pyright: ignore[reportAssignmentType]
+                text,  # pyright: ignore[reportArgumentType]
+                self._deps,
+                0,
+                None,
+            )
+        return text
+
+    def _marked_completed(
+        self, *, text: str | None = None, structured_message: messages.ModelStructuredResponse | None = None
+    ) -> None:
+        self.is_complete = True
+        if text is not None:
+            assert structured_message is None, 'Either text or structured_message should provided, not both'
+            self._all_messages.append(
+                messages.ModelTextResponse(content=text, timestamp=self._stream_response.timestamp())
+            )
+        else:
+            assert structured_message is not None, 'Either text or structured_message should provided, not both'
+            self._all_messages.append(structured_message)

pydantic_ai_slim-0.0.6.dist-info/METADATA

@@ -0,0 +1,49 @@
+Metadata-Version: 2.3
+Name: pydantic-ai-slim
+Version: 0.0.6
+Summary: Agent Framework / shim to use Pydantic with LLMs
+Author-email: Samuel Colvin <samuel@pydantic.dev>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: MacOS X
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: eval-type-backport>=0.2.0
+Requires-Dist: griffe>=1.3.2
+Requires-Dist: httpx>=0.27.2
+Requires-Dist: logfire-api>=1.2.0
+Requires-Dist: pydantic>=2.10
+Provides-Extra: groq
+Requires-Dist: groq>=0.12.0; extra == 'groq'
+Provides-Extra: logfire
+Requires-Dist: logfire>=2.3; extra == 'logfire'
+Provides-Extra: openai
+Requires-Dist: openai>=1.54.3; extra == 'openai'
+Provides-Extra: vertexai
+Requires-Dist: google-auth>=2.36.0; extra == 'vertexai'
+Requires-Dist: requests>=2.32.3; extra == 'vertexai'
+Description-Content-Type: text/markdown
+
+# Coming soon
+
+[![CI](https://github.com/pydantic/pydantic-ai/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/pydantic/pydantic-ai/actions/workflows/ci.yml?query=branch%3Amain)
+[![Coverage](https://coverage-badge.samuelcolvin.workers.dev/pydantic/pydantic-ai.svg)](https://coverage-badge.samuelcolvin.workers.dev/redirect/pydantic/pydantic-ai)
+[![PyPI](https://img.shields.io/pypi/v/pydantic-ai.svg)](https://pypi.python.org/pypi/pydantic-ai)
+[![versions](https://img.shields.io/pypi/pyversions/pydantic-ai.svg)](https://github.com/pydantic/pydantic-ai)
+[![license](https://img.shields.io/github/license/pydantic/pydantic-ai.svg?v)](https://github.com/pydantic/pydantic-ai/blob/main/LICENSE)

pydantic_ai_slim-0.0.6.dist-info/RECORD

@@ -0,0 +1,23 @@
+pydantic_ai/__init__.py,sha256=ghn5MI2Ygw6azR3i7RTw54B041pllt1E520ILK1kM5Y,319
+pydantic_ai/_griffe.py,sha256=pRjCJ6B1hhx6k46XJgl9zF6aRYxRmqEZKFok8unp4Iw,3449
+pydantic_ai/_pydantic.py,sha256=JslSZjj8Ni98oGfrmbS3RGM0B0_PdNZynvgAW2CnXeU,8056
+pydantic_ai/_result.py,sha256=_qVaq_gmQyPWlyFn_9unafPqOiwSgoa23qxvUwMypo8,9683
+pydantic_ai/_retriever.py,sha256=HxYDfpvcOrhv9gq_1CKRIRAFyLs0qquJGDO9LAWy8ok,4638
+pydantic_ai/_system_prompt.py,sha256=PfNCuG45mM65HtoTiYKz6pWv_CQ9dtxPjl-u8BEn2z4,1094
+pydantic_ai/_utils.py,sha256=7tPzgiiDUWAZGH6zmBZ91CUN3aFSv0szEkw0RDbPLJg,8128
+pydantic_ai/agent.py,sha256=nFwHI3w8JpCqze5UX5TAxiZsSSyavsyKo2W5ITNke1g,34454
+pydantic_ai/dependencies.py,sha256=6IawVRoLSefOtO6oCsxB3kndJRVEP1-DHSE9-2T3ZW8,2509
+pydantic_ai/exceptions.py,sha256=bcde_Xg2yCnSYduhTbbtH3_9kQR6UuKqWJNEzfxiKyw,1566
+pydantic_ai/messages.py,sha256=tmZOFCGVIEmSk8YYQ9qiyb6Q-6DTiqOzfWiryCHVQpY,7536
+pydantic_ai/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pydantic_ai/result.py,sha256=Gs2ZjuFJgONGJm8M5R2mGph5-lUFLBg7FxVrs2CVDPs,13525
+pydantic_ai/models/__init__.py,sha256=gAH9jbSk6ezqwJpCoVHbdMwULz9mu5VuguARUqKfN8w,10140
+pydantic_ai/models/function.py,sha256=dv1a1RhfdXqwXMFI_y8QzPWJj_YW6Q7twvKvO98JVUE,10124
+pydantic_ai/models/gemini.py,sha256=vHg91s9UzqU3teNnvOJLXkYI8Gu9Wt1vhEu6zB3Ttd8,27677
+pydantic_ai/models/groq.py,sha256=7zKpFg3Fvc-S2n_EroQg5AAD5cOj4y7SKQ7VjMiNSUs,14939
+pydantic_ai/models/openai.py,sha256=_XZ0eDbk3Q3_V2MlMMaZArzYGSm2VuBR47lv4TmFgjY,14923
+pydantic_ai/models/test.py,sha256=T53NKS7pQbCgzo7QIFGdObt3zbDs5t-tjSlkDNsKCuo,14523
+pydantic_ai/models/vertexai.py,sha256=YiYB82WOB5Kp4NjYhweN0ZNjE39-dnpDseMyoyf6Evk,11294
+pydantic_ai_slim-0.0.6.dist-info/METADATA,sha256=t8H1QGNz1C_fmcjDTfsgvX6hRt4RZBNs-uydcdNgwJA,2370
+pydantic_ai_slim-0.0.6.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+pydantic_ai_slim-0.0.6.dist-info/RECORD,,

pydantic_ai_slim-0.0.6.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.26.3
+Root-Is-Purelib: true
+Tag: py3-none-any