@google-cloud/discoveryengine 1.10.0 → 1.12.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 (129) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +33 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/evaluation.proto +232 -0
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/evaluation_service.proto +252 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +83 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query.proto +86 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_service.proto +264 -0
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_set.proto +64 -0
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_set_service.proto +258 -0
  10. package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +14 -0
  11. package/build/protos/google/cloud/discoveryengine/v1beta/chunk.proto +119 -0
  12. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +0 -5
  13. package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +31 -0
  14. package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +38 -0
  15. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +29 -2
  16. package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto +7 -1
  17. package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +23 -0
  18. package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +10 -0
  19. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
  20. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +37 -2
  21. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation.proto +231 -0
  22. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation_service.proto +252 -0
  23. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +191 -0
  24. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +111 -0
  25. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query.proto +86 -0
  26. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_service.proto +264 -0
  27. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set.proto +64 -0
  28. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set_service.proto +256 -0
  29. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +370 -8
  30. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +11 -5
  31. package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +24 -0
  32. package/build/protos/protos.d.ts +32735 -21073
  33. package/build/protos/protos.js +80768 -53241
  34. package/build/protos/protos.json +5309 -2481
  35. package/build/src/v1alpha/acl_config_service_client.d.ts +108 -0
  36. package/build/src/v1alpha/acl_config_service_client.js +157 -0
  37. package/build/src/v1alpha/chunk_service_client.d.ts +108 -0
  38. package/build/src/v1alpha/chunk_service_client.js +157 -0
  39. package/build/src/v1alpha/completion_service_client.d.ts +108 -0
  40. package/build/src/v1alpha/completion_service_client.js +157 -0
  41. package/build/src/v1alpha/control_service_client.d.ts +108 -0
  42. package/build/src/v1alpha/control_service_client.js +157 -0
  43. package/build/src/v1alpha/conversational_search_service_client.d.ts +108 -0
  44. package/build/src/v1alpha/conversational_search_service_client.js +157 -0
  45. package/build/src/v1alpha/data_store_service_client.d.ts +108 -0
  46. package/build/src/v1alpha/data_store_service_client.js +157 -0
  47. package/build/src/v1alpha/document_service_client.d.ts +108 -0
  48. package/build/src/v1alpha/document_service_client.js +157 -0
  49. package/build/src/v1alpha/engine_service_client.d.ts +108 -0
  50. package/build/src/v1alpha/engine_service_client.js +157 -0
  51. package/build/src/v1alpha/estimate_billing_service_client.d.ts +108 -0
  52. package/build/src/v1alpha/estimate_billing_service_client.js +157 -0
  53. package/build/src/v1alpha/evaluation_service_client.d.ts +2349 -0
  54. package/build/src/v1alpha/evaluation_service_client.js +3288 -0
  55. package/build/src/v1alpha/evaluation_service_client_config.json +58 -0
  56. package/build/src/v1alpha/grounded_generation_service_client.d.ts +108 -0
  57. package/build/src/v1alpha/grounded_generation_service_client.js +157 -0
  58. package/build/src/v1alpha/index.d.ts +3 -0
  59. package/build/src/v1alpha/index.js +7 -1
  60. package/build/src/v1alpha/project_service_client.d.ts +108 -0
  61. package/build/src/v1alpha/project_service_client.js +157 -0
  62. package/build/src/v1alpha/rank_service_client.d.ts +108 -0
  63. package/build/src/v1alpha/rank_service_client.js +157 -0
  64. package/build/src/v1alpha/recommendation_service_client.d.ts +108 -0
  65. package/build/src/v1alpha/recommendation_service_client.js +157 -0
  66. package/build/src/v1alpha/sample_query_service_client.d.ts +2317 -0
  67. package/build/src/v1alpha/sample_query_service_client.js +3186 -0
  68. package/build/src/v1alpha/sample_query_service_client_config.json +68 -0
  69. package/build/src/v1alpha/sample_query_set_service_client.d.ts +2176 -0
  70. package/build/src/v1alpha/sample_query_set_service_client.js +2931 -0
  71. package/build/src/v1alpha/sample_query_set_service_client_config.json +63 -0
  72. package/build/src/v1alpha/schema_service_client.d.ts +108 -0
  73. package/build/src/v1alpha/schema_service_client.js +157 -0
  74. package/build/src/v1alpha/search_service_client.d.ts +108 -0
  75. package/build/src/v1alpha/search_service_client.js +157 -0
  76. package/build/src/v1alpha/search_tuning_service_client.d.ts +108 -0
  77. package/build/src/v1alpha/search_tuning_service_client.js +157 -0
  78. package/build/src/v1alpha/serving_config_service_client.d.ts +108 -0
  79. package/build/src/v1alpha/serving_config_service_client.js +157 -0
  80. package/build/src/v1alpha/site_search_engine_service_client.d.ts +108 -0
  81. package/build/src/v1alpha/site_search_engine_service_client.js +157 -0
  82. package/build/src/v1alpha/user_event_service_client.d.ts +108 -0
  83. package/build/src/v1alpha/user_event_service_client.js +157 -0
  84. package/build/src/v1beta/completion_service_client.d.ts +328 -0
  85. package/build/src/v1beta/completion_service_client.js +423 -0
  86. package/build/src/v1beta/completion_service_client_config.json +10 -0
  87. package/build/src/v1beta/control_service_client.d.ts +237 -0
  88. package/build/src/v1beta/control_service_client.js +333 -0
  89. package/build/src/v1beta/conversational_search_service_client.d.ts +255 -0
  90. package/build/src/v1beta/conversational_search_service_client.js +333 -0
  91. package/build/src/v1beta/data_store_service_client.d.ts +246 -0
  92. package/build/src/v1beta/data_store_service_client.js +339 -0
  93. package/build/src/v1beta/document_service_client.d.ts +239 -0
  94. package/build/src/v1beta/document_service_client.js +339 -0
  95. package/build/src/v1beta/engine_service_client.d.ts +237 -0
  96. package/build/src/v1beta/engine_service_client.js +339 -0
  97. package/build/src/v1beta/evaluation_service_client.d.ts +2325 -0
  98. package/build/src/v1beta/evaluation_service_client.js +3252 -0
  99. package/build/src/v1beta/evaluation_service_client_config.json +58 -0
  100. package/build/src/v1beta/grounded_generation_service_client.d.ts +237 -0
  101. package/build/src/v1beta/grounded_generation_service_client.js +333 -0
  102. package/build/src/v1beta/index.d.ts +3 -0
  103. package/build/src/v1beta/index.js +7 -1
  104. package/build/src/v1beta/project_service_client.d.ts +237 -0
  105. package/build/src/v1beta/project_service_client.js +339 -0
  106. package/build/src/v1beta/rank_service_client.d.ts +237 -0
  107. package/build/src/v1beta/rank_service_client.js +333 -0
  108. package/build/src/v1beta/recommendation_service_client.d.ts +237 -0
  109. package/build/src/v1beta/recommendation_service_client.js +333 -0
  110. package/build/src/v1beta/sample_query_service_client.d.ts +2293 -0
  111. package/build/src/v1beta/sample_query_service_client.js +3150 -0
  112. package/build/src/v1beta/sample_query_service_client_config.json +68 -0
  113. package/build/src/v1beta/sample_query_set_service_client.d.ts +2150 -0
  114. package/build/src/v1beta/sample_query_set_service_client.js +2895 -0
  115. package/build/src/v1beta/sample_query_set_service_client_config.json +63 -0
  116. package/build/src/v1beta/schema_service_client.d.ts +237 -0
  117. package/build/src/v1beta/schema_service_client.js +339 -0
  118. package/build/src/v1beta/search_service_client.d.ts +414 -12
  119. package/build/src/v1beta/search_service_client.js +451 -8
  120. package/build/src/v1beta/search_tuning_service_client.d.ts +237 -0
  121. package/build/src/v1beta/search_tuning_service_client.js +339 -0
  122. package/build/src/v1beta/serving_config_service_client.d.ts +237 -0
  123. package/build/src/v1beta/serving_config_service_client.js +333 -0
  124. package/build/src/v1beta/site_search_engine_service_client.d.ts +237 -0
  125. package/build/src/v1beta/site_search_engine_service_client.js +339 -0
  126. package/build/src/v1beta/user_event_service_client.d.ts +312 -0
  127. package/build/src/v1beta/user_event_service_client.js +381 -0
  128. package/build/src/v1beta/user_event_service_client_config.json +5 -0
  129. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,25 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.12.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.11.0...discoveryengine-v1.12.0) (2024-08-09)
