このページは Cloud Translation API によって翻訳されました。

メディアレコメンデーションを優先表示または非表示にする

注: この機能はプレビュー版で、GCP サービス固有の規約の「pre-GA サービス規約」が適用されます。一般提供前のプロダクトと機能では、サポートが制限されることがあります。また、これらのプロダクトや機能には、他の一般提供前のバージョンと互換性のない変更が行われる場合があります。詳細については、リリースステージの説明をご覧ください。さらに、この機能を使用すると、生成 AI プレビュー版の利用規約（以下「プレビュー規約」）に同意したことになります。この機能については、お客様は Cloud のデータ処理に関する追加条項に記載されているとおりに個人データを処理できます。その際、（プレビュー規約に定義されるとおり）本契約で規定されている制限と義務が適用されます。

このページでは、ブーストサービス提供コントロール（コントロールとも呼ばれます）を使用して、モデルから返されるメディアの推奨事項のランキング位置を変更する方法について説明します。

ブースト制御は、モデルから推奨事項が返された後に、推奨事項の順序を変更します。フィルタ式を結果に適用して、ブーストまたはベリーするレコメンデーションを特定し、-1 ～+1 のブースト値を適用します。ブースト値 +1 は、推奨事項に最大のブーストを与え、返される推奨事項の最上位に配置します。値 -1 は、返された推奨事項のリストの下部に推奨事項を埋め込みます。

ブーストはサービス提供時のコントロールです。まず、レコメンデーションモデルがレコメンデーションのリストを返します。サービス構成を使用して、ブーストコントロールがそのリストに適用され、おすすめのランキングが調整されます。ブーストコントロールは、おすすめの追加や削除は行いませんが、おすすめがユーザーに表示される順序を制御します。

レコメンデーションのブーストとフィルタリング

ブーストはソフト フィルタです。一方、レコメンデーションのフィルタで説明されているレコメンデーションの通常のフィルタは、ハードフィルタです。

レコメンデーションにハードフィルタを適用すると、フィルタで除外されたドキュメントは表示されなくなります。ただし、ソフトフィルタでは、おすすめのリストからドキュメントは削除されません。代わりに、フィルタは、返されるレコメンデーションのリストでどのドキュメントを上位または下位にすべきかを判断するために使用されます。

レコメンデーションモデルの過負荷を回避する

ブーストまたは埋め込みフィルタを適用する場合は、ゼロに近い小さな値をおすすめします。値が +1 または -1 に近いと、レコメンデーションモデルが過剰に反応し、モデルによって適用されるレコメンデーションランキングが、ユーザーに表示されるレコメンデーションの順序に反映されない可能性があります。

たとえば、アニメーション映画を +1 でブーストすると、ユーザーにはアニメーション映画のみがおすすめリストの上部に表示されます。これにより、モデルによって強く推奨されたアニメーション以外の映画がリストの下部に押し下げられ、ユーザーに表示されない可能性があります。

降格と非表示

降格と埋め込みの両方で、推奨事項が返されるリスト内の位置が、通常よりも下になります。

ただし、降格は、コンテンツの古さや、ユーザーがすでにコンテンツの一部を視聴しているかどうかに基づいて行われます。降格の詳細については、メディアレコメンデーションの降格をご覧ください。

非表示は、フィルタで特定されたコンテンツに適用されます。フィルタには、スキーマでフィルタ可能としてマークされた任意のデータフィールドを指定できます。フィールドをフィルタ可能としてマークする方法など、レコメンデーションフィルタに関する一般的な情報については、レコメンデーションをフィルタリングするをご覧ください。

ブーストコントロールとサービス構成について

各ブーストサービングコントロールは、フィルタとブースト値で構成されています。たとえば、1 つのブースト制御で、タイトルに「クリスマス」が含まれる映画を 0.1 の値でブーストし、別のブースト制御で、ホラー映画を -0.2 の値で非表示にします。

1 つ以上のブーストコントロールを作成したら、そのコントロールをサービス構成に関連付けます。Vertex AI Search アプリを作成すると、デフォルトのサービス構成も自動的に作成されます。サービス構成は、サービス時に参照され、アプリが生成する結果を決定します。サービス提供構成には、ブーストコントロールに加えて、多様化コントロールや降格コントロールなど、他のタイプのコントロールを含めることができます。

