@google-cloud/discoveryengine 1.3.1 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (119) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +51 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/common.proto +54 -3
  4. package/build/protos/google/cloud/discoveryengine/v1/completion.proto +52 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +51 -4
  6. package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +3 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +40 -1
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +98 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +304 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/document.proto +1 -1
  11. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +215 -0
  12. package/build/protos/google/cloud/discoveryengine/v1/engine_service.proto +242 -0
  13. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +64 -0
  14. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +38 -0
  15. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +137 -4
  16. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +170 -0
  17. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +691 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +3 -3
  19. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +59 -8
  20. package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +52 -0
  21. package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +51 -4
  22. package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +3 -0
  23. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +40 -1
  24. package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +98 -0
  25. package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +306 -0
  26. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
  27. package/build/protos/google/cloud/discoveryengine/v1beta/engine.proto +220 -0
  28. package/build/protos/google/cloud/discoveryengine/v1beta/engine_service.proto +244 -0
  29. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +64 -0
  30. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +38 -0
  31. package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +26 -3
  32. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +150 -11
  33. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +264 -0
  34. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto +147 -0
  35. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine.proto +170 -0
  36. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine_service.proto +695 -0
  37. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -3
  38. package/build/protos/protos.d.ts +41157 -23655
  39. package/build/protos/protos.js +103188 -62466
  40. package/build/protos/protos.json +10400 -6075
  41. package/build/src/index.d.ts +10 -1
  42. package/build/src/index.js +10 -1
  43. package/build/src/v1/completion_service_client.d.ts +489 -7
  44. package/build/src/v1/completion_service_client.js +715 -11
  45. package/build/src/v1/completion_service_client_config.json +10 -0
  46. package/build/src/v1/conversational_search_service_client.d.ts +341 -3
  47. package/build/src/v1/conversational_search_service_client.js +466 -9
  48. package/build/src/v1/data_store_service_client.d.ts +1286 -0
  49. package/build/src/v1/data_store_service_client.js +1768 -0
  50. package/build/src/v1/data_store_service_client_config.json +46 -0
  51. package/build/src/v1/document_service_client.d.ts +347 -2
  52. package/build/src/v1/document_service_client.js +506 -9
  53. package/build/src/v1/engine_service_client.d.ts +1211 -0
  54. package/build/src/v1/engine_service_client.js +1731 -0
  55. package/build/src/v1/engine_service_client_config.json +46 -0
  56. package/build/src/v1/index.d.ts +3 -0
  57. package/build/src/v1/index.js +7 -1
  58. package/build/src/v1/schema_service_client.d.ts +272 -2
  59. package/build/src/v1/schema_service_client.js +402 -9
  60. package/build/src/v1/search_service_client.d.ts +515 -11
  61. package/build/src/v1/search_service_client.js +648 -15
  62. package/build/src/v1/site_search_engine_service_client.d.ts +1564 -0
  63. package/build/src/v1/site_search_engine_service_client.js +2075 -0
  64. package/build/src/v1/site_search_engine_service_client_config.json +74 -0
  65. package/build/src/v1/user_event_service_client.d.ts +272 -2
  66. package/build/src/v1/user_event_service_client.js +402 -9
  67. package/build/src/v1alpha/completion_service_client.d.ts +11 -2
  68. package/build/src/v1alpha/completion_service_client.js +37 -10
  69. package/build/src/v1alpha/conversational_search_service_client.d.ts +11 -2
  70. package/build/src/v1alpha/conversational_search_service_client.js +37 -10
  71. package/build/src/v1alpha/data_store_service_client.d.ts +11 -2
  72. package/build/src/v1alpha/data_store_service_client.js +37 -10
  73. package/build/src/v1alpha/document_service_client.d.ts +11 -2
  74. package/build/src/v1alpha/document_service_client.js +37 -10
  75. package/build/src/v1alpha/engine_service_client.d.ts +11 -2
  76. package/build/src/v1alpha/engine_service_client.js +37 -10
  77. package/build/src/v1alpha/index.js +1 -1
  78. package/build/src/v1alpha/recommendation_service_client.d.ts +11 -2
  79. package/build/src/v1alpha/recommendation_service_client.js +37 -10
  80. package/build/src/v1alpha/schema_service_client.d.ts +11 -2
  81. package/build/src/v1alpha/schema_service_client.js +37 -10
  82. package/build/src/v1alpha/search_service_client.d.ts +11 -2
  83. package/build/src/v1alpha/search_service_client.js +37 -10
  84. package/build/src/v1alpha/search_tuning_service_client.d.ts +11 -2
  85. package/build/src/v1alpha/search_tuning_service_client.js +37 -10
  86. package/build/src/v1alpha/site_search_engine_service_client.d.ts +11 -2
  87. package/build/src/v1alpha/site_search_engine_service_client.js +37 -10
  88. package/build/src/v1alpha/user_event_service_client.d.ts +11 -2
  89. package/build/src/v1alpha/user_event_service_client.js +37 -10
  90. package/build/src/v1beta/completion_service_client.d.ts +633 -7
  91. package/build/src/v1beta/completion_service_client.js +911 -11
  92. package/build/src/v1beta/completion_service_client_config.json +10 -0
  93. package/build/src/v1beta/conversational_search_service_client.d.ts +341 -3
  94. package/build/src/v1beta/conversational_search_service_client.js +466 -9
  95. package/build/src/v1beta/data_store_service_client.d.ts +1433 -0
  96. package/build/src/v1beta/data_store_service_client.js +1966 -0
  97. package/build/src/v1beta/data_store_service_client_config.json +46 -0
  98. package/build/src/v1beta/document_service_client.d.ts +491 -2
  99. package/build/src/v1beta/document_service_client.js +706 -11
  100. package/build/src/v1beta/engine_service_client.d.ts +1357 -0
  101. package/build/src/v1beta/engine_service_client.js +1928 -0
  102. package/build/src/v1beta/engine_service_client_config.json +46 -0
  103. package/build/src/v1beta/index.d.ts +4 -0
  104. package/build/src/v1beta/index.js +9 -1
  105. package/build/src/v1beta/recommendation_service_client.d.ts +420 -5
  106. package/build/src/v1beta/recommendation_service_client.js +570 -9
  107. package/build/src/v1beta/schema_service_client.d.ts +416 -2
  108. package/build/src/v1beta/schema_service_client.js +602 -11
  109. package/build/src/v1beta/search_service_client.d.ts +539 -29
  110. package/build/src/v1beta/search_service_client.js +664 -27
  111. package/build/src/v1beta/serving_config_service_client.d.ts +1102 -0
  112. package/build/src/v1beta/serving_config_service_client.js +1563 -0
  113. package/build/src/v1beta/serving_config_service_client_config.json +38 -0
  114. package/build/src/v1beta/site_search_engine_service_client.d.ts +1712 -0
  115. package/build/src/v1beta/site_search_engine_service_client.js +2271 -0
  116. package/build/src/v1beta/site_search_engine_service_client_config.json +74 -0
  117. package/build/src/v1beta/user_event_service_client.d.ts +416 -2
  118. package/build/src/v1beta/user_event_service_client.js +602 -11
  119. package/package.json +2 -2
