@aviaryhq/cloudglue-js 0.5.8 → 0.5.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,8 +6,8 @@ import { SegmentationShotDetectorConfig } from './common';
6
6
  import { KeyframeConfig } from './common';
7
7
  import { ThumbnailsConfig } from './common';
8
8
  import { File } from './common';
9
- import { FileSegmentationConfig } from './common';
10
9
  import { DescribeOutput } from './common';
10
+ import { FileSegmentationConfig } from './common';
11
11
  type Collection = {
12
12
  id: string;
13
13
  object: 'collection';
@@ -19,6 +19,7 @@ type Collection = {
19
19
  schema: {};
20
20
  enable_video_level_entities: boolean;
21
21
  enable_segment_level_entities: boolean;
22
+ enable_transcript_mode: boolean;
22
23
  }> | undefined;
23
24
  transcribe_config?: Partial<{
24
25
  enable_summary: boolean;
@@ -67,6 +68,7 @@ type NewCollection = {
67
68
  schema: {};
68
69
  enable_video_level_entities: boolean;
69
70
  enable_segment_level_entities: boolean;
71
+ enable_transcript_mode: boolean;
70
72
  }> | undefined;
71
73
  transcribe_config?: Partial<{
72
74
  enable_summary: boolean;
@@ -105,6 +107,13 @@ type CollectionList = {
105
107
  limit: number;
106
108
  offset: number;
107
109
  };
110
+ type CollectionFileList = {
111
+ object: 'list';
112
+ data: Array<CollectionFile>;
113
+ total: number;
114
+ limit: number;
115
+ offset: number;
116
+ };
108
117
  type CollectionFile = {
109
118
  collection_id: string;
110
119
  file_id: string;
@@ -119,20 +128,6 @@ type CollectionFile = {
119
128
  segmentation_config: SegmentationConfig;
120
129
  } | undefined;
121
130
  };
122
- type AddCollectionFile = ({
123
- file_id: string;
124
- } | {
125
- url: string;
126
- }) & FileSegmentationConfig & Partial<{
127
- thumbnails_config: ThumbnailsConfig;
128
- }>;
129
- type CollectionFileList = {
130
- object: 'list';
131
- data: Array<CollectionFile>;
132
- total: number;
133
- limit: number;
134
- offset: number;
135
- };
136
131
  type RichTranscript = {
137
132
  collection_id: string;
138
133
  file_id: string;
@@ -205,6 +200,13 @@ type MediaDescription = {
205
200
  end_time: number;
206
201
  }>> | undefined;
207
202
  } & DescribeOutput;
203
+ type AddCollectionFile = ({
204
+ file_id: string;
205
+ } | {
206
+ url: string;
207
+ }) & FileSegmentationConfig & Partial<{
208
+ thumbnails_config: ThumbnailsConfig;
209
+ }>;
208
210
  declare const Collection: z.ZodType<Collection>;
209
211
  declare const DefaultSegmentationConfig: z.ZodType<DefaultSegmentationConfig>;
210
212
  declare const NewCollection: z.ZodType<NewCollection>;
@@ -1218,54 +1220,6 @@ export declare const CollectionsApi: import("@zodios/core").ZodiosInstance<[{
1218
1220
  error: z.ZodString;
1219
1221
  }, z.ZodTypeAny, "passthrough">>;
1220
1222
  }];
1221
- }, {
1222
- method: "post";
1223
- path: "/collections/:collection_id/videos";
1224
- alias: "addVideo";
1225
- description: "Add a video to a collection";
1226
- requestFormat: "json";
1227
- parameters: [{
1228
- name: "body";
1229
- description: string;
1230
- type: "Body";
1231
- schema: z.ZodType<AddCollectionFile, z.ZodTypeDef, AddCollectionFile>;
1232
- }, {
1233
- name: "collection_id";
1234
- type: "Path";
1235
- schema: z.ZodString;
1236
- }];
1237
- response: z.ZodType<CollectionFile, z.ZodTypeDef, CollectionFile>;
1238
- errors: [{
1239
- status: 400;
1240
- description: string;
1241
- schema: z.ZodObject<{
1242
- error: z.ZodString;
1243
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
1244
- error: z.ZodString;
1245
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
1246
- error: z.ZodString;
1247
- }, z.ZodTypeAny, "passthrough">>;
1248
- }, {
1249
- status: 404;
1250
- description: string;
1251
- schema: z.ZodObject<{
1252
- error: z.ZodString;
1253
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
1254
- error: z.ZodString;
1255
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
1256
- error: z.ZodString;
1257
- }, z.ZodTypeAny, "passthrough">>;
1258
- }, {
1259
- status: 500;
1260
- description: string;
1261
- schema: z.ZodObject<{
1262
- error: z.ZodString;
1263
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
1264
- error: z.ZodString;
1265
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
1266
- error: z.ZodString;
1267
- }, z.ZodTypeAny, "passthrough">>;
1268
- }];
1269
1223
  }, {
1270
1224
  method: "get";
1271
1225
  path: "/collections/:collection_id/videos";
@@ -2590,6 +2544,54 @@ export declare const CollectionsApi: import("@zodios/core").ZodiosInstance<[{
2590
2544
  error: z.ZodString;
2591
2545
  }, z.ZodTypeAny, "passthrough">>;
2592
2546
  }];
2547
+ }, {
2548
+ method: "post";
2549
+ path: "/collections/:collection_id/media";
2550
+ alias: "addMedia";
2551
+ 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";
2552
+ requestFormat: "json";
2553
+ parameters: [{
2554
+ name: "body";
2555
+ description: string;
2556
+ type: "Body";
2557
+ schema: z.ZodType<AddCollectionFile, z.ZodTypeDef, AddCollectionFile>;
2558
+ }, {
2559
+ name: "collection_id";
2560
+ type: "Path";
2561
+ schema: z.ZodString;
2562
+ }];
2563
+ response: z.ZodType<CollectionFile, z.ZodTypeDef, CollectionFile>;
2564
+ errors: [{
2565
+ status: 400;
2566
+ description: string;
2567
+ schema: z.ZodObject<{
2568
+ error: z.ZodString;
2569
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
2570
+ error: z.ZodString;
2571
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
2572
+ error: z.ZodString;
2573
+ }, z.ZodTypeAny, "passthrough">>;
2574
+ }, {
2575
+ status: 404;
2576
+ description: string;
2577
+ schema: z.ZodObject<{
2578
+ error: z.ZodString;
2579
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
2580
+ error: z.ZodString;
2581
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
2582
+ error: z.ZodString;
2583
+ }, z.ZodTypeAny, "passthrough">>;
2584
+ }, {
2585
+ status: 500;
2586
+ description: string;
2587
+ schema: z.ZodObject<{
2588
+ error: z.ZodString;
2589
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
2590
+ error: z.ZodString;
2591
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
2592
+ error: z.ZodString;
2593
+ }, z.ZodTypeAny, "passthrough">>;
2594
+ }];
2593
2595
  }]>;