4
+
5
+
6
+ ### Features
7
+
8
+ * [discoveryengine] Update CompletionService ([#5574](https://github.com/googleapis/google-cloud-node/issues/5574)) ([384096f](https://github.com/googleapis/google-cloud-node/commit/384096fe3bbab56e9f708a2bc422f711cc1d8641))
9
+ * [discoveryengine] Update SearchService ([#5578](https://github.com/googleapis/google-cloud-node/issues/5578)) ([af46d57](https://github.com/googleapis/google-cloud-node/commit/af46d5779f82d7a37c687e1364b8c653bb6369e9))
10
+
11
+ ## [1.11.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.10.0...discoveryengine-v1.11.0) (2024-07-22)
12
+
13
+
14
+ ### Features
15
+
16
+ * [discoveryengine] add sample query set APIs ([#5552](https://github.com/googleapis/google-cloud-node/issues/5552)) ([8a0e59f](https://github.com/googleapis/google-cloud-node/commit/8a0e59fe0213105c5fd065f1255d2f1bf5b4138c))
17
+
18
+
19
+ ### Bug Fixes
20
+
21
+ * [discoveryengine] update sample query, sample query set patterns ([#5558](https://github.com/googleapis/google-cloud-node/issues/5558)) ([2c4325f](https://github.com/googleapis/google-cloud-node/commit/2c4325f28954f48538cdf113b2a8330dabf08680))
22
+
3
23
  ## [1.10.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.9.0...discoveryengine-v1.10.0) (2024-07-10)
4
24
 
5
25
 
package/README.md CHANGED
@@ -239,12 +239,27 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
239
239
  | Engine_service.tune_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.tune_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/engine_service.tune_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
240
240
  | Engine_service.update_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.update_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/engine_service.update_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
241
241
  | Estimate_billing_service.estimate_data_size | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/estimate_billing_service.estimate_data_size.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/estimate_billing_service.estimate_data_size.js,packages/google-cloud-discoveryengine/samples/README.md) |
242
+ | Evaluation_service.create_evaluation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/evaluation_service.create_evaluation.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/evaluation_service.create_evaluation.js,packages/google-cloud-discoveryengine/samples/README.md) |
243
+ | Evaluation_service.get_evaluation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/evaluation_service.get_evaluation.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/evaluation_service.get_evaluation.js,packages/google-cloud-discoveryengine/samples/README.md) |
244
+ | Evaluation_service.list_evaluation_results | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/evaluation_service.list_evaluation_results.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/evaluation_service.list_evaluation_results.js,packages/google-cloud-discoveryengine/samples/README.md) |
245
+ | Evaluation_service.list_evaluations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/evaluation_service.list_evaluations.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/evaluation_service.list_evaluations.js,packages/google-cloud-discoveryengine/samples/README.md) |
242
246
  | Grounded_generation_service.check_grounding | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/grounded_generation_service.check_grounding.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/grounded_generation_service.check_grounding.js,packages/google-cloud-discoveryengine/samples/README.md) |
243
247
  | Project_service.get_project | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/project_service.get_project.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/project_service.get_project.js,packages/google-cloud-discoveryengine/samples/README.md) |
244
248
  | Project_service.provision_project | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/project_service.provision_project.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/project_service.provision_project.js,packages/google-cloud-discoveryengine/samples/README.md) |