@@ -0,0 +1,306 @@
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.v1beta;
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/v1beta/data_store.proto";
24
+ import "google/longrunning/operations.proto";
25
+ import "google/protobuf/empty.proto";
26
+ import "google/protobuf/field_mask.proto";
27
+ import "google/protobuf/timestamp.proto";
28
+
29
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
30
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
31
+ option java_multiple_files = true;
32
+ option java_outer_classname = "DataStoreServiceProto";
33
+ option java_package = "com.google.cloud.discoveryengine.v1beta";
34
+ option objc_class_prefix = "DISCOVERYENGINE";
35
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
36
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
37
+
38
+ // Service for managing
39
+ // [DataStore][google.cloud.discoveryengine.v1beta.DataStore] configuration.
40
+ service DataStoreService {
41
+ option (google.api.default_host) = "discoveryengine.googleapis.com";
42
+ option (google.api.oauth_scopes) =
43
+ "https://www.googleapis.com/auth/cloud-platform";
44
+
45
+ // Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
46
+ //
47
+ // DataStore is for storing
48
+ // [Documents][google.cloud.discoveryengine.v1beta.Document]. To serve these
49
+ // documents for Search, or Recommendation use case, an
50
+ // [Engine][google.cloud.discoveryengine.v1beta.Engine] needs to be created
51
+ // separately.
52
+ rpc CreateDataStore(CreateDataStoreRequest)
53
+ returns (google.longrunning.Operation) {
54
+ option (google.api.http) = {
55
+ post: "/v1beta/{parent=projects/*/locations/*}/dataStores"
56
+ body: "data_store"
57
+ additional_bindings {
58
+ post: "/v1beta/{parent=projects/*/locations/*/collections/*}/dataStores"
59
+ body: "data_store"
60
+ }
61
+ };
62
+ option (google.api.method_signature) = "parent,data_store,data_store_id";
63
+ option (google.longrunning.operation_info) = {
64
+ response_type: "google.cloud.discoveryengine.v1beta.DataStore"
65
+ metadata_type: "google.cloud.discoveryengine.v1beta.CreateDataStoreMetadata"
66
+ };
67
+ }
68
+
69
+ // Gets a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
70
+ rpc GetDataStore(GetDataStoreRequest) returns (DataStore) {
71
+ option (google.api.http) = {
72
+ get: "/v1beta/{name=projects/*/locations/*/dataStores/*}"
73
+ additional_bindings {
74
+ get: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}"
75
+ }
76
+ };
77
+ option (google.api.method_signature) = "name";
78
+ }
79
+
80
+ // Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s
81
+ // associated with the project.
82
+ rpc ListDataStores(ListDataStoresRequest) returns (ListDataStoresResponse) {
83
+ option (google.api.http) = {
84
+ get: "/v1beta/{parent=projects/*/locations/*}/dataStores"
85
+ additional_bindings {
86
+ get: "/v1beta/{parent=projects/*/locations/*/collections/*}/dataStores"
87
+ }
88
+ };
89
+ option (google.api.method_signature) = "parent";
90
+ }
91
+
92
+ // Deletes a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
93
+ rpc DeleteDataStore(DeleteDataStoreRequest)
94
+ returns (google.longrunning.Operation) {
95
+ option (google.api.http) = {
96
+ delete: "/v1beta/{name=projects/*/locations/*/dataStores/*}"
97
+ additional_bindings {
98
+ delete: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}"
99
+ }
100
+ };
101
+ option (google.api.method_signature) = "name";
102
+ option (google.longrunning.operation_info) = {
103
+ response_type: "google.protobuf.Empty"
104
+ metadata_type: "google.cloud.discoveryengine.v1beta.DeleteDataStoreMetadata"
105
+ };
106
+ }
107
+
108
+ // Updates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore]
109
+ rpc UpdateDataStore(UpdateDataStoreRequest) returns (DataStore) {
110
+ option (google.api.http) = {
111
+ patch: "/v1beta/{data_store.name=projects/*/locations/*/dataStores/*}"
112
+ body: "data_store"
113
+ additional_bindings {
114
+ patch: "/v1beta/{data_store.name=projects/*/locations/*/collections/*/dataStores/*}"
115
+ body: "data_store"
116
+ }
117
+ };
118
+ option (google.api.method_signature) = "data_store,update_mask";
119
+ }
120
+ }
121
+
122
+ // Request for
123
+ // [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore]
124
+ // method.
125
+ message CreateDataStoreRequest {
126
+ // Required. The parent resource name, such as
127
+ // `projects/{project}/locations/{location}/collections/{collection}`.
128
+ string parent = 1 [
129
+ (google.api.field_behavior) = REQUIRED,
130
+ (google.api.resource_reference) = {
131
+ type: "discoveryengine.googleapis.com/Collection"
132
+ }
133
+ ];
134
+
135
+ // Required. The [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to
136
+ // create.
137
+ DataStore data_store = 2 [(google.api.field_behavior) = REQUIRED];
138
+
139
+ // Required. The ID to use for the
140
+ // [DataStore][google.cloud.discoveryengine.v1beta.DataStore], which will
141
+ // become the final component of the
142
+ // [DataStore][google.cloud.discoveryengine.v1beta.DataStore]'s resource name.
143
+ //
144
+ // This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
145
+ // standard with a length limit of 63 characters. Otherwise, an
146
+ // INVALID_ARGUMENT error is returned.
147
+ string data_store_id = 3 [(google.api.field_behavior) = REQUIRED];
148
+
149
+ // A boolean flag indicating whether user want to directly create an advanced
150
+ // data store for site search.
151
+ // If the data store is not configured as site
152
+ // search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
153
+ // be ignored.
154
+ bool create_advanced_site_search = 4;
155
+ }
156
+
157
+ // Request message for
158
+ // [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.GetDataStore]
159
+ // method.
160
+ message GetDataStoreRequest {
161
+ // Required. Full resource name of
162
+ // [DataStore][google.cloud.discoveryengine.v1beta.DataStore], such as
163
+ // `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
164
+ //
165
+ // If the caller does not have permission to access the
166
+ // [DataStore][google.cloud.discoveryengine.v1beta.DataStore], regardless of
167
+ // whether or not it exists, a PERMISSION_DENIED error is returned.
168
+ //
169
+ // If the requested [DataStore][google.cloud.discoveryengine.v1beta.DataStore]
170
+ // does not exist, a NOT_FOUND error is returned.
171
+ string name = 1 [
172
+ (google.api.field_behavior) = REQUIRED,
173
+ (google.api.resource_reference) = {
174
+ type: "discoveryengine.googleapis.com/DataStore"
175
+ }
176
+ ];
177
+ }
178
+
179
+ // Metadata related to the progress of the
180
+ // [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore]
181
+ // operation. This will be returned by the google.longrunning.Operation.metadata
182
+ // field.
183
+ message CreateDataStoreMetadata {
184
+ // Operation create time.
185
+ google.protobuf.Timestamp create_time = 1;
186
+
187
+ // Operation last update time. If the operation is done, this is also the
188
+ // finish time.
189
+ google.protobuf.Timestamp update_time = 2;
190
+ }
191
+
192
+ // Request message for
193
+ // [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores]
194
+ // method.
195
+ message ListDataStoresRequest {
196
+ // Required. The parent branch resource name, such as
197
+ // `projects/{project}/locations/{location}/collections/{collection_id}`.
198
+ //
199
+ // If the caller does not have permission to list
200
+ // [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s under this
201
+ // location, regardless of whether or not this data store exists, a
202
+ // PERMISSION_DENIED error is returned.
203
+ string parent = 1 [
204
+ (google.api.field_behavior) = REQUIRED,
205
+ (google.api.resource_reference) = {
206
+ type: "discoveryengine.googleapis.com/Collection"
207
+ }
208
+ ];
209
+
210
+ // Maximum number of
211
+ // [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s to return. If
212
+ // unspecified, defaults to 10. The maximum allowed value is 50. Values above
213
+ // 50 will be coerced to 50.
214
+ //
215
+ // If this field is negative, an INVALID_ARGUMENT is returned.
216
+ int32 page_size = 2;
217
+
218
+ // A page token
219
+ // [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListDataStoresResponse.next_page_token],
220
+ // received from a previous
221
+ // [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores]
222
+ // call. Provide this to retrieve the subsequent page.
223
+ //
224
+ // When paginating, all other parameters provided to
225
+ // [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores]
226
+ // must match the call that provided the page token. Otherwise, an
227
+ // INVALID_ARGUMENT error is returned.
228
+ string page_token = 3;
229
+
230
+ // Filter by solution type. For example: filter =
231
+ // 'solution_type:SOLUTION_TYPE_SEARCH'
232
+ string filter = 4;
233
+ }
234
+
235
+ // Response message for
236
+ // [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores]
237
+ // method.
238
+ message ListDataStoresResponse {
239
+ // All the customer's
240
+ // [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s.
241
+ repeated DataStore data_stores = 1;
242
+
243
+ // A token that can be sent as
244
+ // [ListDataStoresRequest.page_token][google.cloud.discoveryengine.v1beta.ListDataStoresRequest.page_token]
245
+ // to retrieve the next page. If this field is omitted, there are no
246
+ // subsequent pages.
247
+ string next_page_token = 2;
248
+ }
249
+
250
+ // Request message for
251
+ // [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.DeleteDataStore]
252
+ // method.
253
+ message DeleteDataStoreRequest {
254
+ // Required. Full resource name of
255
+ // [DataStore][google.cloud.discoveryengine.v1beta.DataStore], such as
256
+ // `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
257
+ //
258
+ // If the caller does not have permission to delete the
259
+ // [DataStore][google.cloud.discoveryengine.v1beta.DataStore], regardless of
260
+ // whether or not it exists, a PERMISSION_DENIED error is returned.
261
+ //
262
+ // If the [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to delete
263
+ // does not exist, a NOT_FOUND error is returned.
264
+ string name = 1 [
265
+ (google.api.field_behavior) = REQUIRED,
266
+ (google.api.resource_reference) = {
267
+ type: "discoveryengine.googleapis.com/DataStore"
268
+ }
269
+ ];
270
+ }
271
+
272
+ // Request message for
273
+ // [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.UpdateDataStore]
274
+ // method.
275
+ message UpdateDataStoreRequest {
276
+ // Required. The [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to
277
+ // update.
278
+ //
279
+ // If the caller does not have permission to update the
280
+ // [DataStore][google.cloud.discoveryengine.v1beta.DataStore], regardless of
281
+ // whether or not it exists, a PERMISSION_DENIED error is returned.
282
+ //
283
+ // If the [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to update
284
+ // does not exist, a NOT_FOUND error is returned.
285
+ DataStore data_store = 1 [(google.api.field_behavior) = REQUIRED];
286
+
287
+ // Indicates which fields in the provided
288
+ // [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to update.
289
+ //
290
+ // If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
291
+ // is returned.
292
+ google.protobuf.FieldMask update_mask = 2;
293
+ }
294
+
295
+ // Metadata related to the progress of the
296
+ // [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.DeleteDataStore]
297
+ // operation. This will be returned by the google.longrunning.Operation.metadata
298
+ // field.
299
+ message DeleteDataStoreMetadata {
300
+ // Operation create time.
301
+ google.protobuf.Timestamp create_time = 1;
302
+
303
+ // Operation last update time. If the operation is done, this is also the
304
+ // finish time.
305
+ google.protobuf.Timestamp update_time = 2;
306
+ }
@@ -53,7 +53,7 @@ message Document {
53
53
 
54
54
  // The URI of the content. Only Cloud Storage URIs (e.g.
55
55
  // `gs://bucket-name/path/to/file`) are supported. The maximum file size
56
- // is 100 MB.
56
+ // is 2.5 MB for text-based formats, 100 MB for other formats.
57
57
  string uri = 3;
58
58
  }