2594
2596
  export declare function createApiClient(baseUrl: string, options?: ZodiosOptions): import("@zodios/core").ZodiosInstance<[{
2595
2597
  method: "post";
@@ -2824,54 +2826,6 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
2824
2826
  error: z.ZodString;
2825
2827
  }, z.ZodTypeAny, "passthrough">>;
2826
2828
  }];
2827
- }, {
2828
- method: "post";
2829
- path: "/collections/:collection_id/videos";
2830
- alias: "addVideo";
2831
- description: "Add a video to a collection";
2832
- requestFormat: "json";
2833
- parameters: [{
2834
- name: "body";
2835
- description: string;
2836
- type: "Body";
2837
- schema: z.ZodType<AddCollectionFile, z.ZodTypeDef, AddCollectionFile>;
2838
- }, {
2839
- name: "collection_id";
2840
- type: "Path";
2841
- schema: z.ZodString;
2842
- }];
2843
- response: z.ZodType<CollectionFile, z.ZodTypeDef, CollectionFile>;
2844
- errors: [{
2845
- status: 400;
2846
- description: string;
2847
- schema: z.ZodObject<{
2848
- error: z.ZodString;
2849
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
2850
- error: z.ZodString;
2851
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
2852
- error: z.ZodString;
2853
- }, z.ZodTypeAny, "passthrough">>;
2854
- }, {
2855
- status: 404;
2856
- description: string;
2857
- schema: z.ZodObject<{
2858
- error: z.ZodString;
2859
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
2860
- error: z.ZodString;
2861
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
2862
- error: z.ZodString;
2863
- }, z.ZodTypeAny, "passthrough">>;
2864
- }, {
2865
- status: 500;
2866
- description: string;
2867
- schema: z.ZodObject<{
2868
- error: z.ZodString;
2869
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
2870
- error: z.ZodString;
2871
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
2872
- error: z.ZodString;
2873
- }, z.ZodTypeAny, "passthrough">>;
2874
- }];
2875
2829
  }, {
2876
2830
  method: "get";
2877
2831
  path: "/collections/:collection_id/videos";
@@ -4196,5 +4150,53 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
4196
4150
  error: z.ZodString;
4197
4151
  }, z.ZodTypeAny, "passthrough">>;
4198
4152
  }];
