Method: projects.locations.rankingConfigs.rank

指定された入力クエリに基づいて、テキスト レコードのリストをランク付けします。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

使用するモデルの識別子。次のいずれかです。

  • 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)

リソースに適用するユーザーラベルは、次の要件を満たす必要があります。

  • 1 つのリソースには、最大 64 個のラベルを適用できます。
  • ラベルは、Key-Value ペアでなければなりません。
  • キーは 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 の少なくとも 1 つを設定する必要があります。設定しないと、INVALID_ARGUMENT エラーがスローされます。
content

string

レコードの内容。デフォルトでは空です。title または content の少なくとも 1 つを設定する必要があります。設定しないと、INVALID_ARGUMENT エラーがスローされます。
score

number

指定されたクエリと選択されたモデルに基づくこのレコードのスコア。スコアは小数点第 2 位までに四捨五入されます。スコアが 0 に近い場合は、未設定が返されないように 0.0001 に丸められます。