twelvelabs-js 1.2.2 → 1.2.4

package/api/types/One.d.ts

@@ -5,6 +5,6 @@
  * Provide the video via a unique identifier of an asset.
  */
 export interface One {
-    /** The unique identifier of an asset from a [direct](/v1.3/api-reference/upload-content/direct-uploads) or [multipart](/v1.3/api-reference/upload-content/multipart-uploads) upload. */
+    /** The unique identifier of an asset from a [direct](/v1.3/api-reference/upload-content/direct-uploads) or [multipart](/v1.3/api-reference/upload-content/multipart-uploads) upload. The asset status must be `ready`. Use the [Retrieve an asset](/v1.3/api-reference/upload-content/direct-uploads/retrieve) method to check the status. */
     assetId: string;
 }

package/api/types/SegmentDefinition.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * Defines a type of segment to extract from the video.
+ */
+export interface SegmentDefinition {
+    /** A unique identifier for this segment definition. */
+    id: string;
+    /** Describe what this type of segment looks like in the video. The model uses this text to identify matching segments. */
+    description: string;
+    /** Custom fields to extract for each segment instance. Maximum 20 fields. */
+    fields?: TwelvelabsApi.SegmentField[];
+    /** Reference images that help the model identify segments. Maximum 4 sources. */
+    mediaSources?: TwelvelabsApi.SmeMediaSource[];
+    /**
+     * Time windows that limit segment extraction to specific parts of the video. Only supported for Pegasus 1.5 with `analysis_mode` set to `time_based_metadata`.
+     *
+     * <Note title="Notes">
+     * - Each range must satisfy `end_time > start_time` with a minimum duration of `2` seconds. Both values must fall within the video duration.
+     * - Ranges within a single definition must not overlap. Touching boundaries are allowed (Example: `[0, 5]` and `[5, 10]`).
+     * - Mutually exclusive with the top-level `start_time` / `end_time` fields.
+     * - Mutually exclusive with `min_segment_duration` and `max_segment_duration`.
+     * </Note>
+     */
+    timeRanges?: TwelvelabsApi.AnalyzeTimeRange[];
+}

package/api/types/SegmentDefinition.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SegmentField.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * A custom field to extract for each segment.
+ */
+export interface SegmentField {
+    /** The name of the field. */
+    name: string;
+    /** The data type of the field. */
+    type: TwelvelabsApi.SegmentFieldType;
+    /** Instructions that guide the model on what this field should contain and how to extract it from the video. */
+    description: string;
+    /** Allowed values for this field. Maximum 50 values. */
+    enum?: string[];
+    /** Required when `type` is `array`. Specifies the type of array elements. */
+    items?: TwelvelabsApi.SegmentFieldItems;
+}

package/api/types/SegmentField.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SegmentFieldItems.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * Required when `type` is `array`. Specifies the type of array elements.
+ */
+export interface SegmentFieldItems {
+    type: TwelvelabsApi.SegmentFieldItemsType;
+}

package/api/types/SegmentFieldItems.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SegmentFieldItemsType.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type SegmentFieldItemsType = "string" | "number" | "boolean" | "integer";
+export declare const SegmentFieldItemsType: {
+    readonly String: "string";
+    readonly Number: "number";
+    readonly Boolean: "boolean";
+    readonly Integer: "integer";
+};

package/api/types/SegmentFieldItemsType.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SegmentFieldItemsType = void 0;
+exports.SegmentFieldItemsType = {
+    String: "string",
+    Number: "number",
+    Boolean: "boolean",
+    Integer: "integer",
+};

package/api/types/SegmentFieldType.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The data type of the field.
+ */
+export type SegmentFieldType = "string" | "boolean" | "number" | "integer" | "array";
+export declare const SegmentFieldType: {
+    readonly String: "string";
+    readonly Boolean: "boolean";
+    readonly Number: "number";
+    readonly Integer: "integer";
+    readonly Array: "array";
+};

