@google-cloud/discoveryengine 2.3.0 → 2.4.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 (228) hide show
  1. package/README.md +17 -0
  2. package/build/protos/google/cloud/discoveryengine/v1/assist_answer.proto +251 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/assistant.proto +44 -0
  4. package/build/protos/google/cloud/discoveryengine/v1/assistant_service.proto +217 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +15 -3
  6. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +8 -14
  7. package/build/protos/google/cloud/discoveryengine/v1/session.proto +21 -8
  8. package/build/protos/google/cloud/discoveryengine/v1/session_service.proto +128 -0
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +15 -0
  10. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +30 -9
  11. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +8 -14
  12. package/build/protos/google/cloud/discoveryengine/v1alpha/session.proto +238 -8
  13. package/build/protos/google/cloud/discoveryengine/v1alpha/session_service.proto +201 -0
  14. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +26 -5
  15. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +8 -14
  16. package/build/protos/google/cloud/discoveryengine/v1beta/session.proto +40 -8
  17. package/build/protos/google/cloud/discoveryengine/v1beta/session_service.proto +128 -0
  18. package/build/protos/protos.d.ts +15057 -10636
  19. package/build/protos/protos.js +45523 -34174
  20. package/build/protos/protos.json +4835 -3203
  21. package/build/src/index.d.ts +7 -1
  22. package/build/src/index.js +6 -2
  23. package/build/src/v1/assistant_service_client.d.ts +2058 -0
  24. package/build/src/v1/assistant_service_client.js +2957 -0
  25. package/build/src/v1/assistant_service_client_config.json +43 -0
  26. package/build/src/v1/assistant_service_proto_list.json +48 -0
  27. package/build/src/v1/cmek_config_service_client.d.ts +255 -144
  28. package/build/src/v1/cmek_config_service_client.js +348 -196
  29. package/build/src/v1/cmek_config_service_proto_list.json +4 -0
  30. package/build/src/v1/completion_service_client.d.ts +255 -144
  31. package/build/src/v1/completion_service_client.js +348 -196
  32. package/build/src/v1/completion_service_proto_list.json +4 -0
  33. package/build/src/v1/control_service_client.d.ts +255 -144
  34. package/build/src/v1/control_service_client.js +348 -196
  35. package/build/src/v1/control_service_proto_list.json +4 -0
  36. package/build/src/v1/conversational_search_service_client.d.ts +302 -155
  37. package/build/src/v1/conversational_search_service_client.js +380 -204
  38. package/build/src/v1/conversational_search_service_proto_list.json +4 -0
  39. package/build/src/v1/data_store_service_client.d.ts +255 -144
  40. package/build/src/v1/data_store_service_client.js +348 -196
  41. package/build/src/v1/data_store_service_proto_list.json +4 -0
  42. package/build/src/v1/document_service_client.d.ts +255 -144
  43. package/build/src/v1/document_service_client.js +348 -196
  44. package/build/src/v1/document_service_proto_list.json +4 -0
  45. package/build/src/v1/engine_service_client.d.ts +255 -144
  46. package/build/src/v1/engine_service_client.js +348 -196
  47. package/build/src/v1/engine_service_proto_list.json +4 -0
  48. package/build/src/v1/gapic_metadata.json +86 -0
  49. package/build/src/v1/grounded_generation_service_client.d.ts +255 -144
  50. package/build/src/v1/grounded_generation_service_client.js +348 -196
  51. package/build/src/v1/grounded_generation_service_proto_list.json +4 -0
  52. package/build/src/v1/identity_mapping_store_service_client.d.ts +255 -144
  53. package/build/src/v1/identity_mapping_store_service_client.js +348 -196
  54. package/build/src/v1/identity_mapping_store_service_proto_list.json +4 -0
  55. package/build/src/v1/index.d.ts +2 -0
  56. package/build/src/v1/index.js +5 -1
  57. package/build/src/v1/project_service_client.d.ts +255 -144
  58. package/build/src/v1/project_service_client.js +348 -196
  59. package/build/src/v1/project_service_proto_list.json +4 -0
  60. package/build/src/v1/rank_service_client.d.ts +255 -144
  61. package/build/src/v1/rank_service_client.js +348 -196
  62. package/build/src/v1/rank_service_proto_list.json +4 -0
  63. package/build/src/v1/recommendation_service_client.d.ts +255 -144
  64. package/build/src/v1/recommendation_service_client.js +348 -196
  65. package/build/src/v1/recommendation_service_proto_list.json +4 -0
  66. package/build/src/v1/schema_service_client.d.ts +255 -144
  67. package/build/src/v1/schema_service_client.js +348 -196
  68. package/build/src/v1/schema_service_proto_list.json +4 -0
  69. package/build/src/v1/search_service_client.d.ts +303 -228
  70. package/build/src/v1/search_service_client.js +380 -252
  71. package/build/src/v1/search_service_proto_list.json +4 -0
  72. package/build/src/v1/search_tuning_service_client.d.ts +255 -144
  73. package/build/src/v1/search_tuning_service_client.js +348 -196
  74. package/build/src/v1/search_tuning_service_proto_list.json +4 -0
  75. package/build/src/v1/serving_config_service_client.d.ts +255 -144
  76. package/build/src/v1/serving_config_service_client.js +348 -196
  77. package/build/src/v1/serving_config_service_proto_list.json +4 -0
  78. package/build/src/v1/session_service_client.d.ts +2326 -0
  79. package/build/src/v1/session_service_client.js +3218 -0
  80. package/build/src/v1/session_service_client_config.json +63 -0
  81. package/build/src/v1/session_service_proto_list.json +48 -0
  82. package/build/src/v1/site_search_engine_service_client.d.ts +255 -144
  83. package/build/src/v1/site_search_engine_service_client.js +348 -196
  84. package/build/src/v1/site_search_engine_service_proto_list.json +4 -0
  85. package/build/src/v1/user_event_service_client.d.ts +255 -144
  86. package/build/src/v1/user_event_service_client.js +348 -196
  87. package/build/src/v1/user_event_service_proto_list.json +4 -0
  88. package/build/src/v1/user_license_service_client.d.ts +255 -144
  89. package/build/src/v1/user_license_service_client.js +348 -196
  90. package/build/src/v1/user_license_service_proto_list.json +4 -0
  91. package/build/src/v1alpha/acl_config_service_client.d.ts +144 -144
  92. package/build/src/v1alpha/acl_config_service_client.js +196 -196
  93. package/build/src/v1alpha/acl_config_service_proto_list.json +1 -0
  94. package/build/src/v1alpha/chunk_service_client.d.ts +144 -144
  95. package/build/src/v1alpha/chunk_service_client.js +196 -196
  96. package/build/src/v1alpha/chunk_service_proto_list.json +1 -0
  97. package/build/src/v1alpha/completion_service_client.d.ts +144 -144
  98. package/build/src/v1alpha/completion_service_client.js +196 -196
  99. package/build/src/v1alpha/completion_service_proto_list.json +1 -0
  100. package/build/src/v1alpha/control_service_client.d.ts +144 -144
  101. package/build/src/v1alpha/control_service_client.js +196 -196
  102. package/build/src/v1alpha/control_service_proto_list.json +1 -0
  103. package/build/src/v1alpha/conversational_search_service_client.d.ts +221 -167
  104. package/build/src/v1alpha/conversational_search_service_client.js +244 -210
  105. package/build/src/v1alpha/conversational_search_service_proto_list.json +1 -0
  106. package/build/src/v1alpha/data_store_service_client.d.ts +144 -144
  107. package/build/src/v1alpha/data_store_service_client.js +196 -196
  108. package/build/src/v1alpha/data_store_service_proto_list.json +1 -0
  109. package/build/src/v1alpha/document_service_client.d.ts +144 -144
  110. package/build/src/v1alpha/document_service_client.js +196 -196
  111. package/build/src/v1alpha/document_service_proto_list.json +1 -0
  112. package/build/src/v1alpha/engine_service_client.d.ts +144 -144
  113. package/build/src/v1alpha/engine_service_client.js +196 -196
  114. package/build/src/v1alpha/engine_service_proto_list.json +1 -0
  115. package/build/src/v1alpha/estimate_billing_service_client.d.ts +144 -144
  116. package/build/src/v1alpha/estimate_billing_service_client.js +196 -196
  117. package/build/src/v1alpha/estimate_billing_service_proto_list.json +1 -0
  118. package/build/src/v1alpha/evaluation_service_client.d.ts +144 -144
  119. package/build/src/v1alpha/evaluation_service_client.js +196 -196
  120. package/build/src/v1alpha/evaluation_service_proto_list.json +1 -0
  121. package/build/src/v1alpha/gapic_metadata.json +82 -0
  122. package/build/src/v1alpha/grounded_generation_service_client.d.ts +144 -144
  123. package/build/src/v1alpha/grounded_generation_service_client.js +196 -196
  124. package/build/src/v1alpha/grounded_generation_service_proto_list.json +1 -0
  125. package/build/src/v1alpha/index.d.ts +1 -0
  126. package/build/src/v1alpha/index.js +3 -1
  127. package/build/src/v1alpha/project_service_client.d.ts +144 -144
  128. package/build/src/v1alpha/project_service_client.js +196 -196
  129. package/build/src/v1alpha/project_service_proto_list.json +1 -0
  130. package/build/src/v1alpha/rank_service_client.d.ts +144 -144
  131. package/build/src/v1alpha/rank_service_client.js +196 -196
  132. package/build/src/v1alpha/rank_service_proto_list.json +1 -0
  133. package/build/src/v1alpha/recommendation_service_client.d.ts +144 -144
  134. package/build/src/v1alpha/recommendation_service_client.js +196 -196
  135. package/build/src/v1alpha/recommendation_service_proto_list.json +1 -0
  136. package/build/src/v1alpha/sample_query_service_client.d.ts +144 -144
  137. package/build/src/v1alpha/sample_query_service_client.js +196 -196
  138. package/build/src/v1alpha/sample_query_service_proto_list.json +1 -0
  139. package/build/src/v1alpha/sample_query_set_service_client.d.ts +144 -144
  140. package/build/src/v1alpha/sample_query_set_service_client.js +196 -196
  141. package/build/src/v1alpha/sample_query_set_service_proto_list.json +1 -0
  142. package/build/src/v1alpha/schema_service_client.d.ts +144 -144
  143. package/build/src/v1alpha/schema_service_client.js +196 -196
  144. package/build/src/v1alpha/schema_service_proto_list.json +1 -0
  145. package/build/src/v1alpha/search_service_client.d.ts +168 -186
  146. package/build/src/v1alpha/search_service_client.js +212 -224
  147. package/build/src/v1alpha/search_service_proto_list.json +1 -0
  148. package/build/src/v1alpha/search_tuning_service_client.d.ts +144 -144
  149. package/build/src/v1alpha/search_tuning_service_client.js +196 -196
  150. package/build/src/v1alpha/search_tuning_service_proto_list.json +1 -0
  151. package/build/src/v1alpha/serving_config_service_client.d.ts +144 -144
  152. package/build/src/v1alpha/serving_config_service_client.js +196 -196
  153. package/build/src/v1alpha/serving_config_service_proto_list.json +1 -0
  154. package/build/src/v1alpha/session_service_client.d.ts +2331 -0
  155. package/build/src/v1alpha/session_service_client.js +3161 -0
  156. package/build/src/v1alpha/session_service_client_config.json +68 -0
  157. package/build/src/v1alpha/session_service_proto_list.json +49 -0
  158. package/build/src/v1alpha/site_search_engine_service_client.d.ts +144 -144
  159. package/build/src/v1alpha/site_search_engine_service_client.js +196 -196
  160. package/build/src/v1alpha/site_search_engine_service_proto_list.json +1 -0
  161. package/build/src/v1alpha/user_event_service_client.d.ts +144 -144
  162. package/build/src/v1alpha/user_event_service_client.js +196 -196
  163. package/build/src/v1alpha/user_event_service_proto_list.json +1 -0
  164. package/build/src/v1beta/completion_service_client.d.ts +144 -144
  165. package/build/src/v1beta/completion_service_client.js +196 -196
  166. package/build/src/v1beta/completion_service_proto_list.json +1 -0
  167. package/build/src/v1beta/control_service_client.d.ts +144 -144
  168. package/build/src/v1beta/control_service_client.js +196 -196
  169. package/build/src/v1beta/control_service_proto_list.json +1 -0
  170. package/build/src/v1beta/conversational_search_service_client.d.ts +215 -161
  171. package/build/src/v1beta/conversational_search_service_client.js +242 -208
  172. package/build/src/v1beta/conversational_search_service_proto_list.json +1 -0
  173. package/build/src/v1beta/data_store_service_client.d.ts +144 -144
  174. package/build/src/v1beta/data_store_service_client.js +196 -196
  175. package/build/src/v1beta/data_store_service_proto_list.json +1 -0
  176. package/build/src/v1beta/document_service_client.d.ts +144 -144
  177. package/build/src/v1beta/document_service_client.js +196 -196
  178. package/build/src/v1beta/document_service_proto_list.json +1 -0
  179. package/build/src/v1beta/engine_service_client.d.ts +144 -144
  180. package/build/src/v1beta/engine_service_client.js +196 -196
  181. package/build/src/v1beta/engine_service_proto_list.json +1 -0
  182. package/build/src/v1beta/evaluation_service_client.d.ts +144 -144
  183. package/build/src/v1beta/evaluation_service_client.js +196 -196
  184. package/build/src/v1beta/evaluation_service_proto_list.json +1 -0
  185. package/build/src/v1beta/gapic_metadata.json +68 -0
  186. package/build/src/v1beta/grounded_generation_service_client.d.ts +144 -144
  187. package/build/src/v1beta/grounded_generation_service_client.js +196 -196
  188. package/build/src/v1beta/grounded_generation_service_proto_list.json +1 -0
  189. package/build/src/v1beta/index.d.ts +1 -0
  190. package/build/src/v1beta/index.js +3 -1
  191. package/build/src/v1beta/project_service_client.d.ts +144 -144
  192. package/build/src/v1beta/project_service_client.js +196 -196
  193. package/build/src/v1beta/project_service_proto_list.json +1 -0
  194. package/build/src/v1beta/rank_service_client.d.ts +144 -144
  195. package/build/src/v1beta/rank_service_client.js +196 -196
  196. package/build/src/v1beta/rank_service_proto_list.json +1 -0
  197. package/build/src/v1beta/recommendation_service_client.d.ts +144 -144
  198. package/build/src/v1beta/recommendation_service_client.js +196 -196
  199. package/build/src/v1beta/recommendation_service_proto_list.json +1 -0
  200. package/build/src/v1beta/sample_query_service_client.d.ts +144 -144
  201. package/build/src/v1beta/sample_query_service_client.js +196 -196
  202. package/build/src/v1beta/sample_query_service_proto_list.json +1 -0
  203. package/build/src/v1beta/sample_query_set_service_client.d.ts +144 -144
  204. package/build/src/v1beta/sample_query_set_service_client.js +196 -196
  205. package/build/src/v1beta/sample_query_set_service_proto_list.json +1 -0
  206. package/build/src/v1beta/schema_service_client.d.ts +144 -144
  207. package/build/src/v1beta/schema_service_client.js +196 -196
  208. package/build/src/v1beta/schema_service_proto_list.json +1 -0
  209. package/build/src/v1beta/search_service_client.d.ts +192 -228
  210. package/build/src/v1beta/search_service_client.js +228 -252
  211. package/build/src/v1beta/search_service_proto_list.json +1 -0
  212. package/build/src/v1beta/search_tuning_service_client.d.ts +144 -144
  213. package/build/src/v1beta/search_tuning_service_client.js +196 -196
  214. package/build/src/v1beta/search_tuning_service_proto_list.json +1 -0
  215. package/build/src/v1beta/serving_config_service_client.d.ts +144 -144
  216. package/build/src/v1beta/serving_config_service_client.js +196 -196
  217. package/build/src/v1beta/serving_config_service_proto_list.json +1 -0
  218. package/build/src/v1beta/session_service_client.d.ts +2266 -0
  219. package/build/src/v1beta/session_service_client.js +3136 -0
  220. package/build/src/v1beta/session_service_client_config.json +63 -0
  221. package/build/src/v1beta/session_service_proto_list.json +45 -0
  222. package/build/src/v1beta/site_search_engine_service_client.d.ts +144 -144
  223. package/build/src/v1beta/site_search_engine_service_client.js +196 -196
  224. package/build/src/v1beta/site_search_engine_service_proto_list.json +1 -0
  225. package/build/src/v1beta/user_event_service_client.d.ts +144 -144
  226. package/build/src/v1beta/user_event_service_client.js +196 -196
  227. package/build/src/v1beta/user_event_service_proto_list.json +1 -0
  228. package/package.json +1 -1
