chatlas 0.2.0__py3-none-any.whl

chatlas/_turn.py

@@ -0,0 +1,147 @@
+from __future__ import annotations
+
+from typing import Any, Generic, Literal, Optional, Sequence, TypeVar
+
+from ._content import Content, ContentText
+
+__all__ = ("Turn",)
+
+CompletionT = TypeVar("CompletionT")
+
+
+class Turn(Generic[CompletionT]):
+    """
+    A user or assistant turn
+
+    Every conversation with a chatbot consists of pairs of user and assistant
+    turns, corresponding to an HTTP request and response. These turns are
+    represented by the `Turn` object, which contains a list of
+    [](`~chatlas.types.Content`)s representing the individual messages within the
+    turn. These might be text, images, tool requests (assistant only), or tool
+    responses (user only).
+
+    Note that a call to `.chat()` and related functions may result in multiple
+    user-assistant turn cycles. For example, if you have registered tools, chatlas
+    will automatically handle the tool calling loop, which may result in any
+    number of additional cycles.
+
+    Examples
+    --------
+
+    ```python
+    from chatlas import Turn, ChatOpenAI, ChatAnthropic
+
+    chat = ChatOpenAI()
+    str(chat.chat("What is the capital of France?"))
+    turns = chat.get_turns()
+    assert len(turns) == 2
+    assert isinstance(turns[0], Turn)
+    assert turns[0].role == "user"
+    assert turns[1].role == "assistant"
+
+    # Load context into a new chat instance
+    chat2 = ChatAnthropic(turns=turns)
+    turns2 = chat2.get_turns()
+    assert turns == turns2
+    ```
+
+    Parameters
+    ----------
+    role
+        Either "user", "assistant", or "system".
+    contents
+        A list of [](`~chatlas.types.Content`) objects.
+    tokens
+        A numeric vector of length 2 representing the number of input and output
+        tokens (respectively) used in this turn. Currently only recorded for
+        assistant turns.
+    finish_reason
+        A string indicating the reason why the conversation ended. This is only
+        relevant for assistant turns.
+    completion
+        The completion object returned by the provider. This is useful if there's
+        information returned by the provider that chatlas doesn't otherwise expose.
+        This is only relevant for assistant turns.
+    """
+
+    def __init__(
+        self,
+        role: Literal["user", "assistant", "system"],
+        contents: str | Sequence[Content | str],
+        *,
+        tokens: Optional[tuple[int, int]] = None,
+        finish_reason: Optional[str] = None,
+        completion: Optional[CompletionT] = None,
+    ):
+        self.role = role
+
+        if isinstance(contents, str):
+            contents = [ContentText(contents)]
+
+        contents2: list[Content] = []
+        for x in contents:
+            if isinstance(x, Content):
+                contents2.append(x)
+            elif isinstance(x, str):
+                contents2.append(ContentText(x))
+            else:
+                raise ValueError("All contents must be Content objects or str.")
+
+        self.contents = contents2
+        self.text = "".join(x.text for x in self.contents if isinstance(x, ContentText))
+        self.tokens = tokens
+        self.finish_reason = finish_reason
+        self.completion = completion
+
+    def __str__(self) -> str:
+        return self.text
+
+    def __repr__(self, indent: int = 0) -> str:
+        res = " " * indent + f"<Turn role='{self.role}'"
+        if self.tokens:
+            res += f" tokens={self.tokens}"
+        if self.finish_reason:
+            res += f" finish_reason='{self.finish_reason}'"
+        if self.completion:
+            res += f" completion={self.completion}"
+        res += ">"
+        for content in self.contents:
+            res += "\n" + content.__repr__(indent=indent + 2)
+        return res + "\n"
+
+    def __eq__(self, other: Any) -> bool:
+        if not isinstance(other, Turn):
+            return False
+        res = (
+            self.role == other.role
+            and self.contents == other.contents
+            and self.tokens == other.tokens
+            and self.finish_reason == other.finish_reason
+            and self.completion == other.completion
+        )
+        return res
+
+
+def user_turn(*args: Content | str) -> Turn:
+    if len(args) == 0:
+        raise ValueError("Must supply at least one input.")
+
+    return Turn("user", args)
+
+
+def normalize_turns(turns: list[Turn], system_prompt: str | None = None) -> list[Turn]:
+    if system_prompt is not None:
+        system_turn = Turn("system", system_prompt)
+
+        if not turns:
+            turns = [system_turn]
+        elif turns[0].role != "system":
+            turns = [system_turn] + turns
+        elif turns[0] == system_turn:
+            pass  # Duplicate system prompt; don't need to do anything
+        else:
+            raise ValueError(
+                "system_prompt and turns[0] can't contain conflicting system prompts."
+            )
+
+    return turns

