@aviaryhq/cloudglue-js 0.1.2 → 0.1.4

package/dist/generated/Files.js

@@ -5,6 +5,7 @@ exports.createApiClient = createApiClient;
 const core_1 = require("@zodios/core");
 const zod_1 = require("zod");
 const common_1 = require("./common");
+const common_2 = require("./common");
 const FileList = zod_1.z
     .object({
     object: zod_1.z.literal("list"),
@@ -15,6 +16,16 @@ const FileList = zod_1.z
 })
     .strict()
     .passthrough();
+const SegmentationList = zod_1.z
+    .object({
+    object: zod_1.z.literal("list"),
+    data: zod_1.z.array(common_2.Segmentation),
+    total: zod_1.z.number().int(),
+    limit: zod_1.z.number().int(),
+    offset: zod_1.z.number().int(),
+})
+    .strict()
+    .passthrough();
 const FileUpload = zod_1.z
     .object({
     file: zod_1.z.instanceof(File),
@@ -36,6 +47,7 @@ const FileUpdate = zod_1.z
     .passthrough();
 exports.schemas = {
     FileList,
+    SegmentationList,
     FileUpload,
     FileDelete,
     FileUpdate,
@@ -224,6 +236,81 @@ const endpoints = (0, core_1.makeApi)([
             },
         ],
     },
+    {
+        method: "post",
+        path: "/files/:file_id/segmentations",
+        alias: "createFileSegmentation",
+        description: `Create a new segmentation for a file using the specified segmentation configuration`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "body",
+                description: `Segmentation configuration`,
+                type: "Body",
+                schema: common_2.SegmentationConfig,
+            },
+            {
+                name: "file_id",
+                type: "Path",
+                schema: zod_1.z.string().uuid(),
+            },
+        ],
+        response: common_2.Segmentation,
+        errors: [
+            {
+                status: 400,
+                description: `Invalid request or file duration is less than window size`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+            {
+                status: 404,
+                description: `File 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(),
+            },
+        ],
+    },
+    {
+        method: "get",
+        path: "/files/:file_id/segmentations",
+        alias: "listFileSegmentations",
+        description: `List all segmentations for a specific file`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "file_id",
+                type: "Path",
+                schema: zod_1.z.string().uuid(),
+            },
+            {
+                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: SegmentationList,
+        errors: [
+            {
+                status: 404,
+                description: `File 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.FilesApi = new core_1.Zodios("https://api.cloudglue.dev/v1", endpoints);
 function createApiClient(baseUrl, options) {

package/dist/generated/Search.d.ts

@@ -0,0 +1,190 @@
+import { type ZodiosOptions } from "@zodios/core";
+import { z } from "zod";
+type SearchResponse = {
+    object: "search";
+    query: string;
+    scope: "file" | "segment";
+    results: Array<FileSearchResult | SegmentSearchResult>;
+    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;
+    collection_id: string;
+    id: string;
+    score: number;
+    filename?: (string | null) | undefined;
+    summary?: (string | null) | undefined;
+    generated_title?: (string | null) | undefined;
+};
+type SegmentSearchResult = {
+    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<{
+        text: string;
+        start_time: number;
+        end_time: number;
+    }>> | undefined;
+};
+type SearchFilter = Partial<{
+    metadata: Array<SearchFilterCriteria>;
+    video_info: Array<SearchFilterCriteria & Partial<{
+        path: "duration_seconds" | "has_audio";
+    }>>;
+    file: Array<SearchFilterCriteria & Partial<{
+        path: "bytes" | "filename" | "uri" | "created_at" | "id";
+    }>>;
+}>;
+type SearchFilterCriteria = {
+    path: string;
+    operator: "NotEqual" | "Equal" | "LessThan" | "GreaterThan" | "ContainsAny" | "ContainsAll" | "In";
+    valueText?: string | undefined;
+    valueTextArray?: Array<string> | undefined;
+};
+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 SearchResponse: z.ZodType<SearchResponse>;
+export declare const schemas: {
+    SearchFilterCriteria: z.ZodType<SearchFilterCriteria, z.ZodTypeDef, SearchFilterCriteria>;
+    SearchFilter: z.ZodType<Partial<{
+        metadata: Array<SearchFilterCriteria>;
+        video_info: Array<SearchFilterCriteria & Partial<{
+            path: "duration_seconds" | "has_audio";
+        }>>;
+        file: Array<SearchFilterCriteria & Partial<{
+            path: "bytes" | "filename" | "uri" | "created_at" | "id";
+        }>>;
+    }>, z.ZodTypeDef, Partial<{
+        metadata: Array<SearchFilterCriteria>;
+        video_info: Array<SearchFilterCriteria & Partial<{
+            path: "duration_seconds" | "has_audio";
+        }>>;
+        file: Array<SearchFilterCriteria & Partial<{
+            path: "bytes" | "filename" | "uri" | "created_at" | "id";
+        }>>;
+    }>>;
+    SearchRequest: z.ZodType<SearchRequest, z.ZodTypeDef, SearchRequest>;
+    FileSearchResult: z.ZodType<FileSearchResult, z.ZodTypeDef, FileSearchResult>;
+    SegmentSearchResult: z.ZodType<SegmentSearchResult, z.ZodTypeDef, SegmentSearchResult>;
+    SearchResponse: z.ZodType<SearchResponse, z.ZodTypeDef, SearchResponse>;
+};
+export declare const SearchApi: import("@zodios/core").ZodiosInstance<[{
+    method: "post";
+    path: "/search";
+    alias: "searchContent";
+    description: "Search for videos or video segments in collections to find relevant videos or moments/clips in a video. Supports filtering by metadata, video info, and file properties.\n\n**Important:** Currently only rich-transcript collections support search. For file-level search (scope&#x3D;&#x27;file&#x27;), the collection must be configured with &#x27;enable_summary: true&#x27; in the transcribe_config.";
+    requestFormat: "json";
+    parameters: [{
+        name: "body";
+        description: string;
+        type: "Body";
+        schema: z.ZodType<SearchRequest, z.ZodTypeDef, SearchRequest>;
+    }];
+    response: z.ZodType<SearchResponse, z.ZodTypeDef, SearchResponse>;
+    errors: [{
+        status: 400;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 404;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 500;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }];
+}]>;
+export declare function createApiClient(baseUrl: string, options?: ZodiosOptions): import("@zodios/core").ZodiosInstance<[{
+    method: "post";
+    path: "/search";
+    alias: "searchContent";
+    description: "Search for videos or video segments in collections to find relevant videos or moments/clips in a video. Supports filtering by metadata, video info, and file properties.\n\n**Important:** Currently only rich-transcript collections support search. For file-level search (scope&#x3D;&#x27;file&#x27;), the collection must be configured with &#x27;enable_summary: true&#x27; in the transcribe_config.";
+    requestFormat: "json";
+    parameters: [{
+        name: "body";
+        description: string;
+        type: "Body";
+        schema: z.ZodType<SearchRequest, z.ZodTypeDef, SearchRequest>;
+    }];
+    response: z.ZodType<SearchResponse, z.ZodTypeDef, SearchResponse>;
+    errors: [{
+        status: 400;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 404;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 500;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }];
+}]>;
+export {};

package/dist/generated/Search.js

@@ -0,0 +1,173 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchApi = exports.schemas = void 0;
+exports.createApiClient = createApiClient;
+const core_1 = require("@zodios/core");
+const zod_1 = require("zod");
+const SearchFilterCriteria = zod_1.z
+    .object({
+    path: zod_1.z.string(),
+    operator: zod_1.z.enum([
+        "NotEqual",
+        "Equal",
+        "LessThan",
+        "GreaterThan",
+        "ContainsAny",
+        "ContainsAll",
+        "In",
+    ]),
+    valueText: zod_1.z.string().optional(),
+    valueTextArray: zod_1.z.array(zod_1.z.string()).optional(),
+})
+    .strict()
+    .passthrough();
+const SearchFilter = zod_1.z
+    .object({
+    metadata: zod_1.z.array(SearchFilterCriteria),
+    video_info: zod_1.z.array(SearchFilterCriteria.and(zod_1.z
+        .object({ path: zod_1.z.enum(["duration_seconds", "has_audio"]) })
+        .partial()
+        .strict()
+        .passthrough())),
+    file: zod_1.z.array(SearchFilterCriteria.and(zod_1.z
+        .object({
+        path: zod_1.z.enum(["bytes", "filename", "uri", "created_at", "id"]),
+    })
+        .partial()
+        .strict()
+        .passthrough())),
+})
+    .partial()
+    .strict()
+    .passthrough();
+const SearchRequest = zod_1.z
+    .object({
+    scope: zod_1.z.enum(["file", "segment"]),
+    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(),
+})
+    .strict()
+    .passthrough();
+const FileSearchResult = zod_1.z
+    .object({
+    type: zod_1.z.literal("file"),
+    file_id: zod_1.z.string().uuid(),
+    collection_id: zod_1.z.string().uuid(),
+    id: zod_1.z.string().uuid(),
+    score: zod_1.z.number().gte(0).lte(1),
+    filename: zod_1.z.string().nullish(),
+    summary: zod_1.z.string().nullish(),
+    generated_title: zod_1.z.string().nullish(),
+})
+    .strict()
+    .passthrough();
+const SegmentSearchResult = zod_1.z
+    .object({
+    type: zod_1.z.literal("segment"),
+    file_id: zod_1.z.string().uuid(),
+    collection_id: zod_1.z.string().uuid(),
+    segment_id: zod_1.z.string().uuid(),
+    id: zod_1.z.string().uuid(),
+    score: zod_1.z.number().gte(0).lte(1),
+    start_time: zod_1.z.number(),
+    end_time: zod_1.z.number(),
+    title: zod_1.z.string().nullish(),
+    filename: zod_1.z.string().nullish(),
+    visual_description: zod_1.z
+        .array(zod_1.z
+        .object({
+        text: zod_1.z.string(),
+        start_time: zod_1.z.number(),
+        end_time: zod_1.z.number(),
+    })
+        .partial()
+        .strict()
+        .passthrough())
+        .optional(),
+    scene_text: zod_1.z
+        .array(zod_1.z
+        .object({
+        text: zod_1.z.string(),
+        start_time: zod_1.z.number(),
+        end_time: zod_1.z.number(),
+    })
+        .partial()
+        .strict()
+        .passthrough())
+        .optional(),
+    speech: zod_1.z
+        .array(zod_1.z
+        .object({
+        text: zod_1.z.string(),
+        start_time: zod_1.z.number(),
+        end_time: zod_1.z.number(),
+    })
+        .partial()
+        .strict()
+        .passthrough())
+        .optional(),
+})
+    .strict()
+    .passthrough();
+const SearchResponse = zod_1.z
+    .object({
+    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])),
+    total: zod_1.z.number().int(),
+    limit: zod_1.z.number().int(),
+})
+    .strict()
+    .passthrough();
+exports.schemas = {
+    SearchFilterCriteria,
+    SearchFilter,
+    SearchRequest,
+    FileSearchResult,
+    SegmentSearchResult,
+    SearchResponse,
+};
+const endpoints = (0, core_1.makeApi)([
+    {
+        method: "post",
+        path: "/search",
+        alias: "searchContent",
+        description: `Search for videos or video segments in collections to find relevant videos or moments/clips in a video. Supports filtering by metadata, video info, and file properties.
+
+**Important:** Currently only rich-transcript collections support search. For file-level search (scope='file'), the collection must be configured with 'enable_summary: true' in the transcribe_config.`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "body",
+                description: `Search parameters`,
+                type: "Body",
+                schema: SearchRequest,
+            },
+        ],
+        response: SearchResponse,
+        errors: [
+            {
+                status: 400,
+                description: `Invalid request parameters`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+            {
+                status: 404,
+                description: `Collection 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.SearchApi = new core_1.Zodios("https://api.cloudglue.dev/v1", endpoints);
+function createApiClient(baseUrl, options) {
+    return new core_1.Zodios(baseUrl, endpoints, options);
+}