既存アプリのアップグレード upgrade-existing-app

IMPORTANT
Adobe LLM Appsは現在Betaにいます。
ここに示す機能、ワークフロー、UIは、必ずしも製品の最終状態を表すものではありません。 Betaに参加するには、llm-apps-beta@adobe.comに電子メールを送信します。

このガイドは、アプリが1.2.0より前の@adobe/llm-apps-runtimeを使用している場合や、そのEDS ウィジェットが0.1.13より前のLLM Apps SDKを使用している場合にのみ使用してください。 既に両方の要件を満たしているアプリは、Adobe AnalyticsとCustomer Journey Analyticsの設定に直接進むことができます。

このガイドでは、​古いアプリケーションのランタイムとEDS SDKを更新および検証する方法について説明します。 次に、Analyticsの設定ガイドに戻り、Analyticsを有効にして収集を検証します。

始める前に before-you-begin

ハンドラーリポジトリーにアクセスする必要があります。また、EDS ウィジェットを持つアプリの場合は、アプリにリンクされたEDS リポジトリーにアクセスする必要があります。 アプリでAdobeのマネージドインフラストラクチャを使用している場合は、更新する前にコードへのアクセスをリクエストしてください。 Adobe Managed Infrastructureの使用を参照してください。

別のアプリを作成する必要はありません。 サポートされているバージョン以下のコンポーネントのみを更新します。 analyticsの設定要件を満たす既存のAdobe設定を再利用できます。

EDS ウィジェットを持つアプリケーションの場合は、まずSDK アップデートを公開して検証し、次にランタイムアップデートを結合してアプリケーションを再デプロイします。 2つのリポジトリの更新は個別に準備できますが、両方を使用してAnalytics対応デプロイメントをテストする前に、両方を使用できる必要があります。

LLM アプリケーションアクションリポジトリを確認して更新します upgrade-runtime

  1. アプリにリンクされているハンドラーリポジトリを開き、その依存関係をインストールします。

    code language-bash
    npm install
    
  2. インストールされたランタイムを確認します。

    code language-bash
    npm ls @adobe/llm-apps-runtime
    
  3. ランタイムが1.2.0より前の場合は、現在のバージョンをインストールします。

    code language-bash
    npm install @adobe/llm-apps-runtime@latest
    npm ls @adobe/llm-apps-runtime
    

    インストールされているバージョンが1.2.0以降であることを確認します。 アプリで既に使用している場合は、後続のサポート対象バージョンを保持します。

  4. ランタイム依存関係とその解決済みバージョンが最小要件を満たしていることを確認します。 アプリケーション自体のバージョンは、ランタイム依存関係とは別です。

  5. リポジトリのチェックを実行します。 LLM Apps ボイラープレートの場合:

    code language-bash
    npm test -- --runInBand
    npm run build
    npm run lint
    

    デプロイする前にエラーを調査します。 元のバージョンで既にチェックが失敗した場合は、アップグレードによって発生したエラーとは別にそのベースラインを記録します。 正常なローカルビルドでは、分析の収集は検証されません。

  6. 依存関係の更新とそのロックファイルをコミットし、更新をプッシュして、ハンドラーリポジトリのデフォルトブランチ(通常はmain)にマージします。 デプロイメントは、そのブランチを複製します。 ローカルまたは結合されていない機能ブランチにのみ存在する更新は、デプロイメントには含まれません。

    ロックファイルが存在する場合、デプロイメントはnpm ciの依存関係をインストールし、記録されたバージョンを使用します。 再デプロイしても、ランタイムは自動的にはアップグレードされません。 再デプロイする前に、GitHubのデフォルトブランチで、アップグレードされた依存関係と解決されたバージョンを確認します。

LLM Apps Widget Repositoryを確認して更新します upgrade-sdk

EDS ウィジェットを持つアプリケーションの場合は、EDS リポジトリとサーバーランタイムでSDKを確認します。 一方のリポジトリを更新しても、もう一方のリポジトリは更新されません。

一部のEDS リポジトリには、npm依存関係のないコピー済みSDK スクリプトが含まれています。 ブラウザーは、提供されたスクリプトを直接読み込むため、パッケージエントリがないからといってSDKが欠落しているわけではありません。 プロジェクトのSDK更新プロセスを使用して、コピーしたSDK ディストリビューションを更新します。 SDKをコピーされたスクリプトとして管理するプロジェクトでは、永続的なnpm依存関係を追加する必要はありません。

npmを通じてSDKを管理するプロジェクトの場合:

  1. EDS リポジトリのルートから、現在のSDKをインストールし、そのバージョンを確認します。

    code language-bash
    npm install --save-dev @adobe/llmapps-sdk@latest
    npm ls @adobe/llmapps-sdk
    

    0.1.13以降を使用します。 プロジェクトで既に使用している場合は、後でサポートされるバージョンを保持します。

  2. インストールによって、提供されたSDK ディストリビューションが更新されたことを確認します。 インストールフックは、コピーされたSDK スクリプトを上書きするので、コミットする前にローカルのカスタマイズを確認してください。 依存関係の宣言のみを更新しても、EDSが提供するスクリプトは更新されません。 LLM アプリ SDKのインストール ​を参照してください。

  3. EDS リポジトリのチェック (例:npm run lint)を実行し、既存のウィジェットがまだレンダリングおよび応答を返していることを確認します。

  4. 更新されたSDK ディストリビューションを、依存関係およびロックファイルの更新と共にコミットします。 EDSは、インストールされたnpm パッケージではなく、コピーされたスクリプトを直接提供します。

いずれかの更新メソッドの後、更新をプッシュして、アクションの​ スクリプト URL ​で使用されるEDS ブランチにマージします。 URLが更新されたSDKを提供し、そのサポートライブラリが正常に読み込まれることを確認します。 URLがEDS ライブサイトを使用している場合は、そのサイトの公開手順を完了します。

次の手順 next-step

Adobe AnalyticsとCustomer Journey Analyticsの設定に戻ります。 すべてのアプリケーションでAnalyticsとデプロイを有効にしてイベントを収集する必要があります。ランタイムまたはSDKのみをアップグレードしても、収集は有効になりません。

Analytics設定を保存したら、実稼動環境にデプロイする前に、ステージにデプロイし、新しいアクションコールおよびウィジェットとインタラクションのイベントを🔗検証します。 アクションとウィジェットが引き続き機能し、単一のリンク選択が1つのウィジェットとインタラクションイベントを生成することを確認します。

Analyticsは、分析対応デプロイメントの後に新しいインタラクションの収集を開始します。 アップグレードでは、収集が有効になる前に発生したインタラクションは再構築されません。

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