feat(api): Add batches.cancel API

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 45
+configured_endpoints: 46
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai%2Ftogetherai-1afddc630f2b0684aad99bda9d83dc91ee6648a2b5cd7eac5d42fdc9ff46bbfc.yml
 openapi_spec_hash: a4cab3a8559f632b66ea7aabd40cd8aa
-config_hash: 5e9563faf41fd9a91bea97783683bdb2
+config_hash: eb8d7493024f64839cec7401a9451c78

api.md

@@ -270,12 +270,14 @@ Response Types:
 - <a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#BatchNewResponse">BatchNewResponse</a>
 - <a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#BatchGetResponse">BatchGetResponse</a>
 - <a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#BatchListResponse">BatchListResponse</a>
+- <a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#BatchCancelResponse">BatchCancelResponse</a>
 
 Methods:
 
 - <code title="post /batches">client.Batches.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#BatchService.New">New</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, body <a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#BatchNewParams">BatchNewParams</a>) (<a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#BatchNewResponse">BatchNewResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 - <code title="get /batches/{id}">client.Batches.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#BatchService.Get">Get</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, id <a href="https://pkg.go.dev/builtin#string">string</a>) (<a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#BatchGetResponse">BatchGetResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 - <code title="get /batches">client.Batches.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#BatchService.List">List</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>) ([]<a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#BatchListResponse">BatchListResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
+- <code title="post /batches/{id}/cancel">client.Batches.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#BatchService.Cancel">Cancel</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, id <a href="https://pkg.go.dev/builtin#string">string</a>) (<a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#BatchCancelResponse">BatchCancelResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 
 # Evals
 

batch.go

@@ -64,6 +64,18 @@ func (r *BatchService) List(ctx context.Context, opts ...option.RequestOption) (
 	return
 }
 
+// Cancel a batch job by ID
+func (r *BatchService) Cancel(ctx context.Context, id string, opts ...option.RequestOption) (res *BatchCancelResponse, err error) {
+	opts = slices.Concat(r.Options, opts)
+	if id == "" {
+		err = errors.New("missing required id parameter")
+		return
+	}
+	path := fmt.Sprintf("batches/%s/cancel", id)
+	err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, nil, &res, opts...)
+	return
+}
+
 type BatchNewResponse struct {
 	Job     BatchNewResponseJob `json:"job"`
 	Warning string              `json:"warning"`
@@ -253,6 +265,67 @@ const (
 	BatchListResponseStatusCancelled  BatchListResponseStatus = "CANCELLED"
 )
 
+type BatchCancelResponse struct {
+	ID          string    `json:"id" format:"uuid"`
+	CompletedAt time.Time `json:"completed_at" format:"date-time"`
+	CreatedAt   time.Time `json:"created_at" format:"date-time"`
+	Endpoint    string    `json:"endpoint"`
+	Error       string    `json:"error"`
+	ErrorFileID string    `json:"error_file_id"`
+	// Size of input file in bytes
+	FileSizeBytes int64     `json:"file_size_bytes"`
+	InputFileID   string    `json:"input_file_id"`
+	JobDeadline   time.Time `json:"job_deadline" format:"date-time"`
+	// Model used for processing requests
+	ModelID      string `json:"model_id"`
+	OutputFileID string `json:"output_file_id"`
+	// Completion progress (0.0 to 100)
+	Progress float64 `json:"progress"`
+	// Current status of the batch job
+	//
+	// Any of "VALIDATING", "IN_PROGRESS", "COMPLETED", "FAILED", "EXPIRED",
+	// "CANCELLED".
+	Status BatchCancelResponseStatus `json:"status"`
+	UserID string                    `json:"user_id"`
+	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
+	JSON struct {
+		ID            respjson.Field
+		CompletedAt   respjson.Field
+		CreatedAt     respjson.Field
+		Endpoint      respjson.Field
+		Error         respjson.Field
+		ErrorFileID   respjson.Field
+		FileSizeBytes respjson.Field
+		InputFileID   respjson.Field
+		JobDeadline   respjson.Field
+		ModelID       respjson.Field
+		OutputFileID  respjson.Field
+		Progress      respjson.Field
+		Status        respjson.Field
+		UserID        respjson.Field
+		ExtraFields   map[string]respjson.Field
+		raw           string
+	} `json:"-"`
+}
+
+// Returns the unmodified JSON received from the API
+func (r BatchCancelResponse) RawJSON() string { return r.JSON.raw }
+func (r *BatchCancelResponse) UnmarshalJSON(data []byte) error {
+	return apijson.UnmarshalRoot(data, r)
+}
+
+// Current status of the batch job
+type BatchCancelResponseStatus string
+
+const (
+	BatchCancelResponseStatusValidating BatchCancelResponseStatus = "VALIDATING"
+	BatchCancelResponseStatusInProgress BatchCancelResponseStatus = "IN_PROGRESS"
+	BatchCancelResponseStatusCompleted  BatchCancelResponseStatus = "COMPLETED"
+	BatchCancelResponseStatusFailed     BatchCancelResponseStatus = "FAILED"
+	BatchCancelResponseStatusExpired    BatchCancelResponseStatus = "EXPIRED"
+	BatchCancelResponseStatusCancelled  BatchCancelResponseStatus = "CANCELLED"
+)
+
 type BatchNewParams struct {
 	// The endpoint to use for batch processing
 	Endpoint string `json:"endpoint,required"`

batch_test.go

@@ -84,3 +84,25 @@ func TestBatchList(t *testing.T) {
 		t.Fatalf("err should be nil: %s", err.Error())
 	}
 }
+
+func TestBatchCancel(t *testing.T) {
+	baseURL := "http://localhost:4010"
+	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
+		baseURL = envURL
+	}
+	if !testutil.CheckTestServer(t, baseURL) {
+		return
+	}
+	client := together.NewClient(
+		option.WithBaseURL(baseURL),
+		option.WithAPIKey("My API Key"),
+	)
+	_, err := client.Batches.Cancel(context.TODO(), "batch_job_abc123def456")
+	if err != nil {
+		var apierr *together.Error
+		if errors.As(err, &apierr) {
+			t.Log(string(apierr.DumpRequest(true)))
+		}
+		t.Fatalf("err should be nil: %s", err.Error())
+	}
+}