@google-cloud/discoveryengine 1.1.0 → 1.3.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 (59) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +39 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +190 -0
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +134 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +138 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +306 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +98 -0
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +307 -0
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +121 -0
  10. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +318 -0
  11. package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +370 -0
  12. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +336 -0
  13. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +343 -0
  14. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +159 -0
  15. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +227 -0
  16. package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +312 -0
  17. package/build/protos/google/cloud/discoveryengine/v1alpha/schema_service.proto +260 -0
  18. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +874 -0
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +152 -0
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +475 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +154 -0
  22. package/build/protos/protos.d.ts +16365 -7
  23. package/build/protos/protos.js +42499 -1945
  24. package/build/protos/protos.json +4455 -5
  25. package/build/src/index.d.ts +3 -1
  26. package/build/src/index.js +4 -1
  27. package/build/src/v1alpha/completion_service_client.d.ts +645 -0
  28. package/build/src/v1alpha/completion_service_client.js +901 -0
  29. package/build/src/v1alpha/completion_service_client_config.json +43 -0
  30. package/build/src/v1alpha/conversational_search_service_client.d.ts +1040 -0
  31. package/build/src/v1alpha/conversational_search_service_client.js +1333 -0
  32. package/build/src/v1alpha/conversational_search_service_client_config.json +68 -0
  33. package/build/src/v1alpha/data_store_service_client.d.ts +1060 -0
  34. package/build/src/v1alpha/data_store_service_client.js +1431 -0
  35. package/build/src/v1alpha/data_store_service_client_config.json +46 -0
  36. package/build/src/v1alpha/document_service_client.d.ts +1257 -0
  37. package/build/src/v1alpha/document_service_client.js +1555 -0
  38. package/build/src/v1alpha/document_service_client_config.json +82 -0
  39. package/build/src/v1alpha/engine_service_client.d.ts +1079 -0
  40. package/build/src/v1alpha/engine_service_client.js +1481 -0
  41. package/build/src/v1alpha/engine_service_client_config.json +58 -0
  42. package/build/src/v1alpha/index.d.ts +10 -0
  43. package/build/src/v1alpha/index.js +41 -0
  44. package/build/src/v1alpha/recommendation_service_client.d.ts +858 -0
  45. package/build/src/v1alpha/recommendation_service_client.js +1100 -0
  46. package/build/src/v1alpha/recommendation_service_client_config.json +43 -0
  47. package/build/src/v1alpha/schema_service_client.d.ts +977 -0
  48. package/build/src/v1alpha/schema_service_client.js +1385 -0
  49. package/build/src/v1alpha/schema_service_client_config.json +63 -0
  50. package/build/src/v1alpha/search_service_client.d.ts +1394 -0
  51. package/build/src/v1alpha/search_service_client.js +1640 -0
  52. package/build/src/v1alpha/search_service_client_config.json +43 -0
  53. package/build/src/v1alpha/site_search_engine_service_client.d.ts +821 -0
  54. package/build/src/v1alpha/site_search_engine_service_client.js +1249 -0
  55. package/build/src/v1alpha/site_search_engine_service_client_config.json +30 -0
  56. package/build/src/v1alpha/user_event_service_client.d.ts +895 -0
  57. package/build/src/v1alpha/user_event_service_client.js +1232 -0
  58. package/build/src/v1alpha/user_event_service_client_config.json +67 -0
  59. package/package.json +5 -5
