@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,242 @@
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.v1;
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/v1/engine.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.V1";
30
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
31
+ option java_multiple_files = true;
32
+ option java_outer_classname = "EngineServiceProto";
33
+ option java_package = "com.google.cloud.discoveryengine.v1";
34
+ option objc_class_prefix = "DISCOVERYENGINE";
35
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
36
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
37
+
38
+ // Service for managing [Engine][google.cloud.discoveryengine.v1.Engine]
39
+ // configuration.
40
+ service EngineService {
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 [Engine][google.cloud.discoveryengine.v1.Engine].
46
+ rpc CreateEngine(CreateEngineRequest) returns (google.longrunning.Operation) {
47
+ option (google.api.http) = {
48
+ post: "/v1/{parent=projects/*/locations/*/collections/*}/engines"
49
+ body: "engine"
50
+ };
51
+ option (google.api.method_signature) = "parent,engine,engine_id";
52
+ option (google.longrunning.operation_info) = {
53
+ response_type: "google.cloud.discoveryengine.v1.Engine"
54
+ metadata_type: "google.cloud.discoveryengine.v1.CreateEngineMetadata"
55
+ };
56
+ }
57
+
58
+ // Deletes a [Engine][google.cloud.discoveryengine.v1.Engine].
59
+ rpc DeleteEngine(DeleteEngineRequest) returns (google.longrunning.Operation) {
60
+ option (google.api.http) = {
61
+ delete: "/v1/{name=projects/*/locations/*/collections/*/engines/*}"
62
+ };
63
+ option (google.api.method_signature) = "name";
64
+ option (google.longrunning.operation_info) = {
65
+ response_type: "google.protobuf.Empty"
66
+ metadata_type: "google.cloud.discoveryengine.v1.DeleteEngineMetadata"
67
+ };
68
+ }
69
+
70
+ // Updates an [Engine][google.cloud.discoveryengine.v1.Engine]
71
+ rpc UpdateEngine(UpdateEngineRequest) returns (Engine) {
72
+ option (google.api.http) = {
73
+ patch: "/v1/{engine.name=projects/*/locations/*/collections/*/engines/*}"
74
+ body: "engine"
75
+ };
76
+ option (google.api.method_signature) = "engine,update_mask";
77
+ }
78
+
79
+ // Gets a [Engine][google.cloud.discoveryengine.v1.Engine].
80
+ rpc GetEngine(GetEngineRequest) returns (Engine) {
81
+ option (google.api.http) = {
82
+ get: "/v1/{name=projects/*/locations/*/collections/*/engines/*}"
83
+ };
84
+ option (google.api.method_signature) = "name";
85
+ }
86
+
87
+ // Lists all the [Engine][google.cloud.discoveryengine.v1.Engine]s associated
88
+ // with the project.
89
+ rpc ListEngines(ListEnginesRequest) returns (ListEnginesResponse) {
90
+ option (google.api.http) = {
91
+ get: "/v1/{parent=projects/*/locations/*/collections/*}/engines"
92
+ };
93
+ option (google.api.method_signature) = "parent";
94
+ }
95
+ }
96
+
97
+ // Request for
98
+ // [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine]
99
+ // method.
100
+ message CreateEngineRequest {
101
+ // Required. The parent resource name, such as
102
+ // `projects/{project}/locations/{location}/collections/{collection}`.
103
+ string parent = 1 [
104
+ (google.api.field_behavior) = REQUIRED,
105
+ (google.api.resource_reference) = {
106
+ type: "discoveryengine.googleapis.com/Collection"
107
+ }
108
+ ];
109
+
110
+ // Required. The [Engine][google.cloud.discoveryengine.v1.Engine] to create.
111
+ Engine engine = 2 [(google.api.field_behavior) = REQUIRED];
112
+
113
+ // Required. The ID to use for the
114
+ // [Engine][google.cloud.discoveryengine.v1.Engine], which will become the
115
+ // final component of the [Engine][google.cloud.discoveryengine.v1.Engine]'s
116
+ // resource name.
117
+ //
118
+ // This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
119
+ // standard with a length limit of 63 characters. Otherwise, an
120
+ // INVALID_ARGUMENT error is returned.
121
+ string engine_id = 3 [(google.api.field_behavior) = REQUIRED];
122
+ }
123
+
124
+ // Metadata related to the progress of the
125
+ // [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine]
126
+ // operation. This will be returned by the google.longrunning.Operation.metadata
127
+ // field.
128
+ message CreateEngineMetadata {
129
+ // Operation create time.
130
+ google.protobuf.Timestamp create_time = 1;
131
+
132
+ // Operation last update time. If the operation is done, this is also the
133
+ // finish time.
134
+ google.protobuf.Timestamp update_time = 2;
135
+ }
136
+
137
+ // Request message for
138
+ // [EngineService.DeleteEngine][google.cloud.discoveryengine.v1.EngineService.DeleteEngine]
139
+ // method.
140
+ message DeleteEngineRequest {
141
+ // Required. Full resource name of
142
+ // [Engine][google.cloud.discoveryengine.v1.Engine], such as
143
+ // `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
144
+ //
145
+ // If the caller does not have permission to delete the
146
+ // [Engine][google.cloud.discoveryengine.v1.Engine], regardless of whether or
147
+ // not it exists, a PERMISSION_DENIED error is returned.
148
+ //
149
+ // If the [Engine][google.cloud.discoveryengine.v1.Engine] to delete does not
150
+ // exist, a NOT_FOUND error is returned.
151
+ string name = 1 [
152
+ (google.api.field_behavior) = REQUIRED,
153
+ (google.api.resource_reference) = {
154
+ type: "discoveryengine.googleapis.com/Engine"
155
+ }
156
+ ];
157
+ }
158
+
159
+ // Metadata related to the progress of the
160
+ // [EngineService.DeleteEngine][google.cloud.discoveryengine.v1.EngineService.DeleteEngine]
161
+ // operation. This will be returned by the google.longrunning.Operation.metadata
162
+ // field.
163
+ message DeleteEngineMetadata {
164
+ // Operation create time.
165
+ google.protobuf.Timestamp create_time = 1;
166
+
167
+ // Operation last update time. If the operation is done, this is also the
168
+ // finish time.
169
+ google.protobuf.Timestamp update_time = 2;
170
+ }
171
+
172
+ // Request message for
173
+ // [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine]
174
+ // method.
175
+ message GetEngineRequest {
176
+ // Required. Full resource name of
177
+ // [Engine][google.cloud.discoveryengine.v1.Engine], such as
178
+ // `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
179
+ string name = 1 [
180
+ (google.api.field_behavior) = REQUIRED,
181
+ (google.api.resource_reference) = {
182
+ type: "discoveryengine.googleapis.com/Engine"
183
+ }
184
+ ];
185
+ }
186
+
187
+ // Request message for
188
+ // [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines]
189
+ // method.
190
+ message ListEnginesRequest {
191
+ // Required. The parent resource name, such as
192
+ // `projects/{project}/locations/{location}/collections/{collection_id}`.
193
+ string parent = 1 [
194
+ (google.api.field_behavior) = REQUIRED,
195
+ (google.api.resource_reference) = {
196
+ type: "discoveryengine.googleapis.com/Collection"
197
+ }
198
+ ];
199
+
200
+ // Optional. Not supported.
201
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
202
+
203
+ // Optional. Not supported.
204
+ string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
205
+
206
+ // Optional. Filter by solution type. For example:
207
+ // solution_type=SOLUTION_TYPE_SEARCH
208
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
209
+ }
210
+
211
+ // Response message for
212
+ // [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines]
213
+ // method.
214
+ message ListEnginesResponse {
215
+ // All the customer's [Engine][google.cloud.discoveryengine.v1.Engine]s.
216
+ repeated Engine engines = 1;
217
+
218
+ // Not supported.
219
+ string next_page_token = 2;
220
+ }
221
+
222
+ // Request message for
223
+ // [EngineService.UpdateEngine][google.cloud.discoveryengine.v1.EngineService.UpdateEngine]
224
+ // method.
225
+ message UpdateEngineRequest {
226
+ // Required. The [Engine][google.cloud.discoveryengine.v1.Engine] to update.
227
+ //
228
+ // If the caller does not have permission to update the
229
+ // [Engine][google.cloud.discoveryengine.v1.Engine], regardless of whether or
230
+ // not it exists, a PERMISSION_DENIED error is returned.
231
+ //
232
+ // If the [Engine][google.cloud.discoveryengine.v1.Engine] to update does not
233
+ // exist, a NOT_FOUND error is returned.
234
+ Engine engine = 1 [(google.api.field_behavior) = REQUIRED];
235
+
236
+ // Indicates which fields in the provided
237
+ // [Engine][google.cloud.discoveryengine.v1.Engine] to update.
238
+ //
239
+ // If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
240
+ // is returned.
241
+ google.protobuf.FieldMask update_mask = 2;
242
+ }
@@ -18,6 +18,7 @@ package google.cloud.discoveryengine.v1;
18
18
 
