google-cloud-discovery_engine-v1beta 0.27.0 → 0.28.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 (252) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +4 -4
  3. data/README.md +4 -4
  4. data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/client.rb +591 -0
  5. data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/credentials.rb +49 -0
  6. data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/paths.rb +50 -0
  7. data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/rest/client.rb +534 -0
  8. data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/rest/service_stub.rb +204 -0
  9. data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/rest.rb +52 -0
  10. data/lib/google/cloud/discovery_engine/v1beta/acl_config_service.rb +55 -0
  11. data/lib/google/cloud/discovery_engine/v1beta/assistant_service/client.rb +1058 -0
  12. data/lib/google/cloud/discovery_engine/v1beta/assistant_service/credentials.rb +50 -0
  13. data/lib/google/cloud/discovery_engine/v1beta/assistant_service/paths.rb +230 -0
  14. data/lib/google/cloud/discovery_engine/v1beta/assistant_service/rest/client.rb +975 -0
  15. data/lib/google/cloud/discovery_engine/v1beta/assistant_service/rest/service_stub.rb +444 -0
  16. data/lib/google/cloud/discovery_engine/v1beta/assistant_service/rest.rb +52 -0
  17. data/lib/google/cloud/discovery_engine/v1beta/assistant_service.rb +55 -0
  18. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/client.rb +823 -0
  19. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/credentials.rb +49 -0
  20. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/operations.rb +843 -0
  21. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/paths.rb +135 -0
  22. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/rest/client.rb +752 -0
  23. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/rest/operations.rb +1152 -0
  24. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/rest/service_stub.rb +341 -0
  25. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/rest.rb +53 -0
  26. data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service.rb +56 -0
  27. data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +146 -12
  28. data/lib/google/cloud/discovery_engine/v1beta/completion_service/credentials.rb +5 -1
  29. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +139 -12
  30. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +21 -0
  31. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb +62 -0
  32. data/lib/google/cloud/discovery_engine/v1beta/control_service/credentials.rb +3 -1
  33. data/lib/google/cloud/discovery_engine/v1beta/control_service/paths.rb +53 -0
  34. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +210 -10
  35. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/credentials.rb +3 -1
  36. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/paths.rb +46 -0
  37. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +205 -10
  38. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +72 -0
  39. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +11 -1
  40. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/credentials.rb +3 -1
  41. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/paths.rb +104 -0
  42. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/client.rb +11 -1
  43. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +21 -0
  44. data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +8 -3
  45. data/lib/google/cloud/discovery_engine/v1beta/document_service/credentials.rb +3 -1
  46. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +8 -3
  47. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +21 -0
  48. data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +224 -6
  49. data/lib/google/cloud/discovery_engine/v1beta/engine_service/credentials.rb +3 -1
  50. data/lib/google/cloud/discovery_engine/v1beta/engine_service/paths.rb +104 -0
  51. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +210 -6
  52. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +21 -0
  53. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/service_stub.rb +123 -0
  54. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/client.rb +11 -9
  55. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/credentials.rb +4 -1
  56. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/paths.rb +21 -0
  57. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/client.rb +11 -9
  58. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/operations.rb +21 -0
  59. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/credentials.rb +3 -1
  60. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/client.rb +1180 -0
  61. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/credentials.rb +49 -0
  62. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/operations.rb +843 -0
  63. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/paths.rb +154 -0
  64. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/rest/client.rb +1088 -0
  65. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/rest/operations.rb +1152 -0
  66. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/rest/service_stub.rb +511 -0
  67. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/rest.rb +53 -0
  68. data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service.rb +56 -0
  69. data/lib/google/cloud/discovery_engine/v1beta/license_config_service/client.rb +1050 -0
  70. data/lib/google/cloud/discovery_engine/v1beta/license_config_service/credentials.rb +49 -0
  71. data/lib/google/cloud/discovery_engine/v1beta/license_config_service/paths.rb +86 -0
  72. data/lib/google/cloud/discovery_engine/v1beta/license_config_service/rest/client.rb +965 -0
  73. data/lib/google/cloud/discovery_engine/v1beta/license_config_service/rest/service_stub.rb +451 -0
  74. data/lib/google/cloud/discovery_engine/v1beta/license_config_service/rest.rb +52 -0
  75. data/lib/google/cloud/discovery_engine/v1beta/license_config_service.rb +55 -0
  76. data/lib/google/cloud/discovery_engine/v1beta/project_service/client.rb +3 -1
  77. data/lib/google/cloud/discovery_engine/v1beta/project_service/credentials.rb +3 -1
  78. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/client.rb +3 -1
  79. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +21 -0
  80. data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +2 -2
  81. data/lib/google/cloud/discovery_engine/v1beta/rank_service/credentials.rb +3 -1
  82. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +2 -2
  83. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +2 -2
  84. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/credentials.rb +3 -1
  85. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +2 -2
  86. data/lib/google/cloud/discovery_engine/v1beta/rest.rb +10 -3
  87. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/credentials.rb +3 -1
  88. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/operations.rb +21 -0
  89. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/credentials.rb +3 -1
  90. data/lib/google/cloud/discovery_engine/v1beta/schema_service/credentials.rb +3 -1
  91. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +21 -0
  92. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +194 -38
  93. data/lib/google/cloud/discovery_engine/v1beta/search_service/credentials.rb +4 -1
  94. data/lib/google/cloud/discovery_engine/v1beta/search_service/paths.rb +21 -0
  95. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +194 -38
  96. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/credentials.rb +3 -1
  97. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +21 -0
  98. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +207 -3
  99. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/credentials.rb +3 -1
  100. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +193 -3
  101. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/service_stub.rb +153 -0
  102. data/lib/google/cloud/discovery_engine/v1beta/session_service/client.rb +25 -9
  103. data/lib/google/cloud/discovery_engine/v1beta/session_service/credentials.rb +4 -1
  104. data/lib/google/cloud/discovery_engine/v1beta/session_service/paths.rb +46 -0
  105. data/lib/google/cloud/discovery_engine/v1beta/session_service/rest/client.rb +25 -9
  106. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +1 -3
  107. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/credentials.rb +3 -1
  108. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +1 -3
  109. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +21 -0
  110. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/service_stub.rb +7 -0
  111. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +23 -11
  112. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/credentials.rb +4 -1
  113. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +23 -11
  114. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +21 -0
  115. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +8 -0
  116. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/client.rb +768 -0
  117. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/credentials.rb +49 -0
  118. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/operations.rb +843 -0
  119. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/paths.rb +71 -0
  120. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/rest/client.rb +704 -0
  121. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/rest/operations.rb +1152 -0
  122. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/rest/service_stub.rb +265 -0
  123. data/lib/google/cloud/discovery_engine/v1beta/user_license_service/rest.rb +53 -0
  124. data/lib/google/cloud/discovery_engine/v1beta/user_license_service.rb +56 -0
  125. data/lib/google/cloud/discovery_engine/v1beta/user_store_service/client.rb +590 -0
  126. data/lib/google/cloud/discovery_engine/v1beta/user_store_service/credentials.rb +49 -0
  127. data/lib/google/cloud/discovery_engine/v1beta/user_store_service/paths.rb +71 -0
  128. data/lib/google/cloud/discovery_engine/v1beta/user_store_service/rest/client.rb +533 -0
  129. data/lib/google/cloud/discovery_engine/v1beta/user_store_service/rest/service_stub.rb +204 -0
  130. data/lib/google/cloud/discovery_engine/v1beta/user_store_service/rest.rb +52 -0
  131. data/lib/google/cloud/discovery_engine/v1beta/user_store_service.rb +55 -0
  132. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  133. data/lib/google/cloud/discovery_engine/v1beta.rb +11 -4
  134. data/lib/google/cloud/discoveryengine/v1beta/acl_config_pb.rb +25 -0
  135. data/lib/google/cloud/discoveryengine/v1beta/acl_config_service_pb.rb +28 -0
  136. data/lib/google/cloud/discoveryengine/v1beta/acl_config_service_services_pb.rb +49 -0
  137. data/lib/google/cloud/discoveryengine/v1beta/agent_gateway_setting_pb.rb +25 -0
  138. data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +6 -1
  139. data/lib/google/cloud/discoveryengine/v1beta/assist_answer_pb.rb +48 -0
  140. data/lib/google/cloud/discoveryengine/v1beta/assistant_pb.rb +35 -0
  141. data/lib/google/cloud/discoveryengine/v1beta/assistant_service_pb.rb +48 -0
  142. data/lib/google/cloud/discoveryengine/v1beta/assistant_service_services_pb.rb +56 -0
  143. data/lib/google/cloud/discoveryengine/v1beta/chunk_pb.rb +4 -1
  144. data/lib/google/cloud/discoveryengine/v1beta/cmek_config_service_pb.rb +39 -0
  145. data/lib/google/cloud/discoveryengine/v1beta/cmek_config_service_services_pb.rb +55 -0
  146. data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +12 -1
  147. data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +4 -1
  148. data/lib/google/cloud/discoveryengine/v1beta/completion_service_services_pb.rb +6 -0
  149. data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +6 -1
  150. data/lib/google/cloud/discoveryengine/v1beta/control_service_pb.rb +1 -1
  151. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +12 -1
  152. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_services_pb.rb +8 -0
  153. data/lib/google/cloud/discoveryengine/v1beta/data_store_pb.rb +11 -1
  154. data/lib/google/cloud/discoveryengine/v1beta/data_store_service_pb.rb +1 -1
  155. data/lib/google/cloud/discoveryengine/v1beta/document_pb.rb +4 -1
  156. data/lib/google/cloud/discoveryengine/v1beta/document_processing_config_pb.rb +1 -1
  157. data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +1 -1
  158. data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +17 -1
  159. data/lib/google/cloud/discoveryengine/v1beta/engine_service_pb.rb +3 -1
  160. data/lib/google/cloud/discoveryengine/v1beta/engine_service_services_pb.rb +28 -6
  161. data/lib/google/cloud/discoveryengine/v1beta/evaluation_pb.rb +1 -1
  162. data/lib/google/cloud/discoveryengine/v1beta/evaluation_service_pb.rb +1 -1
  163. data/lib/google/cloud/discoveryengine/v1beta/feedback_pb.rb +28 -0
  164. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +11 -1
  165. data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +1 -1
  166. data/lib/google/cloud/discoveryengine/v1beta/identity_mapping_store_pb.rb +26 -0
  167. data/lib/google/cloud/discoveryengine/v1beta/identity_mapping_store_service_pb.rb +44 -0
  168. data/lib/google/cloud/discoveryengine/v1beta/identity_mapping_store_service_services_pb.rb +58 -0
  169. data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +1 -1
  170. data/lib/google/cloud/discoveryengine/v1beta/license_config_pb.rb +27 -0
  171. data/lib/google/cloud/discoveryengine/v1beta/license_config_service_pb.rb +36 -0
  172. data/lib/google/cloud/discoveryengine/v1beta/license_config_service_services_pb.rb +65 -0
  173. data/lib/google/cloud/discoveryengine/v1beta/logging_pb.rb +24 -0
  174. data/lib/google/cloud/discoveryengine/v1beta/project_pb.rb +10 -1
  175. data/lib/google/cloud/discoveryengine/v1beta/project_service_pb.rb +2 -1
  176. data/lib/google/cloud/discoveryengine/v1beta/rank_service_pb.rb +1 -1
  177. data/lib/google/cloud/discoveryengine/v1beta/recommendation_service_pb.rb +1 -1
  178. data/lib/google/cloud/discoveryengine/v1beta/safety_pb.rb +26 -0
  179. data/lib/google/cloud/discoveryengine/v1beta/sample_query_service_pb.rb +1 -1
  180. data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_service_pb.rb +1 -1
  181. data/lib/google/cloud/discoveryengine/v1beta/schema_service_pb.rb +1 -1
  182. data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +18 -2
  183. data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_pb.rb +1 -1
  184. data/lib/google/cloud/discoveryengine/v1beta/serving_config_pb.rb +3 -1
  185. data/lib/google/cloud/discoveryengine/v1beta/serving_config_service_pb.rb +4 -1
  186. data/lib/google/cloud/discoveryengine/v1beta/serving_config_service_services_pb.rb +14 -0
  187. data/lib/google/cloud/discoveryengine/v1beta/session_pb.rb +2 -1
  188. data/lib/google/cloud/discoveryengine/v1beta/session_service_pb.rb +1 -1
  189. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +1 -1
  190. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_pb.rb +1 -1
  191. data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +2 -1
  192. data/lib/google/cloud/discoveryengine/v1beta/user_event_service_pb.rb +1 -1
  193. data/lib/google/cloud/discoveryengine/v1beta/user_license_pb.rb +27 -0
  194. data/lib/google/cloud/discoveryengine/v1beta/user_license_service_pb.rb +38 -0
  195. data/lib/google/cloud/discoveryengine/v1beta/user_license_service_services_pb.rb +52 -0
  196. data/lib/google/cloud/discoveryengine/v1beta/user_store_pb.rb +24 -0
  197. data/lib/google/cloud/discoveryengine/v1beta/user_store_service_pb.rb +29 -0
  198. data/lib/google/cloud/discoveryengine/v1beta/user_store_service_services_pb.rb +47 -0
  199. data/proto_docs/google/cloud/discoveryengine/v1beta/acl_config.rb +43 -0
  200. data/proto_docs/google/cloud/discoveryengine/v1beta/acl_config_service.rb +49 -0
  201. data/proto_docs/google/cloud/discoveryengine/v1beta/agent_gateway_setting.rb +53 -0
  202. data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +117 -2
  203. data/proto_docs/google/cloud/discoveryengine/v1beta/assist_answer.rb +401 -0
  204. data/proto_docs/google/cloud/discoveryengine/v1beta/assistant.rb +253 -0
  205. data/proto_docs/google/cloud/discoveryengine/v1beta/assistant_service.rb +368 -0
  206. data/proto_docs/google/cloud/discoveryengine/v1beta/chunk.rb +60 -1
  207. data/proto_docs/google/cloud/discoveryengine/v1beta/cmek_config_service.rb +228 -0
  208. data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +223 -0
  209. data/proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb +115 -13
  210. data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +119 -6
  211. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +178 -8
  212. data/proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb +218 -9
  213. data/proto_docs/google/cloud/discoveryengine/v1beta/data_store_service.rb +12 -0
  214. data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +115 -10
  215. data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +30 -0
  216. data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +1 -1
  217. data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +388 -8
  218. data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb +2 -2
  219. data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation_service.rb +13 -11
  220. data/proto_docs/google/cloud/discoveryengine/v1beta/feedback.rb +147 -0
  221. data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +190 -9
  222. data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +9 -0
  223. data/proto_docs/google/cloud/discoveryengine/v1beta/identity_mapping_store.rb +84 -0
  224. data/proto_docs/google/cloud/discoveryengine/v1beta/identity_mapping_store_service.rb +280 -0
  225. data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +25 -5
  226. data/proto_docs/google/cloud/discoveryengine/v1beta/license_config.rb +101 -0
  227. data/proto_docs/google/cloud/discoveryengine/v1beta/license_config_service.rb +224 -0
  228. data/proto_docs/google/cloud/discoveryengine/v1beta/logging.rb +40 -0
  229. data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +214 -0
  230. data/proto_docs/google/cloud/discoveryengine/v1beta/project_service.rb +18 -0
  231. data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb +9 -5
  232. data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +4 -2
  233. data/proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb +2 -2
  234. data/proto_docs/google/cloud/discoveryengine/v1beta/safety.rb +108 -0
  235. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +461 -69
  236. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +50 -3
  237. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb +30 -0
  238. data/proto_docs/google/cloud/discoveryengine/v1beta/session.rb +21 -0
  239. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +8 -2
  240. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine_service.rb +7 -3
  241. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +39 -3
  242. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event_service.rb +14 -6
  243. data/proto_docs/google/cloud/discoveryengine/v1beta/user_license.rb +100 -0
  244. data/proto_docs/google/cloud/discoveryengine/v1beta/user_license_service.rb +202 -0
  245. data/proto_docs/google/cloud/discoveryengine/v1beta/user_store.rb +67 -0
  246. data/proto_docs/google/cloud/discoveryengine/v1beta/user_store_service.rb +54 -0
  247. data/proto_docs/google/iam/v1/iam_policy.rb +87 -0
  248. data/proto_docs/google/iam/v1/options.rb +50 -0
  249. data/proto_docs/google/iam/v1/policy.rb +426 -0
  250. data/proto_docs/google/type/expr.rb +75 -0
  251. data/proto_docs/google/type/latlng.rb +38 -0
  252. metadata +118 -1
