release: 0.19.0 (#213)

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>

Author: stainless-app[bot]

.github/workflows/stale.yaml

@@ -1,3 +1,3 @@
 {
-  ".": "0.18.0"
+  ".": "0.19.0"
 }

.release-please-manifest.json

@@ -1,4 +1,4 @@
-configured_endpoints: 16
+configured_endpoints: 17
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/groqcloud%2Fgroqcloud-8d531e091886f4bb814247a78a6323f6f12351881269a4e8cf68223b9245c64f.yml
 openapi_spec_hash: 418d99cedb3b70fbd0615eed3ceb2872
-config_hash: dd20374dfa31ce00f3b6dd0a6dfbe802
+config_hash: 6b1c374dcc1ffa3165dd22f52a77ff89

.stats.yml

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.19.0 (2025-04-02)
+
+Full Changelog: [v0.18.0...v0.19.0](https://github.com/groq/groq-typescript/compare/v0.18.0...v0.19.0)
+
+### Features
+
+* **api:** add batch cancel ([0b0681f](https://github.com/groq/groq-typescript/commit/0b0681ff484dadce7a3f9ab8b5205683e96297fa))
+
+
+### Chores
+
+* **internal:** skip broken binary tests ([#217](https://github.com/groq/groq-typescript/issues/217)) ([6ad103f](https://github.com/groq/groq-typescript/commit/6ad103f2207357f876734b423c8224d48162c1f6))
+
 ## 0.18.0 (2025-04-01)
 
 Full Changelog: [v0.17.0...v0.18.0](https://github.com/groq/groq-typescript/compare/v0.17.0...v0.18.0)

CHANGELOG.md

@@ -102,12 +102,14 @@ Types:
 - <code><a href="./src/resources/batches.ts">BatchCreateResponse</a></code>
 - <code><a href="./src/resources/batches.ts">BatchRetrieveResponse</a></code>
 - <code><a href="./src/resources/batches.ts">BatchListResponse</a></code>
+- <code><a href="./src/resources/batches.ts">BatchCancelResponse</a></code>
 
 Methods:
 
 - <code title="post /openai/v1/batches">client.batches.<a href="./src/resources/batches.ts">create</a>({ ...params }) -> BatchCreateResponse</code>
 - <code title="get /openai/v1/batches/{batch_id}">client.batches.<a href="./src/resources/batches.ts">retrieve</a>(batchId) -> BatchRetrieveResponse</code>
 - <code title="get /openai/v1/batches">client.batches.<a href="./src/resources/batches.ts">list</a>() -> BatchListResponse</code>
+- <code title="post /openai/v1/batches/{batch_id}/cancel">client.batches.<a href="./src/resources/batches.ts">cancel</a>(batchId) -> BatchCancelResponse</code>
 
 # Files
 

api.md

@@ -1,6 +1,6 @@
 {
   "name": "groq-sdk",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "description": "The official TypeScript library for the Groq API",
   "author": "Groq <[email protected]>",
   "types": "dist/index.d.ts",

package.json

@@ -24,6 +24,13 @@ export class Batches extends APIResource {
   list(options?: Core.RequestOptions): Core.APIPromise<BatchListResponse> {
     return this._client.get('/openai/v1/batches', options);
   }
+
+  /**
+   * Cancels a batch.
+   */
+  cancel(batchId: string, options?: Core.RequestOptions): Core.APIPromise<BatchCancelResponse> {
+    return this._client.post(`/openai/v1/batches/${batchId}/cancel`, options);
+  }
 }
 
 export interface BatchCreateResponse {
@@ -514,6 +521,166 @@ export namespace BatchListResponse {
   }
 }
 
+export interface BatchCancelResponse {
+  id: string;
+
+  /**
+   * The time frame within which the batch should be processed.
+   */
+  completion_window: string;
+
+  /**
+   * The Unix timestamp (in seconds) for when the batch was created.
+   */
+  created_at: number;
+
+  /**
+   * The API endpoint used by the batch.
+   */
+  endpoint: string;
+
+  /**
+   * The ID of the input file for the batch.
+   */
+  input_file_id: string;
+
+  /**
+   * The object type, which is always `batch`.
+   */
+  object: 'batch';
+
+  /**
+   * The current status of the batch.
+   */
+  status:
+    | 'validating'
+    | 'failed'
+    | 'in_progress'
+    | 'finalizing'
+    | 'completed'
+    | 'expired'
+    | 'cancelling'
+    | 'cancelled';
+
+  /**
+   * The Unix timestamp (in seconds) for when the batch was cancelled.
+   */
+  cancelled_at?: number;
+
+  /**
+   * The Unix timestamp (in seconds) for when the batch started cancelling.
+   */
+  cancelling_at?: number;
+
+  /**
+   * The Unix timestamp (in seconds) for when the batch was completed.
+   */
+  completed_at?: number;
+
+  /**
+   * The ID of the file containing the outputs of requests with errors.
+   */
+  error_file_id?: string;
+
+  errors?: BatchCancelResponse.Errors;
+
+  /**
+   * The Unix timestamp (in seconds) for when the batch expired.
+   */
+  expired_at?: number;
+
+  /**
+   * The Unix timestamp (in seconds) for when the batch will expire.
+   */
+  expires_at?: number;
+
+  /**
+   * The Unix timestamp (in seconds) for when the batch failed.
+   */
+  failed_at?: number;
+
+  /**
+   * The Unix timestamp (in seconds) for when the batch started finalizing.
+   */
+  finalizing_at?: number;
+
+  /**
+   * The Unix timestamp (in seconds) for when the batch started processing.
+   */
+  in_progress_at?: number;
+
+  /**
+   * Set of key-value pairs that can be attached to an object. This can be useful for
+   * storing additional information about the object in a structured format.
+   */
+  metadata?: unknown | null;
+
+  /**
+   * The ID of the file containing the outputs of successfully executed requests.
+   */
+  output_file_id?: string;
+
+  /**
+   * The request counts for different statuses within the batch.
+   */
+  request_counts?: BatchCancelResponse.RequestCounts;
+}
+
+export namespace BatchCancelResponse {
+  export interface Errors {
+    data?: Array<Errors.Data>;
+
+    /**
+     * The object type, which is always `list`.
+     */
+    object?: string;
+  }
+
+  export namespace Errors {
+    export interface Data {
+      /**
+       * An error code identifying the error type.
+       */
+      code?: string;
+
+      /**
+       * The line number of the input file where the error occurred, if applicable.
+       */
+      line?: number | null;
+
+      /**
+       * A human-readable message providing more details about the error.
+       */
+      message?: string;
+
+      /**
+       * The name of the parameter that caused the error, if applicable.
+       */
+      param?: string | null;
+    }
+  }
+
+  /**
+   * The request counts for different statuses within the batch.
+   */
+  export interface RequestCounts {
+    /**
+     * Number of requests that have been completed successfully.
+     */
+    completed: number;
+
+    /**
+     * Number of requests that have failed.
+     */
+    failed: number;
+
+    /**
+     * Total number of requests in the batch.
+     */
+    total: number;
+  }
+}
+
 export interface BatchCreateParams {
   /**
    * The time frame within which the batch should be processed. Currently only `24h`
@@ -548,6 +715,7 @@ export declare namespace Batches {
     type BatchCreateResponse as BatchCreateResponse,
     type BatchRetrieveResponse as BatchRetrieveResponse,
     type BatchListResponse as BatchListResponse,
+    type BatchCancelResponse as BatchCancelResponse,
     type BatchCreateParams as BatchCreateParams,
   };
 }

src/resources/batches.ts

@@ -7,6 +7,7 @@ export {
   type BatchCreateResponse,
   type BatchRetrieveResponse,
   type BatchListResponse,
+  type BatchCancelResponse,
   type BatchCreateParams,
 } from './batches';
 export { Chat } from './chat/chat';

src/resources/index.ts

@@ -1 +1 @@
-export const VERSION = '0.18.0'; // x-release-please-version
+export const VERSION = '0.19.0'; // x-release-please-version

src/version.ts

@@ -8,7 +8,8 @@ const client = new Groq({
 });
 
 describe('resource speech', () => {
-  test('create: required and optional params', async () => {
+  // binary tests are currently broken
+  test.skip('create: required and optional params', async () => {
     const response = await client.audio.speech.create({
       input: 'input',
       model: 'model',

tests/api-resources/audio/speech.test.ts

@@ -68,4 +68,22 @@ describe('resource batches', () => {
       Groq.NotFoundError,
     );
   });
+
+  test('cancel', async () => {
+    const responsePromise = client.batches.cancel('batch_id');
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('cancel: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(client.batches.cancel('batch_id', { path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Groq.NotFoundError,
+    );
+  });
 });