blob: cdd683d573e5f8a8ba407896fed449bc0e440aa4 (
plain)
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
|
// Copyright 2021 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.retail.v2alpha;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/retail/v2alpha/common.proto";
import "google/cloud/retail/v2alpha/search_service.proto";
option csharp_namespace = "Google.Cloud.Retail.V2Alpha";
option go_package = "google.golang.org/genproto/googleapis/cloud/retail/v2alpha;retail";
option java_multiple_files = true;
option java_outer_classname = "ControlProto";
option java_package = "com.google.cloud.retail.v2alpha";
option objc_class_prefix = "RETAIL";
option php_namespace = "Google\\Cloud\\Retail\\V2alpha";
option ruby_package = "Google::Cloud::Retail::V2alpha";
// Configures dynamic serving time metadata that is used to pre and post
// process search/recommendation model results.
message Control {
option (google.api.resource) = {
type: "retail.googleapis.com/Control"
pattern: "projects/{project}/locations/{location}/catalogs/{catalog}/controls/{control}"
};
// The behavior/type of the control
//
// A behavior/type must be specified on creation. Type cannot be changed once
// specified (e.g. A Rule control will always be a Rule control.). An
// INVALID_ARGUMENT will be returned if either condition is violated.
oneof control {
// A facet specification to perform faceted search.
SearchRequest.FacetSpec facet_spec = 3;
// A rule control - a condition-action pair.
// Enacts a set action when the condition is triggered.
// For example: Boost "gShoe" when query full matches "Running Shoes".
Rule rule = 4;
}
// Immutable. Fully qualified name
// `projects/*/locations/global/catalogs/*/controls/*`
string name = 1 [(google.api.field_behavior) = IMMUTABLE];
// Required. The human readable control display name. Used in Retail UI.
//
// This field must be a UTF-8 encoded string with a length limit of 128
// characters. Otherwise, an INVALID_ARGUMENT error is thrown.
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
// Output only. List of serving configuration ids that that are associated
// with this control. Note the association is managed via the ServingConfig,
// this is an output only denormalizeed view. Assumed to be in the same
// catalog.
repeated string associated_serving_config_ids = 5
[(google.api.field_behavior) = OUTPUT_ONLY];
// Required. Immutable. The solution types that the serving config is used
// for. Currently we support setting only one type of solution at creation
// time.
//
// Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
// If no solution type is provided at creation time, will default to
// SOLUTION_TYPE_SEARCH.
repeated SolutionType solution_types = 6 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE
];
// Required. Specifies the use case for the control.
// Affects what condition fields can be set.
// Only settable by search controls.
// Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified.
// Currently only allow one search_solution_use_case per control.
repeated SearchSolutionUseCase search_solution_use_case = 7
[(google.api.field_behavior) = REQUIRED];
}
|