4153
+ }, {
4154
+ method: "post";
4155
+ path: "/collections/:collection_id/media";
4156
+ alias: "addMedia";
4157
+ 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";
4158
+ requestFormat: "json";
4159
+ parameters: [{
4160
+ name: "body";
4161
+ description: string;
4162
+ type: "Body";
4163
+ schema: z.ZodType<AddCollectionFile, z.ZodTypeDef, AddCollectionFile>;
4164
+ }, {
4165
+ name: "collection_id";
4166
+ type: "Path";
4167
+ schema: z.ZodString;
4168
+ }];
4169
+ response: z.ZodType<CollectionFile, z.ZodTypeDef, CollectionFile>;
4170
+ errors: [{
4171
+ status: 400;
4172
+ description: string;
4173
+ schema: z.ZodObject<{
4174
+ error: z.ZodString;
4175
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
4176
+ error: z.ZodString;
4177
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
4178
+ error: z.ZodString;
4179
+ }, z.ZodTypeAny, "passthrough">>;
4180
+ }, {
4181
+ status: 404;
4182
+ description: string;
4183
+ schema: z.ZodObject<{
4184
+ error: z.ZodString;
4185
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
4186
+ error: z.ZodString;
4187
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
4188
+ error: z.ZodString;
4189
+ }, z.ZodTypeAny, "passthrough">>;
4190
+ }, {
4191
+ status: 500;
4192
+ description: string;
4193
+ schema: z.ZodObject<{
4194
+ error: z.ZodString;
4195
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
4196
+ error: z.ZodString;
4197
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
4198
+ error: z.ZodString;
4199
+ }, z.ZodTypeAny, "passthrough">>;
4200
+ }];
4199
4201
  }]>;
4200
4202
  export {};
@@ -30,6 +30,7 @@ const Collection = zod_1.z
30
30
  schema: zod_1.z.object({}).partial().strict().passthrough(),
31
31
  enable_video_level_entities: zod_1.z.boolean().default(false),
32
32
  enable_segment_level_entities: zod_1.z.boolean().default(true),
33
+ enable_transcript_mode: zod_1.z.boolean().default(false),
33
34
  })
34
35
  .partial()
35
36
  .strict()
@@ -132,6 +133,7 @@ const NewCollection = zod_1.z
132
133
  schema: zod_1.z.object({}).partial().strict().passthrough(),
133
134
  enable_video_level_entities: zod_1.z.boolean().default(false),
134
135
  enable_segment_level_entities: zod_1.z.boolean().default(true),
136
+ enable_transcript_mode: zod_1.z.boolean().default(false),
135
137
  })
136
138
  .partial()
137
139
  .strict()
@@ -196,7 +198,7 @@ const AddCollectionFile = zod_1.z
196
198
  zod_1.z.object({ file_id: zod_1.z.string() }).strict().passthrough(),
197
199
  zod_1.z.object({ url: zod_1.z.string() }).strict().passthrough(),
198
200
  ])
199
- .and(common_7.FileSegmentationConfig)
201
+ .and(common_8.FileSegmentationConfig)
200
202
  .and(zod_1.z
201
203
  .object({ thumbnails_config: common_5.ThumbnailsConfig })
202
204
  .partial()
@@ -268,7 +270,7 @@ const MediaDescription = zod_1.z
268
270
  })
269
271
  .strict()
270
272
  .passthrough()
271
- .and(common_8.DescribeOutput);
273
+ .and(common_7.DescribeOutput);
272
274
  const RichTranscript = zod_1.z
273
275
  .object({
274
276
  collection_id: zod_1.z.string(),
@@ -292,7 +294,7 @@ const RichTranscript = zod_1.z
292
294
  })
293
295
  .strict()
294
296
  .passthrough()
295
- .and(common_8.DescribeOutput);
297
+ .and(common_7.DescribeOutput);
296
298
  const CollectionRichTranscriptsList = zod_1.z
297
299
  .object({
298
300
  object: zod_1.z.literal('list'),
@@ -319,7 +321,7 @@ const CollectionRichTranscriptsList = zod_1.z
319
321
  .partial()
320
322
  .strict()
321
323
  .passthrough()
322
- .and(common_8.DescribeOutput),
324
+ .and(common_7.DescribeOutput),
323
325
  })
324
326
  .strict()
325
327
  .passthrough()),
@@ -357,7 +359,7 @@ const CollectionMediaDescriptionsList = zod_1.z
357
359
  .partial()
358
360
  .strict()
359
361
  .passthrough()
360
- .and(common_8.DescribeOutput),
362
+ .and(common_7.DescribeOutput),
361
363
  })
362
364
  .strict()
363
365
  .passthrough()),
@@ -673,44 +675,6 @@ const endpoints = (0, core_1.makeApi)([
673
675
  },
674
676
  ],
675
677
  },
