@google-cloud/discoveryengine 1.4.0 → 1.4.1

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 (107) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +13 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config.proto +49 -0
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config_service.proto +79 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +72 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/chunk_service.proto +137 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +77 -4
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/completion.proto +52 -0
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +44 -2
  10. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +6 -1
  11. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +44 -0
  12. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +80 -1
  13. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +83 -0
  14. package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +127 -0
  15. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +6 -0
  16. package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +13 -8
  17. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +3 -2
  18. package/build/protos/google/cloud/discoveryengine/v1alpha/estimate_billing_service.proto +130 -0
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +64 -0
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +66 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +3 -1
  22. package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +3 -0
  23. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +74 -13
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +24 -20
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config.proto +271 -0
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config_service.proto +147 -0
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +9 -3
  28. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +7 -4
  29. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +4 -3
  30. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +5 -0
  31. package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +22 -0
  32. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +9 -0
  33. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +94 -0
  34. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +3 -0
  35. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +19 -4
  36. package/build/protos/google/cloud/discoveryengine/v1beta/search_tuning_service.proto +151 -0
  37. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +4 -3
  38. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto +6 -5
  39. package/build/protos/protos.d.ts +15133 -7787
  40. package/build/protos/protos.js +50444 -32043
  41. package/build/protos/protos.json +4132 -2305
  42. package/build/src/v1alpha/acl_config_service_client.d.ts +1233 -0
  43. package/build/src/v1alpha/acl_config_service_client.js +1765 -0
  44. package/build/src/v1alpha/acl_config_service_client_config.json +34 -0
  45. package/build/src/v1alpha/chunk_service_client.d.ts +1350 -0
  46. package/build/src/v1alpha/chunk_service_client.js +1886 -0
  47. package/build/src/v1alpha/chunk_service_client_config.json +34 -0
  48. package/build/src/v1alpha/completion_service_client.d.ts +588 -3
  49. package/build/src/v1alpha/completion_service_client.js +831 -2
  50. package/build/src/v1alpha/completion_service_client_config.json +10 -0
  51. package/build/src/v1alpha/conversational_search_service_client.d.ts +233 -1
  52. package/build/src/v1alpha/conversational_search_service_client.js +316 -0
  53. package/build/src/v1alpha/data_store_service_client.d.ts +451 -3
  54. package/build/src/v1alpha/data_store_service_client.js +562 -2
  55. package/build/src/v1alpha/data_store_service_client_config.json +8 -0
  56. package/build/src/v1alpha/document_service_client.d.ts +382 -0
  57. package/build/src/v1alpha/document_service_client.js +514 -0
  58. package/build/src/v1alpha/engine_service_client.d.ts +375 -2
  59. package/build/src/v1alpha/engine_service_client.js +514 -0
  60. package/build/src/v1alpha/estimate_billing_service_client.d.ts +1367 -0
  61. package/build/src/v1alpha/estimate_billing_service_client.js +2028 -0
  62. package/build/src/v1alpha/estimate_billing_service_client_config.json +30 -0
  63. package/build/src/v1alpha/index.d.ts +4 -0
  64. package/build/src/v1alpha/index.js +9 -1
  65. package/build/src/v1alpha/recommendation_service_client.d.ts +231 -1
  66. package/build/src/v1alpha/recommendation_service_client.js +316 -0
  67. package/build/src/v1alpha/schema_service_client.d.ts +372 -0
  68. package/build/src/v1alpha/schema_service_client.js +514 -0
  69. package/build/src/v1alpha/search_service_client.d.ts +258 -15
  70. package/build/src/v1alpha/search_service_client.js +336 -10
  71. package/build/src/v1alpha/search_tuning_service_client.d.ts +373 -1
  72. package/build/src/v1alpha/search_tuning_service_client.js +514 -0
  73. package/build/src/v1alpha/serving_config_service_client.d.ts +1369 -0
  74. package/build/src/v1alpha/serving_config_service_client.js +1935 -0
  75. package/build/src/v1alpha/serving_config_service_client_config.json +38 -0
  76. package/build/src/v1alpha/site_search_engine_service_client.d.ts +372 -0
  77. package/build/src/v1alpha/site_search_engine_service_client.js +514 -0
  78. package/build/src/v1alpha/user_event_service_client.d.ts +372 -0
  79. package/build/src/v1alpha/user_event_service_client.js +514 -0
  80. package/build/src/v1beta/completion_service_client.d.ts +75 -0
  81. package/build/src/v1beta/completion_service_client.js +104 -0
  82. package/build/src/v1beta/conversational_search_service_client.d.ts +79 -0
  83. package/build/src/v1beta/conversational_search_service_client.js +104 -0
  84. package/build/src/v1beta/data_store_service_client.d.ts +75 -0
  85. package/build/src/v1beta/data_store_service_client.js +104 -0
  86. package/build/src/v1beta/document_service_client.d.ts +75 -0
  87. package/build/src/v1beta/document_service_client.js +104 -0
  88. package/build/src/v1beta/engine_service_client.d.ts +75 -0
  89. package/build/src/v1beta/engine_service_client.js +104 -0
  90. package/build/src/v1beta/index.d.ts +1 -0
  91. package/build/src/v1beta/index.js +3 -1
  92. package/build/src/v1beta/recommendation_service_client.d.ts +75 -0
  93. package/build/src/v1beta/recommendation_service_client.js +104 -0
  94. package/build/src/v1beta/schema_service_client.d.ts +75 -0
  95. package/build/src/v1beta/schema_service_client.js +104 -0
  96. package/build/src/v1beta/search_service_client.d.ts +81 -0
  97. package/build/src/v1beta/search_service_client.js +108 -0
  98. package/build/src/v1beta/search_tuning_service_client.d.ts +1196 -0
  99. package/build/src/v1beta/search_tuning_service_client.js +1781 -0
  100. package/build/src/v1beta/search_tuning_service_client_config.json +30 -0
  101. package/build/src/v1beta/serving_config_service_client.d.ts +123 -8
  102. package/build/src/v1beta/serving_config_service_client.js +166 -5
  103. package/build/src/v1beta/site_search_engine_service_client.d.ts +75 -0
  104. package/build/src/v1beta/site_search_engine_service_client.js +104 -0
  105. package/build/src/v1beta/user_event_service_client.d.ts +75 -0
  106. package/build/src/v1beta/user_event_service_client.js +104 -0
  107. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.4.1](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.4.0...discoveryengine-v1.4.1) (2024-03-12)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * [discoveryengine] `http_uri` fix for method `ListChunks` in service `ChunkService` ([#5120](https://github.com/googleapis/google-cloud-node/issues/5120)) ([494a98f](https://github.com/googleapis/google-cloud-node/commit/494a98f6b4908f89eedcc05db68bb6af99dc02cb))
9
+
3
10
  ## [1.4.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.3.1...discoveryengine-v1.4.0) (2024-02-09)
4
11
 
5
12
 
package/README.md CHANGED
@@ -172,7 +172,13 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
172
172
  | User_event_service.collect_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/user_event_service.collect_user_event.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/user_event_service.collect_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
173
173
  | User_event_service.import_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/user_event_service.import_user_events.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/user_event_service.import_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |
174
174
  | User_event_service.write_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/user_event_service.write_user_event.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/user_event_service.write_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
175
+ | Acl_config_service.get_acl_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/acl_config_service.get_acl_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/acl_config_service.get_acl_config.js,packages/google-cloud-discoveryengine/samples/README.md) |
176
+ | Acl_config_service.update_acl_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/acl_config_service.update_acl_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/acl_config_service.update_acl_config.js,packages/google-cloud-discoveryengine/samples/README.md) |
177
+ | Chunk_service.get_chunk | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/chunk_service.get_chunk.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/chunk_service.get_chunk.js,packages/google-cloud-discoveryengine/samples/README.md) |
178
+ | Chunk_service.list_chunks | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/chunk_service.list_chunks.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/chunk_service.list_chunks.js,packages/google-cloud-discoveryengine/samples/README.md) |
175
179
  | Completion_service.complete_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.complete_query.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.complete_query.js,packages/google-cloud-discoveryengine/samples/README.md) |
