@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.
Files changed (121) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +10 -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 +61 -2
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +1 -1
  22. package/build/protos/google/cloud/discoveryengine/v1alpha/completion.proto +31 -0
  23. package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +38 -0
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/control.proto +1 -1
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +28 -9
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/custom_tuning_model.proto +10 -1
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +71 -0
  28. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +11 -1
  29. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +24 -1
  30. package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +6 -2
  31. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +108 -1
  32. package/build/protos/google/cloud/discoveryengine/v1alpha/grounded_generation_service.proto +2 -1
  33. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +119 -5
  34. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +58 -1
  35. package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +5 -0
  36. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +428 -12
  37. package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config.proto +14 -5
  38. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +126 -0
  39. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +4 -0
  40. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +3 -0
  41. package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +47 -2
  42. package/build/protos/google/cloud/discoveryengine/v1beta/control.proto +1 -1
  43. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +3 -0
  44. package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto +3 -0
  45. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +20 -0
  46. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +2 -0
  47. package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +114 -0
  48. package/build/protos/google/cloud/discoveryengine/v1beta/grounded_generation_service.proto +2 -1
  49. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +13 -7
  50. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +44 -0
  51. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +101 -6
  52. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -0
  53. package/build/protos/protos.d.ts +24137 -16126
  54. package/build/protos/protos.js +78286 -58223
  55. package/build/protos/protos.json +1954 -105
  56. package/build/src/index.d.ts +4 -1
  57. package/build/src/index.js +4 -1
  58. package/build/src/v1/completion_service_client.d.ts +93 -0
  59. package/build/src/v1/completion_service_client.js +134 -0
  60. package/build/src/v1/control_service_client.d.ts +93 -0
  61. package/build/src/v1/control_service_client.js +128 -0
  62. package/build/src/v1/conversational_search_service_client.d.ts +93 -0
  63. package/build/src/v1/conversational_search_service_client.js +128 -0
  64. package/build/src/v1/data_store_service_client.d.ts +102 -0
  65. package/build/src/v1/data_store_service_client.js +134 -0
  66. package/build/src/v1/document_service_client.d.ts +131 -0
  67. package/build/src/v1/document_service_client.js +156 -0
  68. package/build/src/v1/document_service_client_config.json +5 -0
  69. package/build/src/v1/engine_service_client.d.ts +93 -0
  70. package/build/src/v1/engine_service_client.js +134 -0
  71. package/build/src/v1/grounded_generation_service_client.d.ts +93 -0
  72. package/build/src/v1/grounded_generation_service_client.js +128 -0
  73. package/build/src/v1/index.d.ts +1 -0
  74. package/build/src/v1/index.js +3 -1
  75. package/build/src/v1/project_service_client.d.ts +93 -0
  76. package/build/src/v1/project_service_client.js +134 -0
  77. package/build/src/v1/rank_service_client.d.ts +93 -0
  78. package/build/src/v1/rank_service_client.js +128 -0
  79. package/build/src/v1/recommendation_service_client.d.ts +95 -1
  80. package/build/src/v1/recommendation_service_client.js +128 -0
  81. package/build/src/v1/schema_service_client.d.ts +93 -0
  82. package/build/src/v1/schema_service_client.js +134 -0
  83. package/build/src/v1/search_service_client.d.ts +111 -9
  84. package/build/src/v1/search_service_client.js +140 -6
  85. package/build/src/v1/search_tuning_service_client.d.ts +1776 -0
  86. package/build/src/v1/search_tuning_service_client.js +2589 -0
  87. package/build/src/v1/search_tuning_service_client_config.json +34 -0
  88. package/build/src/v1/site_search_engine_service_client.d.ts +93 -0
  89. package/build/src/v1/site_search_engine_service_client.js +134 -0
  90. package/build/src/v1/user_event_service_client.d.ts +168 -0
  91. package/build/src/v1/user_event_service_client.js +176 -0
  92. package/build/src/v1/user_event_service_client_config.json +5 -0
  93. package/build/src/v1alpha/acl_config_service_client.d.ts +1 -1
  94. package/build/src/v1alpha/completion_service_client.d.ts +91 -0
  95. package/build/src/v1alpha/completion_service_client.js +90 -0
  96. package/build/src/v1alpha/completion_service_client_config.json +10 -0
  97. package/build/src/v1alpha/conversational_search_service_client.d.ts +18 -0
  98. package/build/src/v1alpha/data_store_service_client.d.ts +12 -3
  99. package/build/src/v1alpha/data_store_service_client.js +8 -2
  100. package/build/src/v1alpha/document_service_client.d.ts +33 -0
  101. package/build/src/v1alpha/document_service_client.js +28 -0
  102. package/build/src/v1alpha/document_service_client_config.json +5 -0
  103. package/build/src/v1alpha/engine_service_client.js +6 -0
  104. package/build/src/v1alpha/estimate_billing_service_client.js +6 -0
  105. package/build/src/v1alpha/evaluation_service_client.js +6 -0
  106. package/build/src/v1alpha/project_service_client.js +6 -0
  107. package/build/src/v1alpha/sample_query_service_client.js +6 -0
  108. package/build/src/v1alpha/schema_service_client.js +6 -0
  109. package/build/src/v1alpha/search_service_client.d.ts +219 -21
  110. package/build/src/v1alpha/search_service_client.js +146 -14
  111. package/build/src/v1alpha/search_tuning_service_client.js +6 -0
  112. package/build/src/v1alpha/site_search_engine_service_client.d.ts +101 -0
  113. package/build/src/v1alpha/site_search_engine_service_client.js +70 -0
  114. package/build/src/v1alpha/site_search_engine_service_client_config.json +8 -0
  115. package/build/src/v1alpha/user_event_service_client.js +6 -0
  116. package/build/src/v1beta/document_service_client.d.ts +38 -0
  117. package/build/src/v1beta/document_service_client.js +22 -0
  118. package/build/src/v1beta/document_service_client_config.json +5 -0
  119. package/build/src/v1beta/search_service_client.d.ts +36 -9
  120. package/build/src/v1beta/search_service_client.js +24 -6
  121. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.14.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.13.0...discoveryengine-v1.14.0) (2024-09-10)
