xref: /aosp_15_r20/external/googleapis/google/cloud/contentwarehouse/v1/synonymset.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.cloud.contentwarehouse.v1;
18
19import "google/api/resource.proto";
20
21option csharp_namespace = "Google.Cloud.ContentWarehouse.V1";
22option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
23option java_multiple_files = true;
24option java_outer_classname = "SynonymSetProto";
25option java_package = "com.google.cloud.contentwarehouse.v1";
26option php_namespace = "Google\\Cloud\\ContentWarehouse\\V1";
27option ruby_package = "Google::Cloud::ContentWarehouse::V1";
28
29// Represents a list of synonyms for a given context.
30// For example a context "sales" could contain:
31// Synonym 1: sale, invoice, bill, order
32// Synonym 2: money, credit, finance, payment
33// Synonym 3: shipping, freight, transport
34// Each SynonymSets should be disjoint
35message SynonymSet {
36  option (google.api.resource) = {
37    type: "contentwarehouse.googleapis.com/SynonymSet"
38    pattern: "projects/{project}/locations/{location}/synonymSets/{context}"
39  };
40
41  // Represents a list of words given by the customer
42  // All these words are synonyms of each other.
43  message Synonym {
44    // For example: sale, invoice, bill, order
45    repeated string words = 1;
46  }
47
48  // The resource name of the SynonymSet
49  // This is mandatory for google.api.resource.
50  // Format:
51  // projects/{project_number}/locations/{location}/synonymSets/{context}.
52  string name = 1;
53
54  // This is a freeform field. Example contexts can be "sales," "engineering,"
55  // "real estate," "accounting," etc.
56  // The context can be supplied during search requests.
57  string context = 2;
58
59  // List of Synonyms for the context.
60  repeated Synonym synonyms = 3;
61}
62