@@ -54,10 +54,10 @@ module Google
54
54
  # * `search-history` is the default model for site search dataStores.
55
55
  # @!attribute [rw] user_pseudo_id
56
56
  # @return [::String]
57
- # A unique identifier for tracking visitors. For example, this could be
58
- # implemented with an HTTP cookie, which should be able to uniquely identify
59
- # a visitor on a single device. This unique identifier should not change if
60
- # the visitor logs in or out of the website.
57
+ # Optional. A unique identifier for tracking visitors. For example, this
58
+ # could be implemented with an HTTP cookie, which should be able to uniquely
59
+ # identify a visitor on a single device. This unique identifier should not
60
+ # change if the visitor logs in or out of the website.
61
61
  #
62
62
  # This field should NOT have a fixed value such as `unknown_visitor`.
63
63
  #
@@ -134,9 +134,9 @@ module Google
134
134
  # user's recently searched queries given the empty query.
135
135
  # @!attribute [rw] query_model
136
136
  # @return [::String]
137
- # Specifies the autocomplete data model. This overrides any model specified
138
- # in the Configuration > Autocomplete section of the Cloud console. Currently
139
- # supported values:
137
+ # Specifies the autocomplete query model, which only applies to the QUERY
138
+ # SuggestionType. This overrides any model specified in the Configuration >
139
+ # Autocomplete section of the Cloud console. Currently supported values:
140
140
  #
