@mux/ai 0.1.2 → 0.1.3

package/dist/types-ktXDZ93V.d.ts

@@ -0,0 +1,137 @@
+import Mux from '@mux/mux-node';
+
+/**
+ * Shared credential bag for every workflow. Each property falls back to the
+ * corresponding environment variable when omitted.
+ */
+interface MuxAIConfig {
+    /** Override for the MUX_TOKEN_ID environment variable. */
+    muxTokenId?: string;
+    /** Override for the MUX_TOKEN_SECRET environment variable. */
+    muxTokenSecret?: string;
+    /** Mux signing key ID for signed playback IDs (defaults to the MUX_SIGNING_KEY environment variable). */
+    muxSigningKey?: string;
+    /** Mux signing key private key for signed playback IDs (defaults to the MUX_PRIVATE_KEY environment variable). */
+    muxPrivateKey?: string;
+    /** OpenAI API key (defaults to the OPENAI_API_KEY environment variable). */
+    openaiApiKey?: string;
+    /** Anthropic API key (defaults to the ANTHROPIC_API_KEY environment variable). */
+    anthropicApiKey?: string;
+    /** Google Generative AI API key (defaults to the GOOGLE_GENERATIVE_AI_API_KEY environment variable). */
+    googleApiKey?: string;
+    /** Hive Visual Moderation API key (defaults to the HIVE_API_KEY environment variable). */
+    hiveApiKey?: string;
+}
+/**
+ * Base options mixed into every higher-level workflow configuration.
+ */
+interface MuxAIOptions extends MuxAIConfig {
+    /** Optional timeout (ms) for helper utilities that support request limits. */
+    timeout?: number;
+    /**
+     * Optional cancellation signal passed through to underlying AI SDK calls.
+     * When aborted, in-flight model requests will be
+     * cancelled where supported.
+     */
+    abortSignal?: AbortSignal;
+}
+/** Tone controls for the summarization helper. */
+type ToneType = "normal" | "sassy" | "professional";
+/** Common transport for image-based workflows. */
+type ImageSubmissionMode = "url" | "base64";
+/** Result of calling mux-node's asset retrieval helper. */
+type MuxAsset = Awaited<ReturnType<Mux["video"]["assets"]["retrieve"]>>;
+/** Single ready track extracted from a Mux asset. */
+type AssetTextTrack = NonNullable<MuxAsset["tracks"]>[number];
+/** Playback policy type for Mux assets. */
+type PlaybackPolicy = "public" | "signed";
+/** Convenience bundle returned by `getPlaybackIdForAsset`. */
+interface PlaybackAsset {
+    asset: MuxAsset;
+    playbackId: string;
+    /** The policy type of the playback ID ('public' or 'signed'). */
+    policy: PlaybackPolicy;
+}
+/** Configuration for token-based chunking. */
+interface TokenChunkingConfig {
+    type: "token";
+    /** Maximum tokens per chunk. */
+    maxTokens: number;
+    /** Number of overlapping tokens between chunks. */
+    overlap?: number;
+}
+/** Configuration for VTT-aware chunking that respects cue boundaries. */
+interface VTTChunkingConfig {
+    type: "vtt";
+    /** Maximum tokens per chunk. */
+    maxTokens: number;
+    /** Number of cues to overlap between chunks (default: 2). */
+    overlapCues?: number;
+}
+/** Union type for all chunking strategy configurations. */
+type ChunkingStrategy = TokenChunkingConfig | VTTChunkingConfig;
+/** A single chunk of text extracted from a transcript. */
+interface TextChunk {
+    /** Unique identifier for this chunk. */
+    id: string;
+    /** The text content of the chunk. */
+    text: string;
+    /** Number of tokens in this chunk. */
+    tokenCount: number;
+    /** Start time in seconds (if available from timestamped transcript). */
+    startTime?: number;
+    /** End time in seconds (if available from timestamped transcript). */
+    endTime?: number;
+}
+/** A chunk with its embedding vector. */
+interface ChunkEmbedding {
+    /** Reference to the chunk ID. */
+    chunkId: string;
+    /** The embedding vector. */
+    embedding: number[];
+    /** Optional metadata for this chunk. */
+    metadata: {
+        startTime?: number;
+        endTime?: number;
+        tokenCount: number;
+    };
+}
+/** Result of generating embeddings for a video asset. */
+interface VideoEmbeddingsResult {
+    /** The Mux asset ID. */
+    assetId: string;
+    /** Individual chunk embeddings. */
+    chunks: ChunkEmbedding[];
+    /** Averaged embedding across all chunks. */
+    averagedEmbedding: number[];
+    /** AI provider used. */
+    provider: string;
+    /** Model used for embedding generation. */
+    model: string;
+    /** Additional metadata about the generation. */
+    metadata: {
+        totalChunks: number;
+        totalTokens: number;
+        chunkingStrategy: string;
+        embeddingDimensions: number;
+        generatedAt: string;
+    };
+}
+/**
+ * Token usage breakdown returned by AI SDK providers.
+ * Used for efficiency and cost analysis.
+ */
+interface TokenUsage {
+    /** Number of tokens in the input prompt (text + image). */
+    inputTokens?: number;
+    /** Number of tokens generated in the output. */
+    outputTokens?: number;
+    /** Total tokens consumed (input + output). */
+    totalTokens?: number;
+    /** Tokens used for chain-of-thought reasoning (if applicable). */
+    reasoningTokens?: number;
+    /** Input tokens served from cache (reduces cost). */
+    cachedInputTokens?: number;
+}
+
+export type { AssetTextTrack as A, ChunkingStrategy as C, ImageSubmissionMode as I, MuxAIConfig as M, PlaybackPolicy as P, ToneType as T, VTTChunkingConfig as V, MuxAIOptions as a, MuxAsset as b, PlaybackAsset as c, TokenChunkingConfig as d, TextChunk as e, ChunkEmbedding as f, VideoEmbeddingsResult as g, TokenUsage as h };