676
- {
677
- method: 'post',
678
- path: '/collections/:collection_id/videos',
679
- alias: 'addVideo',
680
- description: `Add a video to a collection`,
681
- requestFormat: 'json',
682
- parameters: [
683
- {
684
- name: 'body',
685
- description: `File association parameters`,
686
- type: 'Body',
687
- schema: AddCollectionFile,
688
- },
689
- {
690
- name: 'collection_id',
691
- type: 'Path',
692
- schema: zod_1.z.string(),
693
- },
694
- ],
695
- response: CollectionFile,
696
- errors: [
697
- {
698
- status: 400,
699
- description: `Invalid request`,
700
- schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
701
- },
702
- {
703
- status: 404,
704
- description: `Collection or file not found`,
705
- schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
706
- },
707
- {
708
- status: 500,
709
- description: `An unexpected error occurred on the server`,
710
- schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
711
- },
712
- ],
713
- },
714
678
  {
715
679
  method: 'get',
716
680
  path: '/collections/:collection_id/videos',
@@ -1304,6 +1268,54 @@ const endpoints = (0, core_1.makeApi)([
1304
1268
  },
1305
1269
  ],
1306
1270
  },
1271
+ {
1272
+ method: 'post',
1273
+ path: '/collections/:collection_id/media',
1274
+ alias: 'addMedia',
1275
+ description: `Add a video or audio file to a collection. This is the recommended endpoint for adding media files to collections.
1276
+
1277
+ **Media Type Handling:**
1278
+
1279
+ - **Video files**: Processed with full visual analysis (scene description, text extraction, etc.)
1280
+ - **Audio files**: Visual features automatically disabled; only speech and audio analysis available
1281
+
1282
+ **Audio File Restrictions:**
1283
+
1284
+ - Audio files cannot be added to face-analysis collections
1285
+ - Shot-detector segmentation is not available for audio files`,
1286
+ requestFormat: 'json',
1287
+ parameters: [
1288
+ {
1289
+ name: 'body',
1290
+ description: `File association parameters`,
1291
+ type: 'Body',
1292
+ schema: AddCollectionFile,
1293
+ },
1294
+ {
1295
+ name: 'collection_id',
1296
+ type: 'Path',
1297
+ schema: zod_1.z.string(),
1298
+ },
1299
+ ],
1300
+ response: CollectionFile,
1301
+ errors: [
1302
+ {
1303
+ status: 400,
1304
+ description: `Invalid request (e.g., audio files with shot-detector segmentation, audio in face-analysis collections)`,
1305
+ schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
1306
+ },
1307
+ {
1308
+ status: 404,
1309
+ description: `Collection or file not found`,
1310
+ schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
1311
+ },
1312
+ {
1313
+ status: 500,
1314
+ description: `An unexpected error occurred on the server`,
1315
+ schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
1316
+ },
1317
+ ],
1318
+ },
1307
1319
  ]);
1308
1320
  exports.CollectionsApi = new core_1.Zodios('https://api.cloudglue.dev/v1', endpoints);
1309
1321
  function createApiClient(baseUrl, options) {
@@ -12,6 +12,7 @@ type Extract = {
12
12
  schema: {};
13
13
  enable_video_level_entities: boolean;
14
14
  enable_segment_level_entities: boolean;
15
+ enable_transcript_mode: boolean;
15
16
  }> | undefined;
16
17
  segmentation_id?: string | undefined;
17
18
  data?: Partial<{
@@ -33,6 +34,7 @@ type NewExtract = {
33
34
  schema?: {} | undefined;
34
35
  enable_video_level_entities?: boolean | undefined;
35
36
  enable_segment_level_entities?: boolean | undefined;
37
+ enable_transcript_mode?: boolean | undefined;
36
38
  thumbnails_config?: ThumbnailsConfig | undefined;
37
39
  } & FileSegmentationConfig;
38
40
  type ExtractList = {
@@ -24,6 +24,7 @@ const Extract = zod_1.z
24
24
  schema: zod_1.z.object({}).partial().strict().passthrough(),
25
25
  enable_video_level_entities: zod_1.z.boolean().default(false),
26
26
  enable_segment_level_entities: zod_1.z.boolean().default(true),
27
+ enable_transcript_mode: zod_1.z.boolean().default(false),
27
28
  })
28
29
  .partial()
29
30
  .strict()
@@ -71,6 +72,7 @@ const NewExtract = zod_1.z
71
72
  schema: zod_1.z.object({}).partial().strict().passthrough().optional(),
72
73
  enable_video_level_entities: zod_1.z.boolean().optional().default(false),
73
74
  enable_segment_level_entities: zod_1.z.boolean().optional().default(true),
75
+ enable_transcript_mode: zod_1.z.boolean().optional().default(false),
74
76
  thumbnails_config: common_1.ThumbnailsConfig.optional(),
75
77
  })
76
78
  .strict()