@tetral-ai/sdk 0.110.0-alpha.1

package/src/resources/messages/batches.ts

@@ -0,0 +1,414 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import * as MessagesAPI from './messages';
+import { APIPromise } from '../../core/api-promise';
+import { Page, type PageParams, PagePromise } from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { JSONLDecoder } from '../../internal/decoders/jsonl';
+import { AnthropicError } from '../../error';
+import { path } from '../../internal/utils/path';
+
+export class Batches extends APIResource {
+  /**
+   * Send a batch of Message creation requests.
+   *
+   * The Message Batches API can be used to process multiple Messages API requests at
+   * once. Once a Message Batch is created, it begins processing immediately. Batches
+   * can take up to 24 hours to complete.
+   *
+   * Learn more about the Message Batches API in our
+   * [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
+   *
+   * @example
+   * ```ts
+   * const messageBatch = await client.messages.batches.create({
+   *   requests: [
+   *     {
+   *       custom_id: 'my-custom-id-1',
+   *       params: {
+   *         max_tokens: 1024,
+   *         messages: [
+   *           { content: 'Hello, world', role: 'user' },
+   *         ],
+   *         model: 'claude-opus-4-6',
+   *       },
+   *     },
+   *   ],
+   * });
+   * ```
+   */
+  create(params: BatchCreateParams, options?: RequestOptions): APIPromise<MessageBatch> {
+    const { user_profile_id, ...body } = params;
+    return this._client.post('/v1/messages/batches', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(user_profile_id != null ? { 'anthropic-user-profile-id': user_profile_id } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * 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.
+   *
+   * Learn more about the Message Batches API in our
+   * [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
+   *
+   * @example
+   * ```ts
+   * const messageBatch = await client.messages.batches.retrieve(
+   *   'message_batch_id',
+   * );
+   * ```
+   */
+  retrieve(messageBatchID: string, options?: RequestOptions): APIPromise<MessageBatch> {
+    return this._client.get(path`/v1/messages/batches/${messageBatchID}`, options);
+  }
+
+  /**
+   * List all Message Batches within a Workspace. Most recently created batches are
+   * returned first.
+   *
+   * Learn more about the Message Batches API in our
+   * [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const messageBatch of client.messages.batches.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: BatchListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<MessageBatchesPage, MessageBatch> {
+    return this._client.getAPIList('/v1/messages/batches', Page<MessageBatch>, { query, ...options });
+  }
+
+  /**
+   * 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.
+   *
+   * Learn more about the Message Batches API in our
+   * [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
+   *
+   * @example
+   * ```ts
+   * const deletedMessageBatch =
+   *   await client.messages.batches.delete('message_batch_id');
+   * ```
+   */
+  delete(messageBatchID: string, options?: RequestOptions): APIPromise<DeletedMessageBatch> {
+    return this._client.delete(path`/v1/messages/batches/${messageBatchID}`, options);
+  }
+
+  /**
+   * Batches may be canceled any time before processing ends. Once cancellation is
+   * initiated, the batch enters a `canceling` state, at which time the system may
+   * complete any in-progress, non-interruptible requests before finalizing
+   * cancellation.
+   *
+   * The number of canceled requests is specified in `request_counts`. To determine
+   * which requests were canceled, check the individual results within the batch.
+   * Note that cancellation may not result in any canceled requests if they were
+   * non-interruptible.
+   *
+   * Learn more about the Message Batches API in our
+   * [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
+   *
+   * @example
+   * ```ts
+   * const messageBatch = await client.messages.batches.cancel(
+   *   'message_batch_id',
+   * );
+   * ```
+   */
+  cancel(messageBatchID: string, options?: RequestOptions): APIPromise<MessageBatch> {
+    return this._client.post(path`/v1/messages/batches/${messageBatchID}/cancel`, options);
+  }
+
+  /**
+   * 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.
+   *
+   * Learn more about the Message Batches API in our
+   * [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
+   *
+   * @example
+   * ```ts
+   * const messageBatchIndividualResponse =
+   *   await client.messages.batches.results('message_batch_id');
+   * ```
+   */
+  async results(
+    messageBatchID: string,
+    options?: RequestOptions,
+  ): Promise<JSONLDecoder<MessageBatchIndividualResponse>> {
+    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}`,
+      );
+    }
+
+    return this._client
+      .get(batch.results_url, {
+        ...options,
+        headers: buildHeaders([{ Accept: 'application/binary' }, options?.headers]),
+        stream: true,
+        __binaryResponse: true,
+      })
+      ._thenUnwrap((_, props) => JSONLDecoder.fromResponse(props.response, props.controller)) as APIPromise<
+      JSONLDecoder<MessageBatchIndividualResponse>
+    >;
+  }
+}
+
+export type MessageBatchesPage = Page<MessageBatch>;
+
+export interface DeletedMessageBatch {
+  /**
+   * ID of the Message Batch.
+   */
+  id: string;
+
+  /**
+   * Deleted object type.
+   *
+   * For Message Batches, this is always `"message_batch_deleted"`.
+   */
+  type: 'message_batch_deleted';
+}
+
+export interface MessageBatch {
+  /**
+   * Unique object identifier.
+   *
+   * The format and length of IDs may change over time.
+   */
+  id: string;
+
+  /**
+   * RFC 3339 datetime string representing the time at which the Message Batch was
+   * archived and its results became unavailable.
+   */
+  archived_at: string | null;
+
+  /**
+   * 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.
+   */
+  processing_status: 'in_progress' | 'canceling' | 'ended';
+
+  /**
+   * Tallies requests within the Message Batch, categorized by their status.
+   *
+   * Requests start as `processing` and move to one of the other statuses only once
+   * processing of the entire batch ends. The sum of all values always matches the
+   * total number of requests in the batch.
+   */
+  request_counts: MessageBatchRequestCounts;
+
+  /**
+   * 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 MessageBatchCanceledResult {
+  type: 'canceled';
+}
+
+export interface MessageBatchErroredResult {
+  error: Shared.ErrorResponse;
+
+  type: 'errored';
+}
+
+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
+   * matching results to requests, as results may be given out of request order.
+   *
+   * 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: MessageBatchResult;
+}
+
+export interface MessageBatchRequestCounts {
+  /**
+   * 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 MessageBatchResult =
+  | MessageBatchSucceededResult
+  | MessageBatchErroredResult
+  | MessageBatchCanceledResult
+  | MessageBatchExpiredResult;
+
+export interface MessageBatchSucceededResult {
+  message: MessagesAPI.Message;
+
+  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: The user profile ID to attribute the requests in this batch to.
+   * Use when acting on behalf of a party other than your organization. Requires the
+   * `user-profiles` beta header. Applies to every request in the batch; an
+   * individual request whose `user_profile_id` body field conflicts with this header
+   * is errored.
+   */
+  user_profile_id?: string;
+}
+
+export namespace BatchCreateParams {
+  export interface Request {
+    /**
+     * Developer-provided ID created for each request in a Message Batch. Useful for
+     * matching results to requests, as results may be given out of request order.
+     *
+     * 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](https://platform.claude.com/docs/en/api/messages) for
+     * full documentation on available parameters.
+     */
+    params: MessagesAPI.MessageCreateParamsNonStreaming;
+  }
+}
+
+export interface BatchListParams extends PageParams {}
+
+export declare namespace Batches {
+  export {
+    type DeletedMessageBatch as DeletedMessageBatch,
+    type MessageBatch as MessageBatch,
+    type MessageBatchCanceledResult as MessageBatchCanceledResult,
+    type MessageBatchErroredResult as MessageBatchErroredResult,
+    type MessageBatchExpiredResult as MessageBatchExpiredResult,
+    type MessageBatchIndividualResponse as MessageBatchIndividualResponse,
+    type MessageBatchRequestCounts as MessageBatchRequestCounts,
+    type MessageBatchResult as MessageBatchResult,
+    type MessageBatchSucceededResult as MessageBatchSucceededResult,
+    type MessageBatchesPage as MessageBatchesPage,
+    type BatchCreateParams as BatchCreateParams,
+    type BatchListParams as BatchListParams,
+  };
+}

package/src/resources/messages/index.ts

@@ -0,0 +1,194 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Batches,
+  type DeletedMessageBatch,
+  type MessageBatch,
+  type MessageBatchCanceledResult,
+  type MessageBatchErroredResult,
+  type MessageBatchExpiredResult,
+  type MessageBatchIndividualResponse,
+  type MessageBatchRequestCounts,
+  type MessageBatchResult,
+  type MessageBatchSucceededResult,
+  type BatchCreateParams,
+  type BatchListParams,
+  type MessageBatchesPage,
+} from './batches';
+export {
+  Messages,
+  type Base64ImageSource,
+  type Base64PDFSource,
+  type BashCodeExecutionOutputBlock,
+  type BashCodeExecutionOutputBlockParam,
+  type BashCodeExecutionResultBlock,
+  type BashCodeExecutionResultBlockParam,
+  type BashCodeExecutionToolResultBlock,
+  type BashCodeExecutionToolResultBlockParam,
+  type BashCodeExecutionToolResultError,
+  type BashCodeExecutionToolResultErrorCode,
+  type BashCodeExecutionToolResultErrorParam,
+  type CacheControlEphemeral,
+  type CacheCreation,
+  type CitationCharLocation,
+  type CitationCharLocationParam,
+  type CitationContentBlockLocation,
+  type CitationContentBlockLocationParam,
+  type CitationPageLocation,
+  type CitationPageLocationParam,
+  type CitationSearchResultLocationParam,
+  type CitationWebSearchResultLocationParam,
+  type CitationsConfig,
+  type CitationsConfigParam,
+  type CitationsDelta,
+  type CitationsSearchResultLocation,
+  type CitationsWebSearchResultLocation,
+  type CodeExecutionOutputBlock,
+  type CodeExecutionOutputBlockParam,
+  type CodeExecutionResultBlock,
+  type CodeExecutionResultBlockParam,
+  type CodeExecutionTool20250522,
+  type CodeExecutionTool20250825,
+  type CodeExecutionTool20260120,
+  type CodeExecutionTool20260521,
+  type CodeExecutionToolResultBlock,
+  type CodeExecutionToolResultBlockContent,
+  type CodeExecutionToolResultBlockParam,
+  type CodeExecutionToolResultBlockParamContent,
+  type CodeExecutionToolResultError,
+  type CodeExecutionToolResultErrorCode,
+  type CodeExecutionToolResultErrorParam,
+  type Container,
+  type ContainerUploadBlock,
+  type ContainerUploadBlockParam,
+  type ContentBlock,
+  type ContentBlockParam,
+  type ContentBlockStartEvent,
+  type ContentBlockStopEvent,
+  type ContentBlockSource,
+  type ContentBlockSourceContent,
+  type DirectCaller,
+  type DocumentBlock,
+  type DocumentBlockParam,
+  type EncryptedCodeExecutionResultBlock,
+  type EncryptedCodeExecutionResultBlockParam,
+  type ImageBlockParam,
+  type InputJSONDelta,
+  type JSONOutputFormat,
+  type MemoryTool20250818,
+  type Message,
+  type MessageCountTokensTool,
+  type MessageDeltaEvent,
+  type MessageDeltaUsage,
+  type MessageParam,
+  type MessageTokensCount,
+  type Metadata,
+  type MidConversationSystemBlockParam,
+  type Model,
+  type OutputConfig,
+  type OutputTokensDetails,
+  type PlainTextSource,
+  type RawContentBlockDelta,
+  type RawContentBlockDeltaEvent,
+  type RawContentBlockStartEvent,
+  type RawContentBlockStopEvent,
+  type RawMessageDeltaEvent,
+  type RawMessageStartEvent,
+  type RawMessageStopEvent,
+  type RawMessageStreamEvent,
+  type RedactedThinkingBlock,
+  type RedactedThinkingBlockParam,
+  type RefusalStopDetails,
+  type SearchResultBlockParam,
+  type ServerToolCaller,
+  type ServerToolCaller20260120,
+  type ServerToolUsage,
+  type ServerToolUseBlock,
+  type ServerToolUseBlockParam,
+  type SignatureDelta,
+  type StopReason,
+  type TextBlock,
+  type TextBlockParam,
+  type TextCitation,
+  type TextCitationParam,
+  type TextDelta,
+  type TextEditorCodeExecutionCreateResultBlock,
+  type TextEditorCodeExecutionCreateResultBlockParam,
+  type TextEditorCodeExecutionStrReplaceResultBlock,
+  type TextEditorCodeExecutionStrReplaceResultBlockParam,
+  type TextEditorCodeExecutionToolResultBlock,
+  type TextEditorCodeExecutionToolResultBlockParam,
+  type TextEditorCodeExecutionToolResultError,
+  type TextEditorCodeExecutionToolResultErrorCode,
+  type TextEditorCodeExecutionToolResultErrorParam,
+  type TextEditorCodeExecutionViewResultBlock,
+  type TextEditorCodeExecutionViewResultBlockParam,
+  type ThinkingBlock,
+  type ThinkingBlockParam,
+  type ThinkingConfigAdaptive,
+  type ThinkingConfigDisabled,
+  type ThinkingConfigEnabled,
+  type ThinkingConfigParam,
+  type ThinkingDelta,
+  type Tool,
+  type ToolBash20250124,
+  type ToolChoice,
+  type ToolChoiceAny,
+  type ToolChoiceAuto,
+  type ToolChoiceNone,
+  type ToolChoiceTool,
+  type ToolReferenceBlock,
+  type ToolReferenceBlockParam,
+  type ToolResultBlockParam,
+  type ToolSearchToolBm25_20251119,
+  type ToolSearchToolRegex20251119,
+  type ToolSearchToolResultBlock,
+  type ToolSearchToolResultBlockParam,
+  type ToolSearchToolResultError,
+  type ToolSearchToolResultErrorCode,
+  type ToolSearchToolResultErrorParam,
+  type ToolSearchToolSearchResultBlock,
+  type ToolSearchToolSearchResultBlockParam,
+  type ToolTextEditor20250124,
+  type ToolTextEditor20250429,
+  type ToolTextEditor20250728,
+  type ToolUnion,
+  type ToolUseBlock,
+  type ToolUseBlockParam,
+  type URLImageSource,
+  type URLPDFSource,
+  type Usage,
+  type UserLocation,
+  type WebFetchBlock,
+  type WebFetchBlockParam,
+  type WebFetchTool20250910,
+  type WebFetchTool20260209,
+  type WebFetchTool20260309,
+  type WebFetchTool20260318,
+  type WebFetchToolResultBlock,
+  type WebFetchToolResultBlockParam,
+  type WebFetchToolResultErrorBlock,
+  type WebFetchToolResultErrorBlockParam,
+  type WebFetchToolResultErrorCode,
+  type WebSearchResultBlock,
+  type WebSearchResultBlockParam,
+  type WebSearchTool20250305,
+  type WebSearchTool20260209,
+  type WebSearchTool20260318,
+  type WebSearchToolRequestError,
+  type WebSearchToolResultBlock,
+  type WebSearchToolResultBlockContent,
+  type WebSearchToolResultBlockParam,
+  type WebSearchToolResultBlockParamContent,
+  type WebSearchToolResultError,
+  type WebSearchToolResultErrorCode,
+  type MessageStreamEvent,
+  type MessageStartEvent,
+  type MessageStopEvent,
+  type ContentBlockDeltaEvent,
+  type MessageCreateParams,
+  type MessageCreateParamsBase,
+  type MessageCreateParamsNonStreaming,
+  type MessageCreateParamsStreaming,
+  type MessageCountTokensParams,
+} from './messages';