配置应用程序变量和密钥 app-variables

IMPORTANT
Adobe LLM Apps当前在Beta中。
此处显示的功能、工作流和UI不一定表示产品的最终状态。 要加入Beta,请发送电子邮件至llm-apps-beta@adobe.com 。

使用变量和密钥配置应用程序,而无需在其操作处理程序中对值进行硬编码。 例如,将产品目录API URL配置为使用暂存中的测试服务和生产中的实时服务,而不更改处理程序代码。

变量包含非敏感设置。 密钥用于敏感值,如API密钥和访问令牌。

IMPORTANT
UI当前仅支持​变量。 计划在未来版本中提供秘密支持。 在此之前,不存储​变量中的​密码、API密钥、访问令牌或其他敏感信息:设置表显示变量值并允许用户复制它们。

在本指南中:​了解如何添加应用程序变量并在操作处理程序中读取它。 部署应用程序并检查处理程序是否使用预期值。

开始之前 before-you-begin

您需要:

  • 访问您应用程序的处理程序存储库​以更新需要读取变量的处理程序。
  • @adobe/llm-apps-runtime1.1.0或更高版本。 在使用下面的帮助程序之前检查版本。

要检查版本,请在处理程序存储库中运行以下命令:

npm ls @adobe/llm-apps-runtime

如果版本低于1.1.0,请升级该版本,然后提交并推送package.json和package-lock.json:

npm install @adobe/llm-apps-runtime@latest

管理变量 manage-variables

每个环境​ 暂存 ​或​ 生产 ​都有自己的变量。 在添加、更新或删除变量之前检查​Workspace。 更改将在下次将应用程序部署到该环境时生效。

添加变量 add-variable-to-app

此示例使用值为Good day的非敏感变量GREETING_PREFIX覆盖处理程序的默认问候语Hello。 添加变量​ 不 ​会自动更改操作:处理程序​ 必须 ​读取变量。

步骤1:在UI中添加变量 add-a-variable

  1. 打开您的应用,然后在左侧导航中选择​设置。

  2. 打开​ 变量和密钥 ​选项卡。

  3. 在​ Workspace ​中,选择​ 暂存 ​或​生产。

  4. 选择​添加。

    变量和密钥 — 使用“添加”按钮清空阶段工作区

  5. 在对话框中,输入:

    • 名称: GREETING_PREFIX。
    • 类型:保持选择​变量。
    • 值: Good day。

    添加变量或密码 — GREETINGPREFIX设置为正常日期

  6. 要保存变量,请选择​添加。

该变量出现在表中,具有其​名称、类型、值​和​ 上次更新时间 ​日期。 要复制值,请使用相邻的复制控件。

变量和密钥 — 在暂存工作区中保存了GREETINGPREFIX

IMPORTANT
保存会将变量添加到选定环境的配置中。 它​ 不会 ​更新已部署的应用程序,直到您再次部署为止。

步骤2:读取处理程序中的变量 use-a-variable

在处理程序存储库中,打开actions/<action-name>/index.js。 请确保处理程序接受第二个参数extra,并使用getVariable读取变量:

const { getVariable } = require('@adobe/llm-apps-runtime');

module.exports = async ({ name = 'there' } = {}, extra) => {
  const prefix = getVariable(extra, 'GREETING_PREFIX') || 'Hello';

  return {
    content: [{ type: 'text', text: `${prefix}, ${name}!` }]
  };
};

使用值Good day,将name设置为Ada的调用返回Good day, Ada!,而不是默认的Hello, Ada!。 如果您稍后将值更改为Howdy,则问候语会在您重新部署后发生更改,而无需进行其他处理程序编辑。

代码​ 中的名称必须 ​与UI中的名称完全匹配。 如果未设置变量,getVariable将返回undefined。 如示例所示,选择合适的默认值;如果操作需要设置,则返回一个清除错误。

NOTE
变量仅在应用程序的操作处理程序中可用;它们​ 不 ​自动可用于小组件。