245
249
  | Project_service.report_consent_change | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/project_service.report_consent_change.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/project_service.report_consent_change.js,packages/google-cloud-discoveryengine/samples/README.md) |
246
250
  | Rank_service.rank | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/rank_service.rank.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/rank_service.rank.js,packages/google-cloud-discoveryengine/samples/README.md) |
247
251
  | Recommendation_service.recommend | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/recommendation_service.recommend.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/recommendation_service.recommend.js,packages/google-cloud-discoveryengine/samples/README.md) |
252
+ | Sample_query_service.create_sample_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/sample_query_service.create_sample_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/sample_query_service.create_sample_query.js,packages/google-cloud-discoveryengine/samples/README.md) |
253
+ | Sample_query_service.delete_sample_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/sample_query_service.delete_sample_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/sample_query_service.delete_sample_query.js,packages/google-cloud-discoveryengine/samples/README.md) |
254
+ | Sample_query_service.get_sample_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/sample_query_service.get_sample_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/sample_query_service.get_sample_query.js,packages/google-cloud-discoveryengine/samples/README.md) |
255
+ | Sample_query_service.import_sample_queries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/sample_query_service.import_sample_queries.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/sample_query_service.import_sample_queries.js,packages/google-cloud-discoveryengine/samples/README.md) |
256
+ | Sample_query_service.list_sample_queries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/sample_query_service.list_sample_queries.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/sample_query_service.list_sample_queries.js,packages/google-cloud-discoveryengine/samples/README.md) |
257
+ | Sample_query_service.update_sample_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/sample_query_service.update_sample_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/sample_query_service.update_sample_query.js,packages/google-cloud-discoveryengine/samples/README.md) |
258
+ | Sample_query_set_service.create_sample_query_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/sample_query_set_service.create_sample_query_set.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/sample_query_set_service.create_sample_query_set.js,packages/google-cloud-discoveryengine/samples/README.md) |
259
+ | Sample_query_set_service.delete_sample_query_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/sample_query_set_service.delete_sample_query_set.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/sample_query_set_service.delete_sample_query_set.js,packages/google-cloud-discoveryengine/samples/README.md) |
260
+ | Sample_query_set_service.get_sample_query_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/sample_query_set_service.get_sample_query_set.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/sample_query_set_service.get_sample_query_set.js,packages/google-cloud-discoveryengine/samples/README.md) |
261
+ | Sample_query_set_service.list_sample_query_sets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/sample_query_set_service.list_sample_query_sets.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/sample_query_set_service.list_sample_query_sets.js,packages/google-cloud-discoveryengine/samples/README.md) |
262
+ | Sample_query_set_service.update_sample_query_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/sample_query_set_service.update_sample_query_set.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/sample_query_set_service.update_sample_query_set.js,packages/google-cloud-discoveryengine/samples/README.md) |
248
263
  | Schema_service.create_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.create_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/v1alpha/schema_service.create_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