19
19
  import "google/api/field_behavior.proto";
20
20
  import "google/api/resource.proto";
21
+ import "google/cloud/discoveryengine/v1/completion.proto";
21
22
  import "google/cloud/discoveryengine/v1/document.proto";
22
23
  import "google/cloud/discoveryengine/v1/user_event.proto";
23
24
  import "google/protobuf/timestamp.proto";
@@ -336,3 +337,66 @@ message ImportDocumentsResponse {
336
337
  // Echoes the destination for the complete errors in the request if set.
337
338
  ImportErrorConfig error_config = 2;
338
339
  }
340
+
341
+ // Request message for
342
+ // [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.ImportSuggestionDenyListEntries]
343
+ // method.
344
+ message ImportSuggestionDenyListEntriesRequest {
345
+ // The inline source for SuggestionDenyListEntry.
346
+ message InlineSource {
347
+ // Required. A list of all denylist entries to import. Max of 1000 items.
348
+ repeated SuggestionDenyListEntry entries = 1
349
+ [(google.api.field_behavior) = REQUIRED];
350
+ }
351
+
352
+ // The source of the updated SuggestionDenyList.
353
+ oneof source {
354
+ // The Inline source for the input content for suggestion deny list entries.
355
+ InlineSource inline_source = 2;
356
+
357
+ // Cloud Storage location for the input content.
358
+ //
359
+ // Only 1 file can be specified that contains all entries to import.
360
+ // Supported values `gcs_source.schema` for autocomplete suggestion deny
361
+ // list entry imports:
362
+ //
363
+ // * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry]
364
+ // per line.
365
+ GcsSource gcs_source = 3;
366
+ }
367
+
368
+ // Required. The parent data store resource name for which to import denylist
369
+ // entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
370
+ string parent = 1 [
371
+ (google.api.field_behavior) = REQUIRED,
372
+ (google.api.resource_reference) = {
373
+ type: "discoveryengine.googleapis.com/DataStore"
374
+ }
375
+ ];
376
+ }
377
+
378
+ // Response message for
379
+ // [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.ImportSuggestionDenyListEntries]
380
+ // method.
381
+ message ImportSuggestionDenyListEntriesResponse {
382
+ // A sample of errors encountered while processing the request.
383
+ repeated google.rpc.Status error_samples = 1;
384
+
385
+ // Count of deny list entries successfully imported.
386
+ int64 imported_entries_count = 2;
387
+
388
+ // Count of deny list entries that failed to be imported.
389
+ int64 failed_entries_count = 3;
390
+ }
391
+
392
+ // Metadata related to the progress of the ImportSuggestionDenyListEntries
393
+ // operation. This is returned by the google.longrunning.Operation.metadata
394
+ // field.
395
+ message ImportSuggestionDenyListEntriesMetadata {
396
+ // Operation create time.
397
+ google.protobuf.Timestamp create_time = 1;
398
+
399
+ // Operation last update time. If the operation is done, this is also the
400
+ // finish time.
401
+ google.protobuf.Timestamp update_time = 2;
402
+ }
@@ -19,6 +19,7 @@ package google.cloud.discoveryengine.v1;
19
19
  import "google/api/field_behavior.proto";