package/README.md CHANGED
@@ -125,6 +125,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
125
125
 
126
126
  | Sample | Source Code | Try it |
127
127
  | --------------------------- | --------------------------------- | ------ |
128
+ | Assistant_service.stream_assist | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/assistant_service.stream_assist.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/assistant_service.stream_assist.js,packages/google-cloud-discoveryengine/samples/README.md) |
128
129
  | Cmek_config_service.delete_cmek_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/cmek_config_service.delete_cmek_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/v1/cmek_config_service.delete_cmek_config.js,packages/google-cloud-discoveryengine/samples/README.md) |
129
130
  | Cmek_config_service.get_cmek_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/cmek_config_service.get_cmek_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/v1/cmek_config_service.get_cmek_config.js,packages/google-cloud-discoveryengine/samples/README.md) |
130
131
  | Cmek_config_service.list_cmek_configs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/cmek_config_service.list_cmek_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/v1/cmek_config_service.list_cmek_configs.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -194,6 +195,11 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
194
195
  | Search_tuning_service.list_custom_models | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/search_tuning_service.list_custom_models.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/search_tuning_service.list_custom_models.js,packages/google-cloud-discoveryengine/samples/README.md) |
195
196
  | Search_tuning_service.train_custom_model | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/search_tuning_service.train_custom_model.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/search_tuning_service.train_custom_model.js,packages/google-cloud-discoveryengine/samples/README.md) |
