@google-cloud/discoveryengine 1.10.0 → 1.11.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 (119) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +30 -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/chunk.proto +119 -0
  11. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +0 -5
  12. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +10 -2
  13. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
  14. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +37 -2
  15. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation.proto +231 -0
  16. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation_service.proto +252 -0
  17. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +83 -0
  18. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query.proto +86 -0
  19. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_service.proto +264 -0
  20. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set.proto +64 -0
  21. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set_service.proto +256 -0
  22. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +67 -8
  23. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +11 -5
  24. package/build/protos/protos.d.ts +28997 -20222
  25. package/build/protos/protos.js +74749 -54453
  26. package/build/protos/protos.json +6933 -4764
  27. package/build/src/v1alpha/acl_config_service_client.d.ts +108 -0
  28. package/build/src/v1alpha/acl_config_service_client.js +157 -0
  29. package/build/src/v1alpha/chunk_service_client.d.ts +108 -0
  30. package/build/src/v1alpha/chunk_service_client.js +157 -0
  31. package/build/src/v1alpha/completion_service_client.d.ts +108 -0
  32. package/build/src/v1alpha/completion_service_client.js +157 -0
  33. package/build/src/v1alpha/control_service_client.d.ts +108 -0
  34. package/build/src/v1alpha/control_service_client.js +157 -0
  35. package/build/src/v1alpha/conversational_search_service_client.d.ts +108 -0
  36. package/build/src/v1alpha/conversational_search_service_client.js +157 -0
  37. package/build/src/v1alpha/data_store_service_client.d.ts +108 -0
  38. package/build/src/v1alpha/data_store_service_client.js +157 -0
  39. package/build/src/v1alpha/document_service_client.d.ts +108 -0
  40. package/build/src/v1alpha/document_service_client.js +157 -0
  41. package/build/src/v1alpha/engine_service_client.d.ts +108 -0
  42. package/build/src/v1alpha/engine_service_client.js +157 -0
  43. package/build/src/v1alpha/estimate_billing_service_client.d.ts +108 -0
  44. package/build/src/v1alpha/estimate_billing_service_client.js +157 -0
  45. package/build/src/v1alpha/evaluation_service_client.d.ts +2349 -0
  46. package/build/src/v1alpha/evaluation_service_client.js +3288 -0
  47. package/build/src/v1alpha/evaluation_service_client_config.json +58 -0
  48. package/build/src/v1alpha/grounded_generation_service_client.d.ts +108 -0
  49. package/build/src/v1alpha/grounded_generation_service_client.js +157 -0
  50. package/build/src/v1alpha/index.d.ts +3 -0
  51. package/build/src/v1alpha/index.js +7 -1
  52. package/build/src/v1alpha/project_service_client.d.ts +108 -0
  53. package/build/src/v1alpha/project_service_client.js +157 -0
  54. package/build/src/v1alpha/rank_service_client.d.ts +108 -0
  55. package/build/src/v1alpha/rank_service_client.js +157 -0
  56. package/build/src/v1alpha/recommendation_service_client.d.ts +108 -0
  57. package/build/src/v1alpha/recommendation_service_client.js +157 -0
  58. package/build/src/v1alpha/sample_query_service_client.d.ts +2317 -0
  59. package/build/src/v1alpha/sample_query_service_client.js +3186 -0
  60. package/build/src/v1alpha/sample_query_service_client_config.json +68 -0
  61. package/build/src/v1alpha/sample_query_set_service_client.d.ts +2176 -0
  62. package/build/src/v1alpha/sample_query_set_service_client.js +2931 -0
  63. package/build/src/v1alpha/sample_query_set_service_client_config.json +63 -0
  64. package/build/src/v1alpha/schema_service_client.d.ts +108 -0
  65. package/build/src/v1alpha/schema_service_client.js +157 -0
  66. package/build/src/v1alpha/search_service_client.d.ts +108 -0
  67. package/build/src/v1alpha/search_service_client.js +157 -0
  68. package/build/src/v1alpha/search_tuning_service_client.d.ts +108 -0
  69. package/build/src/v1alpha/search_tuning_service_client.js +157 -0
  70. package/build/src/v1alpha/serving_config_service_client.d.ts +108 -0
  71. package/build/src/v1alpha/serving_config_service_client.js +157 -0
  72. package/build/src/v1alpha/site_search_engine_service_client.d.ts +108 -0
  73. package/build/src/v1alpha/site_search_engine_service_client.js +157 -0
  74. package/build/src/v1alpha/user_event_service_client.d.ts +108 -0
  75. package/build/src/v1alpha/user_event_service_client.js +157 -0
  76. package/build/src/v1beta/completion_service_client.d.ts +237 -0
  77. package/build/src/v1beta/completion_service_client.js +339 -0
  78. package/build/src/v1beta/control_service_client.d.ts +237 -0
  79. package/build/src/v1beta/control_service_client.js +333 -0
  80. package/build/src/v1beta/conversational_search_service_client.d.ts +237 -0
  81. package/build/src/v1beta/conversational_search_service_client.js +333 -0
  82. package/build/src/v1beta/data_store_service_client.d.ts +237 -0
  83. package/build/src/v1beta/data_store_service_client.js +339 -0
  84. package/build/src/v1beta/document_service_client.d.ts +237 -0
  85. package/build/src/v1beta/document_service_client.js +339 -0
  86. package/build/src/v1beta/engine_service_client.d.ts +237 -0
  87. package/build/src/v1beta/engine_service_client.js +339 -0
  88. package/build/src/v1beta/evaluation_service_client.d.ts +2325 -0
  89. package/build/src/v1beta/evaluation_service_client.js +3252 -0
  90. package/build/src/v1beta/evaluation_service_client_config.json +58 -0
  91. package/build/src/v1beta/grounded_generation_service_client.d.ts +237 -0
  92. package/build/src/v1beta/grounded_generation_service_client.js +333 -0
  93. package/build/src/v1beta/index.d.ts +3 -0
  94. package/build/src/v1beta/index.js +7 -1
  95. package/build/src/v1beta/project_service_client.d.ts +237 -0
  96. package/build/src/v1beta/project_service_client.js +339 -0
  97. package/build/src/v1beta/rank_service_client.d.ts +237 -0
  98. package/build/src/v1beta/rank_service_client.js +333 -0
  99. package/build/src/v1beta/recommendation_service_client.d.ts +237 -0
  100. package/build/src/v1beta/recommendation_service_client.js +333 -0
  101. package/build/src/v1beta/sample_query_service_client.d.ts +2293 -0
  102. package/build/src/v1beta/sample_query_service_client.js +3150 -0
  103. package/build/src/v1beta/sample_query_service_client_config.json +68 -0
  104. package/build/src/v1beta/sample_query_set_service_client.d.ts +2150 -0
  105. package/build/src/v1beta/sample_query_set_service_client.js +2895 -0
  106. package/build/src/v1beta/sample_query_set_service_client_config.json +63 -0
  107. package/build/src/v1beta/schema_service_client.d.ts +237 -0
  108. package/build/src/v1beta/schema_service_client.js +339 -0
  109. package/build/src/v1beta/search_service_client.d.ts +267 -12
  110. package/build/src/v1beta/search_service_client.js +353 -8
  111. package/build/src/v1beta/search_tuning_service_client.d.ts +237 -0
  112. package/build/src/v1beta/search_tuning_service_client.js +339 -0
  113. package/build/src/v1beta/serving_config_service_client.d.ts +237 -0
  114. package/build/src/v1beta/serving_config_service_client.js +333 -0
  115. package/build/src/v1beta/site_search_engine_service_client.d.ts +237 -0
  116. package/build/src/v1beta/site_search_engine_service_client.js +339 -0
  117. package/build/src/v1beta/user_event_service_client.d.ts +237 -0
  118. package/build/src/v1beta/user_event_service_client.js +339 -0
  119. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.11.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.10.0...discoveryengine-v1.11.0) (2024-07-22)
