@aviaryhq/cloudglue-js 0.5.7 → 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.
- package/dist/generated/Collections.d.ts +145 -111
- package/dist/generated/Collections.js +115 -43
- package/dist/generated/Describe.d.ts +16 -0
- package/dist/generated/Describe.js +30 -0
- package/dist/generated/Extract.d.ts +2 -0
- package/dist/generated/Extract.js +2 -0
- package/dist/generated/Files.d.ts +540 -18
- package/dist/generated/Segments.d.ts +2 -2
- package/dist/generated/Segments.js +11 -6
- package/dist/generated/common.d.ts +102 -4
- package/dist/generated/common.js +17 -0
- package/dist/src/api/collections.api.d.ts +47 -12
- package/dist/src/api/collections.api.js +16 -3
- package/dist/src/api/describe.api.d.ts +3 -1
- package/dist/src/api/extract.api.d.ts +11 -14
- package/dist/src/api/files.api.d.ts +90 -3
- package/dist/src/client.js +1 -1
- package/dist/src/types.d.ts +1 -0
- package/package.json +1 -1
|
@@ -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";
|
|
@@ -1558,6 +1512,10 @@ export declare const CollectionsApi: import("@zodios/core").ZodiosInstance<[{
|
|
|
1558
1512
|
name: "end_time_seconds";
|
|
1559
1513
|
type: "Query";
|
|
1560
1514
|
schema: z.ZodOptional<z.ZodNumber>;
|
|
1515
|
+
}, {
|
|
1516
|
+
name: "modalities";
|
|
1517
|
+
type: "Query";
|
|
1518
|
+
schema: z.ZodOptional<z.ZodArray<z.ZodEnum<["speech", "visual_scene_description", "scene_text", "audio_description", "summary", "segment_summary", "title"]>, "many">>;
|
|
1561
1519
|
}];
|
|
1562
1520
|
response: z.ZodType<RichTranscript, z.ZodTypeDef, RichTranscript>;
|
|
1563
1521
|
errors: [{
|
|
@@ -2146,6 +2104,10 @@ export declare const CollectionsApi: import("@zodios/core").ZodiosInstance<[{
|
|
|
2146
2104
|
name: "response_format";
|
|
2147
2105
|
type: "Query";
|
|
2148
2106
|
schema: z.ZodDefault<z.ZodOptional<z.ZodEnum<["json", "markdown"]>>>;
|
|
2107
|
+
}, {
|
|
2108
|
+
name: "modalities";
|
|
2109
|
+
type: "Query";
|
|
2110
|
+
schema: z.ZodOptional<z.ZodArray<z.ZodEnum<["speech", "visual_scene_description", "scene_text", "audio_description", "summary", "segment_summary", "title"]>, "many">>;
|
|
2149
2111
|
}];
|
|
2150
2112
|
response: z.ZodType<CollectionRichTranscriptsList, z.ZodTypeDef, CollectionRichTranscriptsList>;
|
|
2151
2113
|
errors: [{
|
|
@@ -2217,6 +2179,10 @@ export declare const CollectionsApi: import("@zodios/core").ZodiosInstance<[{
|
|
|
2217
2179
|
name: "response_format";
|
|
2218
2180
|
type: "Query";
|
|
2219
2181
|
schema: z.ZodDefault<z.ZodOptional<z.ZodEnum<["json", "markdown"]>>>;
|
|
2182
|
+
}, {
|
|
2183
|
+
name: "modalities";
|
|
2184
|
+
type: "Query";
|
|
2185
|
+
schema: z.ZodOptional<z.ZodArray<z.ZodEnum<["speech", "visual_scene_description", "scene_text", "audio_description", "summary", "segment_summary", "title"]>, "many">>;
|
|
2220
2186
|
}];
|
|
2221
2187
|
response: z.ZodType<CollectionMediaDescriptionsList, z.ZodTypeDef, CollectionMediaDescriptionsList>;
|
|
2222
2188
|
errors: [{
|
|
@@ -2276,6 +2242,10 @@ export declare const CollectionsApi: import("@zodios/core").ZodiosInstance<[{
|
|
|
2276
2242
|
name: "end_time_seconds";
|
|
2277
2243
|
type: "Query";
|
|
2278
2244
|
schema: z.ZodOptional<z.ZodNumber>;
|
|
2245
|
+
}, {
|
|
2246
|
+
name: "modalities";
|
|
2247
|
+
type: "Query";
|
|
2248
|
+
schema: z.ZodOptional<z.ZodArray<z.ZodEnum<["speech", "visual_scene_description", "scene_text", "audio_description", "summary", "segment_summary", "title"]>, "many">>;
|
|
2279
2249
|
}];
|
|
2280
2250
|
response: z.ZodType<MediaDescription, z.ZodTypeDef, MediaDescription>;
|
|
2281
2251
|
errors: [{
|
|
@@ -2574,6 +2544,54 @@ export declare const CollectionsApi: import("@zodios/core").ZodiosInstance<[{
|
|
|
2574
2544
|
error: z.ZodString;
|
|
2575
2545
|
}, z.ZodTypeAny, "passthrough">>;
|
|
2576
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
|
+
}];
|
|
2577
2595
|
}]>;
|
|
2578
2596
|
export declare function createApiClient(baseUrl: string, options?: ZodiosOptions): import("@zodios/core").ZodiosInstance<[{
|
|
2579
2597
|
method: "post";
|
|
@@ -2808,54 +2826,6 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
|
|
|
2808
2826
|
error: z.ZodString;
|
|
2809
2827
|
}, z.ZodTypeAny, "passthrough">>;
|
|
2810
2828
|
}];
|
|
2811
|
-
}, {
|
|
2812
|
-
method: "post";
|
|
2813
|
-
path: "/collections/:collection_id/videos";
|
|
2814
|
-
alias: "addVideo";
|
|
2815
|
-
description: "Add a video to a collection";
|
|
2816
|
-
requestFormat: "json";
|
|
2817
|
-
parameters: [{
|
|
2818
|
-
name: "body";
|
|
2819
|
-
description: string;
|
|
2820
|
-
type: "Body";
|
|
2821
|
-
schema: z.ZodType<AddCollectionFile, z.ZodTypeDef, AddCollectionFile>;
|
|
2822
|
-
}, {
|
|
2823
|
-
name: "collection_id";
|
|
2824
|
-
type: "Path";
|
|
2825
|
-
schema: z.ZodString;
|
|
2826
|
-
}];
|
|
2827
|
-
response: z.ZodType<CollectionFile, z.ZodTypeDef, CollectionFile>;
|
|
2828
|
-
errors: [{
|
|
2829
|
-
status: 400;
|
|
2830
|
-
description: string;
|
|
2831
|
-
schema: z.ZodObject<{
|
|
2832
|
-
error: z.ZodString;
|
|
2833
|
-
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2834
|
-
error: z.ZodString;
|
|
2835
|
-
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2836
|
-
error: z.ZodString;
|
|
2837
|
-
}, z.ZodTypeAny, "passthrough">>;
|
|
2838
|
-
}, {
|
|
2839
|
-
status: 404;
|
|
2840
|
-
description: string;
|
|
2841
|
-
schema: z.ZodObject<{
|
|
2842
|
-
error: z.ZodString;
|
|
2843
|
-
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2844
|
-
error: z.ZodString;
|
|
2845
|
-
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2846
|
-
error: z.ZodString;
|
|
2847
|
-
}, z.ZodTypeAny, "passthrough">>;
|
|
2848
|
-
}, {
|
|
2849
|
-
status: 500;
|
|
2850
|
-
description: string;
|
|
2851
|
-
schema: z.ZodObject<{
|
|
2852
|
-
error: z.ZodString;
|
|
2853
|
-
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2854
|
-
error: z.ZodString;
|
|
2855
|
-
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2856
|
-
error: z.ZodString;
|
|
2857
|
-
}, z.ZodTypeAny, "passthrough">>;
|
|
2858
|
-
}];
|
|
2859
2829
|
}, {
|
|
2860
2830
|
method: "get";
|
|
2861
2831
|
path: "/collections/:collection_id/videos";
|
|
@@ -3148,6 +3118,10 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
|
|
|
3148
3118
|
name: "end_time_seconds";
|
|
3149
3119
|
type: "Query";
|
|
3150
3120
|
schema: z.ZodOptional<z.ZodNumber>;
|
|
3121
|
+
}, {
|
|
3122
|
+
name: "modalities";
|
|
3123
|
+
type: "Query";
|
|
3124
|
+
schema: z.ZodOptional<z.ZodArray<z.ZodEnum<["speech", "visual_scene_description", "scene_text", "audio_description", "summary", "segment_summary", "title"]>, "many">>;
|
|
3151
3125
|
}];
|
|
3152
3126
|
response: z.ZodType<RichTranscript, z.ZodTypeDef, RichTranscript>;
|
|
3153
3127
|
errors: [{
|
|
@@ -3736,6 +3710,10 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
|
|
|
3736
3710
|
name: "response_format";
|
|
3737
3711
|
type: "Query";
|
|
3738
3712
|
schema: z.ZodDefault<z.ZodOptional<z.ZodEnum<["json", "markdown"]>>>;
|
|
3713
|
+
}, {
|
|
3714
|
+
name: "modalities";
|
|
3715
|
+
type: "Query";
|
|
3716
|
+
schema: z.ZodOptional<z.ZodArray<z.ZodEnum<["speech", "visual_scene_description", "scene_text", "audio_description", "summary", "segment_summary", "title"]>, "many">>;
|
|
3739
3717
|
}];
|
|
3740
3718
|
response: z.ZodType<CollectionRichTranscriptsList, z.ZodTypeDef, CollectionRichTranscriptsList>;
|
|
3741
3719
|
errors: [{
|
|
@@ -3807,6 +3785,10 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
|
|
|
3807
3785
|
name: "response_format";
|
|
3808
3786
|
type: "Query";
|
|
3809
3787
|
schema: z.ZodDefault<z.ZodOptional<z.ZodEnum<["json", "markdown"]>>>;
|
|
3788
|
+
}, {
|
|
3789
|
+
name: "modalities";
|
|
3790
|
+
type: "Query";
|
|
3791
|
+
schema: z.ZodOptional<z.ZodArray<z.ZodEnum<["speech", "visual_scene_description", "scene_text", "audio_description", "summary", "segment_summary", "title"]>, "many">>;
|
|
3810
3792
|
}];
|
|
3811
3793
|
response: z.ZodType<CollectionMediaDescriptionsList, z.ZodTypeDef, CollectionMediaDescriptionsList>;
|
|
3812
3794
|
errors: [{
|
|
@@ -3866,6 +3848,10 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
|
|
|
3866
3848
|
name: "end_time_seconds";
|
|
3867
3849
|
type: "Query";
|
|
3868
3850
|
schema: z.ZodOptional<z.ZodNumber>;
|
|
3851
|
+
}, {
|
|
3852
|
+
name: "modalities";
|
|
3853
|
+
type: "Query";
|
|
3854
|
+
schema: z.ZodOptional<z.ZodArray<z.ZodEnum<["speech", "visual_scene_description", "scene_text", "audio_description", "summary", "segment_summary", "title"]>, "many">>;
|
|
3869
3855
|
}];
|
|
3870
3856
|
response: z.ZodType<MediaDescription, z.ZodTypeDef, MediaDescription>;
|
|
3871
3857
|
errors: [{
|
|
@@ -4164,5 +4150,53 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
|
|
|
4164
4150
|
error: z.ZodString;
|
|
4165
4151
|
}, z.ZodTypeAny, "passthrough">>;
|
|
4166
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
|
+
}];
|
|
4167
4201
|
}]>;
|
|
4168
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(
|
|
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(
|
|
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(
|
|
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(
|
|
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(
|
|
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',
|
|
@@ -929,6 +893,21 @@ const endpoints = (0, core_1.makeApi)([
|
|
|
929
893
|
type: 'Query',
|
|
930
894
|
schema: zod_1.z.number().optional(),
|
|
931
895
|
},
|
|
896
|
+
{
|
|
897
|
+
name: 'modalities',
|
|
898
|
+
type: 'Query',
|
|
899
|
+
schema: zod_1.z
|
|
900
|
+
.array(zod_1.z.enum([
|
|
901
|
+
'speech',
|
|
902
|
+
'visual_scene_description',
|
|
903
|
+
'scene_text',
|
|
904
|
+
'audio_description',
|
|
905
|
+
'summary',
|
|
906
|
+
'segment_summary',
|
|
907
|
+
'title',
|
|
908
|
+
]))
|
|
909
|
+
.optional(),
|
|
910
|
+
},
|
|
932
911
|
],
|
|
933
912
|
response: RichTranscript,
|
|
934
913
|
errors: [
|
|
@@ -1058,6 +1037,21 @@ const endpoints = (0, core_1.makeApi)([
|
|
|
1058
1037
|
type: 'Query',
|
|
1059
1038
|
schema: zod_1.z.enum(['json', 'markdown']).optional().default('json'),
|
|
1060
1039
|
},
|
|
1040
|
+
{
|
|
1041
|
+
name: 'modalities',
|
|
1042
|
+
type: 'Query',
|
|
1043
|
+
schema: zod_1.z
|
|
1044
|
+
.array(zod_1.z.enum([
|
|
1045
|
+
'speech',
|
|
1046
|
+
'visual_scene_description',
|
|
1047
|
+
'scene_text',
|
|
1048
|
+
'audio_description',
|
|
1049
|
+
'summary',
|
|
1050
|
+
'segment_summary',
|
|
1051
|
+
'title',
|
|
1052
|
+
]))
|
|
1053
|
+
.optional(),
|
|
1054
|
+
},
|
|
1061
1055
|
],
|
|
1062
1056
|
response: CollectionRichTranscriptsList,
|
|
1063
1057
|
errors: [
|
|
@@ -1125,6 +1119,21 @@ const endpoints = (0, core_1.makeApi)([
|
|
|
1125
1119
|
type: 'Query',
|
|
1126
1120
|
schema: zod_1.z.enum(['json', 'markdown']).optional().default('json'),
|
|
1127
1121
|
},
|
|
1122
|
+
{
|
|
1123
|
+
name: 'modalities',
|
|
1124
|
+
type: 'Query',
|
|
1125
|
+
schema: zod_1.z
|
|
1126
|
+
.array(zod_1.z.enum([
|
|
1127
|
+
'speech',
|
|
1128
|
+
'visual_scene_description',
|
|
1129
|
+
'scene_text',
|
|
1130
|
+
'audio_description',
|
|
1131
|
+
'summary',
|
|
1132
|
+
'segment_summary',
|
|
1133
|
+
'title',
|
|
1134
|
+
]))
|
|
1135
|
+
.optional(),
|
|
1136
|
+
},
|
|
1128
1137
|
],
|
|
1129
1138
|
response: CollectionMediaDescriptionsList,
|
|
1130
1139
|
errors: [
|
|
@@ -1177,6 +1186,21 @@ const endpoints = (0, core_1.makeApi)([
|
|
|
1177
1186
|
type: 'Query',
|
|
1178
1187
|
schema: zod_1.z.number().optional(),
|
|
1179
1188
|
},
|
|
1189
|
+
{
|
|
1190
|
+
name: 'modalities',
|
|
1191
|
+
type: 'Query',
|
|
1192
|
+
schema: zod_1.z
|
|
1193
|
+
.array(zod_1.z.enum([
|
|
1194
|
+
'speech',
|
|
1195
|
+
'visual_scene_description',
|
|
1196
|
+
'scene_text',
|
|
1197
|
+
'audio_description',
|
|
1198
|
+
'summary',
|
|
1199
|
+
'segment_summary',
|
|
1200
|
+
'title',
|
|
1201
|
+
]))
|
|
1202
|
+
.optional(),
|
|
1203
|
+
},
|
|
1180
1204
|
],
|
|
1181
1205
|
response: MediaDescription,
|
|
1182
1206
|
errors: [
|
|
@@ -1244,6 +1268,54 @@ const endpoints = (0, core_1.makeApi)([
|
|
|
1244
1268
|
},
|
|
1245
1269
|
],
|
|
1246
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
|
+
},
|
|
1247
1319
|
]);
|
|
1248
1320
|
exports.CollectionsApi = new core_1.Zodios('https://api.cloudglue.dev/v1', endpoints);
|
|
1249
1321
|
function createApiClient(baseUrl, options) {
|
|
@@ -144,6 +144,10 @@ export declare const DescribeApi: import("@zodios/core").ZodiosInstance<[{
|
|
|
144
144
|
name: "include_data";
|
|
145
145
|
type: "Query";
|
|
146
146
|
schema: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
147
|
+
}, {
|
|
148
|
+
name: "modalities";
|
|
149
|
+
type: "Query";
|
|
150
|
+
schema: z.ZodOptional<z.ZodArray<z.ZodEnum<["speech", "visual_scene_description", "scene_text", "audio_description", "summary", "segment_summary", "title"]>, "many">>;
|
|
147
151
|
}];
|
|
148
152
|
response: z.ZodType<DescribeList, z.ZodTypeDef, DescribeList>;
|
|
149
153
|
errors: [{
|
|
@@ -189,6 +193,10 @@ export declare const DescribeApi: import("@zodios/core").ZodiosInstance<[{
|
|
|
189
193
|
name: "end_time_seconds";
|
|
190
194
|
type: "Query";
|
|
191
195
|
schema: z.ZodOptional<z.ZodNumber>;
|
|
196
|
+
}, {
|
|
197
|
+
name: "modalities";
|
|
198
|
+
type: "Query";
|
|
199
|
+
schema: z.ZodOptional<z.ZodArray<z.ZodEnum<["speech", "visual_scene_description", "scene_text", "audio_description", "summary", "segment_summary", "title"]>, "many">>;
|
|
192
200
|
}];
|
|
193
201
|
response: z.ZodType<Describe, z.ZodTypeDef, Describe>;
|
|
194
202
|
errors: [{
|
|
@@ -344,6 +352,10 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
|
|
|
344
352
|
name: "include_data";
|
|
345
353
|
type: "Query";
|
|
346
354
|
schema: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
355
|
+
}, {
|
|
356
|
+
name: "modalities";
|
|
357
|
+
type: "Query";
|
|
358
|
+
schema: z.ZodOptional<z.ZodArray<z.ZodEnum<["speech", "visual_scene_description", "scene_text", "audio_description", "summary", "segment_summary", "title"]>, "many">>;
|
|
347
359
|
}];
|
|
348
360
|
response: z.ZodType<DescribeList, z.ZodTypeDef, DescribeList>;
|
|
349
361
|
errors: [{
|
|
@@ -389,6 +401,10 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
|
|
|
389
401
|
name: "end_time_seconds";
|
|
390
402
|
type: "Query";
|
|
391
403
|
schema: z.ZodOptional<z.ZodNumber>;
|
|
404
|
+
}, {
|
|
405
|
+
name: "modalities";
|
|
406
|
+
type: "Query";
|
|
407
|
+
schema: z.ZodOptional<z.ZodArray<z.ZodEnum<["speech", "visual_scene_description", "scene_text", "audio_description", "summary", "segment_summary", "title"]>, "many">>;
|
|
392
408
|
}];
|
|
393
409
|
response: z.ZodType<Describe, z.ZodTypeDef, Describe>;
|
|
394
410
|
errors: [{
|