20
20
  import "google/api/resource.proto";
21
21
  import "google/protobuf/timestamp.proto";
22
+ import "google/rpc/status.proto";
22
23
 
23
24
  option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
24
25
  option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
@@ -84,3 +85,40 @@ message PurgeDocumentsMetadata {
84
85
  // Count of entries that encountered errors while processing.
85
86
  int64 failure_count = 4;
86
87
  }
88
+
89
+ // Request message for
90
+ // [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.PurgeSuggestionDenyListEntries]
91
+ // method.
92
+ message PurgeSuggestionDenyListEntriesRequest {
93
+ // Required. The parent data store resource name for which to import denylist
94
+ // entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
95
+ string parent = 1 [
96
+ (google.api.field_behavior) = REQUIRED,
97
+ (google.api.resource_reference) = {
98
+ type: "discoveryengine.googleapis.com/DataStore"
99
+ }
100
+ ];
101
+ }
102
+
103
+ // Response message for
104
+ // [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.PurgeSuggestionDenyListEntries]
105
+ // method.
106
+ message PurgeSuggestionDenyListEntriesResponse {
107
+ // Number of suggestion deny list entries purged.
108
+ int64 purge_count = 1;
109
+
110
+ // A sample of errors encountered while processing the request.
111
+ repeated google.rpc.Status error_samples = 2;
112
+ }
113
+
114
+ // Metadata related to the progress of the PurgeSuggestionDenyListEntries
115
+ // operation. This is returned by the google.longrunning.Operation.metadata
116
+ // field.
117
+ message PurgeSuggestionDenyListEntriesMetadata {
118
+ // Operation create time.
119
+ google.protobuf.Timestamp create_time = 1;
120
+
121
+ // Operation last update time. If the operation is done, this is also the
122
+ // finish time.
123
+ google.protobuf.Timestamp update_time = 2;
124
+ }
@@ -48,6 +48,10 @@ service SearchService {
48
48
  post: "/v1/{serving_config=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:search"
49
49
  body: "*"
50
50
  }