4
+
5
+
6
+ ### Features
7
+
8
+ * [discoveryengine] promote search tuning service to v1 ([#5655](https://github.com/googleapis/google-cloud-node/issues/5655)) ([f4072a0](https://github.com/googleapis/google-cloud-node/commit/f4072a051e85b1fd42116416f19e850bb32fc542))
9
+
10
+ ## [1.13.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.12.0...discoveryengine-v1.13.0) (2024-08-19)
11
+
12
+
13
+ ### Features
14
+
15
+ * [discoveryengine] support natural language understanding in search ([#5596](https://github.com/googleapis/google-cloud-node/issues/5596)) ([5cf8d9e](https://github.com/googleapis/google-cloud-node/commit/5cf8d9e6be7c9f95910185062817379a2e29ffdc))
16
+
3
17
  ## [1.12.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.11.0...discoveryengine-v1.12.0) (2024-08-09)
4
18
 
5
19
 
package/README.md CHANGED
@@ -153,6 +153,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
153
153
  | Data_store_service.get_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/data_store_service.get_data_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/data_store_service.get_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
154
154
  | Data_store_service.list_data_stores | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/data_store_service.list_data_stores.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/data_store_service.list_data_stores.js,packages/google-cloud-discoveryengine/samples/README.md) |
155
155
  | Data_store_service.update_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/data_store_service.update_data_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/data_store_service.update_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
156
+ | Document_service.batch_get_documents_metadata | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/document_service.batch_get_documents_metadata.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/document_service.batch_get_documents_metadata.js,packages/google-cloud-discoveryengine/samples/README.md) |
156
157
  | Document_service.create_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/document_service.create_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/document_service.create_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
157
158
  | Document_service.delete_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/document_service.delete_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/document_service.delete_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
158
159
  | Document_service.get_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/document_service.get_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/document_service.get_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -175,6 +176,8 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
175
176
  | Schema_service.list_schemas | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/schema_service.list_schemas.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/schema_service.list_schemas.js,packages/google-cloud-discoveryengine/samples/README.md) |
176
177
  | Schema_service.update_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/schema_service.update_schema.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/schema_service.update_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
177
178
  | Search_service.search | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/search_service.search.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/search_service.search.js,packages/google-cloud-discoveryengine/samples/README.md) |
