このページは 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\")
カスタムブール値フィールド audio_desc があり、視覚障がいのある視聴者向けの音声による説明がメディアに含まれている場合は true になります。音声の説明を含むメディアをフィルタするには:
"filter": "attributes.audio_desc: ANY(true)"

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

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

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

始める前に

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

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

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

コントロールをサービス構成に接続したら、servingConfigs.recommend メソッドを呼び出すときにサービス構成を指定できます。ブーストコントロールは、返されるおすすめコンテンツの順序に影響を与えるために使用されます。

REST

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

アプリ ID を確認します。アプリ ID がすでにある場合は、次のステップに進みます。
1. Google Cloud コンソールで、[Agent Builder] ページに移動します。
  
  [アプリ] に移動
2. [アプリ] ページでアプリの名前を見つけ、[ID] 列からアプリの ID を取得します。
データストア ID を確認します。データストア ID がすでにある場合は、次のステップに進みます。
1. Google Cloud コンソールで [Agent Builder] ページに移動し、ナビゲーションメニューで [データストア] をクリックします。
  
  [データストア] ページに移動
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: コントロールを識別するための判読可能な名前。UTF-8 文字列で、最大長は 128 文字です。
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 コンソールで、[Agent Builder] ページに移動します。
  
  [アプリ] に移動
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 メソッドを呼び出します。

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

REST

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

アプリ ID を確認します。アプリ ID がすでにある場合は、次のステップに進みます。
1. Google Cloud コンソールで、[Agent Builder] ページに移動します。
  
  [アプリ] に移動
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: 編集するブースト制御の一意の 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: 編集するブースト制御の一意の 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 コンソールで、[Agent Builder] ページに移動します。
  
  [アプリ] に移動
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 つのコントロールを残す

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

メディアレコメンデーションをブーストまたはベリーする

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

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

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

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

カスタムフィールド

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

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

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