エクスポートとインポート

このページでは、エージェント アプリケーションと個々のツールをエクスポートおよびインポートする方法について説明します。

エージェントのエクスポートとインポート

エージェント アプリケーションをエクスポートおよびインポートできます。

  1. CX Agent Studio コンソールを開きます。
  2. プロジェクトを選択します。 プロジェクトのエージェント アプリケーションのリストが表示されます。
  3. アプリケーションのコンテキスト メニューをクリックし、[インポート] または [エクスポート] を選択します。

環境ファイル

エージェント アプリケーションをエクスポートすると、ダウンロードしたアーカイブのルート ディレクトリに environment.json という名前のファイルが含まれます。 このファイルを使用すると、Cloud Storage バケット、サービス エンドポイント、データストア URI など、アプリケーションの環境固有の設定を管理できます。

このファイルをエクスポートとインポートに使用すると、次のようなメリットがあります。

  • 移植性の向上: 1 つのファイルを変更することで、さまざまなプロジェクトや環境（開発からプロダクションなど）間でエージェント アプリケーションを転送できます。
  • 構成の一元化: すべての主要な外部依存関係が 1 か所に一覧表示されるため、管理が簡素化され、概要を把握しやすくなります。
  • エラーの削減: 複数のリソース ファイルで設定を手動で編集する場合と比較して、ミスが発生するリスクを最小限に抑えることができます。
  • 自動化に適している: JSON 形式を使用すると、CI/CD パイプラインの一部としてスクリプトを使用して構成をプログラムで更新できます。

環境固有の設定を更新するには:

  1. エクスポート: エクスポートしたエージェント アプリケーションをダウンロードして抽出します。
  2. 変更: ルート ディレクトリにある environment.json ファイルを開きます。 依存関係の値を変更して、ターゲット環境の設定と一致させます。
  3. インポート: 変更した environment.json ファイルを含むディレクトリ全体を圧縮して、新しい zip アーカイブを作成します。 この新しいアーカイブを移行先の環境にインポートします。environment.json の更新された値が適用されます。

環境ファイルの詳細

environment.json ファイルは、さまざまな環境（開発、テスト、本番環境など）間で変更される可能性のある外部依存関係の中央マニフェストとして機能します。

エージェント アプリケーションをエクスポートすると、アプリケーションのリソース内の環境固有のフィールドが識別されます。 これらの値をハードコードする代わりに、抽出して environment.json ファイルに配置します。 値はリソースの種類と名前で整理されます。 元のリソース マニフェスト ファイルでは、抽出された値はプレースホルダ変数 $env_var に置き換えられます。

エージェント アプリケーションをインポートすると、environment.json ファイルが読み取られます。 リソース マニフェストで $env_var プレースホルダを見つけ、environment.json ファイルの対応する値に置き換えます。 このプロセスにより、新しい環境用にアプリケーションが構成されます。

environment.json ファイルで管理されるフィールドは次のとおりです。

  • ApiKeyConfig.key_name
  • ApiKeyConfig.api_key_secret_version
  • AudioRecordingConfig.gcs_bucket
  • BoostSpecs.data_stores
  • ConnectorTool.connection
  • DataStore.name
  • EngineSource.engine
  • FileSearchTool.file_corpus
  • OAuthConfig.client_secret_version
  • OAuthConfig.token_endpoint
  • OpenApiToolset.url（OpenApiToolset.open_api_schema から自動的に抽出）
  • ServiceAccountAuthConfig.service_account
  • VertexAiRagRetrievalTool.RagResource.rag_corpus
  • VertexAiRagRetrievalTool.RagResource.rag_file_ids

ツールのエクスポートとインポート

個々のツールをエクスポートおよびインポートできます。 この機能により、[ツール] パネルに [インポート] と [エクスポート] の 2 つの新しいオプションが追加されます。

  • エクスポート: ツールのコンテンツを JSON ファイルとしてローカルマシンまたは Cloud Storage にダウンロードします。
  • インポート: ローカルの JSON ファイルまたは Cloud Storage に保存されている JSON ファイルを使用して、新しいツールを作成するか、既存のツールを更新します。

ツールをエクスポートする

ツールをエクスポートするには:

  1. CX Agent Studio コンソールを開き、プロジェクトとエージェントを選択します。
  2. [ツール] パネルを開きます。
  3. エクスポートするツールのコンテキスト メニューをクリックします。
  4. [エクスポート] を選択します。
  5. ダイアログで、次のいずれかのオプションを選択します。
    • ダウンロード: JSON ファイルをローカルマシンに保存します。
    • Cloud Storage: JSON ファイルを指定した Cloud Storage URI に保存します。

ツールをインポートする

ツールをインポートするには、次の 2 つのワークフローがあります。

上書きしてインポートする

このオプションを使用して、既存のツールを変更します。インポートする JSON ファイルは、現在のツールと同じツールタイプに対応している必要があります。

  1. CX Agent Studio コンソールを開き、プロジェクトとエージェントを選択します。
  2. [ツール] パネルを開きます。
  3. 更新するツールのコンテキスト メニューをクリックします。
  4. [上書きしてインポート] を選択します。
  5. ダイアログで、次のいずれかのオプションを選択します。
    • JSON をアップロード: ローカルマシンから JSON ファイルを選択します。
    • Cloud Storage: Cloud Storage 内の JSON ファイルの URI を入力します。

新しいツールとしてインポートする

このオプションを使用して、新しいツールを作成します。

  1. CX Agent Studio コンソールを開き、プロジェクトとエージェントを選択します。
  2. [ツールを作成] パネルを開きます。
  3. [新しいツールとしてインポート] を選択します。
  4. ダイアログで、次のいずれかのオプションを選択します。
    • JSON をアップロード: ローカルマシンから JSON ファイルを選択します。
    • Cloud Storage: Cloud Storage 内の JSON ファイルの URI を入力します。