@aviaryhq/cloudglue-js 0.4.4 → 0.4.6

package/dist/generated/Search.d.ts

@@ -5,8 +5,9 @@ type SearchResponse = {
     object: "search";
     query?: string | undefined;
     scope: "file" | "segment" | "face";
-    search_target?: ("file" | "segment") | undefined;
-    results: Array<FileSearchResult | SegmentSearchResult | FaceSearchResult>;
+    group_by_key?: "file" | undefined;
+    group_count?: number | undefined;
+    results: Array<FileSearchResult | SegmentSearchResult | FaceSearchResult | SegmentGroupResult | FaceGroupResult>;
     total: number;
     limit: number;
 };
@@ -66,6 +67,20 @@ type FaceSearchResult = {
     } | undefined;
     thumbnail_url?: string | undefined;
 };
+type SegmentGroupResult = {
+    type: "segment_group";
+    matched_items: Array<SegmentSearchResult>;
+    file_id: string;
+    item_count: number;
+    best_score: number;
+};
+type FaceGroupResult = {
+    type: "face_group";
+    matched_items: Array<FaceSearchResult>;
+    file_id: string;
+    item_count: number;
+    best_score: number;
+};
 type SearchFilter = Partial<{
     metadata: Array<SearchFilterCriteria>;
     video_info: Array<SearchFilterCriteria & Partial<{
@@ -86,6 +101,8 @@ declare const SearchFilter: z.ZodType<SearchFilter>;
 declare const FileSearchResult: z.ZodType<FileSearchResult>;
 declare const SegmentSearchResult: z.ZodType<SegmentSearchResult>;
 declare const FaceSearchResult: z.ZodType<FaceSearchResult>;
+declare const SegmentGroupResult: z.ZodType<SegmentGroupResult>;
+declare const FaceGroupResult: z.ZodType<FaceGroupResult>;
 declare const SearchResponse: z.ZodType<SearchResponse>;
 export declare const schemas: {
     SearchFilterCriteria: z.ZodType<SearchFilterCriteria, z.ZodTypeDef, SearchFilterCriteria>;
@@ -116,6 +133,9 @@ export declare const schemas: {
         }>;
         limit: number;
         filter: SearchFilter;
+        threshold: number;
+        group_by_key: "file";
+        sort_by: "score" | "item_count";
     }>, z.ZodTypeDef, Partial<{
         scope: "file" | "segment" | "face";
         collections: Array<string>;
@@ -126,10 +146,15 @@ export declare const schemas: {
         }>;
         limit: number;
         filter: SearchFilter;
+        threshold: number;
+        group_by_key: "file";
+        sort_by: "score" | "item_count";
     }>>;
     FileSearchResult: z.ZodType<FileSearchResult, z.ZodTypeDef, FileSearchResult>;
     SegmentSearchResult: z.ZodType<SegmentSearchResult, z.ZodTypeDef, SegmentSearchResult>;
     FaceSearchResult: z.ZodType<FaceSearchResult, z.ZodTypeDef, FaceSearchResult>;
+    SegmentGroupResult: z.ZodType<SegmentGroupResult, z.ZodTypeDef, SegmentGroupResult>;
+    FaceGroupResult: z.ZodType<FaceGroupResult, z.ZodTypeDef, FaceGroupResult>;
     SearchResponse: z.ZodType<SearchResponse, z.ZodTypeDef, SearchResponse>;
 };
 export declare const SearchApi: import("@zodios/core").ZodiosInstance<[{
@@ -152,6 +177,9 @@ export declare const SearchApi: import("@zodios/core").ZodiosInstance<[{
             }>;
             limit: number;
             filter: SearchFilter;
+            threshold: number;
+            group_by_key: "file";
+            sort_by: "score" | "item_count";
         }>, z.ZodTypeDef, Partial<{
             scope: "file" | "segment" | "face";
             collections: Array<string>;
@@ -162,6 +190,9 @@ export declare const SearchApi: import("@zodios/core").ZodiosInstance<[{
             }>;
             limit: number;
             filter: SearchFilter;
+            threshold: number;
+            group_by_key: "file";
+            sort_by: "score" | "item_count";
         }>>;
     }];
     response: z.ZodType<SearchResponse, z.ZodTypeDef, SearchResponse>;
@@ -217,6 +248,9 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
             }>;
             limit: number;
             filter: SearchFilter;
+            threshold: number;
+            group_by_key: "file";
+            sort_by: "score" | "item_count";
         }>, z.ZodTypeDef, Partial<{
             scope: "file" | "segment" | "face";
             collections: Array<string>;
@@ -227,6 +261,9 @@ export declare function createApiClient(baseUrl: string, options?: ZodiosOptions
             }>;
             limit: number;
             filter: SearchFilter;
+            threshold: number;
+            group_by_key: "file";
+            sort_by: "score" | "item_count";
         }>>;
     }];
     response: z.ZodType<SearchResponse, z.ZodTypeDef, SearchResponse>;

