1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
// Copyright 2019 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
syntax = "proto3";
package google.cloud.talent.v4beta1;
import "google/api/annotations.proto";
import "google/cloud/talent/v4beta1/common.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent";
option java_multiple_files = true;
option java_outer_classname = "CompletionServiceProto";
option java_package = "com.google.cloud.talent.v4beta1";
option objc_class_prefix = "CTS";
// A service handles auto completion.
service Completion {
// Completes the specified prefix with keyword suggestions.
// Intended for use by a job search auto-complete search box.
rpc CompleteQuery(CompleteQueryRequest) returns (CompleteQueryResponse) {
option (google.api.http) = {
get: "/v4beta1/{parent=projects/*/tenants/*}:complete"
additional_bindings {
get: "/v4beta1/{parent=projects/*}:complete"
}
};
}
}
// Input only.
//
// Auto-complete parameters.
message CompleteQueryRequest {
// Enum to specify the scope of completion.
enum CompletionScope {
// Default value.
COMPLETION_SCOPE_UNSPECIFIED = 0;
// Suggestions are based only on the data provided by the client.
TENANT = 1;
// Suggestions are based on all jobs data in the system that's visible to
// the client
PUBLIC = 2;
}
// Enum to specify auto-completion topics.
enum CompletionType {
// Default value.
COMPLETION_TYPE_UNSPECIFIED = 0;
// Only suggest job titles.
JOB_TITLE = 1;
// Only suggest company names.
COMPANY_NAME = 2;
// Suggest both job titles and company names.
COMBINED = 3;
}
// Required.
//
// Resource name of tenant the completion is performed within.
//
// The format is "projects/{project_id}/tenants/{tenant_id}", for example,
// "projects/api-test-project/tenant/foo".
//
// Tenant id is optional and the default tenant is used if unspecified, for
// example, "projects/api-test-project".
string parent = 1;
// Required.
//
// The query used to generate suggestions.
//
// The maximum number of allowed characters is 255.
string query = 2;
// Optional.
//
// The list of languages of the query. This is
// the BCP-47 language code, such as "en-US" or "sr-Latn".
// For more information, see
// [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
//
// For [CompletionType.JOB_TITLE][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.JOB_TITLE] type, only open jobs with the same
// [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] are returned.
//
// For [CompletionType.COMPANY_NAME][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.COMPANY_NAME] type,
// only companies having open jobs with the same [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] are
// returned.
//
// For [CompletionType.COMBINED][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.COMBINED] type, only open jobs with the same
// [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] or companies having open jobs with the same
// [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] are returned.
//
// The maximum number of allowed characters is 255.
repeated string language_codes = 3;
// Required.
//
// Completion result count.
//
// The maximum allowed page size is 10.
int32 page_size = 4;
// Optional.
//
// If provided, restricts completion to specified company.
//
// The format is
// "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
// example, "projects/api-test-project/tenants/foo/companies/bar".
//
// Tenant id is optional and the default tenant is used if unspecified, for
// example, "projects/api-test-project/companies/bar".
string company = 5;
// Optional.
//
// The scope of the completion. The defaults is [CompletionScope.PUBLIC][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionScope.PUBLIC].
CompletionScope scope = 6;
// Optional.
//
// The completion topic. The default is [CompletionType.COMBINED][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.COMBINED].
CompletionType type = 7;
}
// Output only.
//
// Response of auto-complete query.
message CompleteQueryResponse {
// Output only.
//
// Resource that represents completion results.
message CompletionResult {
// The suggestion for the query.
string suggestion = 1;
// The completion topic.
CompleteQueryRequest.CompletionType type = 2;
// The URI of the company image for [CompletionType.COMPANY_NAME][].
string image_uri = 3;
}
// Results of the matching job/company candidates.
repeated CompletionResult completion_results = 1;
// Additional information for the API invocation, such as the request
// tracking id.
ResponseMetadata metadata = 2;
}
|
