@lobehub/seo-cli/dist/index.d.mts

Lobe seo is a CLI tool that automate generation seo content for mdx

declare enum LanguageModel {
    /**
     * GPT 3.5 Turbo
     */
    GPT3_5 = "gpt-3.5-turbo",
    GPT3_5_0125 = "gpt-3.5-turbo-0125",
    GPT3_5_1106 = "gpt-3.5-turbo-1106",
    GPT3_5_16K = "gpt-3.5-turbo-16k",
    /**
     * GPT 4
     */
    GPT4 = "gpt-4",
    GPT4_0613 = "gpt-4-0613",
    GPT4_32K = "gpt-4-32k",
    GPT4_PREVIEW = "gpt-4-0125-preview",
    GPT4_TURBO = "gpt-4-turbo",
    GPT4_TURBO_1106 = "gpt-4-1106-preview",
    GPT4_TURBO_1106_VISION = "gpt-4-1106-vision-preview",
    GPT4_TURBO_2024_05_13 = "gpt-4o-2024-05-13",
    GPT4_TURBO_2024_07_18 = "gpt-4o-mini",
    GPT4_TURBO_PREVIEW = "gpt-4-turbo-preview",
    GPT4_TURBO_VISION = "gpt-4-turbo-vision",
    GPT4_VISION_PREVIEW = "gpt-4-vision-preview"
}

interface SeoConfig {
    /**
     * @description Number of concurrently pending promises returned
     */
    concurrency?: number;
    /**
     * @description Entry files path
     */
    entry: string[];
    /**
     * @description The entry file or folder, support glob
     */
    entryExtension: string;
    /**
     * @description Exclude files path
     */
    exclude: string[];
    experimental?: {
        jsonMode?: boolean;
    };
    /**
     * @description Set group key for SEO matters
     */
    groupKey?: string;
    /**
     * @description ChatGPT model name to use
     */
    modelName?: LanguageModel;
    /**
     * @description Provide some context for a more accurate translation
     */
    reference?: string;
    /**
     * @description Stringify the tags array
     */
    tagStringify?: boolean;
    /**
     * @description Sampling temperature to use
     */
    temperature?: number;
}

type Config = SeoConfig;
declare const defineConfig: (config: Partial<Config>) => Config;

export { type Config, defineConfig };