twelvelabs-js 1.2.4 → 1.2.5

package/Client.js

@@ -132,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.4", "User-Agent": "twelvelabs-js/1.2.4", "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.5", "User-Agent": "twelvelabs-js/1.2.5", "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 }),
@@ -238,7 +238,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.4", "User-Agent": "twelvelabs-js/1.2.4", "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.5", "User-Agent": "twelvelabs-js/1.2.5", "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

@@ -10,7 +10,7 @@ export interface AnalyzeRequest {
     /**
      * The video understanding model to use for analysis.
      * - `pegasus1.2`: General analysis (prompt-based text generation).
-     * - `pegasus1.5`: General analysis (prompt-based text generation) with video clipping, structured prompts with reference images, extended token limits, and video segmentation (async only). Does not support `analysis_mode=time_based_metadata` or `response_format.type=segment_definitions` — use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
+     * - `pegasus1.5`: General analysis (prompt-based text generation) with video clipping, structured prompts with reference images, and video segmentation (async only). See the [Pegasus](/v1.3/docs/concepts/models/pegasus#context-window) page for token limits.
      *
      * **Default:** `pegasus1.2`
      */
@@ -22,20 +22,28 @@ export interface AnalyzeRequest {
      */
     videoId?: string;
     video?: TwelvelabsApi.VideoContext;
-    /** A text prompt that guides the model on the desired format or content. Works with both Pegasus 1.2 and Pegasus 1.5. To include reference images in your prompt, use the `prompt_v2` parameter instead (Pegasus 1.5 only). Mutually exclusive with the `prompt_v2` parameter. */
+    /**
+     * A text prompt that guides the model on the desired format or content. Works with both Pegasus 1.2 and Pegasus 1.5. To include reference images in your prompt, use the `prompt_v2` parameter instead (Pegasus 1.5 only). Mutually exclusive with the `prompt_v2` parameter.
+     *
+     * Your prompts can be instructive or descriptive, or you can phrase them as questions. Pegasus 1.2 limits prompts to 2,000 tokens. For Pegasus 1.5, this text counts toward the [context window](/v1.3/docs/concepts/models/pegasus#context-window).
+     */
     prompt?: TwelvelabsApi.AnalyzeTextPrompt;
-    /** A structured prompt with `<@name>` placeholders for referencing images. Requires the `model_name` parameter set to `pegasus1.5`. Mutually exclusive with the `prompt` parameter. */
+    /**
+     * A structured prompt with `<@name>` placeholders for referencing images. Requires the `model_name` parameter set to `pegasus1.5`. Mutually exclusive with the `prompt` parameter.
+     *
+     * The prompt text and reference images count toward the [context window](/v1.3/docs/concepts/models/pegasus#context-window).
+     */
     promptV2?: TwelvelabsApi.AnalyzePromptV2;
     temperature?: TwelvelabsApi.AnalyzeTemperature;
     /** Specifies the format of the response. When you omit this parameter, the platform returns unstructured text. Only the `json_schema` type is supported for synchronous analysis. */
     responseFormat?: TwelvelabsApi.SyncResponseFormat;
     /**
-     * The maximum number of tokens to generate. The allowed range depends on the model:
+     * The maximum response length, in tokens. The allowed range depends on the model:
      *
      * | Model | Min | Max | Default |
      * |-------|-----|-----|---------|
      * | Pegasus 1.2 | 1 | 4,096 | 4,096 |
-     * | Pegasus 1.5 | 512 | 65,536 | 4,096 |
+     * | Pegasus 1.5 | 512 | 98,304 | 4,096 |
      */
     maxTokens?: number;
     /**

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

@@ -10,7 +10,7 @@ export interface AnalyzeStreamRequest {
     /**
      * The video understanding model to use for analysis.
      * - `pegasus1.2`: General analysis (prompt-based text generation).
-     * - `pegasus1.5`: General analysis (prompt-based text generation) with video clipping, structured prompts with reference images, extended token limits, and video segmentation (async only). Does not support `analysis_mode=time_based_metadata` or `response_format.type=segment_definitions` — use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
+     * - `pegasus1.5`: General analysis (prompt-based text generation) with video clipping, structured prompts with reference images, and video segmentation (async only). See the [Pegasus](/v1.3/docs/concepts/models/pegasus#context-window) page for token limits.
      *
      * **Default:** `pegasus1.2`
      */
@@ -22,20 +22,28 @@ export interface AnalyzeStreamRequest {
      */
     videoId?: string;
     video?: TwelvelabsApi.VideoContext;
-    /** A text prompt that guides the model on the desired format or content. Works with both Pegasus 1.2 and Pegasus 1.5. To include reference images in your prompt, use the `prompt_v2` parameter instead (Pegasus 1.5 only). Mutually exclusive with the `prompt_v2` parameter. */
+    /**
+     * A text prompt that guides the model on the desired format or content. Works with both Pegasus 1.2 and Pegasus 1.5. To include reference images in your prompt, use the `prompt_v2` parameter instead (Pegasus 1.5 only). Mutually exclusive with the `prompt_v2` parameter.
+     *
+     * Your prompts can be instructive or descriptive, or you can phrase them as questions. Pegasus 1.2 limits prompts to 2,000 tokens. For Pegasus 1.5, this text counts toward the [context window](/v1.3/docs/concepts/models/pegasus#context-window).
+     */
     prompt?: TwelvelabsApi.AnalyzeTextPrompt;
-    /** A structured prompt with `<@name>` placeholders for referencing images. Requires the `model_name` parameter set to `pegasus1.5`. Mutually exclusive with the `prompt` parameter. */
+    /**
+     * A structured prompt with `<@name>` placeholders for referencing images. Requires the `model_name` parameter set to `pegasus1.5`. Mutually exclusive with the `prompt` parameter.
+     *
+     * The prompt text and reference images count toward the [context window](/v1.3/docs/concepts/models/pegasus#context-window).
+     */
     promptV2?: TwelvelabsApi.AnalyzePromptV2;
     temperature?: TwelvelabsApi.AnalyzeTemperature;
     /** Specifies the format of the response. When you omit this parameter, the platform returns unstructured text. Only the `json_schema` type is supported for synchronous analysis. */
     responseFormat?: TwelvelabsApi.SyncResponseFormat;
     /**
-     * The maximum number of tokens to generate. The allowed range depends on the model:
+     * The maximum response length, in tokens. The allowed range depends on the model:
      *
      * | Model | Min | Max | Default |
      * |-------|-----|-----|---------|
      * | Pegasus 1.2 | 1 | 4,096 | 4,096 |
-     * | Pegasus 1.5 | 512 | 65,536 | 4,096 |
+     * | Pegasus 1.5 | 512 | 98,304 | 4,096 |
      */
     maxTokens?: number;
     /**

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

@@ -170,6 +170,34 @@ export declare class Tasks {
      *             type: "url",
      *             url: "https://example.com/video.mp4"
      *         },
+     *         analysisMode: "time_based_metadata",
+     *         responseFormat: {
+     *             type: "segment_definitions",
+     *             segmentDefinitions: [{
+     *                     id: "scenes",
+     *                     description: "Detect scenes and label them.",
+     *                     fields: [{
+     *                             name: "label",
+     *                             type: "string",
+     *                             description: "A short label for this scene."
+     *                         }, {
+     *                             name: "highlight_at",
+     *                             type: "timestamp",
+     *                             description: "The single most representative moment in this scene.",
+     *                             format: "seconds"
+     *                         }]
+     *                 }],
+     *             segmentTimeFormat: "hh:mm:ss"
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.analyzeAsync.tasks.create({
+     *         modelName: "pegasus1.5",
+     *         video: {
+     *             type: "url",
+     *             url: "https://example.com/video.mp4"
+     *         },
      *         promptV2: {
      *             inputText: "Is there a <@tiger-1> in the video?",
      *             mediaSources: [{
@@ -180,6 +208,47 @@ export declare class Tasks {
      *         },
      *         maxTokens: 4096
      *     })
+     *
+     * @example
+     *     await client.analyzeAsync.tasks.create({
+     *         modelName: "pegasus1.5",
+     *         video: {
+     *             type: "url",
+     *             url: "https://example.com/video.mp4"
+     *         },
+     *         prompt: "Identify intro, main content, and outro clips.",
+     *         responseFormat: {
+     *             type: "json_schema",
+     *             jsonSchema: {
+     *                 "type": "object",
+     *                 "properties": {
+     *                     "clip_start": {
+     *                         "type": "timestamp",
+     *                         "format": "seconds"
+     *                     },
+     *                     "events": {
+     *                         "type": "array",
+     *                         "items": {
+     *                             "type": "object",
+     *                             "properties": {
+     *                                 "intro_end": {
+     *                                     "type": "timestamp",
+     *                                     "format": "hh:mm:ss"
+     *                                 },
+     *                                 "outro_start": {
+     *                                     "type": "timestamp",
+     *                                     "format": "hh:mm:ss.fff"
+     *                                 },
+     *                                 "label": {
+     *                                     "type": "string"
+     *                                 }
+     *                             }
+     *                         }
+     *                     }
+     *                 }
+     *             }
+     *         }
+     *     })
      */
     create(request: TwelvelabsApi.analyzeAsync.CreateAsyncAnalyzeRequest, requestOptions?: Tasks.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.CreateAnalyzeTaskResponse>;
     private __create;

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

@@ -112,7 +112,7 @@ class Tasks {
             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/tasks"),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.4", "User-Agent": "twelvelabs-js/1.2.4", "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.5", "User-Agent": "twelvelabs-js/1.2.5", "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",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -284,6 +284,34 @@ class Tasks {
      *             type: "url",
      *             url: "https://example.com/video.mp4"
      *         },
+     *         analysisMode: "time_based_metadata",
+     *         responseFormat: {
+     *             type: "segment_definitions",
+     *             segmentDefinitions: [{
+     *                     id: "scenes",
+     *                     description: "Detect scenes and label them.",
+     *                     fields: [{
+     *                             name: "label",
+     *                             type: "string",
+     *                             description: "A short label for this scene."
+     *                         }, {
+     *                             name: "highlight_at",
+     *                             type: "timestamp",
+     *                             description: "The single most representative moment in this scene.",
+     *                             format: "seconds"
+     *                         }]
+     *                 }],
+     *             segmentTimeFormat: "hh:mm:ss"
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.analyzeAsync.tasks.create({
+     *         modelName: "pegasus1.5",
+     *         video: {
+     *             type: "url",
+     *             url: "https://example.com/video.mp4"
+     *         },
      *         promptV2: {
      *             inputText: "Is there a <@tiger-1> in the video?",
      *             mediaSources: [{
@@ -294,6 +322,47 @@ class Tasks {
      *         },
      *         maxTokens: 4096
      *     })
+     *
+     * @example
+     *     await client.analyzeAsync.tasks.create({
+     *         modelName: "pegasus1.5",
+     *         video: {
+     *             type: "url",
+     *             url: "https://example.com/video.mp4"
+     *         },
+     *         prompt: "Identify intro, main content, and outro clips.",
+     *         responseFormat: {
+     *             type: "json_schema",
+     *             jsonSchema: {
+     *                 "type": "object",
+     *                 "properties": {
+     *                     "clip_start": {
+     *                         "type": "timestamp",
+     *                         "format": "seconds"
+     *                     },
+     *                     "events": {
+     *                         "type": "array",
+     *                         "items": {
+     *                             "type": "object",
+     *                             "properties": {
+     *                                 "intro_end": {
+     *                                     "type": "timestamp",
+     *                                     "format": "hh:mm:ss"
+     *                                 },
+     *                                 "outro_start": {
+     *                                     "type": "timestamp",
+     *                                     "format": "hh:mm:ss.fff"
+     *                                 },
+     *                                 "label": {
+     *                                     "type": "string"
+     *                                 }
+     *                             }
+     *                         }
+     *                     }
+     *                 }
+     *             }
+     *         }
+     *     })
      */
     create(request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
@@ -304,7 +373,7 @@ class Tasks {
             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/tasks"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.4", "User-Agent": "twelvelabs-js/1.2.4", "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.5", "User-Agent": "twelvelabs-js/1.2.5", "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.analyzeAsync.CreateAsyncAnalyzeRequest.jsonOrThrow(request, {
@@ -385,7 +454,7 @@ class Tasks {
             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/tasks/${encodeURIComponent(taskId)}`),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.4", "User-Agent": "twelvelabs-js/1.2.4", "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.5", "User-Agent": "twelvelabs-js/1.2.5", "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",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 600000,
@@ -453,7 +522,7 @@ class Tasks {
             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/tasks/${encodeURIComponent(taskId)}`),
                 method: "DELETE",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.4", "User-Agent": "twelvelabs-js/1.2.4", "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.5", "User-Agent": "twelvelabs-js/1.2.5", "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",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 600000,

package/api/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts

@@ -91,6 +91,34 @@ import * as TwelvelabsApi from "../../../../../../index";
  *             type: "url",
  *             url: "https://example.com/video.mp4"
  *         },
+ *         analysisMode: "time_based_metadata",
+ *         responseFormat: {
+ *             type: "segment_definitions",
+ *             segmentDefinitions: [{
+ *                     id: "scenes",
+ *                     description: "Detect scenes and label them.",
+ *                     fields: [{
+ *                             name: "label",
+ *                             type: "string",
+ *                             description: "A short label for this scene."
+ *                         }, {
+ *                             name: "highlight_at",
+ *                             type: "timestamp",
+ *                             description: "The single most representative moment in this scene.",
+ *                             format: "seconds"
+ *                         }]
+ *                 }],
+ *             segmentTimeFormat: "hh:mm:ss"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         modelName: "pegasus1.5",
+ *         video: {
+ *             type: "url",
+ *             url: "https://example.com/video.mp4"
+ *         },
  *         promptV2: {
  *             inputText: "Is there a <@tiger-1> in the video?",
  *             mediaSources: [{
@@ -101,12 +129,53 @@ import * as TwelvelabsApi from "../../../../../../index";
  *         },
  *         maxTokens: 4096
  *     }
+ *
+ * @example
+ *     {
+ *         modelName: "pegasus1.5",
+ *         video: {
+ *             type: "url",
+ *             url: "https://example.com/video.mp4"
+ *         },
+ *         prompt: "Identify intro, main content, and outro clips.",
+ *         responseFormat: {
+ *             type: "json_schema",
+ *             jsonSchema: {
+ *                 "type": "object",
+ *                 "properties": {
+ *                     "clip_start": {
+ *                         "type": "timestamp",
+ *                         "format": "seconds"
+ *                     },
+ *                     "events": {
+ *                         "type": "array",
+ *                         "items": {
+ *                             "type": "object",
+ *                             "properties": {
+ *                                 "intro_end": {
+ *                                     "type": "timestamp",
+ *                                     "format": "hh:mm:ss"
+ *                                 },
+ *                                 "outro_start": {
+ *                                     "type": "timestamp",
+ *                                     "format": "hh:mm:ss.fff"
+ *                                 },
+ *                                 "label": {
+ *                                     "type": "string"
+ *                                 }
+ *                             }
+ *                         }
+ *                     }
+ *                 }
+ *             }
+ *         }
+ *     }
  */
 export interface CreateAsyncAnalyzeRequest {
     /**
      * The video understanding model to use for analysis.
      * - `pegasus1.2`: General analysis (prompt-based text generation).
-     * - `pegasus1.5`: General analysis (prompt-based text generation) with video clipping, structured prompts with reference images, extended token limits, and video segmentation.
+     * - `pegasus1.5`: General analysis (prompt-based text generation) with video clipping, structured prompts with reference images, and video segmentation. See the [Pegasus](/v1.3/docs/concepts/models/pegasus#context-window) page for token limits.
      *
      * **Default:** `pegasus1.2`
      */
@@ -128,11 +197,7 @@ export interface CreateAsyncAnalyzeRequest {
     /**
      * Natural-language instructions for analyzing the video. Required for general analysis (prompt-based text generation). Not supported when `analysis_mode` is `time_based_metadata`. To include reference images in your prompt, use the `prompt_v2` parameter instead (Pegasus 1.5 only). Mutually exclusive with the `prompt_v2` parameter.
      *
-     * <Note title="Notes">
-     * - Even though the model behind this endpoint is trained to a high degree of accuracy, the preciseness of the generated text may vary based on the nature and quality of the video and the clarity of the prompt.
-     * - Your prompts can be instructive or descriptive, or you can also phrase them as questions.
-     * - The maximum length of a prompt is 2,000 tokens.
-     * </Note>
+     * Your prompts can be instructive or descriptive, or you can phrase them as questions. Pegasus 1.2 limits prompts to 2,000 tokens. For Pegasus 1.5, this text counts toward the [context window](/v1.3/docs/concepts/models/pegasus#context-window).
      *
      * **Examples**:
      *
@@ -140,6 +205,11 @@ export interface CreateAsyncAnalyzeRequest {
      * - I want to generate a description for my video with the following format: Title of the video, followed by a summary in 2-3 sentences, highlighting the main topic, key events, and concluding remarks.
      */
     prompt?: string;
+    /**
+     * A structured prompt with `<@name>` placeholders for referencing images. Requires the `model_name` parameter set to `pegasus1.5`. Mutually exclusive with the `prompt` parameter.
+     *
+     * The prompt text and reference images count toward the [context window](/v1.3/docs/concepts/models/pegasus#context-window).
+     */
     promptV2?: TwelvelabsApi.AnalyzePromptV2;
     /**
      * The analysis approach for this task.
@@ -151,13 +221,13 @@ export interface CreateAsyncAnalyzeRequest {
     analysisMode?: TwelvelabsApi.analyzeAsync.CreateAsyncAnalyzeRequestAnalysisMode;
     temperature?: TwelvelabsApi.AnalyzeTemperature;
     /**
-     * The maximum number of tokens to generate. The allowed range depends on the model and analysis mode:
+     * The maximum response length, in tokens. The allowed range depends on the model and analysis mode:
      *
      * | Model | Mode | Min | Max | Default |
      * |-------|------|-----|-----|---------|
      * | Pegasus 1.2 | — | 1 | 4,096 | 4096 |
-     * | Pegasus 1.5 | `general` | 512 | 65,536 | 4,096 |
-     * | Pegasus 1.5 | `time_based_metadata` | 2,048 | 65,536 | 32,768 |
+     * | Pegasus 1.5 | `general` | 512 | 98,304 | 4,096 |
+     * | Pegasus 1.5 | `time_based_metadata` | 2,048 | 98,304 | 32,768 |
      */
     maxTokens?: number;
     responseFormat?: TwelvelabsApi.AsyncResponseFormat;
@@ -180,6 +250,7 @@ export interface CreateAsyncAnalyzeRequest {
      * - If omitted, defaults to `0`.
      * - Must be less than `end_time` and less than the video duration. The clip (`end_time - start_time`) must be at least `4` seconds.
      * - Mutually exclusive with `response_format.segment_definitions[].time_ranges`.
+     * - Together with `end_time`, this parameter determines the billable video duration. If you omit both, billing uses the full video duration. For details, see the [Frequently asked questions](/v1.3/docs/resources/frequently-asked-questions#how-is-video-segmentation-priced) page.
      * </Note>
      */
     startTime?: number;
@@ -190,6 +261,7 @@ export interface CreateAsyncAnalyzeRequest {
      * - If omitted, defaults to the video duration.
      * - Must be greater than `start_time` and less than or equal to the video duration. The clip (`end_time - start_time`) must be at least `4` seconds.
      * - Mutually exclusive with `response_format.segment_definitions[].time_ranges`.
+     * - Together with `start_time`, this parameter determines the billable video duration. If you omit both, billing uses the full video duration. For details, see the [Frequently asked questions](/v1.3/docs/resources/frequently-asked-questions#how-is-video-segmentation-priced) page.
      * </Note>
      */
     endTime?: number;

package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts

@@ -4,7 +4,7 @@
 /**
  * The video understanding model to use for analysis.
  * - `pegasus1.2`: General analysis (prompt-based text generation).
- * - `pegasus1.5`: General analysis (prompt-based text generation) with video clipping, structured prompts with reference images, extended token limits, and video segmentation.
+ * - `pegasus1.5`: General analysis (prompt-based text generation) with video clipping, structured prompts with reference images, and video segmentation. See the [Pegasus](/v1.3/docs/concepts/models/pegasus#context-window) page for token limits.
  *
  * **Default:** `pegasus1.2`
  */

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

@@ -115,6 +115,50 @@ export declare class Assets {
      */
     delete(assetId: string, request?: TwelvelabsApi.AssetsDeleteRequest, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
+    /**
+     * This method deletes the user-defined metadata of the specified asset.
+     *
+     * This action cannot be undone.
+     *
+     * @param {string} assetId - The unique identifier of the asset whose user-defined metadata to delete.
+     * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     * @throws {@link TwelvelabsApi.NotFoundError}
+     *
+     * @example
+     *     await client.assets.deleteUserMetadata("6298d673f1090f1100476d4c")
+     */
+    deleteUserMetadata(assetId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteUserMetadata;
+    /**
+     * This method updates the user-defined metadata of the specified asset. The platform merges your changes with the existing metadata:
+     * - A key with a value creates or replaces that key.
+     * - A key set to `null` deletes that key.
+     * - A key set to an empty string (`""`) is ignored.
+     * - A key you omit from the request keeps its current value.
+     *
+     * To replace all metadata, first delete it using [`DELETE`](/v1.3/api-reference/upload-content/direct-uploads/delete-asset-user-metadata) method of the `/assets/{asset_id}/user-metadata` endpoint, then use this method to set the new values.
+     *
+     * @param {string} assetId - The unique identifier of the asset whose user-defined metadata to update.
+     * @param {TwelvelabsApi.AssetsUpdateUserMetadataRequest} request
+     * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     * @throws {@link TwelvelabsApi.NotFoundError}
+     *
+     * @example
+     *     await client.assets.updateUserMetadata("6298d673f1090f1100476d4c", {
+     *         userMetadata: {
+     *             "category": "recentlyAdded",
+     *             "batchNumber": 5,
+     *             "rating": 9.3,
+     *             "needsReview": true
+     *         }
+     *     })
+     */
+    updateUserMetadata(assetId: string, request: TwelvelabsApi.AssetsUpdateUserMetadataRequest, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<void>;
+    private __updateUserMetadata;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "x-api-key": string;
     }>;