@aviaryhq/cloudglue-js 0.5.9 → 0.6.0

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

@@ -205,7 +205,7 @@ export declare class EnhancedFilesApi {
         created_at: import("zod").ZodNumber;
         file_id: import("zod").ZodString;
         segmentation_config: import("zod").ZodObject<{
-            strategy: import("zod").ZodEnum<["uniform", "shot-detector", "manual"]>;
+            strategy: import("zod").ZodEnum<["uniform", "shot-detector", "manual", "narrative"]>;
             uniform_config: import("zod").ZodOptional<import("zod").ZodObject<{
                 window_seconds: import("zod").ZodNumber;
                 hop_seconds: import("zod").ZodOptional<import("zod").ZodNumber>;
@@ -266,6 +266,25 @@ export declare class EnhancedFilesApi {
                     end_time: import("zod").ZodOptional<import("zod").ZodNumber>;
                 }, import("zod").ZodTypeAny, "passthrough">>, "many">;
             }, import("zod").ZodTypeAny, "passthrough">>>;
+            narrative_config: import("zod").ZodOptional<import("zod").ZodObject<{
+                prompt: import("zod").ZodOptional<import("zod").ZodString>;
+                strategy: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["comprehensive", "balanced"]>>>;
+                number_of_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                min_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                max_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+            }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
+                prompt: import("zod").ZodOptional<import("zod").ZodString>;
+                strategy: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["comprehensive", "balanced"]>>>;
+                number_of_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                min_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                max_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+            }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
+                prompt: import("zod").ZodOptional<import("zod").ZodString>;
+                strategy: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["comprehensive", "balanced"]>>>;
+                number_of_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                min_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                max_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+            }, import("zod").ZodTypeAny, "passthrough">>>;
             keyframe_config: import("zod").ZodOptional<import("zod").ZodObject<{
                 frames_per_segment: import("zod").ZodNumber;
                 max_width: import("zod").ZodDefault<import("zod").ZodOptional<import("zod").ZodNumber>>;
@@ -279,7 +298,7 @@ export declare class EnhancedFilesApi {
             start_time_seconds: import("zod").ZodOptional<import("zod").ZodNumber>;
             end_time_seconds: import("zod").ZodOptional<import("zod").ZodNumber>;
         }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
-            strategy: import("zod").ZodEnum<["uniform", "shot-detector", "manual"]>;
+            strategy: import("zod").ZodEnum<["uniform", "shot-detector", "manual", "narrative"]>;
             uniform_config: import("zod").ZodOptional<import("zod").ZodObject<{
                 window_seconds: import("zod").ZodNumber;
                 hop_seconds: import("zod").ZodOptional<import("zod").ZodNumber>;
@@ -340,6 +359,25 @@ export declare class EnhancedFilesApi {
                     end_time: import("zod").ZodOptional<import("zod").ZodNumber>;
                 }, import("zod").ZodTypeAny, "passthrough">>, "many">;
             }, import("zod").ZodTypeAny, "passthrough">>>;
+            narrative_config: import("zod").ZodOptional<import("zod").ZodObject<{
+                prompt: import("zod").ZodOptional<import("zod").ZodString>;
+                strategy: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["comprehensive", "balanced"]>>>;
+                number_of_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                min_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                max_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+            }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
+                prompt: import("zod").ZodOptional<import("zod").ZodString>;
+                strategy: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["comprehensive", "balanced"]>>>;
+                number_of_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                min_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                max_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+            }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
+                prompt: import("zod").ZodOptional<import("zod").ZodString>;
+                strategy: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["comprehensive", "balanced"]>>>;
+                number_of_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                min_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                max_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+            }, import("zod").ZodTypeAny, "passthrough">>>;
             keyframe_config: import("zod").ZodOptional<import("zod").ZodObject<{
                 frames_per_segment: import("zod").ZodNumber;
                 max_width: import("zod").ZodDefault<import("zod").ZodOptional<import("zod").ZodNumber>>;
@@ -353,7 +391,7 @@ export declare class EnhancedFilesApi {
             start_time_seconds: import("zod").ZodOptional<import("zod").ZodNumber>;
             end_time_seconds: import("zod").ZodOptional<import("zod").ZodNumber>;
         }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
-            strategy: import("zod").ZodEnum<["uniform", "shot-detector", "manual"]>;
+            strategy: import("zod").ZodEnum<["uniform", "shot-detector", "manual", "narrative"]>;
             uniform_config: import("zod").ZodOptional<import("zod").ZodObject<{
                 window_seconds: import("zod").ZodNumber;
                 hop_seconds: import("zod").ZodOptional<import("zod").ZodNumber>;
@@ -414,6 +452,25 @@ export declare class EnhancedFilesApi {
                     end_time: import("zod").ZodOptional<import("zod").ZodNumber>;
                 }, import("zod").ZodTypeAny, "passthrough">>, "many">;
             }, import("zod").ZodTypeAny, "passthrough">>>;
+            narrative_config: import("zod").ZodOptional<import("zod").ZodObject<{
+                prompt: import("zod").ZodOptional<import("zod").ZodString>;
+                strategy: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["comprehensive", "balanced"]>>>;
+                number_of_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                min_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                max_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+            }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
+                prompt: import("zod").ZodOptional<import("zod").ZodString>;
+                strategy: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["comprehensive", "balanced"]>>>;
+                number_of_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                min_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                max_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+            }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
+                prompt: import("zod").ZodOptional<import("zod").ZodString>;
+                strategy: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["comprehensive", "balanced"]>>>;
+                number_of_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                min_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+                max_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
+            }, import("zod").ZodTypeAny, "passthrough">>>;
             keyframe_config: import("zod").ZodOptional<import("zod").ZodObject<{
                 frames_per_segment: import("zod").ZodNumber;
                 max_width: import("zod").ZodDefault<import("zod").ZodOptional<import("zod").ZodNumber>>;
@@ -436,6 +493,7 @@ export declare class EnhancedFilesApi {
         }, import("zod").ZodTypeAny, "passthrough">>;
         total_segments: import("zod").ZodOptional<import("zod").ZodNumber>;
         total_shots: import("zod").ZodOptional<import("zod").ZodNumber>;
+        total_chapters: import("zod").ZodOptional<import("zod").ZodNumber>;
         data: import("zod").ZodOptional<import("zod").ZodObject<{
             object: import("zod").ZodLiteral<"list">;
             segments: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
@@ -467,6 +525,22 @@ export declare class EnhancedFilesApi {
                 start_time: import("zod").ZodNumber;
                 end_time: import("zod").ZodNumber;
             }, import("zod").ZodTypeAny, "passthrough">>, "many">>;
+            chapters: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
+                index: import("zod").ZodNumber;
+                start_time: import("zod").ZodNumber;
+                end_time: import("zod").ZodNumber;
+                description: import("zod").ZodString;
+            }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
+                index: import("zod").ZodNumber;
+                start_time: import("zod").ZodNumber;
+                end_time: import("zod").ZodNumber;
+                description: import("zod").ZodString;
+            }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
+                index: import("zod").ZodNumber;
+                start_time: import("zod").ZodNumber;
+                end_time: import("zod").ZodNumber;
+                description: import("zod").ZodString;
+            }, import("zod").ZodTypeAny, "passthrough">>, "many">>;
             total: import("zod").ZodNumber;
             limit: import("zod").ZodNumber;
             offset: import("zod").ZodNumber;
