Member Junction
    Preparing search index...

    Interface EmbeddingRunParams

    Parameters for running an embedding via AIModelRunner.

    interface EmbeddingRunParams {
        ContextUser: UserInfo;
        Description?: string;
        Dimensions?: number;
        ModelID?: string;
        ParentRunID?: string;
        PromptID?: string;
        Texts: string[];
    }
    Index

    Properties

    ContextUser Description? Dimensions? ModelID? ParentRunID? PromptID? Texts

    Properties

    ContextUser: UserInfo

    The user context for permissions and audit

    Description?: string

    Optional: human-readable description for the AIPromptRun record

    Dimensions?: number

    Optional: reduced embedding dimensions. Forwarded to the embedding provider's EmbedTexts call for models that support dimension reduction (e.g. OpenAI text-embedding-3-*); ignored by models that don't. The authoritative source is MJ: Vector Indexes.Dimensions — callers should read it from there and pass it here.

    ModelID?: string

    Optional: specific model ID to use. If not provided, uses the prompt's model configuration.

    ParentRunID?: string

    Optional: parent run ID (e.g., agent run, classification run) for hierarchical tracking

    PromptID?: string

    Optional: specific AIPrompt ID for this embedding operation (type=Embedding). If not provided, uses the first active Embedding prompt found.

    Texts: string[]

    The texts to embed

    Settings

    Member Visibility

    On This Page

    Properties