Class: Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo

Inherits:

Object

Object
Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo

show all

Defined in:: lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb

Overview

Custom ranking information for SearchJobsRequest.

Defined Under Namespace

Modules: ImportanceLevel

Instance Attribute Summary collapse

Instance Attribute Details

#importance_level ⇒ `Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo::ImportanceLevel`

Returns 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:

(Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo::ImportanceLevel) —
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.

# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb', line 471

class CustomRankingInfo
  # The importance level for
  # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo#ranking_expression CustomRankingInfo#ranking_expression}.
  module ImportanceLevel
    # Default value if the importance level isn't specified.
    IMPORTANCE_LEVEL_UNSPECIFIED = 0

    # The given ranking expression is of None importance, existing relevance
    # score (determined by API algorithm) dominates job's final ranking
    # position.
    NONE = 1

    # The given ranking expression is of Low importance in terms of job's
    # final ranking position compared to existing relevance
    # score (determined by API algorithm).
    LOW = 2

    # The given ranking expression is of Mild importance in terms of job's
    # final ranking position compared to existing relevance
    # score (determined by API algorithm).
    MILD = 3

    # The given ranking expression is of Medium importance in terms of job's
    # final ranking position compared to existing relevance
    # score (determined by API algorithm).
    MEDIUM = 4

    # The given ranking expression is of High importance in terms of job's
    # final ranking position compared to existing relevance
    # score (determined by API algorithm).
    HIGH = 5

    # The given ranking expression is of Extreme importance, and dominates
    # job's final ranking position with existing relevance
    # score (determined by API algorithm) ignored.
    EXTREME = 6
  end
end

#ranking_expression ⇒ `String`

Returns Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). The product of 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 < 100 characters in length.

Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5).