Type alias GenerateOptionsBase

GenerateOptionsBase: {
    debug?: boolean;
    description?: string;
    meta?: GenerateMeta;
    openaiApiKey?: string;
    throwOnFailure?: boolean;
} & Partial<Pick<ChatCompletionCreateParamsBase, "model" | "temperature" | "top_p" | "max_tokens" | "presence_penalty" | "frequency_penalty" | "logit_bias" | "user">> & Omit<ClientOptions, "apiKey">

Base options for the generate function.

Type declaration

  • Optional debug?: boolean

    If true, debug information will be logged.

  • Optional description?: string

    Description of the generation.

  • Optional meta?: GenerateMeta

    Metadata for the generation.

  • Optional openaiApiKey?: string

    The API key for OpenAI.

  • Optional throwOnFailure?: boolean

    If true, an error will be thrown if the generation fails.

Generated using TypeDoc