chatlas/_typing_extensions.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+# # Within file flags to ignore unused imports
+# flake8: noqa: F401
+# pyright: reportUnusedImport=false
+import sys
+
+if sys.version_info >= (3, 10):
+    from typing import ParamSpec, TypeGuard, is_typeddict
+else:
+    from typing_extensions import ParamSpec, TypeGuard, is_typeddict
+
+# Even though TypedDict is available in Python 3.8, because it's used with NotRequired,
+# they should both come from the same typing module.
+# https://peps.python.org/pep-0655/#usage-in-python-3-11
+if sys.version_info >= (3, 11):
+    from typing import Required, TypedDict
+else:
+    from typing_extensions import Required, TypedDict
+
+
+# The only purpose of the following line is so that pyright will put all of the
+# conditional imports into the .pyi file when generating type stubs. Without this line,
+# pyright will not include the above imports in the generated .pyi file, and it will
+# result in a lot of red squiggles in user code.
+_: "ParamSpec | TypeGuard | is_typeddict | Required | TypedDict"  # type: ignore

chatlas/_utils.py

@@ -0,0 +1,106 @@
+from __future__ import annotations
+
+import functools
+import inspect
+import os
+import re
+from typing import Awaitable, Callable, TypeVar, cast
+
+from ._typing_extensions import ParamSpec, TypeGuard
+
+# --------------------------------------------------------------------
+# wrap_async() and is_async_callable() was copied from shiny/_utils.py
+# --------------------------------------------------------------------
+
+R = TypeVar("R")  # Return type
+P = ParamSpec("P")
+
+
+def wrap_async(
+    fn: Callable[P, R] | Callable[P, Awaitable[R]],
+) -> Callable[P, Awaitable[R]]:
+    """
+    Given a synchronous function that returns R, return an async function that wraps the
+    original function. If the input function is already async, then return it unchanged.
+    """
+
+    if is_async_callable(fn):
+        return fn
+
+    fn = cast(Callable[P, R], fn)
+
+    @functools.wraps(fn)
+    async def fn_async(*args: P.args, **kwargs: P.kwargs) -> R:
+        return fn(*args, **kwargs)
+
+    return fn_async
+
+
+def is_async_callable(
+    obj: Callable[P, R] | Callable[P, Awaitable[R]],
+) -> TypeGuard[Callable[P, Awaitable[R]]]:
+    """
+    Determine if an object is an async function.
+
+    This is a more general version of `inspect.iscoroutinefunction()`, which only works
+    on functions. This function works on any object that has a `__call__` method, such
+    as a class instance.
+
+    Returns
+    -------
+    :
+        Returns True if `obj` is an `async def` function, or if it's an object with a
+        `__call__` method which is an `async def` function.
+    """
+    if inspect.iscoroutinefunction(obj):
+        return True
+    if hasattr(obj, "__call__"):  # noqa: B004
+        if inspect.iscoroutinefunction(obj.__call__):  # type: ignore
+            return True
+
+    return False
+
+
+# https://docs.pytest.org/en/latest/example/simple.html#pytest-current-test-environment-variable
+def is_testing():
+    return os.environ.get("PYTEST_CURRENT_TEST", None) is not None
+
+
+class MISSING_TYPE:
+    """
+    A singleton representing a missing value.
+    """
+
+    pass
+
+
+MISSING = MISSING_TYPE()
+
+
+# --------------------------------------------------------------------
+# html_escape was copied from htmltools/_utils.py
+# --------------------------------------------------------------------
+
+
+HTML_ESCAPE_TABLE = {
+    "&": "&",
+    ">": ">",
+    "<": "&lt;",
+}
+
+HTML_ATTRS_ESCAPE_TABLE = {
+    **HTML_ESCAPE_TABLE,
+    '"': "&quot;",
+    "'": "&apos;",
+    "\r": "&#13;",
+    "\n": "&#10;",
+}
+
+
+def html_escape(text: str, attr: bool = True) -> str:
+    table = HTML_ATTRS_ESCAPE_TABLE if attr else HTML_ESCAPE_TABLE
+    if not re.search("|".join(table), text):
+        return text
+    for key, value in table.items():
+        text = text.replace(key, value)
+    return text