package/dist/generated/Search.js

@@ -51,8 +51,11 @@ const SearchRequest = zod_1.z
         .partial()
         .strict()
         .passthrough(),
-    limit: zod_1.z.number().int().gte(1).lte(100).default(10),
+    limit: zod_1.z.number().int().gte(1).default(10),
     filter: SearchFilter,
+    threshold: zod_1.z.number(),
+    group_by_key: zod_1.z.literal("file"),
+    sort_by: zod_1.z.enum(["score", "item_count"]).default("score"),
 })
     .partial()
     .strict()
@@ -128,7 +131,7 @@ const FaceSearchResult = zod_1.z
     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),
+    score: zod_1.z.number(),
     timestamp: zod_1.z.number().gte(0),
     face_bounding_box: zod_1.z
         .object({
@@ -144,14 +147,41 @@ const FaceSearchResult = zod_1.z
 })
     .strict()
     .passthrough();
+const SegmentGroupResult = zod_1.z
+    .object({
+    type: zod_1.z.literal("segment_group"),
+    matched_items: zod_1.z.array(SegmentSearchResult),
+    file_id: zod_1.z.string().uuid(),
+    item_count: zod_1.z.number().int(),
+    best_score: zod_1.z.number(),
+})
+    .strict()
+    .passthrough();
+const FaceGroupResult = zod_1.z
+    .object({
+    type: zod_1.z.literal("face_group"),
+    matched_items: zod_1.z.array(FaceSearchResult),
+    file_id: zod_1.z.string().uuid(),
+    item_count: zod_1.z.number().int(),
+    best_score: zod_1.z.number(),
+})
+    .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().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])),
+    group_by_key: zod_1.z.literal("file").optional(),
+    group_count: zod_1.z.number().int().optional(),
+    results: zod_1.z.array(zod_1.z.union([
+        FileSearchResult,
+        SegmentSearchResult,
+        FaceSearchResult,
+        SegmentGroupResult,
+        FaceGroupResult,
+    ])),
     total: zod_1.z.number().int(),
     limit: zod_1.z.number().int(),
 })
