@google-cloud/discoveryengine 1.13.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.
Files changed (92) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +6 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +49 -5
  4. package/build/protos/google/cloud/discoveryengine/v1/control.proto +6 -4
  5. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +9 -9
  6. package/build/protos/google/cloud/discoveryengine/v1/custom_tuning_model.proto +96 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +10 -0
  8. package/build/protos/google/cloud/discoveryengine/v1/document.proto +20 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +2 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +110 -0
  11. package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +2 -1
  12. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +13 -7
  13. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +117 -0
  14. package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +2 -1
  15. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +40 -16
  16. package/build/protos/google/cloud/discoveryengine/v1/search_tuning_service.proto +196 -0
  17. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +4 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +21 -0
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config_service.proto +1 -1
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/answer.proto +6 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/control.proto +1 -1
  22. package/build/protos/google/cloud/discoveryengine/v1alpha/custom_tuning_model.proto +3 -0
  23. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +48 -0
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +20 -0
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +107 -0
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/grounded_generation_service.proto +2 -1
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +7 -7
  28. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +1 -1
  29. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +21 -1
  30. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +4 -0
  31. package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +47 -2
  32. package/build/protos/google/cloud/discoveryengine/v1beta/control.proto +1 -1
  33. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +3 -0
  34. package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto +3 -0
  35. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +20 -0
  36. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +2 -0
  37. package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +114 -0
  38. package/build/protos/google/cloud/discoveryengine/v1beta/grounded_generation_service.proto +2 -1
  39. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +13 -7
  40. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +44 -0
  41. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +101 -6
  42. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -0
  43. package/build/protos/protos.d.ts +7369 -2842
  44. package/build/protos/protos.js +13311 -2062
  45. package/build/protos/protos.json +1096 -45
  46. package/build/src/index.d.ts +4 -1
  47. package/build/src/index.js +4 -1
  48. package/build/src/v1/completion_service_client.d.ts +93 -0
  49. package/build/src/v1/completion_service_client.js +134 -0
  50. package/build/src/v1/control_service_client.d.ts +93 -0
  51. package/build/src/v1/control_service_client.js +128 -0
  52. package/build/src/v1/conversational_search_service_client.d.ts +93 -0
  53. package/build/src/v1/conversational_search_service_client.js +128 -0
  54. package/build/src/v1/data_store_service_client.d.ts +102 -0
  55. package/build/src/v1/data_store_service_client.js +134 -0
  56. package/build/src/v1/document_service_client.d.ts +131 -0
  57. package/build/src/v1/document_service_client.js +156 -0
  58. package/build/src/v1/document_service_client_config.json +5 -0
  59. package/build/src/v1/engine_service_client.d.ts +93 -0
  60. package/build/src/v1/engine_service_client.js +134 -0
  61. package/build/src/v1/grounded_generation_service_client.d.ts +93 -0
  62. package/build/src/v1/grounded_generation_service_client.js +128 -0
  63. package/build/src/v1/index.d.ts +1 -0
  64. package/build/src/v1/index.js +3 -1
  65. package/build/src/v1/project_service_client.d.ts +93 -0
  66. package/build/src/v1/project_service_client.js +134 -0
  67. package/build/src/v1/rank_service_client.d.ts +93 -0
  68. package/build/src/v1/rank_service_client.js +128 -0
  69. package/build/src/v1/recommendation_service_client.d.ts +95 -1
  70. package/build/src/v1/recommendation_service_client.js +128 -0
  71. package/build/src/v1/schema_service_client.d.ts +93 -0
  72. package/build/src/v1/schema_service_client.js +134 -0
  73. package/build/src/v1/search_service_client.d.ts +111 -9
  74. package/build/src/v1/search_service_client.js +140 -6
  75. package/build/src/v1/search_tuning_service_client.d.ts +1776 -0
  76. package/build/src/v1/search_tuning_service_client.js +2589 -0
  77. package/build/src/v1/search_tuning_service_client_config.json +34 -0
  78. package/build/src/v1/site_search_engine_service_client.d.ts +93 -0
  79. package/build/src/v1/site_search_engine_service_client.js +134 -0
  80. package/build/src/v1/user_event_service_client.d.ts +168 -0
  81. package/build/src/v1/user_event_service_client.js +176 -0
  82. package/build/src/v1/user_event_service_client_config.json +5 -0
  83. package/build/src/v1alpha/acl_config_service_client.d.ts +1 -1
  84. package/build/src/v1alpha/document_service_client.d.ts +29 -0
  85. package/build/src/v1alpha/document_service_client.js +22 -0
  86. package/build/src/v1alpha/document_service_client_config.json +5 -0
  87. package/build/src/v1beta/document_service_client.d.ts +38 -0
  88. package/build/src/v1beta/document_service_client.js +22 -0
  89. package/build/src/v1beta/document_service_client_config.json +5 -0
  90. package/build/src/v1beta/search_service_client.d.ts +36 -9
  91. package/build/src/v1beta/search_service_client.js +24 -6
  92. package/package.json +1 -1