当处理程序更改准备就绪时,提交这些更改并将其推送到应用程序的处理程序存储库。 下一个部署使用最新的推送代码。 要了解有关编辑处理程序的详细信息,请参阅自定义生成的处理程序。

步骤3:部署和测试 deploy-and-verify

  1. 将您的应用程序部署到您在​ Workspace ​中选择的相同环境。
  2. 在将name设置为Ada的情况下,从支持的LLM平台中调用操作。 请参阅测试ChatGPT插件或测试Claude连接器。
  3. 确认响应为Good day, Ada!。 响应将验证处理程序是否读取您配置的变量并覆盖其默认问候语。

要配置其他环境,请在​ Workspace ​中选择该环境,使用相应的值重复安装,然后在其中部署和测试应用程序。

NOTE
暂存和生产具有​独立的配置。 一个环境中的更改​ 不会 ​影响另一个环境。 如有必要,在两个环境中使用相同的名称,并为每个环境选择适当的值。
TIP
要在部署之前进行本地测试,请参阅本地处理程序开发和测试,并将变量传递到本地服务器:
node server/local.js --param 'LLMA_VARIABLE_NAMES=["GREETING_PREFIX"]' --param GREETING_PREFIX=Howdy

更新变量 update-or-delete

  1. 在变量行中选择编辑控件。

  2. 查看变量的​ 当前值 ​并输入​新值。

    更新GREETINGPREFIX — 将值从“Good day”更改为“Howdy”

  3. 选择​更新。

  4. 再次将应用程序部署到同一环境,并验证更改后的行为。

更新变量只会更改其值。 您​ 无法 ​重命名变量。 要使用其他名称,请删除现有变量、添加新变量并更新处理程序以读取新名称。

删除变量 delete-a-variable

  1. 检查是否有任何操作仍需要变量。 如有必要,请先更新并推送处理程序​1。

  2. 选择变量行上的删除控件。 要删除多个条目,请选中它们的复选框,然后选择​删除。

  3. 在确认对话框中查看名称,然后选择​删除。

    删除GREETINGPREFIX — 确认永久删除

  4. 再次将应用程序部署到同一环境。

IMPORTANT
您​ 无法 ​撤消删除。 检查是否选择了正确的变量。 已部署的应用程序会保留其现有配置,直到下一次部署为止。 部署后,处理程序​ 不再接收 ​已删除的变量,因此需要该变量的操作可能会失败。

规则和限制 good-to-know

项目
规则
名称
最多64个字符:大写字母、数字和下划线,而不是以数字开头。 每个应用程序和环境必须​是唯一的,并且必须与处理程序匹配。
保留名称
以LLMA_和MCP_SERVER_URL开头的名称。
值
必填,最多500个字符。 平台会删除前导空格和尾随空格。
限制
每个应用程序和环境50个变量。
可见性
变量值是可见且可复制的。 计划的密码支持会隐藏已保存的值。
更改
在下一个部署到选定环境时生效。

疑难解答 verify-configuration

您所看到的内容
要做什么
添加​已禁用,并且页面显示​Workspace限制已达到
删除不再需要的变量。
仅使用大写字母、数字和下划线
重命名,例如API_BASE_URL。
此名称由平台保留
选择不以LLMA_开头且不是MCP_SERVER_URL的名称。
具有此名称的变量已存在
请更新现有变量。
此变量刚在其他地方修改过
刷新页面并重试。
无法加载变量
重新加载页面。 如果错误仍然存在,请检查您是否具有应用程序的访问权限。
操作不使用新值
检查您在保存变量​ 之后是否部署了 ​并测试同一环境。 确认您推送了处理程序更改,且变量名称与​完全匹配。 上次更新时间​在您保存值时显示,而不是在您部署应用程序时显示。
getVariable is not a function
您的应用程序使用的运行时低于1.1.0。 按照中的说明进行升级,在开始之前,请先进行升级,然后再进行部署。
删除变量后,操作失败
将变量添加回来,或者更新处理程序使其不再需要,然后部署。

后续内容 whats-next

recommendation-more-help
llm-apps-help-main-toc