@@ -164,6 +194,8 @@ exports.schemas = {
     FileSearchResult,
     SegmentSearchResult,
     FaceSearchResult,
+    SegmentGroupResult,
+    FaceGroupResult,
     SearchResponse,
 };
 const endpoints = (0, core_1.makeApi)([

package/dist/generated/Segments.d.ts

@@ -25,7 +25,7 @@ type ShotConfig = Partial<{
 }>;
 type NarrativeConfig = Partial<{
     prompt: string;
-    strategy: "direct" | "long" | "balanced";
+    strategy: "comprehensive" | "balanced";
     number_of_chapters: number;
 }>;
 type Segment = {
@@ -70,11 +70,11 @@ export declare const schemas: {
     }>>;
     NarrativeConfig: z.ZodType<Partial<{
         prompt: string;
-        strategy: "direct" | "long" | "balanced";
+        strategy: "comprehensive" | "balanced";
         number_of_chapters: number;
     }>, z.ZodTypeDef, Partial<{
         prompt: string;
-        strategy: "direct" | "long" | "balanced";
+        strategy: "comprehensive" | "balanced";
         number_of_chapters: number;
     }>>;
     NewSegments: z.ZodType<NewSegments, z.ZodTypeDef, NewSegments>;
@@ -87,7 +87,7 @@ 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.\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.";
+    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): Balanced analysis approach using multiple modalities.\n  Recommended for most videos. Supports YouTube URLs.\n\n• **comprehensive**: Uses a VLM to deeply analyze logical segments of video.\n  Only available for non-YouTube videos.\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";
@@ -271,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.\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.";
+    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): Balanced analysis approach using multiple modalities.\n  Recommended for most videos. Supports YouTube URLs.\n\n• **comprehensive**: Uses a VLM to deeply analyze logical segments of video.\n  Only available for non-YouTube videos.\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

@@ -16,7 +16,7 @@ const ShotConfig = zod_1.z
 const NarrativeConfig = zod_1.z
     .object({
     prompt: zod_1.z.string(),
-    strategy: zod_1.z.enum(["direct", "long", "balanced"]).default("balanced"),
+    strategy: zod_1.z.enum(["comprehensive", "balanced"]).default("balanced"),
     number_of_chapters: zod_1.z.number().int().gte(1),
 })
     .partial()
@@ -98,14 +98,11 @@ const endpoints = (0, core_1.makeApi)([
 
 **Narrative Segmentation Strategies:**
 
-• **balanced** (default): Uses multimodal describe job for comprehensive analysis.
+• **balanced** (default): Balanced analysis approach using multiple modalities.
   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.
+• **comprehensive**: Uses a VLM to deeply analyze logical segments of video.
+  Only available for non-YouTube videos.
 
 **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",

package/dist/src/client.d.ts

@@ -182,6 +182,9 @@ interface SearchParams {
     };
     limit?: number;
     filter?: Filter;
+    threshold?: number;
+    group_by_key?: "file";
+    sort_by?: "score" | "item_count";
 }
 interface WaitForReadyOptions {
     /** Interval in milliseconds between polling attempts. Defaults to 5000ms (5 seconds). */
@@ -2028,7 +2031,8 @@ declare class EnhancedSearchApi {
         object: "search";
         query?: string | undefined;
         scope: "file" | "segment" | "face";
-        search_target?: ("file" | "segment") | undefined;
+        group_by_key?: "file" | undefined;
+        group_count?: number | undefined;
         results: Array<{
             type: "file";
             file_id: string;
@@ -2082,6 +2086,61 @@ declare class EnhancedSearchApi {
                 left: number;
             } | undefined;
             thumbnail_url?: string | undefined;
+        } | {
+            type: "segment_group";
+            matched_items: Array<{
+                type: "segment";
+                file_id: string;
+                collection_id: string;
+                segment_id: string;
+                id: string;
+                score: number;
+                start_time: number;
+                end_time: number;
+                title?: (string | null) | undefined;
+                filename?: (string | null) | undefined;
+                visual_description?: Array<Partial<{
+                    text: string;
+                    start_time: number;
+                    end_time: number;
+                }>> | undefined;
+                scene_text?: Array<Partial<{
+                    text: string;
+                    start_time: number;
+                    end_time: number;
+                }>> | undefined;
+                speech?: Array<Partial<{
+                    speaker: string;
+                    text: string;
+                    start_time: number;
+                    end_time: number;
+                }>> | undefined;
+                thumbnail_url?: string | undefined;
+            }>;
+            file_id: string;
+            item_count: number;
+            best_score: number;
+        } | {
+            type: "face_group";
+            matched_items: Array<{
+                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;
+            }>;
+            file_id: string;
+            item_count: number;
+            best_score: number;
         }>;
         total: number;
         limit: number;
@@ -2261,7 +2320,7 @@ declare class EnhancedSegmentsApi {
             }> | undefined;
             narrative_config?: Partial<{
                 prompt: string;
-                strategy: "direct" | "long" | "balanced";
+                strategy: "comprehensive" | "balanced";
                 number_of_chapters: number;
             }> | undefined;
         }>;
@@ -2283,7 +2342,7 @@ declare class EnhancedSegmentsApi {
         }> | undefined;
         narrative_config?: Partial<{
             prompt: string;
-            strategy: "direct" | "long" | "balanced";
+            strategy: "comprehensive" | "balanced";
             number_of_chapters: number;
         }> | undefined;
         total_segments?: number | undefined;
@@ -2313,7 +2372,7 @@ declare class EnhancedSegmentsApi {
         }> | undefined;
         narrative_config?: Partial<{
             prompt: string;
-            strategy: "direct" | "long" | "balanced";
+            strategy: "comprehensive" | "balanced";
             number_of_chapters: number;
         }> | undefined;
         total_segments?: number | undefined;
@@ -2341,7 +2400,7 @@ declare class EnhancedSegmentsApi {
         }> | undefined;
         narrative_config?: Partial<{
             prompt: string;
-            strategy: "direct" | "long" | "balanced";
+            strategy: "comprehensive" | "balanced";
             number_of_chapters: number;
         }> | undefined;
         total_segments?: number | undefined;

package/dist/src/client.js

@@ -645,7 +645,7 @@ class CloudGlue {
             headers: {
                 Authorization: `Bearer ${this.apiKey}`,
                 'x-sdk-client': 'cloudglue-js',
-                'x-sdk-version': '0.4.4',
+                'x-sdk-version': '0.4.6',
             },
             baseURL: this.baseUrl,
             timeout: this.timeout,

package/dist/src/types.d.ts

@@ -129,6 +129,14 @@ export type SegmentSearchResult = z.infer<typeof searchSchemas.SegmentSearchResu
  * Represents a face-level search result
  */
 export type FaceSearchResult = z.infer<typeof searchSchemas.FaceSearchResult>;
+/**
+ * Represents a grouped segment search result
+ */
+export type SegmentGroupResult = z.infer<typeof searchSchemas.SegmentGroupResult>;
+/**
+ * Represents a grouped face search result
+ */
+export type FaceGroupResult = z.infer<typeof searchSchemas.FaceGroupResult>;
 /**
  * Represents search filter criteria for filtering results
  */

package/package.json

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