179
+ | Search_tuning_service.list_custom_models | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/search_tuning_service.list_custom_models.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/search_tuning_service.list_custom_models.js,packages/google-cloud-discoveryengine/samples/README.md) |
180
+ | Search_tuning_service.train_custom_model | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/search_tuning_service.train_custom_model.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/search_tuning_service.train_custom_model.js,packages/google-cloud-discoveryengine/samples/README.md) |
178
181
  | Site_search_engine_service.batch_create_target_sites | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/site_search_engine_service.batch_create_target_sites.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/site_search_engine_service.batch_create_target_sites.js,packages/google-cloud-discoveryengine/samples/README.md) |
179
182
  | Site_search_engine_service.batch_verify_target_sites | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/site_search_engine_service.batch_verify_target_sites.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/site_search_engine_service.batch_verify_target_sites.js,packages/google-cloud-discoveryengine/samples/README.md) |
180
183
  | Site_search_engine_service.create_target_site | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/site_search_engine_service.create_target_site.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/site_search_engine_service.create_target_site.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -189,13 +192,16 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
189
192
  | Site_search_engine_service.update_target_site | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/site_search_engine_service.update_target_site.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/site_search_engine_service.update_target_site.js,packages/google-cloud-discoveryengine/samples/README.md) |
190
193
  | User_event_service.collect_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/user_event_service.collect_user_event.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/user_event_service.collect_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
191
194
  | User_event_service.import_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/user_event_service.import_user_events.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/user_event_service.import_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |
195
+ | User_event_service.purge_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/user_event_service.purge_user_events.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/user_event_service.purge_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |
192
196
  | User_event_service.write_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/user_event_service.write_user_event.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/user_event_service.write_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
193
197
  | Acl_config_service.get_acl_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/acl_config_service.get_acl_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/acl_config_service.get_acl_config.js,packages/google-cloud-discoveryengine/samples/README.md) |
194
198
  | Acl_config_service.update_acl_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/acl_config_service.update_acl_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/acl_config_service.update_acl_config.js,packages/google-cloud-discoveryengine/samples/README.md) |
195
199
  | Chunk_service.get_chunk | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/chunk_service.get_chunk.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/chunk_service.get_chunk.js,packages/google-cloud-discoveryengine/samples/README.md) |
196
200
  | Chunk_service.list_chunks | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/chunk_service.list_chunks.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/chunk_service.list_chunks.js,packages/google-cloud-discoveryengine/samples/README.md) |
197
201
  | Completion_service.complete_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.complete_query.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.complete_query.js,packages/google-cloud-discoveryengine/samples/README.md) |
202
+ | Completion_service.import_completion_suggestions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.import_completion_suggestions.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.import_completion_suggestions.js,packages/google-cloud-discoveryengine/samples/README.md) |
198
203
  | Completion_service.import_suggestion_deny_list_entries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.import_suggestion_deny_list_entries.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.import_suggestion_deny_list_entries.js,packages/google-cloud-discoveryengine/samples/README.md) |
204
+ | Completion_service.purge_completion_suggestions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.purge_completion_suggestions.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.purge_completion_suggestions.js,packages/google-cloud-discoveryengine/samples/README.md) |
199
205
  | Completion_service.purge_suggestion_deny_list_entries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.purge_suggestion_deny_list_entries.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.purge_suggestion_deny_list_entries.js,packages/google-cloud-discoveryengine/samples/README.md) |
200
206
  | Control_service.create_control | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/control_service.create_control.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/control_service.create_control.js,packages/google-cloud-discoveryengine/samples/README.md) |
201
207
  | Control_service.delete_control | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/control_service.delete_control.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/control_service.delete_control.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -222,6 +228,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
222
228
  | Data_store_service.list_data_stores | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.list_data_stores.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.list_data_stores.js,packages/google-cloud-discoveryengine/samples/README.md) |
223
229
  | Data_store_service.update_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.update_data_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.update_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
224
230
  | Data_store_service.update_document_processing_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.update_document_processing_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.update_document_processing_config.js,packages/google-cloud-discoveryengine/samples/README.md) |