chatlas/types/__init__.py

@@ -0,0 +1,32 @@
+from .._chat import ChatResponse, ChatResponseAsync, SubmitInputArgsT
+from .._content import (
+    Content,
+    ContentImage,
+    ContentImageInline,
+    ContentImageRemote,
+    ContentJson,
+    ContentText,
+    ContentToolRequest,
+    ContentToolResult,
+    ImageContentTypes,
+)
+from .._tokens import TokenUsage
+from .._utils import MISSING, MISSING_TYPE
+
+__all__ = (
+    "Content",
+    "ContentImage",
+    "ContentImageInline",
+    "ContentImageRemote",
+    "ContentJson",
+    "ContentText",
+    "ContentToolRequest",
+    "ContentToolResult",
+    "ChatResponse",
+    "ChatResponseAsync",
+    "ImageContentTypes",
+    "SubmitInputArgsT",
+    "TokenUsage",
+    "MISSING_TYPE",
+    "MISSING",
+)

chatlas/types/anthropic/__init__.py

@@ -0,0 +1,14 @@
+# ---------------------------------------------------------
+# Do not modify this file. It was generated by `scripts/generate_typed_dicts.py`.
+# ---------------------------------------------------------
+
+
+from ._client import ChatClientArgs
+from ._client_bedrock import ChatBedrockClientArgs
+from ._submit import SubmitInputArgs
+
+__all__ = (
+    "ChatClientArgs",
+    "ChatBedrockClientArgs",
+    "SubmitInputArgs",
+)

chatlas/types/anthropic/_client.py

@@ -0,0 +1,29 @@
+# ---------------------------------------------------------
+# Do not modify this file. It was generated by `scripts/generate_typed_dicts.py`.
+# ---------------------------------------------------------
+
+
+from typing import Mapping, Optional, TypedDict, Union
+
+import anthropic
+import httpx
+
+
+class ChatClientArgs(TypedDict, total=False):
+    api_key: str | None
+    auth_token: str | None
+    base_url: str | httpx.URL | None
+    timeout: Union[float, anthropic.Timeout, None, anthropic.NotGiven]
+    max_retries: int
+    default_headers: Optional[Mapping[str, str]]
+    default_query: Optional[Mapping[str, object]]
+    http_client: httpx.AsyncClient
+    transport: httpx.AsyncBaseTransport
+    proxies: Union[
+        str,
+        httpx.Proxy,
+        dict[str | httpx.URL, Union[None, str, httpx.URL, httpx.Proxy]],
+        None,
+    ]
+    connection_pool_limits: httpx.Limits
+    _strict_response_validation: bool

chatlas/types/anthropic/_client_bedrock.py

@@ -0,0 +1,23 @@
+# ---------------------------------------------------------
+# Do not modify this file. It was generated by `scripts/generate_typed_dicts.py`.
+# ---------------------------------------------------------
+
+from typing import Mapping, Optional, TypedDict
+
+import anthropic
+import httpx
+
+
+class ChatBedrockClientArgs(TypedDict, total=False):
+    aws_secret_key: str | None
+    aws_access_key: str | None
+    aws_region: str | None
+    aws_profile: str | None
+    aws_session_token: str | None
+    base_url: str | httpx.URL | None
+    timeout: float | anthropic.Timeout | None | anthropic.NotGiven
+    max_retries: int
+    default_headers: Optional[Mapping[str, str]]
+    default_query: Optional[Mapping[str, object]]
+    http_client: httpx.AsyncClient
+    _strict_response_validation: bool