141
141
  # * `document` - Using suggestions generated from user-imported documents.
142
142
  # * `search-history` - Using suggestions generated from the past history of
@@ -153,10 +153,10 @@ module Google
153
153
  # * `search-history` is the default model for site search dataStores.
154
154
  # @!attribute [rw] user_pseudo_id
155
155
  # @return [::String]
156
- # A unique identifier for tracking visitors. For example, this could be
157
- # implemented with an HTTP cookie, which should be able to uniquely identify
158
- # a visitor on a single device. This unique identifier should not change if
159
- # the visitor logs in or out of the website.
156
+ # Optional. A unique identifier for tracking visitors. For example, this
157
+ # could be implemented with an HTTP cookie, which should be able to uniquely
158
+ # identify a visitor on a single device. This unique identifier should not
159
+ # change if the visitor logs in or out of the website.
160
160
  #
161
161
  # This field should NOT have a fixed value such as `unknown_visitor`.
162
162
  #
@@ -188,15 +188,22 @@ module Google
188
188
  # Optional. Suggestion types to return. If empty or unspecified, query
189
189
  # suggestions are returned. Only one suggestion type is supported at the
190
190
  # moment.
191
+ # @!attribute [rw] suggestion_type_specs
192
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::SuggestionTypeSpec>]
193
+ # Optional. Specification of each suggestion type.
194
+ # @!attribute [rw] experiment_ids
195
+ # @return [::Array<::String>]
196
+ # Optional. Experiment ids for this request.
191
197
  class AdvancedCompleteQueryRequest
