@aviaryhq/cloudglue-js 0.4.0 → 0.4.2

package/dist/src/client.d.ts

@@ -65,10 +65,10 @@ interface ListCollectionParams {
     offset?: number;
     order?: "name" | "created_at";
     sort?: "asc" | "desc";
-    collection_type?: "entities" | "rich-transcripts" | "media-descriptions";
+    collection_type?: "entities" | "rich-transcripts" | "media-descriptions" | "face-analysis";
 }
 interface CreateCollectionParams {
-    collection_type: "entities" | "rich-transcripts" | "media-descriptions";
+    collection_type: "entities" | "rich-transcripts" | "media-descriptions" | "face-analysis";
     name: string;
     description?: string;
     extract_config?: {
@@ -93,6 +93,18 @@ interface CreateCollectionParams {
     };
     default_segmentation_config?: SegmentationConfig;
     default_thumbnails_config?: ThumbnailsConfig;
+    face_detection_config?: {
+        frame_extraction_config: {
+            strategy: "uniform";
+            uniform_config?: {
+                frames_per_second?: number;
+                max_width?: number;
+            };
+        };
+        thumbnails_config?: {
+            enable_frame_thumbnails?: boolean;
+        };
+    } | null;
 }
 interface ListCollectionVideosParams {
     limit?: number;
@@ -161,9 +173,13 @@ interface ChatCompletionParams {
     temperature?: number;
 }
 interface SearchParams {
-    scope: "file" | "segment";
+    scope: "file" | "segment" | "face";
     collections: string[];
-    query: string;
+    query?: string;
+    source_image?: {
+        url?: string;
+        base64?: string;
+    };
     limit?: number;
     filter?: Filter;
 }
@@ -183,7 +199,7 @@ declare class EnhancedFilesApi {
         limit: number;
         offset: number;
     }>;
-    uploadFile(params: UploadFileParams): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    uploadFile(params: UploadFileParams): Promise<import("axios").AxiosResponse<any, any>>;
     getFile(fileId: string): Promise<import("zod").objectOutputType<{
         id: import("zod").ZodString;
         status: import("zod").ZodEnum<["pending", "processing", "completed", "failed", "not_applicable"]>;
@@ -639,7 +655,7 @@ declare class EnhancedCollectionsApi {
             object: "collection";
             name: string;
             description?: (string | null) | undefined;
-            collection_type: "media-descriptions" | "entities" | "rich-transcripts";
+            collection_type: "media-descriptions" | "entities" | "rich-transcripts" | "face-analysis";
             extract_config?: Partial<{
                 prompt: string;
                 schema: {};
@@ -662,6 +678,18 @@ declare class EnhancedCollectionsApi {
             }> | undefined;
             default_segmentation_config?: import("../generated/common").SegmentationConfig | undefined;
             default_thumbnails_config?: ThumbnailsConfig | undefined;
+            face_detection_config?: Partial<{
+                frame_extraction_config: {
+                    strategy: "uniform";
+                    uniform_config?: Partial<{
+                        frames_per_second: number;
+                        max_width: number;
+                    }> | undefined;
+                };
+                thumbnails_config: Partial<{
+                    enable_frame_thumbnails: boolean;
+                }>;
+            }> | null | undefined;
             created_at: number;
             file_count: number;
         }>;
@@ -674,7 +702,7 @@ declare class EnhancedCollectionsApi {
         object: "collection";
         name: string;
         description?: (string | null) | undefined;
-        collection_type: "media-descriptions" | "entities" | "rich-transcripts";
+        collection_type: "media-descriptions" | "entities" | "rich-transcripts" | "face-analysis";
         extract_config?: Partial<{
             prompt: string;
             schema: {};
@@ -697,6 +725,18 @@ declare class EnhancedCollectionsApi {
         }> | undefined;
         default_segmentation_config?: import("../generated/common").SegmentationConfig | undefined;
         default_thumbnails_config?: ThumbnailsConfig | undefined;
+        face_detection_config?: Partial<{
+            frame_extraction_config: {
+                strategy: "uniform";
+                uniform_config?: Partial<{
+                    frames_per_second: number;
+                    max_width: number;
+                }> | undefined;
+            };
+            thumbnails_config: Partial<{
+                enable_frame_thumbnails: boolean;
+            }>;
+        }> | null | undefined;
         created_at: number;
         file_count: number;
     }>;
@@ -705,7 +745,7 @@ declare class EnhancedCollectionsApi {
         object: "collection";
         name: string;
         description?: (string | null) | undefined;
-        collection_type: "media-descriptions" | "entities" | "rich-transcripts";
+        collection_type: "media-descriptions" | "entities" | "rich-transcripts" | "face-analysis";
         extract_config?: Partial<{
             prompt: string;
             schema: {};
@@ -728,6 +768,18 @@ declare class EnhancedCollectionsApi {
         }> | undefined;
         default_segmentation_config?: import("../generated/common").SegmentationConfig | undefined;
         default_thumbnails_config?: ThumbnailsConfig | undefined;
+        face_detection_config?: Partial<{
+            frame_extraction_config: {
+                strategy: "uniform";
+                uniform_config?: Partial<{
+                    frames_per_second: number;
+                    max_width: number;
+                }> | undefined;
+            };
+            thumbnails_config: Partial<{
+                enable_frame_thumbnails: boolean;
+            }>;
+        }> | null | undefined;
         created_at: number;
         file_count: number;
     }>;
@@ -743,7 +795,7 @@ declare class EnhancedCollectionsApi {
         object: "collection";
         name: string;
         description?: (string | null) | undefined;
-        collection_type: "media-descriptions" | "entities" | "rich-transcripts";
+        collection_type: "media-descriptions" | "entities" | "rich-transcripts" | "face-analysis";
         extract_config?: Partial<{
             prompt: string;
             schema: {};
@@ -766,6 +818,18 @@ declare class EnhancedCollectionsApi {
         }> | undefined;
         default_segmentation_config?: import("../generated/common").SegmentationConfig | undefined;
         default_thumbnails_config?: ThumbnailsConfig | undefined;
+        face_detection_config?: Partial<{
+            frame_extraction_config: {
+                strategy: "uniform";
+                uniform_config?: Partial<{
+                    frames_per_second: number;
+                    max_width: number;
+                }> | undefined;
+            };
+            thumbnails_config: Partial<{
+                enable_frame_thumbnails: boolean;
+            }>;
+        }> | null | undefined;
         created_at: number;
         file_count: number;
     }>;
@@ -1094,6 +1158,80 @@ declare class EnhancedCollectionsApi {
         speech: Array<import("../generated/common").SpeechOutputPart>;
         audio_description: Array<import("../generated/common").DescribeOutputPart>;
     }>>;
+    getFaceDetections(collectionId: string, fileId: string, params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<import("zod").objectOutputType<{
+        collection_id: import("zod").ZodString;
+        file_id: import("zod").ZodString;
+        faces: import("zod").ZodArray<import("zod").ZodObject<{
+            id: import("zod").ZodString;
+            face_bounding_box: import("zod").ZodObject<{
+                height: import("zod").ZodNumber;
+                width: import("zod").ZodNumber;
+                top: import("zod").ZodNumber;
+                left: import("zod").ZodNumber;
+            }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
+                height: import("zod").ZodNumber;
+                width: import("zod").ZodNumber;
+                top: import("zod").ZodNumber;
+                left: import("zod").ZodNumber;
+            }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
+                height: import("zod").ZodNumber;
+                width: import("zod").ZodNumber;
+                top: import("zod").ZodNumber;
+                left: import("zod").ZodNumber;
+            }, import("zod").ZodTypeAny, "passthrough">>;
+            frame_id: import("zod").ZodString;
+            timestamp: import("zod").ZodNumber;
+            thumbnail_url: import("zod").ZodOptional<import("zod").ZodString>;
+        }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
+            id: import("zod").ZodString;
+            face_bounding_box: import("zod").ZodObject<{
+                height: import("zod").ZodNumber;
+                width: import("zod").ZodNumber;
+                top: import("zod").ZodNumber;
+                left: import("zod").ZodNumber;
+            }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
+                height: import("zod").ZodNumber;
+                width: import("zod").ZodNumber;
+                top: import("zod").ZodNumber;
+                left: import("zod").ZodNumber;
+            }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
+                height: import("zod").ZodNumber;
+                width: import("zod").ZodNumber;
+                top: import("zod").ZodNumber;
+                left: import("zod").ZodNumber;
+            }, import("zod").ZodTypeAny, "passthrough">>;
+            frame_id: import("zod").ZodString;
+            timestamp: import("zod").ZodNumber;
+            thumbnail_url: import("zod").ZodOptional<import("zod").ZodString>;
+        }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
+            id: import("zod").ZodString;
+            face_bounding_box: import("zod").ZodObject<{
+                height: import("zod").ZodNumber;
+                width: import("zod").ZodNumber;
+                top: import("zod").ZodNumber;
+                left: import("zod").ZodNumber;
+            }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
+                height: import("zod").ZodNumber;
+                width: import("zod").ZodNumber;
+                top: import("zod").ZodNumber;
+                left: import("zod").ZodNumber;
+            }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
+                height: import("zod").ZodNumber;
+                width: import("zod").ZodNumber;
+                top: import("zod").ZodNumber;
+                left: import("zod").ZodNumber;
+            }, import("zod").ZodTypeAny, "passthrough">>;
+            frame_id: import("zod").ZodString;
+            timestamp: import("zod").ZodNumber;
+            thumbnail_url: import("zod").ZodOptional<import("zod").ZodString>;
+        }, import("zod").ZodTypeAny, "passthrough">>, "many">;
+        total: import("zod").ZodNumber;
+        limit: import("zod").ZodNumber;
+        offset: import("zod").ZodNumber;
+    }, import("zod").ZodTypeAny, "passthrough">>;
     listMediaDescriptions(collectionId: string, params?: ListCollectionMediaDescriptionsParams): Promise<{
         object: "list";
         data: Array<{
@@ -1684,8 +1822,9 @@ declare class EnhancedSearchApi {
     searchContent(params: SearchParams): Promise<{
         id: string;
         object: "search";
-        query: string;
-        scope: "file" | "segment";
+        query?: string | undefined;
+        scope: "file" | "segment" | "face";
+        search_target?: ("file" | "segment") | undefined;
         results: Array<{
             type: "file";
             file_id: string;
@@ -1724,6 +1863,21 @@ declare class EnhancedSearchApi {
                 end_time: number;
             }>> | undefined;
             thumbnail_url?: string | undefined;
+        } | {
+            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;
         }>;
         total: number;
         limit: number;
@@ -1903,13 +2057,8 @@ declare class EnhancedSegmentsApi {
             }> | undefined;
             narrative_config?: Partial<{
                 prompt: string;
-            }> | undefined;
-            total_segments?: number | undefined;
-            segments?: Array<{
-                start_time: number;
-                end_time: number;
-                description?: string | undefined;
-                thumbnail_url?: string | undefined;
+                strategy: "direct" | "long" | "balanced";
+                number_of_chapters: number;
             }> | undefined;
         }>;
         total: number;
@@ -1930,6 +2079,8 @@ declare class EnhancedSegmentsApi {
         }> | undefined;
         narrative_config?: Partial<{
             prompt: string;
+            strategy: "direct" | "long" | "balanced";
+            number_of_chapters: number;
         }> | undefined;
         total_segments?: number | undefined;
         segments?: Array<{
@@ -1958,6 +2109,8 @@ declare class EnhancedSegmentsApi {
         }> | undefined;
         narrative_config?: Partial<{
             prompt: string;
+            strategy: "direct" | "long" | "balanced";
+            number_of_chapters: number;
         }> | undefined;
         total_segments?: number | undefined;
         segments?: Array<{
@@ -1984,6 +2137,8 @@ declare class EnhancedSegmentsApi {
         }> | undefined;
         narrative_config?: Partial<{
             prompt: string;
+            strategy: "direct" | "long" | "balanced";
+            number_of_chapters: number;
         }> | undefined;
         total_segments?: number | undefined;
         segments?: Array<{

package/dist/src/client.js

@@ -229,6 +229,12 @@ class EnhancedCollectionsApi {
             queries: { ...options },
         });
     }
+    async getFaceDetections(collectionId, fileId, params = {}) {
+        return this.api.getFaceDetections({
+            params: { collection_id: collectionId, file_id: fileId },
+            queries: params
+        });
+    }
     async listMediaDescriptions(collectionId, params = {}) {
         return this.api.listCollectionMediaDescriptions({
             params: { collection_id: collectionId },
@@ -639,7 +645,7 @@ class CloudGlue {
             headers: {
                 Authorization: `Bearer ${this.apiKey}`,
                 'x-sdk-client': 'cloudglue-js',
-                'x-sdk-version': '0.4.0',
+                'x-sdk-version': '0.4.2',
             },
             baseURL: this.baseUrl,
             timeout: this.timeout,

package/dist/src/types.d.ts

@@ -125,6 +125,10 @@ export type FileSearchResult = z.infer<typeof searchSchemas.FileSearchResult>;
  * Represents a segment-level search result
  */
 export type SegmentSearchResult = z.infer<typeof searchSchemas.SegmentSearchResult>;
+/**
+ * Represents a face-level search result
+ */
+export type FaceSearchResult = z.infer<typeof searchSchemas.FaceSearchResult>;
 /**
  * Represents search filter criteria for filtering results
  */
@@ -150,6 +154,10 @@ export type CollectionMediaDescription = z.infer<typeof collectionsSchemas.Media
  * Represents a list of media descriptions for files in a collection
  */
 export type CollectionMediaDescriptionsList = z.infer<typeof collectionsSchemas.CollectionMediaDescriptionsList>;
+/**
+ * Represents face detections for a file in a collection
+ */
+export type FileFaceDetections = z.infer<typeof collectionsSchemas.FileFaceDetections>;
 export type NarrativeConfig = z.infer<typeof segmentsSchemas.NarrativeConfig>;
 export type ShotConfig = z.infer<typeof segmentsSchemas.ShotConfig>;
 export type WebhookEvents = z.infer<typeof webhooksSchemas['WebhookEvents']>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aviaryhq/cloudglue-js",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "Cloudglue API client for Node.js",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",