@aviaryhq/cloudglue-js 0.5.8 → 0.5.10

package/dist/generated/Collections.d.ts

@@ -3,11 +3,12 @@ import { z } from 'zod';
 import { SegmentationConfig } from './common';
 import { SegmentationUniformConfig } from './common';
 import { SegmentationShotDetectorConfig } from './common';
+import { NarrativeConfig } from './common';
 import { KeyframeConfig } from './common';
 import { ThumbnailsConfig } from './common';
 import { File } from './common';
-import { FileSegmentationConfig } from './common';
 import { DescribeOutput } from './common';
+import { FileSegmentationConfig } from './common';
 type Collection = {
     id: string;
     object: 'collection';
@@ -19,6 +20,7 @@ type Collection = {
         schema: {};
         enable_video_level_entities: boolean;
         enable_segment_level_entities: boolean;
+        enable_transcript_mode: boolean;
     }> | undefined;
     transcribe_config?: Partial<{
         enable_summary: boolean;
@@ -67,6 +69,7 @@ type NewCollection = {
         schema: {};
         enable_video_level_entities: boolean;
         enable_segment_level_entities: boolean;
+        enable_transcript_mode: boolean;
     }> | undefined;
     transcribe_config?: Partial<{
         enable_summary: boolean;
@@ -91,9 +94,10 @@ type NewCollection = {
     }> | null | undefined;
 };
 type DefaultSegmentationConfig = {
-    strategy: 'uniform' | 'shot-detector';
+    strategy: 'uniform' | 'shot-detector' | 'narrative';
     uniform_config?: SegmentationUniformConfig | undefined;
     shot_detector_config?: SegmentationShotDetectorConfig | undefined;
+    narrative_config?: NarrativeConfig | undefined;
     keyframe_config?: KeyframeConfig | undefined;
     start_time_seconds?: number | undefined;
     end_time_seconds?: number | undefined;
@@ -105,6 +109,13 @@ type CollectionList = {
     limit: number;
     offset: number;
 };
+type CollectionFileList = {
+    object: 'list';
+    data: Array<CollectionFile>;
+    total: number;
+    limit: number;
+    offset: number;
+};
 type CollectionFile = {
     collection_id: string;
     file_id: string;
@@ -119,20 +130,6 @@ type CollectionFile = {
         segmentation_config: SegmentationConfig;
     } | undefined;
 };
-type AddCollectionFile = ({
-    file_id: string;
-} | {
-    url: string;
-}) & FileSegmentationConfig & Partial<{
-    thumbnails_config: ThumbnailsConfig;
-}>;
-type CollectionFileList = {
-    object: 'list';
-    data: Array<CollectionFile>;
-    total: number;
-    limit: number;
-    offset: number;
-};
 type RichTranscript = {
     collection_id: string;
     file_id: string;
@@ -205,6 +202,13 @@ type MediaDescription = {
         end_time: number;
     }>> | undefined;
 } & DescribeOutput;
+type AddCollectionFile = ({
+    file_id: string;
+} | {
+    url: string;
+}) & FileSegmentationConfig & Partial<{
+    thumbnails_config: ThumbnailsConfig;
+}>;
 declare const Collection: z.ZodType<Collection>;
 declare const DefaultSegmentationConfig: z.ZodType<DefaultSegmentationConfig>;
 declare const NewCollection: z.ZodType<NewCollection>;
@@ -1218,54 +1222,6 @@ export declare const CollectionsApi: import("@zodios/core").ZodiosInstance<[{
             error: z.ZodString;
         }, z.ZodTypeAny, "passthrough">>;
     }];
-}, {
-    method: "post";
-    path: "/collections/:collection_id/videos";
-    alias: "addVideo";
-    description: "Add a video to a collection";
-    requestFormat: "json";
-    parameters: [{
-        name: "body";
-        description: string;
-        type: "Body";
-        schema: z.ZodType<AddCollectionFile, z.ZodTypeDef, AddCollectionFile>;
-    }, {
-        name: "collection_id";
-        type: "Path";
-        schema: z.ZodString;
-    }];
-    response: z.ZodType<CollectionFile, z.ZodTypeDef, CollectionFile>;
-    errors: [{
-        status: 400;
-        description: string;
-        schema: z.ZodObject<{
-            error: z.ZodString;
-        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-            error: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-            error: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">>;
-    }, {
-        status: 404;
-        description: string;
-        schema: z.ZodObject<{
-            error: z.ZodString;
-        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-            error: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-            error: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">>;
-    }, {
-        status: 500;
-        description: string;
-        schema: z.ZodObject<{
-            error: z.ZodString;
-        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-            error: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-            error: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">>;
-    }];
 }, {
     method: "get";
     path: "/collections/:collection_id/videos";
@@ -2590,6 +2546,54 @@ export declare const CollectionsApi: import("@zodios/core").ZodiosInstance<[{
             error: z.ZodString;
         }, z.ZodTypeAny, "passthrough">>;
     }];
+}, {
+    method: "post";
+    path: "/collections/:collection_id/media";
+    alias: "addMedia";
+    description: "Add a video or audio file to a collection. This is the recommended endpoint for adding media files to collections.\n\n**Media Type Handling:**\n\n- **Video files**: Processed with full visual analysis (scene description, text extraction, etc.)\n- **Audio files**: Visual features automatically disabled; only speech and audio analysis available\n\n**Audio File Restrictions:**\n\n- Audio files cannot be added to face-analysis collections\n- Shot-detector segmentation is not available for audio files";
+    requestFormat: "json";
+    parameters: [{
+        name: "body";
+        description: string;
+        type: "Body";
+        schema: z.ZodType<AddCollectionFile, z.ZodTypeDef, AddCollectionFile>;
+    }, {
+        name: "collection_id";
+        type: "Path";
+        schema: z.ZodString;
+    }];
+    response: z.ZodType<CollectionFile, z.ZodTypeDef, CollectionFile>;
+    errors: [{
+        status: 400;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 404;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 500;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }];
 }]>;
 export declare function createApiClient(baseUrl: string, options?: ZodiosOptions): import("@zodios/core").ZodiosInstance<[{
     method: "post";
@@ -2824,54 +2828,6 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
             error: z.ZodString;
         }, z.ZodTypeAny, "passthrough">>;
     }];
-}, {
-    method: "post";
-    path: "/collections/:collection_id/videos";
-    alias: "addVideo";
-    description: "Add a video to a collection";
-    requestFormat: "json";
-    parameters: [{
-        name: "body";
-        description: string;
-        type: "Body";
-        schema: z.ZodType<AddCollectionFile, z.ZodTypeDef, AddCollectionFile>;
-    }, {
-        name: "collection_id";
-        type: "Path";
-        schema: z.ZodString;
-    }];
-    response: z.ZodType<CollectionFile, z.ZodTypeDef, CollectionFile>;
-    errors: [{
-        status: 400;
-        description: string;
-        schema: z.ZodObject<{
-            error: z.ZodString;
-        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-            error: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-            error: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">>;
-    }, {
-        status: 404;
-        description: string;
-        schema: z.ZodObject<{
-            error: z.ZodString;
-        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-            error: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-            error: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">>;
-    }, {
-        status: 500;
-        description: string;
-        schema: z.ZodObject<{
-            error: z.ZodString;
-        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-            error: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-            error: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">>;
-    }];
 }, {
     method: "get";
     path: "/collections/:collection_id/videos";
@@ -4196,5 +4152,53 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
             error: z.ZodString;
         }, z.ZodTypeAny, "passthrough">>;
     }];
+}, {
+    method: "post";
+    path: "/collections/:collection_id/media";
+    alias: "addMedia";
+    description: "Add a video or audio file to a collection. This is the recommended endpoint for adding media files to collections.\n\n**Media Type Handling:**\n\n- **Video files**: Processed with full visual analysis (scene description, text extraction, etc.)\n- **Audio files**: Visual features automatically disabled; only speech and audio analysis available\n\n**Audio File Restrictions:**\n\n- Audio files cannot be added to face-analysis collections\n- Shot-detector segmentation is not available for audio files";
+    requestFormat: "json";
+    parameters: [{
+        name: "body";
+        description: string;
+        type: "Body";
+        schema: z.ZodType<AddCollectionFile, z.ZodTypeDef, AddCollectionFile>;
+    }, {
+        name: "collection_id";
+        type: "Path";
+        schema: z.ZodString;
+    }];
+    response: z.ZodType<CollectionFile, z.ZodTypeDef, CollectionFile>;
+    errors: [{
+        status: 400;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 404;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 500;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }];
 }]>;
 export {};