192
198
  include ::Google::Protobuf::MessageExts
193
199
  extend ::Google::Protobuf::MessageExts::ClassMethods
194
200
 
195
- # Specification to boost suggestions based on the condtion of the suggestion.
201
+ # Specification to boost suggestions based on the condition of the
202
+ # suggestion.
196
203
  # @!attribute [rw] condition_boost_specs
197
204
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::BoostSpec::ConditionBoostSpec>]
198
205
  # Condition boost specifications. If a suggestion matches multiple
199
- # conditions in the specifictions, boost values from these specifications
206
+ # conditions in the specifications, boost values from these specifications
200
207
  # are all applied and combined in a non-linear way. Maximum number of
201
208
  # specifications is 20.
202
209
  #
@@ -236,6 +243,19 @@ module Google
236
243
  end
237
244
  end
238
245
 
246
+ # Specification of each suggestion type.
247
+ # @!attribute [rw] suggestion_type
248
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::SuggestionType]
249
+ # Optional. Suggestion type.
250
+ # @!attribute [rw] max_suggestions
251
+ # @return [::Integer]
252
+ # Optional. Maximum number of suggestions to return for each suggestion
253
+ # type.
254
+ class SuggestionTypeSpec
255
+ include ::Google::Protobuf::MessageExts
256
+ extend ::Google::Protobuf::MessageExts::ClassMethods
257
+ end
258
+
239
259
  # Suggestion type to return.
240
260
  module SuggestionType
241
261
  # Default value.
@@ -300,6 +320,9 @@ module Google
300
320
  # @!attribute [rw] data_store
301
321
  # @return [::Array<::String>]
302
322
  # The name of the dataStore that this suggestion belongs to.
323
+ # @!attribute [rw] score
324
+ # @return [::Float]
325
+ # The score of each suggestion. The score is in the range of [0, 1].
303
326
  class QuerySuggestion
304
327
  include ::Google::Protobuf::MessageExts
305
328
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -319,6 +342,15 @@ module Google
319
342
  # @!attribute [rw] data_store
320
343
  # @return [::String]
321
344
  # The name of the dataStore that this suggestion belongs to.
345
+ # @!attribute [rw] score
346
+ # @return [::Float]
347
+ # The score of each suggestion. The score is in the range of [0, 1].
348
+ # @!attribute [rw] display_photo_uri
349
+ # @return [::String]
350
+ # The photo uri of the person suggestion.
351
+ # @!attribute [rw] destination_uri
352
+ # @return [::String]
353
+ # The destination uri of the person suggestion.
322
354
  class PersonSuggestion
323
355
  include ::Google::Protobuf::MessageExts
324
356
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -350,6 +382,15 @@ module Google
350
382
  # @!attribute [rw] data_store
351
383
  # @return [::String]
352
384
  # The name of the dataStore that this suggestion belongs to.
385
+ # @!attribute [rw] score
386
+ # @return [::Float]
387
+ # The score of each suggestion. The score is in the range of [0, 1].
388
+ # @!attribute [rw] icon_uri
389
+ # @return [::String]
390
+ # The icon uri of the content suggestion.
391
+ # @!attribute [rw] destination_uri
392
+ # @return [::String]
393
+ # The destination uri of the content suggestion.
353
394
  class ContentSuggestion
354
395
  include ::Google::Protobuf::MessageExts
355
396
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -374,11 +415,72 @@ module Google
374
415
  # @!attribute [rw] recent_search_time
375
416
  # @return [::Google::Protobuf::Timestamp]
376
417
  # The time when this recent rearch happened.
418
+ # @!attribute [rw] score
419
+ # @return [::Float]
420
+ # The score of each suggestion. The score is in the range of [0, 1].
377
421
  class RecentSearchSuggestion
378
422
  include ::Google::Protobuf::MessageExts