@@ -26,6 +26,7 @@ import "google/cloud/discoveryengine/v1alpha/purge_config.proto";
26
26
  import "google/longrunning/operations.proto";
27
27
  import "google/protobuf/empty.proto";
28
28
  import "google/protobuf/field_mask.proto";
29
+ import "google/protobuf/timestamp.proto";
29
30
 
30
31
  option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
31
32
  option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
@@ -171,6 +172,20 @@ service DocumentService {
171
172
  };
172
173
  option (google.api.method_signature) = "name";
173
174
  }
175
+
176
+ // Gets index freshness metadata for
177
+ // [Document][google.cloud.discoveryengine.v1alpha.Document]s. Supported for
178
+ // website search only.
179
+ rpc BatchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest)
180
+ returns (BatchGetDocumentsMetadataResponse) {
181
+ option (google.api.http) = {
182
+ get: "/v1alpha/{parent=projects/*/locations/*/dataStores/*/branches/*}/batchGetDocumentsMetadata"
183
+ additional_bindings {
184
+ get: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/batchGetDocumentsMetadata"
185
+ }
186
+ };
187
+ option (google.api.method_signature) = "parent";
188
+ }
174
189
  }
175
190
 
176
191
  // Request message for
@@ -389,3 +404,95 @@ message GetProcessedDocumentRequest {
389
404
  // What format output should be. If unspecified, defaults to JSON.
390
405
  ProcessedDocumentFormat processed_document_format = 3;
391
406
  }
