アプリの変数とシークレットの設定 app-variables

変数とシークレットを使用して、アクションハンドラーで値をハードコーディングせずにアプリを設定します。 例えば、製品カタログ APIのURLを設定して、ステージングのテストサービスと実稼動環境のライブサービスを使用するように、ハンドラーコードを変更せずに設定します。

変数には、機密性のない設定が保持されます。 シークレットは、API キーやアクセストークンなどの機密性の高い値を対象としています。

このガイドでは、 アプリ変数を追加し、アクションハンドラーで読み取る方法を説明します。 アプリをデプロイし、ハンドラーが期待される値を使用することを確認します。

始める前に before-you-begin

次のものが必要です。

バージョンを確認するには、ハンドラーリポジトリで次のコマンドを実行します。

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を上書きします。 変数を追加すると、アクションが​ not ​によって自動的に変更されます。ハンドラー​ は ​で変数を読み取る必要があります。

手順1:UIでの変数の追加 add-a-variable

変数は、名前、種類、値、最終更新日​のテーブルに表示されます。 値をコピーするには、隣接するコピーコントロールを使用します。

手順2: ハンドラーで変数を読み取る use-a-variable

ハンドラーリポジトリで、actions/<action-name>/index.jsを開きます。 ハンドラーが2番目の引数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に設定された呼び出しは、デフォルトのHello, Ada!ではなくGood day, Ada!を返します。 後で値をHowdyに変更すると、別のハンドラーの編集なしで、再デプロイ後に挨拶が変更されます。

コード の名前は、UIの名前と完全に一致している必要があります。​変数が設定されていない場合、getVariableはundefinedを返します。 例のように、適切なデフォルトを選択するか、アクションで設定が必要な場合は明確なエラーを返します。

ハンドラーの変更の準備ができたら、それらをコミットしてアプリのハンドラーリポジトリにプッシュします。 次のデプロイメントでは、最新のプッシュコードを使用します。 ハンドラーの編集について詳しくは、生成ハンドラーのカスタマイズ ​を参照してください。

ステップ 3：デプロイとテスト deploy-and-verify

他の環境を設定するには、Workspace​でその環境を選択し、適切な値で設定を繰り返してから、アプリをそこにデプロイしてテストします。

変数の更新 update-or-delete

変数を更新すると、値のみが変更されます。 変数の名前を​変更できません。 別の名前を使用するには、既存の変数を削除し、新しい変数を追加し、ハンドラーを更新して新しい名前を読み取ります。

変数の削除 delete-a-variable

ルールと制限 good-to-know

トラブルシューティング verify-configuration

次の手順 whats-next