379
423
  extend ::Google::Protobuf::MessageExts::ClassMethods
380
424
  end
381
425
  end
426
+
427
+ # Request message for
428
+ # {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#remove_suggestion CompletionService.RemoveSuggestion}
429
+ # method.
430
+ # @!attribute [rw] search_history_suggestion
431
+ # @return [::String]
432
+ # The search history suggestion to be removed.
433
+ #
434
+ # Note: The following fields are mutually exclusive: `search_history_suggestion`, `remove_all_search_history_suggestions`. If a field in that set is populated, all other fields in the set will automatically be cleared.
435
+ # @!attribute [rw] remove_all_search_history_suggestions
436
+ # @return [::Boolean]
437
+ # Remove all search history suggestions for the user.
438
+ #
439
+ # Note: The following fields are mutually exclusive: `remove_all_search_history_suggestions`, `search_history_suggestion`. If a field in that set is populated, all other fields in the set will automatically be cleared.
440
+ # @!attribute [rw] completion_config
441
+ # @return [::String]
442
+ # Required. The completion_config of the parent engine resource name for
443
+ # which the search history suggestion is to be removed, such as
444
+ # `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
445
+ # @!attribute [rw] user_pseudo_id
446
+ # @return [::String]
447
+ # Required. A unique identifier for tracking visitors. For example, this
448
+ # could be implemented with an HTTP cookie, which should be able to uniquely
449
+ # identify a visitor on a single device. This unique identifier should not
450
+ # change if the visitor logs in or out of the website.
451
+ #
452
+ # This field should NOT have a fixed value such as `unknown_visitor`.
453
+ #
454
+ # This should be the same identifier as
455
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
456
+ # and
457
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}.
458
+ #
459
+ # The field must be a UTF-8 encoded string with a length limit of 128.
460
+ # @!attribute [rw] user_info
461
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::UserInfo]
462
+ # Optional. Information about the end user.
463
+ #
464
+ # This should be the same identifier information as
465
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_info UserEvent.user_info}
466
+ # and
467
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_info SearchRequest.user_info}.
468
+ # @!attribute [rw] remove_time
469
+ # @return [::Google::Protobuf::Timestamp]
470
+ # Required. Time at which the suggestion was removed. If not set, the current
471
+ # time will be used.
472
+ class RemoveSuggestionRequest
473
+ include ::Google::Protobuf::MessageExts
474
+ extend ::Google::Protobuf::MessageExts::ClassMethods
475
+ end
476
+
477
+ # Response message for
478
+ # {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#remove_suggestion CompletionService.RemoveSuggestion}
479
+ # method.
480
+ class RemoveSuggestionResponse
481
+ include ::Google::Protobuf::MessageExts
482
+ extend ::Google::Protobuf::MessageExts::ClassMethods
483
+ end
382
484
  end
383
485
  end
384
486
  end
@@ -41,7 +41,7 @@ module Google
41
41
  # Optional. Query regex to match the whole search query.
42
42
  # Cannot be set when
43
43
  # {::Google::Cloud::DiscoveryEngine::V1beta::Condition#query_terms Condition.query_terms}
44
- # is set. This is currently supporting promotion use case.
44
+ # is set. Only supported for Basic Site Search promotion serving controls.
45
45
  class Condition
46
46
  include ::Google::Protobuf::MessageExts
47
47
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -89,23 +89,28 @@ module Google
89
89
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction]
90
90
  # Defines a boost-type control
91
91
  #
92
- # Note: The following fields are mutually exclusive: `boost_action`, `filter_action`, `redirect_action`, `synonyms_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
92
+ # Note: The following fields are mutually exclusive: `boost_action`, `filter_action`, `redirect_action`, `synonyms_action`, `promote_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
93
93
  # @!attribute [rw] filter_action
94
94
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::FilterAction]
95
95
  # Defines a filter-type control
96
96
  # Currently not supported by Recommendation
97
97
  #
98
- # Note: The following fields are mutually exclusive: `filter_action`, `boost_action`, `redirect_action`, `synonyms_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
98
+ # Note: The following fields are mutually exclusive: `filter_action`, `boost_action`, `redirect_action`, `synonyms_action`, `promote_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
99
99
  # @!attribute [rw] redirect_action
100
100
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::RedirectAction]
101
101
  # Defines a redirect-type control.
102
102
  #
103
- # Note: The following fields are mutually exclusive: `redirect_action`, `boost_action`, `filter_action`, `synonyms_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
103
+ # Note: The following fields are mutually exclusive: `redirect_action`, `boost_action`, `filter_action`, `synonyms_action`, `promote_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
104
104
  # @!attribute [rw] synonyms_action
105
105
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::SynonymsAction]
106
106
  # Treats a group of terms as synonyms of one another.
107
107
  #
108
- # Note: The following fields are mutually exclusive: `synonyms_action`, `boost_action`, `filter_action`, `redirect_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
108
+ # Note: The following fields are mutually exclusive: `synonyms_action`, `boost_action`, `filter_action`, `redirect_action`, `promote_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
109
+ # @!attribute [rw] promote_action
110
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::PromoteAction]
111
+ # Promote certain links based on predefined trigger queries.
112
+ #
113
+ # Note: The following fields are mutually exclusive: `promote_action`, `boost_action`, `filter_action`, `redirect_action`, `synonyms_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
109
114
  # @!attribute [rw] name
110
115
  # @return [::String]
111
116
  # Immutable. Fully qualified name
@@ -148,9 +153,22 @@ module Google
148
153
  extend ::Google::Protobuf::MessageExts::ClassMethods
149
154
 
150
155
  # Adjusts order of products in returned list.