package/dist/generated/Collections.js

@@ -12,6 +12,7 @@ const common_5 = require("./common");
 const common_6 = require("./common");
 const common_7 = require("./common");
 const common_8 = require("./common");
+const common_9 = require("./common");
 const Collection = zod_1.z
     .object({
     id: zod_1.z.string(),
@@ -30,6 +31,7 @@ const Collection = zod_1.z
         schema: zod_1.z.object({}).partial().strict().passthrough(),
         enable_video_level_entities: zod_1.z.boolean().default(false),
         enable_segment_level_entities: zod_1.z.boolean().default(true),
+        enable_transcript_mode: zod_1.z.boolean().default(false),
     })
         .partial()
         .strict()
@@ -60,7 +62,7 @@ const Collection = zod_1.z
         .passthrough()
         .optional(),
     default_segmentation_config: common_1.SegmentationConfig.optional(),
-    default_thumbnails_config: common_5.ThumbnailsConfig.optional(),
+    default_thumbnails_config: common_6.ThumbnailsConfig.optional(),
     face_detection_config: zod_1.z
         .object({
         frame_extraction_config: zod_1.z
@@ -95,10 +97,11 @@ const Collection = zod_1.z
     .passthrough();
 const DefaultSegmentationConfig = zod_1.z
     .object({
-    strategy: zod_1.z.enum(['uniform', 'shot-detector']),
+    strategy: zod_1.z.enum(['uniform', 'shot-detector', 'narrative']),
     uniform_config: common_2.SegmentationUniformConfig.optional(),
     shot_detector_config: common_3.SegmentationShotDetectorConfig.optional(),
-    keyframe_config: common_4.KeyframeConfig.optional(),
+    narrative_config: common_4.NarrativeConfig.optional(),
+    keyframe_config: common_5.KeyframeConfig.optional(),
     start_time_seconds: zod_1.z.number().gte(0).optional(),
     end_time_seconds: zod_1.z.number().gte(0).optional(),
 })
@@ -132,6 +135,7 @@ const NewCollection = zod_1.z
         schema: zod_1.z.object({}).partial().strict().passthrough(),
         enable_video_level_entities: zod_1.z.boolean().default(false),
         enable_segment_level_entities: zod_1.z.boolean().default(true),
+        enable_transcript_mode: zod_1.z.boolean().default(false),
     })
         .partial()
         .strict()