231
+ | Document_service.batch_get_documents_metadata | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.batch_get_documents_metadata.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.batch_get_documents_metadata.js,packages/google-cloud-discoveryengine/samples/README.md) |
225
232
  | Document_service.create_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.create_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.create_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
226
233
  | Document_service.delete_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.delete_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.delete_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
227
234
  | Document_service.get_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.get_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.get_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -280,8 +287,10 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
280
287
  | Site_search_engine_service.fetch_domain_verification_status | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.fetch_domain_verification_status.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.fetch_domain_verification_status.js,packages/google-cloud-discoveryengine/samples/README.md) |
281
288
  | Site_search_engine_service.get_site_search_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_site_search_engine.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_site_search_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
282
289
  | Site_search_engine_service.get_target_site | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_target_site.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_target_site.js,packages/google-cloud-discoveryengine/samples/README.md) |
290
+ | Site_search_engine_service.get_uri_pattern_document_data | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_uri_pattern_document_data.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_uri_pattern_document_data.js,packages/google-cloud-discoveryengine/samples/README.md) |
283
291
  | Site_search_engine_service.list_target_sites | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.list_target_sites.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.list_target_sites.js,packages/google-cloud-discoveryengine/samples/README.md) |
284
292
  | Site_search_engine_service.recrawl_uris | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.recrawl_uris.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.recrawl_uris.js,packages/google-cloud-discoveryengine/samples/README.md) |
293
+ | Site_search_engine_service.set_uri_pattern_document_data | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.set_uri_pattern_document_data.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.set_uri_pattern_document_data.js,packages/google-cloud-discoveryengine/samples/README.md) |
285
294
  | Site_search_engine_service.update_target_site | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.update_target_site.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.update_target_site.js,packages/google-cloud-discoveryengine/samples/README.md) |
286
295
  | User_event_service.collect_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.collect_user_event.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.collect_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
287
296
  | User_event_service.import_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.import_user_events.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.import_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -315,6 +324,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
315
324
  | Data_store_service.get_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/data_store_service.get_data_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/data_store_service.get_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
316
325
  | Data_store_service.list_data_stores | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/data_store_service.list_data_stores.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/data_store_service.list_data_stores.js,packages/google-cloud-discoveryengine/samples/README.md) |
317
326
  | Data_store_service.update_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/data_store_service.update_data_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/data_store_service.update_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
327
+ | Document_service.batch_get_documents_metadata | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.batch_get_documents_metadata.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.batch_get_documents_metadata.js,packages/google-cloud-discoveryengine/samples/README.md) |
318
328
  | Document_service.create_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.create_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.create_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
319
329
  | Document_service.delete_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.delete_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.delete_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
320
330
  | Document_service.get_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.get_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.get_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -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
 
@@ -191,9 +220,8 @@ message Answer {
191
220
 
192
221
  // Data representation.
193
222
  // The structured JSON data for the document.
194
- // It's populated from the struct data from the Document (code
195
- // pointer: http://shortn/_objzAfIiHq), or the Chunk in search result
196
- // (code pointer: http://shortn/_Ipo6KFFGBL).
223
+ // It's populated from the struct data from the Document, or the
224
+ // Chunk in search result.
197
225
  google.protobuf.Struct struct_data = 6;
198
226
  }
199
227
 
@@ -254,6 +282,9 @@ message Answer {
254
282
 
255
283
  // Non-answer-seeking query classification type.
256
284
  NON_ANSWER_SEEKING_QUERY = 2;
285
+
286
+ // Jail-breaking query classification type.
287
+ JAIL_BREAKING_QUERY = 3;
257
288
  }
258
289
 
259
290
  // Query classification type.
@@ -309,6 +340,19 @@ message Answer {
309
340
  // Google skips the answer if there is no relevant content in the
310
341
  // retrieved search results.
311
342
  NO_RELEVANT_CONTENT = 5;
343
+
344
+ // The jail-breaking query ignored case.
345
+ //
346
+ // For example, "Reply in the tone of a competing company's CEO".
347
+ // Google skips the answer if the query is classified as a jail-breaking
348
+ // query.
349
+ JAIL_BREAKING_QUERY_IGNORED = 6;
350
+
351
+ // The customer policy violation case.
352
+ //
353
+ // Google skips the summary if there is a customer policy violation
354
+ // detected. The policy is defined by the customer.
355
+ CUSTOMER_POLICY_VIOLATION = 7;
312
356
  }
