@anthropic-ai/sdk 0.28.0 → 0.29.1

package/src/resources/beta/index.ts

@@ -1,4 +1,50 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Beta } from "./beta.js";
+export {
+  AnthropicBeta,
+  BetaAPIError,
+  BetaAuthenticationError,
+  BetaError,
+  BetaErrorResponse,
+  BetaInvalidRequestError,
+  BetaNotFoundError,
+  BetaOverloadedError,
+  BetaPermissionError,
+  BetaRateLimitError,
+  Beta,
+} from "./beta.js";
+export {
+  BetaCacheControlEphemeral,
+  BetaContentBlock,
+  BetaContentBlockParam,
+  BetaImageBlockParam,
+  BetaInputJSONDelta,
+  BetaMessage,
+  BetaMessageDeltaUsage,
+  BetaMessageParam,
+  BetaMetadata,
+  BetaRawContentBlockDeltaEvent,
+  BetaRawContentBlockStartEvent,
+  BetaRawContentBlockStopEvent,
+  BetaRawMessageDeltaEvent,
+  BetaRawMessageStartEvent,
+  BetaRawMessageStopEvent,
+  BetaRawMessageStreamEvent,
+  BetaTextBlock,
+  BetaTextBlockParam,
+  BetaTextDelta,
+  BetaTool,
+  BetaToolChoice,
+  BetaToolChoiceAny,
+  BetaToolChoiceAuto,
+  BetaToolChoiceTool,
+  BetaToolResultBlockParam,
+  BetaToolUseBlock,
+  BetaToolUseBlockParam,
+  BetaUsage,
+  MessageCreateParams,
+  MessageCreateParamsNonStreaming,
+  MessageCreateParamsStreaming,
+  Messages,
+} from "./messages/index.js";
 export { PromptCaching } from "./prompt-caching/index.js";

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

