release: 0.11.0

.github/workflows/create-releases.yml

@@ -1,5 +1,7 @@
 name: Create releases
 on:
+  schedule:
+    - cron: '0 5 * * *' # every day at 5am UTC
   push:
     branches:
       - main

.prettierrc.json

@@ -0,0 +1,7 @@
+{
+  "arrowParens": "always",
+  "experimentalTernaries": true,
+  "printWidth": 110,
+  "singleQuote": true,
+  "trailingComma": "all"
+}

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.10.2"
+  ".": "0.11.0"
 }

.stats.yml

@@ -1 +1 @@
-configured_endpoints: 1
+configured_endpoints: 2

CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## 0.11.0 (2023-12-19)
+
+Full Changelog: [v0.10.2...v0.11.0](https://github.com/anthropics/anthropic-sdk-typescript/compare/v0.10.2...v0.11.0)
+
+### Features
+
+* **api:** add messages endpoint with streaming helpers ([#235](https://github.com/anthropics/anthropic-sdk-typescript/issues/235)) ([12b914f](https://github.com/anthropics/anthropic-sdk-typescript/commit/12b914f46f4aa625ff141ec0b6631400d0994f76))
+* **client:** support reading the base url from an env variable ([#223](https://github.com/anthropics/anthropic-sdk-typescript/issues/223)) ([5bc3600](https://github.com/anthropics/anthropic-sdk-typescript/commit/5bc3600a487e7ed49d944aaf36a43e0d895e907b))
+
+
+### Chores
+
+* **ci:** run release workflow once per day ([#232](https://github.com/anthropics/anthropic-sdk-typescript/issues/232)) ([115479f](https://github.com/anthropics/anthropic-sdk-typescript/commit/115479f403838a6d2c81587220029b68a4371c02))
+* **deps:** update dependency ts-jest to v29.1.1 ([#233](https://github.com/anthropics/anthropic-sdk-typescript/issues/233)) ([bec6ab1](https://github.com/anthropics/anthropic-sdk-typescript/commit/bec6ab127d9b20071ab673e8e37087a879467b74))
+* **deps:** update jest ([#234](https://github.com/anthropics/anthropic-sdk-typescript/issues/234)) ([5506174](https://github.com/anthropics/anthropic-sdk-typescript/commit/5506174092d5248354f3d288c84da5ba4749375c))
+* update dependencies ([#231](https://github.com/anthropics/anthropic-sdk-typescript/issues/231)) ([4e34536](https://github.com/anthropics/anthropic-sdk-typescript/commit/4e345362c9002528fb0d95ca739fb8211ab3aec8))
+* update prettier ([#230](https://github.com/anthropics/anthropic-sdk-typescript/issues/230)) ([173603e](https://github.com/anthropics/anthropic-sdk-typescript/commit/173603e14fc5fe87c056553ecec3278059fe58d9))
+
+
+### Documentation
+
+* update examples to show claude-2.1 ([#227](https://github.com/anthropics/anthropic-sdk-typescript/issues/227)) ([4b00d84](https://github.com/anthropics/anthropic-sdk-typescript/commit/4b00d84aee56090b5d576fdff9c3a07386475c72))
+
+
+### Build System
+
+* specify `packageManager: yarn` ([#229](https://github.com/anthropics/anthropic-sdk-typescript/issues/229)) ([d31dae4](https://github.com/anthropics/anthropic-sdk-typescript/commit/d31dae455d750a61ae3b9a751ab73309b0f87417))
+
 ## 0.10.2 (2023-11-28)
 
 Full Changelog: [v0.10.1...v0.10.2](https://github.com/anthropics/anthropic-sdk-typescript/compare/v0.10.1...v0.10.2)

README.md

@@ -103,7 +103,7 @@ const anthropic = new Anthropic({
 
 async function main() {
   const completion = await anthropic.completions.create({
-    model: 'claude-2',
+    model: 'claude-2.1',
     max_tokens_to_sample: 300,
     prompt: `${Anthropic.HUMAN_PROMPT} how does a court case get to the Supreme Court?${Anthropic.AI_PROMPT}`,
   });
@@ -123,7 +123,7 @@ const anthropic = new Anthropic();
 
 const stream = await anthropic.completions.create({
   prompt: `${Anthropic.HUMAN_PROMPT} Your prompt here${Anthropic.AI_PROMPT}`,
-  model: 'claude-2',
+  model: 'claude-2.1',
   stream: true,
   max_tokens_to_sample: 300,
 });
@@ -150,7 +150,7 @@ async function main() {
   const params: Anthropic.CompletionCreateParams = {
     prompt: `${Anthropic.HUMAN_PROMPT} how does a court case get to the Supreme Court?${Anthropic.AI_PROMPT}`,
     max_tokens_to_sample: 300,
-    model: 'claude-2',
+    model: 'claude-2.1',
   };
   const completion: Anthropic.Completion = await anthropic.completions.create(params);
 }
@@ -178,7 +178,7 @@ async function main() {
     .create({
       prompt: `${Anthropic.HUMAN_PROMPT} Your prompt here${Anthropic.AI_PROMPT}`,
       max_tokens_to_sample: 300,
-      model: 'claude-2',
+      model: 'claude-2.1',
     })
     .catch((err) => {
       if (err instanceof Anthropic.APIError) {
@@ -227,7 +227,7 @@ await anthropic.completions.create(
   {
     prompt: `${Anthropic.HUMAN_PROMPT} Can you help me effectively ask for a raise at work?${Anthropic.AI_PROMPT}`,
     max_tokens_to_sample: 300,
-    model: 'claude-2',
+    model: 'claude-2.1',
   },
   {
     maxRetries: 5,
@@ -251,7 +251,7 @@ await anthropic.completions.create(
   {
     prompt: `${Anthropic.HUMAN_PROMPT} Where can I get a good coffee in my neighbourhood?${Anthropic.AI_PROMPT}`,
     max_tokens_to_sample: 300,
-    model: 'claude-2',
+    model: 'claude-2.1',
   },
   {
     timeout: 5 * 1000,
@@ -279,7 +279,7 @@ const anthropic = new Anthropic();
 const completion = await anthropic.completions.create(
   {
     max_tokens_to_sample: 300,
-    model: 'claude-2',
+    model: 'claude-2.1',
     prompt: `${Anthropic.HUMAN_PROMPT} Where can I get a good coffee in my neighbourhood?${Anthropic.AI_PROMPT}`,
   },
   { headers: { 'anthropic-version': 'My-Custom-Value' } },
@@ -301,7 +301,7 @@ const response = await anthropic.completions
   .create({
     prompt: `${Anthropic.HUMAN_PROMPT} Can you help me effectively ask for a raise at work?${Anthropic.AI_PROMPT}`,
     max_tokens_to_sample: 300,
-    model: 'claude-2',
+    model: 'claude-2.1',
   })
   .asResponse();
 console.log(response.headers.get('X-My-Header'));
@@ -373,7 +373,7 @@ await anthropic.completions.create(
   {
     prompt: `${Anthropic.HUMAN_PROMPT} How does a court case get to the Supreme Court?${Anthropic.AI_PROMPT}`,
     max_tokens_to_sample: 300,
-    model: 'claude-2',
+    model: 'claude-2.1',
   },
   {
     baseURL: 'http://localhost:8080/test-api',

api.md

@@ -9,3 +9,27 @@ Types:
 Methods:
 
 - <code title="post /v1/complete">client.completions.<a href="./src/resources/completions.ts">create</a>({ ...params }) -> Completion</code>
+
+# Beta
+
+## Messages
+
+Types:
+
+- <code><a href="./src/resources/beta/messages.ts">ContentBlock</a></code>
+- <code><a href="./src/resources/beta/messages.ts">ContentBlockDeltaEvent</a></code>
+- <code><a href="./src/resources/beta/messages.ts">ContentBlockStartEvent</a></code>
+- <code><a href="./src/resources/beta/messages.ts">ContentBlockStopEvent</a></code>
+- <code><a href="./src/resources/beta/messages.ts">Message</a></code>
+- <code><a href="./src/resources/beta/messages.ts">MessageDeltaEvent</a></code>
+- <code><a href="./src/resources/beta/messages.ts">MessageParam</a></code>
+- <code><a href="./src/resources/beta/messages.ts">MessageStartEvent</a></code>
+- <code><a href="./src/resources/beta/messages.ts">MessageStopEvent</a></code>
+- <code><a href="./src/resources/beta/messages.ts">MessageStreamEvent</a></code>
+- <code><a href="./src/resources/beta/messages.ts">TextBlock</a></code>
+- <code><a href="./src/resources/beta/messages.ts">TextDelta</a></code>
+
+Methods:
+
+- <code title="post /v1/messages">client.beta.messages.<a href="./src/resources/beta/messages.ts">create</a>({ ...params }) -> Message</code>
+- <code>client.beta.messages.<a href="./src/resources/beta/messages.ts">stream</a>(body, options?) -> MessageStream</code>

examples/cancellation.ts

@@ -17,7 +17,7 @@ async function main() {
 
   const stream = await client.completions.create({
     prompt: `${Anthropic.HUMAN_PROMPT}${question}${Anthropic.AI_PROMPT}:`,
-    model: 'claude-2',
+    model: 'claude-2.1',
     stream: true,
     max_tokens_to_sample: 500,
   });

examples/demo.ts

@@ -7,7 +7,7 @@ const client = new Anthropic(); // gets API Key from environment variable ANTHRO
 async function main() {
   const result = await client.completions.create({
     prompt: `${Anthropic.HUMAN_PROMPT} how does a court case get to the Supreme Court? ${Anthropic.AI_PROMPT}`,
-    model: 'claude-2',
+    model: 'claude-2.1',
     max_tokens_to_sample: 300,
   });
   console.log(result.completion);

examples/raw-streaming.ts

@@ -0,0 +1,25 @@
+#!/usr/bin/env -S npm run tsn -T
+
+import Anthropic from '@anthropic-ai/sdk';
+
+const client = new Anthropic(); // gets API Key from environment variable ANTHROPIC_API_KEY
+
+async function main() {
+  const question = 'Hey Claude! How can I recursively list all files in a directory in Rust?';
+
+  const stream = await client.completions.create({
+    prompt: `${Anthropic.HUMAN_PROMPT}${question}${Anthropic.AI_PROMPT}:`,
+    model: 'claude-2.1',
+    stream: true,
+    max_tokens_to_sample: 500,
+  });
+
+  for await (const completion of stream) {
+    process.stdout.write(completion.completion);
+  }
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

examples/streaming.ts

@@ -5,18 +5,28 @@ import Anthropic from '@anthropic-ai/sdk';
 const client = new Anthropic(); // gets API Key from environment variable ANTHROPIC_API_KEY
 
 async function main() {
-  const question = 'Hey Claude! How can I recursively list all files in a directory in Rust?';
+  const stream = client.beta.messages
+    .stream({
+      messages: [
+        {
+          role: 'user',
+          content: `Hey Claude! How can I recursively list all files in a directory in Rust?`,
+        },
+      ],
+      model: 'claude-2.1',
+      max_tokens: 1024,
+    })
+    // Once a content block is fully streamed, this event will fire
+    .on('contentBlock', (content) => console.log('contentBlock', content))
+    // Once a message is fully streamed, this event will fire
+    .on('message', (message) => console.log('message', message));
 
-  const stream = await client.completions.create({
-    prompt: `${Anthropic.HUMAN_PROMPT}${question}${Anthropic.AI_PROMPT}:`,
-    model: 'claude-2',
-    stream: true,
-    max_tokens_to_sample: 500,
-  });
-
-  for await (const completion of stream) {
-    process.stdout.write(completion.completion);
+  for await (const event of stream) {
+    console.log('event', event);
   }
+
+  const message = await stream.finalMessage();
+  console.log('finalMessage', message);
 }
 
 main().catch((err) => {

helpers.md

@@ -0,0 +1,96 @@
+# Chat Completion Helpers
+
+## Streaming Responses
+
+```ts
+anthropic.beta.messages.stream({ … }, options?): MessageStream
+```
+
+`anthropic.beta.messages.stream()` returns a `MessageStream`, which emits events, has an async
+iterator, and exposes helper methods to accumulate stream events into a convenient shape and make it easy to reason
+about the conversation.
+
+Alternatively, you can use `anthropic.beta.messages.create({ stream: true, … })` which returns an async
+iterable of the chunks in the stream and uses less memory (most notably, it does not accumulate a message
+object for you).
+
+If you need to cancel a stream, you can `break` from a `for await` loop or call `stream.abort()`.
+
+See an example of streaming helpers in action in [`examples/streaming.ts`](examples/streaming.ts).
+
+## MessageStream API
+
+### Events
+
+#### `.on('connect', () => …)`
+
+The first event that is fired when the connection with the Anthropic API is established.
+
+#### `.on('streamEvent', (event: MessageStreamEvent, snapshot: Message) => …)`
+
+The event fired when a stream event is received from the API. Not fired when it is not streaming. The snapshot
+returns an accumulated `Message` which is progressively built-up over events.
+
+#### `.on('text', (textDelta: string, textSnapshot: string) => …)`
+
+The event fired when a text delta is sent by the API. The second parameter returns a `textSnapshot`.
+
+#### `.on('message', (message: Message) => …)`
+
+The event fired when a message is done being streamed by the API. Corresponds to the `message_stop` SSE event.
+
+#### `.on('contentBlock', (content: ContentBlock) => …)`
+
+The event fired when a content block is done being streamed by the API. Corresponds to the
+`content_block_stop` SSE event.
+
+#### `.on('finalMessage', (message: Message) => …)`
+
+The event fired for the final message. Currently this is equivalent to the `message` event, but is fired after
+it.
+
+#### `.on('error', (error: AnthropicError) => …)`
+
+The event fired when an error is encountered while streaming.
+
+#### `.on('abort', (error: APIUserAbortError) => …)`
+
+The event fired when the stream receives a signal to abort.
+
+#### `.on('end', () => …)`
+
+The last event fired in the stream.
+
+### Methods
+
+#### `.abort()`
+
+Aborts the runner and the streaming request, equivalent to `.controller.abort()`. Calling `.abort()` on a
+`MessageStream` will also abort any in-flight network requests.
+
+#### `await .done()`
+
+An empty promise which resolves when the stream is done.
+
+#### `.currentMessage`
+
+Returns the current state of the message that is being accumulated, or `undefined` if there is no such
+message.
+
+#### `await .finalMessage()`
+
+A promise which resolves with the last message received from the API. Throws if no such message exists.
+
+#### `await .finalText()`
+
+A promise which resolves with the text of the last message received from the API.
+
+### Fields
+
+#### `.messages`
+
+A mutable array of all messages in the conversation.
+
+#### `.controller`
+
+The underlying `AbortController` for the runner.

package.json

@@ -1,20 +1,21 @@
 {
   "name": "@anthropic-ai/sdk",
-  "version": "0.10.2",
+  "version": "0.11.0",
   "description": "The official TypeScript library for the Anthropic API",
   "author": "Anthropic <[email protected]>",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "type": "commonjs",
   "repository": "github:anthropics/anthropic-sdk-typescript",
   "license": "MIT",
+  "packageManager": "[email protected]",
   "private": false,
   "scripts": {
     "test": "bin/check-test-server && yarn jest",
     "build": "bash ./build",
     "prepack": "echo 'to pack, run yarn build && (cd dist; yarn pack)' && exit 1",
     "prepublishOnly": "echo 'to publish, run yarn build && (cd dist; yarn publish)' && exit 1",
-    "format": "prettier --write --cache  --cache-strategy metadata . !dist",
+    "format": "prettier --write --cache --cache-strategy metadata . !dist",
     "prepare": "if [ $(basename $(dirname $PWD)) = 'node_modules' ]; then npm run build; fi",
     "tsn": "ts-node -r tsconfig-paths/register",
     "lint": "eslint --ext ts,js .",
@@ -36,10 +37,10 @@
     "@typescript-eslint/eslint-plugin": "^6.7.0",
     "@typescript-eslint/parser": "^6.7.0",
     "eslint": "^8.49.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-unused-imports": "^2.0.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-unused-imports": "^3.0.0",
     "jest": "^29.4.0",
-    "prettier": "rattrayalex/prettier#postfix-ternaries",
+    "prettier": "^3.0.0",
     "ts-jest": "^29.1.0",
     "ts-morph": "^19.0.0",
     "ts-node": "^10.5.0",