本頁面說明如何使用 Google Cloud 控制台預覽建議,以及如何使用 API 取得建議結果。請參閱「REST」分頁,查看 API 呼叫範例,瞭解如何將建議整合至應用程式。
實際程序視您要匯入媒體資料或自訂資料而定:
取得媒體推薦內容
控制台
如要使用 Google Cloud 控制台預覽媒體建議,請按照下列步驟操作:
前往 Google Cloud 控制台的「AI Applications」頁面。
按一下您要預覽建議的應用程式名稱。
依序點選「Configurations」 >「Training」。如果「Ready to query」(準備好查詢) 為「Yes」(是), 則表示應用程式已可供預覽。
按一下「預覽」。
按一下「Document ID」(文件 ID) 欄位。畫面上就會顯示文件 ID 清單。
針對您要取得建議的文件,按一下對應的文件 ID。 您也可以在「Document ID」(文件 ID) 欄位中輸入文件 ID。
按一下「選取供應設定」,然後選取要預覽的供應設定。
選用:輸入您已收集使用者事件的使用者訪客 ID (也稱為虛擬使用者 ID)。如果將這個欄位留空或輸入不存在的訪客 ID,系統會以新使用者身分預覽建議。
按一下「Get recommendations」(推薦內容)。畫面上就會顯示建議的文件清單。
按一下文件即可取得文件詳細資料。
REST
如要使用 API 取得媒體建議,請使用 servingConfigs.recommend
方法:
找出引擎 ID 和供應設定 ID。如果您已有引擎 ID 和放送設定 ID,請跳至步驟 2。
前往 Google Cloud 控制台的「AI Applications」頁面。
按一下應用程式名稱。
在導覽窗格中,按一下「設定」。
如果只有一個供應設定,請取得「供應」分頁中顯示的供應設定 ID。
如果「供應」分頁中列出多項供應設定,請找出要取得建議的供應設定。供應設定 ID 是「ID」欄中的值。
按一下「訓練」分頁標籤。引擎 ID 是「應用程式 ID」列中的值。
確認應用程式已準備好供預覽:
前往 Google Cloud 控制台的「AI Applications」頁面。
按一下應用程式名稱。
依序點選「Configurations」 >「Training」。如果「Ready to query」(準備好查詢) 為「Yes」(是), 則表示應用程式已可供預覽。
取得建議。
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ -d '{ "validateOnly": false, "userEvent": { "eventType": "view-item", "userPseudoId": "USER_PSEUDO_ID", "documents": [{ "id": "DOCUMENT_ID" }], "filter": "FILTER_STRING" } }' \ "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/servingConfigs/SERVING_CONFIG_ID:recommend"
更改下列內容:
PROJECT_ID
:專案 ID。DATA_STORE_ID
:資料儲存庫的 ID。DOCUMENT_ID
:您要預覽建議的文件 ID。請使用您擷取資料時,為這份文件使用的 ID。USER_PSEUDO_ID
:以 UTF-8 編碼的字串,可做為追蹤使用者的專屬匿名 ID。長度上限為 128 個半形字元。 Google 強烈建議使用這個欄位,因為這有助於提升模型效能和個人化品質。您可以使用 HTTP Cookie 做為這個欄位的值,明確識別單一裝置上的訪客。以下是幾個重要考量:- 訪客登入或登出網站時,這個 ID 不會變更。
- 這個欄位不得為多位使用者設定相同的 ID。 否則,相同的使用者 ID 可能會合併不同使用者的事件記錄,導致模型品質下降。
- 這個欄位不得包含個人識別資訊 (PII)。
詳情請參閱
userPseudoId
。SERVING_CONFIG_ID
:供應設定的 ID。FILTER
:選用。文字欄位,可讓您使用篩選運算式語法,篩選特定欄位集。預設值為空白字串,表示未套用任何篩選器。詳情請參閱「篩選最佳化建議」。
您應該會看到類似下方的結果:
{ "results": [{"id": "sample-id-1"}, {"id": "sample-id-2"}], "attributionToken": "abc123" }
Google 建議您將歸因權杖 (我們會在每個搜尋回應和建議中加入) 與使用者因應這些搜尋回應和建議而採取的動作建立關聯。這有助於提升搜尋回覆和建議的品質。如要這麼做,請在網站上顯示的每個搜尋結果或建議連結網址中,附加 attributionToken
值,例如:https://www.example.com/54321/?rtoken=abc123
。使用者點選其中一個連結時,請在您記錄的使用者事件中加入 attributionToken
值。
取得使用自訂結構化資料的應用程式建議
控制台
如要使用 Google Cloud 控制台預覽結構化應用程式的自訂建議,請按照下列步驟操作:
前往 Google Cloud 控制台的「AI Applications」頁面。
按一下您要預覽建議的應用程式名稱。
按一下「預覽」。
按一下「Document ID」(文件 ID) 欄位。畫面上就會顯示文件 ID 清單。
針對您要取得建議的文件,按一下對應的文件 ID。 您也可以在「Document ID」(文件 ID) 欄位中輸入文件 ID。
按一下「Get recommendations」(推薦內容)。畫面上就會顯示建議的文件清單。
按一下文件即可取得文件詳細資料。
REST
如要使用 API 取得含有結構化資料的應用程式自訂建議,請使用 servingConfigs.recommend
方法:
找出引擎 ID。如果您已有引擎 ID,請跳至步驟 2。
前往 Google Cloud 控制台的「AI Applications」頁面。
按一下應用程式名稱。
從 Google Cloud 控制台的網址取得引擎 ID。這是
engines/
和/data
之間的文字。舉例來說,如果網址包含gen-app-builder/engines/demo_1234567890123/data/records
則引擎 ID 為
demo_1234567890123
。
找出資料儲存庫 ID。如果已有資料商店 ID,請跳到下一個步驟。
前往 Google Cloud 控制台的「AI Applications」頁面,然後點按導覽選單中的「Data Stores」(資料儲存庫)。
點按資料儲存庫的名稱。
在資料儲存庫的「資料」頁面中,取得資料儲存庫 ID。
輪詢
GetEngine
方法,直到系統傳回"servingState":"ACTIVE"
為止,確認引擎已準備好預覽。此時引擎已可供預覽。curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/ENGINE_ID
更改下列內容:
PROJECT_ID
:專案 ID。ENGINE_ID
:引擎 ID。
取得建議。
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -d '{ "userEvent": { "eventType":"view-item", "userPseudoId":"USER_PSEUDO_ID", "documents":[{"id":"DOCUMENT_ID"}]}}' \ "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/servingConfigs/SERVING_CONFIG_ID:recommend"
更改下列內容:
PROJECT_ID
:專案 ID。DATA_STORE_ID
:資料儲存庫的 ID。DOCUMENT_ID
:您要預覽建議的文件 ID。請使用您擷取資料時,為這份文件使用的 ID。USER_PSEUDO_ID
:以 UTF-8 編碼的字串,可做為追蹤使用者的專屬匿名 ID。長度上限為 128 個半形字元。 Google 強烈建議使用這個欄位,因為這有助於提升模型效能和個人化品質。您可以使用 HTTP Cookie 做為這個欄位的值,明確識別單一裝置上的訪客。以下是幾個重要考量:- 訪客登入或登出網站時,這個 ID 不會變更。
- 這個欄位不得為多位使用者設定相同的 ID。 否則,相同的使用者 ID 可能會合併不同使用者的事件記錄,導致模型品質下降。
- 這個欄位不得包含個人識別資訊 (PII)。
詳情請參閱
userPseudoId
。SERVING_CONFIG_ID
:供應設定的 ID。供應設定 ID 與引擎 ID 相同,因此請在此處使用引擎 ID。
C#
詳情請參閱 AI Applications C# API 參考說明文件。
如要向 AI Applications 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Go
詳情請參閱 AI Applications Go API 參考說明文件。
如要向 AI Applications 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Java
詳情請參閱 AI Applications Java API 參考說明文件。
如要向 AI Applications 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Node.js
詳情請參閱 AI Applications Node.js API 參考說明文件。
如要向 AI Applications 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
PHP
詳情請參閱 AI Applications PHP API 參考說明文件。
如要向 AI Applications 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Python
詳情請參閱 AI Applications Python API 參考說明文件。
如要向 AI Applications 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Ruby
詳情請參閱 AI Applications Ruby API 參考說明文件。
如要向 AI Applications 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。