313
357
 
314
358
  // Immutable. Fully qualified name
@@ -73,8 +73,9 @@ message Condition {
73
73
  }
74
74
 
75
75
  // Defines a conditioned behavior to employ during serving.
76
- // Must be attached to a [ServingConfig][] to be considered at serving time.
77
- // Permitted actions dependent on `SolutionType`.
76
+ // Must be attached to a
77
+ // [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] to be
78
+ // considered at serving time. Permitted actions dependent on `SolutionType`.
78
79
  message Control {
79
80
  option (google.api.resource) = {
80
81
  type: "discoveryengine.googleapis.com/Control"
@@ -182,8 +183,9 @@ message Control {
182
183
  // Otherwise an INVALID ARGUMENT error is thrown.
183
184
  string display_name = 2 [(google.api.field_behavior) = REQUIRED];
184
185
 
185
- // Output only. List of all [ServingConfig][] ids this control is attached to.
186
- // May take up to 10 minutes to update after changes.
186
+ // Output only. List of all
187
+ // [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] IDs this
188
+ // control is attached to. May take up to 10 minutes to update after changes.
187
189
  repeated string associated_serving_config_ids = 3
188
190
  [(google.api.field_behavior) = OUTPUT_ONLY];
189
191
 
@@ -584,12 +584,7 @@ message AnswerQueryRequest {
584
584
  string order_by = 4;
585
585
 
586
586
  // Specifies the search result mode. If unspecified, the
587
- // search result mode is based on
588
- // [DataStore.DocumentProcessingConfig.chunking_config][]:
589
- // * If [DataStore.DocumentProcessingConfig.chunking_config][] is
590
- // specified,
591
- // it defaults to `CHUNKS`.
592
- // * Otherwise, it defaults to `DOCUMENTS`.
587
+ // search result mode defaults to `DOCUMENTS`.
593
588
  // See [parse and chunk
594
589
  // documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
595
590
  SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 5;
@@ -707,6 +702,9 @@ message AnswerQueryRequest {
707
702
 
708
703
  // Non-answer-seeking query classification type.
709
704
  NON_ANSWER_SEEKING_QUERY = 2;
705
+
706
+ // Jail-breaking query classification type.
707
+ JAIL_BREAKING_QUERY = 3;
710
708
  }
711
709
 
712
710
  // Enabled query classification types.
@@ -819,9 +817,11 @@ message AnswerQueryRequest {
819
817
  // method.
820
818
  message AnswerQueryResponse {
821
819
  // Answer resource object.
822
- // If [AnswerQueryRequest.StepSpec.max_step_count][] is greater than 1,
823
- // use [Answer.name][google.cloud.discoveryengine.v1.Answer.name] to fetch
824
- // answer information using
820
+ // If
821
+ // [AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps][google.cloud.discoveryengine.v1.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps]
822
+ // is greater than 1, use
823
+ // [Answer.name][google.cloud.discoveryengine.v1.Answer.name] to fetch answer
824
+ // information using
825
825
  // [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1.ConversationalSearchService.GetAnswer]
826
826
  // API.
827
827
  Answer answer = 1;
@@ -0,0 +1,96 @@
1
+ // Copyright 2024 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/field_behavior.proto";
20
+ import "google/api/resource.proto";
21
+ import "google/protobuf/timestamp.proto";
22
+
23
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
24
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
25
+ option java_multiple_files = true;
26
+ option java_outer_classname = "CustomTuningModelProto";
27
+ option java_package = "com.google.cloud.discoveryengine.v1";
28
+ option objc_class_prefix = "DISCOVERYENGINE";
29
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
30
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
31
+
32
+ // Metadata that describes a custom tuned model.
33
+ message CustomTuningModel {
34
+ option (google.api.resource) = {
35
+ type: "discoveryengine.googleapis.com/CustomTuningModel"
36
+ pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}"
37
+ pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}"
38
+ };
39
+
40
+ // The state of the model.
41
+ enum ModelState {
42
+ // Default value.
43
+ MODEL_STATE_UNSPECIFIED = 0;
44
+
45
+ // The model is in a paused training state.
46
+ TRAINING_PAUSED = 1;
47
+
48
+ // The model is currently training.
49
+ TRAINING = 2;
50
+
51
+ // The model has successfully completed training.
52
+ TRAINING_COMPLETE = 3;
53
+
54
+ // The model is ready for serving.
55
+ READY_FOR_SERVING = 4;
56
+
57
+ // The model training failed.
58
+ TRAINING_FAILED = 5;
59
+
60
+ // The model training finished successfully but metrics did not improve.
61
+ NO_IMPROVEMENT = 6;
62
+
63
+ // Input data validation failed. Model training didn't start.
64
+ INPUT_VALIDATION_FAILED = 7;
65
+ }
66
+
67
+ // Required. The fully qualified resource name of the model.
68
+ //
69
+ // Format:
70
+ // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`
71
+ // model must be an alpha-numerical string with limit of 40 characters.
72
+ string name = 1 [
73
+ (google.api.field_behavior) = REQUIRED,
74
+ (google.api.resource_reference) = {
75
+ type: "discoveryengine.googleapis.com/CustomTuningModel"
76
+ }
77
+ ];
78
+
79
+ // The display name of the model.
80
+ string display_name = 2;
81
+
82
+ // The version of the model.
83
+ int64 model_version = 3;
84
+
85
+ // The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
86
+ ModelState model_state = 4;
87
+
88
+ // Deprecated: timestamp the Model was created at.
89
+ google.protobuf.Timestamp create_time = 5 [deprecated = true];
90
+
91
+ // Timestamp the model training was initiated.
92
+ google.protobuf.Timestamp training_start_time = 6;
93
+
94
+ // The metrics of the trained model.
95
+ map<string, double> metrics = 7;
96
+ }
@@ -152,6 +152,16 @@ message CreateDataStoreRequest {
152
152
  // search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
153
153
  // be ignored.
154
154
  bool create_advanced_site_search = 4;
155
+
156
+ // A boolean flag indicating whether to skip the default schema creation for
157
+ // the data store. Only enable this flag if you are certain that the default
158
+ // schema is incompatible with your use case.
159
+ //
160
+ // If set to true, you must manually create a schema for the data store before
161
+ // any documents can be ingested.
162
+ //
163
+ // This flag cannot be specified if `data_store.starting_schema` is specified.
164
+ bool skip_default_schema_creation = 7;
155
165
  }
156
166
 
157
167
  // Request message for
@@ -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.V1";
25
26
  option go_package = "cloud.google.com/go/discoveryengine/apiv1/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.v1.Document.struct_data] or
75
87
  // [json_data][google.cloud.discoveryengine.v1.Document.json_data] should be
@@ -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/v1/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.V1";
31
32
  option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
@@ -156,6 +157,20 @@ service DocumentService {
156
157
  metadata_type: "google.cloud.discoveryengine.v1.PurgeDocumentsMetadata"
157
158
  };
158
159
  }
160
+
161
+ // Gets index freshness metadata for
162
+ // [Document][google.cloud.discoveryengine.v1.Document]s. Supported for
163
+ // website search only.
164
+ rpc BatchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest)
165
+ returns (BatchGetDocumentsMetadataResponse) {
166
+ option (google.api.http) = {
167
+ get: "/v1/{parent=projects/*/locations/*/dataStores/*/branches/*}/batchGetDocumentsMetadata"
168
+ additional_bindings {
169
+ get: "/v1/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/batchGetDocumentsMetadata"
170
+ }
171
+ };
172
+ option (google.api.method_signature) = "parent";
173
+ }
159
174
  }
160
175
 
161
176
  // Request message for
@@ -318,3 +333,98 @@ message DeleteDocumentRequest {
318
333
  }
319
334
  ];