サービス構成は、recommend メソッドを呼び出すときに適用できます。サービス構成内のすべてのコントロールが、メソッド呼び出しによって返されたレコメンデーションに適用されます。

さらに、アプリに関連付けることができるサービス構成は複数あります。これにより、状況に応じて異なるコントロールのセットを適用できます。たとえば、おすすめのリクエストがお子様のアカウントから送信された場合は、お子様向けのカテゴリの映画を上位に表示し、不適切な映画を非表示にします。同様に、リクエストが成人向けとマークされたアカウントから送信された場合は、成人に人気のタイトルやカテゴリをブーストします。また、地域ごとに異なるサービング構成を設定し、地域で人気のあるコンテンツをブーストすることもできます。サービス提供構成の詳細については、メディアサービス提供構成の作成と管理をご覧ください。

ブースト値は加算される

複数のサービス提供コントロールをサービス構成にアタッチした場合、ブーストと埋め込みは加算されます。

たとえば、子供向けアニメ映画のブースト値を 0.3、アニメアドベンチャー映画のブースト値を 0.4 に設定した場合、子供向けアニメアドベンチャーに分類される映画のブースト値は 0.7 になります。

同様に、ホラー映画が同じサービス構成で 1 つのコントロールによって 0.2 増加し、別のコントロールによって -0.3 減少した場合、最終的な結果は映画が -0.1 減少することになります。

ブーストの合計は +1 を超えることがあります。たとえば、子供向けアニメ映画のブーストが 0.6、アニメアドベンチャー映画のブーストが 0.5 の場合、子供向けアニメアドベンチャー映画のブーストは +1.1 になります。

フィルタの例

メディアレコメンデーションのフィルタの例を次に示します。

一般的なキープロパティのフィルタ

一般的なキー文字列プロパティ（category、image_name、image_uri、language、title、uri）のフィルタの例。

子供向けアニメーション:
"filter": "categories: ANY(\"animation\") AND categories: ANY(\"children\")"
怖いメディア:
"filter": "categories: ANY(\"horror\", \"thriller\", \"crime\")
タイトルが「クリスマス」のメディア:
"filter": "title: ANY(\"Christmas\")"
images 配列の最初のアイテムの name が「ビーチボール」であるメディア:
"filter": "images[0].name: ANY(\"beach ball\")"

メディアキーのプロパティでフィルタ

メディアキーのプロパティのフィルタの例。メディアキーのプロパティは media_ で始まり、フィルタ構文では、フィールド名の前に media_key_properties. が付きます。メディアキープロパティの一覧については、Google の事前定義済みスキーマとカスタムスキーマをご覧ください。

タイプが audio のメディア:
"filter": "media_key_properties.media_type: ANY(\"audio\")"
hash_tags 配列に文字列 #winter が含まれているメディア:
"filter": "media_key_properties.hash_tags: ANY(\"#winter\")"
hash_tags 配列の最初の要素が文字列 #winter のメディア:
"filter": "media_key_properties.hash_tags[0]: ANY(\"#winter\")"

カスタムフィールド

カスタムフィールドのフィルタの例。カスタム属性の場合は、フィールド名の前に attributes. を付けます。

スキーマに、映画がプレミア上映された映画祭を表すカスタム文字列フィールド festival があります。カンヌでプレミア上映された映画のみをフィルタするには:
"filter": "attributes.festival: ANY(\"Cannes\")
視覚障がいのある視聴者向けの音声解説がメディアに含まれている場合に true になるカスタムブール値フィールド audio_desc があります。音声による説明付きのメディアをフィルタするには:
"filter": "attributes.audio_desc: ANY(true)"

フィルタリング可能なフィールドの制限事項

ブーストサービス管理には次の制限が適用されます。

ブーストのフィルタ式で使用できるのは、文字列型とブール型のプロパティフィールドのみです。
2 つ以上のレベルでネストされたフィールドでフィルタすることはできません。たとえば、persons.name でフィルタリングできますが、フィールド persons.name.stage でフィルタリングすることはできません（そのようなフィールドが存在する場合でも）。
フィルタは完全一致である必要があります。つまり、例では、「Christmas Story」または「CHRISTMAS」という映画はブーストされません。

始める前に

