サービス構成を管理する

このページでは、サービス構成を削除、編集、一覧表示する方法と、各構成に関する統計情報の確認について説明します。

新しいサービス構成の作成方法については、サービス構成の作成をご覧ください。

既存のプレースメントがある場合や新しいプレースメントを作成する場合、小売業向け Vertex AI Search は各プレースメントに関連付けられたサービス構成を自動的に作成します。サービス構成を作成しても、対応するプレースメントは作成されません。サービス構成を削除すると、対応するプレースメントが削除されます。プレースメントを削除すると、対応するサービス構成が削除されます。

サービス構成を編集する

サービス構成を編集するには、小売向け検索コンソールまたは API を使用します。

コンソールでサービス構成を編集

各サービス構成のコントロールは、[サービス構成] ページで表示、編集できます。サービス構成をクリックすると、[詳細] ページが表示され、その構成のすべてのサービスとサイト全体のコントロールが一覧表示されます。

このページでは、コントロールを編集したり、新しいコントロールを作成したり、既存のコントロールを構成に適用したりできます。

新規作成または更新されたサービス構成がライブ トラフィックを処理できるようになるまでに数分かかります。変更はすぐに [Evaluate] ページでテストできます。

サービス構成をインラインで編集する

サービス構成フィールドの更新、サービス提供コントロールの追加、サービス提供コントロールの削除は、Retail API メソッドを使用してインラインで行うことができます。

サービス構成にインラインでパッチ適用する

サービス構成のフィールドを更新するには、ServingConfig.patch を使用し、リクエスト本文に ServingConfig のインスタンスを含めます。updateMask パラメータで更新するためにフィールドを指定するか、サポートされているすべてのフィールドを更新には未設定のままにします。

このメソッドの詳細については、ServingConfig.patch API リファレンスをご覧ください。

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d '{
      "name": "projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/servingConfigs/SERVING_CONFIG_ID",
      "FIELD_NAME_1": "NEW_FIELD_VALUE_1"
      "FIELD_NAME_2": "NEW_FIELD_VALUE_2"
    }' \
'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/servingConfigs/SERVING_CONFIG_ID?updateMask=FIELD_NAME_1,FIELD_NAME_2'

サービス構成にインラインでコントロールを追加する

サービス構成にコントロールを追加するには、ServingConfig.addControl を使用します。 このコントロールは、そのコントロールが属するコントロールのリストの最後の位置に追加されます。たとえば、facetSpec コントロールは servingConfig.facetSpecIds の最後の位置に適用されます。

このメソッドの詳細については、ServingConfig.addControl API リファレンスをご覧ください。

curl -X POST \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d '{
      "controlID": "CONTROL_ID"
    }' \
'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/servingConfigs/SERVING_CONFIG_ID:addControl'

サービス構成からインラインでコントロールを削除する

サービス構成からコントロールを削除するには、ServingConfig.removeControl を使用します。

このメソッドの詳細については、ServingConfig.removeControl API リファレンスをご覧ください。

curl -X POST \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d '{
      "controlID": "CONTROL_ID"
    }' \
'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/servingConfigs/SERVING_CONFIG_ID:removeControl'

サービス構成を表示する

サービス構成を表示するには、小売向け検索コンソールまたは API を使用します。

コンソールでサービス構成を表示する

サービス構成はすべて、[サービス構成] ページで確認できます。

サービス構成をインラインで表示する

単一のサービス構成をインラインで表示するには、ServingConfig.get を使用します。

このメソッドの詳細については、ServingConfig.get API リファレンスをご覧ください。

curl -X GET \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/servingConfigs/SERVING_CONFIG_ID'

すべてのサービス構成をインラインで一覧表示するには、ServingConfig.list を使用します。

必要に応じて、パラメータ pageSize を使用して、返される結果の最大数を設定できます。結果がさらにある場合は、list レスポンスにページトークンが含まれます。list リクエストの pageToken パラメータでページトークンを渡して、結果の次のページを取得できます。

このメソッドの詳細については、ServingConfig.list API リファレンスをご覧ください。

curl -X GET \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/servingConfigs?pageSize=PAGE_SIZE&pageToken=PAGE_TOKEN'

サービス構成を削除する

サービス構成を削除するには、小売向け検索コンソールまたは API を使用します。

コンソールでサービス構成を削除する

コンソールでサービス構成を削除するには:

  1. Search for Retail コンソールの[サービス構成]ページに移動します。

    [サービス構成] ページに移動

  2. 削除するサービス構成をクリックして、詳細ページを開きます。

  3. ページ上部のボタンバーで [削除] をクリックします。

  4. サービス構成が有効だとみなされる場合は、ID を再入力して [確認] をクリックして削除を完了する必要があります。

サービス構成をインラインで削除する

単一のサービス構成をインラインで削除するには、ServingConfig.delete を使用します。

このメソッドの詳細については、ServingConfig.delete API リファレンスをご覧ください。

curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/servingConfigs/SERVING_CONFIG_ID'

サービス構成の統計情報の確認

各サービス構成の詳細については、[Serving Configs] ページをご覧ください。表内の構成については、[分析情報の表示] をクリックすると統計情報が表示されます。

[クリック率] は、サービス構成の 1 回の検索あたりのクリック数を示します。[コンバージョン率] は、構成の 1 回の検索での購入を示します。