196
197
  | Serving_config_service.update_serving_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/serving_config_service.update_serving_config.js,packages/google-cloud-discoveryengine/samples/README.md) |
198
+ | Session_service.create_session | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/session_service.create_session.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/session_service.create_session.js,packages/google-cloud-discoveryengine/samples/README.md) |
199
+ | Session_service.delete_session | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/session_service.delete_session.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/session_service.delete_session.js,packages/google-cloud-discoveryengine/samples/README.md) |
200
+ | Session_service.get_session | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/session_service.get_session.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/session_service.get_session.js,packages/google-cloud-discoveryengine/samples/README.md) |
201
+ | Session_service.list_sessions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/session_service.list_sessions.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/session_service.list_sessions.js,packages/google-cloud-discoveryengine/samples/README.md) |
202
+ | Session_service.update_session | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/session_service.update_session.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/session_service.update_session.js,packages/google-cloud-discoveryengine/samples/README.md) |
197
203
  | Site_search_engine_service.batch_create_target_sites | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/site_search_engine_service.batch_create_target_sites.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/site_search_engine_service.batch_create_target_sites.js,packages/google-cloud-discoveryengine/samples/README.md) |
198
204
  | Site_search_engine_service.batch_verify_target_sites | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/site_search_engine_service.batch_verify_target_sites.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/site_search_engine_service.batch_verify_target_sites.js,packages/google-cloud-discoveryengine/samples/README.md) |
