Generated from protobuf messagegoogle.cloud.discoveryengine.v1.RankingRecord
Namespace
Google \ Cloud \ DiscoveryEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ id
string
The unique ID to represent the record.
↳ title
string
The title of the record. Empty by default. At least one oftitleorcontentshould be set otherwise an INVALID_ARGUMENT error is thrown.
↳ content
string
The content of the record. Empty by default. At least one oftitleorcontentshould be set otherwise an INVALID_ARGUMENT error is thrown.
↳ score
float
The score of this record based on the given query and selected model. The score will be rounded to 2 decimal places. If the score is close to 0, it will be rounded to 0.0001 to avoid returning unset.
getId
The unique ID to represent the record.
Returns
Type
Description
string
setId
The unique ID to represent the record.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getTitle
The title of the record. Empty by default.
At least one oftitleorcontentshould be
set otherwise an INVALID_ARGUMENT error is thrown.
Returns
Type
Description
string
setTitle
The title of the record. Empty by default.
At least one oftitleorcontentshould be
set otherwise an INVALID_ARGUMENT error is thrown.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getContent
The content of the record. Empty by default.
At least one oftitleorcontentshould be
set otherwise an INVALID_ARGUMENT error is thrown.
Returns
Type
Description
string
setContent
The content of the record. Empty by default.
At least one oftitleorcontentshould be
set otherwise an INVALID_ARGUMENT error is thrown.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getScore
The score of this record based on the given query and selected model.
The score will be rounded to 2 decimal places. If the score is close to 0,
it will be rounded to 0.0001 to avoid returning unset.
Returns
Type
Description
float
setScore
The score of this record based on the given query and selected model.
The score will be rounded to 2 decimal places. If the score is close to 0,
it will be rounded to 0.0001 to avoid returning unset.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class RankingRecord (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.RankingRecord)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.RankingRecord)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.RankingRecord)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.RankingRecord)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.RankingRecord)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.RankingRecord)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.RankingRecord)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.RankingRecord)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.RankingRecord)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.RankingRecord)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.RankingRecord)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.RankingRecord)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.RankingRecord)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.RankingRecord)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.RankingRecord)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.RankingRecord)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.RankingRecord) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class RankingRecord.\n\nRecord message for\n[RankService.Rank](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.RankServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_RankServiceClient__rank__) method.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.RankingRecord`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getId\n\nThe unique ID to represent the record.\n\n### setId\n\nThe unique ID to represent the record.\n\n### getTitle\n\nThe title of the record. Empty by default.\n\nAt least one of\n[title](/php/docs/reference/cloud-discoveryengine/latest/V1.RankingRecord#_Google_Cloud_DiscoveryEngine_V1_RankingRecord__getTitle__) or\n[content](/php/docs/reference/cloud-discoveryengine/latest/V1.RankingRecord#_Google_Cloud_DiscoveryEngine_V1_RankingRecord__getContent__) should be\nset otherwise an INVALID_ARGUMENT error is thrown.\n\n### setTitle\n\nThe title of the record. Empty by default.\n\nAt least one of\n[title](/php/docs/reference/cloud-discoveryengine/latest/V1.RankingRecord#_Google_Cloud_DiscoveryEngine_V1_RankingRecord__getTitle__) or\n[content](/php/docs/reference/cloud-discoveryengine/latest/V1.RankingRecord#_Google_Cloud_DiscoveryEngine_V1_RankingRecord__getContent__) should be\nset otherwise an INVALID_ARGUMENT error is thrown.\n\n### getContent\n\nThe content of the record. Empty by default.\n\nAt least one of\n[title](/php/docs/reference/cloud-discoveryengine/latest/V1.RankingRecord#_Google_Cloud_DiscoveryEngine_V1_RankingRecord__getTitle__) or\n[content](/php/docs/reference/cloud-discoveryengine/latest/V1.RankingRecord#_Google_Cloud_DiscoveryEngine_V1_RankingRecord__getContent__) should be\nset otherwise an INVALID_ARGUMENT error is thrown.\n\n### setContent\n\nThe content of the record. Empty by default.\n\nAt least one of\n[title](/php/docs/reference/cloud-discoveryengine/latest/V1.RankingRecord#_Google_Cloud_DiscoveryEngine_V1_RankingRecord__getTitle__) or\n[content](/php/docs/reference/cloud-discoveryengine/latest/V1.RankingRecord#_Google_Cloud_DiscoveryEngine_V1_RankingRecord__getContent__) should be\nset otherwise an INVALID_ARGUMENT error is thrown.\n\n### getScore\n\nThe score of this record based on the given query and selected model.\n\nThe score will be rounded to 2 decimal places. If the score is close to 0,\nit will be rounded to 0.0001 to avoid returning unset.\n\n### setScore\n\nThe score of this record based on the given query and selected model.\n\nThe score will be rounded to 2 decimal places. If the score is close to 0,\nit will be rounded to 0.0001 to avoid returning unset."]]