@@ -501,6 +575,22 @@ export declare class EnhancedFilesApi {
                 start_time: import("zod").ZodNumber;
                 end_time: import("zod").ZodNumber;
             }, import("zod").ZodTypeAny, "passthrough">>, "many">>;
+            chapters: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
+                index: import("zod").ZodNumber;
+                start_time: import("zod").ZodNumber;
+                end_time: import("zod").ZodNumber;
+                description: import("zod").ZodString;
+            }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
+                index: import("zod").ZodNumber;
+                start_time: import("zod").ZodNumber;
+                end_time: import("zod").ZodNumber;
+                description: import("zod").ZodString;
+            }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
+                index: import("zod").ZodNumber;
+                start_time: import("zod").ZodNumber;
+                end_time: import("zod").ZodNumber;
+                description: import("zod").ZodString;
+            }, import("zod").ZodTypeAny, "passthrough">>, "many">>;
             total: import("zod").ZodNumber;
             limit: import("zod").ZodNumber;
             offset: import("zod").ZodNumber;
@@ -535,6 +625,22 @@ export declare class EnhancedFilesApi {
                 start_time: import("zod").ZodNumber;
                 end_time: import("zod").ZodNumber;
             }, import("zod").ZodTypeAny, "passthrough">>, "many">>;
+            chapters: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
+                index: import("zod").ZodNumber;
+                start_time: import("zod").ZodNumber;
+                end_time: import("zod").ZodNumber;
+                description: import("zod").ZodString;
+            }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
+                index: import("zod").ZodNumber;
+                start_time: import("zod").ZodNumber;
+                end_time: import("zod").ZodNumber;
+                description: import("zod").ZodString;
+            }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
+                index: import("zod").ZodNumber;
+                start_time: import("zod").ZodNumber;
+                end_time: import("zod").ZodNumber;
+                description: import("zod").ZodString;
+            }, import("zod").ZodTypeAny, "passthrough">>, "many">>;
             total: import("zod").ZodNumber;
             limit: import("zod").ZodNumber;
             offset: import("zod").ZodNumber;
