twelvelabs-js 1.2.7 → 1.2.8

package/Client.d.ts

@@ -69,6 +69,8 @@ export declare class TwelvelabsApiClient {
      * - Videos longer than 1 hour. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
      * - Video segmentation with custom segment definitions. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with the `model_name` parameter set to `pegasus1.5` instead.
      *
+     * On the Free plan, you have a total of 600 minutes (10 hours) shared across indexing, analysis, and segmentation. For details, see the [Video hours and video count limits](/v1.3/docs/concepts/indexes#video-hours-and-video-count-limits) section.
+     *
      * <Note title="Note">
      * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
      * </Note>
@@ -95,6 +97,8 @@ export declare class TwelvelabsApiClient {
      * - Videos longer than 1 hour. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
      * - Video segmentation with custom segment definitions. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with the `model_name` parameter set to `pegasus1.5` instead.
      *
+     * On the Free plan, you have a total of 600 minutes (10 hours) shared across indexing, analysis, and segmentation. For details, see the [Video hours and video count limits](/v1.3/docs/concepts/indexes#video-hours-and-video-count-limits) section.
+     *
      * <Note title="Note">
      * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
      * </Note>

package/Client.js

@@ -119,6 +119,8 @@ class TwelvelabsApiClient {
      * - Videos longer than 1 hour. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
      * - Video segmentation with custom segment definitions. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with the `model_name` parameter set to `pegasus1.5` instead.
      *
+     * On the Free plan, you have a total of 600 minutes (10 hours) shared across indexing, analysis, and segmentation. For details, see the [Video hours and video count limits](/v1.3/docs/concepts/indexes#video-hours-and-video-count-limits) section.
+     *
      * <Note title="Note">
      * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
      * </Note>
@@ -132,7 +134,7 @@ class TwelvelabsApiClient {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "analyze"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.7", "User-Agent": "twelvelabs-js/1.2.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.8", "User-Agent": "twelvelabs-js/1.2.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: Object.assign(Object.assign({}, serializers.AnalyzeStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" })), { stream: true }),
@@ -215,6 +217,8 @@ class TwelvelabsApiClient {
      * - Videos longer than 1 hour. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
      * - Video segmentation with custom segment definitions. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with the `model_name` parameter set to `pegasus1.5` instead.
      *
+     * On the Free plan, you have a total of 600 minutes (10 hours) shared across indexing, analysis, and segmentation. For details, see the [Video hours and video count limits](/v1.3/docs/concepts/indexes#video-hours-and-video-count-limits) section.
+     *
      * <Note title="Note">
      * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
      * </Note>
@@ -238,7 +242,7 @@ class TwelvelabsApiClient {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "analyze"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.7", "User-Agent": "twelvelabs-js/1.2.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.8", "User-Agent": "twelvelabs-js/1.2.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: Object.assign(Object.assign({}, serializers.AnalyzeRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" })), { stream: false }),

package/api/client/requests/AnalyzeRequest.d.ts

@@ -42,7 +42,7 @@ export interface AnalyzeRequest {
      *
      * | Model | Min | Max | Default |
      * |-------|-----|-----|---------|
-     * | Pegasus 1.2 | 1 | 4,096 | 4,096 |
+     * | Pegasus 1.2 | 2 | 4,096 | 4,096 |
      * | Pegasus 1.5 | 512 | 98,304 | 4,096 |
      */
     maxTokens?: number;

package/api/client/requests/AnalyzeStreamRequest.d.ts

@@ -42,7 +42,7 @@ export interface AnalyzeStreamRequest {
      *
      * | Model | Min | Max | Default |
      * |-------|-----|-----|---------|
-     * | Pegasus 1.2 | 1 | 4,096 | 4,096 |
+     * | Pegasus 1.2 | 2 | 4,096 | 4,096 |
      * | Pegasus 1.5 | 512 | 98,304 | 4,096 |
      */
     maxTokens?: number;

package/api/errors/GatewayTimeoutError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index";
+import * as TwelvelabsApi from "../index";
+import * as core from "../../core";
+export declare class GatewayTimeoutError extends errors.TwelvelabsApiError {
+    constructor(body: TwelvelabsApi.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/api/errors/GatewayTimeoutError.js

@@ -0,0 +1,52 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GatewayTimeoutError = void 0;
+const errors = __importStar(require("../../errors/index"));
+class GatewayTimeoutError extends errors.TwelvelabsApiError {
+    constructor(body, rawResponse) {
+        super({
+            message: "GatewayTimeoutError",
+            statusCode: 504,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, GatewayTimeoutError.prototype);
+    }
+}
+exports.GatewayTimeoutError = GatewayTimeoutError;

package/api/errors/ServiceUnavailableError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index";
+import * as TwelvelabsApi from "../index";
+import * as core from "../../core";
+export declare class ServiceUnavailableError extends errors.TwelvelabsApiError {
+    constructor(body: TwelvelabsApi.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/api/errors/ServiceUnavailableError.js

@@ -0,0 +1,52 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceUnavailableError = void 0;
+const errors = __importStar(require("../../errors/index"));
+class ServiceUnavailableError extends errors.TwelvelabsApiError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ServiceUnavailableError",
+            statusCode: 503,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, ServiceUnavailableError.prototype);
+    }
+}
+exports.ServiceUnavailableError = ServiceUnavailableError;

package/api/errors/index.d.ts

@@ -4,3 +4,5 @@ export * from "./InternalServerError";
 export * from "./ConflictError";
 export * from "./ForbiddenError";
 export * from "./TooManyRequestsError";
+export * from "./ServiceUnavailableError";
+export * from "./GatewayTimeoutError";

package/api/errors/index.js

@@ -20,3 +20,5 @@ __exportStar(require("./InternalServerError"), exports);
 __exportStar(require("./ConflictError"), exports);
 __exportStar(require("./ForbiddenError"), exports);
 __exportStar(require("./TooManyRequestsError"), exports);
+__exportStar(require("./ServiceUnavailableError"), exports);
+__exportStar(require("./GatewayTimeoutError"), exports);

package/api/resources/analyzeAsync/client/Client.d.ts

@@ -4,6 +4,7 @@
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
 import { Tasks } from "../resources/tasks/client/Client";
+import { Batches } from "../resources/batches/client/Client";
 export declare namespace AnalyzeAsync {
     interface Options {
         environment?: core.Supplier<environments.TwelvelabsApiEnvironment | string>;
@@ -15,6 +16,8 @@ export declare namespace AnalyzeAsync {
 export declare class AnalyzeAsync {
     protected readonly _options: AnalyzeAsync.Options;
     protected _tasks: Tasks | undefined;
+    protected _batches: Batches | undefined;
     constructor(_options: AnalyzeAsync.Options);
     get tasks(): Tasks;
+    get batches(): Batches;
 }

package/api/resources/analyzeAsync/client/Client.js

@@ -5,6 +5,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AnalyzeAsync = void 0;
 const Client_1 = require("../resources/tasks/client/Client");
+const Client_2 = require("../resources/batches/client/Client");
 class AnalyzeAsync {
     constructor(_options) {
         this._options = _options;
@@ -13,5 +14,9 @@ class AnalyzeAsync {
         var _a;
         return ((_a = this._tasks) !== null && _a !== void 0 ? _a : (this._tasks = new Client_1.Tasks(this._options)));
     }
+    get batches() {
+        var _a;
+        return ((_a = this._batches) !== null && _a !== void 0 ? _a : (this._batches = new Client_2.Batches(this._options)));
+    }
 }
 exports.AnalyzeAsync = AnalyzeAsync;

package/api/resources/analyzeAsync/resources/batches/client/Client.d.ts

@@ -0,0 +1,231 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments";
+import * as core from "../../../../../../core";
+import * as TwelvelabsApi from "../../../../../index";
+export declare namespace Batches {
+    interface Options {
+        environment?: core.Supplier<environments.TwelvelabsApiEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey: core.Supplier<string>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Batches {
+    protected readonly _options: Batches.Options;
+    constructor(_options: Batches.Options);
+    /**
+     * Use this method to list all the batch objects in your account. The response sorts batches by creation date, with the newest batch first.
+     *
+     * @param {TwelvelabsApi.analyzeAsync.BatchesListRequest} request
+     * @param {Batches.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     *
+     * @example
+     *     await client.analyzeAsync.batches.list({
+     *         page: 1,
+     *         pageLimit: 10
+     *     })
+     */
+    list(request?: TwelvelabsApi.analyzeAsync.BatchesListRequest, requestOptions?: Batches.RequestOptions): Promise<core.Page<TwelvelabsApi.AnalyzeBatchStatusResponse>>;
+    /**
+     * Use this method to submit many video analysis requests in a single call. Each request creates an analysis task. The response contains one batch identifier and one task identifier per request. Use the batch identifier to check progress and retrieve results.
+     *
+     * <Note title="Model requirement">
+     * You must use Pegasus 1.5 for batch analysis. Set the `model_name` parameter to `pegasus1.5`.
+     * </Note>
+     *
+     * **When to use this method**:
+     * - Run the same model and analysis settings across many videos.
+     * - Track a single batch instead of many individual analysis tasks.
+     *
+     * **Do not use this method for**:
+     * - Single videos that require immediate results. Use the [`POST`](/v1.3/api-reference/analyze-videos/sync-analysis) method of the `/analyze` endpoint instead.
+     * - Background processing of a single video. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
+     *
+     * **Retention and retry**:
+     * - Batches expire 24 hours after creation. You can retrieve results for 30 days after creation.
+     * - If processing does not finish for some items in time, resubmit them in a new batch.
+     *
+     * **Limits**:
+     * - Up to 1,000 requests per batch.
+     * - Up to 2,000 total content hours per batch.
+     * - Up to 5 active batches per account.
+     *
+     * @param {TwelvelabsApi.analyzeAsync.CreateAnalyzeBatchRequest} request
+     * @param {Batches.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     * @throws {@link TwelvelabsApi.NotFoundError}
+     * @throws {@link TwelvelabsApi.ConflictError}
+     * @throws {@link TwelvelabsApi.TooManyRequestsError}
+     * @throws {@link TwelvelabsApi.ServiceUnavailableError}
+     * @throws {@link TwelvelabsApi.GatewayTimeoutError}
+     *
+     * @example
+     *     await client.analyzeAsync.batches.create({
+     *         modelName: "pegasus1.5",
+     *         analysisMode: "general",
+     *         defaults: {
+     *             prompt: {
+     *                 inputText: "Generate a 3-sentence executive summary of this video."
+     *             },
+     *             temperature: 0.2,
+     *             maxTokens: 4096
+     *         },
+     *         requests: [{
+     *                 video: {
+     *                     type: "asset_id",
+     *                     assetId: "6298d673f1090f1100476d4c"
+     *                 },
+     *                 customId: "summary-001"
+     *             }, {
+     *                 video: {
+     *                     type: "asset_id",
+     *                     assetId: "6298d673f1090f1100476d4d"
+     *                 },
+     *                 customId: "summary-002"
+     *             }, {
+     *                 video: {
+     *                     type: "asset_id",
+     *                     assetId: "6298d673f1090f1100476d4e"
+     *                 },
+     *                 customId: "action-003",
+     *                 prompt: {
+     *                     inputText: "List all action items discussed."
+     *                 }
+     *             }]
+     *     })
+     *
+     * @example
+     *     await client.analyzeAsync.batches.create({
+     *         modelName: "pegasus1.5",
+     *         analysisMode: "time_based_metadata",
+     *         defaults: {
+     *             responseFormat: {
+     *                 type: "segment_definitions",
+     *                 segmentDefinitions: [{
+     *                         id: "product_moments",
+     *                         description: "Moments where a person holds <@product> while speaking to the camera.",
+     *                         fields: [{
+     *                                 name: "segment_title",
+     *                                 type: "string",
+     *                                 description: "A short headline for this moment"
+     *                             }, {
+     *                                 name: "product_visibility",
+     *                                 type: "string",
+     *                                 description: "How prominently the product appears in this segment",
+     *                                 enum: ["FULL", "PARTIAL", "BACKGROUND"]
+     *                             }],
+     *                         mediaSources: [{
+     *                                 name: "product",
+     *                                 mediaType: "image",
+     *                                 url: "https://example.com/product.jpg"
+     *                             }]
+     *                     }]
+     *             },
+     *             temperature: 0,
+     *             maxTokens: 4096,
+     *             minSegmentDuration: 2
+     *         },
+     *         requests: [{
+     *                 video: {
+     *                     type: "asset_id",
+     *                     assetId: "6298d673f1090f1100476d4c"
+     *                 },
+     *                 customId: "ep-001"
+     *             }, {
+     *                 video: {
+     *                     type: "asset_id",
+     *                     assetId: "6298d673f1090f1100476d4d"
+     *                 },
+     *                 customId: "ep-002"
+     *             }]
+     *     })
+     */
+    create(request: TwelvelabsApi.analyzeAsync.CreateAnalyzeBatchRequest, requestOptions?: Batches.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.CreateAnalyzeBatchResponse>;
+    private __create;
+    /**
+     * Use this method to monitor a batch. The response includes the current batch status and counts for queued, processing, ready, failed, and canceled items.
+     *
+     * Poll this method until the batch reaches the `completed`, `canceled`, or `expired` status. To retrieve the results, call the [`GET`](/v1.3/api-reference/analyze-videos/batch-analysis/retrieve-batch-results) method of the `/analyze/batches/{batch_id}/results` endpoint.
+     *
+     * Do not treat the `completed` status as a success signal. It means processing has finished for every item, not that every analysis succeeded. To see how many items succeeded, failed, or were canceled, check the `ready_items`, `failed_items`, and `canceled_items` fields. A batch never has the `failed` status.
+     *
+     * @param {string} batchId - The unique identifier of the batch.
+     * @param {Batches.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.NotFoundError}
+     *
+     * @example
+     *     await client.analyzeAsync.batches.retrieve("68f4ddaf8aaa60d33df0e800")
+     */
+    retrieve(batchId: string, requestOptions?: Batches.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.AnalyzeBatchStatusResponse>;
+    private __retrieve;
+    /**
+     * Use this method to delete a batch and all the tasks associated with it. You can only delete batches with status `completed`, `canceled`, or `expired`.
+     *
+     * Deleting a batch does not affect billing. You are billed for every completed analysis regardless of whether you delete the batch afterward.
+     *
+     * To stop a batch with the `pending` or `processing` status, use the [`POST`](/v1.3/api-reference/analyze-videos/batch-analysis/cancel-batch) method of the `/analyze/batches/{batch_id}/cancel` endpoint.
+     *
+     * Batches are deleted 30 days after creation.
+     *
+     * @param {string} batchId - The unique identifier of the batch.
+     * @param {Batches.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.NotFoundError}
+     * @throws {@link TwelvelabsApi.ConflictError}
+     *
+     * @example
+     *     await client.analyzeAsync.batches.delete("68f4ddaf8aaa60d33df0e800")
+     */
+    delete(batchId: string, requestOptions?: Batches.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
+    /**
+     * Use this method to retrieve the results for each item in a batch. You can call it while the batch has the `pending` or `processing` status.
+     *
+     * Each result entry has a status. For details on each status, see the [Item statuses](/v1.3/api-reference/analyze-videos/batch-analysis/the-batch-object#item-statuses) section on the **The batch object** page.
+     *
+     * Each result entry includes a task identifier in the `task_id` field. Use this value with the [`GET`](/v1.3/api-reference/analyze-videos/retrieve-analysis-task-status-results) method of the `/analyze/tasks/{task_id}` endpoint if you need the full analysis task response.
+     *
+     * You can retrieve results for 30 days after batch creation.
+     */
+    results(batchId: string, requestOptions?: Batches.RequestOptions): core.HttpResponsePromise<core.Stream<TwelvelabsApi.BatchResultItem>>;
+    private __results;
+    /**
+     * Use this method to request cancellation for a batch with the `pending` or `processing` status.
+     *
+     * When you invoke this method, the platform performs the following steps:
+     * - Cancels the items in the `queued` status.
+     * - Finishes the analysis for the items in the `processing` status.
+     *
+     * The batch status changes to `canceling` immediately, and to `canceled` after every item reaches `ready`, `failed`, or `canceled`. You are not billed for canceled or failed items.
+     *
+     * @param {string} batchId - The unique identifier of the batch.
+     * @param {Batches.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.NotFoundError}
+     * @throws {@link TwelvelabsApi.ConflictError}
+     *
+     * @example
+     *     await client.analyzeAsync.batches.cancel("68f4ddaf8aaa60d33df0e800")
+     */
+    cancel(batchId: string, requestOptions?: Batches.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.AnalyzeBatchStatusResponse>;
+    private __cancel;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "x-api-key": string;
+    }>;
+}