@aviaryhq/cloudglue-js 0.4.0 → 0.4.2

package/dist/generated/Collections.js

@@ -19,6 +19,7 @@ const Collection = zod_1.z
         "media-descriptions",
         "entities",
         "rich-transcripts",
+        "face-analysis",
     ]),
     extract_config: zod_1.z
         .object({
@@ -57,6 +58,33 @@ const Collection = zod_1.z
         .optional(),
     default_segmentation_config: common_1.SegmentationConfig.optional(),
     default_thumbnails_config: common_2.ThumbnailsConfig.optional(),
+    face_detection_config: zod_1.z
+        .object({
+        frame_extraction_config: zod_1.z
+            .object({
+            strategy: zod_1.z.literal("uniform"),
+            uniform_config: zod_1.z
+                .object({
+                frames_per_second: zod_1.z.number().gte(0.1).lte(30).default(1),
+                max_width: zod_1.z.number().gte(64).lte(4096).default(1024),
+            })
+                .partial()
+                .strict()
+                .passthrough()
+                .optional(),
+        })
+            .strict()
+            .passthrough(),
+        thumbnails_config: zod_1.z
+            .object({ enable_frame_thumbnails: zod_1.z.boolean().default(true) })
+            .partial()
+            .strict()
+            .passthrough(),
+    })
+        .partial()
+        .strict()
+        .passthrough()
+        .nullish(),
     created_at: zod_1.z.number().int(),
     file_count: zod_1.z.number().int(),
 })
@@ -68,6 +96,7 @@ const NewCollection = zod_1.z
         "media-descriptions",
         "entities",
         "rich-transcripts",
+        "face-analysis",
     ]),
     name: zod_1.z.string(),
     description: zod_1.z.string().nullish(),
@@ -108,6 +137,33 @@ const NewCollection = zod_1.z
         .optional(),
     default_segmentation_config: common_1.SegmentationConfig.optional(),
     default_thumbnails_config: common_2.ThumbnailsConfig.optional(),
+    face_detection_config: zod_1.z
+        .object({
+        frame_extraction_config: zod_1.z
+            .object({
+            strategy: zod_1.z.literal("uniform"),
+            uniform_config: zod_1.z
+                .object({
+                frames_per_second: zod_1.z.number().gte(0.1).lte(30).default(1),
+                max_width: zod_1.z.number().gte(64).lte(4096).default(1024),
+            })
+                .partial()
+                .strict()
+                .passthrough()
+                .optional(),
+        })
+            .strict()
+            .passthrough(),
+        thumbnails_config: zod_1.z
+            .object({ enable_frame_thumbnails: zod_1.z.boolean().default(true) })
+            .partial()
+            .strict()
+            .passthrough(),
+    })
+        .partial()
+        .strict()
+        .passthrough()
+        .optional(),
 })
     .strict()
     .passthrough();
@@ -366,6 +422,34 @@ const CollectionEntitiesList = zod_1.z
 })
     .strict()
     .passthrough();