@@ -740,6 +846,133 @@ export declare class EnhancedFilesApi {
         limit: number;
         offset: number;
     }>;
+    /**
+     * List all describe outputs for a specific file segment
+     * @param fileId - The ID of the file
+     * @param segmentId - The ID of the segment
+     * @param params - Optional parameters for filtering and pagination
+     * @returns List of describe outputs for the segment
+     */
+    listFileSegmentDescribes(fileId: string, segmentId: string, params?: {
+        status?: string;
+        response_format?: 'json' | 'markdown';
+        include_data?: boolean;
+        limit?: number;
+        offset?: number;
+    }): Promise<{
+        object: "list";
+        data: Array<{
+            job_id: string;
+            segment_id: string;
+            status: "pending" | "processing" | "completed" | "failed" | "not_applicable";
+            describe_config: Partial<{
+                enable_summary: boolean;
+                enable_speech: boolean;
+                enable_visual_scene_description: boolean;
+                enable_scene_text: boolean;
+                enable_audio_description: boolean;
+            }>;
+            created_at: number;
+            completed_at?: number | undefined;
+            start_time: number;
+            end_time: number;
+            file_id: string;
+            segmentation_id?: string | undefined;
+            data?: (Partial<{
+                visual_scene_description: Array<{
+                    text: string;
+                    start_time: number;
+                    end_time: number;
+                }>;
+                speech: Array<{
+                    text: string;
+                    start_time: number;
+                    end_time: number;
+                    speaker?: string | undefined;
+                }>;
+                scene_text: Array<{
+                    text: string;
+                    start_time: number;
+                    end_time: number;
+                }>;
+                audio_description: Array<{
+                    text: string;
+                    start_time: number;
+                    end_time: number;
+                }>;
+                title: string;
+                summary: string;
+                start_time: number;
+                end_time: number;
+                segment_id: string;
+            }> | {
+                content: string;
+            }) | undefined;
+            object: "segment_describe";
+        }>;
+        total: number;
+        limit: number;
+        offset: number;
+    }>;
+    /**
+     * Get a specific describe output for a file segment by job ID
+     * @param fileId - The ID of the file
+     * @param segmentId - The ID of the segment
+     * @param jobId - The ID of the describe job
+     * @param params - Optional parameters
+     * @returns The describe output for the segment
+     */
+    getFileSegmentDescribe(fileId: string, segmentId: string, jobId: string, params?: {
+        response_format?: 'json' | 'markdown';
+    }): Promise<{
+        job_id: string;
+        segment_id: string;
+        status: "pending" | "processing" | "completed" | "failed" | "not_applicable";
+        describe_config: Partial<{
+            enable_summary: boolean;
+            enable_speech: boolean;
+            enable_visual_scene_description: boolean;
+            enable_scene_text: boolean;
+            enable_audio_description: boolean;
+        }>;
+        created_at: number;
+        completed_at?: number | undefined;
+        start_time: number;
+        end_time: number;
+        file_id: string;
+        segmentation_id?: string | undefined;
+        data?: (Partial<{
+            visual_scene_description: Array<{
+                text: string;
+                start_time: number;
+                end_time: number;
+            }>;
+            speech: Array<{
+                text: string;
+                start_time: number;
+                end_time: number;
+                speaker?: string | undefined;
+            }>;
+            scene_text: Array<{
+                text: string;
+                start_time: number;
+                end_time: number;
+            }>;
+            audio_description: Array<{
+                text: string;
+                start_time: number;
+                end_time: number;
+            }>;
+            title: string;
+            summary: string;
+            start_time: number;
+            end_time: number;
+            segment_id: string;
+        }> | {
+            content: string;
+        }) | undefined;
+        object: "segment_describe";
+    }>;
     /**
      * Waits for a file to finish processing by polling the getFile endpoint until the file
      * reaches a terminal state (completed, failed, or not_applicable) or until maxAttempts is reached.

package/dist/src/api/files.api.js

@@ -121,6 +121,33 @@ class EnhancedFilesApi {
             queries: params,
         });
     }
+    /**
+     * List all describe outputs for a specific file segment
+     * @param fileId - The ID of the file
+     * @param segmentId - The ID of the segment
+     * @param params - Optional parameters for filtering and pagination
+     * @returns List of describe outputs for the segment
+     */
+    async listFileSegmentDescribes(fileId, segmentId, params = {}) {
+        return this.api.listFileSegmentDescribes({
+            params: { file_id: fileId, segment_id: segmentId },
+            queries: params,
+        });
+    }
+    /**
+     * Get a specific describe output for a file segment by job ID
+     * @param fileId - The ID of the file
+     * @param segmentId - The ID of the segment
+     * @param jobId - The ID of the describe job
+     * @param params - Optional parameters
+     * @returns The describe output for the segment
+     */
+    async getFileSegmentDescribe(fileId, segmentId, jobId, params = {}) {
+        return this.api.getFileSegmentDescribe({
+            params: { file_id: fileId, segment_id: segmentId, job_id: jobId },
+            queries: params,
+        });
+    }
     /**
      * Waits for a file to finish processing by polling the getFile endpoint until the file
      * reaches a terminal state (completed, failed, or not_applicable) or until maxAttempts is reached.

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

@@ -0,0 +1,269 @@
+import { ResponseApi } from '../../generated';
+import { WaitForReadyOptions } from '../types';
+type ResponseStatus = 'in_progress' | 'completed' | 'failed' | 'cancelled';
+export interface CreateResponseParams {
+    /** The model to use for the response */
+    model: 'nimbus-001';
+    /** The input message(s) - can be a simple string or array of structured messages */
+    input: string | Array<{
+        type: 'message';
+        role: 'developer' | 'user' | 'assistant';
+        content: Array<{
+            type: 'input_text';
+            text: string;
+        }>;
+    }>;
+    /** Optional system instructions */
+    instructions?: string;
+    /** Temperature for response generation (0-2, default 0.7) */
+    temperature?: number;
+    /** Knowledge base configuration specifying collections to search */
+    knowledge_base: {
+        collections: string[];
+        filter?: {
+            file_ids?: string[];
+        };
+    };
+    /** Include additional data in response annotations */
+    include?: Array<'cloudglue_citations.media_descriptions'>;
+    /** Run the response generation in background (async) */
+    background?: boolean;
+}
+export interface ListResponsesParams {
+    limit?: number;
+    offset?: number;
+    status?: ResponseStatus;
+    created_before?: string;
+    created_after?: string;
+}
+export declare class EnhancedResponseApi {
+    private readonly api;
+    constructor(api: typeof ResponseApi);
+    /**
+     * Create a new response using the Response API.
+     * This provides an OpenAI Responses-compatible interface for chat completions with video collections.
+     *
+     * @param params - Response creation parameters
+     * @returns The created response
+     */
+    createResponse(params: CreateResponseParams): Promise<Partial<{
+        id: string;
+        object: "response";
+        status: "in_progress" | "completed" | "failed" | "cancelled";
+        created_at: number;
+        model: string;
+        instructions: string | null;
+        output: Array<Partial<{
+            type: "message";
+            role: "assistant";
+            content: Array<Partial<{
+                type: "output_text";
+                text: string;
+                annotations: Array<Partial<{
+                    type: "cloudglue_citation";
+                    collection_id: string;
+                    file_id: string;
+                    segment_id: string;
+                    start_time: number;
+                    end_time: number;
+                    context: string;
+                    relevant_sources: Array<string>;
+                    visual_scene_description: Array<string>;
+                    scene_text: Array<string>;
+                    speech: Array<string>;
+                    audio_description: Array<string>;
+                }>>;
+            }>>;
+        }>> | null;
+        usage: Partial<{
+            input_tokens: number;
+            output_tokens: number;
+            total_tokens: number;
+        }>;
+        error: Partial<{
+            message: string;
+            type: string;
+            code: string;
+        }> | null;
+    }>>;
+    /**
+     * List all responses with pagination and filtering options.
+     *
+     * @param params - Optional pagination and filtering parameters
+     * @returns Paginated list of responses
+     */
+    listResponses(params?: ListResponsesParams): Promise<Partial<{
+        object: "list";
+        data: Array<Partial<{
+            id: string;
+            object: "response";
+            status: "in_progress" | "completed" | "failed" | "cancelled";
+            created_at: number;
+            model: string;
+            instructions: string | null;
+            usage: Partial<{
+                input_tokens: number;
+                output_tokens: number;
+                total_tokens: number;
+            }>;
+        }>>;
+        total: number;
+        limit: number;
+        offset: number;
+    }>>;
+    /**
+     * Retrieve a specific response by its ID.
+     *
+     * @param responseId - The ID of the response to retrieve
+     * @returns The response object
+     */
+    getResponse(responseId: string): Promise<Partial<{
+        id: string;
+        object: "response";
+        status: "in_progress" | "completed" | "failed" | "cancelled";
+        created_at: number;
+        model: string;
+        instructions: string | null;
+        output: Array<Partial<{
+            type: "message";
+            role: "assistant";
+            content: Array<Partial<{
+                type: "output_text";
+                text: string;
+                annotations: Array<Partial<{
+                    type: "cloudglue_citation";
+                    collection_id: string;
+                    file_id: string;
+                    segment_id: string;
+                    start_time: number;
+                    end_time: number;
+                    context: string;
+                    relevant_sources: Array<string>;
+                    visual_scene_description: Array<string>;
+                    scene_text: Array<string>;
+                    speech: Array<string>;
+                    audio_description: Array<string>;
+                }>>;
+            }>>;
+        }>> | null;
+        usage: Partial<{
+            input_tokens: number;
+            output_tokens: number;
+            total_tokens: number;
+        }>;
+        error: Partial<{
+            message: string;
+            type: string;
+            code: string;
+        }> | null;
+    }>>;
+    /**
+     * Delete a response by ID.
+     * This operation is idempotent - deleting a non-existent response returns success.
+     *
+     * @param responseId - The ID of the response to delete
+     * @returns Deletion confirmation
+     */
+    deleteResponse(responseId: string): Promise<import("zod").objectOutputType<{
+        id: import("zod").ZodOptional<import("zod").ZodString>;
+        object: import("zod").ZodOptional<import("zod").ZodLiteral<"response">>;
+        deleted: import("zod").ZodOptional<import("zod").ZodLiteral<true>>;
+    }, import("zod").ZodTypeAny, "passthrough">>;
+    /**
+     * Cancel a background response that is in progress.
+     * If the response is already completed, failed, or cancelled, this returns the response as-is.
+     *
+     * @param responseId - The ID of the response to cancel
+     * @returns The response object
+     */
+    cancelResponse(responseId: string): Promise<Partial<{
+        id: string;
+        object: "response";
+        status: "in_progress" | "completed" | "failed" | "cancelled";
+        created_at: number;
+        model: string;
+        instructions: string | null;
+        output: Array<Partial<{
+            type: "message";
+            role: "assistant";
+            content: Array<Partial<{
+                type: "output_text";
+                text: string;
+                annotations: Array<Partial<{
+                    type: "cloudglue_citation";
+                    collection_id: string;
+                    file_id: string;
+                    segment_id: string;
+                    start_time: number;
+                    end_time: number;
+                    context: string;
+                    relevant_sources: Array<string>;
+                    visual_scene_description: Array<string>;
+                    scene_text: Array<string>;
+                    speech: Array<string>;
+                    audio_description: Array<string>;
+                }>>;
+            }>>;
+        }>> | null;
+        usage: Partial<{
+            input_tokens: number;
+            output_tokens: number;
+            total_tokens: number;
+        }>;
+        error: Partial<{
+            message: string;
+            type: string;
+            code: string;
+        }> | null;
+    }>>;
+    /**
+     * Waits for a background response to complete by polling until it reaches
+     * a terminal state (completed, failed, or cancelled) or until maxAttempts is reached.
+     *
+     * @param responseId - The ID of the response to wait for
+     * @param options - Optional configuration for polling behavior
+     * @returns The final response object
+     * @throws {CloudGlueError} If the response fails or maxAttempts is reached
+     */
+    waitForReady(responseId: string, options?: WaitForReadyOptions): Promise<Partial<{
+        id: string;
+        object: "response";
+        status: "in_progress" | "completed" | "failed" | "cancelled";
+        created_at: number;
+        model: string;
+        instructions: string | null;
+        output: Array<Partial<{
+            type: "message";
+            role: "assistant";
+            content: Array<Partial<{
+                type: "output_text";
+                text: string;
+                annotations: Array<Partial<{
+                    type: "cloudglue_citation";
+                    collection_id: string;
+                    file_id: string;
+                    segment_id: string;
+                    start_time: number;
+                    end_time: number;
+                    context: string;
+                    relevant_sources: Array<string>;
+                    visual_scene_description: Array<string>;
+                    scene_text: Array<string>;
+                    speech: Array<string>;
+                    audio_description: Array<string>;
+                }>>;
+            }>>;
+        }>> | null;
+        usage: Partial<{
+            input_tokens: number;
+            output_tokens: number;
+            total_tokens: number;
+        }>;
+        error: Partial<{
+            message: string;
+            type: string;
+            code: string;
+        }> | null;
+    }>>;
+}
+export {};