@anthropic-ai/sdk 0.35.0 → 0.36.3

package/src/lib/MessageStream.ts

@@ -9,6 +9,7 @@ import {
   type MessageCreateParams,
   type MessageCreateParamsBase,
   type TextBlock,
+  type TextCitation,
 } from "../resources/messages.js";
 import { type ReadableStream, type Response } from "../_shims/index.js";
 import { Stream } from "../streaming.js";
@@ -18,6 +19,7 @@ export interface MessageStreamEvents {
   connect: () => void;
   streamEvent: (event: MessageStreamEvent, snapshot: Message) => void;
   text: (textDelta: string, textSnapshot: string) => void;
+  citation: (citation: TextCitation, citationsSnapshot: TextCitation[]) => void;
   inputJson: (partialJson: string, jsonSnapshot: unknown) => void;
   message: (message: Message) => void;
   contentBlock: (content: ContentBlock) => void;
@@ -55,6 +57,7 @@ export class MessageStream implements AsyncIterable<MessageStreamEvent> {
   #errored = false;
   #aborted = false;
   #catchingPromiseCreated = false;
+  #response: Response | null | undefined;
   #request_id: string | null | undefined;
 
   constructor() {
@@ -76,6 +79,10 @@ export class MessageStream implements AsyncIterable<MessageStreamEvent> {
     this.#endPromise.catch(() => {});
   }
 
+  get response(): Response | null | undefined {
+    return this.#response;
+  }
+
   get request_id(): string | null | undefined {
     return this.#request_id;
   }
@@ -183,6 +190,7 @@ export class MessageStream implements AsyncIterable<MessageStreamEvent> {
 
   protected _connected(response: Response | null) {
     if (this.ended) return;
+    this.#response = response;
     this.#request_id = response?.headers.get('request-id');
     this.#resolveConnectedPromise(response);
     this._emit('connect');
@@ -407,12 +415,27 @@ export class MessageStream implements AsyncIterable<MessageStreamEvent> {
     switch (event.type) {
       case 'content_block_delta': {
         const content = messageSnapshot.content.at(-1)!;
-        if (event.delta.type === 'text_delta' && content.type === 'text') {
-          this._emit('text', event.delta.text, content.text || '');
-        } else if (event.delta.type === 'input_json_delta' && content.type === 'tool_use') {
-          if (content.input) {
-            this._emit('inputJson', event.delta.partial_json, content.input);
+        switch (event.delta.type) {
+          case 'text_delta': {
+            if (content.type === 'text') {
+              this._emit('text', event.delta.text, content.text || '');
+            }
+            break;
+          }
+          case 'citations_delta': {
+            if (content.type === 'text') {
+              this._emit('citation', event.delta.citation, content.citations ?? []);
+            }
+            break;
           }
+          case 'input_json_delta': {
+            if (content.type === 'tool_use' && content.input) {
+              this._emit('inputJson', event.delta.partial_json, content.input);
+            }
+            break;
+          }
+          default:
+            checkNever(event.delta);
         }
         break;
       }
@@ -499,25 +522,45 @@ export class MessageStream implements AsyncIterable<MessageStreamEvent> {
         return snapshot;
       case 'content_block_delta': {
         const snapshotContent = snapshot.content.at(event.index);
-        if (snapshotContent?.type === 'text' && event.delta.type === 'text_delta') {
-          snapshotContent.text += event.delta.text;
-        } else if (snapshotContent?.type === 'tool_use' && event.delta.type === 'input_json_delta') {
-          // we need to keep track of the raw JSON string as well so that we can
-          // re-parse it for each delta, for now we just store it as an untyped
-          // non-enumerable property on the snapshot
-          let jsonBuf = (snapshotContent as any)[JSON_BUF_PROPERTY] || '';
-          jsonBuf += event.delta.partial_json;
-
-          Object.defineProperty(snapshotContent, JSON_BUF_PROPERTY, {
-            value: jsonBuf,
-            enumerable: false,
-            writable: true,
-          });
-
-          if (jsonBuf) {
-            snapshotContent.input = partialParse(jsonBuf);
+
+        switch (event.delta.type) {
+          case 'text_delta': {
+            if (snapshotContent?.type === 'text') {
+              snapshotContent.text += event.delta.text;
+            }
+            break;
           }
+          case 'citations_delta': {
+            if (snapshotContent?.type === 'text') {
+              snapshotContent.citations ??= [];
+              snapshotContent.citations.push(event.delta.citation);
+            }
+            break;
+          }
+          case 'input_json_delta': {
+            if (snapshotContent?.type === 'tool_use') {
+              // we need to keep track of the raw JSON string as well so that we can
+              // re-parse it for each delta, for now we just store it as an untyped
+              // non-enumerable property on the snapshot
+              let jsonBuf = (snapshotContent as any)[JSON_BUF_PROPERTY] || '';
+              jsonBuf += event.delta.partial_json;
+
+              Object.defineProperty(snapshotContent, JSON_BUF_PROPERTY, {
+                value: jsonBuf,
+                enumerable: false,
+                writable: true,
+              });
+
+              if (jsonBuf) {
+                snapshotContent.input = partialParse(jsonBuf);
+              }
+            }
+            break;
+          }
+          default:
+            checkNever(event.delta);
         }
+
         return snapshot;
       }
       case 'content_block_stop':
@@ -591,3 +634,6 @@ export class MessageStream implements AsyncIterable<MessageStreamEvent> {
     return stream.toReadableStream();
   }
 }
+
+// used to ensure exhaustive case matching without throwing a runtime error
+function checkNever(x: never) {}

package/src/resources/beta/beta.ts

@@ -8,8 +8,18 @@ import {
   BetaBase64PDFBlock,
   BetaBase64PDFSource,
   BetaCacheControlEphemeral,
+  BetaCitationCharLocation,
+  BetaCitationCharLocationParam,
+  BetaCitationContentBlockLocation,
+  BetaCitationContentBlockLocationParam,
+  BetaCitationPageLocation,
+  BetaCitationPageLocationParam,
+  BetaCitationsConfigParam,
+  BetaCitationsDelta,
   BetaContentBlock,
   BetaContentBlockParam,
+  BetaContentBlockSource,
+  BetaContentBlockSourceContent,
   BetaImageBlockParam,
   BetaInputJSONDelta,
   BetaMessage,
@@ -17,6 +27,7 @@ import {
   BetaMessageParam,
   BetaMessageTokensCount,
   BetaMetadata,
+  BetaPlainTextSource,
   BetaRawContentBlockDeltaEvent,
   BetaRawContentBlockStartEvent,
   BetaRawContentBlockStopEvent,
@@ -26,6 +37,8 @@ import {
   BetaRawMessageStreamEvent,
   BetaTextBlock,
   BetaTextBlockParam,
+  BetaTextCitation,
+  BetaTextCitationParam,
   BetaTextDelta,
   BetaTool,
   BetaToolBash20241022,
@@ -163,8 +176,18 @@ export declare namespace Beta {
     type BetaBase64PDFBlock as BetaBase64PDFBlock,
     type BetaBase64PDFSource as BetaBase64PDFSource,
     type BetaCacheControlEphemeral as BetaCacheControlEphemeral,
+    type BetaCitationCharLocation as BetaCitationCharLocation,
+    type BetaCitationCharLocationParam as BetaCitationCharLocationParam,
+    type BetaCitationContentBlockLocation as BetaCitationContentBlockLocation,
+    type BetaCitationContentBlockLocationParam as BetaCitationContentBlockLocationParam,
+    type BetaCitationPageLocation as BetaCitationPageLocation,
+    type BetaCitationPageLocationParam as BetaCitationPageLocationParam,
+    type BetaCitationsConfigParam as BetaCitationsConfigParam,
+    type BetaCitationsDelta as BetaCitationsDelta,
     type BetaContentBlock as BetaContentBlock,
     type BetaContentBlockParam as BetaContentBlockParam,
+    type BetaContentBlockSource as BetaContentBlockSource,
+    type BetaContentBlockSourceContent as BetaContentBlockSourceContent,
     type BetaImageBlockParam as BetaImageBlockParam,
     type BetaInputJSONDelta as BetaInputJSONDelta,
     type BetaMessage as BetaMessage,
@@ -172,6 +195,7 @@ export declare namespace Beta {
     type BetaMessageParam as BetaMessageParam,
     type BetaMessageTokensCount as BetaMessageTokensCount,
     type BetaMetadata as BetaMetadata,
+    type BetaPlainTextSource as BetaPlainTextSource,
     type BetaRawContentBlockDeltaEvent as BetaRawContentBlockDeltaEvent,
     type BetaRawContentBlockStartEvent as BetaRawContentBlockStartEvent,
     type BetaRawContentBlockStopEvent as BetaRawContentBlockStopEvent,
@@ -181,6 +205,8 @@ export declare namespace Beta {
     type BetaRawMessageStreamEvent as BetaRawMessageStreamEvent,
     type BetaTextBlock as BetaTextBlock,
     type BetaTextBlockParam as BetaTextBlockParam,
+    type BetaTextCitation as BetaTextCitation,
+    type BetaTextCitationParam as BetaTextCitationParam,
     type BetaTextDelta as BetaTextDelta,
     type BetaTool as BetaTool,
     type BetaToolBash20241022 as BetaToolBash20241022,

package/src/resources/beta/index.ts

@@ -21,8 +21,18 @@ export {
   type BetaBase64PDFBlock,
   type BetaBase64PDFSource,
   type BetaCacheControlEphemeral,
+  type BetaCitationCharLocation,
+  type BetaCitationCharLocationParam,
+  type BetaCitationContentBlockLocation,
+  type BetaCitationContentBlockLocationParam,
+  type BetaCitationPageLocation,
+  type BetaCitationPageLocationParam,
+  type BetaCitationsConfigParam,
+  type BetaCitationsDelta,
   type BetaContentBlock,
   type BetaContentBlockParam,
+  type BetaContentBlockSource,
+  type BetaContentBlockSourceContent,
   type BetaImageBlockParam,
   type BetaInputJSONDelta,
   type BetaMessage,
@@ -30,6 +40,7 @@ export {
   type BetaMessageParam,
   type BetaMessageTokensCount,
   type BetaMetadata,
+  type BetaPlainTextSource,
   type BetaRawContentBlockDeltaEvent,
   type BetaRawContentBlockStartEvent,
   type BetaRawContentBlockStopEvent,
@@ -39,6 +50,8 @@ export {
   type BetaRawMessageStreamEvent,
   type BetaTextBlock,
   type BetaTextBlockParam,
+  type BetaTextCitation,
+  type BetaTextCitationParam,
   type BetaTextDelta,
   type BetaTool,
   type BetaToolBash20241022,

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

@@ -86,9 +86,10 @@ export class Batches extends APIResource {
   }
 
   /**
-   * This endpoint is idempotent and can be used to poll for Message Batch
-   * completion. To access the results of a Message Batch, make a request to the
-   * `results_url` field in the response.
+   * Delete a Message Batch.
+   *
+   * Message Batches can only be deleted once they've finished processing. If you'd
+   * like to delete an in-progress batch, you must first cancel it.
    */
   delete(
     messageBatchId: string,
@@ -298,6 +299,10 @@ export interface BetaMessageBatchExpiredResult {
   type: 'expired';
 }
 
+/**
+ * This is a single line in the response `.jsonl` file and does not represent the
+ * response as a whole.
+ */
 export interface BetaMessageBatchIndividualResponse {
   /**
    * Developer-provided ID created for each request in a Message Batch. Useful for

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

@@ -24,8 +24,18 @@ export {
   type BetaBase64PDFBlock,
   type BetaBase64PDFSource,
   type BetaCacheControlEphemeral,
+  type BetaCitationCharLocation,
+  type BetaCitationCharLocationParam,
+  type BetaCitationContentBlockLocation,
+  type BetaCitationContentBlockLocationParam,
+  type BetaCitationPageLocation,
+  type BetaCitationPageLocationParam,
+  type BetaCitationsConfigParam,
+  type BetaCitationsDelta,
   type BetaContentBlock,
   type BetaContentBlockParam,
+  type BetaContentBlockSource,
+  type BetaContentBlockSourceContent,
   type BetaImageBlockParam,
   type BetaInputJSONDelta,
   type BetaMessage,
@@ -33,6 +43,7 @@ export {
   type BetaMessageParam,
   type BetaMessageTokensCount,
   type BetaMetadata,
+  type BetaPlainTextSource,
   type BetaRawContentBlockDeltaEvent,
   type BetaRawContentBlockStartEvent,
   type BetaRawContentBlockStopEvent,
@@ -42,6 +53,8 @@ export {
   type BetaRawMessageStreamEvent,
   type BetaTextBlock,
   type BetaTextBlockParam,
+  type BetaTextCitation,
+  type BetaTextCitationParam,
   type BetaTextDelta,
   type BetaTool,
   type BetaToolBash20241022,

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

@@ -120,11 +120,17 @@ export class Messages extends APIResource {
 export type BetaMessageStreamParams = MessageCreateParamsBase;
 
 export interface BetaBase64PDFBlock {
-  source: BetaBase64PDFSource;
+  source: BetaBase64PDFSource | BetaPlainTextSource | BetaContentBlockSource;
 
   type: 'document';
 
   cache_control?: BetaCacheControlEphemeral | null;
+
+  citations?: BetaCitationsConfigParam;
+
+  context?: string | null;
+
+  title?: string | null;
 }
 
 export interface BetaBase64PDFSource {
@@ -139,6 +145,100 @@ export interface BetaCacheControlEphemeral {
   type: 'ephemeral';
 }
 
+export interface BetaCitationCharLocation {
+  cited_text: string;
+
+  document_index: number;
+
+  document_title: string | null;
+
+  end_char_index: number;
+
+  start_char_index: number;
+
+  type: 'char_location';
+}
+
+export interface BetaCitationCharLocationParam {
+  cited_text: string;
+
+  document_index: number;
+
+  document_title: string | null;
+
+  end_char_index: number;
+
+  start_char_index: number;
+
+  type: 'char_location';
+}
+
+export interface BetaCitationContentBlockLocation {
+  cited_text: string;
+
+  document_index: number;
+
+  document_title: string | null;
+
+  end_block_index: number;
+
+  start_block_index: number;
+
+  type: 'content_block_location';
+}
+
+export interface BetaCitationContentBlockLocationParam {
+  cited_text: string;
+
+  document_index: number;
+
+  document_title: string | null;
+
+  end_block_index: number;
+
+  start_block_index: number;
+
+  type: 'content_block_location';
+}
+
+export interface BetaCitationPageLocation {
+  cited_text: string;
+
+  document_index: number;
+
+  document_title: string | null;
+
+  end_page_number: number;
+
+  start_page_number: number;
+
+  type: 'page_location';
+}
+
+export interface BetaCitationPageLocationParam {
+  cited_text: string;
+
+  document_index: number;
+
+  document_title: string | null;
+
+  end_page_number: number;
+
+  start_page_number: number;
+
+  type: 'page_location';
+}
+
+export interface BetaCitationsConfigParam {
+  enabled?: boolean;
+}
+
+export interface BetaCitationsDelta {
+  citation: BetaCitationCharLocation | BetaCitationPageLocation | BetaCitationContentBlockLocation;
+
+  type: 'citations_delta';
+}
+
 export type BetaContentBlock = BetaTextBlock | BetaToolUseBlock;
 
 export type BetaContentBlockParam =
@@ -148,6 +248,14 @@ export type BetaContentBlockParam =
   | BetaToolResultBlockParam
   | BetaBase64PDFBlock;
 
+export interface BetaContentBlockSource {
+  content: string | Array<BetaContentBlockSourceContent>;
+
+  type: 'content';
+}
+
+export type BetaContentBlockSourceContent = BetaTextBlockParam | BetaImageBlockParam;
+
 export interface BetaImageBlockParam {
   source: BetaImageBlockParam.Source;
 
@@ -309,8 +417,16 @@ export interface BetaMetadata {
   user_id?: string | null;
 }
 
+export interface BetaPlainTextSource {
+  data: string;
+
+  media_type: 'text/plain';
+
+  type: 'text';
+}
+
 export interface BetaRawContentBlockDeltaEvent {
-  delta: BetaTextDelta | BetaInputJSONDelta;
+  delta: BetaTextDelta | BetaInputJSONDelta | BetaCitationsDelta;
 
   index: number;
 
@@ -380,6 +496,15 @@ export type BetaRawMessageStreamEvent =
   | BetaRawContentBlockStopEvent;
 
 export interface BetaTextBlock {
+  /**
+   * Citations supporting the text block.
+   *
+   * The type of citation returned will depend on the type of document being cited.
+   * Citing a PDF results in `page_location`, plain text results in `char_location`,
+   * and content document results in `content_block_location`.
+   */
+  citations: Array<BetaTextCitation> | null;
+
   text: string;
 
   type: 'text';
@@ -391,8 +516,20 @@ export interface BetaTextBlockParam {
   type: 'text';
 
   cache_control?: BetaCacheControlEphemeral | null;
+
+  citations?: Array<BetaTextCitationParam> | null;
 }
 
+export type BetaTextCitation =
+  | BetaCitationCharLocation
+  | BetaCitationPageLocation
+  | BetaCitationContentBlockLocation;
+
+export type BetaTextCitationParam =
+  | BetaCitationCharLocationParam
+  | BetaCitationPageLocationParam
+  | BetaCitationContentBlockLocationParam;
+
 export interface BetaTextDelta {
   text: string;
 
@@ -1110,8 +1247,18 @@ export declare namespace Messages {
     type BetaBase64PDFBlock as BetaBase64PDFBlock,
     type BetaBase64PDFSource as BetaBase64PDFSource,
     type BetaCacheControlEphemeral as BetaCacheControlEphemeral,
+    type BetaCitationCharLocation as BetaCitationCharLocation,
+    type BetaCitationCharLocationParam as BetaCitationCharLocationParam,
+    type BetaCitationContentBlockLocation as BetaCitationContentBlockLocation,
+    type BetaCitationContentBlockLocationParam as BetaCitationContentBlockLocationParam,
+    type BetaCitationPageLocation as BetaCitationPageLocation,
+    type BetaCitationPageLocationParam as BetaCitationPageLocationParam,
+    type BetaCitationsConfigParam as BetaCitationsConfigParam,
+    type BetaCitationsDelta as BetaCitationsDelta,
     type BetaContentBlock as BetaContentBlock,
     type BetaContentBlockParam as BetaContentBlockParam,
+    type BetaContentBlockSource as BetaContentBlockSource,
+    type BetaContentBlockSourceContent as BetaContentBlockSourceContent,
     type BetaImageBlockParam as BetaImageBlockParam,
     type BetaInputJSONDelta as BetaInputJSONDelta,
     type BetaMessage as BetaMessage,
@@ -1119,6 +1266,7 @@ export declare namespace Messages {
     type BetaMessageParam as BetaMessageParam,
     type BetaMessageTokensCount as BetaMessageTokensCount,
     type BetaMetadata as BetaMetadata,
+    type BetaPlainTextSource as BetaPlainTextSource,
     type BetaRawContentBlockDeltaEvent as BetaRawContentBlockDeltaEvent,
     type BetaRawContentBlockStartEvent as BetaRawContentBlockStartEvent,
     type BetaRawContentBlockStopEvent as BetaRawContentBlockStopEvent,
@@ -1128,6 +1276,8 @@ export declare namespace Messages {
     type BetaRawMessageStreamEvent as BetaRawMessageStreamEvent,
     type BetaTextBlock as BetaTextBlock,
     type BetaTextBlockParam as BetaTextBlockParam,
+    type BetaTextCitation as BetaTextCitation,
+    type BetaTextCitationParam as BetaTextCitationParam,
     type BetaTextDelta as BetaTextDelta,
     type BetaTool as BetaTool,
     type BetaToolBash20241022 as BetaToolBash20241022,

package/src/resources/index.ts

@@ -27,9 +27,19 @@ export {
   Messages,
   type Base64PDFSource,
   type CacheControlEphemeral,
+  type CitationCharLocation,
+  type CitationCharLocationParam,
+  type CitationContentBlockLocation,
+  type CitationContentBlockLocationParam,
+  type CitationPageLocation,
+  type CitationPageLocationParam,
+  type CitationsConfigParam,
+  type CitationsDelta,
   type ContentBlock,
   type ContentBlockDeltaEvent,
   type ContentBlockParam,
+  type ContentBlockSource,
+  type ContentBlockSourceContent,
   type ContentBlockStartEvent,
   type ContentBlockStopEvent,
   type DocumentBlockParam,
@@ -47,6 +57,7 @@ export {
   type MessageTokensCount,
   type Metadata,
   type Model,
+  type PlainTextSource,
   type RawContentBlockDeltaEvent,
   type RawContentBlockStartEvent,
   type RawContentBlockStopEvent,
@@ -56,6 +67,8 @@ export {
   type RawMessageStreamEvent,
   type TextBlock,
   type TextBlockParam,
+  type TextCitation,
+  type TextCitationParam,
   type TextDelta,
   type Tool,
   type ToolChoice,

package/src/resources/messages/batches.ts

@@ -50,9 +50,10 @@ export class Batches extends APIResource {
   }
 
   /**
-   * This endpoint is idempotent and can be used to poll for Message Batch
-   * completion. To access the results of a Message Batch, make a request to the
-   * `results_url` field in the response.
+   * Delete a Message Batch.
+   *
+   * Message Batches can only be deleted once they've finished processing. If you'd
+   * like to delete an in-progress batch, you must first cancel it.
    */
   delete(messageBatchId: string, options?: Core.RequestOptions): Core.APIPromise<DeletedMessageBatch> {
     return this._client.delete(`/v1/messages/batches/${messageBatchId}`, options);
@@ -206,6 +207,10 @@ export interface MessageBatchExpiredResult {
   type: 'expired';
 }
 
+/**
+ * This is a single line in the response `.jsonl` file and does not represent the
+ * response as a whole.
+ */
 export interface MessageBatchIndividualResponse {
   /**
    * Developer-provided ID created for each request in a Message Batch. Useful for

package/src/resources/messages/index.ts

@@ -19,9 +19,19 @@ export {
   Messages,
   type Base64PDFSource,
   type CacheControlEphemeral,
+  type CitationCharLocation,
+  type CitationCharLocationParam,
+  type CitationContentBlockLocation,
+  type CitationContentBlockLocationParam,
+  type CitationPageLocation,
+  type CitationPageLocationParam,
+  type CitationsConfigParam,
+  type CitationsDelta,
   type ContentBlock,
   type ContentBlockDeltaEvent,
   type ContentBlockParam,
+  type ContentBlockSource,
+  type ContentBlockSourceContent,
   type ContentBlockStartEvent,
   type ContentBlockStopEvent,
   type DocumentBlockParam,
@@ -37,6 +47,7 @@ export {
   type MessageTokensCount,
   type Metadata,
   type Model,
+  type PlainTextSource,
   type RawContentBlockDeltaEvent,
   type RawContentBlockStartEvent,
   type RawContentBlockStopEvent,
@@ -46,6 +57,8 @@ export {
   type RawMessageStreamEvent,
   type TextBlock,
   type TextBlockParam,
+  type TextCitation,
+  type TextCitationParam,
   type TextDelta,
   type Tool,
   type ToolChoice,