156
+ # @!attribute [rw] fixed_boost
157
+ # @return [::Float]
158
+ # Optional. Strength of the boost, which should be in [-1, 1]. Negative
159
+ # boost means demotion. Default is 0.0 (No-op).
160
+ #
161
+ # Note: The following fields are mutually exclusive: `fixed_boost`, `interpolation_boost_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
162
+ # @!attribute [rw] interpolation_boost_spec
163
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction::InterpolationBoostSpec]
164
+ # Optional. Complex specification for custom ranking based on customer
165
+ # defined attribute value.
166
+ #
167
+ # Note: The following fields are mutually exclusive: `interpolation_boost_spec`, `fixed_boost`. If a field in that set is populated, all other fields in the set will automatically be cleared.
151
168
  # @!attribute [rw] boost
169
+ # @deprecated This field is deprecated and may be removed in the next major version update.
152
170
  # @return [::Float]
153
- # Required. Strength of the boost, which should be in [-1, 1]. Negative
171
+ # Strength of the boost, which should be in [-1, 1]. Negative
154
172
  # boost means demotion. Default is 0.0 (No-op).
155
173
  # @!attribute [rw] filter
156
174
  # @return [::String]
@@ -169,6 +187,86 @@ module Google
169
187
  class BoostAction
170
188
  include ::Google::Protobuf::MessageExts
171
189
  extend ::Google::Protobuf::MessageExts::ClassMethods
190
+
191
+ # Specification for custom ranking based on customer specified attribute
192
+ # value. It provides more controls for customized ranking than the simple
193
+ # (condition, boost) combination above.
194
+ # @!attribute [rw] field_name
195
+ # @return [::String]
196
+ # Optional. The name of the field whose value will be used to determine
197
+ # the boost amount.
198
+ # @!attribute [rw] attribute_type
199
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction::InterpolationBoostSpec::AttributeType]
200
+ # Optional. The attribute type to be used to determine the boost amount.
201
+ # The attribute value can be derived from the field value of the
202
+ # specified field_name. In the case of numerical it is straightforward
203
+ # i.e. attribute_value = numerical_field_value. In the case of freshness
204
+ # however, attribute_value = (time.now() - datetime_field_value).
205
+ # @!attribute [rw] interpolation_type
206
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction::InterpolationBoostSpec::InterpolationType]
207
+ # Optional. The interpolation type to be applied to connect the control
208
+ # points listed below.
209
+ # @!attribute [rw] control_points
210
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction::InterpolationBoostSpec::ControlPoint>]
211
+ # Optional. The control points used to define the curve. The monotonic
212
+ # function (defined through the interpolation_type above) passes through
213
+ # the control points listed here.
214
+ class InterpolationBoostSpec
215
+ include ::Google::Protobuf::MessageExts
216
+ extend ::Google::Protobuf::MessageExts::ClassMethods
217
+
218
+ # The control points used to define the curve. The curve defined
219
+ # through these control points can only be monotonically increasing
220
+ # or decreasing(constant values are acceptable).
221
+ # @!attribute [rw] attribute_value
222
+ # @return [::String]
223
+ # Optional. Can be one of:
224
+ # 1. The numerical field value.
225
+ # 2. The duration spec for freshness:
226
+ # The value must be formatted as an XSD `dayTimeDuration` value (a
227
+ # restricted subset of an ISO 8601 duration value). The pattern for
228
+ # this is: `[nD][T[nH][nM][nS]]`.
229
+ # @!attribute [rw] boost_amount
230
+ # @return [::Float]
231
+ # Optional. The value between -1 to 1 by which to boost the score if
232
+ # the attribute_value evaluates to the value specified above.
233
+ class ControlPoint
234
+ include ::Google::Protobuf::MessageExts
235
+ extend ::Google::Protobuf::MessageExts::ClassMethods
236
+ end
237
+
238
+ # The attribute(or function) for which the custom ranking is to be
239
+ # applied.
240
+ module AttributeType
241
+ # Unspecified AttributeType.
242
+ ATTRIBUTE_TYPE_UNSPECIFIED = 0
243
+
244
+ # The value of the numerical field will be used to dynamically update
245
+ # the boost amount. In this case, the attribute_value (the x value)
246
+ # of the control point will be the actual value of the numerical
247
+ # field for which the boost_amount is specified.
248
+ NUMERICAL = 1
249
+
250
+ # For the freshness use case the attribute value will be the duration
251
+ # between the current time and the date in the datetime field
252
+ # specified. The value must be formatted as an XSD `dayTimeDuration`
253
+ # value (a restricted subset of an ISO 8601 duration value). The
254
+ # pattern for this is: `[nD][T[nH][nM][nS]]`.
255
+ # For example, `5D`, `3DT12H30M`, `T24H`.
256
+ FRESHNESS = 2
257
+ end
258
+
259
+ # The interpolation type to be applied. Default will be linear
260
+ # (Piecewise Linear).
261
+ module InterpolationType
262
+ # Interpolation type is unspecified. In this case, it defaults to
263
+ # Linear.
264
+ INTERPOLATION_TYPE_UNSPECIFIED = 0
265
+
266
+ # Piecewise linear interpolation will be applied.
267
+ LINEAR = 1
268
+ end
269
+ end
172
270
  end
173
271
 
174
272
  # Specified which products may be included in results.
@@ -219,6 +317,21 @@ module Google
219
317
  include ::Google::Protobuf::MessageExts
220
318
  extend ::Google::Protobuf::MessageExts::ClassMethods
221
319
  end
320
+
321
+ # Promote certain links based on some trigger queries.
322
+ #
323
+ # Example: Promote shoe store link when searching for `shoe` keyword.
324
+ # The link can be outside of associated data store.
325
+ # @!attribute [rw] data_store
326
+ # @return [::String]
327
+ # Required. Data store with which this promotion is attached to.
328
+ # @!attribute [rw] search_link_promotion
329
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchLinkPromotion]
330
+ # Required. Promotion attached to this action.
331
+ class PromoteAction
332
+ include ::Google::Protobuf::MessageExts
333
+ extend ::Google::Protobuf::MessageExts::ClassMethods
334
+ end
222
335
  end
223
336
  end
224
337
  end
