chatlas 0.3.0__tar.gz → 0.5.0__tar.gz

{chatlas-0.3.0 → chatlas-0.5.0}/.github/workflows/check-update-types.yml

@@ -36,7 +36,12 @@ jobs:
       # Fail if there are changes under chatlas/types and throw a useful error message
       - name: Check for changes
         run: |
+          echo "Checking for changes in types..."
+          git status chatlas/types
+          git diff --stat chatlas/types
           if [[ -n $(git diff chatlas/types) ]]; then
+            echo "Changes detected:"
+            git diff chatlas/types
             echo "::error::Types are out of date. Please run 'make update-types' and commit the changes."
             exit 1
           fi

{chatlas-0.3.0 → chatlas-0.5.0}/.github/workflows/test.yml

@@ -50,6 +50,7 @@ jobs:
         run: make check-tests
 
       - name: 📝 Check types
+        if: ${{ matrix.config.python-version != '3.9' }}
         run: make check-types
 
       - name: 📐 Check formatting

{chatlas-0.3.0 → chatlas-0.5.0}/.gitignore

@@ -12,3 +12,6 @@ sandbox/
 
 # Automatically generated by docs/index.py
 docs/index.qmd
+
+# setuptools_scm
+chatlas/_version.py

chatlas-0.5.0/CHANGELOG.md