chatlas/types/anthropic/_submit.py

@@ -0,0 +1,57 @@
+# ---------------------------------------------------------
+# Do not modify this file. It was generated by `scripts/generate_typed_dicts.py`.
+# ---------------------------------------------------------
+
+
+from typing import Iterable, Literal, Mapping, Optional, TypedDict, Union
+
+import anthropic
+import anthropic._types
+import anthropic.types.message_param
+import anthropic.types.text_block_param
+import anthropic.types.tool_choice_any_param
+import anthropic.types.tool_choice_auto_param
+import anthropic.types.tool_choice_tool_param
+import anthropic.types.tool_param
+
+
+class SubmitInputArgs(TypedDict, total=False):
+    max_tokens: int
+    messages: Iterable[anthropic.types.message_param.MessageParam]
+    model: Union[
+        str,
+        Literal[
+            "claude-3-5-haiku-latest",
+            "claude-3-5-haiku-20241022",
+            "claude-3-5-sonnet-latest",
+            "claude-3-5-sonnet-20241022",
+            "claude-3-5-sonnet-20240620",
+            "claude-3-opus-latest",
+            "claude-3-opus-20240229",
+            "claude-3-sonnet-20240229",
+            "claude-3-haiku-20240307",
+            "claude-2.1",
+            "claude-2.0",
+        ],
+    ]
+    stop_sequences: Union[list[str], anthropic.NotGiven]
+    stream: Union[Literal[False], Literal[True], anthropic.NotGiven]
+    system: Union[
+        str,
+        Iterable[anthropic.types.text_block_param.TextBlockParam],
+        anthropic.NotGiven,
+    ]
+    temperature: float | anthropic.NotGiven
+    tool_choice: Union[
+        anthropic.types.tool_choice_auto_param.ToolChoiceAutoParam,
+        anthropic.types.tool_choice_any_param.ToolChoiceAnyParam,
+        anthropic.types.tool_choice_tool_param.ToolChoiceToolParam,
+        anthropic.NotGiven,
+    ]
+    tools: Union[Iterable[anthropic.types.tool_param.ToolParam], anthropic.NotGiven]
+    top_k: int | anthropic.NotGiven
+    top_p: float | anthropic.NotGiven
+    extra_headers: Optional[Mapping[str, Union[str, anthropic._types.Omit]]]
+    extra_query: Optional[Mapping[str, object]]
+    extra_body: object | None
+    timeout: float | anthropic.Timeout | None | anthropic.NotGiven

chatlas/types/google/__init__.py

@@ -0,0 +1,12 @@
+# ---------------------------------------------------------
+# Do not modify this file. It was generated by `scripts/generate_typed_dicts.py`.
+# ---------------------------------------------------------
+
+
+from ._client import ChatClientArgs
+from ._submit import SubmitInputArgs
+
+__all__ = (
+    "ChatClientArgs",
+    "SubmitInputArgs",
+)

chatlas/types/google/_client.py

