feat(messages): add support for image inputs (anthropics#359)

Author: stainless-bot

README.md

@@ -35,10 +35,10 @@ message = client.messages.create(
     messages=[
         {
             "role": "user",
-            "content": "How does a court case get to the supreme court?",
+            "content": "Hello, Claude",
         }
     ],
-    model="claude-2.1",
+    model="claude-3-opus-20240229",
 )
 print(message.content)
 ```
@@ -69,10 +69,10 @@ async def main() -> None:
         messages=[
             {
                 "role": "user",
-                "content": "How does a court case get to the supreme court?",
+                "content": "Hello, Claude",
             }
         ],
-        model="claude-2.1",
+        model="claude-3-opus-20240229",
     )
     print(message.content)
 
@@ -96,10 +96,10 @@ stream = client.messages.create(
     messages=[
         {
             "role": "user",
-            "content": "your prompt here",
+            "content": "Hello, Claude",
         }
     ],
-    model="claude-2.1",
+    model="claude-3-opus-20240229",
     stream=True,
 )
 for event in stream:
@@ -118,10 +118,10 @@ stream = await client.messages.create(
     messages=[
         {
             "role": "user",
-            "content": "your prompt here",
+            "content": "Hello, Claude",
         }
     ],
-    model="claude-2.1",
+    model="claude-3-opus-20240229",
     stream=True,
 )
 async for event in stream:
@@ -147,7 +147,7 @@ async def main() -> None:
                 "content": "Say hello there!",
             }
         ],
-        model="claude-2.1",
+        model="claude-3-opus-20240229",
     ) as stream:
         async for text in stream.text_stream:
             print(text, end="", flush=True)
@@ -190,11 +190,12 @@ For a more fully fledged example see [`examples/bedrock.py`](https://github.com/
 
 ## Token counting
 
-You can estimate billing for a given request with the `client.count_tokens()` method, eg:
+You can see the exact usage for a given request through the `usage` response property, e.g.
 
 ```py
-client = Anthropic()
-client.count_tokens('Hello world!')  # 3
+message = client.messages.create(...)
+message.usage
+# Usage(input_tokens=25, output_tokens=13)
 ```
 
 ## Using types
@@ -227,10 +228,10 @@ try:
         messages=[
             {
                 "role": "user",
-                "content": "your prompt here",
+                "content": "Hello, Claude",
             }
         ],
-        model="claude-2.1",
+        model="claude-3-opus-20240229",
     )
 except anthropic.APIConnectionError as e:
     print("The server could not be reached")
@@ -279,10 +280,10 @@ client.with_options(max_retries=5).messages.create(
     messages=[
         {
             "role": "user",
-            "content": "Can you help me effectively ask for a raise at work?",
+            "content": "Hello, Claude",
         }
     ],
-    model="claude-2.1",
+    model="claude-3-opus-20240229",
 )
 ```
 
@@ -311,10 +312,10 @@ client.with_options(timeout=5 * 1000).messages.create(
     messages=[
         {
             "role": "user",
-            "content": "Where can I get a good coffee in my neighbourhood?",
+            "content": "Hello, Claude",
         }
     ],
-    model="claude-2.1",
+    model="claude-3-opus-20240229",
 )
 ```
 
@@ -374,9 +375,9 @@ response = client.messages.with_raw_response.create(
     max_tokens=1024,
     messages=[{
         "role": "user",
-        "content": "Where can I get a good coffee in my neighbourhood?",
+        "content": "Hello, Claude",
     }],
-    model="claude-2.1",
+    model="claude-3-opus-20240229",
 )
 print(response.headers.get('X-My-Header'))
 
@@ -407,10 +408,10 @@ with client.messages.with_streaming_response.create(
     messages=[
         {
             "role": "user",
-            "content": "Where can I get a good coffee in my neighbourhood?",
+            "content": "Hello, Claude",
         }
     ],
-    model="claude-2.1",
+    model="claude-3-opus-20240229",
 ) as response:
     print(response.headers.get("X-My-Header"))
 

api.md

@@ -1,21 +1,3 @@
-# Anthropic
-
-Methods:
-
-- <code>client.<a href="./src/anthropic/_client.py">count_tokens</a>(\*args) -> int</code>
-
-# Completions
-
-Types:
-
-```python
-from anthropic.types import Completion
-```
-
-Methods:
-
-- <code title="post /v1/complete">client.completions.<a href="./src/anthropic/resources/completions.py">create</a>(\*\*<a href="src/anthropic/types/completion_create_params.py">params</a>) -> <a href="./src/anthropic/types/completion.py">Completion</a></code>
-
 # Messages
 
 Types:
@@ -26,6 +8,7 @@ from anthropic.types import (
     ContentBlockDeltaEvent,
     ContentBlockStartEvent,
     ContentBlockStopEvent,
+    ImageBlockParam,
     Message,
     MessageDeltaEvent,
     MessageDeltaUsage,

examples/images.py

@@ -0,0 +1,30 @@
+from pathlib import Path
+
+from anthropic import Anthropic
+
+client = Anthropic()
+
+response = client.messages.create(
+    max_tokens=1024,
+    messages=[
+        {
+            "role": "user",
+            "content": [
+                {
+                    "type": "text",
+                    "text": "Hello!",
+                },
+                {
+                    "type": "image",
+                    "source": {
+                        "type": "base64",
+                        "media_type": "image/png",
+                        "data": Path(__file__).parent.joinpath("logo.png"),
+                    },
+                },
+            ],
+        },
+    ],
+    model="claude-3-opus-20240229",
+)
+print(response.model_dump_json(indent=2))

examples/logo.png

@@ -10,7 +10,7 @@
             "content": "Hello!",
         }
     ],
-    model="claude-2.1",
+    model="claude-3-opus-20240229",
 )
 print(response)
 
@@ -30,6 +30,6 @@
             "content": "How are you?",
         },
     ],
-    model="claude-2.1",
+    model="claude-3-opus-20240229",
 )
 print(response2)

examples/messages.py

@@ -14,7 +14,7 @@ async def main() -> None:
                 "content": "Say hello there!",
             }
         ],
-        model="claude-2.1",
+        model="claude-3-opus-20240229",
     ) as stream:
         async for text in stream.text_stream:
             print(text, end="", flush=True)

examples/messages_stream.py

@@ -22,7 +22,7 @@ async def main() -> None:
                 "content": "Say hello there!",
             }
         ],
-        model="claude-2.1",
+        model="claude-3-opus-20240229",
         event_handler=MyStream,
     ) as stream:
         accumulated = await stream.get_final_message()

examples/messages_stream_handler.py

@@ -0,0 +1,20 @@
+#!/usr/bin/env -S poetry run python
+
+import asyncio
+
+import anthropic
+from anthropic import AsyncAnthropic
+
+
+async def main() -> None:
+    client = AsyncAnthropic()
+
+    res = await client.completions.create(
+        model="claude-2.1",
+        prompt=f"{anthropic.HUMAN_PROMPT} how does a court case get to the Supreme Court? {anthropic.AI_PROMPT}",
+        max_tokens_to_sample=1000,
+    )
+    print(res.completion)
+
+
+asyncio.run(main())

examples/text_completions_demo_async.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env -S poetry run python
+
+import anthropic
+from anthropic import Anthropic
+
+
+def main() -> None:
+    client = Anthropic()
+
+    res = client.completions.create(
+        model="claude-2.1",
+        prompt=f"{anthropic.HUMAN_PROMPT} how does a court case get to the Supreme Court? {anthropic.AI_PROMPT}",
+        max_tokens_to_sample=1000,
+    )
+    print(res.completion)
+
+
+main()

examples/text_completions_demo_sync.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env -S poetry run python
+
+import asyncio
+
+from anthropic import AI_PROMPT, HUMAN_PROMPT, Anthropic, APIStatusError, AsyncAnthropic
+
+client = Anthropic()
+async_client = AsyncAnthropic()
+
+question = """
+Hey Claude! How can I recursively list all files in a directory in Python?
+"""
+
+
+def sync_stream() -> None:
+    stream = client.completions.create(
+        prompt=f"{HUMAN_PROMPT} {question}{AI_PROMPT}",
+        model="claude-2.1",
+        stream=True,
+        max_tokens_to_sample=300,
+    )
+
+    for completion in stream:
+        print(completion.completion, end="", flush=True)
+
+    print()
+
+
+async def async_stream() -> None:
+    stream = await async_client.completions.create(
+        prompt=f"{HUMAN_PROMPT} {question}{AI_PROMPT}",
+        model="claude-2.1",
+        stream=True,
+        max_tokens_to_sample=300,
+    )
+
+    async for completion in stream:
+        print(completion.completion, end="", flush=True)
+
+    print()
+
+
+def stream_error() -> None:
+    try:
+        client.completions.create(
+            prompt=f"{HUMAN_PROMPT} {question}{AI_PROMPT}",
+            model="claude-unknown-model",
+            stream=True,
+            max_tokens_to_sample=300,
+        )
+    except APIStatusError as err:
+        print(f"Caught API status error with response body: {err.response.text}")
+
+
+sync_stream()
+asyncio.run(async_stream())
+stream_error()

examples/text_completions_streaming.py

@@ -11,7 +11,7 @@ async with client.messages.stream(
             "content": "Say hello there!",
         }
     ],
-    model="claude-2.1",
+    model="claude-3-opus-20240229",
 ) as stream:
     async for text in stream.text_stream:
         print(text, end="", flush=True)
@@ -74,7 +74,7 @@ async def main() -> None:
                 "content": "Say hello there!",
             }
         ],
-        model="claude-2.1",
+        model="claude-3-opus-20240229",
         event_handler=MyStream,
     ) as stream:
         message = await stream.get_final_message()

helpers.md

@@ -267,7 +267,12 @@ def count_tokens(
         self,
         text: str,
     ) -> int:
-        """Count the number of tokens in a given string"""
+        """Count the number of tokens in a given string.
+
+        Note that this is only accurate for older models, e.g. `claude-2.1`. For newer
+        models this can only be used as a _very_ rough estimate, instead you should rely
+        on the `usage` property in the response for exact counts.
+        """
         # Note: tokenizer is untyped
         tokenizer = self.get_tokenizer()
         encoded_text = tokenizer.encode(text)  # type: ignore
@@ -522,7 +527,12 @@ async def count_tokens(
         self,
         text: str,
     ) -> int:
-        """Count the number of tokens in a given string"""
+        """Count the number of tokens in a given string.
+
+        Note that this is only accurate for older models, e.g. `claude-2.1`. For newer
+        models this can only be used as a _very_ rough estimate, instead you should rely
+        on the `usage` property in the response for exact counts.
+        """
         # Note: tokenizer is untyped
         tokenizer = await self.get_tokenizer()
         encoded_text = tokenizer.encode(text)  # type: ignore

src/anthropic/_client.py

@@ -421,7 +421,8 @@ def accumulate_event(*, event: MessageStreamEvent, current_snapshot: Message | N
         )
     elif event.type == "content_block_delta":
         content = current_snapshot.content[event.index]
-        content.text += event.delta.text
+        if content.type == "text" and event.delta.type == "text_delta":
+            content.text += event.delta.text
     elif event.type == "message_delta":
         current_snapshot.stop_reason = event.delta.stop_reason
         current_snapshot.stop_sequence = event.delta.stop_sequence