+const FileFaceDetections = zod_1.z
+    .object({
+    collection_id: zod_1.z.string(),
+    file_id: zod_1.z.string(),
+    faces: zod_1.z.array(zod_1.z
+        .object({
+        id: zod_1.z.string().uuid(),
+        face_bounding_box: zod_1.z
+            .object({
+            height: zod_1.z.number().gte(0).lte(1),
+            width: zod_1.z.number().gte(0).lte(1),
+            top: zod_1.z.number().gte(0).lte(1),
+            left: zod_1.z.number().gte(0).lte(1),
+        })
+            .strict()
+            .passthrough(),
+        frame_id: zod_1.z.string().uuid(),
+        timestamp: zod_1.z.number().gte(0),
+        thumbnail_url: zod_1.z.string().optional(),
+    })
+        .strict()
+        .passthrough()),
+    total: zod_1.z.number().int(),
+    limit: zod_1.z.number().int(),
+    offset: zod_1.z.number().int(),
+})
+    .strict()
+    .passthrough();
 exports.schemas = {
     Collection,
     NewCollection,
@@ -382,6 +466,7 @@ exports.schemas = {
     CollectionFileDelete,
     FileEntities,
     CollectionEntitiesList,
+    FileFaceDetections,
 };
 const endpoints = (0, core_1.makeApi)([
     {
@@ -453,9 +538,24 @@ const endpoints = (0, core_1.makeApi)([
                 name: "collection_type",
                 type: "Query",
                 schema: zod_1.z
-                    .enum(["media-descriptions", "entities", "rich-transcripts"])
+                    .enum([
+                    "media-descriptions",
+                    "entities",
+                    "rich-transcripts",
+                    "face-analysis",
+                ])
                     .optional(),
             },
+            {
+                name: "created_after",
+                type: "Query",
+                schema: zod_1.z.string().datetime({ offset: true }).optional(),
+            },
+            {
+                name: "created_before",
+                type: "Query",
+                schema: zod_1.z.string().datetime({ offset: true }).optional(),
+            },
         ],
         response: CollectionList,
         errors: [
@@ -1082,6 +1182,53 @@ const endpoints = (0, core_1.makeApi)([
             },
         ],
     },
+    {
+        method: "get",
+        path: "/collections/:collection_id/videos/:file_id/face-detections",
+        alias: "getFaceDetections",
+        description: `Retrieve face detections for a specific file in a collection. Results are paginated with a default limit of 50 faces per request (maximum 100). Use limit and offset parameters to paginate through all results. This API is only available when the collection is created with collection_type 'face-analysis'`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "collection_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+            {
+                name: "file_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+            {
+                name: "limit",
+                type: "Query",
+                schema: zod_1.z.number().int().gte(1).lte(100).optional().default(50),
+            },
+            {
+                name: "offset",
+                type: "Query",
+                schema: zod_1.z.number().int().gte(0).optional().default(0),
+            },
+        ],
+        response: FileFaceDetections,
+        errors: [
+            {
+                status: 400,
+                description: `Collection type is not 'face-analysis'`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+            {
+                status: 404,
+                description: `Collection, file, or face detection job 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) {

package/dist/generated/Search.d.ts

@@ -3,19 +3,13 @@ import { z } from "zod";
 type SearchResponse = {
     id: string;
     object: "search";
-    query: string;
-    scope: "file" | "segment";
-    results: Array<FileSearchResult | SegmentSearchResult>;
+    query?: string | undefined;
+    scope: "file" | "segment" | "face";
+    search_target?: ("file" | "segment") | undefined;
+    results: Array<FileSearchResult | SegmentSearchResult | FaceSearchResult>;
     total: number;
     limit: number;
 };
-type SearchRequest = {
-    scope: "file" | "segment";
-    collections: Array<string>;
-    query: string;
-    limit?: number | undefined;
-    filter?: SearchFilter | undefined;
-};
 type FileSearchResult = {
     type: "file";
     file_id: string;
@@ -56,6 +50,22 @@ type SegmentSearchResult = {
     }>> | undefined;
     thumbnail_url?: string | undefined;
 };
+type FaceSearchResult = {
+    type: "face";
+    file_id: string;
+    collection_id: string;
+    face_id: string;
+    frame_id: string;
+    score: number;
+    timestamp: number;
+    face_bounding_box?: {
+        height: number;
+        width: number;
+        top: number;
+        left: number;
+    } | undefined;
+    thumbnail_url?: string | undefined;
+};
 type SearchFilter = Partial<{
     metadata: Array<SearchFilterCriteria>;
     video_info: Array<SearchFilterCriteria & Partial<{
@@ -73,9 +83,9 @@ type SearchFilterCriteria = {
 };
 declare const SearchFilterCriteria: z.ZodType<SearchFilterCriteria>;
 declare const SearchFilter: z.ZodType<SearchFilter>;
-declare const SearchRequest: z.ZodType<SearchRequest>;
 declare const FileSearchResult: z.ZodType<FileSearchResult>;
 declare const SegmentSearchResult: z.ZodType<SegmentSearchResult>;
+declare const FaceSearchResult: z.ZodType<FaceSearchResult>;
 declare const SearchResponse: z.ZodType<SearchResponse>;
 export declare const schemas: {
     SearchFilterCriteria: z.ZodType<SearchFilterCriteria, z.ZodTypeDef, SearchFilterCriteria>;
@@ -96,9 +106,30 @@ export declare const schemas: {
             path: "bytes" | "filename" | "uri" | "created_at" | "id";
         }>>;
     }>>;
-    SearchRequest: z.ZodType<SearchRequest, z.ZodTypeDef, SearchRequest>;
+    SearchRequest: z.ZodType<Partial<{
+        scope: "file" | "segment" | "face";
+        collections: Array<string>;
+        query: string;
+        source_image: Partial<{
+            url: string;
+            base64: string;
+        }>;
+        limit: number;
+        filter: SearchFilter;
+    }>, z.ZodTypeDef, Partial<{
+        scope: "file" | "segment" | "face";
+        collections: Array<string>;
+        query: string;
+        source_image: Partial<{
+            url: string;
+            base64: string;
+        }>;
+        limit: number;
+        filter: SearchFilter;
+    }>>;
     FileSearchResult: z.ZodType<FileSearchResult, z.ZodTypeDef, FileSearchResult>;
     SegmentSearchResult: z.ZodType<SegmentSearchResult, z.ZodTypeDef, SegmentSearchResult>;
+    FaceSearchResult: z.ZodType<FaceSearchResult, z.ZodTypeDef, FaceSearchResult>;
     SearchResponse: z.ZodType<SearchResponse, z.ZodTypeDef, SearchResponse>;
 };
 export declare const SearchApi: import("@zodios/core").ZodiosInstance<[{
@@ -111,7 +142,27 @@ export declare const SearchApi: import("@zodios/core").ZodiosInstance<[{
         name: "body";
         description: string;
         type: "Body";
-        schema: z.ZodType<SearchRequest, z.ZodTypeDef, SearchRequest>;
+        schema: z.ZodType<Partial<{
+            scope: "file" | "segment" | "face";
+            collections: Array<string>;
+            query: string;
+            source_image: Partial<{
+                url: string;
+                base64: string;
+            }>;
+            limit: number;
+            filter: SearchFilter;
+        }>, z.ZodTypeDef, Partial<{
+            scope: "file" | "segment" | "face";
+            collections: Array<string>;
+            query: string;
+            source_image: Partial<{
+                url: string;
+                base64: string;
+            }>;
+            limit: number;
+            filter: SearchFilter;
+        }>>;
     }];
     response: z.ZodType<SearchResponse, z.ZodTypeDef, SearchResponse>;
     errors: [{
@@ -156,7 +207,27 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
         name: "body";
         description: string;
         type: "Body";
-        schema: z.ZodType<SearchRequest, z.ZodTypeDef, SearchRequest>;
+        schema: z.ZodType<Partial<{
+            scope: "file" | "segment" | "face";
+            collections: Array<string>;
+            query: string;
+            source_image: Partial<{
+                url: string;
+                base64: string;
+            }>;
+            limit: number;
+            filter: SearchFilter;
+        }>, z.ZodTypeDef, Partial<{
+            scope: "file" | "segment" | "face";
+            collections: Array<string>;
+            query: string;
+            source_image: Partial<{
+                url: string;
+                base64: string;
+            }>;
+            limit: number;
+            filter: SearchFilter;
+        }>>;
     }];
     response: z.ZodType<SearchResponse, z.ZodTypeDef, SearchResponse>;
     errors: [{

package/dist/generated/Search.js

@@ -43,12 +43,18 @@ const SearchFilter = zod_1.z
     .passthrough();
 const SearchRequest = zod_1.z
     .object({
-    scope: zod_1.z.enum(["file", "segment"]),
+    scope: zod_1.z.enum(["file", "segment", "face"]),
     collections: zod_1.z.array(zod_1.z.string().uuid()).min(1),
     query: zod_1.z.string().min(1),
-    limit: zod_1.z.number().int().gte(1).lte(100).optional().default(10),
-    filter: SearchFilter.optional(),
+    source_image: zod_1.z
+        .object({ url: zod_1.z.string(), base64: zod_1.z.string() })
+        .partial()
+        .strict()
+        .passthrough(),
+    limit: zod_1.z.number().int().gte(1).lte(100).default(10),
+    filter: SearchFilter,
 })
+    .partial()
     .strict()
     .passthrough();
 const FileSearchResult = zod_1.z
@@ -115,13 +121,37 @@ const SegmentSearchResult = zod_1.z
 })
     .strict()
     .passthrough();
+const FaceSearchResult = zod_1.z
+    .object({
+    type: zod_1.z.literal("face"),
+    file_id: zod_1.z.string().uuid(),
+    collection_id: zod_1.z.string().uuid(),
+    face_id: zod_1.z.string().uuid(),
+    frame_id: zod_1.z.string().uuid(),
+    score: zod_1.z.number().gte(0).lte(100),
+    timestamp: zod_1.z.number().gte(0),
+    face_bounding_box: zod_1.z
+        .object({
+        height: zod_1.z.number().gte(0).lte(1),
+        width: zod_1.z.number().gte(0).lte(1),
+        top: zod_1.z.number().gte(0).lte(1),
+        left: zod_1.z.number().gte(0).lte(1),
+    })
+        .strict()
+        .passthrough()
+        .optional(),
+    thumbnail_url: zod_1.z.string().optional(),
+})
+    .strict()
+    .passthrough();
 const SearchResponse = zod_1.z
     .object({
     id: zod_1.z.string().uuid(),
     object: zod_1.z.literal("search"),
-    query: zod_1.z.string(),
-    scope: zod_1.z.enum(["file", "segment"]),
-    results: zod_1.z.array(zod_1.z.union([FileSearchResult, SegmentSearchResult])),
+    query: zod_1.z.string().optional(),
+    scope: zod_1.z.enum(["file", "segment", "face"]),
+    search_target: zod_1.z.enum(["file", "segment"]).optional(),
+    results: zod_1.z.array(zod_1.z.union([FileSearchResult, SegmentSearchResult, FaceSearchResult])),
     total: zod_1.z.number().int(),
     limit: zod_1.z.number().int(),
 })
@@ -133,6 +163,7 @@ exports.schemas = {
     SearchRequest,
     FileSearchResult,
     SegmentSearchResult,
+    FaceSearchResult,
     SearchResponse,
 };
 const endpoints = (0, core_1.makeApi)([

package/dist/generated/Segments.d.ts

@@ -25,6 +25,8 @@ type ShotConfig = Partial<{
 }>;
 type NarrativeConfig = Partial<{
     prompt: string;
+    strategy: "direct" | "long" | "balanced";
+    number_of_chapters: number;
 }>;
 type Segment = {
     start_time: number;
@@ -34,16 +36,27 @@ type Segment = {
 };
 type SegmentsList = {
     object: "list";
-    data: Array<Segments>;
+    data: Array<SegmentsListItem>;
     total: number;
     limit: number;
     offset: number;
 };
+type SegmentsListItem = {
+    job_id: string;
+    file_id: string;
+    object: "segments";
+    status: "pending" | "processing" | "completed" | "failed";
+    criteria: "shot" | "narrative";
+    created_at: number;
+    shot_config?: ShotConfig | undefined;
+    narrative_config?: NarrativeConfig | undefined;
+};
 declare const ShotConfig: z.ZodType<ShotConfig>;
 declare const NarrativeConfig: z.ZodType<NarrativeConfig>;
 declare const NewSegments: z.ZodType<NewSegments>;
 declare const Segment: z.ZodType<Segment>;
 declare const Segments: z.ZodType<Segments>;
+declare const SegmentsListItem: z.ZodType<SegmentsListItem>;
 declare const SegmentsList: z.ZodType<SegmentsList>;
 export declare const schemas: {
     ShotConfig: z.ZodType<Partial<{
@@ -57,19 +70,24 @@ export declare const schemas: {
     }>>;
     NarrativeConfig: z.ZodType<Partial<{
         prompt: string;
+        strategy: "direct" | "long" | "balanced";
+        number_of_chapters: number;
     }>, z.ZodTypeDef, Partial<{
         prompt: string;
+        strategy: "direct" | "long" | "balanced";
+        number_of_chapters: number;
     }>>;
     NewSegments: z.ZodType<NewSegments, z.ZodTypeDef, NewSegments>;
     Segment: z.ZodType<Segment, z.ZodTypeDef, Segment>;
     Segments: z.ZodType<Segments, z.ZodTypeDef, Segments>;
+    SegmentsListItem: z.ZodType<SegmentsListItem, z.ZodTypeDef, SegmentsListItem>;
     SegmentsList: z.ZodType<SegmentsList, z.ZodTypeDef, SegmentsList>;
 };
 export declare const SegmentsApi: import("@zodios/core").ZodiosInstance<[{
     method: "post";
     path: "/segments";
     alias: "createSegments";
-    description: "Create intelligent video segments based on shot detection or narrative analysis.\n\n**⚠️ Note: YouTube URLs are supported for narrative-based segmentation only.** Shot-based segmentation requires direct video file access. Use Cloudglue Files, HTTP URLs, or files from data connectors for shot-based segmentation.";
+    description: "Create intelligent video segments based on shot detection or narrative analysis.\n\n**⚠️ Note: YouTube URLs are supported for narrative-based segmentation only.** Shot-based segmentation requires direct video file access. Use Cloudglue Files, HTTP URLs, or files from data connectors for shot-based segmentation.\n\n**Narrative Segmentation Strategies:**\n\n• **balanced** (default): Uses multimodal describe job for comprehensive analysis.\n  Recommended for most videos. Supports YouTube URLs.\n\n• **direct**: Directly analyzes the full video URL with AI.\n  Ideal for videos less than 10 minutes long. Provides finer grain control and expressibility with direct integration of your prompt with the Video AI model.\n\n• **long**: Optimized for longer videos beyond 10 minutes.\n  Provides finer grain control and expressibility with direct integration of your prompt with the Video AI model.\n\n**YouTube URLs**: Automatically use the &#x27;balanced&#x27; strategy. The strategy field is ignored for YouTube URLs, and other strategies will be rejected with an error.";
     requestFormat: "json";
     parameters: [{
         name: "body";
@@ -253,7 +271,7 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
     method: "post";
     path: "/segments";
     alias: "createSegments";
-    description: "Create intelligent video segments based on shot detection or narrative analysis.\n\n**⚠️ Note: YouTube URLs are supported for narrative-based segmentation only.** Shot-based segmentation requires direct video file access. Use Cloudglue Files, HTTP URLs, or files from data connectors for shot-based segmentation.";
+    description: "Create intelligent video segments based on shot detection or narrative analysis.\n\n**⚠️ Note: YouTube URLs are supported for narrative-based segmentation only.** Shot-based segmentation requires direct video file access. Use Cloudglue Files, HTTP URLs, or files from data connectors for shot-based segmentation.\n\n**Narrative Segmentation Strategies:**\n\n• **balanced** (default): Uses multimodal describe job for comprehensive analysis.\n  Recommended for most videos. Supports YouTube URLs.\n\n• **direct**: Directly analyzes the full video URL with AI.\n  Ideal for videos less than 10 minutes long. Provides finer grain control and expressibility with direct integration of your prompt with the Video AI model.\n\n• **long**: Optimized for longer videos beyond 10 minutes.\n  Provides finer grain control and expressibility with direct integration of your prompt with the Video AI model.\n\n**YouTube URLs**: Automatically use the &#x27;balanced&#x27; strategy. The strategy field is ignored for YouTube URLs, and other strategies will be rejected with an error.";
     requestFormat: "json";
     parameters: [{
         name: "body";

package/dist/generated/Segments.js

@@ -14,7 +14,11 @@ const ShotConfig = zod_1.z
     .strict()
     .passthrough();
 const NarrativeConfig = zod_1.z
-    .object({ prompt: zod_1.z.string() })
+    .object({
+    prompt: zod_1.z.string(),
+    strategy: zod_1.z.enum(["direct", "long", "balanced"]).default("balanced"),
+    number_of_chapters: zod_1.z.number().int().gte(1),
+})
     .partial()
     .strict()
     .passthrough();
@@ -51,10 +55,23 @@ const Segments = zod_1.z
 })
     .strict()
     .passthrough();
+const SegmentsListItem = zod_1.z
+    .object({
+    job_id: zod_1.z.string().uuid(),
+    file_id: zod_1.z.string().uuid(),
+    object: zod_1.z.literal("segments"),
+    status: zod_1.z.enum(["pending", "processing", "completed", "failed"]),
+    criteria: zod_1.z.enum(["shot", "narrative"]),
+    created_at: zod_1.z.number().int(),
+    shot_config: ShotConfig.optional(),
+    narrative_config: NarrativeConfig.optional(),
+})
+    .strict()
+    .passthrough();
 const SegmentsList = zod_1.z
     .object({
     object: zod_1.z.literal("list"),
-    data: zod_1.z.array(Segments),
+    data: zod_1.z.array(SegmentsListItem),
     total: zod_1.z.number().int(),
     limit: zod_1.z.number().int(),
     offset: zod_1.z.number().int(),
@@ -67,6 +84,7 @@ exports.schemas = {
     NewSegments,
     Segment,
     Segments,
+    SegmentsListItem,
     SegmentsList,
 };
 const endpoints = (0, core_1.makeApi)([
@@ -76,7 +94,20 @@ const endpoints = (0, core_1.makeApi)([
         alias: "createSegments",
         description: `Create intelligent video segments based on shot detection or narrative analysis.
 
-**⚠️ Note: YouTube URLs are supported for narrative-based segmentation only.** Shot-based segmentation requires direct video file access. Use Cloudglue Files, HTTP URLs, or files from data connectors for shot-based segmentation.`,
+**⚠️ Note: YouTube URLs are supported for narrative-based segmentation only.** Shot-based segmentation requires direct video file access. Use Cloudglue Files, HTTP URLs, or files from data connectors for shot-based segmentation.
+
+**Narrative Segmentation Strategies:**
+
+• **balanced** (default): Uses multimodal describe job for comprehensive analysis.
+  Recommended for most videos. Supports YouTube URLs.
+
+• **direct**: Directly analyzes the full video URL with AI.
+  Ideal for videos less than 10 minutes long. Provides finer grain control and expressibility with direct integration of your prompt with the Video AI model.
+
+• **long**: Optimized for longer videos beyond 10 minutes.
+  Provides finer grain control and expressibility with direct integration of your prompt with the Video AI model.
+
+**YouTube URLs**: Automatically use the 'balanced' strategy. The strategy field is ignored for YouTube URLs, and other strategies will be rejected with an error.`,
         requestFormat: "json",
         parameters: [
             {
@@ -90,7 +121,7 @@ const endpoints = (0, core_1.makeApi)([
         errors: [
             {
                 status: 400,
-                description: `Invalid request, missing required parameters, or unsupported URL type (e.g., YouTube URLs with shot-based segmentation are not supported)`,
+                description: `Invalid request, missing required parameters, unsupported URL type (e.g., YouTube URLs with shot-based segmentation), or unsupported strategy for YouTube URLs (YouTube URLs only support 'balanced' strategy)`,
                 schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
             },
             {