407
+
408
+ // Request message for
409
+ // [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1alpha.DocumentService.BatchGetDocumentsMetadata]
410
+ // method.
411
+ message BatchGetDocumentsMetadataRequest {
412
+ // Matcher for the [Document][google.cloud.discoveryengine.v1alpha.Document]s
413
+ // by exact uris.
414
+ message UrisMatcher {
415
+ // The exact URIs to match by.
416
+ repeated string uris = 1;
417
+ }
418
+
419
+ // Matcher for the [Document][google.cloud.discoveryengine.v1alpha.Document]s.
420
+ // Currently supports matching by exact URIs.
421
+ message Matcher {
422
+ // Matcher for the
423
+ // [Document][google.cloud.discoveryengine.v1alpha.Document]s.
424
+ oneof matcher {
425
+ // Matcher by exact URIs.
426
+ UrisMatcher uris_matcher = 1;
427
+ }
428
+ }
429
+
430
+ // Required. The parent branch resource name, such as
431
+ // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
432
+ string parent = 1 [
433
+ (google.api.field_behavior) = REQUIRED,
434
+ (google.api.resource_reference) = {
435
+ type: "discoveryengine.googleapis.com/Branch"
436
+ }
437
+ ];
438
+
439
+ // Required. Matcher for the
440
+ // [Document][google.cloud.discoveryengine.v1alpha.Document]s.
441
+ Matcher matcher = 2 [(google.api.field_behavior) = REQUIRED];
442
+ }
443
+
444
+ // Response message for
445
+ // [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1alpha.DocumentService.BatchGetDocumentsMetadata]
446
+ // method.
447
+ message BatchGetDocumentsMetadataResponse {
448
+ // The metadata of a
449
+ // [Document][google.cloud.discoveryengine.v1alpha.Document].
450
+ message DocumentMetadata {
451
+ // The value of the matcher that was used to match the
452
+ // [Document][google.cloud.discoveryengine.v1alpha.Document].
453
+ message MatcherValue {
454
+ // The value of the matcher that was used to match the
455
+ // [Document][google.cloud.discoveryengine.v1alpha.Document].
456
+ oneof matcher_value {
457
+ // If match by URI, the URI of the
458
+ // [Document][google.cloud.discoveryengine.v1alpha.Document].
459
+ string uri = 1;
460
+ }
461
+ }
462
+
463
+ // The value of the matcher that was used to match the
464
+ // [Document][google.cloud.discoveryengine.v1alpha.Document].
465
+ MatcherValue matcher_value = 2;
466
+
467
+ // The state of the document.
468
+ State state = 3;
469
+
470
+ // The timestamp of the last time the
471
+ // [Document][google.cloud.discoveryengine.v1alpha.Document] was last
472
+ // indexed.
473
+ google.protobuf.Timestamp last_refreshed_time = 4;
474
+ }
475
+
476
+ // The state of the
477
+ // [Document][google.cloud.discoveryengine.v1alpha.Document].
478
+ enum State {
479
+ // Should never be set.
480
+ STATE_UNSPECIFIED = 0;
481
+
482
+ // The [Document][google.cloud.discoveryengine.v1alpha.Document] is indexed.
483
+ INDEXED = 1;
484
+
485
+ // The [Document][google.cloud.discoveryengine.v1alpha.Document] is not
486
+ // indexed because its URI is not in the
487
+ // [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
488
+ NOT_IN_TARGET_SITE = 2;
489
+
490
+ // The [Document][google.cloud.discoveryengine.v1alpha.Document] is not
491
+ // indexed.
492
+ NOT_IN_INDEX = 3;
493
+ }
494
+
495
+ // The metadata of the
496
+ // [Document][google.cloud.discoveryengine.v1alpha.Document]s.
497
+ repeated DocumentMetadata documents_metadata = 1;
498
+ }
@@ -129,8 +129,9 @@ message CheckGroundingResponse {
129
129
  // field will be set to false. In that case, no grounding check was done for
130
130
  // the claim and therefore
131
131
  // [citation_indices][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.citation_indices],
132
+ // [anti_citation_indices][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.anti_citation_indices],
132
133
  // and
133
- // [anti_citation_indices][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.anti_citation_indices]
134
+ // [score][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.score]
134
135
  // should not be returned.
135
136
  optional bool grounding_check_required = 6;
136
137
  }
@@ -84,7 +84,7 @@ message BigQuerySource {
84
84
  google.type.Date partition_date = 5;
85
85
  }
86
86
 
