providerplaneai
    Preparing search index...

    Interface ClientVideoAnalysisRequest

    Interface contract for ClientVideoAnalysisRequest.

    interface ClientVideoAnalysisRequest {
        context?: { metadata?: Record<string, unknown>; requestId?: string };
        model?: string;
        options?: Record<string, unknown>;
        params?: {
            maxOutputTokens?: number;
            model?: string;
            outputFormat?: "text" | "json";
            temperature?: number;
        };
        prompt?: string;
        videos?: ClientVideoInput[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    context? model? options? params? prompt? videos?

    Properties

    context?: { metadata?: Record<string, unknown>; requestId?: string }

    Execution context (tracing, requestId, etc.) Not sent to the provider.

    model?: string
    options?: Record<string, unknown>

    Provider-agnostic tuning options (temperature, max tokens, etc.)

    params?: {
        maxOutputTokens?: number;
        model?: string;
        outputFormat?: "text" | "json";
        temperature?: number;
    }

    Type Declaration

    • OptionalmaxOutputTokens?: number
    • Optionalmodel?: string
    • OptionaloutputFormat?: "text" | "json"

      json asks the provider adapter to request structured JSON output. Adapters still perform best-effort parsing because model output may drift.

    • Optionaltemperature?: number
    prompt?: string

    Optional analysis instruction.

    videos?: ClientVideoInput[]

    One or more videos to analyze. If omitted, provider may use context video artifacts.

    Settings

    Member Visibility

    On This Page

    Properties