199
205
  | Site_search_engine_service.create_sitemap | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/site_search_engine_service.create_sitemap.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1/site_search_engine_service.create_sitemap.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -299,6 +305,12 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
299
305
  | 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) |
300
306
  | 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) |
301
307
  | 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) |
308
+ | Session_service.create_session | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/session_service.create_session.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/session_service.create_session.js,packages/google-cloud-discoveryengine/samples/README.md) |
309
+ | Session_service.delete_session | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/session_service.delete_session.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/session_service.delete_session.js,packages/google-cloud-discoveryengine/samples/README.md) |
310
+ | Session_service.get_session | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/session_service.get_session.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/session_service.get_session.js,packages/google-cloud-discoveryengine/samples/README.md) |
311
+ | Session_service.list_files | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/session_service.list_files.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/session_service.list_files.js,packages/google-cloud-discoveryengine/samples/README.md) |
312
+ | Session_service.list_sessions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/session_service.list_sessions.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/session_service.list_sessions.js,packages/google-cloud-discoveryengine/samples/README.md) |
313
+ | Session_service.update_session | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/session_service.update_session.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/session_service.update_session.js,packages/google-cloud-discoveryengine/samples/README.md) |
302
314
  | 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) |
303
315
  | 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) |
304
316
  | 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) |
