RecommendResponse

Recommend メソッドのレスポンス メッセージ。

JSON 表現
{
  "results": [
    {
      object (RecommendationResult)
    }
  ],
  "attributionToken": string,
  "missingIds": [
    string
  ],
  "validateOnly": boolean
}
フィールド
results[]

object (RecommendationResult)

おすすめのドキュメントのリスト。順序はランキング(最も関連性の高いドキュメントから最も関連性の低いドキュメント)を表します。

attributionToken

string

一意のアトリビューション トークン。これは、この推奨事項の結果として得られる UserEvent ログに含まれる必要があります。これにより、推奨事項モデルのパフォーマンスを正確に特定できます。

missingIds[]

string

リクエストされた ServingConfig に関連付けられたデフォルトのブランチに存在しなかった、リクエスト内のドキュメントの ID。

validateOnly

boolean

RecommendRequest.validate_only が設定されている場合は true。

RecommendationResult

RecommendationResult は、関連するメタデータを含む一般的な推奨事項の結果を表します。

JSON 表現
{
  "id": string,
  "document": {
    object (Document)
  },
  "metadata": {
    string: value,
    ...
  }
}
フィールド
id

string

推奨されるドキュメントのリソース ID。

document

object (Document)

RecommendRequest.paramsreturnDocument が true に設定されている場合に設定します。

metadata

map (key: string, value: value (Value format))

追加のドキュメントのメタデータまたはアノテーション。

値は次のいずれかです。

  • score: レコメンデーション スコア(double 値)。RecommendRequest.paramsreturnScore が true に設定されている場合に設定されます。