@@ -236,6 +236,12 @@ module Google
236
236
  # `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
237
237
  # or
238
238
  # `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
239
+ #
240
+ # Or the resource name of the agent engine serving config, such as:
241
+ # `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`.
242
+ # (use when `enable_agent_invocation` set to true, and you have custom
243
+ # `AI_MODE` agent engine configured)
244
+ #
239
245
  # This field is used to identify the serving configuration name, set
240
246
  # of models used to make the search.
241
247
  # @!attribute [rw] query
@@ -312,18 +318,63 @@ module Google
312
318
  # See [Google Cloud
313
319
  # Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
314
320
  # for more details.
321
+ # @!attribute [rw] end_user_spec
322
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::EndUserSpec]
323
+ # Optional. End user specification.
315
324
  class AnswerQueryRequest
316
325
  include ::Google::Protobuf::MessageExts
317
326
  extend ::Google::Protobuf::MessageExts::ClassMethods
318
327
 
319
328
  # Safety specification.
329
+ # There are two use cases:
330
+ # 1. when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold
331
+ # will be applied for all categories.
332
+ # 2. when safety_spec.enable is set and some safety_settings are set, only
333
+ # specified safety_settings are applied.
320
334
  # @!attribute [rw] enable
321
335
  # @return [::Boolean]
322
336
  # Enable the safety filtering on the answer response. It is false by
323
337
  # default.
338
+ # @!attribute [rw] safety_settings
339
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SafetySpec::SafetySetting>]
340
+ # Optional. Safety settings.
341
+ # This settings are effective only when the safety_spec.enable is true.
324
342
  class SafetySpec
325
343
  include ::Google::Protobuf::MessageExts
326
344
  extend ::Google::Protobuf::MessageExts::ClassMethods
345
+
346
+ # Safety settings.
347
+ # @!attribute [rw] category
348
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::HarmCategory]
349
+ # Required. Harm category.
350
+ # @!attribute [rw] threshold
351
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SafetySpec::SafetySetting::HarmBlockThreshold]
352
+ # Required. The harm block threshold.
353
+ class SafetySetting
354
+ include ::Google::Protobuf::MessageExts
355
+ extend ::Google::Protobuf::MessageExts::ClassMethods
356
+
357
+ # Probability based thresholds levels for blocking.
358
+ module HarmBlockThreshold
359
+ # Unspecified harm block threshold.
360
+ HARM_BLOCK_THRESHOLD_UNSPECIFIED = 0
361
+
362
+ # Block low threshold and above (i.e. block more).
363
+ BLOCK_LOW_AND_ABOVE = 1
364
+
365
+ # Block medium threshold and above.
366
+ BLOCK_MEDIUM_AND_ABOVE = 2
367
+
368
+ # Block only high threshold (i.e. block less).
369
+ BLOCK_ONLY_HIGH = 3
370
+
371
+ # Block none.
372
+ BLOCK_NONE = 4
373
+
374
+ # Turn off the safety filter.
375
+ OFF = 5
376
+ end
377
+ end
327
378
  end
328
379
 
329
380
  # Related questions specification.
@@ -422,6 +473,9 @@ module Google
422
473
  # competing company's CEO". If this field is set to `true`, we skip
423
474
  # generating summaries for jail-breaking queries and return fallback
424
475
  # messages instead.
476
+ # @!attribute [rw] multimodal_spec
477
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::AnswerGenerationSpec::MultimodalSpec]
478
+ # Optional. Multimodal specification.
425
479
  class AnswerGenerationSpec
426
480
  include ::Google::Protobuf::MessageExts
427
481
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -444,6 +498,31 @@ module Google
444
498
  include ::Google::Protobuf::MessageExts
445
499
  extend ::Google::Protobuf::MessageExts::ClassMethods
446
500
  end
501
+
502
+ # Multimodal specification: Will return an image from specified source.
503
+ # If multiple sources are specified, the pick is a quality based decision.
504
+ # @!attribute [rw] image_source
505
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::AnswerGenerationSpec::MultimodalSpec::ImageSource]
506
+ # Optional. Source of image returned in the answer.
507
+ class MultimodalSpec
508
+ include ::Google::Protobuf::MessageExts
509
+ extend ::Google::Protobuf::MessageExts::ClassMethods
510
+
511
+ # Specifies the image source.
512
+ module ImageSource
513
+ # Unspecified image source (multimodal feature is disabled by default).
514
+ IMAGE_SOURCE_UNSPECIFIED = 0
515
+
516
+ # Behavior when service determines the pick from all available sources.
517
+ ALL_AVAILABLE_SOURCES = 1
518
+
519
+ # Includes image from corpus in the answer.
520
+ CORPUS_IMAGE_ONLY = 2
521
+
522
+ # Triggers figure generation in the answer.
523
+ FIGURE_GENERATION_ONLY = 3
524
+ end
525
+ end
447
526
  end
448
527
 
449
528
  # Search specification.
@@ -652,6 +731,10 @@ module Google
652
731
  # @!attribute [rw] query_rephraser_spec
653
732
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryRephraserSpec]
654
733
  # Query rephraser specification.
734
+ # @!attribute [rw] disable_spell_correction
735
+ # @return [::Boolean]
736
+ # Optional. Whether to disable spell correction.
737
+ # The default value is `false`.
655
738
  class QueryUnderstandingSpec
656
739
  include ::Google::Protobuf::MessageExts
657
740
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -680,6 +763,9 @@ module Google
680
763
 
681
764
  # Non-answer-seeking query classification type, for no clear intent.
682
765
  NON_ANSWER_SEEKING_QUERY_V2 = 4
766
+
767
+ # User defined query classification type.
768
+ USER_DEFINED_CLASSIFICATION_QUERY = 5
683
769
  end
684
770
  end
685
771
 
@@ -692,9 +778,76 @@ module Google
692
778
  # Max rephrase steps.
693
779
  # The max number is 5 steps.
694
780
  # If not set or set to < 1, it will be set to 1 by default.