@@ -0,0 +1,393 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from "../../../resource.js";
+import { isRequestOptions } from "../../../core.js";
+import * as Core from "../../../core.js";
+import * as BatchesAPI from "./batches.js";
+import * as BetaAPI from "../beta.js";
+import * as BetaMessagesAPI from "./messages.js";
+import { Page, type PageParams } from "../../../pagination.js";
+import { JSONLDecoder } from "../../../internal/decoders/jsonl.js";
+import { AnthropicError } from "../../../error.js";
+
+export class Batches extends APIResource {
+  /**
+   * Send a batch of requests to create Messages.
+   *
+   * The Messages Batch API can be used to process multiple Messages API requests at
+   * once. Once a Message Batch is created, it begins processing immediately.
+   */
+  create(params: BatchCreateParams, options?: Core.RequestOptions): Core.APIPromise<BetaMessageBatch> {
+    const { betas, ...body } = params;
+    return this._client.post('/v1/messages/batches?beta=true', {
+      body,
+      ...options,
+      headers: {
+        'anthropic-beta': [...(betas ?? []), 'message-batches-2024-09-24'].toString(),
+        ...options?.headers,
+      },
+    });
+  }
+
+  /**
+   * This endpoint is idempotent and can be used to poll for Message Batch
+   * completion. To access the results of a Message Batch, use the `responses_url`
+   * field in the response.
+   */
+  retrieve(
+    messageBatchId: string,
+    params?: BatchRetrieveParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BetaMessageBatch>;
+  retrieve(messageBatchId: string, options?: Core.RequestOptions): Core.APIPromise<BetaMessageBatch>;
+  retrieve(
+    messageBatchId: string,
+    params: BatchRetrieveParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BetaMessageBatch> {
+    if (isRequestOptions(params)) {
+      return this.retrieve(messageBatchId, {}, params);
+    }
+    const { betas } = params;
+    return this._client.get(`/v1/messages/batches/${messageBatchId}?beta=true`, {
+      ...options,
+      headers: {
+        'anthropic-beta': [...(betas ?? []), 'message-batches-2024-09-24'].toString(),
+        ...options?.headers,
+      },
+    });
+  }
+
+  /**
+   * List all Message Batches within a Workspace.
+   */
+  list(
+    params?: BatchListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<BetaMessageBatchesPage, BetaMessageBatch>;
+  list(options?: Core.RequestOptions): Core.PagePromise<BetaMessageBatchesPage, BetaMessageBatch>;
+  list(
+    params: BatchListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<BetaMessageBatchesPage, BetaMessageBatch> {
+    if (isRequestOptions(params)) {
+      return this.list({}, params);
+    }
+    const { betas, ...query } = params;
+    return this._client.getAPIList('/v1/messages/batches?beta=true', BetaMessageBatchesPage, {
+      query,
+      ...options,
+      headers: {
+        'anthropic-beta': [...(betas ?? []), 'message-batches-2024-09-24'].toString(),
+        ...options?.headers,
+      },
+    });
+  }
+
+  /**
+   * Batches may be canceled any time before processing ends. The system may complete
+   * any in-progress, non-interruptible operations before finalizing cancellation.
+   */
+  cancel(
+    messageBatchId: string,
+    params?: BatchCancelParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BetaMessageBatch>;
+  cancel(messageBatchId: string, options?: Core.RequestOptions): Core.APIPromise<BetaMessageBatch>;
+  cancel(
+    messageBatchId: string,
+    params: BatchCancelParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BetaMessageBatch> {
+    if (isRequestOptions(params)) {
+      return this.cancel(messageBatchId, {}, params);
+    }
+    const { betas } = params;
+    return this._client.post(`/v1/messages/batches/${messageBatchId}/cancel?beta=true`, {
+      ...options,
+      headers: {
+        'anthropic-beta': [...(betas ?? []), 'message-batches-2024-09-24'].toString(),
+        ...options?.headers,
+      },
+    });
+  }
+
+  /**
+   * Streams the results of a Message Batch as a `.jsonl` file.
+   *
+   * Each line in the file is a JSON object containing the result of a single request
+   * in the Message Batch. Results are not guaranteed to be in the same order as
+   * requests. Use the `custom_id` field to match results to requests.
+   */
+  async results(
+    messageBatchId: string,
+    params?: BatchResultsParams,
+    options?: Core.RequestOptions,
+  ): Promise<JSONLDecoder<BetaMessageBatchIndividualResponse>>;
+  async results(
+    messageBatchId: string,
+    options?: Core.RequestOptions,
+  ): Promise<JSONLDecoder<BetaMessageBatchIndividualResponse>>;
+  async results(
+    messageBatchId: string,
+    params: BatchResultsParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Promise<JSONLDecoder<BetaMessageBatchIndividualResponse>> {
+    if (isRequestOptions(params)) {
+      return this.results(messageBatchId, {}, params);
+    }
+
+    const batch = await this.retrieve(messageBatchId);
+    if (!batch.results_url) {
+      throw new AnthropicError(
+        `No batch \`results_url\`; Has it finished processing? ${batch.processing_status} - ${batch.id}`,
+      );
+    }
+
+    const { betas } = params;
+    return this._client
+      .get(batch.results_url, {
+        ...options,
+        headers: {
+          'anthropic-beta': [...(betas ?? []), 'message-batches-2024-09-24'].toString(),
+          ...options?.headers,
+        },
+        __binaryResponse: true,
+      })
+      ._thenUnwrap((_, props) => JSONLDecoder.fromResponse(props.response, props.controller));
+  }
+}
+
+export class BetaMessageBatchesPage extends Page<BetaMessageBatch> {}
+
+export interface BetaMessageBatch {
+  /**
+   * Unique object identifier.
+   *
+   * The format and length of IDs may change over time.
+   */
+  id: string;
+
+  /**
+   * RFC 3339 datetime string representing the time at which cancellation was
+   * initiated for the Message Batch. Specified only if cancellation was initiated.
+   */
+  cancel_initiated_at: string | null;
+
+  /**
+   * RFC 3339 datetime string representing the time at which the Message Batch was
+   * created.
+   */
+  created_at: string;
+
+  /**
+   * RFC 3339 datetime string representing the time at which processing for the
+   * Message Batch ended. Specified only once processing ends.
+   *
+   * Processing ends when every request in a Message Batch has either succeeded,
+   * errored, canceled, or expired.
+   */
+  ended_at: string | null;
+
+  /**
+   * RFC 3339 datetime string representing the time at which the Message Batch will
+   * expire and end processing, which is 24 hours after creation.
+   */
+  expires_at: string;
+
+  /**
+   * Processing status of the Message Batch.
+   *
+   * This is one of: `in_progress`, `canceling`, or `ended`.
+   */
+  processing_status: 'in_progress' | 'canceling' | 'ended';
+
+  /**
+   * Overview of the number of requests within the Message Batch and their statuses.
+   *
+   * Requests start as `processing` and move to one of the other statuses only once
+   * processing of entire batch ends.
+   */
+  request_counts: BetaMessageBatchRequestCounts;
+
+  /**
+   * URL to a `.jsonl` file containing the results of the Message Batch requests.
+   * Specified only once processing ends.
+   *
+   * Results in the file are not guaranteed to be in the same order as requests. Use
+   * the `custom_id` field to match results to requests.
+   */
+  results_url: string | null;
+
+  /**
+   * Object type.
+   *
+   * For Message Batches, this is always `"message_batch"`.
+   */
+  type: 'message_batch';
+}
+
+export interface BetaMessageBatchCanceledResult {
+  type: 'canceled';
+}
+
+export interface BetaMessageBatchErroredResult {
+  error: BetaAPI.BetaErrorResponse;
+
+  type: 'errored';
+}
+
+export interface BetaMessageBatchExpiredResult {
+  type: 'expired';
+}
+
+export interface BetaMessageBatchIndividualResponse {
+  /**
+   * Developer-provided ID created for each request in a Message Batch. Useful for
+   * matching results to requests.
+   *
+   * Must be unique for each request within the Message Batch.
+   */
+  custom_id: string;
+
+  /**
+   * Processing result for this request.
+   *
+   * Contains a Message output if processing was successful, an error response if
+   * processing failed, or the reason why processing was not attempted, such as
+   * cancellation or expiration.
+   */
+  result: BetaMessageBatchResult;
+}
+
+export interface BetaMessageBatchRequestCounts {
+  /**
+   * Number of requests in the Message Batch that have been canceled.
+   *
+   * This is zero until processing of the entire Message Batch has ended.
+   */
+  canceled: number;
+
+  /**
+   * Number of requests in the Message Batch that encountered an error.
+   *
+   * This is zero until processing of the entire Message Batch has ended.
+   */
+  errored: number;
+
+  /**
+   * Number of requests in the Message Batch that have expired.
+   *
+   * This is zero until processing of the entire Message Batch has ended.
+   */
+  expired: number;
+
+  /**
+   * Number of requests in the Message Batch that are processing.
+   */
+  processing: number;
+
+  /**
+   * Number of requests in the Message Batch that have completed successfully.
+   *
+   * This is zero until processing of the entire Message Batch has ended.
+   */
+  succeeded: number;
+}
+
+/**
+ * Processing result for this request.
+ *
+ * Contains a Message output if processing was successful, an error response if
+ * processing failed, or the reason why processing was not attempted, such as
+ * cancellation or expiration.
+ */
+export type BetaMessageBatchResult =
+  | BetaMessageBatchSucceededResult
+  | BetaMessageBatchErroredResult
+  | BetaMessageBatchCanceledResult
+  | BetaMessageBatchExpiredResult;
+
+export interface BetaMessageBatchSucceededResult {
+  message: BetaMessagesAPI.BetaMessage;
+
+  type: 'succeeded';
+}
+
+export interface BatchCreateParams {
+  /**
+   * Body param: List of requests for prompt completion. Each is an individual
+   * request to create a Message.
+   */
+  requests: Array<BatchCreateParams.Request>;
+
+  /**
+   * Header param: Optional header to specify the beta version(s) you want to use.
+   */
+  betas?: Array<BetaAPI.AnthropicBeta>;
+}
+
+export namespace BatchCreateParams {
+  export interface Request {
+    /**
+     * Developer-provided ID created for each request in a Message Batch. Useful for
+     * matching results to requests.
+     *
+     * Must be unique for each request within the Message Batch.
+     */
+    custom_id: string;
+
+    /**
+     * Messages API creation parameters for the individual request.
+     *
+     * See the [Messages API reference](/en/api/messages) for full documentation on
+     * available parameters.
+     */
+    params: BetaMessagesAPI.MessageCreateParamsNonStreaming;
+  }
+}
+
+export interface BatchRetrieveParams {
+  /**
+   * Optional header to specify the beta version(s) you want to use.
+   */
+  betas?: Array<BetaAPI.AnthropicBeta>;
+}
+
+export interface BatchListParams extends PageParams {
+  /**
+   * Header param: Optional header to specify the beta version(s) you want to use.
+   */
+  betas?: Array<BetaAPI.AnthropicBeta>;
+}
+
+export interface BatchCancelParams {
+  /**
+   * Optional header to specify the beta version(s) you want to use.
+   */
+  betas?: Array<BetaAPI.AnthropicBeta>;
+}
+
+export interface BatchResultsParams {
+  /**
+   * Optional header to specify the beta version(s) you want to use.
+   */
+  betas?: Array<BetaAPI.AnthropicBeta>;
+}
+
+export namespace Batches {
+  export import BetaMessageBatch = BatchesAPI.BetaMessageBatch;
+  export import BetaMessageBatchCanceledResult = BatchesAPI.BetaMessageBatchCanceledResult;
+  export import BetaMessageBatchErroredResult = BatchesAPI.BetaMessageBatchErroredResult;
+  export import BetaMessageBatchExpiredResult = BatchesAPI.BetaMessageBatchExpiredResult;
+  export import BetaMessageBatchIndividualResponse = BatchesAPI.BetaMessageBatchIndividualResponse;
+  export import BetaMessageBatchRequestCounts = BatchesAPI.BetaMessageBatchRequestCounts;
+  export import BetaMessageBatchResult = BatchesAPI.BetaMessageBatchResult;
+  export import BetaMessageBatchSucceededResult = BatchesAPI.BetaMessageBatchSucceededResult;
+  export import BetaMessageBatchesPage = BatchesAPI.BetaMessageBatchesPage;
+  export import BatchCreateParams = BatchesAPI.BatchCreateParams;
+  export import BatchRetrieveParams = BatchesAPI.BatchRetrieveParams;
+  export import BatchListParams = BatchesAPI.BatchListParams;
+  export import BatchCancelParams = BatchesAPI.BatchCancelParams;
+  export import BatchResultsParams = BatchesAPI.BatchResultsParams;
+}

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

@@ -0,0 +1,53 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  BetaCacheControlEphemeral,
+  BetaContentBlock,
+  BetaContentBlockParam,
+  BetaImageBlockParam,
+  BetaInputJSONDelta,
+  BetaMessage,
+  BetaMessageDeltaUsage,
+  BetaMessageParam,
+  BetaMetadata,
+  BetaRawContentBlockDeltaEvent,
+  BetaRawContentBlockStartEvent,
+  BetaRawContentBlockStopEvent,
+  BetaRawMessageDeltaEvent,
+  BetaRawMessageStartEvent,
+  BetaRawMessageStopEvent,
+  BetaRawMessageStreamEvent,
+  BetaTextBlock,
+  BetaTextBlockParam,
+  BetaTextDelta,
+  BetaTool,
+  BetaToolChoice,
+  BetaToolChoiceAny,
+  BetaToolChoiceAuto,
+  BetaToolChoiceTool,
+  BetaToolResultBlockParam,
+  BetaToolUseBlock,
+  BetaToolUseBlockParam,
+  BetaUsage,
+  MessageCreateParams,
+  MessageCreateParamsNonStreaming,
+  MessageCreateParamsStreaming,
+  Messages,
+} from "./messages.js";
+export {
+  BetaMessageBatch,
+  BetaMessageBatchCanceledResult,
+  BetaMessageBatchErroredResult,
+  BetaMessageBatchExpiredResult,
+  BetaMessageBatchIndividualResponse,
+  BetaMessageBatchRequestCounts,
+  BetaMessageBatchResult,
+  BetaMessageBatchSucceededResult,
+  BatchCreateParams,
+  BatchRetrieveParams,
+  BatchListParams,
+  BatchCancelParams,
+  BatchResultsParams,
+  BetaMessageBatchesPage,
+  Batches,
+} from "./batches.js";