Method: projects.locations.rankingConfigs.rank

根據指定的輸入查詢，為文字記錄清單排序。

HTTP 要求

POST https://discoveryengine.googleapis.com/v1alpha/{rankingConfig=projects/*/locations/*/rankingConfigs/*}:rank

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
rankingConfig

string

這是必要旗標，排序服務設定的資源名稱，例如 projects/{projectNum}/locations/{location}/rankingConfigs/default_ranking_config。

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "model": string,
  "topN": integer,
  "query": string,
  "records": [
    {
      object (RankingRecord)
    }
  ],
  "ignoreRecordDetailsInResponse": boolean,
  "userLabels": {
    string: string,
    ...
  }
}
欄位
model

string

要使用的模型 ID。可以是下列其中一個值：

  • semantic-ranker-512@latest：語意排名模型，輸入權杖大小上限為 512。

如未指定，則預設為 semantic-ranker-512@latest。
topN

integer

要傳回的結果數。如果未設定或不超過零，則會傳回所有結果。
query

string

要使用的查詢。
records[]

object (RankingRecord)

這是必要旗標，要排序的記錄清單。
ignoreRecordDetailsInResponse

boolean

如果為 true，回應只會包含記錄 ID 和分數。預設值為 false，回應會包含記錄詳細資料。
userLabels

map (key: string, value: string)

套用於資源的使用者標籤必須符合下列規定：

  • 每項資源可以有多個標籤，上限為 64 個。
  • 每個標籤都必須是鍵/值組合。
  • 鍵的長度必須至少為 1 個字元，最多 63 個字元，且不能空白。值可以空白，長度上限為 63 個字元。
  • 鍵和值只能使用小寫字母、數字字元、底線和連字號。所有字元都必須使用 UTF-8 編碼，且可使用國際字元。
  • 標籤中的鍵部分不得重複，但可讓多個資源使用相同的鍵。
  • 鍵的開頭必須是小寫字母或國際字元。

詳情請參閱 Google Cloud 文件。

回應主體

RankService.Rank 方法的回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "records": [
    {
      object (RankingRecord)
    }
  ]
}
欄位
records[]

object (RankingRecord)

依分數遞減排序的記錄清單。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳情請參閱Authentication Overview。

IAM 權限

需要 rankingConfig 資源的下列 IAM 權限：

  • discoveryengine.rankingConfigs.rank

詳情請參閱 IAM 說明文件。

RankingRecord

錄製要傳送給 RankService.Rank 方法的訊息。

JSON 表示法 
{
  "id": string,
  "title": string,
  "content": string,
  "score": number
}
欄位
id

string

代表記錄的專屬 ID。
title

string

記錄的標題。預設為空白。請至少設定 title 或 content 其中一個，否則會擲回 INVALID_ARGUMENT 錯誤。
content

string

記錄的內容。預設為空白。請至少設定 title 或 content 其中一個，否則會擲回 INVALID_ARGUMENT 錯誤。
score

number

這項記錄的分數，是根據指定查詢和所選模型計算得出。分數會四捨五入到小數點第 2 位。如果分數接近 0，系統會將分數四捨五入為 0.0001，避免傳回未設定的值。