@aviaryhq/cloudglue-js 0.5.9 → 0.6.0

package/dist/src/api/segmentations.api.js

@@ -32,5 +32,18 @@ class EnhancedSegmentationsApi {
             },
         });
     }
+    /**
+     * List all describe jobs that referenced the specified segmentation.
+     * Returns describe job records associated with the segmentation.
+     * @param segmentationId - The ID of the segmentation
+     * @param params - Optional parameters for filtering and pagination
+     * @returns List of describe jobs for the segmentation
+     */
+    async listSegmentationDescribes(segmentationId, params = {}) {
+        return this.api.listSegmentationDescribes({
+            params: { segmentation_id: segmentationId },
+            queries: params,
+        });
+    }
 }
 exports.EnhancedSegmentationsApi = EnhancedSegmentationsApi;

package/dist/src/api/segments.api.d.ts

@@ -28,13 +28,7 @@ export declare class EnhancedSegmentsApi {
                 max_duration_seconds: number;
                 min_duration_seconds: number;
             }> | undefined;
-            narrative_config?: Partial<{
-                prompt: string;
-                strategy: "comprehensive" | "balanced";
-                number_of_chapters: number;
-                min_chapters: number;
-                max_chapters: number;
-            }> | undefined;
+            narrative_config?: import("../../generated/common").NarrativeConfig | undefined;
         }>;
         total: number;
         limit: number;
@@ -52,15 +46,10 @@ export declare class EnhancedSegmentsApi {
             max_duration_seconds: number;
             min_duration_seconds: number;
         }> | undefined;
-        narrative_config?: Partial<{
-            prompt: string;
-            strategy: "comprehensive" | "balanced";
-            number_of_chapters: number;
-            min_chapters: number;
-            max_chapters: number;
-        }> | undefined;
+        narrative_config?: import("../../generated/common").NarrativeConfig | undefined;
         total_segments?: number | undefined;
         total_shots?: number | undefined;
