twelvelabs-js 1.2.1 → 1.2.3

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,22 +48,55 @@ export declare class TwelvelabsApiClient {
     get entityCollections(): EntityCollections;
     get embed(): Embed;
     get search(): Search;
+    get analyzeAsync(): AnalyzeAsync;
     /**
-     * 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.
+     * - Video segmentation. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with `model_name` set to `pegasus1.5` 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.
      * </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.
+     * - Video segmentation. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with `model_name` set to `pegasus1.5` 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.
      * </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,12 +95,32 @@ class TwelvelabsApiClient {
         var _a;
         return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_7.Search(this._options)));
     }
+    get analyzeAsync() {
+        var _a;
+        return ((_a = this._analyzeAsync) !== null && _a !== void 0 ? _a : (this._analyzeAsync = new Client_8.AnalyzeAsync(this._options)));
+    }
     /**
-     * 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.
+     * - Video segmentation. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with `model_name` set to `pegasus1.5` 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.
      * </Note>
      */
     analyzeStream(request, requestOptions) {
@@ -111,7 +132,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.1", "User-Agent": "twelvelabs-js/1.2.1", "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.3", "User-Agent": "twelvelabs-js/1.2.3", "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 }),
@@ -173,11 +194,27 @@ 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.
+     * - Video segmentation. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with `model_name` set to `pegasus1.5` 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.
      * </Note>
      *
      * @param {TwelvelabsApi.AnalyzeRequest} request
@@ -223,7 +260,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.1", "User-Agent": "twelvelabs-js/1.2.1", "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.3", "User-Agent": "twelvelabs-js/1.2.3", "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 }),