87
- // The project ID (can be project # or ID) that the BigQuery source is in with
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 is in with a length limit of 128
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 is in with a length limit of 128
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;
@@ -303,8 +303,8 @@ message FhirStoreSource {
303
303
 
304
304
  // Cloud SQL source import data from.
305
305
  message CloudSqlSource {
306
- // The project ID that the Cloud SQL source is in with a length limit of 128
307
- // 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
308
308
  // request.
309
309
  string project_id = 1;
310
310
 
@@ -336,8 +336,8 @@ message CloudSqlSource {
336
336
 
337
337
  // AlloyDB source import data from.
338
338
  message AlloyDbSource {
339
- // The project ID that the AlloyDB source is in
340
- // with a length limit of 128 characters. If not specified, inherits the
339
+ // The project ID that contains the AlloyDB source.
340
+ // Has a length limit of 128 characters. If not specified, inherits the
341
341
  // project ID from the parent request.
342
342
  string project_id = 1;
343
343
 
@@ -136,7 +136,7 @@ message PurgeDocumentsRequest {
136
136
  ];
137
137
  }
138
138
 
139
- // The desired input source for the purging documents based on document ids.
139
+ // The desired input source for the purging documents based on document IDs.
140
140
  oneof source {
141
141
  // Cloud Storage location for the input content.
142
142
  // Supported `data_schema`:
@@ -1279,6 +1279,19 @@ message SearchResponse {
1279
1279
  // [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
1280
1280
  // is set to `true`.
1281
1281
  JAIL_BREAKING_QUERY_IGNORED = 7;
1282
+
1283
+ // The customer policy violation case.
1284
+ //
1285
+ // Google skips the summary if there is a customer policy violation
1286
+ // detected. The policy is defined by the customer.
1287
+ CUSTOMER_POLICY_VIOLATION = 8;
1288
+
1289
+ // The non-answer seeking query ignored case.
1290
+ //
1291
+ // Only used when
1292
+ // [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
1293
+ // is set to `true`.
1294
+ NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9;
1282
1295
  }
1283
1296
 
1284
1297
  // The summary content.
@@ -1333,6 +1346,9 @@ message SearchResponse {
1333
1346
  // Values of the string field. The record will only be returned if the
1334
1347
  // field value matches one of the values specified here.
1335
1348
  repeated string values = 2;
1349
+
1350
+ // Identifies the keywords within the search query that match a filter.
1351
+ string query_segment = 3;
1336
1352
  }
1337
1353
 
1338
1354
  // Constraint expression of a number field. Example: price < 100.
@@ -1367,6 +1383,9 @@ message SearchResponse {
1367
1383
 
1368
1384
  // The value specified in the numerical constraint.
1369
1385
  double value = 3;
1386
+
1387
+ // Identifies the keywords within the search query that match a filter.
1388
+ string query_segment = 4;
1370
1389
  }
1371
1390
 
1372
1391
  // Constraint of a geolocation field.
@@ -1506,7 +1525,8 @@ message SearchResponse {
1506
1525
  // A unique search token. This should be included in the
1507
1526
  // [UserEvent][google.cloud.discoveryengine.v1alpha.UserEvent] logs resulting
1508
1527
  // from this search, which enables accurate attribution of search model
1509
- // performance.
1528
+ // performance. This also helps to identify a request during the customer
1529
+ // support scenarios.
1510
1530
  string attribution_token = 4;
1511
1531
 
1512
1532
  // The URI of a customer-defined redirect page. If redirect action is
@@ -458,6 +458,10 @@ message DocumentInfo {
458
458
  // The promotion IDs associated with this Document.
459
459
  // Currently, this field is restricted to at most one ID.
460
460
  repeated string promotion_ids = 4;
461
+
462
+ // Output only. Whether the referenced Document can be found in the data
463
+ // store.
464
+ bool joined = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
461
465
  }
462
466
 
463
467
  // Detailed panel information associated with a user event.
@@ -69,6 +69,13 @@ message Answer {
69
69
 
70
70
  // Page identifier.
71
71
  string page_identifier = 2;
72
+
73
+ // The relevance of the chunk for a given query. Values range from 0.0
74
+ // (completely irrelevant) to 1.0 (completely relevant).
75
+ // This value is for informational purpose only. It may change for
76
+ // the same query and chunk at any time due to a model retraining or
77
+ // change in implementation.
78
+ optional float relevance_score = 3;
72
79
  }
73
80
 
74
81
  // Document resource name.
@@ -121,13 +128,28 @@ message Answer {
121
128
  // Chunk textual content.
122
129
  string content = 2;
123
130
 
124
- // Relevance score.
131
+ // The relevance of the chunk for a given query. Values range from 0.0
132
+ // (completely irrelevant) to 1.0 (completely relevant).
133
+ // This value is for informational purpose only. It may change for
134
+ // the same query and chunk at any time due to a model retraining or
135
+ // change in implementation.
125
136
  optional float relevance_score = 3;
126
137
 
127
138
  // Document metadata.
128
139
  DocumentMetadata document_metadata = 4;
129
140
  }
130
141
 
142
+ // Structured search information.
143
+ message StructuredDocumentInfo {
144
+ // Document resource name.
145
+ string document = 1 [(google.api.resource_reference) = {
146
+ type: "discoveryengine.googleapis.com/Document"
147
+ }];
148
+
149
+ // Structured search data.
150
+ google.protobuf.Struct struct_data = 2;
151
+ }
152
+
131
153
  // Search result content.
132
154
  oneof content {
133
155
  // Unstructured document information.
@@ -135,6 +157,9 @@ message Answer {
135
157
 
136
158
  // Chunk information.
137
159
  ChunkInfo chunk_info = 2;
160
+
161
+ // Structured document information.
162
+ StructuredDocumentInfo structured_document_info = 3;
138
163
  }
139
164
  }
140
165
 
@@ -168,7 +193,11 @@ message Answer {
168
193
  // Chunk textual content.
169
194
  string content = 2;
170
195
 
171
- // Relevance score.
196
+ // The relevance of the chunk for a given query. Values range from
197
+ // 0.0 (completely irrelevant) to 1.0 (completely relevant).
198
+ // This value is for informational purpose only. It may change for
199
+ // the same query and chunk at any time due to a model retraining or
200
+ // change in implementation.
172
201
  optional float relevance_score = 3;
173
202
  }
174
203
 
@@ -255,6 +284,9 @@ message Answer {
255
284
 
256
285
  // Non-answer-seeking query classification type.
257
286
  NON_ANSWER_SEEKING_QUERY = 2;
287
+
288
+ // Jail-breaking query classification type.
289
+ JAIL_BREAKING_QUERY = 3;
258
290
  }
259
291
 
260
292
  // Query classification type.
@@ -310,6 +342,19 @@ message Answer {
310
342
  // Google skips the answer if there is no relevant content in the
311
343
  // retrieved search results.
312
344
  NO_RELEVANT_CONTENT = 5;
345
+
346
+ // The jail-breaking query ignored case.
347
+ //
348
+ // For example, "Reply in the tone of a competing company's CEO".
349
+ // Google skips the answer if the query is classified as a jail-breaking
350
+ // query.
351
+ JAIL_BREAKING_QUERY_IGNORED = 6;
352
+
353
+ // The customer policy violation case.
354
+ //
355
+ // Google skips the summary if there is a customer policy violation
356
+ // detected. The policy is defined by the customer.
357
+ CUSTOMER_POLICY_VIOLATION = 7;
313
358
  }
314
359
 
315
360
  // Immutable. Fully qualified name
@@ -184,7 +184,7 @@ message Control {
184
184
  string display_name = 2 [(google.api.field_behavior) = REQUIRED];
185
185
 
186
186
  // Output only. List of all
187
- // [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] ids this
187
+ // [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] IDs this
188
188
  // control is attached to. May take up to 10 minutes to update after changes.
189
189
  repeated string associated_serving_config_ids = 3
190
190
  [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -706,6 +706,9 @@ message AnswerQueryRequest {
706
706
 
707
707
  // Non-answer-seeking query classification type.
708
708
  NON_ANSWER_SEEKING_QUERY = 2;
709
+
710
+ // Jail-breaking query classification type.
711
+ JAIL_BREAKING_QUERY = 3;
709
712
  }
710
713
 
711
714
  // Enabled query classification types.
@@ -59,6 +59,9 @@ message CustomTuningModel {
59
59
 
60
60
  // The model training finished successfully but metrics did not improve.
61
61
  NO_IMPROVEMENT = 6;
62
+
63
+ // Input data validation failed. Model training didn't start.
64
+ INPUT_VALIDATION_FAILED = 7;
62
65
  }
63
66
 
64
67
  // Required. The fully qualified resource name of the model.
@@ -20,6 +20,7 @@ import "google/api/field_behavior.proto";
20
20
  import "google/api/resource.proto";
21
21
  import "google/protobuf/struct.proto";
22
22
  import "google/protobuf/timestamp.proto";
23
+ import "google/rpc/status.proto";
23
24
 
24
25
  option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
25
26
  option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
@@ -70,6 +71,17 @@ message Document {
70
71
  string mime_type = 1;
71
72
  }
72
73
 
74
+ // Index status of the document.
75
+ message IndexStatus {
76
+ // The time when the document was indexed.
77
+ // If this field is populated, it means the document has been indexed.
78
+ google.protobuf.Timestamp index_time = 1;
79
+
80
+ // A sample of errors encountered while indexing the document.
81
+ // If this field is populated, the document is not indexed due to errors.
82
+ repeated google.rpc.Status error_samples = 2;
83
+ }
84
+
73
85
  // Data representation. One of
74
86
  // [struct_data][google.cloud.discoveryengine.v1beta.Document.struct_data] or
75
87
  // [json_data][google.cloud.discoveryengine.v1beta.Document.json_data] should
@@ -127,4 +139,12 @@ message Document {
127
139
  // document has never been indexed.
128
140
  google.protobuf.Timestamp index_time = 13
129
141
  [(google.api.field_behavior) = OUTPUT_ONLY];
142
+
143
+ // Output only. The index status of the document.
144
+ //
145
+ // * If document is indexed successfully, the index_time field is populated.
146
+ // * Otherwise, if document is not indexed due to errors, the error_samples
147
+ // field is populated.
148
+ // * Otherwise, index_status is unset.
149
+ IndexStatus index_status = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
130
150
  }
@@ -123,5 +123,7 @@ message DocumentProcessingConfig {
123
123
  // layout parsing are supported.
124
124
  // * `pptx`: Override parsing config for PPTX files, only digital parsing and
125
125
  // layout parsing are supported.
126
+ // * `xlsx`: Override parsing config for XLSX files, only digital parsing and
127
+ // layout parsing are supported.
126
128
  map<string, ParsingConfig> parsing_config_overrides = 5;
127
129
  }
@@ -26,6 +26,7 @@ import "google/cloud/discoveryengine/v1beta/purge_config.proto";
26
26
  import "google/longrunning/operations.proto";
27
27
  import "google/protobuf/empty.proto";
28
28
  import "google/protobuf/field_mask.proto";
29
+ import "google/protobuf/timestamp.proto";
29
30
 
30
31
  option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
31
32
  option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
@@ -158,6 +159,20 @@ service DocumentService {
158
159
  metadata_type: "google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata"
159
160
  };
160
161
  }
162
+
163
+ // Gets index freshness metadata for
164
+ // [Document][google.cloud.discoveryengine.v1beta.Document]s. Supported for
165
+ // website search only.
166
+ rpc BatchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest)
167
+ returns (BatchGetDocumentsMetadataResponse) {
168
+ option (google.api.http) = {
169
+ get: "/v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/batchGetDocumentsMetadata"
170
+ additional_bindings {
171
+ get: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/batchGetDocumentsMetadata"
172
+ }
173
+ };
174
+ option (google.api.method_signature) = "parent";
175
+ }
161
176
  }
162
177
 
163
178
  // Request message for
@@ -320,3 +335,102 @@ message DeleteDocumentRequest {
320
335
  }
321
336
  ];
322
337
  }
338
+
339
+ // Request message for
340
+ // [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata]
341
+ // method.
342
+ message BatchGetDocumentsMetadataRequest {
343
+ // Matcher for the [Document][google.cloud.discoveryengine.v1beta.Document]s
344
+ // by exact uris.
345
+ message UrisMatcher {
346
+ // The exact URIs to match by.
347
+ repeated string uris = 1;
348
+ }
349
+
350
+ // Matcher for the [Document][google.cloud.discoveryengine.v1beta.Document]s.
351
+ // Currently supports matching by exact URIs.
352
+ message Matcher {
353
+ // Matcher for the
354
+ // [Document][google.cloud.discoveryengine.v1beta.Document]s.
355
+ oneof matcher {
356
+ // Matcher by exact URIs.
357
+ UrisMatcher uris_matcher = 1;
358
+ }
359
+ }
360
+
361
+ // Required. The parent branch resource name, such as
362
+ // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
363
+ string parent = 1 [
364
+ (google.api.field_behavior) = REQUIRED,
365
+ (google.api.resource_reference) = {
366
+ type: "discoveryengine.googleapis.com/Branch"
367
+ }
368
+ ];
369
+
370
+ // Required. Matcher for the
371
+ // [Document][google.cloud.discoveryengine.v1beta.Document]s.
372
+ Matcher matcher = 2 [(google.api.field_behavior) = REQUIRED];
373
+ }
374
+
375
+ // Response message for
376
+ // [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata]
377
+ // method.
378
+ message BatchGetDocumentsMetadataResponse {
379
+ // The metadata of a [Document][google.cloud.discoveryengine.v1beta.Document].
380
+ message DocumentMetadata {
381
+ // The value of the matcher that was used to match the
382
+ // [Document][google.cloud.discoveryengine.v1beta.Document].
383
+ message MatcherValue {
384
+ // The value of the matcher that was used to match the
385
+ // [Document][google.cloud.discoveryengine.v1beta.Document].
386
+ oneof matcher_value {
387
+ // If match by URI, the URI of the
388
+ // [Document][google.cloud.discoveryengine.v1beta.Document].
389
+ string uri = 1;
390
+ }
391
+ }
392
+
393
+ // The value of the matcher that was used to match the
394
+ // [Document][google.cloud.discoveryengine.v1beta.Document].
395
+ MatcherValue matcher_value = 2;
396
+
397
+ // The state of the document.
398
+ State state = 3;
399
+
400
+ // The timestamp of the last time the
401
+ // [Document][google.cloud.discoveryengine.v1beta.Document] was last
402
+ // indexed.
403
+ google.protobuf.Timestamp last_refreshed_time = 4;
404
+
405
+ // The data ingestion source of the
406
+ // [Document][google.cloud.discoveryengine.v1beta.Document].
407
+ //
408
+ // Allowed values are:
409
+ //
410
+ // * `batch`: Data ingested via Batch API, e.g., ImportDocuments.
411
+ // * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.
412
+ string data_ingestion_source = 5;
413
+ }
414
+
415
+ // The state of the [Document][google.cloud.discoveryengine.v1beta.Document].
416
+ enum State {
417
+ // Should never be set.
418
+ STATE_UNSPECIFIED = 0;
419
+
420
+ // The [Document][google.cloud.discoveryengine.v1beta.Document] is indexed.
421
+ INDEXED = 1;
422
+
423
+ // The [Document][google.cloud.discoveryengine.v1beta.Document] is not
424
+ // indexed because its URI is not in the
425
+ // [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
426
+ NOT_IN_TARGET_SITE = 2;
427
+
428
+ // The [Document][google.cloud.discoveryengine.v1beta.Document] is not
429
+ // indexed.
430
+ NOT_IN_INDEX = 3;
431
+ }
432
+
433
+ // The metadata of the
434
+ // [Document][google.cloud.discoveryengine.v1beta.Document]s.
435
+ repeated DocumentMetadata documents_metadata = 1;
436
+ }
@@ -129,8 +129,9 @@ message CheckGroundingResponse {
129
129
  // field will be set to false. In that case, no grounding check was done for
130
130
  // the claim and therefore
131
131
  // [citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.citation_indices],
132
+ // [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices],
132
133
  // and
133
- // [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices]
134
+ // [score][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.score]
134
135
  // should not be returned.
135
136
  optional bool grounding_check_required = 6;
136
137
  }
@@ -84,7 +84,7 @@ message BigQuerySource {
84
84
  google.type.Date partition_date = 5;
85
85
  }
86
86
 
87
- // The project ID (can be project # or ID) that the BigQuery source is in with
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;
@@ -126,7 +126,7 @@ message BigQuerySource {
126
126
 
127
127
  // The Spanner source for importing data
128
128
  message SpannerSource {
129
- // The project ID that the Spanner source is in with a length limit of 128
129
+ // The project ID that contains the Spanner source. Has a length limit of 128
130
130
  // characters. If not specified, inherits the project ID from the parent
131
131
  // request.
132
132
  string project_id = 1;
@@ -260,7 +260,7 @@ message BigtableOptions {
260
260
 
261
261
  // The Cloud Bigtable source for importing data.
262
262
  message BigtableSource {
263
- // The project ID that the Bigtable source is in with a length limit of 128
263
+ // The project ID that contains the Bigtable source. Has a length limit of 128
264
264
  // characters. If not specified, inherits the project ID from the parent
265
265
  // request.
266
266
  string project_id = 1;
@@ -292,12 +292,18 @@ message FhirStoreSource {
292
292
  // limit of 2,000 characters. Can be specified if one wants to have the
293
293
  // FhirStore export to a specific Cloud Storage directory.
294
294
  string gcs_staging_dir = 2;
295
+
296
+ // The FHIR resource types to import. The resource types should be a subset of
297
+ // all [supported FHIR resource
298
+ // types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification).
299
+ // Default to all supported FHIR resource types if empty.
300
+ repeated string resource_types = 3;
295
301
  }
296
302
 
297
303
  // Cloud SQL source import data from.
298
304
  message CloudSqlSource {
299
- // The project ID that the Cloud SQL source is in with a length limit of 128
300
- // characters. If not specified, inherits the project ID from the parent
305
+ // The project ID that contains the Cloud SQL source. Has a length limit of
306
+ // 128 characters. If not specified, inherits the project ID from the parent
301
307
  // request.
302
308
  string project_id = 1;
303
309
 
@@ -329,8 +335,8 @@ message CloudSqlSource {
329
335
 
330
336
  // AlloyDB source import data from.
331
337
  message AlloyDbSource {
332
- // The project ID that the AlloyDB source is in
333
- // with a length limit of 128 characters. If not specified, inherits the
338
+ // The project ID that contains the AlloyDB source.
339
+ // Has a length limit of 128 characters. If not specified, inherits the
334
340
  // project ID from the parent request.
335
341
  string project_id = 1;
336
342