249
264
  | Schema_service.delete_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.delete_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/v1alpha/schema_service.delete_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
250
265
  | Schema_service.get_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.get_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/v1alpha/schema_service.get_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -273,7 +288,9 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
273
288
  | User_event_service.purge_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/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/v1alpha/user_event_service.purge_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |
274
289
  | User_event_service.write_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/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/v1alpha/user_event_service.write_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
275
290
  | Completion_service.complete_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/completion_service.complete_query.js,packages/google-cloud-discoveryengine/samples/README.md) |
291
+ | Completion_service.import_completion_suggestions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/completion_service.import_completion_suggestions.js,packages/google-cloud-discoveryengine/samples/README.md) |
276
292
  | Completion_service.import_suggestion_deny_list_entries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/completion_service.import_suggestion_deny_list_entries.js,packages/google-cloud-discoveryengine/samples/README.md) |
293
+ | Completion_service.purge_completion_suggestions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/completion_service.purge_completion_suggestions.js,packages/google-cloud-discoveryengine/samples/README.md) |
277
294
  | Completion_service.purge_suggestion_deny_list_entries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/completion_service.purge_suggestion_deny_list_entries.js,packages/google-cloud-discoveryengine/samples/README.md) |
278
295
  | Control_service.create_control | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/control_service.create_control.js,packages/google-cloud-discoveryengine/samples/README.md) |
279
296
  | Control_service.delete_control | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/control_service.delete_control.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -313,10 +330,25 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
313
330
  | Engine_service.resume_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/engine_service.resume_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/v1beta/engine_service.resume_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
314
331
  | Engine_service.tune_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/engine_service.tune_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/v1beta/engine_service.tune_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
315
332
  | Engine_service.update_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/engine_service.update_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/v1beta/engine_service.update_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