@@ -0,0 +1,62 @@
+# Changelog
+
+<!--
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+-->
+
+## [0.5.0] - 2025-03-18
+
+### New features
+
+* Added a `ChatSnowflake()` class to interact with [Snowflake Cortex LLM](https://docs.snowflake.com/en/user-guide/snowflake-cortex/llm-functions). (#54)
+* Added a `ChatAuto()` class, allowing for configuration of chat providers and models via environment variables. (#38, thanks @mconflitti-pbc)
+
+### Improvements
+
+* Updated `ChatAnthropic()`'s `model` default to `"claude-3-7-sonnet-latest"`. (#62)
+* The version is now accessible as `chatlas.__version__`. (#64)
+* All provider-specific `Chat` subclasses now have an associated extras in chatlas. For example, `ChatOpenAI` has `chatlas[openai]`, `ChatPerplexity` has `chatlas[perplexity]`, `ChatBedrockAnthropic` has `chatlas[bedrock-anthropic]`, and so forth for the other `Chat` classes. (#66)
+
+### Bug fixes
+
+* Fixed an issue with content getting duplicated when it overflows in a `Live()` console. (#71)
+* Fix an issue with tool calls not working with `ChatVertex()`. (#61)
+
+
+## [0.4.0] - 2025-02-19
+
+### New features
+
+* Added a `ChatVertex()` class to interact with Google Cloud's Vertex AI. (#50)
+* Added `.app(*, echo=)` support. This allows for chatlas to change the echo behavior when running the Shiny app. (#31)
+
+### Improvements
+
+* Migrated `ChatGoogle()`'s underlying python SDK from `google-generative` to `google-genai`. As a result, streaming tools are now working properly. (#50)
+
+### Bug fixes
+
+* Fixed a bug where synchronous chat tools would not work properly when used in a `_async()` context. (#56)
+* Fix broken `Chat`'s Shiny app when `.app(*, stream=True)` by using async chat tools. (#31)
+* Update formatting of exported markdown to use `repr()` instead of `str()` when exporting tool call results. (#30)
+
+## [0.3.0] - 2024-12-20
+
+### New features
+
+* `Chat`'s `.tokens()` method gains a `values` argument. Set it to `"discrete"` to get a result that can be summed to determine the token cost of submitting the current turns. The default (`"cumulative"`), remains the same (the result can be summed to determine the overall token cost of the conversation).
+* `Chat` gains a `.token_count()` method to help estimate token cost of new input. (#23)
+
+### Bug fixes
+
+* `ChatOllama` no longer fails when a `OPENAI_API_KEY` environment variable is not set.
+* `ChatOpenAI` now correctly includes the relevant `detail` on `ContentImageRemote()` input.
+* `ChatGoogle` now correctly logs its `token_usage()`. (#23)
+
+
+## [0.2.0] - 2024-12-11
+
+First stable release of `chatlas`, see the website to learn more <https://posit-dev.github.io/chatlas/>

{chatlas-0.3.0 → chatlas-0.5.0}/Makefile

@@ -9,7 +9,7 @@ build:   ## [py] Build python package
 	uv build
 
 .PHONY: check
-check:  check-tests check-format check-types ## [py] Run python checks
+check: check-format check-types check-tests ## [py] Run python checks
 
 .PHONY: check-tests
 check-tests:  ## [py] Run python tests

{chatlas-0.3.0 → chatlas-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chatlas
-Version: 0.3.0
+Version: 0.5.0
 Summary: A simple and consistent interface for chatting with LLMs
 Project-URL: Homepage, https://posit-dev.github.io/chatlas
 Project-URL: Documentation, https://posit-dev.github.io/chatlas
@@ -20,9 +20,15 @@ Requires-Python: >=3.9
 Requires-Dist: jinja2
 Requires-Dist: pydantic>=2.0
 Requires-Dist: rich
+Provides-Extra: anthropic
+Requires-Dist: anthropic; extra == 'anthropic'
+Provides-Extra: azure-openai
+Requires-Dist: openai; extra == 'azure-openai'
+Provides-Extra: bedrock-anthropic
+Requires-Dist: anthropic[bedrock]; extra == 'bedrock-anthropic'
 Provides-Extra: dev
 Requires-Dist: anthropic[bedrock]; extra == 'dev'
-Requires-Dist: google-generativeai>=0.8.3; extra == 'dev'
+Requires-Dist: google-genai>=1.2.0; extra == 'dev'
 Requires-Dist: matplotlib; extra == 'dev'
 Requires-Dist: numpy>1.24.4; extra == 'dev'
 Requires-Dist: openai; extra == 'dev'
@@ -30,7 +36,9 @@ Requires-Dist: pillow; extra == 'dev'
 Requires-Dist: python-dotenv; extra == 'dev'
 Requires-Dist: ruff>=0.6.5; extra == 'dev'
 Requires-Dist: shiny; extra == 'dev'
+Requires-Dist: snowflake-ml-python; extra == 'dev'
 Requires-Dist: tiktoken; extra == 'dev'
+Requires-Dist: torch; (python_version <= '3.11') and extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: griffe>=1; extra == 'docs'
 Requires-Dist: ipykernel; extra == 'docs'
@@ -42,14 +50,32 @@ Requires-Dist: pandas; extra == 'docs'
 Requires-Dist: pyyaml; extra == 'docs'
 Requires-Dist: quartodoc>=0.7; extra == 'docs'
 Requires-Dist: sentence-transformers; extra == 'docs'
+Provides-Extra: github
+Requires-Dist: openai; extra == 'github'
+Provides-Extra: google
+Requires-Dist: google-genai; extra == 'google'
+Provides-Extra: groq
+Requires-Dist: openai; extra == 'groq'
+Provides-Extra: ollama
+Requires-Dist: openai; extra == 'ollama'
+Provides-Extra: openai
+Requires-Dist: openai; extra == 'openai'
+Provides-Extra: perplexity
+Requires-Dist: openai; extra == 'perplexity'
+Provides-Extra: snowflake
+Requires-Dist: snowflake-ml-python; extra == 'snowflake'
 Provides-Extra: test
 Requires-Dist: pyright>=1.1.379; extra == 'test'
 Requires-Dist: pytest-asyncio; extra == 'test'
 Requires-Dist: pytest>=8.3.2; extra == 'test'
 Requires-Dist: syrupy>=4; extra == 'test'
+Provides-Extra: vertex
+Requires-Dist: google-genai; extra == 'vertex'
 Description-Content-Type: text/markdown
 
-# chatlas
+<h1 class="unnumbered unlisted"> chatlas <a href="https://posit-dev.github.io/chatlas"><img src="docs/images/logo.png" align="right" height="138" alt="chatlas website" /></a> </h1> 
+
+
 
 <p>
 <!-- badges start -->
@@ -60,11 +86,11 @@ Description-Content-Type: text/markdown
 </p>
 
 chatlas provides a simple and unified interface across large language model (llm) providers in Python. 
-It abstracts away complexity from common tasks like streaming chat interfaces, tool calling, structured output, and much more.
-chatlas helps you prototype faster without painting you into a corner; for example, switching providers is as easy as changing one line of code, but provider specific features are still accessible when needed.
-Developer experience is also a key focus of chatlas: typing support, rich console output, and built-in tooling are all included.
+It helps you prototype faster by abstracting away complexity from common tasks like streaming chat interfaces, tool calling, structured output, and much more.
+Switching providers is also as easy as changing one line of code, but you can also reach for provider-specific features when you need them.
+Developer experience is also a key focus of chatlas: typing support, rich console output, and extension points are all included.
 
-(Looking for something similar to chatlas, but in R? Check out [elmer](https://elmer.tidyverse.org/)!)
+(Looking for something similar to chatlas, but in R? Check out [ellmer](https://ellmer.tidyverse.org/)!)
 
 ## Install
 
@@ -96,6 +122,8 @@ It also supports the following enterprise cloud providers:
 
 * AWS Bedrock: [`ChatBedrockAnthropic()`](https://posit-dev.github.io/chatlas/reference/ChatBedrockAnthropic.html).
 * Azure OpenAI: [`ChatAzureOpenAI()`](https://posit-dev.github.io/chatlas/reference/ChatAzureOpenAI.html).
+* Snowflake Cortex: [`ChatSnowflake()`](https://posit-dev.github.io/chatlas/reference/ChatSnowflake.html).
+* Vertex AI: [`ChatVertex()`](https://posit-dev.github.io/chatlas/reference/ChatVertex.html).
 
 To use a model provider that isn't listed here, you have two options:
 

{chatlas-0.3.0 → chatlas-0.5.0}/README.md

@@ -1,4 +1,6 @@
-# chatlas
+<h1 class="unnumbered unlisted"> chatlas <a href="https://posit-dev.github.io/chatlas"><img src="docs/images/logo.png" align="right" height="138" alt="chatlas website" /></a> </h1> 
+
+
 
 <p>
 <!-- badges start -->
@@ -9,11 +11,11 @@
 </p>
 
 chatlas provides a simple and unified interface across large language model (llm) providers in Python. 
-It abstracts away complexity from common tasks like streaming chat interfaces, tool calling, structured output, and much more.
-chatlas helps you prototype faster without painting you into a corner; for example, switching providers is as easy as changing one line of code, but provider specific features are still accessible when needed.
-Developer experience is also a key focus of chatlas: typing support, rich console output, and built-in tooling are all included.
+It helps you prototype faster by abstracting away complexity from common tasks like streaming chat interfaces, tool calling, structured output, and much more.
+Switching providers is also as easy as changing one line of code, but you can also reach for provider-specific features when you need them.
+Developer experience is also a key focus of chatlas: typing support, rich console output, and extension points are all included.
 
-(Looking for something similar to chatlas, but in R? Check out [elmer](https://elmer.tidyverse.org/)!)
+(Looking for something similar to chatlas, but in R? Check out [ellmer](https://ellmer.tidyverse.org/)!)
 
 ## Install
 
@@ -45,6 +47,8 @@ It also supports the following enterprise cloud providers:
 
 * AWS Bedrock: [`ChatBedrockAnthropic()`](https://posit-dev.github.io/chatlas/reference/ChatBedrockAnthropic.html).
 * Azure OpenAI: [`ChatAzureOpenAI()`](https://posit-dev.github.io/chatlas/reference/ChatAzureOpenAI.html).
+* Snowflake Cortex: [`ChatSnowflake()`](https://posit-dev.github.io/chatlas/reference/ChatSnowflake.html).
+* Vertex AI: [`ChatVertex()`](https://posit-dev.github.io/chatlas/reference/ChatVertex.html).
 
 To use a model provider that isn't listed here, you have two options:
 

{chatlas-0.3.0 → chatlas-0.5.0}/chatlas/__init__.py

@@ -1,21 +1,29 @@
 from . import types
 from ._anthropic import ChatAnthropic, ChatBedrockAnthropic
+from ._auto import ChatAuto
 from ._chat import Chat
 from ._content_image import content_image_file, content_image_plot, content_image_url
 from ._github import ChatGithub
-from ._google import ChatGoogle
+from ._google import ChatGoogle, ChatVertex
 from ._groq import ChatGroq
 from ._interpolate import interpolate, interpolate_file
 from ._ollama import ChatOllama
 from ._openai import ChatAzureOpenAI, ChatOpenAI
 from ._perplexity import ChatPerplexity
 from ._provider import Provider
+from ._snowflake import ChatSnowflake
 from ._tokens import token_usage
 from ._tools import Tool
 from ._turn import Turn
 
+try:
+    from ._version import version as __version__
+except ImportError:  # pragma: no cover
+    __version__ = "0.0.0"  # stub value for docs
+
 __all__ = (
     "ChatAnthropic",
+    "ChatAuto",
     "ChatBedrockAnthropic",
     "ChatGithub",
     "ChatGoogle",
@@ -24,6 +32,8 @@ __all__ = (
     "ChatOpenAI",
     "ChatAzureOpenAI",
     "ChatPerplexity",
+    "ChatSnowflake",
+    "ChatVertex",
     "Chat",
     "content_image_file",
     "content_image_plot",

{chatlas-0.3.0 → chatlas-0.5.0}/chatlas/_anthropic.py

@@ -72,7 +72,7 @@ def ChatAnthropic(
     ::: {.callout-note}
     ## API key
 
-    Note that a Claude Prop membership does not give you the ability to call
+    Note that a Claude Pro membership does not give you the ability to call
     models via the API. You will need to go to the [developer
     console](https://console.anthropic.com/account/keys) to sign up (and pay
     for) a developer account that will give you an API key that you can use with
@@ -82,7 +82,7 @@ def ChatAnthropic(
     ::: {.callout-note}
     ## Python requirements
 
-    `ChatAnthropic` requires the `anthropic` package (e.g., `pip install anthropic`).
+    `ChatAnthropic` requires the `anthropic` package: `pip install "chatlas[anthropic]"`.
     :::
 
     Examples
@@ -164,7 +164,7 @@ def ChatAnthropic(
     """
 
     if model is None:
-        model = log_model_default("claude-3-5-sonnet-latest")
+        model = log_model_default("claude-3-7-sonnet-latest")
 
     return Chat(
         provider=AnthropicProvider(
@@ -311,7 +311,8 @@ class AnthropicProvider(Provider[Message, RawMessageStreamEvent, Message]):
             if stream:
                 stream = False
                 warnings.warn(
-                    "Anthropic does not support structured data extraction in streaming mode."
+                    "Anthropic does not support structured data extraction in streaming mode.",
+                    stacklevel=2,
                 )
 
         kwargs_full: "SubmitInputArgs" = {
@@ -371,10 +372,7 @@ class AnthropicProvider(Provider[Message, RawMessageStreamEvent, Message]):
 
         return completion
 
-    def stream_turn(self, completion, has_data_model, stream) -> Turn:
-        return self._as_turn(completion, has_data_model)
-
-    async def stream_turn_async(self, completion, has_data_model, stream) -> Turn:
+    def stream_turn(self, completion, has_data_model) -> Turn:
         return self._as_turn(completion, has_data_model)
 
     def value_turn(self, completion, has_data_model) -> Turn:
@@ -574,8 +572,8 @@ def ChatBedrockAnthropic(
     ::: {.callout-note}
     ## Python requirements
 
-    `ChatBedrockAnthropic`, requires the `anthropic` package with the `bedrock` extras
-    (e.g., `pip install anthropic[bedrock]`).
+    `ChatBedrockAnthropic`, requires the `anthropic` package with the `bedrock` extras:
+    `pip install "chatlas[bedrock-anthropic]"`
     :::
 
     Examples

chatlas-0.5.0/chatlas/_auto.py

@@ -0,0 +1,183 @@
+from __future__ import annotations
+
+import json
+import os
+from typing import Callable, Literal, Optional
+
+from ._anthropic import ChatAnthropic, ChatBedrockAnthropic
+from ._chat import Chat
+from ._github import ChatGithub
+from ._google import ChatGoogle, ChatVertex
+from ._groq import ChatGroq
+from ._ollama import ChatOllama
+from ._openai import ChatAzureOpenAI, ChatOpenAI
+from ._perplexity import ChatPerplexity
+from ._snowflake import ChatSnowflake
+from ._turn import Turn
+
+AutoProviders = Literal[
+    "anthropic",
+    "bedrock-anthropic",
+    "github",
+    "google",
+    "groq",
+    "ollama",
+    "openai",
+    "azure-openai",
+    "perplexity",
+    "snowflake",
+    "vertex",
+]
+
+_provider_chat_model_map: dict[AutoProviders, Callable[..., Chat]] = {
+    "anthropic": ChatAnthropic,
+    "bedrock-anthropic": ChatBedrockAnthropic,
+    "github": ChatGithub,
+    "google": ChatGoogle,
+    "groq": ChatGroq,
+    "ollama": ChatOllama,
+    "openai": ChatOpenAI,
+    "azure-openai": ChatAzureOpenAI,
+    "perplexity": ChatPerplexity,
+    "snowflake": ChatSnowflake,
+    "vertex": ChatVertex,
+}
+
+
+def ChatAuto(
+    system_prompt: Optional[str] = None,
+    turns: Optional[list[Turn]] = None,
+    *,
+    provider: Optional[AutoProviders] = None,
+    model: Optional[str] = None,
+    **kwargs,
+) -> Chat:
+    """
+    Use environment variables (env vars) to configure the Chat provider and model.
+
+    Creates a `:class:~chatlas.Chat` instance based on the specified provider.
+    The provider may be specified through the `provider` parameter and/or the
+    `CHATLAS_CHAT_PROVIDER` env var. If both are set, the env var takes
+    precedence. Similarly, the provider's model may be specified through the
+    `model` parameter and/or the `CHATLAS_CHAT_MODEL` env var. Also, additional
+    configuration may be provided through the `kwargs` parameter and/or the
+    `CHATLAS_CHAT_ARGS` env var (as a JSON string). In this case, when both are
+    set, they are merged, with the env var arguments taking precedence.
+
+    As a result, `ChatAuto()` provides a convenient way to set a default
+    provider and model in your Python code, while allowing you to override
+    these settings through env vars (i.e., without modifying your code).
+
+    Prerequisites
+    -------------
+
+    ::: {.callout-note}
+    ## API key
+
+    Follow the instructions for the specific provider to obtain an API key.
+    :::
+
+    ::: {.callout-note}
+    ## Python requirements
+
+    Follow the instructions for the specific provider to install the required
+    Python packages.
+    :::
+
+
+    Examples
+    --------
+    First, set the environment variables for the provider, arguments, and API key:
+
+    ```bash
+    export CHATLAS_CHAT_PROVIDER=anthropic
+    export CHATLAS_CHAT_MODEL=claude-3-haiku-20240229
+    export CHATLAS_CHAT_ARGS='{"kwargs": {"max_retries": 3}}'
+    export ANTHROPIC_API_KEY=your_api_key
+    ```
+
+    Then, you can use the `ChatAuto` function to create a Chat instance:
+
+    ```python
+    from chatlas import ChatAuto
+
+    chat = ChatAuto()
+    chat.chat("What is the capital of France?")
+    ```
+
+    Parameters
+    ----------
+    provider
+        The name of the default chat provider to use. Providers are strings
+        formatted in kebab-case, e.g. to use `ChatBedrockAnthropic` set
+        `provider="bedrock-anthropic"`.
+
+        This value can also be provided via the `CHATLAS_CHAT_PROVIDER`
+        environment variable, which takes precedence over `provider`
+        when set.
+    model
+        The name of the default model to use. This value can also be provided
+        via the `CHATLAS_CHAT_MODEL` environment variable, which takes
+        precedence over `model` when set.
+    system_prompt
+        A system prompt to set the behavior of the assistant.
+    turns
+        A list of turns to start the chat with (i.e., continuing a previous
+        conversation). If not provided, the conversation begins from scratch. Do
+        not provide non-`None` values for both `turns` and `system_prompt`. Each
+        message in the list should be a dictionary with at least `role` (usually
+        `system`, `user`, or `assistant`, but `tool` is also possible). Normally
+        there is also a `content` field, which is a string.
+    **kwargs
+        Additional keyword arguments to pass to the Chat constructor. See the
+        documentation for each provider for more details on the available
+        options.
+
+        These arguments can also be provided via the `CHATLAS_CHAT_ARGS`
+        environment variable as a JSON string. When provided, the options
+        in the `CHATLAS_CHAT_ARGS` envvar take precedence over the options
+        passed to `kwargs`.
+
+        Note that `system_prompt` and `turns` in `kwargs` or in
+        `CHATLAS_CHAT_ARGS` are ignored.
+
+    Returns
+    -------
+    Chat
+        A chat instance using the specified provider.
+
+    Raises
+    ------
+    ValueError
+        If no valid provider is specified either through parameters or
+        environment variables.
+    """
+    the_provider = os.environ.get("CHATLAS_CHAT_PROVIDER", provider)
+
+    if the_provider is None:
+        raise ValueError(
+            "Provider name is required as parameter or `CHATLAS_CHAT_PROVIDER` must be set."
+        )
+    if the_provider not in _provider_chat_model_map:
+        raise ValueError(
+            f"Provider name '{the_provider}' is not a known chatlas provider: "
+            f"{', '.join(_provider_chat_model_map.keys())}"
+        )
+
+    # `system_prompt` and `turns` always come from `ChatAuto()`
+    base_args = {"system_prompt": system_prompt, "turns": turns}
+
+    if env_model := os.environ.get("CHATLAS_CHAT_MODEL"):
+        model = env_model
+
+    if model:
+        base_args["model"] = model
+
+    env_kwargs = {}
+    if env_kwargs_str := os.environ.get("CHATLAS_CHAT_ARGS"):
+        env_kwargs = json.loads(env_kwargs_str)
+
+    kwargs = {**kwargs, **env_kwargs, **base_args}
+    kwargs = {k: v for k, v in kwargs.items() if v is not None}
+
+    return _provider_chat_model_map[the_provider](**kwargs)