4
+
5
+
6
+ ### Features
7
+
8
+ * [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))
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * [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))
14
+
3
15
  ## [1.10.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.9.0...discoveryengine-v1.10.0) (2024-07-10)
4
16
 
5
17
 
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) |
@@ -313,10 +328,25 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
313
328
  | 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
329
  | 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
330
  | 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) |
331
+ | 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) |
332
+ | 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) |
333
+ | 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) |
334
+ | 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
335
  | 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
336
  | 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
337
  | 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
338
  | 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) |
339
+ | 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) |
340
+ | 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) |
341
+ | 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) |
342
+ | 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) |
343
+ | 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) |
344
+ | 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) |
345
+ | 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) |
346
+ | 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) |
347
+ | 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) |
348
+ | 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) |
349
+ | 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
350
  | 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
351
  | 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
352
  | 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) |
@@ -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
+ }
@@ -0,0 +1,252 @@
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/annotations.proto";
20
+ import "google/api/client.proto";
21
+ import "google/api/field_behavior.proto";
22
+ import "google/api/resource.proto";
23
+ import "google/cloud/discoveryengine/v1alpha/evaluation.proto";
24
+ import "google/cloud/discoveryengine/v1alpha/sample_query.proto";
25
+ import "google/longrunning/operations.proto";
26
+
27
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
28
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
29
+ option java_multiple_files = true;
30
+ option java_outer_classname = "EvaluationServiceProto";
31
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
32
+ option objc_class_prefix = "DISCOVERYENGINE";
33
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
34
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
35
+
36
+ // Service for managing
37
+ // [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s,
38
+ service EvaluationService {
39
+ option (google.api.default_host) = "discoveryengine.googleapis.com";
40
+ option (google.api.oauth_scopes) =
41
+ "https://www.googleapis.com/auth/cloud-platform";
42
+
43
+ // Gets a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
44
+ rpc GetEvaluation(GetEvaluationRequest) returns (Evaluation) {
45
+ option (google.api.http) = {
46
+ get: "/v1alpha/{name=projects/*/locations/*/evaluations/*}"
47
+ };
48
+ option (google.api.method_signature) = "name";
49
+ }
50
+
51
+ // Gets a list of
52
+ // [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.
53
+ rpc ListEvaluations(ListEvaluationsRequest)
54
+ returns (ListEvaluationsResponse) {
55
+ option (google.api.http) = {
56
+ get: "/v1alpha/{parent=projects/*/locations/*}/evaluations"
57
+ };
58
+ option (google.api.method_signature) = "parent";
59
+ }
60
+
61
+ // Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
62
+ //
63
+ // Upon creation, the evaluation will be automatically triggered and begin
64
+ // execution.
65
+ rpc CreateEvaluation(CreateEvaluationRequest)
66
+ returns (google.longrunning.Operation) {
67
+ option (google.api.http) = {
68
+ post: "/v1alpha/{parent=projects/*/locations/*}/evaluations"
69
+ body: "evaluation"
70
+ };
71
+ option (google.api.method_signature) = "parent,evaluation";
72
+ option (google.longrunning.operation_info) = {
73
+ response_type: "google.cloud.discoveryengine.v1alpha.Evaluation"
74
+ metadata_type: "google.cloud.discoveryengine.v1alpha.CreateEvaluationMetadata"
75
+ };
76
+ }
77
+
78
+ // Gets a list of results for a given a
79
+ // [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
80
+ rpc ListEvaluationResults(ListEvaluationResultsRequest)
81
+ returns (ListEvaluationResultsResponse) {
82
+ option (google.api.http) = {
83
+ get: "/v1alpha/{evaluation=projects/*/locations/*/evaluations/*}:listResults"
84
+ };
85
+ option (google.api.method_signature) = "evaluation";
86
+ }
87
+ }
88
+
89
+ // Request message for
90
+ // [EvaluationService.GetEvaluation][google.cloud.discoveryengine.v1alpha.EvaluationService.GetEvaluation]
91
+ // method.
92
+ message GetEvaluationRequest {
93
+ // Required. Full resource name of
94
+ // [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], such as
95
+ // `projects/{project}/locations/{location}/evaluations/{evaluation}`.
96
+ //
97
+ // If the caller does not have permission to access the
98
+ // [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], regardless
99
+ // of whether or not it exists, a PERMISSION_DENIED error is returned.
100
+ //
101
+ // If the requested
102
+ // [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] does not
103
+ // exist, a NOT_FOUND error is returned.
104
+ string name = 1 [
105
+ (google.api.field_behavior) = REQUIRED,
106
+ (google.api.resource_reference) = {
107
+ type: "discoveryengine.googleapis.com/Evaluation"
108
+ }
109
+ ];
110
+ }
111
+
112
+ // Request message for
113
+ // [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations]
114
+ // method.
115
+ message ListEvaluationsRequest {
116
+ // Required. The parent location resource name, such as
117
+ // `projects/{project}/locations/{location}`.
118
+ //
119
+ // If the caller does not have permission to list
120
+ // [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s under this
121
+ // location, regardless of whether or not this location exists, a
122
+ // `PERMISSION_DENIED` error is returned.
123
+ string parent = 1 [
124
+ (google.api.field_behavior) = REQUIRED,
125
+ (google.api.resource_reference) = {
126
+ type: "discoveryengine.googleapis.com/Location"
127
+ }
128
+ ];
129
+
130
+ // Maximum number of
131
+ // [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s to return.
132
+ // If unspecified, defaults to 100. The maximum allowed value is 1000. Values
133
+ // above 1000 will be coerced to 1000.
134
+ //
135
+ // If this field is negative, an `INVALID_ARGUMENT` error is returned.
136
+ int32 page_size = 2;
137
+
138
+ // A page token
139
+ // [ListEvaluationsResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationsResponse.next_page_token],
140
+ // received from a previous
141
+ // [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations]
142
+ // call. Provide this to retrieve the subsequent page.
143
+ //
144
+ // When paginating, all other parameters provided to
145
+ // [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations]
146
+ // must match the call that provided the page token. Otherwise, an
147
+ // `INVALID_ARGUMENT` error is returned.
148
+ string page_token = 3;
149
+ }
150
+
151
+ // Response message for
152
+ // [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations]
153
+ // method.
154
+ message ListEvaluationsResponse {
155
+ // The [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.
156
+ repeated Evaluation evaluations = 1;
157
+
158
+ // A token that can be sent as
159
+ // [ListEvaluationsRequest.page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationsRequest.page_token]
160
+ // to retrieve the next page. If this field is omitted, there are no
161
+ // subsequent pages.
162
+ string next_page_token = 2;
163
+ }
164
+
165
+ // Request message for
166
+ // [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1alpha.EvaluationService.CreateEvaluation]
167
+ // method.
168
+ message CreateEvaluationRequest {
169
+ // Required. The parent resource name, such as
170
+ // `projects/{project}/locations/{location}`.
171
+ string parent = 1 [
172
+ (google.api.field_behavior) = REQUIRED,
173
+ (google.api.resource_reference) = {
174
+ type: "discoveryengine.googleapis.com/Location"
175
+ }
176
+ ];
177
+
178
+ // Required. The [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]
179
+ // to create.
180
+ Evaluation evaluation = 2 [(google.api.field_behavior) = REQUIRED];
181
+ }
182
+
183
+ // Metadata for
184
+ // [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1alpha.EvaluationService.CreateEvaluation]
185
+ // method.
186
+ message CreateEvaluationMetadata {}
187
+
188
+ // Request message for
189
+ // [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults]
190
+ // method.
191
+ message ListEvaluationResultsRequest {
192
+ // Required. The evaluation resource name, such as
193
+ // `projects/{project}/locations/{location}/evaluations/{evaluation}`.
194
+ //
195
+ // If the caller does not have permission to list [EvaluationResult][]
196
+ // under this evaluation, regardless of whether or not this evaluation
197
+ // set exists, a `PERMISSION_DENIED` error is returned.
198
+ string evaluation = 1 [
199
+ (google.api.field_behavior) = REQUIRED,
200
+ (google.api.resource_reference) = {
201
+ type: "discoveryengine.googleapis.com/Evaluation"
202
+ }
203
+ ];
204
+
205
+ // Maximum number of [EvaluationResult][] to return. If unspecified,
206
+ // defaults to 100. The maximum allowed value is 1000. Values above 1000 will
207
+ // be coerced to 1000.
208
+ //
209
+ // If this field is negative, an `INVALID_ARGUMENT` error is returned.
210
+ int32 page_size = 2;
211
+
212
+ // A page token
213
+ // [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse.next_page_token],
214
+ // received from a previous
215
+ // [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults]
216
+ // call. Provide this to retrieve the subsequent page.
217
+ //
218
+ // When paginating, all other parameters provided to
219
+ // [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults]
220
+ // must match the call that provided the page token. Otherwise, an
221
+ // `INVALID_ARGUMENT` error is returned.
222
+ string page_token = 3;
223
+ }
224
+
225
+ // Response message for
226
+ // [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults]
227
+ // method.
228
+ message ListEvaluationResultsResponse {
229
+ // Represents the results of an evaluation for a single
230
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
231
+ message EvaluationResult {
232
+ // Output only. The
233
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] that was
234
+ // evaluated.
235
+ SampleQuery sample_query = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
236
+
237
+ // Output only. The metrics produced by the evaluation, for a given
238
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
239
+ QualityMetrics quality_metrics = 2
240
+ [(google.api.field_behavior) = OUTPUT_ONLY];
241
+ }
242
+
243
+ // The
244
+ // [EvaluationResult][google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse.EvaluationResult]s.
245
+ repeated EvaluationResult evaluation_results = 1;
246
+
247
+ // A token that can be sent as
248
+ // [ListEvaluationResultsRequest.page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationResultsRequest.page_token]
249
+ // to retrieve the next page. If this field is omitted, there are no
250
+ // subsequent pages.
251
+ string next_page_token = 2;
252
+ }