メディアレコメンデーションアプリとデータストアが作成されていることを確認します。詳細については、メディアレコメンデーションアプリとデータストアを作成するをご覧ください。
省略可: デフォルトのサービング構成を使用しない場合は、サービング構成を作成するの手順 1 ～ 5 と 7 に沿って新しいサービング構成を作成します。アプリが本番環境にある場合は、ブースト制御を本番環境のサービング構成に適用する前に、ブースト制御のテスト用に別のサービング構成を作成することをおすすめします。
ブースト制御で使用するフィールドは、スキーマで Filterable としてマークされていることを確認します。詳細については、フィールド設定を構成するをご覧ください。フィルタリングの上限もご覧ください。

推奨事項をブーストまたはベリーする

この手順では、ブーストコントロールを作成して、サービス提供構成にコントロールを関連付ける方法について説明します。

コントロールがサービス構成に関連付けられたら、servingConfigs.recommend メソッドを呼び出すときにサービス構成を指定できます。ブーストコントロールは、返されるレコメンデーションの順序に影響を与えるために使用されます。

REST

ブーストサービス提供コントロールを作成してサービス提供構成にアタッチする手順は次のとおりです。

アプリ ID を確認します。アプリ ID がすでにある場合は、次のステップに進みます。
1. Google Cloud コンソールで、[AI アプリケーション] ページに移動します。
  
  [アプリ] に移動
2. [アプリ] ページで、アプリの名前を見つけ、[ID] 列からアプリの ID を取得します。
データストア ID を確認します。データストア ID がすでにある場合は、次のステップに進みます。
1. Google Cloud コンソールで、[AI アプリケーション] ページに移動し、ナビゲーションメニューで [データストア] をクリックします。
  
  [データストア] ページに移動
2. データストアの名前をクリックします。
3. データストアの [データ] ページで、データストア ID を取得します。

ブーストコントロールを作成します。

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-H "X-Goog-User-Project: PROJECT_NUMBER" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_NUMBER/locations/global/collections/default_collection/engines/APP_ID/controls?controlId=CONTROL_ID" \
-d '{
      "displayName": "CONTROL_DISPLAY_NAME",
          "solutionType": "SOLUTION_TYPE_RECOMMENDATION",
          "boostAction": {
               "dataStore": "projects/PROJECT_NUMBER/locations/global/collections/default_collection/dataStores/DATA_STORE_ID",
               "boost" :  BOOST_VALUE,
               "filter": "FILTER"
          }
    }'

次のように置き換えます。

PROJECT_NUMBER: Google Cloud プロジェクトの番号。
CONTROL_DISPLAY_NAME: コントロールを識別するための人が読める形式の名前。最大長が 128 文字の UTF-8 文字列である必要があります。
CONTROL_ID: コントロールの固有識別子（データストア内）。ID には、小文字、数字、ハイフン、アンダースコアを使用できます。
APP_ID: Vertex AI Search アプリの ID。
DATA_STORE_ID: Vertex AI Search データストアの ID。
BOOST_VALUE: [-1,1] の範囲の浮動小数点数。値が負の場合、結果の下位に推奨事項が表示されます。値が正の場合、推奨事項は昇格されます（結果の上位に表示されます）。
FILTER: ブーストまたは非表示にするドキュメントを記述するフィルタ式。フィルタ式を作成する方法の詳細については、フィルタ式をご覧ください。

コマンドとレスポンスの例

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-H "X-Goog-User-Project: 123456" \
"https://discoveryengine.googleapis.com/v1beta/projects/123456/locations/global/collections/default_collection/engines/my-app/controls?controlId=boost-kids" \
-d '{
      "displayName": "Boost childrens category",
          "solutionType": "SOLUTION_TYPE_RECOMMENDATION",
          "boostAction": {
               "dataStore": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store",
               "boost" :  0.3,
               "filter": "categories: ANY(\"Children\")"
          }
    }'

{
  "name": "projects/123456/locations/global/collections/default_collection/engines/my-app/controls/boost-kids",
  "displayName": "Boost childrens category",
  "solutionType": "SOLUTION_TYPE_RECOMMENDATION",
  "boostAction": {
    "boost": 0.3,
    "filter": "categories: ANY(\"Children\")",
    "dataStore": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store"
  }
}

このコマンドは、子ども向けに分類されたドキュメントをブーストします。

