@google-cloud/discoveryengine 1.12.0 → 1.14.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.
- package/CHANGELOG.md +14 -0
- package/README.md +10 -0
- package/build/protos/google/cloud/discoveryengine/v1/answer.proto +49 -5
- package/build/protos/google/cloud/discoveryengine/v1/control.proto +6 -4
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +9 -9
- package/build/protos/google/cloud/discoveryengine/v1/custom_tuning_model.proto +96 -0
- package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +10 -0
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +20 -0
- package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +2 -0
- package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +110 -0
- package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +13 -7
- package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +117 -0
- package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +40 -16
- package/build/protos/google/cloud/discoveryengine/v1/search_tuning_service.proto +196 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +4 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +21 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config_service.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/answer.proto +61 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion.proto +31 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +38 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/control.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +28 -9
- package/build/protos/google/cloud/discoveryengine/v1alpha/custom_tuning_model.proto +10 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +71 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +11 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +24 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +6 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +108 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/grounded_generation_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +119 -5
- package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +58 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +5 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +428 -12
- package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config.proto +14 -5
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +126 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +4 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +47 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/control.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +20 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +2 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +114 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/grounded_generation_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +13 -7
- package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +44 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +101 -6
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -0
- package/build/protos/protos.d.ts +24137 -16126
- package/build/protos/protos.js +78286 -58223
- package/build/protos/protos.json +1954 -105
- package/build/src/index.d.ts +4 -1
- package/build/src/index.js +4 -1
- package/build/src/v1/completion_service_client.d.ts +93 -0
- package/build/src/v1/completion_service_client.js +134 -0
- package/build/src/v1/control_service_client.d.ts +93 -0
- package/build/src/v1/control_service_client.js +128 -0
- package/build/src/v1/conversational_search_service_client.d.ts +93 -0
- package/build/src/v1/conversational_search_service_client.js +128 -0
- package/build/src/v1/data_store_service_client.d.ts +102 -0
- package/build/src/v1/data_store_service_client.js +134 -0
- package/build/src/v1/document_service_client.d.ts +131 -0
- package/build/src/v1/document_service_client.js +156 -0
- package/build/src/v1/document_service_client_config.json +5 -0
- package/build/src/v1/engine_service_client.d.ts +93 -0
- package/build/src/v1/engine_service_client.js +134 -0
- package/build/src/v1/grounded_generation_service_client.d.ts +93 -0
- package/build/src/v1/grounded_generation_service_client.js +128 -0
- package/build/src/v1/index.d.ts +1 -0
- package/build/src/v1/index.js +3 -1
- package/build/src/v1/project_service_client.d.ts +93 -0
- package/build/src/v1/project_service_client.js +134 -0
- package/build/src/v1/rank_service_client.d.ts +93 -0
- package/build/src/v1/rank_service_client.js +128 -0
- package/build/src/v1/recommendation_service_client.d.ts +95 -1
- package/build/src/v1/recommendation_service_client.js +128 -0
- package/build/src/v1/schema_service_client.d.ts +93 -0
- package/build/src/v1/schema_service_client.js +134 -0
- package/build/src/v1/search_service_client.d.ts +111 -9
- package/build/src/v1/search_service_client.js +140 -6
- package/build/src/v1/search_tuning_service_client.d.ts +1776 -0
- package/build/src/v1/search_tuning_service_client.js +2589 -0
- package/build/src/v1/search_tuning_service_client_config.json +34 -0
- package/build/src/v1/site_search_engine_service_client.d.ts +93 -0
- package/build/src/v1/site_search_engine_service_client.js +134 -0
- package/build/src/v1/user_event_service_client.d.ts +168 -0
- package/build/src/v1/user_event_service_client.js +176 -0
- package/build/src/v1/user_event_service_client_config.json +5 -0
- package/build/src/v1alpha/acl_config_service_client.d.ts +1 -1
- package/build/src/v1alpha/completion_service_client.d.ts +91 -0
- package/build/src/v1alpha/completion_service_client.js +90 -0
- package/build/src/v1alpha/completion_service_client_config.json +10 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +18 -0
- package/build/src/v1alpha/data_store_service_client.d.ts +12 -3
- package/build/src/v1alpha/data_store_service_client.js +8 -2
- package/build/src/v1alpha/document_service_client.d.ts +33 -0
- package/build/src/v1alpha/document_service_client.js +28 -0
- package/build/src/v1alpha/document_service_client_config.json +5 -0
- package/build/src/v1alpha/engine_service_client.js +6 -0
- package/build/src/v1alpha/estimate_billing_service_client.js +6 -0
- package/build/src/v1alpha/evaluation_service_client.js +6 -0
- package/build/src/v1alpha/project_service_client.js +6 -0
- package/build/src/v1alpha/sample_query_service_client.js +6 -0
- package/build/src/v1alpha/schema_service_client.js +6 -0
- package/build/src/v1alpha/search_service_client.d.ts +219 -21
- package/build/src/v1alpha/search_service_client.js +146 -14
- package/build/src/v1alpha/search_tuning_service_client.js +6 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +101 -0
- package/build/src/v1alpha/site_search_engine_service_client.js +70 -0
- package/build/src/v1alpha/site_search_engine_service_client_config.json +8 -0
- package/build/src/v1alpha/user_event_service_client.js +6 -0
- package/build/src/v1beta/document_service_client.d.ts +38 -0
- package/build/src/v1beta/document_service_client.js +22 -0
- package/build/src/v1beta/document_service_client_config.json +5 -0
- package/build/src/v1beta/search_service_client.d.ts +36 -9
- package/build/src/v1beta/search_service_client.js +24 -6
- package/package.json +2 -2
@@ -84,7 +84,7 @@ message BigQuerySource {
|
|
84
84
|
google.type.Date partition_date = 5;
|
85
85
|
}
|
86
86
|
|
87
|
-
// The project ID
|
87
|
+
// The project ID or the project number that contains the BigQuery source. Has
|
88
88
|
// a length limit of 128 characters. If not specified, inherits the project
|
89
89
|
// ID from the parent request.
|
90
90
|
string project_id = 1;
|
@@ -127,7 +127,7 @@ message BigQuerySource {
|
|
127
127
|
|
128
128
|
// The Spanner source for importing data
|
129
129
|
message SpannerSource {
|
130
|
-
// The project ID that the Spanner source
|
130
|
+
// The project ID that contains the Spanner source. Has a length limit of 128
|
131
131
|
// characters. If not specified, inherits the project ID from the parent
|
132
132
|
// request.
|
133
133
|
string project_id = 1;
|
@@ -261,7 +261,7 @@ message BigtableOptions {
|
|
261
261
|
|
262
262
|
// The Cloud Bigtable source for importing data.
|
263
263
|
message BigtableSource {
|
264
|
-
// The project ID that the Bigtable source
|
264
|
+
// The project ID that contains the Bigtable source. Has a length limit of 128
|
265
265
|
// characters. If not specified, inherits the project ID from the parent
|
266
266
|
// request.
|
267
267
|
string project_id = 1;
|
@@ -293,12 +293,18 @@ message FhirStoreSource {
|
|
293
293
|
// limit of 2,000 characters. Can be specified if one wants to have the
|
294
294
|
// FhirStore export to a specific Cloud Storage directory.
|
295
295
|
string gcs_staging_dir = 2;
|
296
|
+
|
297
|
+
// The FHIR resource types to import. The resource types should be a subset of
|
298
|
+
// all [supported FHIR resource
|
299
|
+
// types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification).
|
300
|
+
// Default to all supported FHIR resource types if empty.
|
301
|
+
repeated string resource_types = 3;
|
296
302
|
}
|
297
303
|
|
298
304
|
// Cloud SQL source import data from.
|
299
305
|
message CloudSqlSource {
|
300
|
-
// The project ID that the Cloud SQL source
|
301
|
-
// characters. If not specified, inherits the project ID from the parent
|
306
|
+
// The project ID that contains the Cloud SQL source. Has a length limit of
|
307
|
+
// 128 characters. If not specified, inherits the project ID from the parent
|
302
308
|
// request.
|
303
309
|
string project_id = 1;
|
304
310
|
|
@@ -328,6 +334,38 @@ message CloudSqlSource {
|
|
328
334
|
bool offload = 6;
|
329
335
|
}
|
330
336
|
|
337
|
+
// AlloyDB source import data from.
|
338
|
+
message AlloyDbSource {
|
339
|
+
// The project ID that contains the AlloyDB source.
|
340
|
+
// Has a length limit of 128 characters. If not specified, inherits the
|
341
|
+
// project ID from the parent request.
|
342
|
+
string project_id = 1;
|
343
|
+
|
344
|
+
// Required. The AlloyDB location to copy the data from with a length limit of
|
345
|
+
// 256 characters.
|
346
|
+
string location_id = 2 [(google.api.field_behavior) = REQUIRED];
|
347
|
+
|
348
|
+
// Required. The AlloyDB cluster to copy the data from with a length limit of
|
349
|
+
// 256 characters.
|
350
|
+
string cluster_id = 3 [(google.api.field_behavior) = REQUIRED];
|
351
|
+
|
352
|
+
// Required. The AlloyDB database to copy the data from with a length limit of
|
353
|
+
// 256 characters.
|
354
|
+
string database_id = 4 [(google.api.field_behavior) = REQUIRED];
|
355
|
+
|
356
|
+
// Required. The AlloyDB table to copy the data from with a length limit of
|
357
|
+
// 256 characters.
|
358
|
+
string table_id = 5 [(google.api.field_behavior) = REQUIRED];
|
359
|
+
|
360
|
+
// Intermediate Cloud Storage directory used for the import with a length
|
361
|
+
// limit of 2,000 characters. Can be specified if one wants to have the
|
362
|
+
// AlloyDB export to a specific Cloud Storage directory.
|
363
|
+
//
|
364
|
+
// Ensure that the AlloyDB service account has the necessary Cloud
|
365
|
+
// Storage Admin permissions to access the specified Cloud Storage directory.
|
366
|
+
string gcs_staging_dir = 6;
|
367
|
+
}
|
368
|
+
|
331
369
|
// Firestore source import data from.
|
332
370
|
message FirestoreSource {
|
333
371
|
// The project ID that the Cloud SQL source is in with a length limit of 128
|
@@ -501,6 +539,9 @@ message ImportDocumentsRequest {
|
|
501
539
|
// Firestore input source.
|
502
540
|
FirestoreSource firestore_source = 13;
|
503
541
|
|
542
|
+
// AlloyDB input source.
|
543
|
+
AlloyDbSource alloy_db_source = 14;
|
544
|
+
|
504
545
|
// Cloud Bigtable input source.
|
505
546
|
BigtableSource bigtable_source = 15;
|
506
547
|
}
|
@@ -666,6 +707,79 @@ message ImportSuggestionDenyListEntriesMetadata {
|
|
666
707
|
google.protobuf.Timestamp update_time = 2;
|
667
708
|
}
|
668
709
|
|
710
|
+
// Request message for
|
711
|
+
// [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions]
|
712
|
+
// method.
|
713
|
+
message ImportCompletionSuggestionsRequest {
|
714
|
+
// The inline source for CompletionSuggestions.
|
715
|
+
message InlineSource {
|
716
|
+
// Required. A list of all denylist entries to import. Max of 1000 items.
|
717
|
+
repeated CompletionSuggestion suggestions = 1
|
718
|
+
[(google.api.field_behavior) = REQUIRED];
|
719
|
+
}
|
720
|
+
|
721
|
+
// The source of the autocomplete suggestions.
|
722
|
+
oneof source {
|
723
|
+
// The Inline source for suggestion entries.
|
724
|
+
InlineSource inline_source = 2;
|
725
|
+
|
726
|
+
// Cloud Storage location for the input content.
|
727
|
+
GcsSource gcs_source = 3;
|
728
|
+
|
729
|
+
// BigQuery input source.
|
730
|
+
BigQuerySource bigquery_source = 4;
|
731
|
+
}
|
732
|
+
|
733
|
+
// Required. The parent data store resource name for which to import customer
|
734
|
+
// autocomplete suggestions.
|
735
|
+
//
|
736
|
+
// Follows pattern `projects/*/locations/*/collections/*/dataStores/*`
|
737
|
+
string parent = 1 [
|
738
|
+
(google.api.field_behavior) = REQUIRED,
|
739
|
+
(google.api.resource_reference) = {
|
740
|
+
type: "discoveryengine.googleapis.com/DataStore"
|
741
|
+
}
|
742
|
+
];
|
743
|
+
|
744
|
+
// The desired location of errors incurred during the Import.
|
745
|
+
ImportErrorConfig error_config = 5;
|
746
|
+
}
|
747
|
+
|
748
|
+
// Response of the
|
749
|
+
// [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions]
|
750
|
+
// method. If the long running operation is done, this message is returned by
|
751
|
+
// the google.longrunning.Operations.response field if the operation is
|
752
|
+
// successful.
|
753
|
+
message ImportCompletionSuggestionsResponse {
|
754
|
+
// A sample of errors encountered while processing the request.
|
755
|
+
repeated google.rpc.Status error_samples = 1;
|
756
|
+
|
757
|
+
// The desired location of errors incurred during the Import.
|
758
|
+
ImportErrorConfig error_config = 2;
|
759
|
+
}
|
760
|
+
|
761
|
+
// Metadata related to the progress of the ImportCompletionSuggestions
|
762
|
+
// operation. This will be returned by the google.longrunning.Operation.metadata
|
763
|
+
// field.
|
764
|
+
message ImportCompletionSuggestionsMetadata {
|
765
|
+
// Operation create time.
|
766
|
+
google.protobuf.Timestamp create_time = 1;
|
767
|
+
|
768
|
+
// Operation last update time. If the operation is done, this is also the
|
769
|
+
// finish time.
|
770
|
+
google.protobuf.Timestamp update_time = 2;
|
771
|
+
|
772
|
+
// Count of
|
773
|
+
// [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
|
774
|
+
// successfully imported.
|
775
|
+
int64 success_count = 3;
|
776
|
+
|
777
|
+
// Count of
|
778
|
+
// [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
|
779
|
+
// that failed to be imported.
|
780
|
+
int64 failure_count = 4;
|
781
|
+
}
|
782
|
+
|
669
783
|
// Request message for
|
670
784
|
// [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueries]
|
671
785
|
// method.
|
@@ -120,13 +120,32 @@ message PurgeErrorConfig {
|
|
120
120
|
// [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments]
|
121
121
|
// method.
|
122
122
|
message PurgeDocumentsRequest {
|
123
|
-
// The
|
123
|
+
// The inline source for the input config for
|
124
|
+
// [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments]
|
125
|
+
// method.
|
126
|
+
message InlineSource {
|
127
|
+
// Required. A list of full resource name of documents to purge. In the
|
128
|
+
// format
|
129
|
+
// `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
|
130
|
+
// Recommended max of 100 items.
|
131
|
+
repeated string documents = 1 [
|
132
|
+
(google.api.field_behavior) = REQUIRED,
|
133
|
+
(google.api.resource_reference) = {
|
134
|
+
type: "discoveryengine.googleapis.com/Document"
|
135
|
+
}
|
136
|
+
];
|
137
|
+
}
|
138
|
+
|
139
|
+
// The desired input source for the purging documents based on document IDs.
|
124
140
|
oneof source {
|
125
141
|
// Cloud Storage location for the input content.
|
126
142
|
// Supported `data_schema`:
|
127
143
|
// * `document_id`: One valid
|
128
144
|
// [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] per line.
|
129
145
|
GcsSource gcs_source = 5;
|
146
|
+
|
147
|
+
// Inline source for the input content for purge.
|
148
|
+
InlineSource inline_source = 6;
|
130
149
|
}
|
131
150
|
|
132
151
|
// Required. The parent resource name, such as
|
@@ -223,3 +242,41 @@ message PurgeSuggestionDenyListEntriesMetadata {
|
|
223
242
|
// finish time.
|
224
243
|
google.protobuf.Timestamp update_time = 2;
|
225
244
|
}
|
245
|
+
|
246
|
+
// Request message for
|
247
|
+
// [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeCompletionSuggestions]
|
248
|
+
// method.
|
249
|
+
message PurgeCompletionSuggestionsRequest {
|
250
|
+
// Required. The parent data store resource name for which to purge completion
|
251
|
+
// suggestions. Follows pattern
|
252
|
+
// projects/*/locations/*/collections/*/dataStores/*.
|
253
|
+
string parent = 1 [
|
254
|
+
(google.api.field_behavior) = REQUIRED,
|
255
|
+
(google.api.resource_reference) = {
|
256
|
+
type: "discoveryengine.googleapis.com/DataStore"
|
257
|
+
}
|
258
|
+
];
|
259
|
+
}
|
260
|
+
|
261
|
+
// Response message for
|
262
|
+
// [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeCompletionSuggestions]
|
263
|
+
// method.
|
264
|
+
message PurgeCompletionSuggestionsResponse {
|
265
|
+
// Whether the completion suggestions were successfully purged.
|
266
|
+
bool purge_succeeded = 1;
|
267
|
+
|
268
|
+
// A sample of errors encountered while processing the request.
|
269
|
+
repeated google.rpc.Status error_samples = 2;
|
270
|
+
}
|
271
|
+
|
272
|
+
// Metadata related to the progress of the PurgeCompletionSuggestions
|
273
|
+
// operation. This is returned by the google.longrunning.Operation.metadata
|
274
|
+
// field.
|
275
|
+
message PurgeCompletionSuggestionsMetadata {
|
276
|
+
// Operation create time.
|
277
|
+
google.protobuf.Timestamp create_time = 1;
|
278
|
+
|
279
|
+
// Operation last update time. If the operation is done, this is also the
|
280
|
+
// finish time.
|
281
|
+
google.protobuf.Timestamp update_time = 2;
|
282
|
+
}
|
@@ -192,6 +192,11 @@ message FieldConfig {
|
|
192
192
|
// Retrieve value from page map.
|
193
193
|
PAGEMAP = 2;
|
194
194
|
|
195
|
+
// Retrieve value from the attributes set by
|
196
|
+
// [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData]
|
197
|
+
// API.
|
198
|
+
URI_PATTERN_MAPPING = 3;
|
199
|
+
|
195
200
|
// Retrieve value from schema.org data.
|
196
201
|
SCHEMA_ORG = 4;
|
197
202
|
}
|