@@ -395,6 +407,11 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
395
407
  | 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) |
396
408
  | 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) |
397
409
  | 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) |
410
+ | Session_service.create_session | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/session_service.create_session.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/session_service.create_session.js,packages/google-cloud-discoveryengine/samples/README.md) |
411
+ | Session_service.delete_session | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/session_service.delete_session.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/session_service.delete_session.js,packages/google-cloud-discoveryengine/samples/README.md) |
412
+ | Session_service.get_session | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/session_service.get_session.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/session_service.get_session.js,packages/google-cloud-discoveryengine/samples/README.md) |
413
+ | Session_service.list_sessions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/session_service.list_sessions.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/session_service.list_sessions.js,packages/google-cloud-discoveryengine/samples/README.md) |
414
+ | Session_service.update_session | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/session_service.update_session.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/session_service.update_session.js,packages/google-cloud-discoveryengine/samples/README.md) |
398
415
  | 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/v1beta/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/v1beta/site_search_engine_service.batch_create_target_sites.js,packages/google-cloud-discoveryengine/samples/README.md) |
399
416
  | 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/v1beta/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/v1beta/site_search_engine_service.batch_verify_target_sites.js,packages/google-cloud-discoveryengine/samples/README.md) |
400
417
  | Site_search_engine_service.create_sitemap | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/site_search_engine_service.create_sitemap.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/site_search_engine_service.create_sitemap.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -0,0 +1,251 @@