@@ -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.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/conversation.proto";
24
+ import "google/cloud/discoveryengine/v1alpha/search_service.proto";
25
+ import "google/protobuf/empty.proto";
26
+ import "google/protobuf/field_mask.proto";
27
+
28
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
29
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
30
+ option java_multiple_files = true;
31
+ option java_outer_classname = "ConversationalSearchServiceProto";
32
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
33
+ option objc_class_prefix = "DISCOVERYENGINE";
34
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
35
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
36
+
37
+ // Service for conversational search.
38
+ service ConversationalSearchService {
39
+ option (google.api.default_host) = "discoveryengine.googleapis.com";
40
+ option (google.api.oauth_scopes) =
41
+ "https://www.googleapis.com/auth/cloud-platform";
42
+
43
+ // Converses a conversation.
44
+ rpc ConverseConversation(ConverseConversationRequest)
45
+ returns (ConverseConversationResponse) {
46
+ option (google.api.http) = {
47
+ post: "/v1alpha/{name=projects/*/locations/*/dataStores/*/conversations/*}:converse"
48
+ body: "*"
49
+ additional_bindings {
50
+ post: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}:converse"
51
+ body: "*"
52
+ }
53
+ };
54
+ option (google.api.method_signature) = "name,query";
55
+ }
56
+
57
+ // Creates a Conversation.
58
+ //
59
+ // If the [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
60
+ // create already exists, an ALREADY_EXISTS error is returned.
61
+ rpc CreateConversation(CreateConversationRequest) returns (Conversation) {
62
+ option (google.api.http) = {
63
+ post: "/v1alpha/{parent=projects/*/locations/*/dataStores/*}/conversations"
64
+ body: "conversation"
65
+ additional_bindings {
66
+ post: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations"
67
+ body: "conversation"
68
+ }
69
+ };
70
+ option (google.api.method_signature) = "parent,conversation";
71
+ }
72
+
73
+ // Deletes a Conversation.
74
+ //
75
+ // If the [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
76
+ // delete does not exist, a NOT_FOUND error is returned.
77
+ rpc DeleteConversation(DeleteConversationRequest)
78
+ returns (google.protobuf.Empty) {
79
+ option (google.api.http) = {
80
+ delete: "/v1alpha/{name=projects/*/locations/*/dataStores/*/conversations/*}"
81
+ additional_bindings {
82
+ delete: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}"
83
+ }
84
+ };
85
+ option (google.api.method_signature) = "name";
86
+ }
87
+
88
+ // Updates a Conversation.
89
+ //
90
+ // [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] action
91
+ // type cannot be changed. If the
92
+ // [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to update
93
+ // does not exist, a NOT_FOUND error is returned.
94
+ rpc UpdateConversation(UpdateConversationRequest) returns (Conversation) {
95
+ option (google.api.http) = {
96
+ patch: "/v1alpha/{conversation.name=projects/*/locations/*/dataStores/*/conversations/*}"
97
+ body: "conversation"
98
+ additional_bindings {
99
+ patch: "/v1alpha/{conversation.name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}"
100
+ body: "conversation"
101
+ }
102
+ };
103
+ option (google.api.method_signature) = "conversation,update_mask";
104
+ }
105
+
106
+ // Gets a Conversation.
107
+ rpc GetConversation(GetConversationRequest) returns (Conversation) {
108
+ option (google.api.http) = {
109
+ get: "/v1alpha/{name=projects/*/locations/*/dataStores/*/conversations/*}"
110
+ additional_bindings {
111
+ get: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}"
112
+ }
113
+ };
114
+ option (google.api.method_signature) = "name";
115
+ }
116
+
117
+ // Lists all Conversations by their parent
118
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
119
+ rpc ListConversations(ListConversationsRequest)
120
+ returns (ListConversationsResponse) {
121
+ option (google.api.http) = {
122
+ get: "/v1alpha/{parent=projects/*/locations/*/dataStores/*}/conversations"
123
+ additional_bindings {
124
+ get: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations"
125
+ }
126
+ };
127
+ option (google.api.method_signature) = "parent";
128
+ }
129
+ }
130
+
131
+ // Request message for
132
+ // [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation]
133
+ // method.
134
+ message ConverseConversationRequest {
135
+ // Required. The resource name of the Conversation to get. Format:
136
+ // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
137
+ // Use
138
+ // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
139
+ // to activate auto session mode, which automatically creates a new
140
+ // conversation inside a ConverseConversation session.
141
+ string name = 1 [
142
+ (google.api.field_behavior) = REQUIRED,
143
+ (google.api.resource_reference) = {
144
+ type: "discoveryengine.googleapis.com/Conversation"
145
+ }
146
+ ];
147
+
148
+ // Required. Current user input.
149
+ TextInput query = 2 [(google.api.field_behavior) = REQUIRED];
150
+
151
+ // The resource name of the Serving Config to use. Format:
152
+ // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
153
+ // If this is not set, the default serving config will be used.
154
+ string serving_config = 3 [(google.api.resource_reference) = {
155
+ type: "discoveryengine.googleapis.com/ServingConfig"
156
+ }];
157
+
158
+ // The conversation to be used by auto session only. The name field will be
159
+ // ignored as we automatically assign new name for the conversation in auto
160
+ // session.
161
+ Conversation conversation = 5;
162
+
163
+ // Whether to turn on safe search.
164
+ bool safe_search = 6;
165
+
166
+ // The user labels applied to a resource must meet the following requirements:
167
+ //
168
+ // * Each resource can have multiple labels, up to a maximum of 64.
169
+ // * Each label must be a key-value pair.
170
+ // * Keys have a minimum length of 1 character and a maximum length of 63
171
+ // characters and cannot be empty. Values can be empty and have a maximum
172
+ // length of 63 characters.
173
+ // * Keys and values can contain only lowercase letters, numeric characters,
174
+ // underscores, and dashes. All characters must use UTF-8 encoding, and
175
+ // international characters are allowed.
176
+ // * The key portion of a label must be unique. However, you can use the same
177
+ // key with multiple resources.
178
+ // * Keys must start with a lowercase letter or international character.
179
+ //
180
+ // See [Google Cloud
181
+ // Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
182
+ // for more details.
183
+ map<string, string> user_labels = 7;
184
+
185
+ // A specification for configuring the summary returned in the response.
186
+ SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;
187
+ }
188
+
189
+ // Response message for
190
+ // [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation]
191
+ // method.
192
+ message ConverseConversationResponse {
193
+ // Answer to the current query.
194
+ Reply reply = 1;
195
+
196
+ // Updated conversation including the answer.
197
+ Conversation conversation = 2;
198
+
199
+ // Suggested related questions.
200
+ repeated string related_questions = 6;
201
+
202
+ // Search Results.
203
+ repeated SearchResponse.SearchResult search_results = 3;
204
+ }
205
+
206
+ // Request for CreateConversation method.
207
+ message CreateConversationRequest {
208
+ // Required. Full resource name of parent data store. Format:
209
+ // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
210
+ string parent = 1 [
211
+ (google.api.field_behavior) = REQUIRED,
212
+ (google.api.resource_reference) = {
213
+ type: "discoveryengine.googleapis.com/DataStore"
214
+ }
215
+ ];
216
+
217
+ // Required. The conversation to create.
218
+ Conversation conversation = 2 [(google.api.field_behavior) = REQUIRED];
219
+ }
220
+
221
+ // Request for UpdateConversation method.
222
+ message UpdateConversationRequest {
223
+ // Required. The Conversation to update.
224
+ Conversation conversation = 1 [(google.api.field_behavior) = REQUIRED];
225
+
226
+ // Indicates which fields in the provided
227
+ // [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
228
+ // update. The following are NOT supported:
229
+ //
230
+ // * [conversation.name][]
231
+ //
232
+ // If not set or empty, all supported fields are updated.
233
+ google.protobuf.FieldMask update_mask = 2;
234
+ }
235
+
236
+ // Request for DeleteConversation method.
237
+ message DeleteConversationRequest {
238
+ // Required. The resource name of the Conversation to delete. Format:
239
+ // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
240
+ string name = 1 [
241
+ (google.api.field_behavior) = REQUIRED,
242
+ (google.api.resource_reference) = {
243
+ type: "discoveryengine.googleapis.com/Conversation"
244
+ }
245
+ ];
246
+ }
247
+
248
+ // Request for GetConversation method.
249
+ message GetConversationRequest {
250
+ // Required. The resource name of the Conversation to get. Format:
251
+ // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
252
+ string name = 1 [
253
+ (google.api.field_behavior) = REQUIRED,
254
+ (google.api.resource_reference) = {
255
+ type: "discoveryengine.googleapis.com/Conversation"
256
+ }
257
+ ];
258
+ }
259
+
260
+ // Request for ListConversations method.
261
+ message ListConversationsRequest {
262
+ // Required. The data store resource name. Format:
263
+ // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
264
+ string parent = 1 [
265
+ (google.api.field_behavior) = REQUIRED,
266
+ (google.api.resource_reference) = {
267
+ type: "discoveryengine.googleapis.com/DataStore"
268
+ }
269
+ ];
270
+
271
+ // Maximum number of results to return. If unspecified, defaults
272
+ // to 50. Max allowed value is 1000.
273
+ int32 page_size = 2;
274
+
275
+ // A page token, received from a previous `ListConversations` call.
276
+ // Provide this to retrieve the subsequent page.
277
+ string page_token = 3;
278
+
279
+ // A filter to apply on the list results. The supported features are:
280
+ // user_pseudo_id, state.
281
+ //
282
+ // Example:
283
+ // "user_pseudo_id = some_id"
284
+ string filter = 4;
285
+
286
+ // A comma-separated list of fields to order by, sorted in ascending order.
287
+ // Use "desc" after a field name for descending.
288
+ // Supported fields:
289
+ // * `update_time`
290
+ // * `create_time`
291
+ // * `conversation_name`
292
+ //
293
+ // Example:
294
+ // "update_time desc"
295
+ // "create_time"
296
+ string order_by = 5;
297
+ }
298
+
299
+ // Response for ListConversations method.
300
+ message ListConversationsResponse {
301
+ // All the Conversations for a given data store.
302
+ repeated Conversation conversations = 1;
303
+
304
+ // Pagination token, if not returned indicates the last page.
305
+ string next_page_token = 2;
306
+ }
@@ -0,0 +1,98 @@
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/field_behavior.proto";
20
+ import "google/api/resource.proto";
21
+ import "google/cloud/discoveryengine/v1alpha/common.proto";
22
+ import "google/protobuf/timestamp.proto";
23
+
24
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
25
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
26
+ option java_multiple_files = true;
27
+ option java_outer_classname = "DataStoreProto";
28
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
29
+ option objc_class_prefix = "DISCOVERYENGINE";
30
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
31
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
32
+
33
+ // DataStore captures global settings and configs at the DataStore level.
34
+ message DataStore {
35
+ option (google.api.resource) = {
36
+ type: "discoveryengine.googleapis.com/DataStore"
37
+ pattern: "projects/{project}/locations/{location}/dataStores/{data_store}"
38
+ pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}"
39
+ };
40
+
41
+ // Content config of the data store.
42
+ enum ContentConfig {
43
+ // Default value.
44
+ CONTENT_CONFIG_UNSPECIFIED = 0;
45
+
46
+ // Only contains documents without any
47
+ // [Document.content][google.cloud.discoveryengine.v1alpha.Document.content].
48
+ NO_CONTENT = 1;
49
+
50
+ // Only contains documents with
51
+ // [Document.content][google.cloud.discoveryengine.v1alpha.Document.content].
52
+ CONTENT_REQUIRED = 2;
53
+
54
+ // The data store is used for public website search.
55
+ PUBLIC_WEBSITE = 3;
56
+ }
57
+
58
+ // Immutable. The full resource name of the data store.
59
+ // Format:
60
+ // `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
61
+ //
62
+ // This field must be a UTF-8 encoded string with a length limit of 1024
63
+ // characters.
64
+ string name = 1 [(google.api.field_behavior) = IMMUTABLE];
65
+
66
+ // Required. The data store display name.
67
+ //
68
+ // This field must be a UTF-8 encoded string with a length limit of 128
69
+ // characters. Otherwise, an INVALID_ARGUMENT error is returned.
70
+ string display_name = 2 [(google.api.field_behavior) = REQUIRED];
71
+
72
+ // Immutable. The industry vertical that the data store registers.
73
+ IndustryVertical industry_vertical = 3
74
+ [(google.api.field_behavior) = IMMUTABLE];
75
+
76
+ // The solutions that the data store enrolls. Available solutions for each
77
+ // [industry_vertical][google.cloud.discoveryengine.v1alpha.DataStore.industry_vertical]:
78
+ //
79
+ // * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`.
80
+ // * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other
81
+ // solutions cannot be enrolled.
82
+ repeated SolutionType solution_types = 5;
83
+
84
+ // Output only. The id of the default
85
+ // [Schema][google.cloud.discoveryengine.v1alpha.Schema] asscociated to this
86
+ // data store.
87
+ string default_schema_id = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
88
+
89
+ // Immutable. The content config of the data store. If this field is unset,
90
+ // the server behavior defaults to
91
+ // [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.NO_CONTENT].
92
+ ContentConfig content_config = 6 [(google.api.field_behavior) = IMMUTABLE];
93
+
94
+ // Output only. Timestamp the
95
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] was created at.
96
+ google.protobuf.Timestamp create_time = 4
97
+ [(google.api.field_behavior) = OUTPUT_ONLY];
98
+ }