Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class RankSignals.
A set of ranking signals.
Generated from protobuf message google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ SearchResponse \ SearchResultMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ keyword_similarity_score |
float
Keyword matching adjustment. |
↳ relevance_score |
float
Semantic relevance adjustment. |
↳ semantic_similarity_score |
float
Semantic similarity adjustment. |
↳ pctr_rank |
float
Predicted conversion rate adjustment as a rank. |
↳ topicality_rank |
float
Topicality adjustment as a rank. |
↳ document_age |
float
Age of the document in hours. |
↳ boosting_factor |
float
Combined custom boosts for a doc. |
↳ default_rank |
float
The default rank of the result. |
↳ custom_signals |
array<RankSignals\CustomSignal>
A list of custom clearbox signals. |
getKeywordSimilarityScore
Keyword matching adjustment.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasKeywordSimilarityScore
clearKeywordSimilarityScore
setKeywordSimilarityScore
Keyword matching adjustment.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRelevanceScore
Semantic relevance adjustment.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasRelevanceScore
clearRelevanceScore
setRelevanceScore
Semantic relevance adjustment.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSemanticSimilarityScore
Semantic similarity adjustment.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasSemanticSimilarityScore
clearSemanticSimilarityScore
setSemanticSimilarityScore
Semantic similarity adjustment.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPctrRank
Predicted conversion rate adjustment as a rank.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasPctrRank
clearPctrRank
setPctrRank
Predicted conversion rate adjustment as a rank.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTopicalityRank
Topicality adjustment as a rank.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasTopicalityRank
clearTopicalityRank
setTopicalityRank
Topicality adjustment as a rank.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDocumentAge
Age of the document in hours.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasDocumentAge
clearDocumentAge
setDocumentAge
Age of the document in hours.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBoostingFactor
Combined custom boosts for a doc.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasBoostingFactor
clearBoostingFactor
setBoostingFactor
Combined custom boosts for a doc.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDefaultRank
The default rank of the result.
| Returns | |
|---|---|
| Type | Description |
float |
|
setDefaultRank
The default rank of the result.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCustomSignals
A list of custom clearbox signals.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCustomSignals
A list of custom clearbox signals.
| Parameter | |
|---|---|
| Name | Description |
var |
array<RankSignals\CustomSignal>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|