providerplaneai
    Preparing search index...

    Interface ClientEmbeddingRequest

    Interface contract for ClientEmbeddingRequest.

    interface ClientEmbeddingRequest {
        context?: { metadata?: Record<string, unknown>; requestId?: string };
        input: string | string[];
        inputId?: string;
        model?: string;
        options?: Record<string, unknown>;
        purpose?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    context? input inputId? model? options? purpose?

    Properties

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

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

    input: string | string[]
    inputId?: string

    Optional identifier for this embedding input

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

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

    purpose?: string

    Optional semantic hint about the embedding (e.g., "query", "document")

    Settings

    Member Visibility

    On This Page

    Properties