レコメンデーションに適用するブーストコントロールごとに、ステップ 3 を繰り返します。たとえば、子供向けの映画をブーストする 1 つのブーストコントロール boost-kids と、ホラー映画を埋め込む 2 つ目のコントロール bury-horror が必要になる場合があります。
サービス提供構成の ID を確認します。サービス提供構成 ID がすでにある場合は、次のステップに進みます。
1. Google Cloud コンソールで、[AI アプリケーション] ページに移動します。
  
  [アプリ] に移動
2. [アプリ] ページで、アプリの名前をクリックします。
3. [構成] ページに移動し、[サービス提供] タブをクリックします。
4. [ID] 列からサービス提供構成 ID を取得します。

engines.servingConfigs.patch メソッドを使用して、更新リクエストで新しいブーストサービス提供コントロールをサービス構成に関連付けます。

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/CONFIG_ID?update_mask=boost_control_ids" \
-d '{
  "boostControlIds": ["CONTROL_ID"]
}'

次のように置き換えます。

CONFIG_ID: ブーストコントロールを関連付けるサービング構成の ID（例: my_app-1234567_id）。前の手順を参照してください。
CONTROL_ID: サービス提供構成に接続する 1 つ以上のブーストサービス提供コントロールの ID が含まれます（例: "boost-kids", "bury-horror"）。これは文字列の配列です。複数の ID がある場合は、区切り記号の引用符とカンマを使用することを忘れないでください。

コマンドとレスポンスの例

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: my-project-123" \
"https://discoveryengine.googleapis.com/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/servingConfigs/my_app-1234567_id?update_mask=boost_control_ids" \
-d '{
  "boostControlIds": ["boost-kids", "bury-horror"]
}'

{
  "name": "projects/123456/locations/global/collections/default_collection/engines/my-app/servingConfigs/my_app-1234567_id",
  "displayName": "jane-day-test-serving-config-for-boost-bury",
  "solutionType": "SOLUTION_TYPE_RECOMMENDATION",
  "modelId": "my-app",
  "diversityLevel": "no-diversity",
  "diversityType": "RULE_BASED_DIVERSITY",
  "mediaConfig": {},
  "boostControlIds": [
    "boost-kids",
    "bury-horror"
  ]
}

このコマンドは、my-app アプリのデフォルトのサービング構成に 2 つのブーストコントロールをアタッチします。

結果が反映されるまで数分待ちます。
ブースト制御の効果をプレビューします。メディアレコメンデーションを取得するをご覧ください。

ブーストコントロールを更新する

この手順では、既存のブーストコントロールを更新して、ブーストまたはフィルタの値を変更する方法について説明します。

ブーストコントロールをテストした後、ブーストを強くしたり弱くしたりしたいと思うことがあります。また、フィルタ文字列を変更することもできます。

ブースト値またはフィルタを更新する場合は、engines.controls.patch メソッドを呼び出します。

patch メソッドは、boost と filter の値を指定した新しい値に置き換えます。この手順では、boost 値（ステップ 3）と filter 値（ステップ 4）を個別に編集する方法を示します。両方を編集する場合は、1 つの curl コマンドで実行できます。

REST

既存のコントロールのフィルタのブースト値を変更する手順は次のとおりです。

アプリ ID を確認します。アプリ ID がすでにある場合は、次のステップに進みます。
1. Google Cloud コンソールで、[AI アプリケーション] ページに移動します。
  
  [アプリ] に移動
2. [アプリ] ページで、アプリの名前を見つけ、[ID] 列からアプリの ID を取得します。

engines.servingConfigs.get メソッドを使用して、更新するブーストコントロールの ID を見つけます。ID がすでにある場合は、次のステップに進みます。

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls"

次のように置き換えます。

PROJECT_ID: 実際の Google Cloud プロジェクト ID。
APP_ID: Vertex AI Search アプリの ID。

コマンドの例と結果

curl -X GET \
 -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
 -H "Content-Type: application/json" \
 -H "X-Goog-User-Project: my-project-123" \
 "https://discoveryengine.googleapis.com/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/controls"

