Konfigurieren von App-Variablen und -Geheimnissen app-variables

Verwenden Sie Variablen und Geheimnisse, um Ihre App ohne Hartkodierung in den Aktions-Handlern zu konfigurieren. Konfigurieren Sie beispielsweise die Produktkatalog-API-URL für die Verwendung eines Test-Services in der Staging-Umgebung und des Live-Services in der Produktion, ohne den Handler-Code zu ändern.

Variablen enthalten nicht vertrauliche Einstellungen. Geheime Daten sind für vertrauliche Werte wie API-Schlüssel und Zugriffstoken vorgesehen.

In diesem Handbuch: Erfahren Sie, wie Sie eine App-Variable hinzufügen und in einem Aktions-Handler lesen. Stellen Sie die App bereit und überprüfen Sie, ob der Handler den erwarteten Wert verwendet.

Voraussetzungen before-you-begin

Sie benötigen:

Um die Version zu überprüfen, führen Sie den folgenden Befehl in Ihrem Handler-Repository aus:

npm ls @adobe/llm-apps-runtime

Wenn die Version älter als 1.1.0 ist, aktualisieren Sie sie, übertragen und übertragen Sie package.json und package-lock.json:

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

Variablen verwalten manage-variables

Jede Umgebung, Staging oder Produktion, verfügt über eigene Variablen. Überprüfen Sie Workspace, bevor Sie eine Variable hinzufügen, aktualisieren oder löschen. Die Änderungen werden wirksam, wenn Sie die App das nächste Mal in dieser Umgebung bereitstellen.

Variable hinzufügen add-variable-to-app

In diesem Beispiel wird die Variable „non-sensitive“ GREETING_PREFIX mit dem Wert Good day verwendet, um die Standardbegrüßung des Handlers von Hello zu überschreiben. Durch das Hinzufügen einer Variablen nicht eine Aktion automatisch geändert werden: Der Handler muss die Variable lesen.

Schritt 1: Variable in der Benutzeroberfläche hinzufügen add-a-variable

Die Variable wird in der Tabelle mit dem Name, Type, Value und Last updated angezeigt. Um den Wert zu kopieren, verwenden Sie das angrenzende Kopiersteuerelement.

Schritt 2: Variable in Handler lesen use-a-variable

Öffnen Sie actions/<action-name>/index.js in Ihrem Handler-Repository. Stellen Sie sicher, dass der Handler ein zweites Argument akzeptiert, extra und lesen Sie die Variable mit 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}!` }]
  };
};

Bei dem Wert Good day gibt ein Aufruf mit name auf Ada den Wert Good day, Ada! anstelle des Hello, Ada! zurück. Wenn Sie den Wert später in Howdy ändern, ändert sich die Grußformel nach der erneuten Bereitstellung ohne weitere Handler-Bearbeitung.

Der Name im Code muss mit dem Namen in der Benutzeroberfläche genau übereinstimmen. Wenn die Variable nicht festgelegt ist, gibt getVariable undefined zurück. Wählen Sie einen geeigneten Standardwert aus, wie im Beispiel, oder geben Sie einen eindeutigen Fehler zurück, wenn die Aktion die Einstellung erfordert.

Wenn Ihre Handler-Änderungen bereit sind, übertragen Sie sie in das Handler-Repository Ihrer App. Bei der nächsten Bereitstellung wird der neueste Push-Code verwendet. Weitere Informationen zum Bearbeiten von Handlern finden Sie unter Anpassen eines generierten Handlers.

Schritt 3: Bereitstellen und Testen deploy-and-verify

Um die andere Umgebung zu konfigurieren, wählen Sie diese Umgebung in Workspace aus, wiederholen Sie die Einrichtung mit dem entsprechenden Wert und stellen Sie dann die App dort bereit und testen Sie sie.

Aktualisieren einer Variablen update-or-delete

Beim Aktualisieren einer Variablen wird nur ihr Wert geändert. Variablen nicht umbenannt werden. Um einen anderen Namen zu verwenden, löschen Sie die vorhandene Variable, fügen Sie eine neue Variable hinzu und aktualisieren Sie Ihren Handler, um den neuen Namen zu lesen.

Löschen einer Variablen delete-a-variable

Regeln und Beschränkungen good-to-know

Fehlerbehebung verify-configuration

Wie geht es weiter whats-next