Class SearchJobsRequest (2.13.2)

Version 2.13.2

• 2.15.0 (latest)
• 2.14.1
• 2.13.5
• 2.12.0
• 2.11.1
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.3
• 2.6.0
• 2.5.2
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.0
• 1.0.2
• 0.6.3
• 0.5.0
• 0.4.0
• 0.3.0

SearchJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The Request body of the SearchJobs call.

Attributes
Name	Description
parent	str Required. The resource name of the tenant to search within. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
search_mode	google.cloud.talent_v4.types.SearchJobsRequest.SearchMode Mode of a search. Defaults to SearchMode.JOB_SEARCH.
request_metadata	google.cloud.talent_v4.types.RequestMetadata Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers (such as user_id) are provided by users, and must be unique and consistent.
job_query	google.cloud.talent_v4.types.JobQuery Query used to search against jobs, such as keyword, location filters, etc.
enable_broadening	bool Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false.
histogram_queries	MutableSequence[google.cloud.talent_v4.types.HistogramQuery] An expression specifies a histogram request against matching jobs. Expression syntax is an aggregation function call with histogram facets and other options. Available aggregation function calls are: - count(string_histogram_facet): Count the number of matching entities, for each distinct attribute value. - count(numeric_histogram_facet, list of buckets): Count the number of matching entities within each bucket. A maximum of 200 histogram buckets are supported. Data types: - Histogram facet: facet names with format ``a-zA-Z][a-zA-Z0-9_]+``. - String: string like "any string with backslash escape for quote(")." - Number: whole number and floating point number like 10, -1 and -0.01. - List: list of elements with comma(,) separator surrounded by square brackets, for example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants: - MIN (minimum number similar to java Double.MIN_VALUE) - MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: - bucket(start, end[, label]): bucket built-in function creates a bucket with range of [start, end). Note that the end is exclusive, for example, bucket(1, MAX, "positive number") or bucket(1, 10). Job histogram facets: - company_display_name: histogram by Job.company_display_name. - employment_type: histogram by Job.employment_types, for example, "FULL_TIME", "PART_TIME". - company_size (DEPRECATED): histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". - publish_time_in_day: histogram by the Job.posting_publish_time in days. Must specify list of numeric buckets in spec. - publish_time_in_month: histogram by the Job.posting_publish_time in months. Must specify list of numeric buckets in spec. - publish_time_in_year: histogram by the Job.posting_publish_time in years. Must specify list of numeric buckets in spec. - degree_types: histogram by the Job.degree_types, for example, "Bachelors", "Masters". - job_level: histogram by the Job.job_level, for example, "Entry Level". - country: histogram by the country code of jobs, for example, "US", "FR". - admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level, for example, "CA", "IL". - city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY". - admin1_country: histogram by a combination of the "admin1 code, country", for example, "CA, US", "IL, US". - city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. - locale: histogram by the Job.language_code, for example, "en-US", "fr-FR". - language: histogram by the language subtag of the Job.language_code, for example, "en", "fr". - category: histogram by the JobCategory, for example, "COMPUTER_AND_IT", "HEALTHCARE". - base_compensation_unit: histogram by the CompensationInfo.CompensationUnit of base salary, for example, "WEEKLY", "MONTHLY". - base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. - annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. - annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. - string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute["key1"]. - numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute["key1"]. Must specify list of numeric buckets to group results by. Example expressions: - count(admin1) - count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)]) - count(string_custom_attribute["some-string-custom-attribute"]) - count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
job_view	google.cloud.talent_v4.types.JobView The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_SMALL if no value is specified.
offset	int An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. The maximum allowed value is 5000. Otherwise an error is thrown. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page).
max_page_size	int A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100.
page_token	str The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results.
order_by	str The criteria determining how search results are sorted. Default is "relevance desc". Supported options are: - "relevance desc": By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering. - "posting_publish_time desc": By Job.posting_publish_time descending. - "posting_update_time desc": By Job.posting_update_time descending. - "title": By Job.title ascending. - "title desc": By Job.title descending. - "annualized_base_compensation": By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - "annualized_base_compensation desc": By job's CompensationInfo.annualized_base_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - "annualized_total_compensation": By job's CompensationInfo.annualized_total_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - "annualized_total_compensation desc": By job's CompensationInfo.annualized_total_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - "custom_ranking desc": By the relevance score adjusted to the SearchJobsRequest.CustomRankingInfo.ranking_expression with weight factor assigned by SearchJobsRequest.CustomRankingInfo.importance_level in descending order. - Location sorting: Use the special syntax to order jobs by distance: "distance_from('Hawaii')": Order by distance from Hawaii. "distance_from(19.89, 155.5)": Order by distance from a coordinate. "distance_from('Hawaii'), distance_from('Puerto Rico')": Order by multiple locations. See details below. "distance_from('Hawaii'), distance_from(19.89, 155.5)": Order by multiple locations. See details below. The string can have a maximum of 256 characters. When multiple distance centers are provided, a job that is close to any of the distance centers would have a high rank. When a job has multiple locations, the job location closest to one of the distance centers will be used. Jobs that don't have locations will be ranked at the bottom. Distance is calculated with a precision of 11.3 meters (37.4 feet). Diversification strategy is still applied unless explicitly disabled in diversification_level.
diversification_level	google.cloud.talent_v4.types.SearchJobsRequest.DiversificationLevel Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results. Defaults to DiversificationLevel.SIMPLE if no value is specified.
custom_ranking_info	google.cloud.talent_v4.types.SearchJobsRequest.CustomRankingInfo Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm).
disable_keyword_match	bool This field is deprecated. Please use SearchJobsRequest.keyword_match_mode going forward. To migrate, disable_keyword_match set to false maps to KeywordMatchMode.KEYWORD_MATCH_ALL, and disable_keyword_match set to true maps to KeywordMatchMode.KEYWORD_MATCH_DISABLED. If SearchJobsRequest.keyword_match_mode is set, this field is ignored. Controls whether to disable exact keyword match on Job.title, Job.description, Job.company_display_name, Job.addresses, Job.qualifications. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, for the query "program manager," a result is returned even if the job posting has the title "software developer," which doesn't fall into "program manager" ontology, but does have "program manager" appearing in its description. For queries like "cloud" that don't contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value. Use Company.keyword_searchable_job_custom_attributes if company-specific globally matched custom field/attribute string values are needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false.
keyword_match_mode	google.cloud.talent_v4.types.SearchJobsRequest.KeywordMatchMode Controls what keyword match options to use. If both keyword_match_mode and disable_keyword_match are set, keyword_match_mode will take precedence. Defaults to KeywordMatchMode.KEYWORD_MATCH_ALL if no value is specified.