{
  "controls": [
    {
      "name": "projects/123456/locations/global/collections/default_collection/engines/my-app/controls/boost-kids",
      "displayName": "Boost childrens category",
      "associatedServingConfigIds": [
        "my_app-1234567_id"
      ],
      "solutionType": "SOLUTION_TYPE_RECOMMENDATION",
      "boostAction": {
        "boost": 0.3,
        "filter": "categories: ANY(\"Children\")",
        "dataStore": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store"
      }
    },
    {
      "name": "projects/123456/locations/global/collections/default_collection/engines/my-app/controls/bury-horror",
      "displayName": "Bury horror category",
      "associatedServingConfigIds": [
        "my_app-1234567_id"
      ],
      "solutionType": "SOLUTION_TYPE_RECOMMENDATION",
      "boostAction": {
        "boost": -0.4,
        "filter": "categories: ANY(\"Horror\")",
        "dataStore": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store"
      }
    }
  ]
}

このコマンドは、アプリに関連付けられているすべてのコントロールを一覧表示します。更新するブーストコントロールの名前をメモしておきます。

コントロールのブースト値を編集します。

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls/CONTROL_ID?update_mask=boost_action.boost" \
-d '{
    "name": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls/CONTROL_ID",
    "boostAction": {
      "boost": BOOST_VALUE
    }
}'

次のように置き換えます。

PROJECT_ID: 実際の Google Cloud プロジェクト ID。
APP_ID: Vertex AI Search アプリの ID。
CONTROL_ID: 編集するブースト制御の一意の識別子。ステップ 2 で GET コマンドによって出力された name フィールドの最後の部分。例: boost-kids
BOOST_VALUE: [-1,1] の範囲の浮動小数点数。値が負の場合、結果の下位に推奨事項が表示されます。値が正の場合、推奨事項は昇格されます（結果の上位に表示されます）。

コマンドの例と結果

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: my-project-123" \
"https://discoveryengine.googleapis.com/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/controls/boost-kids?update_mask=boost_action.boost" \
-d '{
    "name": "projects/my-project-123/locations/global/collections/default_collection/engines/my-app/controls/boost-kids",
    "boostAction": {
      "boost": 0.2
    }
}'

{
  "name": "projects/123456/locations/global/collections/default_collection/engines/my-app/controls/boost-kids",
  "displayName": "Boost childrens category",
  "solutionType": "SOLUTION_TYPE_RECOMMENDATION",
  "boostAction": {
    "boost": 0.2,
    "filter": "categories: ANY(\"Children\")",
    "dataStore": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store"
  }
}

このコマンドブーストは、boost-kids コントロールのブースト値を 0.2 に設定します。

ブーストコントロールのフィルタを編集します。

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls/CONTROL_ID?update_mask=boost_action.filter" \
-d '{
    "name": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls/CONTROL_ID",
    "boostAction": {
      "filter": "FILTER"
    }
}'

次のように置き換えます。

PROJECT_ID: 実際の Google Cloud プロジェクト ID。
APP_ID: Vertex AI Search アプリの ID。
CONTROL_ID: 編集するブースト制御の一意の識別子。ステップ 2 の GET コマンドで出力された name フィールドの最後の部分。
FILTER: ブーストまたは非表示にするドキュメントを記述するフィルタ式。フィルタ式を作成する方法の詳細については、フィルタ式をご覧ください。

コマンドの例と結果

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: my-project-123" \
"https://discoveryengine.googleapis.com/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/controls/boost-kids?update_mask=boost_action.filter" \
-d '{
"name": "projects/my-project-123/locations/global/collections/default_collection/engines/my-app/controls/boost-kids",
"boostAction": {
  "filter": "categories: ANY(\"animation\") AND categories: ANY(\"children\")"
}
}'

{
  "name": "projects/123456/locations/global/collections/default_collection/engines/my-app/controls/boost-kids",
  "displayName": "Boost childrens category",
  "solutionType": "SOLUTION_TYPE_RECOMMENDATION",
  "boostAction": {
    "boost": 0.2,
    "filter": "categories: ANY(\"animation\") AND categories: ANY(\"children\")",
    "dataStore": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store"
  }
}

このコマンドは、カテゴリ animation のフィルタを追加して、子ども向けのアニメーションメディアをブーストします。フィルタは既存のフィルタを置き換えます。

ブーストコントロールを削除する

この手順では、ブースト制御を削除する方法について説明します。ブースト制御を使用していない場合は、許可されている制御の数の割り当てに達したり、割り当てを超えたりしないように、ブースト制御を削除することをおすすめします。

ブースト制御を削除するときは、engines.controls.delete メソッドを呼び出します。

サービス構成に関連付けられているブーストコントロールは削除できません。ブースト制御を削除しようとすると、エラーメッセージにサービング構成の名前が表示されます。次に、そのサービス構成を削除するか、サービス構成からコントロールを切り離す必要があります。