@@ -0,0 +1,101 @@
+# ---------------------------------------------------------
+# Do not modify this file. It was generated by `scripts/generate_typed_dicts.py`.
+# ---------------------------------------------------------
+
+
+from typing import Any, Callable, Iterable, TypedDict, Union
+
+import google.ai.generativelanguage_v1beta.types.content
+import google.ai.generativelanguage_v1beta.types.file
+import google.ai.generativelanguage_v1beta.types.generative_service
+import google.generativeai.types.content_types
+import google.generativeai.types.file_types
+import google.generativeai.types.generation_types
+
+
+class ChatClientArgs(TypedDict, total=False):
+    model_name: str
+    generation_config: Union[
+        google.ai.generativelanguage_v1beta.types.generative_service.GenerationConfig,
+        google.generativeai.types.generation_types.GenerationConfigDict,
+        google.generativeai.types.generation_types.GenerationConfig,
+        None,
+    ]
+    tools: Union[
+        google.generativeai.types.content_types.FunctionLibrary,
+        Iterable[
+            Union[
+                str,
+                google.generativeai.types.content_types.Tool,
+                google.ai.generativelanguage_v1beta.types.content.Tool,
+                google.generativeai.types.content_types.ToolDict,
+                Iterable[
+                    Union[
+                        google.generativeai.types.content_types.FunctionDeclaration,
+                        google.ai.generativelanguage_v1beta.types.content.FunctionDeclaration,
+                        dict[str, Any],
+                        Callable[..., Any],
+                    ]
+                ],
+                google.generativeai.types.content_types.FunctionDeclaration,
+                google.ai.generativelanguage_v1beta.types.content.FunctionDeclaration,
+                dict[str, Any],
+                Callable[..., Any],
+            ]
+        ],
+        str,
+        google.generativeai.types.content_types.Tool,
+        google.ai.generativelanguage_v1beta.types.content.Tool,
+        google.generativeai.types.content_types.ToolDict,
+        Iterable[
+            Union[
+                google.generativeai.types.content_types.FunctionDeclaration,
+                google.ai.generativelanguage_v1beta.types.content.FunctionDeclaration,
+                dict[str, Any],
+                Callable[..., Any],
+            ]
+        ],
+        google.generativeai.types.content_types.FunctionDeclaration,
+        google.ai.generativelanguage_v1beta.types.content.FunctionDeclaration,
+        dict[str, Any],
+        Callable[..., Any],
+        None,
+    ]
+    tool_config: Union[
+        google.generativeai.types.content_types.ToolConfigDict,
+        google.ai.generativelanguage_v1beta.types.content.ToolConfig,
+        None,
+    ]
+    system_instruction: Union[
+        google.ai.generativelanguage_v1beta.types.content.Content,
+        google.generativeai.types.content_types.ContentDict,
+        Iterable[
+            Union[
+                google.ai.generativelanguage_v1beta.types.content.Part,
+                google.generativeai.types.content_types.PartDict,
+                google.ai.generativelanguage_v1beta.types.content.Blob,
+                google.generativeai.types.content_types.BlobDict,
+                Any,
+                str,
+                google.ai.generativelanguage_v1beta.types.content.FunctionCall,
+                google.ai.generativelanguage_v1beta.types.content.FunctionResponse,
+                google.generativeai.types.file_types.FileDataDict,
+                google.ai.generativelanguage_v1beta.types.content.FileData,
+                google.ai.generativelanguage_v1beta.types.file.File,
+                google.generativeai.types.file_types.File,
+            ]
+        ],
+        google.ai.generativelanguage_v1beta.types.content.Part,
+        google.generativeai.types.content_types.PartDict,
+        google.ai.generativelanguage_v1beta.types.content.Blob,
+        google.generativeai.types.content_types.BlobDict,
+        Any,
+        str,
+        google.ai.generativelanguage_v1beta.types.content.FunctionCall,
+        google.ai.generativelanguage_v1beta.types.content.FunctionResponse,
+        google.generativeai.types.file_types.FileDataDict,
+        google.ai.generativelanguage_v1beta.types.content.FileData,
+        google.ai.generativelanguage_v1beta.types.file.File,
+        google.generativeai.types.file_types.File,
+        None,
+    ]

chatlas/types/google/_submit.py