180
+ | Completion_service.import_suggestion_deny_list_entries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.import_suggestion_deny_list_entries.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.import_suggestion_deny_list_entries.js,packages/google-cloud-discoveryengine/samples/README.md) |
181
+ | Completion_service.purge_suggestion_deny_list_entries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.purge_suggestion_deny_list_entries.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.purge_suggestion_deny_list_entries.js,packages/google-cloud-discoveryengine/samples/README.md) |
176
182
  | Conversational_search_service.converse_conversation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/conversational_search_service.converse_conversation.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/conversational_search_service.converse_conversation.js,packages/google-cloud-discoveryengine/samples/README.md) |
177
183
  | Conversational_search_service.create_conversation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/conversational_search_service.create_conversation.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/conversational_search_service.create_conversation.js,packages/google-cloud-discoveryengine/samples/README.md) |
178
184
  | Conversational_search_service.delete_conversation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/conversational_search_service.delete_conversation.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/conversational_search_service.delete_conversation.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -182,8 +188,10 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
182
188
  | Data_store_service.create_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.create_data_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.create_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
183
189
  | Data_store_service.delete_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.delete_data_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.delete_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
184
190
  | Data_store_service.get_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.get_data_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.get_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
191
+ | Data_store_service.get_document_processing_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.get_document_processing_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.get_document_processing_config.js,packages/google-cloud-discoveryengine/samples/README.md) |
185
192
  | Data_store_service.list_data_stores | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.list_data_stores.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.list_data_stores.js,packages/google-cloud-discoveryengine/samples/README.md) |
