@google-cloud/discoveryengine 1.4.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +15 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config.proto +49 -0
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config_service.proto +79 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +106 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/chunk_service.proto +137 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +97 -4
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/completion.proto +52 -0
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +44 -2
  10. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +6 -1
  11. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +44 -0
  12. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +80 -1
  13. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +102 -0
  14. package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +127 -0
  15. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +70 -0
  16. package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +13 -8
  17. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +3 -2
  18. package/build/protos/google/cloud/discoveryengine/v1alpha/estimate_billing_service.proto +130 -0
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +376 -21
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +66 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/rank_service.proto +115 -0
  22. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +3 -1
  23. package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +3 -0
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +221 -30
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +27 -20
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config.proto +271 -0
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config_service.proto +148 -0
  28. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +9 -3
  29. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +7 -4
  30. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +4 -3
  31. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +5 -0
  32. package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +22 -0
  33. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +9 -0
  34. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +94 -0
  35. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +3 -0
  36. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +19 -4
  37. package/build/protos/google/cloud/discoveryengine/v1beta/search_tuning_service.proto +151 -0
  38. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +4 -3
  39. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto +6 -5
  40. package/build/protos/protos.d.ts +18160 -8292
  41. package/build/protos/protos.js +50325 -25400
  42. package/build/protos/protos.json +4864 -2447
  43. package/build/src/v1/completion_service_client.js +10 -7
  44. package/build/src/v1/conversational_search_service_client.js +10 -7
  45. package/build/src/v1/data_store_service_client.js +10 -7
  46. package/build/src/v1/document_service_client.js +10 -7
  47. package/build/src/v1/engine_service_client.js +10 -7
  48. package/build/src/v1/schema_service_client.js +10 -7
  49. package/build/src/v1/search_service_client.js +10 -7
  50. package/build/src/v1/site_search_engine_service_client.js +10 -7
  51. package/build/src/v1/user_event_service_client.js +10 -7
  52. package/build/src/v1alpha/acl_config_service_client.d.ts +1233 -0
  53. package/build/src/v1alpha/acl_config_service_client.js +1768 -0
  54. package/build/src/v1alpha/acl_config_service_client_config.json +34 -0
  55. package/build/src/v1alpha/chunk_service_client.d.ts +1350 -0
  56. package/build/src/v1alpha/chunk_service_client.js +1889 -0
  57. package/build/src/v1alpha/chunk_service_client_config.json +34 -0
  58. package/build/src/v1alpha/completion_service_client.d.ts +588 -3
  59. package/build/src/v1alpha/completion_service_client.js +844 -9
  60. package/build/src/v1alpha/completion_service_client_config.json +10 -0
  61. package/build/src/v1alpha/conversational_search_service_client.d.ts +233 -1
  62. package/build/src/v1alpha/conversational_search_service_client.js +326 -7
  63. package/build/src/v1alpha/data_store_service_client.d.ts +451 -3
  64. package/build/src/v1alpha/data_store_service_client.js +575 -9
  65. package/build/src/v1alpha/data_store_service_client_config.json +8 -0
  66. package/build/src/v1alpha/document_service_client.d.ts +462 -21
  67. package/build/src/v1alpha/document_service_client.js +549 -7
  68. package/build/src/v1alpha/document_service_client_config.json +5 -0
  69. package/build/src/v1alpha/engine_service_client.d.ts +375 -2
  70. package/build/src/v1alpha/engine_service_client.js +527 -7
  71. package/build/src/v1alpha/estimate_billing_service_client.d.ts +1367 -0
  72. package/build/src/v1alpha/estimate_billing_service_client.js +2034 -0
  73. package/build/src/v1alpha/estimate_billing_service_client_config.json +30 -0
  74. package/build/src/v1alpha/index.d.ts +5 -0
  75. package/build/src/v1alpha/index.js +11 -1
  76. package/build/src/v1alpha/rank_service_client.d.ts +1254 -0
  77. package/build/src/v1alpha/rank_service_client.js +1796 -0
  78. package/build/src/v1alpha/rank_service_client_config.json +30 -0
  79. package/build/src/v1alpha/recommendation_service_client.d.ts +231 -1
  80. package/build/src/v1alpha/recommendation_service_client.js +326 -7
  81. package/build/src/v1alpha/schema_service_client.d.ts +372 -0
  82. package/build/src/v1alpha/schema_service_client.js +527 -7
  83. package/build/src/v1alpha/search_service_client.d.ts +288 -30
  84. package/build/src/v1alpha/search_service_client.js +366 -27
  85. package/build/src/v1alpha/search_tuning_service_client.d.ts +373 -1
  86. package/build/src/v1alpha/search_tuning_service_client.js +527 -7
  87. package/build/src/v1alpha/serving_config_service_client.d.ts +1370 -0
  88. package/build/src/v1alpha/serving_config_service_client.js +1939 -0
  89. package/build/src/v1alpha/serving_config_service_client_config.json +38 -0
  90. package/build/src/v1alpha/site_search_engine_service_client.d.ts +372 -0
  91. package/build/src/v1alpha/site_search_engine_service_client.js +527 -7
  92. package/build/src/v1alpha/user_event_service_client.d.ts +372 -0
  93. package/build/src/v1alpha/user_event_service_client.js +527 -7
  94. package/build/src/v1beta/completion_service_client.d.ts +75 -0
  95. package/build/src/v1beta/completion_service_client.js +114 -7
  96. package/build/src/v1beta/conversational_search_service_client.d.ts +79 -0
  97. package/build/src/v1beta/conversational_search_service_client.js +114 -7
  98. package/build/src/v1beta/data_store_service_client.d.ts +75 -0
  99. package/build/src/v1beta/data_store_service_client.js +114 -7
  100. package/build/src/v1beta/document_service_client.d.ts +75 -0
  101. package/build/src/v1beta/document_service_client.js +114 -7
  102. package/build/src/v1beta/engine_service_client.d.ts +75 -0
  103. package/build/src/v1beta/engine_service_client.js +114 -7
  104. package/build/src/v1beta/index.d.ts +1 -0
  105. package/build/src/v1beta/index.js +3 -1
  106. package/build/src/v1beta/recommendation_service_client.d.ts +75 -0
  107. package/build/src/v1beta/recommendation_service_client.js +114 -7
  108. package/build/src/v1beta/schema_service_client.d.ts +75 -0
  109. package/build/src/v1beta/schema_service_client.js +114 -7
  110. package/build/src/v1beta/search_service_client.d.ts +81 -0
  111. package/build/src/v1beta/search_service_client.js +118 -7
  112. package/build/src/v1beta/search_tuning_service_client.d.ts +1196 -0
  113. package/build/src/v1beta/search_tuning_service_client.js +1784 -0
  114. package/build/src/v1beta/search_tuning_service_client_config.json +30 -0
  115. package/build/src/v1beta/serving_config_service_client.d.ts +123 -8
  116. package/build/src/v1beta/serving_config_service_client.js +176 -12
  117. package/build/src/v1beta/site_search_engine_service_client.d.ts +75 -0
  118. package/build/src/v1beta/site_search_engine_service_client.js +114 -7
  119. package/build/src/v1beta/user_event_service_client.d.ts +75 -0
  120. package/build/src/v1beta/user_event_service_client.js +114 -7
  121. package/package.json +3 -3
