Interface EmbedderReference<CustomOptions>

A reference object that can used to resolve an embedder instance. Include additional type information about the specific embedder, e.g. custom config options schema.

interface EmbedderReference<CustomOptions extends ZodTypeAny = ZodTypeAny> {
    config?: TypeOf<CustomOptions>;
    configSchema?: CustomOptions;
    info?: {
        dimensions?: number;
        label?: string;
        supports?: { input?: ("image" | "text")[]; multilingual?: boolean };
    };
    name: string;
    version?: string;
}

Type Parameters

Properties

config? configSchema? info? name version?

Properties

Optionalconfig

config?: TypeOf<CustomOptions>

OptionalconfigSchema

configSchema?: CustomOptions

Optionalinfo

info?: {
    dimensions?: number;
    label?: string;
    supports?: { input?: ("image" | "text")[]; multilingual?: boolean };
}

name

name: string

Optionalversion

version?: string

Settings

Member Visibility

On This Page

Properties