+        total_chapters?: number | undefined;
         segments?: Array<{
             start_time: number;
             end_time: number;
@@ -69,6 +58,7 @@ export declare class EnhancedSegmentsApi {
             shot_index?: number | undefined;
         }> | undefined;
         shots?: Array<import("../../generated/common").Shot> | undefined;
+        chapters?: Array<import("../../generated/common").Chapter> | undefined;
     }>;
     createSegmentJob(params: {
         url: string;
@@ -87,15 +77,10 @@ export declare class EnhancedSegmentsApi {
             max_duration_seconds: number;
             min_duration_seconds: number;
         }> | undefined;
-        narrative_config?: Partial<{
-            prompt: string;
-            strategy: "comprehensive" | "balanced";
-            number_of_chapters: number;
-            min_chapters: number;
-            max_chapters: number;
-        }> | undefined;
+        narrative_config?: import("../../generated/common").NarrativeConfig | undefined;
         total_segments?: number | undefined;
         total_shots?: number | undefined;
+        total_chapters?: number | undefined;
         segments?: Array<{
             start_time: number;
             end_time: number;
@@ -104,6 +89,7 @@ export declare class EnhancedSegmentsApi {
             shot_index?: number | undefined;
         }> | undefined;
         shots?: Array<import("../../generated/common").Shot> | undefined;
+        chapters?: Array<import("../../generated/common").Chapter> | undefined;
     }>;
     deleteSegmentJob(jobId: string): Promise<import("zod").objectOutputType<{
         id: import("zod").ZodString;
@@ -120,15 +106,10 @@ export declare class EnhancedSegmentsApi {
             max_duration_seconds: number;
             min_duration_seconds: number;
         }> | undefined;
-        narrative_config?: Partial<{
-            prompt: string;
-            strategy: "comprehensive" | "balanced";
-            number_of_chapters: number;
-            min_chapters: number;
-            max_chapters: number;
-        }> | undefined;
+        narrative_config?: import("../../generated/common").NarrativeConfig | undefined;
         total_segments?: number | undefined;
         total_shots?: number | undefined;
+        total_chapters?: number | undefined;
         segments?: Array<{
             start_time: number;
             end_time: number;
@@ -137,5 +118,6 @@ export declare class EnhancedSegmentsApi {
             shot_index?: number | undefined;
         }> | undefined;
         shots?: Array<import("../../generated/common").Shot> | undefined;
+        chapters?: Array<import("../../generated/common").Chapter> | undefined;
     }>;
 }

package/dist/src/client.d.ts

@@ -14,6 +14,7 @@ import { EnhancedTranscribeApi } from './api/transcribe.api';
 import { EnhancedChatApi } from './api/chat-completion.api';
 import { EnhancedCollectionsApi } from './api/collections.api';
 import { EnhancedShareableApi } from './api/shareable.api';
+import { EnhancedResponseApi } from './api/response.api';
 /**
  * Main CloudGlue client class that provides access to all API functionality
  * through enhanced, user-friendly interfaces
@@ -93,5 +94,10 @@ export declare class CloudGlue {
      * Provides methods for creating and managing shareable assets
      */
     readonly shareable: EnhancedShareableApi;
+    /**
+     * Response API for OpenAI Responses-compatible chat completions
+     * Provides methods for creating and managing responses with video collections
+     */
+    readonly responses: EnhancedResponseApi;
     constructor(config?: CloudGlueConfig);
 }

package/dist/src/client.js

@@ -16,6 +16,7 @@ const Face_Detection_1 = require("../generated/Face_Detection");
 const Face_Match_1 = require("../generated/Face_Match");
 const Tags_1 = require("../generated/Tags");
 const Share_1 = require("../generated/Share");
+const Response_1 = require("../generated/Response");
 const webhooks_api_1 = require("./api/webhooks.api");
 const tags_api_1 = require("./api/tags.api");
 const error_1 = require("./error");
@@ -32,6 +33,7 @@ const transcribe_api_1 = require("./api/transcribe.api");
 const chat_completion_api_1 = require("./api/chat-completion.api");
 const collections_api_1 = require("./api/collections.api");
 const shareable_api_1 = require("./api/shareable.api");
+const response_api_1 = require("./api/response.api");
 /**
  * Main CloudGlue client class that provides access to all API functionality
  * through enhanced, user-friendly interfaces
@@ -48,7 +50,7 @@ class CloudGlue {
             headers: {
                 Authorization: `Bearer ${this.apiKey}`,
                 'x-sdk-client': 'cloudglue-js',
-                'x-sdk-version': '0.5.9',
+                'x-sdk-version': '0.6.0',
             },
             baseURL: this.baseUrl,
             timeout: this.timeout,
@@ -75,6 +77,7 @@ class CloudGlue {
         const webhooksApi = (0, Webhooks_1.createApiClient)(this.baseUrl, sharedConfig);
         const tagsApi = (0, Tags_1.createApiClient)(this.baseUrl, sharedConfig);
         const shareableApi = (0, Share_1.createApiClient)(this.baseUrl, sharedConfig);
+        const responseApi = (0, Response_1.createApiClient)(this.baseUrl, sharedConfig);
         // Configure base URL and axios config for all clients
         [
             filesApi,
@@ -92,6 +95,7 @@ class CloudGlue {
             webhooksApi,
             tagsApi,
             shareableApi,
+            responseApi,
         ].forEach((client) => {
             Object.assign(client.axios.defaults, axiosConfig);
             client.axios.interceptors.response.use((response) => {
@@ -126,6 +130,7 @@ class CloudGlue {
         this.webhooks = new webhooks_api_1.EnhancedWebhooksApi(webhooksApi);
         this.tags = new tags_api_1.EnhancedTagsApi(tagsApi);
         this.shareable = new shareable_api_1.EnhancedShareableApi(shareableApi);
+        this.responses = new response_api_1.EnhancedResponseApi(responseApi);
     }
 }
 exports.CloudGlue = CloudGlue;

package/dist/src/types.d.ts

@@ -5,9 +5,8 @@ import { schemas as chatSchemas } from '../generated/Chat';
 import { schemas as transcribeSchemas } from '../generated/Transcribe';
 import { schemas as extractSchemas } from '../generated/Extract';
 import { schemas as searchSchemas } from '../generated/Search';
-import { schemas as describeSchemas } from '../generated/Describe';
 import { schemas as segmentsSchemas } from '../generated/Segments';
-import { SegmentationUniformConfig as SegmentationUniformConfigType, SegmentationShotDetectorConfig as SegmentationShotDetectorConfigType, SegmentationConfig as SegmentationConfigType } from '../generated/common';
+import { SegmentationUniformConfig as SegmentationUniformConfigType, SegmentationShotDetectorConfig as SegmentationShotDetectorConfigType, SegmentationConfig as SegmentationConfigType, NarrativeConfig as NarrativeConfigType, Chapter as ChapterType, Describe as DescribeType, DescribeList as DescribeListType } from '../generated/common';
 import { schemas as webhooksSchemas } from '../generated/Webhooks';
 import { FrameExtraction } from '../generated/common';
 import { schemas as faceDetectionSchemas } from '../generated/Face_Detection';
@@ -153,11 +152,11 @@ export type SearchFilter = z.infer<typeof searchSchemas.SearchRequest>['filter']
  * Represents the result of a video description request
  * Contains detailed information about the video content including speech, text, and visual descriptions
  */
-export type Describe = z.infer<typeof describeSchemas.Describe>;
+export type Describe = z.infer<typeof DescribeType>;
 /**
  * Represents a list of description jobs
  */
-export type DescribeList = z.infer<typeof describeSchemas.DescribeList>;
+export type DescribeList = z.infer<typeof DescribeListType>;
 /**
  * Represents media description data for a video in a collection
  */
@@ -170,7 +169,12 @@ export type CollectionMediaDescriptionsList = z.infer<typeof collectionsSchemas.
  * 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 NarrativeConfig = z.infer<typeof NarrativeConfigType>;
+/**
+ * Represents a chapter within a narrative segmentation
+ * Contains timing and description information for the chapter
+ */
+export type Chapter = z.infer<typeof ChapterType>;
 export type ShotConfig = z.infer<typeof segmentsSchemas.ShotConfig>;
 export type WebhookEvents = z.infer<(typeof webhooksSchemas)['WebhookEvents']>;
 /**
@@ -274,3 +278,36 @@ export type ShareableAssetListResponse = z.infer<typeof shareableSchemas.Shareab
 export type CreateShareableAssetRequest = z.infer<typeof shareableSchemas.CreateShareableAssetRequest>;
 export type UpdateShareableAssetRequest = z.infer<typeof shareableSchemas.UpdateShareableAssetRequest>;
 export type Modalities = 'speech' | 'visual_scene_description' | 'scene_text' | 'audio_description' | 'summary' | 'segment_summary' | 'title';
+import { schemas as responseSchemas } from '../generated/Response';
+/**
+ * Represents a Response API response object
+ */
+export type Response = z.infer<typeof responseSchemas.Response>;
+/**
+ * Represents a list of Response API responses
+ */
+export type ResponseList = z.infer<typeof responseSchemas.ResponseList>;
+/**
+ * Represents a Response API list item (without full output data)
+ */
+export type ResponseListItem = z.infer<typeof responseSchemas.ResponseListItem>;
+/**
+ * Represents a Response API input message
+ */
+export type ResponseInputMessage = z.infer<typeof responseSchemas.ResponseInputMessage>;
+/**
+ * Represents a Response API output message
+ */
+export type ResponseOutputMessage = z.infer<typeof responseSchemas.ResponseOutputMessage>;
+/**
+ * Represents a citation annotation in a Response API response
+ */
+export type ResponseAnnotation = z.infer<typeof responseSchemas.ResponseAnnotation>;
+/**
+ * Represents usage information for a Response API response
+ */
+export type ResponseUsage = z.infer<typeof responseSchemas.ResponseUsage>;
+/**
+ * Represents knowledge base configuration for the Response API
+ */
+export type ResponseKnowledgeBase = z.infer<typeof responseSchemas.ResponseKnowledgeBase>;

package/package.json

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