变量

env.vars 对象包含一组变量值。您可以使用这些变量来参数化您的脚本。

// grab locale from variable or default to en-US
const locale = env.vars.locale || "en-US"
// conditionally modify prompt
if (env.vars.explain)
    $`Explain your reasoning`

脚本参数

可以在script函数调用中声明参数。env.vars对象将包含这些参数的值。

script({
    parameters: {
        string: "the default value", // a string parameter with a default value
        number: 42, // a number parameter with a default value
        boolean: true, // a boolean parameter with a default value
        stringWithDescription: {
            // a string parameter with a description
            type: "string",
            default: "the default value",
            description: "A description of the parameter",
        },
    },
})

在VS Code中调用此脚本时，系统将提示用户为这些参数提供值。

来自CLI的变量

在CLI中使用vars字段来覆盖变量。vars接受一系列key=value键值对。

npx genaiscript run ... --vars myvar=myvalue myvar2=myvalue2 ...

测试中的变量

您可以在script函数的tests对象中指定变量。这些变量将在测试范围内可用。

script({
    ...,
    tests: {
        ...,
        vars: {
            number: 42
        }
    }
})