186
193
  | Data_store_service.update_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.update_data_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.update_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
194
+ | Data_store_service.update_document_processing_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.update_document_processing_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.update_document_processing_config.js,packages/google-cloud-discoveryengine/samples/README.md) |
187
195
  | Document_service.create_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.create_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.create_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
188
196
  | Document_service.delete_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.delete_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.delete_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
189
197
  | Document_service.get_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.get_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.get_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -199,6 +207,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
199
207
  | Engine_service.resume_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/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/v1alpha/engine_service.resume_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
200
208
  | 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) |
201
209
  | 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) |
210
+ | 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) |
202
211
  | 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) |
203
212
  | 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) |
204
213
  | 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) |
@@ -207,6 +216,9 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
207
216
  | Schema_service.update_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.update_schema.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.update_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
208
217
  | Search_service.search | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/search_service.search.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/search_service.search.js,packages/google-cloud-discoveryengine/samples/README.md) |
209
218
  | Search_tuning_service.train_custom_model | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/search_tuning_service.train_custom_model.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/search_tuning_service.train_custom_model.js,packages/google-cloud-discoveryengine/samples/README.md) |
219
+ | Serving_config_service.get_serving_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/serving_config_service.get_serving_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/serving_config_service.get_serving_config.js,packages/google-cloud-discoveryengine/samples/README.md) |
220
+ | Serving_config_service.list_serving_configs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/serving_config_service.list_serving_configs.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/serving_config_service.list_serving_configs.js,packages/google-cloud-discoveryengine/samples/README.md) |
221
+ | Serving_config_service.update_serving_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/serving_config_service.update_serving_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/serving_config_service.update_serving_config.js,packages/google-cloud-discoveryengine/samples/README.md) |
210
222
  | Site_search_engine_service.batch_create_target_sites | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.batch_create_target_sites.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.batch_create_target_sites.js,packages/google-cloud-discoveryengine/samples/README.md) |