333
+ | Evaluation_service.create_evaluation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/evaluation_service.create_evaluation.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/evaluation_service.create_evaluation.js,packages/google-cloud-discoveryengine/samples/README.md) |
334
+ | Evaluation_service.get_evaluation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/evaluation_service.get_evaluation.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/evaluation_service.get_evaluation.js,packages/google-cloud-discoveryengine/samples/README.md) |
335
+ | Evaluation_service.list_evaluation_results | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/evaluation_service.list_evaluation_results.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/evaluation_service.list_evaluation_results.js,packages/google-cloud-discoveryengine/samples/README.md) |
336
+ | Evaluation_service.list_evaluations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/evaluation_service.list_evaluations.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/evaluation_service.list_evaluations.js,packages/google-cloud-discoveryengine/samples/README.md) |
316
337
  | Grounded_generation_service.check_grounding | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/grounded_generation_service.check_grounding.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/grounded_generation_service.check_grounding.js,packages/google-cloud-discoveryengine/samples/README.md) |
317
338
  | Project_service.provision_project | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/project_service.provision_project.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/project_service.provision_project.js,packages/google-cloud-discoveryengine/samples/README.md) |
318
339
  | Rank_service.rank | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/rank_service.rank.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/rank_service.rank.js,packages/google-cloud-discoveryengine/samples/README.md) |
319
340
  | Recommendation_service.recommend | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/recommendation_service.recommend.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/recommendation_service.recommend.js,packages/google-cloud-discoveryengine/samples/README.md) |
341
+ | Sample_query_service.create_sample_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/sample_query_service.create_sample_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/v1beta/sample_query_service.create_sample_query.js,packages/google-cloud-discoveryengine/samples/README.md) |
342
+ | Sample_query_service.delete_sample_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/sample_query_service.delete_sample_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/v1beta/sample_query_service.delete_sample_query.js,packages/google-cloud-discoveryengine/samples/README.md) |
343
+ | Sample_query_service.get_sample_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/sample_query_service.get_sample_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/v1beta/sample_query_service.get_sample_query.js,packages/google-cloud-discoveryengine/samples/README.md) |
344
+ | Sample_query_service.import_sample_queries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/sample_query_service.import_sample_queries.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/sample_query_service.import_sample_queries.js,packages/google-cloud-discoveryengine/samples/README.md) |
345
+ | Sample_query_service.list_sample_queries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/sample_query_service.list_sample_queries.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/sample_query_service.list_sample_queries.js,packages/google-cloud-discoveryengine/samples/README.md) |
346
+ | Sample_query_service.update_sample_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/sample_query_service.update_sample_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/v1beta/sample_query_service.update_sample_query.js,packages/google-cloud-discoveryengine/samples/README.md) |
347
+ | Sample_query_set_service.create_sample_query_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/sample_query_set_service.create_sample_query_set.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/sample_query_set_service.create_sample_query_set.js,packages/google-cloud-discoveryengine/samples/README.md) |
348
+ | Sample_query_set_service.delete_sample_query_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/sample_query_set_service.delete_sample_query_set.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/sample_query_set_service.delete_sample_query_set.js,packages/google-cloud-discoveryengine/samples/README.md) |
349
+ | Sample_query_set_service.get_sample_query_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/sample_query_set_service.get_sample_query_set.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/sample_query_set_service.get_sample_query_set.js,packages/google-cloud-discoveryengine/samples/README.md) |
350
+ | Sample_query_set_service.list_sample_query_sets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/sample_query_set_service.list_sample_query_sets.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/sample_query_set_service.list_sample_query_sets.js,packages/google-cloud-discoveryengine/samples/README.md) |
351
+ | Sample_query_set_service.update_sample_query_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/sample_query_set_service.update_sample_query_set.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/sample_query_set_service.update_sample_query_set.js,packages/google-cloud-discoveryengine/samples/README.md) |
320
352
  | Schema_service.create_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/schema_service.create_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/v1beta/schema_service.create_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
321
353
  | Schema_service.delete_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/schema_service.delete_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/v1beta/schema_service.delete_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
322
354
  | Schema_service.get_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/schema_service.get_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/v1beta/schema_service.get_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -342,6 +374,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
342
374
  | Site_search_engine_service.update_target_site | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/site_search_engine_service.update_target_site.js,packages/google-cloud-discoveryengine/samples/README.md) |
343
375
  | User_event_service.collect_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/user_event_service.collect_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
344
376
  | User_event_service.import_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/user_event_service.import_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |
377
+ | User_event_service.purge_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/user_event_service.purge_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |
345
378
  | User_event_service.write_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/user_event_service.write_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
346
379
  | Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/quickstart.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/quickstart.js,packages/google-cloud-discoveryengine/samples/README.md) |
347
380
 
@@ -0,0 +1,232 @@
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.v1alpha;
18
+
19
+ import "google/api/field_behavior.proto";
20
+ import "google/api/resource.proto";
21
+ import "google/cloud/discoveryengine/v1alpha/search_service.proto";
22
+ import "google/protobuf/timestamp.proto";
23
+ import "google/rpc/status.proto";
24
+
25
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
26
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
27
+ option java_multiple_files = true;
28
+ option java_outer_classname = "EvaluationProto";
29
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
30
+ option objc_class_prefix = "DISCOVERYENGINE";
31
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
32
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
33
+
34
+ // An evaluation is a single execution (or run) of an evaluation process. It
35
+ // encapsulates the state of the evaluation and the resulting data.
36
+ message Evaluation {
37
+ option (google.api.resource) = {
38
+ type: "discoveryengine.googleapis.com/Evaluation"
39
+ pattern: "projects/{project}/locations/{location}/evaluations/{evaluation}"
40
+ };
41
+
42
+ // Describes the specification of the evaluation.
43
+ message EvaluationSpec {
44
+ // Describes the specification of the query set.
45
+ message QuerySetSpec {
46
+ // Required. The full resource name of the
47
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]
48
+ // used for the evaluation, in the format of
49
+ // `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
50
+ string sample_query_set = 1 [
51
+ (google.api.field_behavior) = REQUIRED,
52
+ (google.api.resource_reference) = {
53
+ type: "discoveryengine.googleapis.com/SampleQuerySet"
54
+ }
55
+ ];
56
+ }
57
+
58
+ // The search specification.
59
+ oneof search_spec {
60
+ // Required. The search request that is used to perform the evaluation.
61
+ //
62
+ // Only the following fields within SearchRequest are supported; if any
63
+ // other fields are provided, an UNSUPPORTED error will be returned:
64
+ //
65
+ // * [SearchRequest.serving_config][google.cloud.discoveryengine.v1alpha.SearchRequest.serving_config]
66
+ // * [SearchRequest.branch][google.cloud.discoveryengine.v1alpha.SearchRequest.branch]
67
+ // * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1alpha.SearchRequest.canonical_filter]
68
+ // * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.query_expansion_spec]
69
+ // * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.spell_correction_spec]
70
+ // * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.content_search_spec]
71
+ // * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id]
72
+ SearchRequest search_request = 2 [(google.api.field_behavior) = REQUIRED];
73
+ }
74
+
75
+ // Required. The specification of the query set.
76
+ QuerySetSpec query_set_spec = 1 [(google.api.field_behavior) = REQUIRED];
77
+ }
78
+
79
+ // Describes the state of an evaluation.
80
+ enum State {
81
+ // The evaluation is unspecified.
82
+ STATE_UNSPECIFIED = 0;
83
+
84
+ // The service is preparing to run the evaluation.
85
+ PENDING = 1;
86
+
87
+ // The evaluation is in progress.
88
+ RUNNING = 2;
89
+
90
+ // The evaluation completed successfully.
91
+ SUCCEEDED = 3;
92
+
93
+ // The evaluation failed.
94
+ FAILED = 4;
95
+ }
96
+
97
+ // Identifier. The full resource name of the
98
+ // [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], in the
99
+ // format of
100
+ // `projects/{project}/locations/{location}/evaluations/{evaluation}`.
101
+ //
102
+ // This field must be a UTF-8 encoded string with a length limit of 1024
103
+ // characters.
104
+ string name = 1 [(google.api.field_behavior) = IDENTIFIER];
105
+
106
+ // Required. The specification of the evaluation.
107
+ EvaluationSpec evaluation_spec = 2 [(google.api.field_behavior) = REQUIRED];
108
+
109
+ // Output only. The metrics produced by the evaluation, averaged across all
110
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s in the
111
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
112
+ //
113
+ // Only populated when the evaluation's state is SUCCEEDED.
114
+ QualityMetrics quality_metrics = 3
115
+ [(google.api.field_behavior) = OUTPUT_ONLY];
116
+
117
+ // Output only. The state of the evaluation.
118
+ State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
119
+
120
+ // Output only. The error that occurred during evaluation. Only populated when
121
+ // the evaluation's state is FAILED.
122
+ google.rpc.Status error = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
123
+
124
+ // Output only. Timestamp the
125
+ // [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] was created
126
+ // at.
127
+ google.protobuf.Timestamp create_time = 6
128
+ [(google.api.field_behavior) = OUTPUT_ONLY];
129
+
130
+ // Output only. Timestamp the
131
+ // [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] was completed
132
+ // at.
133
+ google.protobuf.Timestamp end_time = 7
134
+ [(google.api.field_behavior) = OUTPUT_ONLY];
135
+
136
+ // Output only. A sample of errors encountered while processing the request.
137
+ repeated google.rpc.Status error_samples = 8
138
+ [(google.api.field_behavior) = OUTPUT_ONLY];
139
+ }
140
+
141
+ // Describes the metrics produced by the evaluation.
142
+ message QualityMetrics {
143
+ // Stores the metric values at specific top-k levels.
144
+ message TopkMetrics {
145
+ // The top-1 value.
146
+ double top_1 = 1;
147
+
148
+ // The top-3 value.
149
+ double top_3 = 2;
150
+
151
+ // The top-5 value.
152
+ double top_5 = 3;
153
+
154
+ // The top-10 value.
155
+ double top_10 = 4;
156
+ }
157
+
158
+ // Recall per document, at various top-k cutoff levels.
159
+ //
160
+ // Recall is the fraction of relevant documents retrieved out of all
161
+ // relevant documents.
162
+ //
163
+ // Example (top-5):
164
+ // * For a single
165
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], If 3 out
166
+ // of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
167
+ TopkMetrics doc_recall = 1;
168
+
169
+ // Precision per document, at various top-k cutoff levels.
170
+ //
171
+ // Precision is the fraction of retrieved documents that are relevant.
172
+ //
173
+ // Example (top-5):
174
+ // * For a single
175
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], If 4 out
176
+ // of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 =
177
+ // 0.8
178
+ TopkMetrics doc_precision = 2;
179
+
180
+ // Normalized discounted cumulative gain (NDCG) per document, at various top-k
181
+ // cutoff levels.
182
+ //
183
+ // NDCG measures the ranking quality, giving higher relevance to top
184
+ // results.
185
+ //
186
+ // Example (top-3):
187
+ // Suppose [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]
188
+ // with three retrieved documents (D1, D2, D3) and binary relevance
189
+ // judgements (1 for relevant, 0 for not relevant):
190
+ //
191
+ // Retrieved: [D3 (0), D1 (1), D2 (1)]
192
+ // Ideal: [D1 (1), D2 (1), D3 (0)]
193
+ //
194
+ // Calculate NDCG@3 for each
195
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]:
196
+ // * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
197
+ // * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
198
+ // * NDCG@3: 1.13/1.63 = 0.693
199
+ TopkMetrics doc_ndcg = 3;
200
+
201
+ // Recall per page, at various top-k cutoff levels.
202
+ //
203
+ // Recall is the fraction of relevant pages retrieved out of all relevant
204
+ // pages.
205
+ //
206
+ // Example (top-5):
207
+ // * For a single
208
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], if 3 out
209
+ // of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
210
+ TopkMetrics page_recall = 4;
211
+
212
+ // Normalized discounted cumulative gain (NDCG) per page, at various top-k
213
+ // cutoff levels.
214
+ //
215
+ // NDCG measures the ranking quality, giving higher relevance to top
216
+ // results.
217
+ //
218
+ // Example (top-3):
219
+ // Suppose [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]
220
+ // with three retrieved pages (P1, P2, P3) and binary relevance judgements (1
221
+ // for relevant, 0 for not relevant):
222
+ //
223
+ // Retrieved: [P3 (0), P1 (1), P2 (1)]
224
+ // Ideal: [P1 (1), P2 (1), P3 (0)]
225
+ //
226
+ // Calculate NDCG@3 for
227
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]:
228
+ // * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
229
+ // * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
230
+ // * NDCG@3: 1.13/1.63 = 0.693
231
+ TopkMetrics page_ndcg = 5;
232
+ }