Reference documentation and code samples for the Google Cloud Talent Solution V4 Client class CustomRankingInfo.
Custom ranking information for SearchJobsRequest.
Generated from protobuf message google.cloud.talent.v4.SearchJobsRequest.CustomRankingInfo
Namespace
Google \ Cloud \ Talent \ V4 \ SearchJobsRequestMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ importance_level |
int
Required. Controls over how important the score of CustomRankingInfo.ranking_expression gets applied to job's final ranking position. An error is thrown if not specified. |
↳ ranking_expression |
string
Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). A combination of the ranking expression and relevance score is used to determine job's final ranking position. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: +, -, *, /, where the left and right side of the operator is either a numeric Job.custom_attributes key, integer/double value or an expression that can be evaluated to a number. Parenthesis are supported to adjust calculation precedence. The expression must be < 200 characters in length. The expression is considered invalid for a job if the expression references custom attributes that are not populated on the job or if the expression results in a divide by zero. If an expression is invalid for a job, that job is demoted to the end of the results. Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5) |
getImportanceLevel
Required. Controls over how important the score of CustomRankingInfo.ranking_expression gets applied to job's final ranking position.
An error is thrown if not specified.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ImportanceLevel. |
setImportanceLevel
Required. Controls over how important the score of CustomRankingInfo.ranking_expression gets applied to job's final ranking position.
An error is thrown if not specified.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ImportanceLevel. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRankingExpression
Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). A combination of the ranking expression and relevance score is used to determine job's final ranking position.
The syntax for this expression is a subset of Google SQL syntax. Supported operators are: +, -, *, /, where the left and right side of the operator is either a numeric Job.custom_attributes key, integer/double value or an expression that can be evaluated to a number. Parenthesis are supported to adjust calculation precedence. The expression must be < 200 characters in length. The expression is considered invalid for a job if the expression references custom attributes that are not populated on the job or if the expression results in a divide by zero. If an expression is invalid for a job, that job is demoted to the end of the results. Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5)
| Returns | |
|---|---|
| Type | Description |
string |
|
setRankingExpression
Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). A combination of the ranking expression and relevance score is used to determine job's final ranking position.
The syntax for this expression is a subset of Google SQL syntax. Supported operators are: +, -, *, /, where the left and right side of the operator is either a numeric Job.custom_attributes key, integer/double value or an expression that can be evaluated to a number. Parenthesis are supported to adjust calculation precedence. The expression must be < 200 characters in length. The expression is considered invalid for a job if the expression references custom attributes that are not populated on the job or if the expression results in a divide by zero. If an expression is invalid for a job, that job is demoted to the end of the results. Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5)
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|