211
223
  | Site_search_engine_service.batch_verify_target_sites | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.batch_verify_target_sites.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.batch_verify_target_sites.js,packages/google-cloud-discoveryengine/samples/README.md) |
212
224
  | Site_search_engine_service.create_target_site | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.create_target_site.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.create_target_site.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -256,6 +268,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
256
268
  | Schema_service.list_schemas | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/schema_service.list_schemas.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/schema_service.list_schemas.js,packages/google-cloud-discoveryengine/samples/README.md) |
257
269
  | Schema_service.update_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/schema_service.update_schema.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/schema_service.update_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
258
270
  | Search_service.search | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/search_service.search.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/search_service.search.js,packages/google-cloud-discoveryengine/samples/README.md) |
271
+ | Search_tuning_service.train_custom_model | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/search_tuning_service.train_custom_model.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/search_tuning_service.train_custom_model.js,packages/google-cloud-discoveryengine/samples/README.md) |
259
272
  | Serving_config_service.get_serving_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/serving_config_service.get_serving_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/serving_config_service.get_serving_config.js,packages/google-cloud-discoveryengine/samples/README.md) |
260
273
  | Serving_config_service.list_serving_configs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/serving_config_service.list_serving_configs.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/serving_config_service.list_serving_configs.js,packages/google-cloud-discoveryengine/samples/README.md) |
261
274
  | Serving_config_service.update_serving_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/serving_config_service.update_serving_config.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/serving_config_service.update_serving_config.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -0,0 +1,49 @@