51
+ additional_bindings {
52
+ post: "/v1/{serving_config=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:search"
53
+ body: "*"
54
+ }
51
55
  };
52
56
  }
53
57
  }
@@ -317,6 +321,28 @@ message SearchRequest {
317
321
  // A specification for configuring a summary returned in a search
318
322
  // response.
319
323
  message SummarySpec {
324
+ // Specification of the prompt to use with the model.
325
+ message ModelPromptSpec {
326
+ // Text at the beginning of the prompt that instructs the assistant.
327
+ // Examples are available in the user guide.
328
+ string preamble = 1;
329
+ }
330
+
331
+ // Specification of the model.
332
+ message ModelSpec {
333
+ // The model version used to generate the summary.
334
+ //
335
+ // Supported values are:
336
+ //
337
+ // * `stable`: string. Default value when no value is specified. Uses a
338
+ // generally available, fine-tuned version of the text-bison@001
339
+ // model.
340
+ // * `preview`: string. (Public preview) Uses a fine-tuned version of
341
+ // the text-bison@002 model. This model works only for summaries in
342
+ // English.
343
+ string version = 1;
344
+ }
345
+
320
346
  // The number of top results to generate the summary from. If the number
321
347
  // of results returned is less than `summaryResultCount`, the summary is
322
348
  // generated from all of the results.
@@ -368,9 +394,18 @@ message SearchRequest {
368
394
  // fallback messages instead.
369
395
  bool ignore_non_summary_seeking_query = 4;
370
396
 
397
+ // If specified, the spec will be used to modify the prompt provided to
398
+ // the LLM.
399
+ ModelPromptSpec model_prompt_spec = 5;
400
+
371
401
  // Language code for Summary. Use language tags defined by
372
- // [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].
402
+ // [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
403
+ // Note: This is an experimental feature.
373
404
  string language_code = 6;
405
+
406
+ // If specified, the spec will be used to modify the model specification
407
+ // provided to the LLM.
408
+ ModelSpec model_spec = 7;
374
409
  }
375
410
 
376
411
  // If `snippetSpec` is not specified, snippets are not included in the
@@ -383,6 +418,8 @@ message SearchRequest {
383
418
  }
384
419
 
385
420
  // Required. The resource name of the Search serving config, such as
421
+ // `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
422
+ // or
386
423
  // `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
387
424
  // This field is used to identify the serving configuration name, set
388
425
  // of models used to make the search.
@@ -440,12 +477,37 @@ message SearchRequest {
440
477
  // expression is case-sensitive.
441
478
  //
442
479
  // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
480
+ //
481
+ // Filtering in Vertex AI Search is done by mapping the LHS filter key to a
482
+ // key property defined in the Vertex AI Search backend -- this mapping is
483
+ // defined by the customer in their schema. For example a media customer might
484
+ // have a field 'name' in their schema. In this case the filter would look
485
+ // like this: filter --> name:'ANY("king kong")'
486
+ //
487
+ // For more information about filtering including syntax and filter
488
+ // operators, see
489
+ // [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
443
490
  string filter = 7;
444
491
 
492
+ // The default filter that is applied when a user performs a search without
493
+ // checking any filters on the search page.
494
+ //
495
+ // The filter applied to every search request when quality improvement such as
496
+ // query expansion is needed. In the case a query does not have a sufficient
497
+ // amount of results this filter will be used to determine whether or not to
498
+ // enable the query expansion flow. The original filter will still be used for
499
+ // the query expanded search.
500
+ // This field is strongly recommended to achieve high search quality.
501
+ //
502
+ // For more information about filter syntax, see
503
+ // [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter].
504
+ string canonical_filter = 29;
505
+
445
506
  // The order in which documents are returned. Documents can be ordered by
446
507
  // a field in an [Document][google.cloud.discoveryengine.v1.Document] object.
447
508
  // Leave it unset if ordered by relevance. `order_by` expression is
448
- // case-sensitive.
509
+ // case-sensitive. For more information on ordering, see
510
+ // [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
449
511
  //
450
512
  // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
451
513
  string order_by = 8;
@@ -463,6 +525,8 @@ message SearchRequest {
463
525
  repeated FacetSpec facet_specs = 9;
464
526
 
465
527
  // Boost specification to boost certain documents.
528
+ // For more information on boosting, see
529
+ // [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
466
530
  BoostSpec boost_spec = 10;
467
531
 
468
532
  // Additional search parameters.
@@ -471,9 +535,17 @@ message SearchRequest {
471
535
  //
472
536
  // * `user_country_code`: string. Default empty. If set to non-empty, results
473
537
  // are restricted or boosted based on the location provided.
538
+ // Example:
539
+ // user_country_code: "au"
540
+ //
541
+ // For available codes see [Country
542
+ // Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
543
+ //
474
544
  // * `search_type`: double. Default empty. Enables non-webpage searching
475
- // depending on the value. The only valid non-default value is 1,
476
- // which enables image searching.
545
+ // depending on the value. The only valid non-default value is 1,
546
+ // which enables image searching.
547
+ // Example:
548
+ // search_type: 1
477
549
  map<string, google.protobuf.Value> params = 11;
478
550
 
479
551
  // The query expansion specification that specifies the conditions under which
@@ -585,6 +657,64 @@ message SearchResponse {
585
657
  repeated float scores = 2;
586
658
  }
587
659
 
660
+ // Citation metadata.
661
+ message CitationMetadata {
662
+ // Citations for segments.
663
+ repeated Citation citations = 1;
664
+ }
665
+
666
+ // Citation info for a segment.
667
+ message Citation {
668
+ // Index indicates the start of the segment, measured in bytes/unicode.
669
+ int64 start_index = 1;
670
+
671
+ // End of the attributed segment, exclusive.
672
+ int64 end_index = 2;
673
+
674
+ // Citation sources for the attributed segment.
675
+ repeated CitationSource sources = 3;
676
+ }
677
+
678
+ // Citation source.
679
+ message CitationSource {
680
+ // Document reference index from SummaryWithMetadata.references.
681
+ // It is 0-indexed and the value will be zero if the reference_index is
682
+ // not set explicitly.
683
+ int64 reference_index = 4;
684
+ }
685
+
686
+ // Document reference.
687
+ message Reference {
688
+ // Title of the document.
689
+ string title = 1;
690
+
691
+ // Required.
692
+ // [Document.name][google.cloud.discoveryengine.v1.Document.name] of the
693
+ // document. Full resource name of the referenced document, in the format
694
+ // `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
695
+ string document = 2 [
696
+ (google.api.field_behavior) = REQUIRED,
697
+ (google.api.resource_reference) = {
698
+ type: "discoveryengine.googleapis.com/Document"
699
+ }
700
+ ];
701
+
702
+ // Cloud Storage or HTTP uri for the document.
703
+ string uri = 3;
704
+ }
705
+
706
+ // Summary with metadata information.
707
+ message SummaryWithMetadata {
708
+ // Summary text with no citation information.
709
+ string summary = 1;
710
+
711
+ // Citation metadata for given summary.
712
+ CitationMetadata citation_metadata = 2;
713
+
714
+ // Document References.
715
+ repeated Reference references = 3;
716
+ }
717
+
588
718
  // An Enum for summary-skipped reasons.
589
719
  enum SummarySkippedReason {
590
720
  // Default value. The summary skipped reason is not specified.
@@ -633,6 +763,9 @@ message SearchResponse {
633
763
  // A collection of Safety Attribute categories and their associated
634
764
  // confidence scores.
635
765
  SafetyAttributes safety_attributes = 3;
766
+
767
+ // Summary with metadata information.
768
+ SummaryWithMetadata summary_with_metadata = 4;
636
769
  }
637
770
 
638
771
  // Information describing query expansion including whether expansion has