package/api/types/SegmentFieldType.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SegmentFieldType = void 0;
+exports.SegmentFieldType = {
+    String: "string",
+    Boolean: "boolean",
+    Number: "number",
+    Integer: "integer",
+    Array: "array",
+};

package/api/types/SmeMediaSource.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * A reference image that provides visual context for segment identification. Provide exactly one of `url`, `asset_id`, or `base64_string`.
+ */
+export interface SmeMediaSource {
+    /** A descriptive name for this media source. */
+    name: string;
+    /** The media type. Only `image` is available. */
+    mediaType: TwelvelabsApi.SmeMediaSourceMediaType;
+    /** A publicly accessible HTTPS URL of the image. */
+    url?: string;
+    /** The unique identifier of an uploaded asset. */
+    assetId?: string;
+    /** Base64-encoded image data. The maximum size is 30MB. */
+    base64String?: string;
+}

package/api/types/SmeMediaSource.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SmeMediaSourceMediaType.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The media type. Only `image` is available.
+ */
+export type SmeMediaSourceMediaType = "image";
+export declare const SmeMediaSourceMediaType: {
+    readonly Image: "image";
+};

package/api/types/SmeMediaSourceMediaType.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SmeMediaSourceMediaType = void 0;
+exports.SmeMediaSourceMediaType = {
+    Image: "image",
+};

package/api/types/{ResponseFormat.d.ts → SyncResponseFormat.d.ts}

@@ -5,9 +5,9 @@ import * as TwelvelabsApi from "../index";
 /**
  * Specifies the format of the response. When you omit this parameter, the platform returns unstructured text.
  */