1
+ // Copyright 2022 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/common.proto";
22
+
23
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
24
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
25
+ option java_multiple_files = true;
26
+ option java_outer_classname = "AclConfigProto";
27
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
28
+ option objc_class_prefix = "DISCOVERYENGINE";
29
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
30
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
31
+
32
+ // Access Control Configuration.
33
+ message AclConfig {
34
+ option (google.api.resource) = {
35
+ type: "discoveryengine.googleapis.com/AclConfig"
36
+ pattern: "projects/{project}/locations/{location}/aclConfig"
37
+ };
38
+
39
+ // Immutable. The full resource name of the acl configuration.
40
+ // Format:
41
+ // `projects/{project}/locations/{location}/aclConfig`.
42
+ //
43
+ // This field must be a UTF-8 encoded string with a length limit of 1024
44
+ // characters.
45
+ string name = 1 [(google.api.field_behavior) = IMMUTABLE];
46
+
47
+ // Identity provider config.
48
+ IdpConfig idp_config = 2;
49
+ }
@@ -0,0 +1,79 @@
1
+ // Copyright 2022 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/acl_config.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 = "AclConfigServiceProto";
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
+ // Service for managing Acl Configuration.
35
+ service AclConfigService {
36
+ option (google.api.default_host) = "discoveryengine.googleapis.com";
37
+ option (google.api.oauth_scopes) =
38
+ "https://www.googleapis.com/auth/cloud-platform";
39
+
40
+ // Default Acl Configuration for use in a location of a customer's project.
41
+ // Updates will only reflect to new data stores. Existing data stores will
42
+ // still use the old value.
43
+ rpc UpdateAclConfig(UpdateAclConfigRequest) returns (AclConfig) {
44
+ option (google.api.http) = {
45
+ patch: "/v1alpha/{acl_config.name=projects/*/locations/*/aclConfig}"
46
+ body: "acl_config"
47
+ };
48
+ }
49
+
50
+ // Gets the [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig].
51
+ rpc GetAclConfig(GetAclConfigRequest) returns (AclConfig) {
52
+ option (google.api.http) = {
53
+ get: "/v1alpha/{name=projects/*/locations/*/aclConfig}"
54
+ };
55
+ option (google.api.method_signature) = "name";
56
+ }
57
+ }
58
+
59
+ // Request message for GetAclConfigRequest method.
60
+ message GetAclConfigRequest {
61
+ // Required. Resource name of
62
+ // [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], such as
63
+ // `projects/*/locations/*/aclConfig`.
64
+ //
65
+ // If the caller does not have permission to access the
66
+ // [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], regardless of
67
+ // whether or not it exists, a PERMISSION_DENIED error is returned.
68
+ string name = 1 [
69
+ (google.api.field_behavior) = REQUIRED,
70
+ (google.api.resource_reference) = {
71
+ type: "discoveryengine.googleapis.com/AclConfig"
72
+ }
73
+ ];
74
+ }
75
+
76
+ // Request message for UpdateAclConfig method.
77
+ message UpdateAclConfigRequest {
78
+ AclConfig acl_config = 1 [(google.api.field_behavior) = REQUIRED];
79
+ }
@@ -0,0 +1,72 @@
1
+ // Copyright 2022 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/protobuf/struct.proto";
22
+
23
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
24
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
25
+ option java_multiple_files = true;
26
+ option java_outer_classname = "ChunkProto";
27
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
28
+ option objc_class_prefix = "DISCOVERYENGINE";
29
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
30
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
31
+
32
+ // Chunk captures all raw metadata information of items to be recommended or
33
+ // searched in the chunk mode.
34
+ message Chunk {
35
+ option (google.api.resource) = {
36
+ type: "discoveryengine.googleapis.com/Chunk"
37
+ pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}"
38
+ pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}"
39
+ };
40
+
41
+ // Document metadata contains the information of the document of the current
42
+ // chunk.
43
+ message DocumentMetadata {
44
+ // Uri of the document.
45
+ string uri = 1;
46
+
47
+ // Title of the document.
48
+ string title = 2;
49
+ }
50
+
51
+ // The full resource name of the chunk.
52
+ // Format:
53
+ // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`.
54
+ //
55
+ // This field must be a UTF-8 encoded string with a length limit of 1024
56
+ // characters.
57
+ string name = 1;
58
+
59
+ // Unique chunk id of the current chunk.
60
+ string id = 2;
61
+
62
+ // Content is a string from a document (parsed content).
63
+ string content = 3;
64
+
65
+ // Metadata of the document from the current chunk.
66
+ DocumentMetadata document_metadata = 5;
67
+
68
+ // Output only. This field is OUTPUT_ONLY.
69
+ // It contains derived data that are not in the original input document.
70
+ google.protobuf.Struct derived_struct_data = 4
71
+ [(google.api.field_behavior) = OUTPUT_ONLY];
72
+ }
@@ -0,0 +1,137 @@
1
+ // Copyright 2022 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/chunk.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 = "ChunkServiceProto";
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
+ // Service for displaying processed
35
+ // [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] information of the
36
+ // customer's unstructured data.
37
+ service ChunkService {
38
+ option (google.api.default_host) = "discoveryengine.googleapis.com";
39
+ option (google.api.oauth_scopes) =
40
+ "https://www.googleapis.com/auth/cloud-platform";
41
+
42
+ // Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].
43
+ rpc GetChunk(GetChunkRequest) returns (Chunk) {
44
+ option (google.api.http) = {
45
+ get: "/v1alpha/{name=projects/*/locations/*/dataStores/*/branches/*/documents/*/chunks/*}"
46
+ additional_bindings {
47
+ get: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*/chunks/*}"
48
+ }
49
+ };
50
+ option (google.api.method_signature) = "name";
51
+ }
52
+
53
+ // Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
54
+ rpc ListChunks(ListChunksRequest) returns (ListChunksResponse) {
55
+ option (google.api.http) = {
56
+ get: "/v1alpha/{parent=projects/*/locations/*/dataStores/*/branches/*/documents/*}/chunks"
57
+ additional_bindings {
58
+ get: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}/chunks"
59
+ }
60
+ };
61
+ option (google.api.method_signature) = "parent";
62
+ }
63
+ }
64
+
65
+ // Request message for
66
+ // [ChunkService.GetChunk][google.cloud.discoveryengine.v1alpha.ChunkService.GetChunk]
67
+ // method.
68
+ message GetChunkRequest {
69
+ // Required. Full resource name of
70
+ // [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], such as
71
+ // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`.
72
+ //
73
+ // If the caller does not have permission to access the
74
+ // [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], regardless of whether
75
+ // or not it exists, a `PERMISSION_DENIED` error is returned.
76
+ //
77
+ // If the requested [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] does
78
+ // not exist, a `NOT_FOUND` error is returned.
79
+ string name = 1 [
80
+ (google.api.field_behavior) = REQUIRED,
81
+ (google.api.resource_reference) = {
82
+ type: "discoveryengine.googleapis.com/Chunk"
83
+ }
84
+ ];
85
+ }
86
+
87
+ // Request message for
88
+ // [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks]
89
+ // method.
90
+ message ListChunksRequest {
91
+ // Required. The parent document resource name, such as
92
+ // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
93
+ //
94
+ // If the caller does not have permission to list
95
+ // [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s under this document,
96
+ // regardless of whether or not this document exists, a `PERMISSION_DENIED`
97
+ // error is returned.
98
+ string parent = 1 [
99
+ (google.api.field_behavior) = REQUIRED,
100
+ (google.api.resource_reference) = {
101
+ type: "discoveryengine.googleapis.com/Document"
102
+ }
103
+ ];
104
+
105
+ // Maximum number of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s to
106
+ // return. If unspecified, defaults to 100. The maximum allowed value is 1000.
107
+ // Values above 1000 will be coerced to 1000.
108
+ //
109
+ // If this field is negative, an `INVALID_ARGUMENT` error is returned.
110
+ int32 page_size = 2;
111
+
112
+ // A page token
113
+ // [ListChunksResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListChunksResponse.next_page_token],
114
+ // received from a previous
115
+ // [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks]
116
+ // call. Provide this to retrieve the subsequent page.
117
+ //
118
+ // When paginating, all other parameters provided to
119
+ // [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks]
120
+ // must match the call that provided the page token. Otherwise, an
121
+ // `INVALID_ARGUMENT` error is returned.
122
+ string page_token = 3;
123
+ }
124
+
125
+ // Response message for
126
+ // [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks]
127
+ // method.
128
+ message ListChunksResponse {
129
+ // The [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
130
+ repeated Chunk chunks = 1;
131
+
132
+ // A token that can be sent as
133
+ // [ListChunksRequest.page_token][google.cloud.discoveryengine.v1alpha.ListChunksRequest.page_token]
134
+ // to retrieve the next page. If this field is omitted, there are no
135
+ // subsequent pages.
136
+ string next_page_token = 2;
137
+ }
@@ -36,10 +36,8 @@ option (google.api.resource_definition) = {
36
36
  pattern: "projects/{project}/locations/{location}/collections/{collection}"
37
37
  };
38
38
  option (google.api.resource_definition) = {
39
- type: "discoveryengine.googleapis.com/ServingConfig"
40
- pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}"
41
- pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}"
42
- pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}"
39
+ type: "discoveryengine.googleapis.com/Location"
40
+ pattern: "projects/{project}/locations/{location}"
43
41
  };
44
42
 
45
43
  // The industry vertical associated with the
@@ -178,8 +176,83 @@ message UserInfo {
178
176
  string user_agent = 2;
179
177
  }
180
178
 
179
+ // Defines embedding config, used for bring your own embeddings feature.
180
+ message EmbeddingConfig {
181
+ // Full field path in the schema mapped as embedding field.
182
+ string field_path = 1;
183
+ }
184
+
181
185
  // Double list.
182
186
  message DoubleList {
183
187
  // Double values.
184
188
  repeated double values = 1;
185
189
  }
190
+
191
+ // Defines guided search spec.
192
+ message GuidedSearchSpec {
193
+ // Whether or not to enable and include refinement attributes in gudied search
194
+ // result.
195
+ bool enable_refinement_attributes = 1;
196
+
197
+ // Whether or not to enable and include related questions in search response.
198
+ bool enable_related_questions = 2;
199
+
200
+ // Max number of related questions to be returned. The valid range is [1, 5].
201
+ // If enable_related_questions is true, the default value is 3.
202
+ int32 max_related_questions = 3;
203
+ }
204
+
205
+ // Defines custom fine tuning spec.
206
+ message CustomFineTuningSpec {
207
+ // Whether or not to enable and include custom fine tuned search adaptor
208
+ // model.
209
+ bool enable_search_adaptor = 1;
210
+ }
211
+
212
+ // Identity Provider Config.
213
+ message IdpConfig {
214
+ // Third party IDP Config.
215
+ message ExternalIdpConfig {
216
+ // Workforce pool name.
217
+ // Example: "locations/global/workforcePools/pool_id"
218
+ string workforce_pool_name = 1;
219
+ }
220
+
221
+ // Identity Provider Type.
222
+ enum IdpType {
223
+ // Default value. ACL search not enabled.
224
+ IDP_TYPE_UNSPECIFIED = 0;
225
+
226
+ // Google 1P provider.
227
+ GSUITE = 1;
228
+
229
+ // Third party provider.
230
+ THIRD_PARTY = 2;
231
+ }
232
+
233
+ // Identity provider type configured.
234
+ IdpType idp_type = 1;
235
+
236
+ // External Identity provider config.
237
+ ExternalIdpConfig external_idp_config = 2;
238
+ }
239
+
240
+ // Principal identifier of a user or a group.
241
+ message Principal {
242
+ // Union field principal. Principal can be a user or a group.
243
+ oneof principal {
244
+ // User identifier.
245
+ // For Google Workspace user account, user_id should be the google workspace
246
+ // user email.
247
+ // For non-google identity provider user account, user_id is the mapped user
248
+ // identifier configured during the workforcepool config.
249
+ string user_id = 1;
250
+
251
+ // Group identifier.
252
+ // For Google Workspace user account, group_id should be the google
253
+ // workspace group email.
254
+ // For non-google identity provider user account, group_id is the mapped
255
+ // group identifier configured during the workforcepool config.
256
+ string group_id = 2;
257
+ }
258
+ }
@@ -0,0 +1,52 @@
1
+ // Copyright 2022 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
+
21
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
22
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
23
+ option java_multiple_files = true;
24
+ option java_outer_classname = "CompletionProto";
25
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
26
+ option objc_class_prefix = "DISCOVERYENGINE";
27
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
28
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
29
+
30
+ // Suggestion deny list entry identifying the phrase to block from suggestions
31
+ // and the applied operation for the phrase.
32
+ message SuggestionDenyListEntry {
33
+ // Operator for matching with the generated suggestions.
34
+ enum MatchOperator {
35
+ // Default value. Should not be used
36
+ MATCH_OPERATOR_UNSPECIFIED = 0;
37
+
38
+ // If the suggestion is an exact match to the block_phrase, then block it.
39
+ EXACT_MATCH = 1;
40
+
41
+ // If the suggestion contains the block_phrase, then block it.
42
+ CONTAINS = 2;
43
+ }
44
+
45
+ // Required. Phrase to block from suggestions served. Can be maximum 125
46
+ // characters.
47
+ string block_phrase = 1 [(google.api.field_behavior) = REQUIRED];
48
+
49
+ // Required. The match operator to apply for this phrase. Whether to block the
50
+ // exact phrase, or block any suggestions containing this phrase.
51
+ MatchOperator match_operator = 2 [(google.api.field_behavior) = REQUIRED];
52
+ }