package/dist/workflows/index.d.mts

@@ -0,0 +1,8 @@
+export { z as AudioTranslationOptions, A as AudioTranslationResult, e as BurnedInCaptionsAnalysis, c as BurnedInCaptionsOptions, b as BurnedInCaptionsPromptOverrides, a as BurnedInCaptionsPromptSections, B as BurnedInCaptionsResult, C as Chapter, l as ChaptersOptions, k as ChaptersResult, j as ChaptersType, E as EmbeddingsOptions, p as HiveModerationOutput, H as HiveModerationSource, q as ModerationOptions, o as ModerationProvider, M as ModerationResult, S as SUMMARY_KEYWORD_LIMIT, x as SummarizationOptions, w as SummarizationPromptOverrides, v as SummarizationPromptSections, u as SummaryAndTagsResult, t as SummaryType, T as ThumbnailModerationScore, G as TranslationOptions, J as TranslationPayload, F as TranslationResult, d as burnedInCaptionsSchema, f as chapterSchema, g as chaptersSchema, m as generateChapters, n as generateVideoEmbeddings, r as getModerationScores, y as getSummaryAndTags, h as hasBurnedInCaptions, s as summarySchema, D as translateAudio, K as translateCaptions, I as translationSchema } from '../index-vJ5r2FNm.mjs';
+import 'zod';
+import '@ai-sdk/anthropic';
+import '@ai-sdk/google';
+import '@ai-sdk/openai';
+import '../types-ktXDZ93V.mjs';
+import '@mux/mux-node';
+import 'node:buffer';

package/dist/workflows/index.d.ts

@@ -0,0 +1,8 @@
+export { z as AudioTranslationOptions, A as AudioTranslationResult, e as BurnedInCaptionsAnalysis, c as BurnedInCaptionsOptions, b as BurnedInCaptionsPromptOverrides, a as BurnedInCaptionsPromptSections, B as BurnedInCaptionsResult, C as Chapter, l as ChaptersOptions, k as ChaptersResult, j as ChaptersType, E as EmbeddingsOptions, p as HiveModerationOutput, H as HiveModerationSource, q as ModerationOptions, o as ModerationProvider, M as ModerationResult, S as SUMMARY_KEYWORD_LIMIT, x as SummarizationOptions, w as SummarizationPromptOverrides, v as SummarizationPromptSections, u as SummaryAndTagsResult, t as SummaryType, T as ThumbnailModerationScore, G as TranslationOptions, J as TranslationPayload, F as TranslationResult, d as burnedInCaptionsSchema, f as chapterSchema, g as chaptersSchema, m as generateChapters, n as generateVideoEmbeddings, r as getModerationScores, y as getSummaryAndTags, h as hasBurnedInCaptions, s as summarySchema, D as translateAudio, K as translateCaptions, I as translationSchema } from '../index-Bnv7tv90.js';
+import 'zod';
+import '@ai-sdk/anthropic';
+import '@ai-sdk/google';
+import '@ai-sdk/openai';
+import '../types-ktXDZ93V.js';
+import '@mux/mux-node';
+import 'node:buffer';