-export interface ResponseFormat {
+export interface SyncResponseFormat {
     /** Set this parameter to "json_schema" to receive structured JSON responses. */
-    type: TwelvelabsApi.ResponseFormatType;
+    type: TwelvelabsApi.SyncResponseFormatType;
     /**
      * Contains the JSON schema that defines the response structure. The schema must adhere to the [JSON Schema Draft 2020-12](https://json-schema.org/draft/2020-12) specification.
      *
@@ -24,23 +24,30 @@ export interface ResponseFormat {
      *
      * | Type | Supported keywords | Notes |
      * |------|-------------------|-------|
-     * | `integer` | `maximum`, `exclusiveMaximum`, `minimum`, `exclusiveMinimum`. | - `maximum`: Sets the highest allowed value (inclusive).<br/>- `exclusiveMaximum`: Sets the highest allowed value (exclusive).<br/>-`minimum`: Sets the lowest allowed value (inclusive).<br/>- `exclusiveMinimum`: Sets the lowest allowed value (exclusive).<br/>These constraints are supported only for the `integer` type. |
+     * | `integer` | `maximum`, `exclusiveMaximum`, `minimum`, `exclusiveMinimum`. | - `maximum`: Sets the highest allowed value (inclusive).<br/>- `exclusiveMaximum`: Sets the highest allowed value (exclusive).<br/>- `minimum`: Sets the lowest allowed value (inclusive).<br/>- `exclusiveMinimum`: Sets the lowest allowed value (exclusive).<br/>These constraints are supported only for the `integer` type. |
      * | `string` | `pattern`, `format` | - `pattern`: A regular expression that the string must match.<br/>- `format`: Validates predefined formats. It accepts the following values: `uuid`, `date-time`, `date`, and `time`.<br/>See string limitations below. |
      * | `object` | `properties`, `required` | - `properties`: Defines object properties and their schemas. - `required`: Specifies mandatory properties.<br/>See object limitations below. |
-     * | `array` | `items`, `minItems` | `minItems` accepts only `0` or `1` |
+     * | `array` | `items`, `minItems` | `minItems` accepts only `0` or `1`.<br/>See array limitations below. |
      *
      *
      * **String limitations**
      *
-     * The platform validates strings using the `pattern` and `format` constraints only. When you include `minLength` or `maxLength` keywords in your schema, the platform returns an error: "String length constraints (minLength) are not supported."
+     * When you use the `string` type:
+     * - The platform validates strings using only `pattern` and `format`. Including `minLength` or `maxLength` causes a 422 error: "String length constraints (minLength) are not supported." Remove these keywords from your schema.
      *
      *
      * **Object limitations**
      *
      * When you use the `object` type:
-     * - The platform always ignores the `additionalProperties` setting.
-     * - The sequence of the properties is fixed.
-     * - The first property should be required. If the first property is optional, the platform moves the first required property to the first position.
+     * - The platform does not support the `additionalProperties` keyword. Including it causes a 422 error. Remove it from your schema.
+     * - The platform returns properties in declaration order.
+     * - Make the first property required. If the first property is optional, the platform moves the first required property to the beginning.
+     *
+     *
+     * **Array limitations**
+     *
+     * When you use the `array` type:
+     * - The platform does not support `uniqueItems` or `maxItems`. Including either keyword causes a 422 error. Remove them from your schema.
      *
      *
      * **Constant and enumerated values**
@@ -70,6 +77,18 @@ export interface ResponseFormat {
      * For details, see the [JSON Schema documentation on $defs](https://json-schema.org/understanding-json-schema/structuring#defs).
      *
      *
+     * **Reserved property names (`start_time` / `end_time`)**
+     *
+     * For `pegasus1.5`, properties named `start_time` or `end_time` in your response schema receive special type handling. These are unrelated to the top-level `start_time` / `end_time` request parameters. The model outputs these values as floating-point seconds, and the platform converts them based on the declared type at any nesting depth (including inside array `items`):
+     *
+     * | Declared type | Platform behavior |
+     * |---------------|-------------------|
+     * | `number` | Passes the value through without conversion. |
+     * | `integer` | Rounds the value to the nearest integer before returning it. |
+     * | `string` (no `format`) | Converts the value to the `hh:mm:ss.fff` format. |
+     *
+     * All other property names in your schema remain unconstrained by these rules.
+     *
      *
      * **Response validation**
      *

package/api/types/SyncResponseFormat.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/{dist/api/types/ResponseFormatType.d.ts → api/types/SyncResponseFormatType.d.ts}

@@ -4,7 +4,7 @@
 /**
  * Set this parameter to "json_schema" to receive structured JSON responses.
  */
-export type ResponseFormatType = "json_schema";
-export declare const ResponseFormatType: {
+export type SyncResponseFormatType = "json_schema";
+export declare const SyncResponseFormatType: {
     readonly JsonSchema: "json_schema";
 };

package/{dist/api/types/ResponseFormatType.js → api/types/SyncResponseFormatType.js}

@@ -3,7 +3,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResponseFormatType = void 0;
-exports.ResponseFormatType = {
+exports.SyncResponseFormatType = void 0;
+exports.SyncResponseFormatType = {
     JsonSchema: "json_schema",
 };

package/api/types/TokenUsage.d.ts

@@ -6,5 +6,7 @@
  */
 export interface TokenUsage {
     /** The number of tokens in the generated text. */
-    outputTokens?: number;
+    outputTokens: number;
+    /** The number of tokens consumed by the input (prompt and video). Omitted for Pegasus 1.5. */
+    inputTokens?: number;
 }

package/api/types/VideosListRequestDuration.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface VideosListRequestDuration {
+    gte?: number;
+    lte?: number;
+}

package/api/types/VideosListRequestDuration.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/VideosListRequestFps.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface VideosListRequestFps {
+    gte?: number;
+    lte?: number;
+}

package/api/types/VideosListRequestFps.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/VideosListRequestHeight.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface VideosListRequestHeight {
+    gte?: number;
+    lte?: number;
+}

package/api/types/VideosListRequestHeight.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/VideosListRequestSize.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface VideosListRequestSize {
+    gte?: number;
+    lte?: number;
+}

package/api/types/VideosListRequestSize.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/VideosListRequestWidth.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface VideosListRequestWidth {
+    gte?: number;
+    lte?: number;
+}

package/api/types/VideosListRequestWidth.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/index.d.ts

@@ -1,7 +1,20 @@
 export * from "./BadRequestErrorBody";
+export * from "./IndexedAssetsListRequestDuration";
+export * from "./IndexedAssetsListRequestFps";
+export * from "./IndexedAssetsListRequestWidth";
+export * from "./IndexedAssetsListRequestHeight";
+export * from "./IndexedAssetsListRequestSize";
 export * from "./NotFoundErrorBody";
 export * from "./InternalServerErrorBody";
+export * from "./VideosListRequestDuration";
+export * from "./VideosListRequestFps";
+export * from "./VideosListRequestWidth";
+export * from "./VideosListRequestHeight";
+export * from "./VideosListRequestSize";
+export * from "./ConflictErrorBody";
 export * from "./ForbiddenErrorBody";
+export * from "./AnalyzeStreamRequestModelName";
+export * from "./AnalyzeRequestModelName";
 export * from "./Url";
 export * from "./One";
 export * from "./Two";
@@ -115,12 +128,36 @@ export * from "./StreamEndResponseMetadata";
 export * from "./StreamEndResponse";
 export * from "./NonStreamAnalyzeResponse";
 export * from "./TokenUsage";
-export * from "./ResponseFormatType";
-export * from "./ResponseFormat";
+export * from "./AsyncResponseFormatType";
+export * from "./AsyncResponseFormat";
+export * from "./SyncResponseFormatType";
+export * from "./SyncResponseFormat";
+export * from "./SegmentDefinition";
+export * from "./AnalyzePromptV2";
+export * from "./AnalyzeTimeRange";
+export * from "./SegmentFieldType";
+export * from "./SegmentFieldItemsType";
+export * from "./SegmentFieldItems";
+export * from "./SegmentField";
+export * from "./SmeMediaSourceMediaType";
+export * from "./SmeMediaSource";
 export * from "./FinishReason";
 export * from "./VideoContext";
 export * from "./AnalyzeTaskStatus";
 export * from "./CreateAnalyzeTaskResponse";
+export * from "./AnalyzeTaskResponseVideoSourceType";
+export * from "./AnalyzeTaskResponseVideoSourceSystemMetadata";
+export * from "./AnalyzeTaskResponseVideoSource";
+export * from "./AnalyzeTaskResponseRequestParamsAnalysisMode";
+export * from "./AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem";
+export * from "./AnalyzeTaskResponseRequestParamsPromptV2";
+export * from "./AnalyzeTaskResponseRequestParamsResponseFormatType";
+export * from "./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems";
+export * from "./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem";
+export * from "./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem";
+export * from "./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem";
+export * from "./AnalyzeTaskResponseRequestParamsResponseFormat";
+export * from "./AnalyzeTaskResponseRequestParams";
 export * from "./AnalyzeTaskResponse";
 export * from "./AnalyzeTaskResultUsage";
 export * from "./AnalyzeTaskResult";
@@ -129,6 +166,13 @@ export * from "./AnalyzeTaskWebhookInfo";
 export * from "./AssetMethod";
 export * from "./AssetStatus";
 export * from "./Asset";
+export * from "./AssetDetail";
+export * from "./AssetHlsStatus";
+export * from "./AssetHls";
+export * from "./AssetThumbnailStatus";
+export * from "./AssetThumbnail";
+export * from "./IndexedAssetSummaryIndex";
+export * from "./IndexedAssetSummary";
 export * from "./CreateAssetUploadResponse";
 export * from "./CompletedChunkProofType";
 export * from "./CompletedChunk";

package/api/types/index.js

@@ -15,9 +15,22 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BadRequestErrorBody"), exports);
+__exportStar(require("./IndexedAssetsListRequestDuration"), exports);
+__exportStar(require("./IndexedAssetsListRequestFps"), exports);
+__exportStar(require("./IndexedAssetsListRequestWidth"), exports);
+__exportStar(require("./IndexedAssetsListRequestHeight"), exports);
+__exportStar(require("./IndexedAssetsListRequestSize"), exports);
 __exportStar(require("./NotFoundErrorBody"), exports);
 __exportStar(require("./InternalServerErrorBody"), exports);
+__exportStar(require("./VideosListRequestDuration"), exports);
+__exportStar(require("./VideosListRequestFps"), exports);
+__exportStar(require("./VideosListRequestWidth"), exports);
+__exportStar(require("./VideosListRequestHeight"), exports);
+__exportStar(require("./VideosListRequestSize"), exports);
+__exportStar(require("./ConflictErrorBody"), exports);
 __exportStar(require("./ForbiddenErrorBody"), exports);
+__exportStar(require("./AnalyzeStreamRequestModelName"), exports);
+__exportStar(require("./AnalyzeRequestModelName"), exports);
 __exportStar(require("./Url"), exports);
 __exportStar(require("./One"), exports);
 __exportStar(require("./Two"), exports);
@@ -131,12 +144,36 @@ __exportStar(require("./StreamEndResponseMetadata"), exports);
 __exportStar(require("./StreamEndResponse"), exports);
 __exportStar(require("./NonStreamAnalyzeResponse"), exports);
 __exportStar(require("./TokenUsage"), exports);
-__exportStar(require("./ResponseFormatType"), exports);
-__exportStar(require("./ResponseFormat"), exports);
+__exportStar(require("./AsyncResponseFormatType"), exports);
+__exportStar(require("./AsyncResponseFormat"), exports);
+__exportStar(require("./SyncResponseFormatType"), exports);
+__exportStar(require("./SyncResponseFormat"), exports);
+__exportStar(require("./SegmentDefinition"), exports);
+__exportStar(require("./AnalyzePromptV2"), exports);
+__exportStar(require("./AnalyzeTimeRange"), exports);
+__exportStar(require("./SegmentFieldType"), exports);
+__exportStar(require("./SegmentFieldItemsType"), exports);
+__exportStar(require("./SegmentFieldItems"), exports);
+__exportStar(require("./SegmentField"), exports);
+__exportStar(require("./SmeMediaSourceMediaType"), exports);
+__exportStar(require("./SmeMediaSource"), exports);
 __exportStar(require("./FinishReason"), exports);
 __exportStar(require("./VideoContext"), exports);
 __exportStar(require("./AnalyzeTaskStatus"), exports);
 __exportStar(require("./CreateAnalyzeTaskResponse"), exports);
+__exportStar(require("./AnalyzeTaskResponseVideoSourceType"), exports);
+__exportStar(require("./AnalyzeTaskResponseVideoSourceSystemMetadata"), exports);
+__exportStar(require("./AnalyzeTaskResponseVideoSource"), exports);
+__exportStar(require("./AnalyzeTaskResponseRequestParamsAnalysisMode"), exports);
+__exportStar(require("./AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem"), exports);
+__exportStar(require("./AnalyzeTaskResponseRequestParamsPromptV2"), exports);
+__exportStar(require("./AnalyzeTaskResponseRequestParamsResponseFormatType"), exports);
+__exportStar(require("./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems"), exports);
+__exportStar(require("./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem"), exports);
+__exportStar(require("./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem"), exports);
+__exportStar(require("./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem"), exports);
+__exportStar(require("./AnalyzeTaskResponseRequestParamsResponseFormat"), exports);
+__exportStar(require("./AnalyzeTaskResponseRequestParams"), exports);
 __exportStar(require("./AnalyzeTaskResponse"), exports);
 __exportStar(require("./AnalyzeTaskResultUsage"), exports);
 __exportStar(require("./AnalyzeTaskResult"), exports);
@@ -145,6 +182,13 @@ __exportStar(require("./AnalyzeTaskWebhookInfo"), exports);
 __exportStar(require("./AssetMethod"), exports);
 __exportStar(require("./AssetStatus"), exports);
 __exportStar(require("./Asset"), exports);
+__exportStar(require("./AssetDetail"), exports);
+__exportStar(require("./AssetHlsStatus"), exports);
+__exportStar(require("./AssetHls"), exports);
+__exportStar(require("./AssetThumbnailStatus"), exports);
+__exportStar(require("./AssetThumbnail"), exports);
+__exportStar(require("./IndexedAssetSummaryIndex"), exports);
+__exportStar(require("./IndexedAssetSummary"), exports);
 __exportStar(require("./CreateAssetUploadResponse"), exports);
 __exportStar(require("./CompletedChunkProofType"), exports);
 __exportStar(require("./CompletedChunk"), exports);

package/dist/Client.d.ts

@@ -50,7 +50,7 @@ export declare class TwelvelabsApiClient {
     get search(): Search;
     get analyzeAsync(): AnalyzeAsync;
     /**
-     * This method synchronously analyzes your videos and generates fully customizable text based on your prompts.
+     * This method analyzes your videos and returns the results directly in the response. It generates text based on your prompts and supports both Pegasus 1.2 and Pegasus 1.5 for general analysis (prompt-based text generation).
      *
      * <Accordion title="Input requirements">
      * - Minimum duration: 4 seconds
@@ -62,20 +62,21 @@ export declare class TwelvelabsApiClient {
      *
      * **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
+     * - Retrieve immediate results without polling for task completion
+     * - 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 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.
      *
-     * <Note title="Notes">
-     * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
+     * <Note title="Note">
+     * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
      * </Note>
      */
     analyzeStream(request: TwelvelabsApi.AnalyzeStreamRequest, requestOptions?: TwelvelabsApiClient.RequestOptions): core.HttpResponsePromise<core.Stream<TwelvelabsApi.StreamAnalyzeResponse>>;
     private __analyzeStream;
     /**
-     * This method synchronously analyzes your videos and generates fully customizable text based on your prompts.
+     * This method analyzes your videos and returns the results directly in the response. It generates text based on your prompts and supports both Pegasus 1.2 and Pegasus 1.5 for general analysis (prompt-based text generation).
      *
      * <Accordion title="Input requirements">
      * - Minimum duration: 4 seconds
@@ -87,49 +88,26 @@ export declare class TwelvelabsApiClient {
      *
      * **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
+     * - Retrieve immediate results without polling for task completion
+     * - 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 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.
      *
-     * <Note title="Notes">
-     * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
+     * <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.AnalyzeRequest} request
      * @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link TwelvelabsApi.BadRequestError}
+     * @throws {@link TwelvelabsApi.NotFoundError}
      * @throws {@link TwelvelabsApi.TooManyRequestsError}
      *
      * @example
-     *     await client.analyze({
-     *         videoId: "6298d673f1090f1100476d4c",
-     *         prompt: "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.",
-     *         temperature: 0.2,
-     *         responseFormat: {
-     *             type: "json_schema",
-     *             jsonSchema: {
-     *                 "type": "object",
-     *                 "properties": {
-     *                     "title": {
-     *                         "type": "string"
-     *                     },
-     *                     "summary": {
-     *                         "type": "string"
-     *                     },
-     *                     "keywords": {
-     *                         "type": "array",
-     *                         "items": {
-     *                             "type": "string"
-     *                         }
-     *                     }
-     *                 }
-     *             }
-     *         },
-     *         maxTokens: 2000
-     *     })
+     *     await client.analyze({})
      */
     analyze(request: TwelvelabsApi.AnalyzeRequest, requestOptions?: TwelvelabsApiClient.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.NonStreamAnalyzeResponse>;
     private __analyze;