320
335
  }
336
+
337
+ // Request message for
338
+ // [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1.DocumentService.BatchGetDocumentsMetadata]
339
+ // method.
340
+ message BatchGetDocumentsMetadataRequest {
341
+ // Matcher for the [Document][google.cloud.discoveryengine.v1.Document]s by
342
+ // exact uris.
343
+ message UrisMatcher {
344
+ // The exact URIs to match by.
345
+ repeated string uris = 1;
346
+ }
347
+
348
+ // Matcher for the [Document][google.cloud.discoveryengine.v1.Document]s.
349
+ // Currently supports matching by exact URIs.
350
+ message Matcher {
351
+ // Matcher for the [Document][google.cloud.discoveryengine.v1.Document]s.
352
+ oneof matcher {
353
+ // Matcher by exact URIs.
354
+ UrisMatcher uris_matcher = 1;
355
+ }
356
+ }
357
+
358
+ // Required. The parent branch resource name, such as
359
+ // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
360
+ string parent = 1 [
361
+ (google.api.field_behavior) = REQUIRED,
362
+ (google.api.resource_reference) = {
363
+ type: "discoveryengine.googleapis.com/Branch"
364
+ }
365
+ ];
366
+
367
+ // Required. Matcher for the
368
+ // [Document][google.cloud.discoveryengine.v1.Document]s.
369
+ Matcher matcher = 2 [(google.api.field_behavior) = REQUIRED];
370
+ }
371
+
372
+ // Response message for
373
+ // [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1.DocumentService.BatchGetDocumentsMetadata]
374
+ // method.
375
+ message BatchGetDocumentsMetadataResponse {
376
+ // The metadata of a [Document][google.cloud.discoveryengine.v1.Document].
377
+ message DocumentMetadata {
378
+ // The value of the matcher that was used to match the
379
+ // [Document][google.cloud.discoveryengine.v1.Document].
380
+ message MatcherValue {
381
+ // The value of the matcher that was used to match the
382
+ // [Document][google.cloud.discoveryengine.v1.Document].
383
+ oneof matcher_value {
384
+ // If match by URI, the URI of the
385
+ // [Document][google.cloud.discoveryengine.v1.Document].
386
+ string uri = 1;
387
+ }
388
+ }
389
+
390
+ // The value of the matcher that was used to match the
391
+ // [Document][google.cloud.discoveryengine.v1.Document].
392
+ MatcherValue matcher_value = 2;
393
+
394
+ // The state of the document.
395
+ State state = 3;
396
+
397
+ // The timestamp of the last time the
398
+ // [Document][google.cloud.discoveryengine.v1.Document] was last indexed.
399
+ google.protobuf.Timestamp last_refreshed_time = 4;
400
+
401
+ // The data ingestion source of the
402
+ // [Document][google.cloud.discoveryengine.v1.Document].
403
+ //
404
+ // Allowed values are:
405
+ //
406
+ // * `batch`: Data ingested via Batch API, e.g., ImportDocuments.
407
+ // * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.
408
+ string data_ingestion_source = 5;
409
+ }
410
+
411
+ // The state of the [Document][google.cloud.discoveryengine.v1.Document].
412
+ enum State {
413
+ // Should never be set.
414
+ STATE_UNSPECIFIED = 0;
415
+
416
+ // The [Document][google.cloud.discoveryengine.v1.Document] is indexed.
417
+ INDEXED = 1;
418
+
419
+ // The [Document][google.cloud.discoveryengine.v1.Document] is not indexed
420
+ // because its URI is not in the
421
+ // [TargetSite][google.cloud.discoveryengine.v1.TargetSite].
422
+ NOT_IN_TARGET_SITE = 2;
423
+
424
+ // The [Document][google.cloud.discoveryengine.v1.Document] is not indexed.
425
+ NOT_IN_INDEX = 3;
426
+ }
427
+
428
+ // The metadata of the [Document][google.cloud.discoveryengine.v1.Document]s.
429
+ repeated DocumentMetadata documents_metadata = 1;
430
+ }
@@ -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.v1.CheckGroundingResponse.Claim.citation_indices],
132
+ // [anti_citation_indices][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.anti_citation_indices],
132
133
  // and
133
- // [anti_citation_indices][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.anti_citation_indices]
134
+ // [score][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.score]
134
135
  // should not be returned.
135
136
  optional bool grounding_check_required = 6;
136
137
  }