@anthropic-ai/sdk 0.40.1 → 0.50.1

package/src/resources/messages/messages.ts

@@ -1,10 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import { APIPromise } from "../../core.js";
-import * as Core from "../../core.js";
-import * as MessagesAPI from "./messages.js";
-import * as BatchesAPI from "./batches.js";
+import { APIResource } from '../../core/resource';
+import * as MessagesAPI from './messages';
+import * as BatchesAPI from './batches';
 import {
   BatchCreateParams,
   BatchListParams,
@@ -19,11 +17,13 @@ import {
   MessageBatchResult,
   MessageBatchSucceededResult,
   MessageBatchesPage,
-} from "./batches.js";
-import { Stream } from "../../streaming.js";
-import { MessageStream } from "../../lib/MessageStream.js";
+} from './batches';
+import { APIPromise } from '../../core/api-promise';
+import { Stream } from '../../core/streaming';
+import { RequestOptions } from '../../internal/request-options';
+import { MessageStream } from '../../lib/MessageStream';
 
-export { MessageStream } from "../../lib/MessageStream.js";
+export { MessageStream } from '../../lib/MessageStream';
 
 export class Messages extends APIResource {
   batches: BatchesAPI.Batches = new BatchesAPI.Batches(this._client);
@@ -36,19 +36,28 @@ export class Messages extends APIResource {
    * conversations.
    *
    * Learn more about the Messages API in our [user guide](/en/docs/initial-setup)
+   *
+   * @example
+   * ```ts
+   * const message = await client.messages.create({
+   *   max_tokens: 1024,
+   *   messages: [{ content: 'Hello, world', role: 'user' }],
+   *   model: 'claude-3-7-sonnet-20250219',
+   * });
+   * ```
    */
-  create(body: MessageCreateParamsNonStreaming, options?: Core.RequestOptions): APIPromise<Message>;
+  create(body: MessageCreateParamsNonStreaming, options?: RequestOptions): APIPromise<Message>;
   create(
     body: MessageCreateParamsStreaming,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): APIPromise<Stream<RawMessageStreamEvent>>;
   create(
     body: MessageCreateParamsBase,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): APIPromise<Stream<RawMessageStreamEvent> | Message>;
   create(
     body: MessageCreateParams,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): APIPromise<Message> | APIPromise<Stream<RawMessageStreamEvent>> {
     if (body.model in DEPRECATED_MODELS) {
       console.warn(
@@ -70,7 +79,7 @@ export class Messages extends APIResource {
   /**
    * Create a Message stream
    */
-  stream(body: MessageStreamParams, options?: Core.RequestOptions): MessageStream {
+  stream(body: MessageStreamParams, options?: RequestOptions): MessageStream {
     return MessageStream.createMessage(this, body, options);
   }
 
@@ -82,11 +91,17 @@ export class Messages extends APIResource {
    *
    * Learn more about token counting in our
    * [user guide](/en/docs/build-with-claude/token-counting)
+   *
+   * @example
+   * ```ts
+   * const messageTokensCount =
+   *   await client.messages.countTokens({
+   *     messages: [{ content: 'string', role: 'user' }],
+   *     model: 'claude-3-7-sonnet-latest',
+   *   });
+   * ```
    */
-  countTokens(
-    body: MessageCountTokensParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<MessageTokensCount> {
+  countTokens(body: MessageCountTokensParams, options?: RequestOptions): APIPromise<MessageTokensCount> {
     return this._client.post('/v1/messages/count_tokens', { body, ...options });
   }
 }
@@ -195,22 +210,58 @@ export interface CitationPageLocationParam {
   type: 'page_location';
 }
 
+export interface CitationWebSearchResultLocationParam {
+  cited_text: string;
+
+  encrypted_index: string;
+
+  title: string | null;
+
+  type: 'web_search_result_location';
+
+  url: string;
+}
+
 export interface CitationsConfigParam {
   enabled?: boolean;
 }
 
 export interface CitationsDelta {
-  citation: CitationCharLocation | CitationPageLocation | CitationContentBlockLocation;
+  citation:
+    | CitationCharLocation
+    | CitationPageLocation
+    | CitationContentBlockLocation
+    | CitationsWebSearchResultLocation;
 
   type: 'citations_delta';
 }
 
-export type ContentBlock = TextBlock | ToolUseBlock | ThinkingBlock | RedactedThinkingBlock;
+export interface CitationsWebSearchResultLocation {
+  cited_text: string;
+
+  encrypted_index: string;
+
+  title: string | null;
+
+  type: 'web_search_result_location';
+
+  url: string;
+}
+
+export type ContentBlock =
+  | TextBlock
+  | ToolUseBlock
+  | ServerToolUseBlock
+  | WebSearchToolResultBlock
+  | ThinkingBlock
+  | RedactedThinkingBlock;
 
 export type ContentBlockParam =
   | TextBlockParam
   | ImageBlockParam
   | ToolUseBlockParam
+  | ServerToolUseBlockParam
+  | WebSearchToolResultBlockParam
   | ToolResultBlockParam
   | DocumentBlockParam
   | ThinkingBlockParam
@@ -229,6 +280,9 @@ export interface DocumentBlockParam {
 
   type: 'document';
 
+  /**
+   * Create a cache control breakpoint at this content block.
+   */
   cache_control?: CacheControlEphemeral | null;
 
   citations?: CitationsConfigParam;
@@ -243,11 +297,12 @@ export interface ImageBlockParam {
 
   type: 'image';
 
+  /**
+   * Create a cache control breakpoint at this content block.
+   */
   cache_control?: CacheControlEphemeral | null;
 }
 
-export type InputJsonDelta = InputJSONDelta;
-
 export interface InputJSONDelta {
   partial_json: string;
 
@@ -362,13 +417,33 @@ export interface Message {
   usage: Usage;
 }
 
-export type MessageCountTokensTool = Tool | ToolBash20250124 | ToolTextEditor20250124;
+export type MessageCountTokensTool = Tool | ToolBash20250124 | ToolTextEditor20250124 | WebSearchTool20250305;
 
 export interface MessageDeltaUsage {
+  /**
+   * The cumulative number of input tokens used to create the cache entry.
+   */
+  cache_creation_input_tokens: number | null;
+
+  /**
+   * The cumulative number of input tokens read from the cache.
+   */
+  cache_read_input_tokens: number | null;
+
+  /**
+   * The cumulative number of input tokens which were used.
+   */
+  input_tokens: number | null;
+
   /**
    * The cumulative number of output tokens which were used.
    */
   output_tokens: number;
+
+  /**
+   * The number of server tool requests.
+   */
+  server_tool_use: ServerToolUsage | null;
 }
 
 export interface MessageParam {
@@ -454,7 +529,13 @@ export interface RawContentBlockDeltaEvent {
 }
 
 export interface RawContentBlockStartEvent {
-  content_block: TextBlock | ToolUseBlock | ThinkingBlock | RedactedThinkingBlock;
+  content_block:
+    | TextBlock
+    | ToolUseBlock
+    | ServerToolUseBlock
+    | WebSearchToolResultBlock
+    | ThinkingBlock
+    | RedactedThinkingBlock;
 
   index: number;
 
@@ -530,13 +611,45 @@ export interface RedactedThinkingBlockParam {
   type: 'redacted_thinking';
 }
 
+export interface ServerToolUsage {
+  /**
+   * The number of web search tool requests.
+   */
+  web_search_requests: number;
+}
+
+export interface ServerToolUseBlock {
+  id: string;
+
+  input: unknown;
+
+  name: 'web_search';
+
+  type: 'server_tool_use';
+}
+
+export interface ServerToolUseBlockParam {
+  id: string;
+
+  input: unknown;
+
+  name: 'web_search';
+
+  type: 'server_tool_use';
+
+  /**
+   * Create a cache control breakpoint at this content block.
+   */
+  cache_control?: CacheControlEphemeral | null;
+}
+
 export interface SignatureDelta {
   signature: string;
 
   type: 'signature_delta';
 }
 
-export type StopReason = 'end_turn' | 'max_tokens' | 'stop_sequence' | 'tool_use';
+export type StopReason = 'end_turn' | 'max_tokens' | 'stop_sequence' | 'tool_use' | 'pause_turn' | 'refusal';
 
 export interface TextBlock {
   /**
@@ -558,17 +671,25 @@ export interface TextBlockParam {
 
   type: 'text';
 
+  /**
+   * Create a cache control breakpoint at this content block.
+   */
   cache_control?: CacheControlEphemeral | null;
 
   citations?: Array<TextCitationParam> | null;
 }
 
-export type TextCitation = CitationCharLocation | CitationPageLocation | CitationContentBlockLocation;
+export type TextCitation =
+  | CitationCharLocation
+  | CitationPageLocation
+  | CitationContentBlockLocation
+  | CitationsWebSearchResultLocation;
 
 export type TextCitationParam =
   | CitationCharLocationParam
   | CitationPageLocationParam
-  | CitationContentBlockLocationParam;
+  | CitationContentBlockLocationParam
+  | CitationWebSearchResultLocationParam;
 
 export interface TextDelta {
   text: string;
@@ -644,10 +765,13 @@ export interface Tool {
   /**
    * Name of the tool.
    *
-   * This is how the tool will be called by the model and in tool_use blocks.
+   * This is how the tool will be called by the model and in `tool_use` blocks.
    */
   name: string;
 
+  /**
+   * Create a cache control breakpoint at this content block.
+   */
   cache_control?: CacheControlEphemeral | null;
 
   /**
@@ -659,6 +783,8 @@ export interface Tool {
    * aspects of the tool input JSON schema.
    */
   description?: string;
+
+  type?: 'custom' | null;
 }
 
 export namespace Tool {
@@ -681,12 +807,15 @@ export interface ToolBash20250124 {
   /**
    * Name of the tool.
    *
-   * This is how the tool will be called by the model and in tool_use blocks.
+   * This is how the tool will be called by the model and in `tool_use` blocks.
    */
   name: 'bash';
 
   type: 'bash_20250124';
 
+  /**
+   * Create a cache control breakpoint at this content block.
+   */
   cache_control?: CacheControlEphemeral | null;
 }
 
@@ -758,6 +887,9 @@ export interface ToolResultBlockParam {
 
   type: 'tool_result';
 
+  /**
+   * Create a cache control breakpoint at this content block.
+   */
   cache_control?: CacheControlEphemeral | null;
 
   content?: string | Array<TextBlockParam | ImageBlockParam>;
@@ -769,16 +901,19 @@ export interface ToolTextEditor20250124 {
   /**
    * Name of the tool.
    *
-   * This is how the tool will be called by the model and in tool_use blocks.
+   * This is how the tool will be called by the model and in `tool_use` blocks.
    */
   name: 'str_replace_editor';
 
   type: 'text_editor_20250124';
 
+  /**
+   * Create a cache control breakpoint at this content block.
+   */
   cache_control?: CacheControlEphemeral | null;
 }
 
-export type ToolUnion = Tool | ToolBash20250124 | ToolTextEditor20250124;
+export type ToolUnion = Tool | ToolBash20250124 | ToolTextEditor20250124 | WebSearchTool20250305;
 
 export interface ToolUseBlock {
   id: string;
@@ -799,6 +934,9 @@ export interface ToolUseBlockParam {
 
   type: 'tool_use';
 
+  /**
+   * Create a cache control breakpoint at this content block.
+   */
   cache_control?: CacheControlEphemeral | null;
 }
 
@@ -834,6 +972,155 @@ export interface Usage {
    * The number of output tokens which were used.
    */
   output_tokens: number;
+
+  /**
+   * The number of server tool requests.
+   */
+  server_tool_use: ServerToolUsage | null;
+}
+
+export interface WebSearchResultBlock {
+  encrypted_content: string;
+
+  page_age: string | null;
+
+  title: string;
+
+  type: 'web_search_result';
+
+  url: string;
+}
+
+export interface WebSearchResultBlockParam {
+  encrypted_content: string;
+
+  title: string;
+
+  type: 'web_search_result';
+
+  url: string;
+
+  page_age?: string | null;
+}
+
+export interface WebSearchTool20250305 {
+  /**
+   * Name of the tool.
+   *
+   * This is how the tool will be called by the model and in `tool_use` blocks.
+   */
+  name: 'web_search';
+
+  type: 'web_search_20250305';
+
+  /**
+   * If provided, only these domains will be included in results. Cannot be used
+   * alongside `blocked_domains`.
+   */
+  allowed_domains?: Array<string> | null;
+
+  /**
+   * If provided, these domains will never appear in results. Cannot be used
+   * alongside `allowed_domains`.
+   */
+  blocked_domains?: Array<string> | null;
+
+  /**
+   * Create a cache control breakpoint at this content block.
+   */
+  cache_control?: CacheControlEphemeral | null;
+
+  /**
+   * Maximum number of times the tool can be used in the API request.
+   */
+  max_uses?: number | null;
+
+  /**
+   * Parameters for the user's location. Used to provide more relevant search
+   * results.
+   */
+  user_location?: WebSearchTool20250305.UserLocation | null;
+}
+
+export namespace WebSearchTool20250305 {
+  /**
+   * Parameters for the user's location. Used to provide more relevant search
+   * results.
+   */
+  export interface UserLocation {
+    type: 'approximate';
+
+    /**
+     * The city of the user.
+     */
+    city?: string | null;
+
+    /**
+     * The two letter
+     * [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the
+     * user.
+     */
+    country?: string | null;
+
+    /**
+     * The region of the user.
+     */
+    region?: string | null;
+
+    /**
+     * The [IANA timezone](https://nodatime.org/TimeZones) of the user.
+     */
+    timezone?: string | null;
+  }
+}
+
+export interface WebSearchToolRequestError {
+  error_code:
+    | 'invalid_tool_input'
+    | 'unavailable'
+    | 'max_uses_exceeded'
+    | 'too_many_requests'
+    | 'query_too_long';
+
+  type: 'web_search_tool_result_error';
+}
+
+export interface WebSearchToolResultBlock {
+  content: WebSearchToolResultBlockContent;
+
+  tool_use_id: string;
+
+  type: 'web_search_tool_result';
+}
+
+export type WebSearchToolResultBlockContent = WebSearchToolResultError | Array<WebSearchResultBlock>;
+
+export interface WebSearchToolResultBlockParam {
+  content: WebSearchToolResultBlockParamContent;
+
+  tool_use_id: string;
+
+  type: 'web_search_tool_result';
+
+  /**
+   * Create a cache control breakpoint at this content block.
+   */
+  cache_control?: CacheControlEphemeral | null;
+}
+
+export type WebSearchToolResultBlockParamContent =
+  | Array<WebSearchResultBlockParam>
+  | WebSearchToolRequestError;
+
+export interface WebSearchToolResultError {
+  error_code:
+    | 'invalid_tool_input'
+    | 'unavailable'
+    | 'max_uses_exceeded'
+    | 'too_many_requests'
+    | 'query_too_long';
+
+  type: 'web_search_tool_result_error';
 }
 
 export type MessageStreamEvent = RawMessageStreamEvent;
@@ -951,6 +1238,8 @@ export interface MessageCreateParamsBase {
    * [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.
+   *
+   * There is a limit of 100000 messages in a single request.
    */
   messages: Array<MessageParam>;
 
@@ -1126,26 +1415,6 @@ export interface MessageCreateParamsBase {
 }
 
 export namespace MessageCreateParams {
-  /**
-   * @deprecated use `Anthropic.Messages.ToolChoiceAuto` instead
-   */
-  export type Metadata = MessagesAPI.Metadata;
-
-  /**
-   * @deprecated use `Anthropic.Messages.ToolChoiceAuto` instead
-   */
-  export type ToolChoiceAuto = MessagesAPI.ToolChoiceAuto;
-
-  /**
-   * @deprecated use `Anthropic.Messages.ToolChoiceAny` instead
-   */
-  export type ToolChoiceAny = MessagesAPI.ToolChoiceAny;
-
-  /**
-   * @deprecated use `Anthropic.Messages.ToolChoiceTool` instead
-   */
-  export type ToolChoiceTool = MessagesAPI.ToolChoiceTool;
-
   export type MessageCreateParamsNonStreaming = MessagesAPI.MessageCreateParamsNonStreaming;
   export type MessageCreateParamsStreaming = MessagesAPI.MessageCreateParamsStreaming;
 }
@@ -1260,6 +1529,8 @@ export interface MessageCountTokensParams {
    * [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.
+   *
+   * There is a limit of 100000 messages in a single request.
    */
   messages: Array<MessageParam>;
 
@@ -1373,7 +1644,6 @@ export interface MessageCountTokensParams {
 }
 
 Messages.Batches = Batches;
-Messages.MessageBatchesPage = MessageBatchesPage;
 
 export declare namespace Messages {
   export {
@@ -1386,18 +1656,22 @@ export declare namespace Messages {
     type CitationContentBlockLocationParam as CitationContentBlockLocationParam,
     type CitationPageLocation as CitationPageLocation,
     type CitationPageLocationParam as CitationPageLocationParam,
+    type CitationWebSearchResultLocationParam as CitationWebSearchResultLocationParam,
     type CitationsConfigParam as CitationsConfigParam,
     type CitationsDelta as CitationsDelta,
+    type CitationsWebSearchResultLocation as CitationsWebSearchResultLocation,
     type ContentBlock as ContentBlock,
     type ContentBlockParam as ContentBlockParam,
+    type ContentBlockStartEvent as ContentBlockStartEvent,
+    type ContentBlockStopEvent as ContentBlockStopEvent,
     type ContentBlockSource as ContentBlockSource,
     type ContentBlockSourceContent as ContentBlockSourceContent,
     type DocumentBlockParam as DocumentBlockParam,
     type ImageBlockParam as ImageBlockParam,
-    type InputJsonDelta as InputJsonDelta,
     type InputJSONDelta as InputJSONDelta,
     type Message as Message,
     type MessageCountTokensTool as MessageCountTokensTool,
+    type MessageDeltaEvent as MessageDeltaEvent,
     type MessageDeltaUsage as MessageDeltaUsage,
     type MessageParam as MessageParam,
     type MessageTokensCount as MessageTokensCount,
@@ -1414,6 +1688,9 @@ export declare namespace Messages {
     type RawMessageStreamEvent as RawMessageStreamEvent,
     type RedactedThinkingBlock as RedactedThinkingBlock,
     type RedactedThinkingBlockParam as RedactedThinkingBlockParam,
+    type ServerToolUsage as ServerToolUsage,
+    type ServerToolUseBlock as ServerToolUseBlock,
+    type ServerToolUseBlockParam as ServerToolUseBlockParam,
     type SignatureDelta as SignatureDelta,
     type StopReason as StopReason,
     type TextBlock as TextBlock,
@@ -1442,13 +1719,19 @@ export declare namespace Messages {
     type URLImageSource as URLImageSource,
     type URLPDFSource as URLPDFSource,
     type Usage as Usage,
+    type WebSearchResultBlock as WebSearchResultBlock,
+    type WebSearchResultBlockParam as WebSearchResultBlockParam,
+    type WebSearchTool20250305 as WebSearchTool20250305,
+    type WebSearchToolRequestError as WebSearchToolRequestError,
+    type WebSearchToolResultBlock as WebSearchToolResultBlock,
+    type WebSearchToolResultBlockContent as WebSearchToolResultBlockContent,
+    type WebSearchToolResultBlockParam as WebSearchToolResultBlockParam,
+    type WebSearchToolResultBlockParamContent as WebSearchToolResultBlockParamContent,
+    type WebSearchToolResultError as WebSearchToolResultError,
     type MessageStreamEvent as MessageStreamEvent,
     type MessageStartEvent as MessageStartEvent,
-    type MessageDeltaEvent as MessageDeltaEvent,
     type MessageStopEvent as MessageStopEvent,
-    type ContentBlockStartEvent as ContentBlockStartEvent,
     type ContentBlockDeltaEvent as ContentBlockDeltaEvent,
-    type ContentBlockStopEvent as ContentBlockStopEvent,
     type MessageCreateParams as MessageCreateParams,
     type MessageCreateParamsNonStreaming as MessageCreateParamsNonStreaming,
     type MessageCreateParamsStreaming as MessageCreateParamsStreaming,
@@ -1467,7 +1750,7 @@ export declare namespace Messages {
     type MessageBatchRequestCounts as MessageBatchRequestCounts,
     type MessageBatchResult as MessageBatchResult,
     type MessageBatchSucceededResult as MessageBatchSucceededResult,
-    MessageBatchesPage as MessageBatchesPage,
+    type MessageBatchesPage as MessageBatchesPage,
     type BatchCreateParams as BatchCreateParams,
     type BatchListParams as BatchListParams,
   };

package/src/resources/messages.ts

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from "./messages/index.js";
+export * from './messages/index';