REST

ブースト制御を削除する手順は次のとおりです。

アプリ ID を確認します。アプリ ID がすでにある場合は、次のステップに進みます。
1. Google Cloud コンソールで、[AI アプリケーション] ページに移動します。
  
  [アプリ] に移動
2. [アプリ] ページで、アプリの名前を見つけ、[ID] 列からアプリの ID を取得します。

engines.servingConfigs.get メソッドを使用して、削除するブースト制御の ID を見つけます。ID がすでにある場合は、次のステップに進みます。

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls"

次のように置き換えます。

PROJECT_ID: 実際の Google Cloud プロジェクト ID。
APP_ID: Vertex AI Search アプリの ID。

コマンドの例と結果

curl -X GET \
 -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
 -H "Content-Type: application/json" \
 -H "X-Goog-User-Project: my-project-123" \
 "https://discoveryengine.googleapis.com/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/controls"

{
  "controls": [
    {
      "name": "projects/123456/locations/global/collections/default_collection/engines/my-app/controls/boost-kids",
      "displayName": "Boost childrens category",
      "associatedServingConfigIds": [
        "my_app-1234567_id"
      ],
      "solutionType": "SOLUTION_TYPE_RECOMMENDATION",
      "boostAction": {
        "boost": 0.2,
        "filter": "categories: ANY(\"animation\") AND categories: ANY(\"children\")",
        "dataStore": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store"
      }
    },
    {
      "name": "projects/123456/locations/global/collections/default_collection/engines/my-app/controls/bury-horror",
      "displayName": "Bury horror category",
      "associatedServingConfigIds": [
        "my_app-1234567_id"
      ],
      "solutionType": "SOLUTION_TYPE_RECOMMENDATION",
      "boostAction": {
        "boost": -0.4,
        "filter": "categories: ANY(\"Horror\")",
        "dataStore": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store"
      }
    }
  ]
}

このコマンドは、アプリに関連付けられているすべてのコントロールを一覧表示します。

出力を確認します。サービス構成にブーストコントロールが関連付けられている場合は、サービス構成を更新して、削除するコントロールを削除します。サービス構成を更新してブーストコントロールを削除するをご覧ください。
次の curl コマンドを実行して、ブースト制御を削除します。
```
curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls/CONTROL_ID"
```
次のように置き換えます。
- PROJECT_ID: 実際の Google Cloud プロジェクト ID。
- APP_ID: Vertex AI Search アプリの ID。
- CONTROL_ID: 削除するブースト制御の一意の識別子。ステップ 2 の GET コマンドで出力された name フィールドの最後の部分。
コマンドの例
```
curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: my-project-123" \
"https://discoveryengine.googleapis.com/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/controls/boost-kids"
```
```
{}
```
このコマンドは、boost-kids コントロールを削除します。
コントロールが 1 つ以上のサービング構成でアクティブに参照されていることを示すエラーメッセージが表示された場合は、サービング構成を更新してブーストコントロールを削除するをご覧ください。

サービス構成を更新してブーストコントロールを削除する

ブーストコントロールを削除する前に、すべてのサービングコントロールからブーストコントロールを切り離す必要があります。これを行うには、サービス提供コントロールにパッチを適用して、ブーストコントロールの ID を削除します。

ブーストコントロールをサービス構成から切り離すには、次の操作を行います。

engines.servingConfigs.get リクエストを行い、レスポンスの boostControlIds フィールドを確認して、サービス提供構成に適用されているブーストコントロールを特定します。

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/CONFIG_ID"

次のように置き換えます。

PROJECT_ID: 実際の Google Cloud プロジェクト ID。
APP_ID: Vertex AI Search アプリの ID。
CONFIG_ID: 詳細を確認するサービス提供構成の ID。

コマンドの例と結果

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: my-project-123" \
"https://discoveryengine.googleapis.com/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/servingConfigs/my_app-1234567_id"

{
  "name": "projects/123456/locations/global/collections/default_collection/engines/my-app/servingConfigs/my_app-1234567_id",
  "displayName": "jane-day-test-serving-config-for-boost-bury",
  "solutionType": "SOLUTION_TYPE_RECOMMENDATION",
  "modelId": "my-app",
  "diversityLevel": "no-diversity",
  "diversityType": "RULE_BASED_DIVERSITY",
  "mediaConfig": {},
  "createTime": "2024-11-22T23:54:45.613178Z",
  "updateTime": "2024-11-26T20:28:11.967439Z",
  "boostControlIds": [
    "boost-kids",
    "bury-horror"
  ]
}