@@ -0,0 +1,113 @@
+# ---------------------------------------------------------
+# Do not modify this file. It was generated by `scripts/generate_typed_dicts.py`.
+# ---------------------------------------------------------
+
+
+from typing import Any, Callable, Iterable, TypedDict, Union
+
+import google.ai.generativelanguage_v1beta.types.content
+import google.ai.generativelanguage_v1beta.types.file
+import google.ai.generativelanguage_v1beta.types.generative_service
+import google.generativeai.types.content_types
+import google.generativeai.types.file_types
+import google.generativeai.types.generation_types
+import google.generativeai.types.helper_types
+
+
+class SubmitInputArgs(TypedDict, total=False):
+    contents: Union[
+        google.ai.generativelanguage_v1beta.types.content.Content,
+        google.generativeai.types.content_types.ContentDict,
+        Iterable[
+            Union[
+                google.ai.generativelanguage_v1beta.types.content.Part,
+                google.generativeai.types.content_types.PartDict,
+                google.ai.generativelanguage_v1beta.types.content.Blob,
+                google.generativeai.types.content_types.BlobDict,
+                Any,
+                str,
+                google.ai.generativelanguage_v1beta.types.content.FunctionCall,
+                google.ai.generativelanguage_v1beta.types.content.FunctionResponse,
+                google.generativeai.types.file_types.FileDataDict,
+                google.ai.generativelanguage_v1beta.types.content.FileData,
+                google.ai.generativelanguage_v1beta.types.file.File,
+                google.generativeai.types.file_types.File,
+            ]
+        ],
+        google.ai.generativelanguage_v1beta.types.content.Part,
+        google.generativeai.types.content_types.PartDict,
+        google.ai.generativelanguage_v1beta.types.content.Blob,
+        google.generativeai.types.content_types.BlobDict,
+        Any,
+        str,
+        google.ai.generativelanguage_v1beta.types.content.FunctionCall,
+        google.ai.generativelanguage_v1beta.types.content.FunctionResponse,
+        google.generativeai.types.file_types.FileDataDict,
+        google.ai.generativelanguage_v1beta.types.content.FileData,
+        google.ai.generativelanguage_v1beta.types.file.File,
+        google.generativeai.types.file_types.File,
+        Iterable[
+            Union[
+                google.ai.generativelanguage_v1beta.types.content.Content,
+                google.generativeai.types.content_types.ContentDict,
+            ]
+        ],
+        None,
+    ]
+    generation_config: Union[
+        google.ai.generativelanguage_v1beta.types.generative_service.GenerationConfig,
+        google.generativeai.types.generation_types.GenerationConfigDict,
+        google.generativeai.types.generation_types.GenerationConfig,
+        None,
+    ]
+    stream: bool
+    tools: Union[
+        google.generativeai.types.content_types.FunctionLibrary,
+        Iterable[
+            Union[
+                str,
+                google.generativeai.types.content_types.Tool,
+                google.ai.generativelanguage_v1beta.types.content.Tool,
+                google.generativeai.types.content_types.ToolDict,
+                Iterable[
+                    Union[
+                        google.generativeai.types.content_types.FunctionDeclaration,
+                        google.ai.generativelanguage_v1beta.types.content.FunctionDeclaration,
+                        dict[str, Any],
+                        Callable[..., Any],
+                    ]
+                ],
+                google.generativeai.types.content_types.FunctionDeclaration,
+                google.ai.generativelanguage_v1beta.types.content.FunctionDeclaration,
+                dict[str, Any],
+                Callable[..., Any],
+            ]
+        ],
+        str,
+        google.generativeai.types.content_types.Tool,
+        google.ai.generativelanguage_v1beta.types.content.Tool,
+        google.generativeai.types.content_types.ToolDict,
+        Iterable[
+            Union[
+                google.generativeai.types.content_types.FunctionDeclaration,
+                google.ai.generativelanguage_v1beta.types.content.FunctionDeclaration,
+                dict[str, Any],
+                Callable[..., Any],
+            ]
+        ],
+        google.generativeai.types.content_types.FunctionDeclaration,
+        google.ai.generativelanguage_v1beta.types.content.FunctionDeclaration,
+        dict[str, Any],
+        Callable[..., Any],
+        None,
+    ]
+    tool_config: Union[
+        google.generativeai.types.content_types.ToolConfigDict,
+        google.ai.generativelanguage_v1beta.types.content.ToolConfig,
+        None,
+    ]
+    request_options: Union[
+        google.generativeai.types.helper_types.RequestOptions,
+        google.generativeai.types.helper_types.RequestOptionsDict,
+        None,
+    ]

chatlas/types/openai/__init__.py

@@ -0,0 +1,14 @@
+# ---------------------------------------------------------
+# Do not modify this file. It was generated by `scripts/generate_typed_dicts.py`.
+# ---------------------------------------------------------
+
+
+from ._client import ChatClientArgs
+from ._client_azure import ChatAzureClientArgs
+from ._submit import SubmitInputArgs
+
+__all__ = (
+    "ChatClientArgs",
+    "ChatAzureClientArgs",
+    "SubmitInputArgs",
+)