twelvelabs-js 1.2.0 → 1.2.2

package/Client.d.ts

@@ -11,6 +11,7 @@ import { MultipartUpload } from "./api/resources/multipartUpload/client/Client";
 import { EntityCollections } from "./api/resources/entityCollections/client/Client";
 import { Embed } from "./api/resources/embed/client/Client";
 import { Search } from "./api/resources/search/client/Client";
+import { AnalyzeAsync } from "./api/resources/analyzeAsync/client/Client";
 export declare namespace TwelvelabsApiClient {
     interface Options {
         environment?: core.Supplier<environments.TwelvelabsApiEnvironment | string>;
@@ -38,6 +39,7 @@ export declare class TwelvelabsApiClient {
     protected _entityCollections: EntityCollections | undefined;
     protected _embed: Embed | undefined;
     protected _search: Search | undefined;
+    protected _analyzeAsync: AnalyzeAsync | undefined;
     constructor(_options: TwelvelabsApiClient.Options);
     get tasks(): Tasks;
     get indexes(): Indexes;
@@ -46,71 +48,53 @@ export declare class TwelvelabsApiClient {
     get entityCollections(): EntityCollections;
     get embed(): Embed;
     get search(): Search;
+    get analyzeAsync(): AnalyzeAsync;
     /**
+     * This method synchronously analyzes your videos and generates fully customizable text based on your prompts.
      *
-     * <Note title="Deprecation notice">
-     *   This endpoint will be sunset and removed. Use the [`POST`](/v1.3/api-reference/analyze-videos/analyze) method of the `/analyze` endpoint. Pass the [`response_format`](/v1.3/api-reference/analyze-videos/analyze#request.body.response_format) parameter to specify the format of the response as structured JSON. For migration instructions, see the [Release notes](/v1.3/docs/get-started/release-notes#predefined-formats-for-video-analysis-will-be-sunset-and-removed) page.
-     * </Note>
-     *
-     * This endpoint analyzes videos and generates summaries, chapters, or highlights. Optionally, you can provide a prompt to customize the output.
-     *
-     * <Note title="Note">
-     * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
-     * </Note>
+     * <Accordion title="Input requirements">
+     * - Minimum duration: 4 seconds
+     * - Maximum duration: 1 hour
+     * - Formats: [FFmpeg supported formats](https://ffmpeg.org/ffmpeg-formats.html)
+     * - Resolution: 360x360 to 5184x2160 pixels
+     * - Aspect ratio: Between 1:1 and 1:2.4, or between 2.4:1 and 1:1.
+     * </Accordion>
      *
-     * @param {TwelvelabsApi.SummarizeRequest} request
-     * @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link TwelvelabsApi.BadRequestError}
-     * @throws {@link TwelvelabsApi.TooManyRequestsError}
-     *
-     * @example
-     *     await client.summarize({
-     *         videoId: "6298d673f1090f1100476d4c",
-     *         type: "summary",
-     *         prompt: "Generate a summary of this video for a social media post, up to two sentences.",
-     *         temperature: 0.2
-     *     })
-     */
-    summarize(request: TwelvelabsApi.SummarizeRequest, requestOptions?: TwelvelabsApiClient.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.SummarizeResponse>;
-    private __summarize;
-    /**
-     * <Note title="Deprecation notice">
-     *   This endpoint will be sunset and removed on February 15, 2026. Instead, use the [`POST`](/v1.3/api-reference/analyze-videos/analyze) method of the `/analyze` endpoint, passing the [`response_format`](/v1.3/api-reference/analyze-videos/analyze#request.body.response_format) parameter to specify the format of the response as structured JSON. For migration instructions, see the [Release notes](/v1.3/docs/get-started/release-notes#predefined-formats-for-video-analysis-will-be-sunset-and-removed) page.
-     * </Note>
+     * **When to use this method**:
+     * - Analyze videos up to 1 hour
+     * - Retrieve immediate results without waiting for asynchronous processing
+     * - Stream text fragments in real-time for immediate processing and feedback
      *
-     * This method analyzes videos and generates titles, topics, and hashtags.
-     *
-     * @param {TwelvelabsApi.GistRequest} request
-     * @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link TwelvelabsApi.BadRequestError}
-     * @throws {@link TwelvelabsApi.TooManyRequestsError}
-     *
-     * @example
-     *     await client.gist({
-     *         videoId: "6298d673f1090f1100476d4c",
-     *         types: ["title", "topic"]
-     *     })
-     */
-    gist(request: TwelvelabsApi.GistRequest, requestOptions?: TwelvelabsApiClient.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.Gist>;
-    private __gist;
-    /**
-     * This endpoint analyzes your videos and creates fully customizable text based on your prompts, including but not limited to tables of content, action items, memos, and detailed analyses.
+     * **Do not use this method for**:
+     * - 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.
      *
      * <Note title="Notes">
      * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
-     * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Analyze videos](/v1.3/docs/guides/analyze-videos) page.
      * </Note>
      */
     analyzeStream(request: TwelvelabsApi.AnalyzeStreamRequest, requestOptions?: TwelvelabsApiClient.RequestOptions): core.HttpResponsePromise<core.Stream<TwelvelabsApi.StreamAnalyzeResponse>>;
     private __analyzeStream;
     /**
-     * This endpoint analyzes your videos and creates fully customizable text based on your prompts, including but not limited to tables of content, action items, memos, and detailed analyses.
+     * This method synchronously analyzes your videos and generates fully customizable text based on your prompts.
+     *
+     * <Accordion title="Input requirements">
+     * - Minimum duration: 4 seconds
+     * - Maximum duration: 1 hour
+     * - Formats: [FFmpeg supported formats](https://ffmpeg.org/ffmpeg-formats.html)
+     * - Resolution: 360x360 to 5184x2160 pixels
+     * - Aspect ratio: Between 1:1 and 1:2.4, or between 2.4:1 and 1:1.
+     * </Accordion>
+     *
+     * **When to use this method**:
+     * - Analyze videos up to 1 hour
+     * - Retrieve immediate results without waiting for asynchronous processing
+     * - Stream text fragments in real-time for immediate processing and feedback
+     *
+     * **Do not use this method for**:
+     * - 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.
      *
      * <Note title="Notes">
      * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
-     * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Analyze videos](/v1.3/docs/guides/analyze-videos) page.
      * </Note>
      *
      * @param {TwelvelabsApi.AnalyzeRequest} request

package/Client.js

@@ -62,6 +62,7 @@ const Client_4 = require("./api/resources/multipartUpload/client/Client");
 const Client_5 = require("./api/resources/entityCollections/client/Client");
 const Client_6 = require("./api/resources/embed/client/Client");
 const Client_7 = require("./api/resources/search/client/Client");
+const Client_8 = require("./api/resources/analyzeAsync/client/Client");
 class TwelvelabsApiClient {
     constructor(_options) {
         this._options = _options;
@@ -94,175 +95,31 @@ class TwelvelabsApiClient {
         var _a;
         return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_7.Search(this._options)));
     }
-    /**
-     *
-     * <Note title="Deprecation notice">
-     *   This endpoint will be sunset and removed. Use the [`POST`](/v1.3/api-reference/analyze-videos/analyze) method of the `/analyze` endpoint. Pass the [`response_format`](/v1.3/api-reference/analyze-videos/analyze#request.body.response_format) parameter to specify the format of the response as structured JSON. For migration instructions, see the [Release notes](/v1.3/docs/get-started/release-notes#predefined-formats-for-video-analysis-will-be-sunset-and-removed) page.
-     * </Note>
-     *
-     * This endpoint analyzes videos and generates summaries, chapters, or highlights. Optionally, you can provide a prompt to customize the output.
-     *
-     * <Note title="Note">
-     * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
-     * </Note>
-     *
-     * @param {TwelvelabsApi.SummarizeRequest} request
-     * @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link TwelvelabsApi.BadRequestError}
-     * @throws {@link TwelvelabsApi.TooManyRequestsError}
-     *
-     * @example
-     *     await client.summarize({
-     *         videoId: "6298d673f1090f1100476d4c",
-     *         type: "summary",
-     *         prompt: "Generate a summary of this video for a social media post, up to two sentences.",
-     *         temperature: 0.2
-     *     })
-     */
-    summarize(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__summarize(request, requestOptions));
-    }
-    __summarize(request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            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, "summarize"),
-                method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "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: serializers.SummarizeRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return {
-                    data: serializers.SummarizeResponse.parseOrThrow(_response.body, {
-                        unrecognizedObjectKeys: "passthrough",
-                        allowUnrecognizedUnionMembers: true,
-                        allowUnrecognizedEnumValues: true,
-                        breadcrumbsPrefix: ["response"],
-                    }),
-                    rawResponse: _response.rawResponse,
-                };
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 400:
-                        throw new TwelvelabsApi.BadRequestError(_response.error.body, _response.rawResponse);
-                    case 429:
-                        throw new TwelvelabsApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
-                    default:
-                        throw new errors.TwelvelabsApiError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                            rawResponse: _response.rawResponse,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.TwelvelabsApiError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                        rawResponse: _response.rawResponse,
-                    });
-                case "timeout":
-                    throw new errors.TwelvelabsApiTimeoutError("Timeout exceeded when calling POST /summarize.");
-                case "unknown":
-                    throw new errors.TwelvelabsApiError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
+    get analyzeAsync() {
+        var _a;
+        return ((_a = this._analyzeAsync) !== null && _a !== void 0 ? _a : (this._analyzeAsync = new Client_8.AnalyzeAsync(this._options)));
     }
     /**
-     * <Note title="Deprecation notice">
-     *   This endpoint will be sunset and removed on February 15, 2026. Instead, use the [`POST`](/v1.3/api-reference/analyze-videos/analyze) method of the `/analyze` endpoint, passing the [`response_format`](/v1.3/api-reference/analyze-videos/analyze#request.body.response_format) parameter to specify the format of the response as structured JSON. For migration instructions, see the [Release notes](/v1.3/docs/get-started/release-notes#predefined-formats-for-video-analysis-will-be-sunset-and-removed) page.
-     * </Note>
+     * This method synchronously analyzes your videos and generates fully customizable text based on your prompts.
      *
-     * This method analyzes videos and generates titles, topics, and hashtags.
+     * <Accordion title="Input requirements">
+     * - Minimum duration: 4 seconds
+     * - Maximum duration: 1 hour
+     * - Formats: [FFmpeg supported formats](https://ffmpeg.org/ffmpeg-formats.html)
+     * - Resolution: 360x360 to 5184x2160 pixels
+     * - Aspect ratio: Between 1:1 and 1:2.4, or between 2.4:1 and 1:1.
+     * </Accordion>
      *
-     * @param {TwelvelabsApi.GistRequest} request
-     * @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
+     * **When to use this method**:
+     * - Analyze videos up to 1 hour
+     * - Retrieve immediate results without waiting for asynchronous processing
+     * - Stream text fragments in real-time for immediate processing and feedback
      *
-     * @throws {@link TwelvelabsApi.BadRequestError}
-     * @throws {@link TwelvelabsApi.TooManyRequestsError}
-     *
-     * @example
-     *     await client.gist({
-     *         videoId: "6298d673f1090f1100476d4c",
-     *         types: ["title", "topic"]
-     *     })
-     */
-    gist(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__gist(request, requestOptions));
-    }
-    __gist(request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            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, "gist"),
-                method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "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: serializers.GistRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return {
-                    data: serializers.Gist.parseOrThrow(_response.body, {
-                        unrecognizedObjectKeys: "passthrough",
-                        allowUnrecognizedUnionMembers: true,
-                        allowUnrecognizedEnumValues: true,
-                        breadcrumbsPrefix: ["response"],
-                    }),
-                    rawResponse: _response.rawResponse,
-                };
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 400:
-                        throw new TwelvelabsApi.BadRequestError(_response.error.body, _response.rawResponse);
-                    case 429:
-                        throw new TwelvelabsApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
-                    default:
-                        throw new errors.TwelvelabsApiError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                            rawResponse: _response.rawResponse,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.TwelvelabsApiError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                        rawResponse: _response.rawResponse,
-                    });
-                case "timeout":
-                    throw new errors.TwelvelabsApiTimeoutError("Timeout exceeded when calling POST /gist.");
-                case "unknown":
-                    throw new errors.TwelvelabsApiError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
-    }
-    /**
-     * This endpoint analyzes your videos and creates fully customizable text based on your prompts, including but not limited to tables of content, action items, memos, and detailed analyses.
+     * **Do not use this method for**:
+     * - 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.
      *
      * <Note title="Notes">
      * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
-     * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Analyze videos](/v1.3/docs/guides/analyze-videos) page.
      * </Note>
      */
     analyzeStream(request, requestOptions) {
@@ -274,7 +131,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.0", "User-Agent": "twelvelabs-js/1.2.0", "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.2", "User-Agent": "twelvelabs-js/1.2.2", "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 }),
@@ -336,11 +193,26 @@ class TwelvelabsApiClient {
         });
     }
     /**
-     * This endpoint analyzes your videos and creates fully customizable text based on your prompts, including but not limited to tables of content, action items, memos, and detailed analyses.
+     * This method synchronously analyzes your videos and generates fully customizable text based on your prompts.
+     *
+     * <Accordion title="Input requirements">
+     * - Minimum duration: 4 seconds
+     * - Maximum duration: 1 hour
+     * - Formats: [FFmpeg supported formats](https://ffmpeg.org/ffmpeg-formats.html)
+     * - Resolution: 360x360 to 5184x2160 pixels
+     * - Aspect ratio: Between 1:1 and 1:2.4, or between 2.4:1 and 1:1.
+     * </Accordion>
+     *
+     * **When to use this method**:
+     * - Analyze videos up to 1 hour
+     * - Retrieve immediate results without waiting for asynchronous processing
+     * - Stream text fragments in real-time for immediate processing and feedback
+     *
+     * **Do not use this method for**:
+     * - 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.
      *
      * <Note title="Notes">
      * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
-     * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Analyze videos](/v1.3/docs/guides/analyze-videos) page.
      * </Note>
      *
      * @param {TwelvelabsApi.AnalyzeRequest} request
@@ -386,7 +258,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.0", "User-Agent": "twelvelabs-js/1.2.0", "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.2", "User-Agent": "twelvelabs-js/1.2.2", "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 }),