このコマンドは、サービス提供構成 my_app-1234567_id に関する情報を一覧表示します。特に、サービス提供構成に boost-kids と bury-horror の 2 つのブーストコントロールが関連付けられていることを示します。

サービス構成を更新してブーストコントロールを 1 つ削除するには、engines.servingConfigs.patch メソッドを使用します。

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/CONFIG_ID?update_mask=boost_control_ids" \
-d '{
  "boostControlIds": ["CONTROL_ID"]
}'

次のように置き換えます。

CONFIG_ID: ブーストコントロールを関連付けるサービング構成の ID（例: my_app-1234567_id）。前の手順を参照してください。
CONTROL_ID: サービス提供構成に含めるブースト制御の ID を 1 つ以上含む。削除するブーストコントロールは省略してください。これは文字列の配列です。複数の ID がある場合は、区切り記号として引用符とカンマを使用してください（例: boost-1", "boost-2）。

コマンドと結果の例: 1 つのコントロールを残す

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: my-project-123" \
"https://discoveryengine.googleapis.com/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/servingConfigs/my_app-1234567_id?update_mask=boost_control_ids" \
-d '{
  "boostControlIds": ["bury-horror"]
}'

{
  "name": "projects/123456/locations/global/collections/default_collection/engines/my-app/servingConfigs/my_app-1234567_id",
  "displayName": "jane-day-test-serving-config-for-boost-bury",
  "solutionType": "SOLUTION_TYPE_RECOMMENDATION",
  "modelId": "my-app",
  "diversityLevel": "no-diversity",
  "diversityType": "RULE_BASED_DIVERSITY",
  "mediaConfig": {},
  "boostControlIds": [
    "bury-horror"
  ]
}

このコマンドは、bury-horror ブーストコントロールをサービス提供構成に保持し、boost-kids コントロールを削除します。boost-kids が他のサービング構成に関連付けられていないと仮定すると、削除できるようになります。ブースト制御を削除するをご覧ください。

コマンドと結果の例: すべてのコントロールを削除する

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: my-project-123" \
"https://discoveryengine.googleapis.com/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/servingConfigs/my_app-1234567_id?update_mask=boost_control_ids" \
-d '{
"boostControlIds": []
}'

{
"name": "projects/123456/locations/global/collections/default_collection/engines/my-app/servingConfigs/my_app-1234567_id",
"displayName": "jane-day-test-serving-config-for-boost-bury",
"solutionType": "SOLUTION_TYPE_RECOMMENDATION",
"modelId": "my-app",
"diversityLevel": "no-diversity",
"diversityType": "RULE_BASED_DIVERSITY",
"mediaConfig": {}
}

このコマンドは、サービス構成 my_app-1234567_id からすべてのブーストコントロールを削除します。

メディア レコメンデーションを優先表示または非表示にする コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

レコメンデーションのブーストとフィルタリング

レコメンデーション モデルの過負荷を回避する

降格と非表示

ブースト コントロールとサービス構成について

ブースト値は加算される

フィルタの例

一般的なキー プロパティのフィルタ

メディアキーのプロパティでフィルタ

カスタム フィールド

フィルタリング可能なフィールドの制限事項

始める前に

推奨事項をブーストまたはベリーする

REST

コマンドとレスポンスの例

コマンドとレスポンスの例

ブースト コントロールを更新する

REST

コマンドの例と結果

コマンドの例と結果

コマンドの例と結果

ブースト コントロールを削除する

REST

コマンドの例と結果

コマンドの例

サービス構成を更新してブースト コントロールを削除する

コマンドの例と結果

コマンドと結果の例: 1 つのコントロールを残す

コマンドと結果の例: すべてのコントロールを削除する

メディアレコメンデーションを優先表示または非表示にする

レコメンデーションモデルの過負荷を回避する

ブーストコントロールとサービス構成について

一般的なキープロパティのフィルタ

カスタムフィールド

ブーストコントロールを更新する

ブーストコントロールを削除する

サービス構成を更新してブーストコントロールを削除する