@yamlresume/ai
    Preparing search index...

    Interface GenerateResumeOptions

    Options for generating a new resume.

    interface GenerateResumeOptions {
        language:
            | "en"
            | "zh-hans"
            | "zh-hant-hk"
            | "zh-hant-tw"
            | "es"
            | "fr"
            | "no"
            | "nl"
            | "ja"
            | "de"
            | "id"
            | "pt-br";
        maxRetries?: number;
        maxTokens?: number;
        model: LanguageModelV1;
        onChunk?: (chunk: string) => void;
        position: string;
        temperature?: number;
        withComments?: boolean;
        withLayouts?: boolean;
    }

    Hierarchy (View Summary)

    Index
    language maxRetries? maxTokens? model onChunk? position temperature? withComments? withLayouts?
    language:
        | "en"
        | "zh-hans"
        | "zh-hant-hk"
        | "zh-hant-tw"
        | "es"
        | "fr"
        | "no"
        | "nl"
        | "ja"
        | "de"
        | "id"
        | "pt-br"

    The target locale language for the resume.

    maxRetries?: number

    Maximum number of retries when the generated output fails validation.

    2
    maxTokens?: number

    Maximum number of tokens to generate.

    16384
    model: LanguageModelV1

    The Vercel AI SDK language model to use.

    onChunk?: (chunk: string) => void

    Optional callback invoked with each text chunk streamed from the model. When provided, the LLM response is streamed instead of returned all at once.

    Type Declaration

      • (chunk: string): void

      • Parameters

        • chunk: string

          The incremental text chunk from the model.

        Returns void

    position: string

    The target position or job title for the resume.

    temperature?: number

    Sampling temperature. Lower values produce more deterministic output.

    Some models (kimi-k2.6 with my test) only accept a temperature of 1.0.

    1
    withComments?: boolean

    Whether to inject deterministic YAML comments (schema header, enum option hints, date hints, etc.) into the generated resume.

    true
    withLayouts?: boolean

    Whether to append the default layouts block to the generated resume.

    true

    Settings
    Member Visibility

    On This Page
    Properties