@@ -82,7 +82,7 @@ message Engine {
82
82
  TRAINING = 2;
83
83
  }
84
84
 
85
- // Required. The type of engine e.g. `recommended-for-you`.
85
+ // Required. The type of engine. e.g., `recommended-for-you`.
86
86
  //
87
87
  // This field together with
88
88
  // [optimization_objective][Engine.optimization_objective] describe engine
@@ -92,7 +92,7 @@ message Engine {
92
92
  // `more-like-this`, `most-popular-items`.
93
93
  string type = 1 [(google.api.field_behavior) = REQUIRED];
94
94
 
95
- // The optimization objective e.g. `cvr`.
95
+ // The optimization objective. e.g., `cvr`.
96
96
  //
97
97
  // This field together with
98
98
  // [optimization_objective][google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.type]
@@ -155,6 +155,11 @@ message Engine {
155
155
  // database](https://www.iana.org/time-zones), e.g., America/New_York,
156
156
  // Europe/Paris.
157
157
  string time_zone = 3 [(google.api.field_behavior) = REQUIRED];
158
+
159
+ // Agent location for Agent creation, supported values: global/us/eu.
160
+ // If not provided, us Engine will create Agent using us-central-1 by
161
+ // default; eu Engine will create Agent using eu-west-1 by default.
162
+ string location = 4;
158
163
  }
159
164
 
160
165
  // The configurationt generate the Dialogflow agent that is associated to
@@ -181,16 +186,16 @@ message Engine {
181
186
  // or
182
187
  // [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines]
183
188
  // API after engine creation. Please use
184
- // [chat_engine_metadata.dialogflow_agent][] for actual agent
185
- // association after Engine is created.
189
+ // [ChatEngineMetadata.dialogflow_agent][google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata.dialogflow_agent]
190
+ // for actual agent association after Engine is created.
186
191
  string dialogflow_agent_to_link = 2;
187
192
  }
188
193
 
189
194
  // Common configurations for an Engine.
190
195
  message CommonConfig {
191
- // The name of the company, business or entity that is associated with the
192
- // engine. Setting this may help improve LLM related features.
193
- string company_name = 1;
196
+ // Immutable. The name of the company, business or entity that is associated
197
+ // with the engine. Setting this may help improve LLM related features.
198
+ string company_name = 1 [(google.api.field_behavior) = IMMUTABLE];
194
199
  }
195
200
 
196
201
  // Additional information of a recommendation engine.
@@ -352,7 +357,7 @@ message Engine {
352
357
  // Note that when used in
353
358
  // [CreateEngineRequest][google.cloud.discoveryengine.v1alpha.CreateEngineRequest],
354
359
  // one DataStore id must be provided as the system will use it for necessary
355
- // intializations.
360
+ // initializations.
356
361
  repeated string data_store_ids = 5;
357
362
 
358
363
  // Required. The solutions of the engine.
@@ -94,7 +94,7 @@ service EngineService {
94
94
  }
95
95
 
96
96
  // Pauses the training of an existing engine. Only applicable if
97
- // [solution_type][] is
97
+ // [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
98
98
  // [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
99
99
  rpc PauseEngine(PauseEngineRequest) returns (Engine) {
100
100
  option (google.api.http) = {
@@ -115,7 +115,8 @@ service EngineService {
115
115
  option (google.api.method_signature) = "name";
116
116
  }
117
117
 
118
- // Tunes an existing engine. Only applicable if [solution_type][] is
118
+ // Tunes an existing engine. Only applicable if
119
+ // [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
119
120
  // [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
120
121
  rpc TuneEngine(TuneEngineRequest) returns (google.longrunning.Operation) {
121
122
  option (google.api.http) = {
@@ -0,0 +1,130 @@
1
+ // Copyright 2022 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
+
15
+ syntax = "proto3";
16
+
17
+ package google.cloud.discoveryengine.v1alpha;
18
+
19
+ import "google/api/annotations.proto";
20
+ import "google/api/client.proto";
21
+ import "google/api/field_behavior.proto";
22
+ import "google/api/resource.proto";
23
+ import "google/cloud/discoveryengine/v1alpha/import_config.proto";
24
+ import "google/longrunning/operations.proto";
25
+ import "google/protobuf/timestamp.proto";
26
+
27
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
28
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
29
+ option java_multiple_files = true;
30
+ option java_outer_classname = "EstimateBillingServiceProto";
31
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
32
+ option objc_class_prefix = "DISCOVERYENGINE";
33
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
34
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
35
+
36
+ // Service for managing billing estimations resources.
37
+ service EstimateBillingService {
38
+ option (google.api.default_host) = "discoveryengine.googleapis.com";
39
+ option (google.api.oauth_scopes) =
40
+ "https://www.googleapis.com/auth/cloud-platform";
41
+
42
+ // Estimates the data size to be used by a customer.
43
+ rpc EstimateDataSize(EstimateDataSizeRequest)
44
+ returns (google.longrunning.Operation) {
45
+ option (google.api.http) = {
46
+ post: "/v1alpha/{location=projects/*/locations/*}:estimateDataSize"
47
+ body: "*"
48
+ };
49
+ option (google.longrunning.operation_info) = {
50
+ response_type: "google.cloud.discoveryengine.v1alpha.EstimateDataSizeResponse"
51
+ metadata_type: "google.cloud.discoveryengine.v1alpha.EstimateDataSizeMetadata"
52
+ };
53
+ }
54
+ }
55
+
56
+ // Request message for
57
+ // [EstimateBillingService.EstimateDataSize][google.cloud.discoveryengine.v1alpha.EstimateBillingService.EstimateDataSize]
58
+ // method
59
+ message EstimateDataSizeRequest {
60
+ // Data source is a set of website patterns that we crawl to get
61
+ // the total number of websites.
62
+ message WebsiteDataSource {
63
+ // URI patterns that we use to crawl.
64
+ message EstimatorUriPattern {
65
+ // User provided URI pattern. For example, `foo.com/bar/*`.
66
+ string provided_uri_pattern = 1;
67
+
68
+ // Whether we infer the generated URI or use the exact provided one.
69
+ bool exact_match = 2;
70
+
71
+ // Whether the pattern is exclusive or not. If set to true, the pattern is
72
+ // considered exclusive. If unset or set to false, the pattern is
73
+ // considered inclusive by default.
74
+ bool exclusive = 3;
75
+ }
76
+
77
+ // Required. The URI patterns to estimate the data sizes. At most 10
78
+ // patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown.
79
+ repeated EstimatorUriPattern estimator_uri_patterns = 1
80
+ [(google.api.field_behavior) = REQUIRED];
81
+ }
82
+
83
+ // Data source contains files either in Cloud Storage or BigQuery.
84
+ message FileDataSource {
85
+ // Which source contains the files to be used.
86
+ oneof source {
87
+ // Cloud Storage location for the input content.
88
+ GcsSource gcs_source = 1;
89
+
90
+ // BigQuery input source.
91
+ BigQuerySource bigquery_source = 2;
92
+ }
93
+ }
94
+
95
+ // Data source for which we are estimating its size.
96
+ oneof data_source {
97
+ // Website data.
98
+ WebsiteDataSource website_data_source = 2;
99
+
100
+ // Structured or unstructured data.
101
+ FileDataSource file_data_source = 3;
102
+ }
103
+
104
+ // Required. Full resource name of the location, such as
105
+ // `projects/{project}/locations/{location}`.
106
+ string location = 1 [
107
+ (google.api.field_behavior) = REQUIRED,
108
+ (google.api.resource_reference) = {
109
+ type: "discoveryengine.googleapis.com/Location"
110
+ }
111
+ ];
112
+ }
113
+
114
+ // Response of the EstimateDataSize request. If the long running
115
+ // operation was successful, then this message is returned by the
116
+ // google.longrunning.Operations.response field if the operation was successful.
117
+ message EstimateDataSizeResponse {
118
+ // Data size in terms of bytes.
119
+ int64 data_size_bytes = 1;
120
+
121
+ // Total number of documents.
122
+ int64 document_count = 2;
123
+ }
124
+
125
+ // Metadata related to the progress of the EstimateDataSize operation. This is
126
+ // returned by the google.longrunning.Operation.metadata field.
127
+ message EstimateDataSizeMetadata {
128
+ // Operation create time.
129
+ google.protobuf.Timestamp create_time = 1;
130
+ }
@@ -18,8 +18,10 @@ package google.cloud.discoveryengine.v1alpha;
18
18
 
19
19
  import "google/api/field_behavior.proto";
20
20
  import "google/api/resource.proto";
21
+ import "google/cloud/discoveryengine/v1alpha/completion.proto";
21
22
  import "google/cloud/discoveryengine/v1alpha/document.proto";
22
23
  import "google/cloud/discoveryengine/v1alpha/user_event.proto";
24
+ import "google/protobuf/field_mask.proto";
23
25
  import "google/protobuf/timestamp.proto";
24
26
  import "google/rpc/status.proto";
25
27
  import "google/type/date.proto";
@@ -122,6 +124,233 @@ message BigQuerySource {
122
124
  string data_schema = 6;
123
125
  }
124
126
 
127
+ // The Spanner source for importing data
128
+ message SpannerSource {
129
+ // The project ID that the Spanner source is in with a length limit of 128
130
+ // characters. If not specified, inherits the project ID from the parent
131
+ // request.
132
+ string project_id = 1;
133
+
134
+ // Required. The instance ID of the source Spanner table.
135
+ string instance_id = 2 [(google.api.field_behavior) = REQUIRED];
136
+
137
+ // Required. The database ID of the source Spanner table.
138
+ string database_id = 3 [(google.api.field_behavior) = REQUIRED];
139
+
140
+ // Required. The table name of the Spanner database that needs to be imported.
141
+ string table_id = 4 [(google.api.field_behavior) = REQUIRED];
142
+
143
+ // Whether to apply data boost on Spanner export. Enabling this option will
144
+ // incur additional cost. More info can be found
145
+ // [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas).
146
+ bool enable_data_boost = 5;
147
+ }
148
+
149
+ // The Bigtable Options object that contains information to support
150
+ // the import.
151
+ message BigtableOptions {
152
+ // The column family of the Bigtable.
153
+ message BigtableColumnFamily {
154
+ // The field name to use for this column family in the document. The
155
+ // name has to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`. If not set,
156
+ // it is parsed from the family name with best effort. However, due to
157
+ // different naming patterns, field name collisions could happen, where
158
+ // parsing behavior is undefined.
159
+ string field_name = 1;
160
+
161
+ // The encoding mode of the values when the type is not STRING.
162
+ // Acceptable encoding values are:
163
+ //
164
+ // * `TEXT`: indicates values are alphanumeric text strings.
165
+ // * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes`
166
+ // family of functions. This can be overridden for a specific column
167
+ // by listing that column in `columns` and specifying an encoding for it.
168
+ Encoding encoding = 2;
169
+
170
+ // The type of values in this column family.
171
+ // The values are expected to be encoded using `HBase Bytes.toBytes`
172
+ // function when the encoding value is set to `BINARY`.
173
+ Type type = 3;
174
+
175
+ // The list of objects that contains column level information for each
176
+ // column. If a column is not present in this list it will be ignored.
177
+ repeated BigtableColumn columns = 4;
178
+ }
179
+
180
+ // The column of the Bigtable.
181
+ message BigtableColumn {
182
+ // Required. Qualifier of the column. If it cannot be decoded with utf-8,
183
+ // use a base-64 encoded string instead.
184
+ bytes qualifier = 1 [(google.api.field_behavior) = REQUIRED];
185
+
186
+ // The field name to use for this column in the document. The name has to
187
+ // match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`.
188
+ // If not set, it is parsed from the qualifier bytes with best effort.
189
+ // However, due to different naming patterns, field name collisions could
190
+ // happen, where parsing behavior is undefined.
191
+ string field_name = 2;
192
+
193
+ // The encoding mode of the values when the type is not `STRING`.
194
+ // Acceptable encoding values are:
195
+ //
196
+ // * `TEXT`: indicates values are alphanumeric text strings.
197
+ // * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes`
198
+ // family of functions. This can be overridden for a specific column
199
+ // by listing that column in `columns` and specifying an encoding for it.
200
+ Encoding encoding = 3;
201
+
202
+ // The type of values in this column family.
203
+ // The values are expected to be encoded using `HBase Bytes.toBytes`
204
+ // function when the encoding value is set to `BINARY`.
205
+ Type type = 4;
206
+ }
207
+
208
+ // The type of values in a Bigtable column or column family.
209
+ // The values are expected to be encoded using
210
+ // [HBase
211
+ // Bytes.toBytes](https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/util/Bytes.html)
212
+ // function when the encoding value is set to `BINARY`.
213
+ enum Type {
214
+ // The type is unspecified.
215
+ TYPE_UNSPECIFIED = 0;
216
+
217
+ // String type.
218
+ STRING = 1;
219
+
220
+ // Numerical type.
221
+ NUMBER = 2;
222
+
223
+ // Integer type.
224
+ INTEGER = 3;
225
+
226
+ // Variable length integer type.
227
+ VAR_INTEGER = 4;
228
+
229
+ // BigDecimal type.
230
+ BIG_NUMERIC = 5;
231
+
232
+ // Boolean type.
233
+ BOOLEAN = 6;
234
+
235
+ // JSON type.
236
+ JSON = 7;
237
+ }
238
+
239
+ // The encoding mode of a Bigtable column or column family.
240
+ enum Encoding {
241
+ // The encoding is unspecified.
242
+ ENCODING_UNSPECIFIED = 0;
243
+
244
+ // Text encoding.
245
+ TEXT = 1;
246
+
247
+ // Binary encoding.
248
+ BINARY = 2;
249
+ }
250
+
251
+ // The field name used for saving row key value in the document. The name has
252
+ // to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`.
253
+ string key_field_name = 1;
254
+
255
+ // The mapping from family names to an object that contains column families
256
+ // level information for the given column family. If a family is not present
257
+ // in this map it will be ignored.
258
+ map<string, BigtableColumnFamily> families = 2;
259
+ }
260
+
261
+ // The Cloud Bigtable source for importing data.
262
+ message BigtableSource {
263
+ // The project ID that the Bigtable source is in with a length limit of 128
264
+ // characters. If not specified, inherits the project ID from the parent
265
+ // request.
266
+ string project_id = 1;
267
+
268
+ // Required. The instance ID of the Cloud Bigtable that needs to be imported.
269
+ string instance_id = 2 [(google.api.field_behavior) = REQUIRED];
270
+
271
+ // Required. The table ID of the Cloud Bigtable that needs to be imported.
272
+ string table_id = 3 [(google.api.field_behavior) = REQUIRED];
273
+
274
+ // Required. Bigtable options that contains information needed when parsing
275
+ // data into typed structures. For example, column type annotations.
276
+ BigtableOptions bigtable_options = 4 [(google.api.field_behavior) = REQUIRED];
277
+ }
278
+
279
+ // Cloud FhirStore source import data from.
280
+ message FhirStoreSource {
281
+ // Required. The full resource name of the FHIR store to import data from, in
282
+ // the format of
283
+ // `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.
284
+ string fhir_store = 1 [
285
+ (google.api.field_behavior) = REQUIRED,
286
+ (google.api.resource_reference) = {
287
+ type: "healthcare.googleapis.com/FhirStore"
288
+ }
289
+ ];
290
+
291
+ // Intermediate Cloud Storage directory used for the import with a length
292
+ // limit of 2,000 characters. Can be specified if one wants to have the
293
+ // FhirStore export to a specific Cloud Storage directory.
294
+ string gcs_staging_dir = 2;
295
+ }
296
+
297
+ // Cloud SQL source import data from.
298
+ message CloudSqlSource {
299
+ // The project ID that the Cloud SQL source is in with a length limit of 128
300
+ // characters. If not specified, inherits the project ID from the parent
301
+ // request.
302
+ string project_id = 1;
303
+
304
+ // Required. The Cloud SQL instance to copy the data from with a length limit
305
+ // of 256 characters.
306
+ string instance_id = 2 [(google.api.field_behavior) = REQUIRED];
307
+
308
+ // Required. The Cloud SQL database to copy the data from with a length limit
309
+ // of 256 characters.
310
+ string database_id = 3 [(google.api.field_behavior) = REQUIRED];
311
+
312
+ // Required. The Cloud SQL table to copy the data from with a length limit of
313
+ // 256 characters.
314
+ string table_id = 4 [(google.api.field_behavior) = REQUIRED];
315
+
316
+ // Intermediate Cloud Storage directory used for the import with a length
317
+ // limit of 2,000 characters. Can be specified if one wants to have the
318
+ // Cloud SQL export to a specific Cloud Storage directory.
319
+ //
320
+ // Please ensure that the Cloud SQL service account has the necessary Cloud
321
+ // Storage Admin permissions to access the specified Cloud Storage directory.
322
+ string gcs_staging_dir = 5;
323
+
324
+ // Option for serverless export. Enabling this option will incur
325
+ // additional cost. More info can be found
326
+ // [here](https://cloud.google.com/sql/pricing#serverless).
327
+ bool offload = 6;
328
+ }
329
+
330
+ // Firestore source import data from.
331
+ message FirestoreSource {
332
+ // The project ID that the Cloud SQL source is in with a length limit of 128
333
+ // characters. If not specified, inherits the project ID from the parent
334
+ // request.
335
+ string project_id = 1;
336
+
337
+ // Required. The Firestore database to copy the data from with a length limit
338
+ // of 256 characters.
339
+ string database_id = 2 [(google.api.field_behavior) = REQUIRED];
340
+
341
+ // Required. The Firestore collection to copy the data from with a length
342
+ // limit of 1,500 characters.
343
+ string collection_id = 3 [(google.api.field_behavior) = REQUIRED];
344
+
345
+ // Intermediate Cloud Storage directory used for the import with a length
346
+ // limit of 2,000 characters. Can be specified if one wants to have the
347
+ // Firestore export to a specific Cloud Storage directory.
348
+ //
349
+ // Please ensure that the Firestore service account has the necessary Cloud
350
+ // Storage Admin permissions to access the specified Cloud Storage directory.
351
+ string gcs_staging_dir = 4;
352
+ }
353
+
125
354
  // Configuration of destination for Import related errors.
126
355
  message ImportErrorConfig {
127
356
  // Required. Errors destination.
@@ -219,6 +448,9 @@ message ImportDocumentsMetadata {
219
448
 
220
449
  // Count of entries that encountered errors while processing.
221
450
  int64 failure_count = 4;
451
+
452
+ // Total count of entries that were processed.
453
+ int64 total_count = 5;
222
454
  }
223
455
 
224
456
  // Request message for Import methods.
@@ -255,6 +487,21 @@ message ImportDocumentsRequest {
255
487
 
256
488
  // BigQuery input source.
257
489
  BigQuerySource bigquery_source = 4;
490
+
491
+ // FhirStore input source.
492
+ FhirStoreSource fhir_store_source = 10;
493
+
494
+ // Spanner input source.
495
+ SpannerSource spanner_source = 11;
496
+
497
+ // Cloud SQL input source.
498
+ CloudSqlSource cloud_sql_source = 12;
499
+
500
+ // Firestore input source.
501
+ FirestoreSource firestore_source = 13;
502
+
503
+ // Cloud Bigtable input source.
504
+ BigtableSource bigtable_source = 15;
258
505
  }
259
506
 
260
507
  // Required. The parent branch resource name, such as
@@ -275,6 +522,10 @@ message ImportDocumentsRequest {
275
522
  // [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
276
523
  ReconciliationMode reconciliation_mode = 6;
277
524
 
525
+ // Indicates which fields in the provided imported documents to update. If
526
+ // not set, the default is to update all fields.
527
+ google.protobuf.FieldMask update_mask = 7;
528
+
278
529
  // Whether to automatically generate IDs for the documents if absent.
279
530
  //
280
531
  // If set to `true`,
@@ -288,45 +539,54 @@ message ImportDocumentsRequest {
288
539
  // [id_field][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.id_field],
289
540
  // otherwise, documents without IDs fail to be imported.
290
541
  //
291
- // Only set this field when using
292
- // [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource] or
293
- // [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource], and
294
- // when
542
+ // Supported data sources:
543
+ //
544
+ // * [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource].
295
545
  // [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema]
296
- // or
546
+ // must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
547
+ // * [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource].
297
548
  // [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema]
298
- // is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
549
+ // must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
550
+ // * [SpannerSource][google.cloud.discoveryengine.v1alpha.SpannerSource].
551
+ // * [CloudSqlSource][google.cloud.discoveryengine.v1alpha.CloudSqlSource].
552
+ // * [FirestoreSource][google.cloud.discoveryengine.v1alpha.FirestoreSource].
553
+ // * [BigtableSource][google.cloud.discoveryengine.v1alpha.BigtableSource].
299
554
  bool auto_generate_ids = 8;
300
555
 
301
- // The field in the Cloud Storage and BigQuery sources that indicates the
302
- // unique IDs of the documents.
556
+ // The field indicates the ID field or column to be used as unique IDs of
557
+ // the documents.
303
558
  //
304
559
  // For [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource] it is the
305
560
  // key of the JSON field. For instance, `my_id` for JSON `{"my_id":
306
- // "some_uuid"}`. For
307
- // [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource] it is
308
- // the column name of the BigQuery table where the unique ids are stored.
561
+ // "some_uuid"}`. For others, it may be the column name of the table where the
562
+ // unique ids are stored.
309
563
  //
310
- // The values of the JSON field or the BigQuery column are used as the
564
+ // The values of the JSON field or the table column are used as the
311
565
  // [Document.id][google.cloud.discoveryengine.v1alpha.Document.id]s. The JSON
312
- // field or the BigQuery column must be of string type, and the values must be
566
+ // field or the table column must be of string type, and the values must be
313
567
  // set as valid strings conform to
314
568
  // [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
315
569
  // Otherwise, documents without valid IDs fail to be imported.
316
570
  //
317
- // Only set this field when using
318
- // [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource] or
319
- // [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource], and
320
- // when
321
- // [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema]
322
- // or
323
- // [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema]
324
- // is `custom`. And only set this field when
571
+ // Only set this field when
325
572
  // [auto_generate_ids][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.auto_generate_ids]
326
573
  // is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
327
574
  //
328
575
  // If it is unset, a default value `_id` is used when importing from the
329
576
  // allowed data sources.
577
+ //
578
+ // Supported data sources:
579
+ //
580
+ // * [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource].
581
+ // [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema]
582
+ // must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
583
+ // * [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource].
584
+ // [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema]
585
+ // must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
586
+ // * [SpannerSource][google.cloud.discoveryengine.v1alpha.SpannerSource].
587
+ // * [CloudSqlSource][google.cloud.discoveryengine.v1alpha.CloudSqlSource].
588
+ // * [FirestoreSource][google.cloud.discoveryengine.v1alpha.FirestoreSource].
589
+ // * [BigtableSource][google.cloud.discoveryengine.v1alpha.BigtableSource].
330
590
  string id_field = 9;
331
591
  }
332
592
 
@@ -341,3 +601,98 @@ message ImportDocumentsResponse {
341
601
  // Echoes the destination for the complete errors in the request if set.
342
602
  ImportErrorConfig error_config = 2;
343
603
  }
604
+
605
+ // Request message for
606
+ // [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries]
607
+ // method.
608
+ message ImportSuggestionDenyListEntriesRequest {
609
+ // The inline source for SuggestionDenyListEntry.
610
+ message InlineSource {
611
+ // Required. A list of all denylist entries to import. Max of 1000 items.
612
+ repeated SuggestionDenyListEntry entries = 1
613
+ [(google.api.field_behavior) = REQUIRED];
614
+ }
615
+
616
+ // The source of the updated SuggestionDenyList.
617
+ oneof source {
618
+ // The Inline source for the input content for suggestion deny list entries.
619
+ InlineSource inline_source = 2;
620
+
621
+ // Cloud Storage location for the input content.
622
+ //
623
+ // Only 1 file can be specified that contains all entries to import.
624
+ // Supported values `gcs_source.schema` for autocomplete suggestion deny
625
+ // list entry imports:
626
+ //
627
+ // * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry]
628
+ // per line.
629
+ GcsSource gcs_source = 3;
630
+ }
631
+
632
+ // Required. The parent data store resource name for which to import denylist
633
+ // entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
634
+ string parent = 1 [
635
+ (google.api.field_behavior) = REQUIRED,
636
+ (google.api.resource_reference) = {
637
+ type: "discoveryengine.googleapis.com/DataStore"
638
+ }
639
+ ];
640
+ }
641
+
642
+ // Response message for
643
+ // [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries]
644
+ // method.
645
+ message ImportSuggestionDenyListEntriesResponse {
646
+ // A sample of errors encountered while processing the request.
647
+ repeated google.rpc.Status error_samples = 1;
648
+
649
+ // Count of deny list entries successfully imported.
650
+ int64 imported_entries_count = 2;
651
+
652
+ // Count of deny list entries that failed to be imported.
653
+ int64 failed_entries_count = 3;
654
+ }
655
+
656
+ // Metadata related to the progress of the ImportSuggestionDenyListEntries
657
+ // operation. This is returned by the google.longrunning.Operation.metadata
658
+ // field.
659
+ message ImportSuggestionDenyListEntriesMetadata {
660
+ // Operation create time.
661
+ google.protobuf.Timestamp create_time = 1;
662
+
663
+ // Operation last update time. If the operation is done, this is also the
664
+ // finish time.
665
+ google.protobuf.Timestamp update_time = 2;
666
+ }
667
+
668
+ // Response of the
669
+ // [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions]
670
+ // method. If the long running operation is done, this message is returned by
671
+ // the google.longrunning.Operations.response field if the operation is
672
+ // successful.
673
+ message ImportCompletionSuggestionsResponse {
674
+ // A sample of errors encountered while processing the request.
675
+ repeated google.rpc.Status error_samples = 1;
676
+
677
+ // Count of
678
+ // [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
679
+ // successfully imported.
680
+ int64 success_count = 2;
681
+
682
+ // Count of
683
+ // [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
684
+ // that failed to be imported.
685
+ int64 failure_count = 3;
686
+ }
687
+
688
+ // Metadata related to the progress of the ImportCompletionSuggestions
689
+ // operation. This will be returned by the google.longrunning.Operation.metadata
690
+ // field.
691
+ message ImportCompletionSuggestionsMetadata {
692
+ // Operation create time.
693
+ google.protobuf.Timestamp create_time = 1;
694
+
695
+ // Operation last update time. If the operation is done, this is also the
696
+ // finish time.
697
+ google.protobuf.Timestamp update_time = 2;
698
+ }