Classes

CustomRankingInfo

CustomRankingInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Custom ranking information for SearchJobsRequest.

DiversificationLevel

DiversificationLevel(value)

Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results.

If you are using pageToken to page through the result set, latency might be lower but we can't guarantee that all results are returned. If you are using page offset, latency might be higher but all results are returned.

Values: DIVERSIFICATION_LEVEL_UNSPECIFIED (0): The diversification level isn't specified. DISABLED (1): Disables diversification. Jobs that would normally be pushed to the last page would not have their positions altered. This may result in highly similar jobs appearing in sequence in the search results. SIMPLE (2): Default diversifying behavior. The result list is ordered so that highly similar results are pushed to the end of the last page of search results. ONE_PER_COMPANY (3): Only one job from the same company will be shown at once, other jobs under same company are pushed to the end of the last page of search result. TWO_PER_COMPANY (4): Similar to ONE_PER_COMPANY, but it allows at most two jobs in the same company to be shown at once, the other jobs under same company are pushed to the end of the last page of search result. MAX_THREE_PER_COMPANY (6): Similar to ONE_PER_COMPANY, but it allows at most three jobs in the same company to be shown at once, the other jobs under same company are dropped. DIVERSIFY_BY_LOOSER_SIMILARITY (5): The result list is ordered such that somewhat similar results are pushed to the end of the last page of the search results. This option is recommended if SIMPLE diversification does not diversify enough.

KeywordMatchMode

KeywordMatchMode(value)

Controls what keyword matching behavior the search has. When keyword matching is enabled, a keyword match returns jobs that may not match given category filters when there are matching keywords. For example, for the query "program manager" with KeywordMatchMode set to KEYWORD_MATCH_ALL, a job posting with the title "software developer," which doesn't fall into "program manager" ontology, and "program manager" appearing in its description will be surfaced.

For queries like "cloud" that don't contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this enum's value.

Use Company.keyword_searchable_job_custom_attributes if company-specific globally matched custom field/attribute string values are needed. Enabling keyword match improves recall of subsequent search requests.

Values: KEYWORD_MATCH_MODE_UNSPECIFIED (0): The keyword match option isn't specified. Defaults to KeywordMatchMode.KEYWORD_MATCH_ALL behavior. KEYWORD_MATCH_DISABLED (1): Disables keyword matching. KEYWORD_MATCH_ALL (2): Enable keyword matching over Job.title, Job.description, Job.company_display_name, Job.addresses, Job.qualifications, and keyword searchable Job.custom_attributes fields. KEYWORD_MATCH_TITLE_ONLY (3): Only enable keyword matching over Job.title.

SearchMode

SearchMode(value)

A string-represented enumeration of the job search mode. The service operate differently for different modes of service.

Values: SEARCH_MODE_UNSPECIFIED (0): The mode of the search method isn't specified. The default search behavior is identical to JOB_SEARCH search behavior. JOB_SEARCH (1): The job search matches against all jobs, and featured jobs (jobs with promotionValue > 0) are not specially handled. FEATURED_JOB_SEARCH (2): The job search matches only against featured jobs (jobs with a promotionValue > 0). This method doesn't return any jobs having a promotionValue <= 0. The search results order is determined by the promotionValue (jobs with a higher promotionValue are returned higher up in the search results), with relevance being used as a tiebreaker.