781
+ # @!attribute [rw] model_spec
782
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryRephraserSpec::ModelSpec]
783
+ # Optional. Query Rephraser Model specification.
695
784
  class QueryRephraserSpec
696
785
  include ::Google::Protobuf::MessageExts
697
786
  extend ::Google::Protobuf::MessageExts::ClassMethods
787
+
788
+ # Query Rephraser Model specification.
789
+ # @!attribute [rw] model_type
790
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryRephraserSpec::ModelSpec::ModelType]
791
+ # Optional. Enabled query rephraser model type. If not set, it will use
792
+ # LARGE by default.
793
+ class ModelSpec
794
+ include ::Google::Protobuf::MessageExts
795
+ extend ::Google::Protobuf::MessageExts::ClassMethods
796
+
797
+ # Query rephraser types. Currently only supports single-hop
798
+ # (max_rephrase_steps = 1) model selections. For multi-hop
799
+ # (max_rephrase_steps > 1), there is only one default model.
800
+ module ModelType
801
+ # Unspecified model type.
802
+ MODEL_TYPE_UNSPECIFIED = 0
803
+
804
+ # Small query rephraser model. Gemini 1.0 XS model.
805
+ SMALL = 1
806
+
807
+ # Large query rephraser model. Gemini 1.0 Pro model.
808
+ LARGE = 2
809
+ end
810
+ end
811
+ end
812
+ end
813
+
814
+ # End user specification.
815
+ # @!attribute [rw] end_user_metadata
816
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::EndUserSpec::EndUserMetaData>]
817
+ # Optional. End user metadata.
818
+ class EndUserSpec
819
+ include ::Google::Protobuf::MessageExts
820
+ extend ::Google::Protobuf::MessageExts::ClassMethods
821
+
822
+ # End user metadata.
823
+ # @!attribute [rw] chunk_info
824
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::EndUserSpec::EndUserMetaData::ChunkInfo]
825
+ # Chunk information.
826
+ class EndUserMetaData
827
+ include ::Google::Protobuf::MessageExts
828
+ extend ::Google::Protobuf::MessageExts::ClassMethods
829
+
830
+ # Chunk information.
831
+ # @!attribute [rw] content
832
+ # @return [::String]
833
+ # Chunk textual content. It is limited to 8000 characters.
834
+ # @!attribute [rw] document_metadata
835
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::EndUserSpec::EndUserMetaData::ChunkInfo::DocumentMetadata]
836
+ # Metadata of the document from the current chunk.
837
+ class ChunkInfo
838
+ include ::Google::Protobuf::MessageExts
839
+ extend ::Google::Protobuf::MessageExts::ClassMethods
840
+
841
+ # Document metadata contains the information of the document of
842
+ # the current chunk.
843
+ # @!attribute [rw] title
844
+ # @return [::String]
845
+ # Title of the document.
846
+ class DocumentMetadata
847
+ include ::Google::Protobuf::MessageExts
848
+ extend ::Google::Protobuf::MessageExts::ClassMethods
849
+ end
850
+ end
698
851
  end
699
852
  end
700
853
 
@@ -753,6 +906,14 @@ module Google
753
906
  # @!attribute [rw] session
754
907
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Session]
755
908
  # Required. The session to create.
909
+ # @!attribute [rw] session_id
910
+ # @return [::String]
911
+ # Optional. The ID to use for the session, which will become the final
912
+ # component of the session's resource name.
913
+ #
914
+ # This value should be 1-63 characters, and valid characters
915
+ # are /[a-z0-9][a-z0-9-]\\{0,61}[a-z0-9]/. If not specified, a unique ID will
916
+ # be generated.
756
917
  class CreateSessionRequest
757
918
  include ::Google::Protobuf::MessageExts
758
919
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -816,7 +977,9 @@ module Google
816
977
  # @!attribute [rw] filter
817
978
  # @return [::String]
818
979
  # A comma-separated list of fields to filter by, in EBNF grammar.
980
+ #
819
981
  # The supported fields are:
982
+ #
820
983
  # * `user_pseudo_id`
821
984
  # * `state`
822
985
  # * `display_name`
@@ -825,29 +988,36 @@ module Google
825
988
  # * `labels`
826
989
  # * `create_time`
827
990
  # * `update_time`
991
+ # * `collaborative_project`
828
992
  #
829
993
  # Examples:
830
- # "user_pseudo_id = some_id"
831
- # "display_name = \"some_name\""
832
- # "starred = true"
833
- # "is_pinned=true AND (NOT labels:hidden)"
834
- # "create_time > \"1970-01-01T12:00:00Z\""
994
+ #
995
+ # * `user_pseudo_id = some_id`
996
+ # * `display_name = "some_name"`
997
+ # * `starred = true`
998
+ # * `is_pinned=true AND (NOT labels:hidden)`
999
+ # * `create_time > "1970-01-01T12:00:00Z"`
1000
+ # * `collaborative_project =
1001
+ # "projects/123/locations/global/collections/default_collection/engines/"
1002
+ # "default_engine/collaborative_projects/cp1"`
835
1003
  # @!attribute [rw] order_by
836
1004
  # @return [::String]
837
1005
  # A comma-separated list of fields to order by, sorted in ascending order.
838
1006
  # Use "desc" after a field name for descending.
1007
+ #
839
1008
  # Supported fields:
840
1009
  #
841
1010
  # * `update_time`
842
1011
  # * `create_time`
843
1012
  # * `session_name`
844
1013
  # * `is_pinned`
1014
+ # * `display_name`
845
1015
  #
846
1016
  # Example:
847
1017
  #
848
- # * "update_time desc"
849
- # * "create_time"
850
- # * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
1018
+ # * `update_time desc`
1019
+ # * `create_time`
1020
+ # * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then
851
1021
  # by update_time.
852
1022
  class ListSessionsRequest
853
1023
  include ::Google::Protobuf::MessageExts