59
59
 
@@ -0,0 +1,220 @@
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.v1beta;
18
+
19
+ import "google/api/field_behavior.proto";
20
+ import "google/api/resource.proto";
21
+ import "google/cloud/discoveryengine/v1beta/common.proto";
22
+ import "google/protobuf/timestamp.proto";
23
+
24
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
25
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
26
+ option java_multiple_files = true;
27
+ option java_outer_classname = "EngineProto";
28
+ option java_package = "com.google.cloud.discoveryengine.v1beta";
29
+ option objc_class_prefix = "DISCOVERYENGINE";
30
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
31
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
32
+
33
+ // Metadata that describes the training and serving parameters of an
34
+ // [Engine][google.cloud.discoveryengine.v1beta.Engine].
35
+ message Engine {
36
+ option (google.api.resource) = {
37
+ type: "discoveryengine.googleapis.com/Engine"
38
+ pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}"
39
+ };
40
+
41
+ // Configurations for a Search Engine.
42
+ message SearchEngineConfig {
43
+ // The search feature tier of this engine.
44
+ //
45
+ // Different tiers might have different
46
+ // pricing. To learn more, please check the pricing documentation.
47
+ //
48
+ // Defaults to
49
+ // [SearchTier.SEARCH_TIER_STANDARD][google.cloud.discoveryengine.v1beta.SearchTier.SEARCH_TIER_STANDARD]
50
+ // if not specified.
51
+ SearchTier search_tier = 1;
52
+
53
+ // The add-on that this search engine enables.
54
+ repeated SearchAddOn search_add_ons = 2;
55
+ }
56
+
57
+ // Configurations for a Chat Engine.
58
+ message ChatEngineConfig {
59
+ // Configurations for generating a Dialogflow agent.
60
+ //
61
+ // Note that these configurations are one-time consumed by
62
+ // and passed to Dialogflow service. It means they cannot be retrieved using
63
+ // [EngineService.GetEngine][google.cloud.discoveryengine.v1beta.EngineService.GetEngine]
64
+ // or
65
+ // [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines]
66
+ // API after engine creation.
67
+ message AgentCreationConfig {
68
+ // Name of the company, organization or other entity that the agent
69
+ // represents. Used for knowledge connector LLM prompt and for knowledge
70
+ // search.
71
+ string business = 1;
72
+
73
+ // Required. The default language of the agent as a language tag.
74
+ // See [Language
75
+ // Support](https://cloud.google.com/dialogflow/docs/reference/language)
76
+ // for a list of the currently supported language codes.
77
+ string default_language_code = 2;
78
+
79
+ // Required. The time zone of the agent from the [time zone
80
+ // database](https://www.iana.org/time-zones), e.g., America/New_York,
81
+ // Europe/Paris.
82
+ string time_zone = 3 [(google.api.field_behavior) = REQUIRED];
83
+
84
+ // Agent location for Agent creation, supported values: global/us/eu.
85
+ // If not provided, us Engine will create Agent using us-central-1 by
86
+ // default; eu Engine will create Agent using eu-west-1 by default.
87
+ string location = 4;
88
+ }
89
+
90
+ // The configurationt generate the Dialogflow agent that is associated to
91
+ // this Engine.
92
+ //
93
+ // Note that these configurations are one-time consumed by
94
+ // and passed to Dialogflow service. It means they cannot be retrieved using
95
+ // [EngineService.GetEngine][google.cloud.discoveryengine.v1beta.EngineService.GetEngine]
96
+ // or
97
+ // [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines]
98
+ // API after engine creation.
99
+ AgentCreationConfig agent_creation_config = 1;
100
+
101
+ // The resource name of an exist Dialogflow agent to link to this Chat
102
+ // Engine. Customers can either provide `agent_creation_config` to create
103
+ // agent or provide an agent name that links the agent with the Chat engine.
104
+ //
105
+ // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
106
+ // ID>`.
107
+ //
108
+ // Note that the `dialogflow_agent_to_link` are one-time consumed by and
109
+ // passed to Dialogflow service. It means they cannot be retrieved using
110
+ // [EngineService.GetEngine][google.cloud.discoveryengine.v1beta.EngineService.GetEngine]
111
+ // or
112
+ // [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines]
113
+ // API after engine creation. Please use
114
+ // [ChatEngineMetadata.dialogflow_agent][google.cloud.discoveryengine.v1beta.Engine.ChatEngineMetadata.dialogflow_agent]
115
+ // for actual agent association after Engine is created.
116
+ string dialogflow_agent_to_link = 2;
117
+ }
118
+
119
+ // Common configurations for an Engine.
120
+ message CommonConfig {
121
+ // Immutable. The name of the company, business or entity that is associated
122
+ // with the engine. Setting this may help improve LLM related features.
123
+ string company_name = 1 [(google.api.field_behavior) = IMMUTABLE];
124
+ }
125
+
126
+ // Additional information of a Chat Engine.
127
+ // Fields in this message are output only.
128
+ message ChatEngineMetadata {
129
+ // The resource name of a Dialogflow agent, that this Chat Engine refers
130
+ // to.
131
+ //
132
+ // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
133
+ // ID>`.
134
+ string dialogflow_agent = 1;
135
+ }
136
+
137
+ // Additional config specs that defines the behavior of the engine.
138
+ oneof engine_config {
139
+ // Configurations for the Chat Engine. Only applicable if
140
+ // [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
141
+ // is
142
+ // [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
143
+ ChatEngineConfig chat_engine_config = 11;
144
+
145
+ // Configurations for the Search Engine. Only applicable if
146
+ // [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
147
+ // is
148
+ // [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
149
+ SearchEngineConfig search_engine_config = 13;
150
+ }
151
+
152
+ // Engine metadata to monitor the status of the engine.
153
+ oneof engine_metadata {
154
+ // Output only. Additional information of the Chat Engine. Only applicable
155
+ // if
156
+ // [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
157
+ // is
158
+ // [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
159
+ ChatEngineMetadata chat_engine_metadata = 12
160
+ [(google.api.field_behavior) = OUTPUT_ONLY];
161
+ }
162
+
163
+ // Immutable. The fully qualified resource name of the engine.
164
+ //
165
+ // This field must be a UTF-8 encoded string with a length limit of 1024
166
+ // characters.
167
+ //
168
+ // Format:
169
+ // `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
170
+ // engine should be 1-63 characters, and valid characters are
171
+ // /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
172
+ string name = 1 [(google.api.field_behavior) = IMMUTABLE];
173
+
174
+ // Required. The display name of the engine. Should be human readable. UTF-8
175
+ // encoded string with limit of 1024 characters.
176
+ string display_name = 2 [(google.api.field_behavior) = REQUIRED];
177
+
178
+ // Output only. Timestamp the Recommendation Engine was created at.
179
+ google.protobuf.Timestamp create_time = 3
180
+ [(google.api.field_behavior) = OUTPUT_ONLY];
181
+
182
+ // Output only. Timestamp the Recommendation Engine was last updated.
183
+ google.protobuf.Timestamp update_time = 4
184
+ [(google.api.field_behavior) = OUTPUT_ONLY];
185
+
186
+ // The data stores associated with this engine.
187
+ //
188
+ // For
189
+ // [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]
190
+ // and
191
+ // [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
192
+ // type of engines, they can only associate with at most one data store.
193
+ //
194
+ // If
195
+ // [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
196
+ // is
197
+ // [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT],
198
+ // multiple [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s in the
199
+ // same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be
200
+ // associated here.
201
+ //
202
+ // Note that when used in
203
+ // [CreateEngineRequest][google.cloud.discoveryengine.v1beta.CreateEngineRequest],
204
+ // one DataStore id must be provided as the system will use it for necessary
205
+ // initializations.
206
+ repeated string data_store_ids = 5;
207
+
208
+ // Required. The solutions of the engine.
209
+ SolutionType solution_type = 6 [(google.api.field_behavior) = REQUIRED];
210
+
211
+ // The industry vertical that the engine registers.
212
+ // The restriction of the Engine industry vertical is based on
213
+ // [DataStore][google.cloud.discoveryengine.v1beta.DataStore]: If unspecified,
214
+ // default to `GENERIC`. Vertical on Engine has to match vertical of the
215
+ // DataStore liniked to the engine.
216
+ IndustryVertical industry_vertical = 16;
217
+
218
+ // Common config spec that specifies the metadata of the engine.
219
+ CommonConfig common_config = 15;
220
+ }