@anthropic-ai/sdk 0.20.8 → 0.21.0

package/src/resources/beta/tools/messages.ts

@@ -3,6 +3,8 @@
 import * as Core from "../../../core";
 import { APIPromise } from "../../../core";
 import { APIResource } from "../../../resource";
+import { ToolsBetaMessageStream } from "../../../lib/ToolsBetaMessageStream";
+export { ToolsBetaMessageStream } from "../../../lib/ToolsBetaMessageStream";
 import * as ToolsMessagesAPI from "./messages";
 import * as MessagesAPI from "../../messages";
 import { Stream } from "../../../streaming";
@@ -21,23 +23,36 @@ export class Messages extends APIResource {
   create(
     body: MessageCreateParamsStreaming,
     options?: Core.RequestOptions,
-  ): APIPromise<Stream<MessagesAPI.MessageStreamEvent>>;
+  ): APIPromise<Stream<ToolsBetaMessageStreamEvent>>;
   create(
     body: MessageCreateParamsBase,
     options?: Core.RequestOptions,
-  ): APIPromise<Stream<MessagesAPI.MessageStreamEvent> | ToolsBetaMessage>;
+  ): APIPromise<Stream<ToolsBetaMessageStreamEvent> | ToolsBetaMessage>;
   create(
     body: MessageCreateParams,
     options?: Core.RequestOptions,
-  ): APIPromise<ToolsBetaMessage> | APIPromise<Stream<MessagesAPI.MessageStreamEvent>> {
+  ): APIPromise<ToolsBetaMessage> | APIPromise<Stream<ToolsBetaMessageStreamEvent>> {
     return this._client.post('/v1/messages?beta=tools', {
       body,
       timeout: 600000,
       ...options,
-      headers: { 'anthropic-beta': 'tools-2024-04-04', ...options?.headers },
+      headers: { 'anthropic-beta': 'tools-2024-05-16', ...options?.headers },
       stream: body.stream ?? false,
-    }) as APIPromise<ToolsBetaMessage> | APIPromise<Stream<MessagesAPI.MessageStreamEvent>>;
+    }) as APIPromise<ToolsBetaMessage> | APIPromise<Stream<ToolsBetaMessageStreamEvent>>;
   }