@@ -150,7 +154,7 @@ const NewCollection = zod_1.z
         .passthrough()
         .optional(),
     default_segmentation_config: DefaultSegmentationConfig.optional(),
-    default_thumbnails_config: common_5.ThumbnailsConfig.optional(),
+    default_thumbnails_config: common_6.ThumbnailsConfig.optional(),
     face_detection_config: zod_1.z
         .object({
         frame_extraction_config: zod_1.z
@@ -196,9 +200,9 @@ const AddCollectionFile = zod_1.z
     zod_1.z.object({ file_id: zod_1.z.string() }).strict().passthrough(),
     zod_1.z.object({ url: zod_1.z.string() }).strict().passthrough(),
 ])
-    .and(common_7.FileSegmentationConfig)
+    .and(common_9.FileSegmentationConfig)
     .and(zod_1.z
-    .object({ thumbnails_config: common_5.ThumbnailsConfig })
+    .object({ thumbnails_config: common_6.ThumbnailsConfig })
     .partial()
     .strict()
     .passthrough());
@@ -215,7 +219,7 @@ const CollectionFile = zod_1.z
         'failed',
         'not_applicable',
     ]),
-    file: common_6.File.optional(),
+    file: common_7.File.optional(),
     segmentation: zod_1.z
         .object({
         id: zod_1.z.string().uuid(),
@@ -673,44 +677,6 @@ const endpoints = (0, core_1.makeApi)([
             },
         ],
     },
-    {
-        method: 'post',
-        path: '/collections/:collection_id/videos',
-        alias: 'addVideo',
-        description: `Add a video to a collection`,
-        requestFormat: 'json',
-        parameters: [
-            {
-                name: 'body',
-                description: `File association parameters`,
-                type: 'Body',
-                schema: AddCollectionFile,
-            },
-            {
-                name: 'collection_id',
-                type: 'Path',
-                schema: zod_1.z.string(),
-            },
-        ],
-        response: CollectionFile,
-        errors: [
-            {
-                status: 400,
-                description: `Invalid request`,
-                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
-            },
-            {
-                status: 404,
-                description: `Collection or file not found`,
-                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
-            },
-            {
-                status: 500,
-                description: `An unexpected error occurred on the server`,
-                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
-            },
-        ],
-    },
     {
         method: 'get',
         path: '/collections/:collection_id/videos',
@@ -1304,6 +1270,54 @@ const endpoints = (0, core_1.makeApi)([
             },
         ],
     },
+    {
+        method: 'post',
+        path: '/collections/:collection_id/media',
+        alias: 'addMedia',
+        description: `Add a video or audio file to a collection. This is the recommended endpoint for adding media files to collections.
+
+**Media Type Handling:**
+
+- **Video files**: Processed with full visual analysis (scene description, text extraction, etc.)
+- **Audio files**: Visual features automatically disabled; only speech and audio analysis available
+
+**Audio File Restrictions:**
+
+- Audio files cannot be added to face-analysis collections
+- Shot-detector segmentation is not available for audio files`,
+        requestFormat: 'json',
+        parameters: [
+            {
+                name: 'body',
+                description: `File association parameters`,
+                type: 'Body',
+                schema: AddCollectionFile,
+            },
+            {
+                name: 'collection_id',
+                type: 'Path',
+                schema: zod_1.z.string(),
+            },
+        ],
+        response: CollectionFile,
+        errors: [
+            {
+                status: 400,
+                description: `Invalid request (e.g., audio files with shot-detector segmentation, audio in face-analysis collections)`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+            {
+                status: 404,
+                description: `Collection or file not found`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+            {
+                status: 500,
+                description: `An unexpected error occurred on the server`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+        ],
+    },
 ]);
 exports.CollectionsApi = new core_1.Zodios('https://api.cloudglue.dev/v1', endpoints);
 function createApiClient(baseUrl, options) {