1
+ // Copyright 2025 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+
15
+ syntax = "proto3";
16
+
17
+ package google.cloud.discoveryengine.v1;
18
+
19
+ import "google/api/field_behavior.proto";
20
+ import "google/api/resource.proto";
21
+
22
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
23
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
24
+ option java_multiple_files = true;
25
+ option java_outer_classname = "AssistAnswerProto";
26
+ option java_package = "com.google.cloud.discoveryengine.v1";
27
+ option objc_class_prefix = "DISCOVERYENGINE";
28
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
29
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
30
+
31
+ // AssistAnswer resource, main part of
32
+ // [AssistResponse][google.cloud.discoveryengine.v1.AssistResponse].
33
+ message AssistAnswer {
34
+ option (google.api.resource) = {
35
+ type: "discoveryengine.googleapis.com/AssistAnswer"
36
+ pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}"
37
+ };
38
+
39
+ // One part of the multi-part response of the assist call.
40
+ message Reply {
41
+ // Alternatives for the assistant reply.
42
+ oneof reply {
43
+ // Possibly grounded response text or media from the assistant.
44
+ AssistantGroundedContent grounded_content = 1;
45
+ }
46
+ }
47
+
48
+ // State of the answer generation.
49
+ enum State {
50
+ // Unknown.
51
+ STATE_UNSPECIFIED = 0;
52
+
53
+ // Assist operation is currently in progress.
54
+ IN_PROGRESS = 1;
55
+
56
+ // Assist operation has failed.
57
+ FAILED = 2;
58
+
59
+ // Assist operation has succeeded.
60
+ SUCCEEDED = 3;
61
+
62
+ // Assist operation has been skipped.
63
+ SKIPPED = 4;
64
+ }
65
+
66
+ // Possible reasons for not answering an assist call.
67
+ enum AssistSkippedReason {
68
+ // Default value. Skip reason is not specified.
69
+ ASSIST_SKIPPED_REASON_UNSPECIFIED = 0;
70
+
71
+ // The assistant ignored the query, because it did not appear to be
72
+ // answer-seeking.
73
+ NON_ASSIST_SEEKING_QUERY_IGNORED = 1;
74
+
75
+ // The assistant ignored the query or refused to answer because of a
76
+ // customer policy violation (e.g., the query or the answer contained a
77
+ // banned phrase).
78
+ CUSTOMER_POLICY_VIOLATION = 2;
79
+ }
80
+
81
+ // Immutable. Resource name of the `AssistAnswer`.
82
+ // Format:
83
+ // `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`
84
+ //
85
+ // This field must be a UTF-8 encoded string with a length limit of 1024
86
+ // characters.
87
+ string name = 1 [(google.api.field_behavior) = IMMUTABLE];
88
+
89
+ // State of the answer generation.
90
+ State state = 2;
91
+
92
+ // Replies of the assistant.
93
+ repeated Reply replies = 3;
94
+
95
+ // Reasons for not answering the assist call.
96
+ repeated AssistSkippedReason assist_skipped_reasons = 5;
97
+ }
98
+
99
+ // Multi-modal content.
100
+ message AssistantContent {
101
+ // Inline blob.
102
+ message Blob {
103
+ // Required. The media type (MIME type) of the generated data.
104
+ string mime_type = 1 [(google.api.field_behavior) = REQUIRED];
105
+
106
+ // Required. Raw bytes.
107
+ bytes data = 2 [(google.api.field_behavior) = REQUIRED];
108
+ }
109
+
110
+ // A file, e.g., an audio summary.
111
+ message File {
112
+ // Required. The media type (MIME type) of the file.
113
+ string mime_type = 1 [(google.api.field_behavior) = REQUIRED];
114
+
115
+ // Required. The file ID.
116
+ string file_id = 2 [(google.api.field_behavior) = REQUIRED];
117
+ }
118
+
119
+ // Code generated by the model that is meant to be executed by the model.
120
+ message ExecutableCode {
121
+ // Required. The code content. Currently only supports Python.
122
+ string code = 2 [(google.api.field_behavior) = REQUIRED];
123
+ }
124
+
125
+ // Result of executing ExecutableCode.
126
+ message CodeExecutionResult {
127
+ // Enumeration of possible outcomes of the code execution.
128
+ enum Outcome {
129
+ // Unspecified status. This value should not be used.
130
+ OUTCOME_UNSPECIFIED = 0;
131
+
132
+ // Code execution completed successfully.
133
+ OUTCOME_OK = 1;
134
+
135
+ // Code execution finished but with a failure. `stderr` should contain the
136
+ // reason.
137
+ OUTCOME_FAILED = 2;
138
+
139
+ // Code execution ran for too long, and was cancelled. There may or may
140
+ // not be a partial output present.
141
+ OUTCOME_DEADLINE_EXCEEDED = 3;
142
+ }
143
+
144
+ // Required. Outcome of the code execution.
145
+ Outcome outcome = 1 [(google.api.field_behavior) = REQUIRED];
146
+
147
+ // Optional. Contains stdout when code execution is successful, stderr or
148
+ // other description otherwise.
149
+ string output = 2 [(google.api.field_behavior) = OPTIONAL];
150
+ }
151
+
152
+ // Contained data.
153
+ oneof data {
154
+ // Inline text.
155
+ string text = 2;
156
+
157
+ // Inline binary data.
158
+ Blob inline_data = 3;
159
+
160
+ // A file, e.g., an audio summary.
161
+ File file = 4;
162
+
163
+ // Code generated by the model that is meant to be executed.
164
+ ExecutableCode executable_code = 7;
165
+
166
+ // Result of executing an ExecutableCode.
167
+ CodeExecutionResult code_execution_result = 8;
168
+ }
169
+
170
+ // The producer of the content. Can be "model" or "user".
171
+ string role = 1;
172
+
173
+ // Optional. Indicates if the part is thought from the model.
174
+ bool thought = 6 [(google.api.field_behavior) = OPTIONAL];
175
+ }
176
+
177
+ // A piece of content and possibly its grounding information.
178
+ //
179
+ // Not all content needs grounding. Phrases like "Of course, I will gladly
180
+ // search it for you." do not need grounding.
181
+ message AssistantGroundedContent {
182
+ // Grounding details for text sources.
183
+ message TextGroundingMetadata {
184
+ // Grounding information for a segment of the text.
185
+ message Segment {
186
+ // Zero-based index indicating the start of the segment, measured in bytes
187
+ // of a UTF-8 string (i.e. characters encoded on multiple bytes have a
188
+ // length of more than one).
189
+ int64 start_index = 1;
190
+
191
+ // End of the segment, exclusive.
192
+ int64 end_index = 2;
193
+
194
+ // References for the segment.
195
+ repeated int32 reference_indices = 4;
196
+
197
+ // Score for the segment.
198
+ float grounding_score = 5;
199
+
200
+ // The text segment itself.
201
+ string text = 6;
202
+ }
203
+
204
+ // Referenced content and related document metadata.
205
+ message Reference {
206
+ // Document metadata.
207
+ message DocumentMetadata {
208
+ // Document resource name.
209
+ optional string document = 1 [(google.api.resource_reference) = {
210
+ type: "discoveryengine.googleapis.com/Document"
211
+ }];
212
+
213
+ // URI for the document. It may contain a URL that redirects to the
214
+ // actual website.
215
+ optional string uri = 2;
216
+
217
+ // Title.
218
+ optional string title = 3;
219
+
220
+ // Page identifier.
221
+ optional string page_identifier = 4;
222
+
223
+ // Domain name from the document URI. Note that the `uri` field may
224
+ // contain a URL that redirects to the actual website, in which case
225
+ // this will contain the domain name of the target site.
226
+ optional string domain = 5;
227
+ }
228
+
229
+ // Referenced text content.
230
+ string content = 1;
231
+
232
+ // Document metadata.
233
+ DocumentMetadata document_metadata = 2;
234
+ }
235
+
236
+ // Grounding information for parts of the text.
237
+ repeated Segment segments = 4;
238
+
239
+ // References for the grounded text.
240
+ repeated Reference references = 2;
241
+ }
242
+
243
+ // Grounding metadata for various modals. It only supports text for now.
244
+ oneof metadata {
245
+ // Metadata for grounding based on text sources.
246
+ TextGroundingMetadata text_grounding_metadata = 3;
247
+ }
248
+
249
+ // The content.
250
+ AssistantContent content = 1;
251
+ }
@@ -0,0 +1,44 @@
1
+ // Copyright 2025 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+
15
+ syntax = "proto3";
16
+
17
+ package google.cloud.discoveryengine.v1;
18
+
19
+ import "google/api/field_behavior.proto";
20
+ import "google/api/resource.proto";
21
+
22
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
23
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
24
+ option java_multiple_files = true;
25
+ option java_outer_classname = "AssistantProto";
26
+ option java_package = "com.google.cloud.discoveryengine.v1";
27
+ option objc_class_prefix = "DISCOVERYENGINE";
28
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
29
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
30
+
31
+ // Discovery Engine Assistant resource.
32
+ message Assistant {
33
+ option (google.api.resource) = {
34
+ type: "discoveryengine.googleapis.com/Assistant"
35
+ pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}"
36
+ };
37
+
38
+ // Immutable. Resource name of the assistant.
39
+ // Format:
40
+ // `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
41
+ //
42
+ // It must be a UTF-8 encoded string with a length limit of 1024 characters.
43
+ string name = 1 [(google.api.field_behavior) = IMMUTABLE];
44
+ }
@@ -0,0 +1,217 @@
1
+ // Copyright 2025 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+
15
+ syntax = "proto3";
16
+
17
+ package google.cloud.discoveryengine.v1;
18
+
19
+ import "google/api/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/v1/assist_answer.proto";
24
+ import "google/cloud/discoveryengine/v1/search_service.proto";
25
+ import "google/cloud/discoveryengine/v1/session.proto";
26
+
27
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
28
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
29
+ option java_multiple_files = true;
30
+ option java_outer_classname = "AssistantServiceProto";
31
+ option java_package = "com.google.cloud.discoveryengine.v1";
32
+ option objc_class_prefix = "DISCOVERYENGINE";
33
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
34
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
35
+
36
+ // Service for managing Assistant configuration and assisting users.
37
+ service AssistantService {
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
+ // Assists the user with a query in a streaming fashion.
43
+ rpc StreamAssist(StreamAssistRequest) returns (stream StreamAssistResponse) {
44
+ option (google.api.http) = {
45
+ post: "/v1/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:streamAssist"
46
+ body: "*"
47
+ };
48
+ }
49
+ }
50
+
51
+ // User metadata of the request.
52
+ message AssistUserMetadata {
53
+ // Optional. IANA time zone, e.g. Europe/Budapest.
54
+ string time_zone = 1 [(google.api.field_behavior) = OPTIONAL];
55
+
56
+ // Optional. Preferred language to be used for answering if language detection
57
+ // fails. Also used as the language of error messages created by actions,
58
+ // regardless of language detection results.
59
+ string preferred_language_code = 2 [(google.api.field_behavior) = OPTIONAL];
60
+ }
61
+
62
+ // Request for the
63
+ // [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist]
64
+ // method.
65
+ message StreamAssistRequest {
66
+ // Specification of tools that are used to serve the request.
67
+ message ToolsSpec {
68
+ // Specification of the Vertex AI Search tool.
69
+ message VertexAiSearchSpec {
70
+ // Optional. Specs defining
71
+ // [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
72
+ // a search call and configurations for those data stores. This is only
73
+ // considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
74
+ // multiple data stores.
75
+ repeated SearchRequest.DataStoreSpec data_store_specs = 2
76
+ [(google.api.field_behavior) = OPTIONAL];
77
+
78
+ // Optional. The filter syntax consists of an expression language for
79
+ // constructing a predicate from one or more fields of the documents being
80
+ // filtered. Filter expression is case-sensitive.
81
+ //
82
+ // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
83
+ //
84
+ // Filtering in Vertex AI Search is done by mapping the LHS filter key to
85
+ // a key property defined in the Vertex AI Search backend -- this mapping
86
+ // is defined by the customer in their schema. For example a media
87
+ // customer might have a field 'name' in their schema. In this case the
88
+ // filter would look like this: filter --> name:'ANY("king kong")'
89
+ //
90
+ // For more information about filtering including syntax and filter
91
+ // operators, see
92
+ // [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
93
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
94
+ }
95
+
96
+ // Specification of the web grounding tool.
97
+ message WebGroundingSpec {}
98
+
99
+ // Specification of the image generation tool.
100
+ message ImageGenerationSpec {}
101
+
102
+ // Specification of the video generation tool.
103
+ message VideoGenerationSpec {}
104
+
105
+ // Optional. Specification of the Vertex AI Search tool.
106
+ VertexAiSearchSpec vertex_ai_search_spec = 1
107
+ [(google.api.field_behavior) = OPTIONAL];
108
+
109
+ // Optional. Specification of the web grounding tool.
110
+ // If field is present, enables grounding with web search. Works only if
111
+ // [Assistant.web_grounding_type][google.cloud.discoveryengine.v1.Assistant.web_grounding_type]
112
+ // is [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] or
113
+ // [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][].
114
+ WebGroundingSpec web_grounding_spec = 2
115
+ [(google.api.field_behavior) = OPTIONAL];
116
+
117
+ // Optional. Specification of the image generation tool.
118
+ ImageGenerationSpec image_generation_spec = 3
119
+ [(google.api.field_behavior) = OPTIONAL];
120
+
121
+ // Optional. Specification of the video generation tool.
122
+ VideoGenerationSpec video_generation_spec = 4
123
+ [(google.api.field_behavior) = OPTIONAL];
124
+ }
125
+
126
+ // Assistant generation specification for the request.
127
+ // This allows to override the default generation configuration at the engine
128
+ // level.
129
+ message GenerationSpec {
130
+ // Optional. The Vertex AI model_id used for the generative model. If not
131
+ // set, the default Assistant model will be used.
132
+ string model_id = 1 [(google.api.field_behavior) = OPTIONAL];
133
+ }
134
+
135
+ // Required. The resource name of the
136
+ // [Assistant][google.cloud.discoveryengine.v1.Assistant]. Format:
137
+ // `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
138
+ string name = 1 [
139
+ (google.api.field_behavior) = REQUIRED,
140
+ (google.api.resource_reference) = {
141
+ type: "discoveryengine.googleapis.com/Assistant"
142
+ }
143
+ ];
144
+
145
+ // Optional. Current user query.
146
+ //
147
+ // Empty query is only supported if `file_ids` are provided. In this case, the
148
+ // answer will be generated based on those context files.
149
+ Query query = 2 [(google.api.field_behavior) = OPTIONAL];
150
+
151
+ // Optional. The session to use for the request. If specified, the assistant
152
+ // has access to the session history, and the query and the answer are stored
153
+ // there.
154
+ //
155
+ // If `-` is specified as the session ID, or it is left empty, then a new
156
+ // session is created with an automatically generated ID.
157
+ //
158
+ // Format:
159
+ // `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
160
+ string session = 3 [
161
+ (google.api.field_behavior) = OPTIONAL,
162
+ (google.api.resource_reference) = {
163
+ type: "discoveryengine.googleapis.com/Session"
164
+ }
165
+ ];
166
+
167
+ // Optional. Information about the user initiating the query.
168
+ AssistUserMetadata user_metadata = 6 [(google.api.field_behavior) = OPTIONAL];
169
+
170
+ // Optional. Specification of tools that are used to serve the request.
171
+ ToolsSpec tools_spec = 18 [(google.api.field_behavior) = OPTIONAL];
172
+
173
+ // Optional. Specification of the generation configuration for the request.
174
+ GenerationSpec generation_spec = 19 [(google.api.field_behavior) = OPTIONAL];
175
+ }
176
+
177
+ // Response for the
178
+ // [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist]
179
+ // method.
180
+ message StreamAssistResponse {
181
+ // Information about the session.
182
+ message SessionInfo {
183
+ // Name of the newly generated or continued session.
184
+ //
185
+ // Format:
186
+ // `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.
187
+ string session = 1 [(google.api.resource_reference) = {
188
+ type: "discoveryengine.googleapis.com/Session"
189
+ }];
190
+ }
191
+
192
+ // Assist answer resource object containing parts of the assistant's final
193
+ // answer for the user's query.
194
+ //
195
+ // Not present if the current response doesn't add anything to previously
196
+ // sent
197
+ // [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies].
198
+ //
199
+ // Observe
200
+ // [AssistAnswer.state][google.cloud.discoveryengine.v1.AssistAnswer.state] to
201
+ // see if more parts are to be expected. While the state is `IN_PROGRESS`, the
202
+ // [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies]
203
+ // field in each response will contain replies (reply fragments) to be
204
+ // appended to the ones received in previous responses. [AssistAnswer.name][]
205
+ // won't be filled.
206
+ //
207
+ // If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response
208
+ // is the last response and [AssistAnswer.name][] will have a value.
209
+ AssistAnswer answer = 1;
210
+
211
+ // Session information.
212
+ SessionInfo session_info = 2;
213
+
214
+ // A global unique ID that identifies the current pair of request and stream
215
+ // of responses. Used for feedback and support.
216
+ string assist_token = 4;
217
+ }
@@ -1125,11 +1125,23 @@ message ListSessionsRequest {
1125
1125
  // Provide this to retrieve the subsequent page.
1126
1126
  string page_token = 3;
1127
1127
 
1128
- // A filter to apply on the list results. The supported features are:
1129
- // user_pseudo_id, state.
1128
+ // A comma-separated list of fields to filter by, in EBNF grammar.
1129
+ // The supported fields are:
1130
+ // * `user_pseudo_id`
1131
+ // * `state`
1132
+ // * `display_name`
1133
+ // * `starred`
1134
+ // * `is_pinned`
1135
+ // * `labels`
1136
+ // * `create_time`
1137
+ // * `update_time`
1130
1138
  //
1131
- // Example:
1139
+ // Examples:
1132
1140
  // "user_pseudo_id = some_id"
1141
+ // "display_name = \"some_name\""
1142
+ // "starred = true"
1143
+ // "is_pinned=true AND (NOT labels:hidden)"
1144
+ // "create_time > \"1970-01-01T12:00:00Z\""
1133
1145
  string filter = 4;
1134
1146
 
1135
1147
  // A comma-separated list of fields to order by, sorted in ascending order.