+
+  /**
+   * Create a Message stream
+   */
+  stream(body: MessageStreamParams, options?: Core.RequestOptions): ToolsBetaMessageStream {
+    return ToolsBetaMessageStream.createMessage(this, body, options);
+  }
+}
+
+export interface InputJsonDelta {
+  partial_json: string;
+
+  type: 'input_json_delta';
 }
 
 export interface Tool {
@@ -82,7 +97,7 @@ export interface ToolResultBlockParam {
 
   type: 'tool_result';
 
-  content?: Array<MessagesAPI.TextBlockParam>;
+  content?: Array<MessagesAPI.TextBlockParam | MessagesAPI.ImageBlockParam>;
 
   is_error?: boolean;
 }
@@ -109,6 +124,22 @@ export interface ToolUseBlockParam {
 
 export type ToolsBetaContentBlock = MessagesAPI.TextBlock | ToolUseBlock;
 
+export interface ToolsBetaContentBlockDeltaEvent {
+  delta: MessagesAPI.TextDelta | InputJsonDelta;
+
+  index: number;
+
+  type: 'content_block_delta';
+}
+
+export interface ToolsBetaContentBlockStartEvent {
+  content_block: MessagesAPI.TextBlock | ToolUseBlock;
+
+  index: number;
+
+  type: 'content_block_start';
+}
+
 export interface ToolsBetaMessage {
   /**
    * Unique object identifier.
@@ -222,6 +253,14 @@ export interface ToolsBetaMessageParam {
   role: 'user' | 'assistant';
 }
 
+export type ToolsBetaMessageStreamEvent =
+  | MessagesAPI.MessageStartEvent
+  | MessagesAPI.MessageDeltaEvent
+  | MessagesAPI.MessageStopEvent
+  | ToolsBetaContentBlockStartEvent
+  | ToolsBetaContentBlockDeltaEvent
+  | MessagesAPI.ContentBlockStopEvent;
+
 export type MessageCreateParams = MessageCreateParamsNonStreaming | MessageCreateParamsStreaming;
 
 export interface MessageCreateParamsBase {
@@ -232,7 +271,7 @@ export interface MessageCreateParamsBase {
    * only specifies the absolute maximum number of tokens to generate.
    *
    * Different models have different maximum values for this parameter. See
-   * [models](https://docs.anthropic.com/claude/docs/models-overview) for details.
+   * [models](https://docs.anthropic.com/en/docs/models-overview) for details.
    */
   max_tokens: number;
 
@@ -315,12 +354,12 @@ export interface MessageCreateParamsBase {
    * We currently support the `base64` source type for images, and the `image/jpeg`,
    * `image/png`, `image/gif`, and `image/webp` media types.
    *
-   * See [examples](https://docs.anthropic.com/claude/reference/messages-examples)
-   * for more input examples.
+   * See [examples](https://docs.anthropic.com/en/api/messages-examples) for more
+   * input examples.
    *
    * Note that if you want to include a
-   * [system prompt](https://docs.anthropic.com/claude/docs/system-prompts), you can
-   * use the top-level `system` parameter — there is no `"system"` role for input
+   * [system prompt](https://docs.anthropic.com/en/docs/system-prompts), you can use
+   * the top-level `system` parameter — there is no `"system"` role for input
    * messages in the Messages API.
    */
   messages: Array<ToolsBetaMessageParam>;
@@ -328,8 +367,8 @@ export interface MessageCreateParamsBase {
   /**
    * The model that will complete your prompt.
    *
-   * See [models](https://docs.anthropic.com/claude/docs/models-overview) for
-   * additional details and options.
+   * See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
+   * details and options.
    */
   model: string;
 
@@ -354,8 +393,8 @@ export interface MessageCreateParamsBase {
   /**
    * Whether to incrementally stream the response using server-sent events.
    *
-   * See [streaming](https://docs.anthropic.com/claude/reference/messages-streaming)
-   * for details.
+   * See [streaming](https://docs.anthropic.com/en/api/messages-streaming) for
+   * details.
    */
   stream?: boolean;
 
@@ -364,7 +403,7 @@ export interface MessageCreateParamsBase {
    *
    * A system prompt is a way of providing context and instructions to Claude, such
    * as specifying a particular goal or role. See our
-   * [guide to system prompts](https://docs.anthropic.com/claude/docs/system-prompts).
+   * [guide to system prompts](https://docs.anthropic.com/en/docs/system-prompts).
    */
   system?: string;
 
@@ -380,6 +419,15 @@ export interface MessageCreateParamsBase {
    */
   temperature?: number;
 
+  /**
+   * How the model should use the provided tools. The model can use a specific tool,
+   * any available tool, or decide by itself.
+   */
+  tool_choice?:
+    | MessageCreateParams.ToolChoiceAuto
+    | MessageCreateParams.ToolChoiceAny
+    | MessageCreateParams.ToolChoiceTool;
+
   /**
    * [beta] Definitions of tools that the model may use.
    *
@@ -448,7 +496,7 @@ export interface MessageCreateParamsBase {
    * functions, or more generally whenever you want the model to produce a particular
    * JSON structure of output.
    *
-   * See our [beta guide](https://docs.anthropic.com/claude/docs/tool-use) for more
+   * See our [beta guide](https://docs.anthropic.com/en/docs/tool-use) for more
    * details.
    */
   tools?: Array<Tool>;
@@ -493,6 +541,32 @@ export namespace MessageCreateParams {
     user_id?: string | null;
   }
 
+  /**
+   * The model will automatically decide whether to use tools.
+   */
+  export interface ToolChoiceAuto {
+    type: 'auto';
+  }
+
+  /**
+   * The model will use any available tools.
+   */
+  export interface ToolChoiceAny {
+    type: 'any';
+  }
+
+  /**
+   * The model will use the specified tool with `tool_choice.name`.
+   */
+  export interface ToolChoiceTool {
+    /**
+     * The name of the tool to use.
+     */
+    name: string;
+
+    type: 'tool';
+  }
+
   export type MessageCreateParamsNonStreaming = ToolsMessagesAPI.MessageCreateParamsNonStreaming;
   export type MessageCreateParamsStreaming = ToolsMessagesAPI.MessageCreateParamsStreaming;
 }
@@ -501,8 +575,8 @@ export interface MessageCreateParamsNonStreaming extends MessageCreateParamsBase
   /**
    * Whether to incrementally stream the response using server-sent events.
    *
-   * See [streaming](https://docs.anthropic.com/claude/reference/messages-streaming)
-   * for details.
+   * See [streaming](https://docs.anthropic.com/en/api/messages-streaming) for
+   * details.
    */
   stream?: false;
 }
@@ -511,21 +585,323 @@ export interface MessageCreateParamsStreaming extends MessageCreateParamsBase {
   /**
    * Whether to incrementally stream the response using server-sent events.
    *
-   * See [streaming](https://docs.anthropic.com/claude/reference/messages-streaming)
-   * for details.
+   * See [streaming](https://docs.anthropic.com/en/api/messages-streaming) for
+   * details.
    */
   stream: true;
 }
 
+export interface MessageStreamParams {
+  /**
+   * The maximum number of tokens to generate before stopping.
+   *
+   * Note that our models may stop _before_ reaching this maximum. This parameter
+   * only specifies the absolute maximum number of tokens to generate.
+   *
+   * Different models have different maximum values for this parameter. See
+   * [models](https://docs.anthropic.com/en/docs/models-overview) for details.
+   */
+  max_tokens: number;
+
+  /**
+   * Input messages.
+   *
+   * Our models are trained to operate on alternating `user` and `assistant`
+   * conversational turns. When creating a new `Message`, you specify the prior
+   * conversational turns with the `messages` parameter, and the model then generates
+   * the next `Message` in the conversation.
+   *
+   * Each input message must be an object with a `role` and `content`. You can
+   * specify a single `user`-role message, or you can include multiple `user` and
+   * `assistant` messages. The first message must always use the `user` role.
+   *
+   * If the final message uses the `assistant` role, the response content will
+   * continue immediately from the content in that message. This can be used to
+   * constrain part of the model's response.
+   *
+   * Example with a single `user` message:
+   *
+   * ```json
+   * [{ "role": "user", "content": "Hello, Claude" }]
+   * ```
+   *
+   * Example with multiple conversational turns:
+   *
+   * ```json
+   * [
+   *   { "role": "user", "content": "Hello there." },
+   *   { "role": "assistant", "content": "Hi, I'm Claude. How can I help you?" },
+   *   { "role": "user", "content": "Can you explain LLMs in plain English?" }
+   * ]
+   * ```
+   *
+   * Example with a partially-filled response from Claude:
+   *
+   * ```json
+   * [
+   *   {
+   *     "role": "user",
+   *     "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"
+   *   },
+   *   { "role": "assistant", "content": "The best answer is (" }
+   * ]
+   * ```
+   *
+   * Each input message `content` may be either a single `string` or an array of
+   * content blocks, where each block has a specific `type`. Using a `string` for
+   * `content` is shorthand for an array of one content block of type `"text"`. The
+   * following input messages are equivalent:
+   *
+   * ```json
+   * { "role": "user", "content": "Hello, Claude" }
+   * ```
+   *
+   * ```json
+   * { "role": "user", "content": [{ "type": "text", "text": "Hello, Claude" }] }
+   * ```
+   *
+   * Starting with Claude 3 models, you can also send image content blocks:
+   *
+   * ```json
+   * {
+   *   "role": "user",
+   *   "content": [
+   *     {
+   *       "type": "image",
+   *       "source": {
+   *         "type": "base64",
+   *         "media_type": "image/jpeg",
+   *         "data": "/9j/4AAQSkZJRg..."
+   *       }
+   *     },
+   *     { "type": "text", "text": "What is in this image?" }
+   *   ]
+   * }
+   * ```
+   *
+   * We currently support the `base64` source type for images, and the `image/jpeg`,
+   * `image/png`, `image/gif`, and `image/webp` media types.
+   *
+   * See [examples](https://docs.anthropic.com/en/api/messages-examples) for more
+   * input examples.
+   *
+   * Note that if you want to include a
+   * [system prompt](https://docs.anthropic.com/en/docs/system-prompts), you can use
+   * the top-level `system` parameter — there is no `"system"` role for input
+   * messages in the Messages API.
+   */
+  messages: Array<ToolsBetaMessageParam>;
+
+  /**
+   * The model that will complete your prompt.
+   *
+   * See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
+   * details and options.
+   */
+  model: string;
+
+  /**
+   * An object describing metadata about the request.
+   */
+  metadata?: MessageStreamParams.Metadata;
+
+  /**
+   * Custom text sequences that will cause the model to stop generating.
+   *
+   * Our models will normally stop when they have naturally completed their turn,
+   * which will result in a response `stop_reason` of `"end_turn"`.
+   *
+   * If you want the model to stop generating when it encounters custom strings of
+   * text, you can use the `stop_sequences` parameter. If the model encounters one of
+   * the custom sequences, the response `stop_reason` value will be `"stop_sequence"`
+   * and the response `stop_sequence` value will contain the matched stop sequence.
+   */
+  stop_sequences?: Array<string>;
+
+  /**
+   * System prompt.
+   *
+   * A system prompt is a way of providing context and instructions to Claude, such
+   * as specifying a particular goal or role. See our
+   * [guide to system prompts](https://docs.anthropic.com/en/docs/system-prompts).
+   */
+  system?: string;
+
+  /**
+   * Amount of randomness injected into the response.
+   *
+   * Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0`
+   * for analytical / multiple choice, and closer to `1.0` for creative and
+   * generative tasks.
+   *
+   * Note that even with `temperature` of `0.0`, the results will not be fully
+   * deterministic.
+   */
+  temperature?: number;
+
+  /**
+   * How the model should use the provided tools. The model can use a specific tool,
+   * any available tool, or decide by itself.
+   */
+  tool_choice?:
+    | MessageStreamParams.ToolChoiceAuto
+    | MessageStreamParams.ToolChoiceAny
+    | MessageStreamParams.ToolChoiceTool;
+
+  /**
+   * [beta] Definitions of tools that the model may use.
+   *
+   * If you include `tools` in your API request, the model may return `tool_use`
+   * content blocks that represent the model's use of those tools. You can then run
+   * those tools using the tool input generated by the model and then optionally
+   * return results back to the model using `tool_result` content blocks.
+   *
+   * Each tool definition includes:
+   *
+   * - `name`: Name of the tool.
+   * - `description`: Optional, but strongly-recommended description of the tool.
+   * - `input_schema`: [JSON schema](https://json-schema.org/) for the tool `input`
+   *   shape that the model will produce in `tool_use` output content blocks.
+   *
+   * For example, if you defined `tools` as:
+   *
+   * ```json
+   * [
+   *   {
+   *     "name": "get_stock_price",
+   *     "description": "Get the current stock price for a given ticker symbol.",
+   *     "input_schema": {
+   *       "type": "object",
+   *       "properties": {
+   *         "ticker": {
+   *           "type": "string",
+   *           "description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
+   *         }
+   *       },
+   *       "required": ["ticker"]
+   *     }
+   *   }
+   * ]
+   * ```
+   *
+   * And then asked the model "What's the S&P 500 at today?", the model might produce
+   * `tool_use` content blocks in the response like this:
+   *
+   * ```json
+   * [
+   *   {
+   *     "type": "tool_use",
+   *     "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
+   *     "name": "get_stock_price",
+   *     "input": { "ticker": "^GSPC" }
+   *   }
+   * ]
+   * ```
+   *
+   * You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an
+   * input, and return the following back to the model in a subsequent `user`
+   * message:
+   *
+   * ```json
+   * [
+   *   {
+   *     "type": "tool_result",
+   *     "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
+   *     "content": "259.75 USD"
+   *   }
+   * ]
+   * ```
+   *
+   * Tools can be used for workflows that include running client-side tools and
+   * functions, or more generally whenever you want the model to produce a particular
+   * JSON structure of output.
+   *
+   * See our [beta guide](https://docs.anthropic.com/en/docs/tool-use) for more
+   * details.
+   */
+  tools?: Array<Tool>;
+
+  /**
+   * Only sample from the top K options for each subsequent token.
+   *
+   * Used to remove "long tail" low probability responses.
+   * [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277).
+   *
+   * Recommended for advanced use cases only. You usually only need to use
+   * `temperature`.
+   */
+  top_k?: number;
+
+  /**
+   * Use nucleus sampling.
+   *
+   * In nucleus sampling, we compute the cumulative distribution over all the options
+   * for each subsequent token in decreasing probability order and cut it off once it
+   * reaches a particular probability specified by `top_p`. You should either alter
+   * `temperature` or `top_p`, but not both.
+   *
+   * Recommended for advanced use cases only. You usually only need to use
+   * `temperature`.
+   */
+  top_p?: number;
+}
+
+export namespace MessageStreamParams {
+  /**
+   * An object describing metadata about the request.
+   */
+  export interface Metadata {
+    /**
+     * An external identifier for the user who is associated with the request.
+     *
+     * This should be a uuid, hash value, or other opaque identifier. Anthropic may use
+     * this id to help detect abuse. Do not include any identifying information such as
+     * name, email address, or phone number.
+     */
+    user_id?: string | null;
+  }
+
+  /**
+   * The model will automatically decide whether to use tools.
+   */
+  export interface ToolChoiceAuto {
+    type: 'auto';
+  }
+
+  /**
+   * The model will use any available tools.
+   */
+  export interface ToolChoiceAny {
+    type: 'any';
+  }
+
+  /**
+   * The model will use the specified tool with `tool_choice.name`.
+   */
+  export interface ToolChoiceTool {
+    /**
+     * The name of the tool to use.
+     */
+    name: string;
+
+    type: 'tool';
+  }
+}
+
 export namespace Messages {
+  export import InputJsonDelta = ToolsMessagesAPI.InputJsonDelta;
   export import Tool = ToolsMessagesAPI.Tool;
   export import ToolResultBlockParam = ToolsMessagesAPI.ToolResultBlockParam;
   export import ToolUseBlock = ToolsMessagesAPI.ToolUseBlock;
   export import ToolUseBlockParam = ToolsMessagesAPI.ToolUseBlockParam;
   export import ToolsBetaContentBlock = ToolsMessagesAPI.ToolsBetaContentBlock;
+  export import ToolsBetaContentBlockDeltaEvent = ToolsMessagesAPI.ToolsBetaContentBlockDeltaEvent;
+  export import ToolsBetaContentBlockStartEvent = ToolsMessagesAPI.ToolsBetaContentBlockStartEvent;
   export import ToolsBetaMessage = ToolsMessagesAPI.ToolsBetaMessage;
   export import ToolsBetaMessageParam = ToolsMessagesAPI.ToolsBetaMessageParam;
+  export import ToolsBetaMessageStreamEvent = ToolsMessagesAPI.ToolsBetaMessageStreamEvent;
   export import MessageCreateParams = ToolsMessagesAPI.MessageCreateParams;
   export import MessageCreateParamsNonStreaming = ToolsMessagesAPI.MessageCreateParamsNonStreaming;
   export import MessageCreateParamsStreaming = ToolsMessagesAPI.MessageCreateParamsStreaming;
+  export import MessageStreamParams = ToolsMessagesAPI.MessageStreamParams;
 }

package/src/resources/beta/tools/tools.ts

@@ -9,14 +9,19 @@ export class Tools extends APIResource {
 
 export namespace Tools {
   export import Messages = MessagesAPI.Messages;
+  export import InputJsonDelta = MessagesAPI.InputJsonDelta;
   export import Tool = MessagesAPI.Tool;
   export import ToolResultBlockParam = MessagesAPI.ToolResultBlockParam;
   export import ToolUseBlock = MessagesAPI.ToolUseBlock;
   export import ToolUseBlockParam = MessagesAPI.ToolUseBlockParam;
   export import ToolsBetaContentBlock = MessagesAPI.ToolsBetaContentBlock;
+  export import ToolsBetaContentBlockDeltaEvent = MessagesAPI.ToolsBetaContentBlockDeltaEvent;
+  export import ToolsBetaContentBlockStartEvent = MessagesAPI.ToolsBetaContentBlockStartEvent;
   export import ToolsBetaMessage = MessagesAPI.ToolsBetaMessage;
   export import ToolsBetaMessageParam = MessagesAPI.ToolsBetaMessageParam;
+  export import ToolsBetaMessageStreamEvent = MessagesAPI.ToolsBetaMessageStreamEvent;
   export import MessageCreateParams = MessagesAPI.MessageCreateParams;
   export import MessageCreateParamsNonStreaming = MessagesAPI.MessageCreateParamsNonStreaming;
   export import MessageCreateParamsStreaming = MessagesAPI.MessageCreateParamsStreaming;
+  export import MessageStreamParams = MessagesAPI.MessageStreamParams;
 }

package/src/resources/completions.ts

@@ -11,11 +11,10 @@ export class Completions extends APIResource {
    * [Legacy] Create a Text Completion.
    *
    * The Text Completions API is a legacy API. We recommend using the
-   * [Messages API](https://docs.anthropic.com/claude/reference/messages_post) going
-   * forward.
+   * [Messages API](https://docs.anthropic.com/en/api/messages) going forward.
    *
    * Future models and features will not be compatible with Text Completions. See our
-   * [migration guide](https://docs.anthropic.com/claude/reference/migrating-from-text-completions-to-messages)
+   * [migration guide](https://docs.anthropic.com/en/api/migrating-from-text-completions-to-messages)
    * for guidance in migrating from Text Completions to Messages.
    */
   create(body: CompletionCreateParamsNonStreaming, options?: Core.RequestOptions): APIPromise<Completion>;
@@ -91,8 +90,8 @@ export interface CompletionCreateParamsBase {
   /**
    * The model that will complete your prompt.
    *
-   * See [models](https://docs.anthropic.com/claude/docs/models-overview) for
-   * additional details and options.
+   * See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
+   * details and options.
    */
   model: (string & {}) | 'claude-2.0' | 'claude-2.1' | 'claude-instant-1.2';
 
@@ -106,11 +105,10 @@ export interface CompletionCreateParamsBase {
    * "\n\nHuman: {userQuestion}\n\nAssistant:"
    * ```
    *
-   * See
-   * [prompt validation](https://anthropic.readme.io/claude/reference/prompt-validation)
-   * and our guide to
-   * [prompt design](https://docs.anthropic.com/claude/docs/introduction-to-prompt-design)
-   * for more details.
+   * See [prompt validation](https://docs.anthropic.com/en/api/prompt-validation) and
+   * our guide to
+   * [prompt design](https://docs.anthropic.com/en/docs/intro-to-prompting) for more
+   * details.
    */
   prompt: string;
 
@@ -131,9 +129,7 @@ export interface CompletionCreateParamsBase {
   /**
    * Whether to incrementally stream the response using server-sent events.
    *
-   * See
-   * [streaming](https://docs.anthropic.com/claude/reference/text-completions-streaming)
-   * for details.
+   * See [streaming](https://docs.anthropic.com/en/api/streaming) for details.
    */
   stream?: boolean;
 
@@ -197,9 +193,7 @@ export interface CompletionCreateParamsNonStreaming extends CompletionCreatePara
   /**
    * Whether to incrementally stream the response using server-sent events.
    *
-   * See
-   * [streaming](https://docs.anthropic.com/claude/reference/text-completions-streaming)
-   * for details.
+   * See [streaming](https://docs.anthropic.com/en/api/streaming) for details.
    */
   stream?: false;
 }
@@ -208,9 +202,7 @@ export interface CompletionCreateParamsStreaming extends CompletionCreateParamsB
   /**
    * Whether to incrementally stream the response using server-sent events.
    *
-   * See
-   * [streaming](https://docs.anthropic.com/claude/reference/text-completions-streaming)
-   * for details.
+   * See [streaming](https://docs.anthropic.com/en/api/streaming) for details.
    */
   stream: true;
 }