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
@@ -32,12 +32,22 @@ module Google
32
32
  # @!attribute [rw] answer_text
33
33
  # @return [::String]
34
34
  # The textual answer.
35
+ # @!attribute [rw] grounding_score
36
+ # @return [::Float]
37
+ # A score in the range of [0, 1] describing how grounded the answer is by the
38
+ # reference chunks.
35
39
  # @!attribute [rw] citations
36
40
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::Citation>]
37
41
  # Citations.
42
+ # @!attribute [rw] grounding_supports
43
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::GroundingSupport>]
44
+ # Optional. Grounding supports.
38
45
  # @!attribute [rw] references
39
46
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::Reference>]
40
47
  # References.
48
+ # @!attribute [r] blob_attachments
49
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::BlobAttachment>]
50
+ # Output only. List of blob attachments in the answer.
41
51
  # @!attribute [rw] related_questions
42
52
  # @return [::Array<::String>]
43
53
  # Suggested related questions.
@@ -57,6 +67,9 @@ module Google
57
67
  # @!attribute [r] complete_time
58
68
  # @return [::Google::Protobuf::Timestamp]
59
69
  # Output only. Answer completed timestamp.
70
+ # @!attribute [rw] safety_ratings
71
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SafetyRating>]
72
+ # Optional. Safety ratings.
60
73
  class Answer
61
74
  include ::Google::Protobuf::MessageExts
62
75
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -65,10 +78,13 @@ module Google
65
78
  # @!attribute [rw] start_index
66
79
  # @return [::Integer]
67
80
  # Index indicates the start of the segment, measured in bytes (UTF-8
68
- # unicode).
81
+ # unicode). If there are multi-byte characters,such as non-ASCII
82
+ # characters, the index measurement is longer than the string length.
69
83
  # @!attribute [rw] end_index
70
84
  # @return [::Integer]
71
- # End of the attributed segment, exclusive.
85
+ # End of the attributed segment, exclusive. Measured in bytes (UTF-8
86
+ # unicode). If there are multi-byte characters,such as non-ASCII
87
+ # characters, the index measurement is longer than the string length.
72
88
  # @!attribute [rw] sources
73
89
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::CitationSource>]
74
90
  # Citation sources for the attributed segment.
@@ -86,6 +102,35 @@ module Google
86
102
  extend ::Google::Protobuf::MessageExts::ClassMethods
87
103
  end
88
104
 
105
+ # Grounding support for a claim in `answer_text`.
106
+ # @!attribute [rw] start_index
107
+ # @return [::Integer]
108
+ # Required. Index indicates the start of the claim, measured in bytes
109
+ # (UTF-8 unicode).
110
+ # @!attribute [rw] end_index
111
+ # @return [::Integer]
112
+ # Required. End of the claim, exclusive.
113
+ # @!attribute [rw] grounding_score
114
+ # @return [::Float]
115
+ # A score in the range of [0, 1] describing how grounded is a specific
116
+ # claim by the references.
117
+ # Higher value means that the claim is better supported by the reference
118
+ # chunks.
119
+ # @!attribute [rw] grounding_check_required
120
+ # @return [::Boolean]
121
+ # Indicates that this claim required grounding check. When the
122
+ # system decided this claim didn't require attribution/grounding check,
123
+ # this field is set to false. In that case, no grounding check was
124
+ # done for the claim and therefore `grounding_score`, `sources` is not
125
+ # returned.
126
+ # @!attribute [rw] sources
127
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::CitationSource>]
128
+ # Optional. Citation sources for the claim.
129
+ class GroundingSupport
130
+ include ::Google::Protobuf::MessageExts
131
+ extend ::Google::Protobuf::MessageExts::ClassMethods
132
+ end
133
+
89
134
  # Reference.
90
135
  # @!attribute [rw] unstructured_document_info
91
136
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::Reference::UnstructuredDocumentInfo]
@@ -141,6 +186,9 @@ module Google
141
186
  # This value is for informational purpose only. It may change for
142
187
  # the same query and chunk at any time due to a model retraining or
143
188
  # change in implementation.
189
+ # @!attribute [r] blob_attachment_indexes
190
+ # @return [::Array<::Integer>]
191
+ # Output only. Stores indexes of blobattachments linked to this chunk.
144
192
  class ChunkContent
145
193
  include ::Google::Protobuf::MessageExts
146
194
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -164,6 +212,9 @@ module Google
164
212
  # @!attribute [rw] document_metadata
165
213
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::Reference::ChunkInfo::DocumentMetadata]
166
214
  # Document metadata.
215
+ # @!attribute [r] blob_attachment_indexes
216
+ # @return [::Array<::Integer>]
217
+ # Output only. Stores indexes of blobattachments linked to this chunk.
167
218
  class ChunkInfo
168
219
  include ::Google::Protobuf::MessageExts
169
220
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -198,12 +249,56 @@ module Google
198
249
  # @!attribute [rw] struct_data
199
250
  # @return [::Google::Protobuf::Struct]
200
251
  # Structured search data.
252
+ # @!attribute [r] title
253
+ # @return [::String]
254
+ # Output only. The title of the document.
255
+ # @!attribute [r] uri
256
+ # @return [::String]
257
+ # Output only. The URI of the document.
201
258
  class StructuredDocumentInfo
202
259
  include ::Google::Protobuf::MessageExts
203
260
  extend ::Google::Protobuf::MessageExts::ClassMethods
204
261
  end
205
262
  end
206
263
 
264
+ # Stores binarydata attached to text answer, e.g. image, video, audio, etc.
265
+ # @!attribute [r] data
266
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::BlobAttachment::Blob]
267
+ # Output only. The mime type and data of the blob.
268
+ # @!attribute [r] attribution_type
269
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::BlobAttachment::AttributionType]
270
+ # Output only. The attribution type of the blob.
271
+ class BlobAttachment
272
+ include ::Google::Protobuf::MessageExts
273
+ extend ::Google::Protobuf::MessageExts::ClassMethods
274
+
275
+ # The media type and data of the blob.
276
+ # @!attribute [r] mime_type
277
+ # @return [::String]
278
+ # Output only. The media type (MIME type) of the generated or retrieved
279
+ # data.
280
+ # @!attribute [r] data
281
+ # @return [::String]
282
+ # Output only. Raw bytes.
283
+ class Blob
284
+ include ::Google::Protobuf::MessageExts
285
+ extend ::Google::Protobuf::MessageExts::ClassMethods
286
+ end
287
+
288
+ # The source of the blob.
289
+ module AttributionType
290
+ # Unspecified attribution type.
291
+ ATTRIBUTION_TYPE_UNSPECIFIED = 0
292
+
293
+ # The attachment data is from the corpus.
294
+ CORPUS = 1
295
+
296
+ # The attachment data is generated by the model through code
297
+ # generation.
298
+ GENERATED = 2
299
+ end
300
+ end
301
+
207
302
  # Step information.
208
303
  # @!attribute [rw] state
209
304
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::Step::State]
@@ -362,6 +457,9 @@ module Google
362
457
 
363
458
  # Non-answer-seeking query classification type, for no clear intent.
364
459
  NON_ANSWER_SEEKING_QUERY_V2 = 4
460
+
461
+ # User defined query classification type.
462
+ USER_DEFINED_CLASSIFICATION_QUERY = 5
365
463
  end
366
464
  end
367
465
  end
@@ -379,6 +477,9 @@ module Google
379
477
 
380
478
  # Answer generation has succeeded.
381
479
  SUCCEEDED = 3
480
+
481
+ # Answer generation is currently in progress.
482
+ STREAMING = 4
382
483
  end
383
484
 
384
485
  # An enum for answer skipped reasons.
@@ -434,6 +535,20 @@ module Google
434
535
  # Google skips the answer if a well grounded answer was unable to be
435
536
  # generated.
436
537
  LOW_GROUNDED_ANSWER = 9
538
+
539
+ # The user defined query classification ignored case.
540
+ #
541
+ # Google skips the answer if the query is classified as a user defined
542
+ # query classification.
543
+ USER_DEFINED_CLASSIFICATION_QUERY_IGNORED = 10
544
+
545
+ # The unhelpful answer case.
546
+ #
547
+ # Google skips the answer if the answer is not helpful. This can be due to
548
+ # a variety of factors, including but not limited to: the query is not
549
+ # answerable, the answer is not relevant to the query, or the answer is
550
+ # not well-formatted.
551
+ UNHELPFUL_ANSWER = 11
437
552
  end
438
553
  end
439
554
  end
@@ -0,0 +1,401 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module DiscoveryEngine
23
+ module V1beta
24
+ # AssistAnswer resource, main part of
25
+ # [AssistResponse][google.cloud.discoveryengine.v1beta.AssistResponse].
26
+ # @!attribute [rw] name
27
+ # @return [::String]
28
+ # Immutable. Identifier. Resource name of the `AssistAnswer`.
29
+ # Format:
30
+ # `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`
31
+ #
32
+ # This field must be a UTF-8 encoded string with a length limit of 1024
33
+ # characters.
34
+ # @!attribute [rw] state
35
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer::State]
36
+ # State of the answer generation.
37
+ # @!attribute [rw] replies
38
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer::Reply>]
39
+ # Replies of the assistant.
40
+ # @!attribute [rw] assist_skipped_reasons
41
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer::AssistSkippedReason>]
42
+ # Reasons for not answering the assist call.
43
+ # @!attribute [rw] customer_policy_enforcement_result
44
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer::CustomerPolicyEnforcementResult]
45
+ # Optional. The field contains information about the various policy checks'
46
+ # results like the banned phrases or the Model Armor checks. This field is
47
+ # populated only if the assist call was skipped due to a policy violation.
48
+ class AssistAnswer
49
+ include ::Google::Protobuf::MessageExts
50
+ extend ::Google::Protobuf::MessageExts::ClassMethods
51
+
52
+ # One part of the multi-part response of the assist call.
53
+ # @!attribute [rw] grounded_content
54
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistantGroundedContent]
55
+ # Possibly grounded response text or media from the assistant.
56
+ # @!attribute [rw] create_time
57
+ # @return [::Google::Protobuf::Timestamp]
58
+ # The time when the reply was created.
59
+ class Reply
60
+ include ::Google::Protobuf::MessageExts
61
+ extend ::Google::Protobuf::MessageExts::ClassMethods
62
+ end
63
+
64
+ # Customer policy enforcement results. Contains the results of the various
65
+ # policy checks, like the banned phrases or the Model Armor checks.
66
+ # @!attribute [rw] verdict
67
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer::CustomerPolicyEnforcementResult::Verdict]
68
+ # Final verdict of the customer policy enforcement. If only one policy
69
+ # blocked the processing, the verdict is BLOCK.
70
+ # @!attribute [rw] policy_results
71
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer::CustomerPolicyEnforcementResult::PolicyEnforcementResult>]
72
+ # Customer policy enforcement results.
73
+ # Populated only if the assist call was skipped due to a policy
74
+ # violation. It contains results from those filters that blocked the
75
+ # processing of the query.
76
+ class CustomerPolicyEnforcementResult
77
+ include ::Google::Protobuf::MessageExts
78
+ extend ::Google::Protobuf::MessageExts::ClassMethods
79
+
80
+ # Customer policy enforcement result for the banned phrase policy.
81
+ # @!attribute [rw] banned_phrases
82
+ # @return [::Array<::String>]
83
+ # The banned phrases that were found in the query or the answer.
84
+ class BannedPhraseEnforcementResult
85
+ include ::Google::Protobuf::MessageExts
86
+ extend ::Google::Protobuf::MessageExts::ClassMethods
87
+ end
88
+
89
+ # Customer policy enforcement result for the Model Armor policy.
90
+ # @!attribute [rw] model_armor_violation
91
+ # @return [::String]
92
+ # The Model Armor violation that was found.
93
+ #
94
+ # Note: The following fields are mutually exclusive: `model_armor_violation`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
95
+ # @!attribute [rw] error
96
+ # @return [::Google::Rpc::Status]
97
+ # The error returned by Model Armor if the policy enforcement failed
98
+ # for some reason.
99
+ #
100
+ # Note: The following fields are mutually exclusive: `error`, `model_armor_violation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
101
+ class ModelArmorEnforcementResult
102
+ include ::Google::Protobuf::MessageExts
103
+ extend ::Google::Protobuf::MessageExts::ClassMethods
104
+ end
105
+
106
+ # Customer policy enforcement result for a single policy type.
107
+ # @!attribute [rw] banned_phrase_enforcement_result
108
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer::CustomerPolicyEnforcementResult::BannedPhraseEnforcementResult]
109
+ # The policy enforcement result for the banned phrase policy.
110
+ #
111
+ # Note: The following fields are mutually exclusive: `banned_phrase_enforcement_result`, `model_armor_enforcement_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
112
+ # @!attribute [rw] model_armor_enforcement_result
113
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer::CustomerPolicyEnforcementResult::ModelArmorEnforcementResult]
114
+ # The policy enforcement result for the Model Armor policy.
115
+ #
116
+ # Note: The following fields are mutually exclusive: `model_armor_enforcement_result`, `banned_phrase_enforcement_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
117
+ class PolicyEnforcementResult
118
+ include ::Google::Protobuf::MessageExts
119
+ extend ::Google::Protobuf::MessageExts::ClassMethods
120
+ end
121
+
122
+ # The verdict of the customer policy enforcement.
123
+ module Verdict
124
+ # Unknown value.
125
+ UNSPECIFIED = 0
126
+
127
+ # There was no policy violation.
128
+ ALLOW = 1
129
+
130
+ # Processing was blocked by the customer policy.
131
+ BLOCK = 2
132
+ end
133
+ end
134
+
135
+ # State of the answer generation.
136
+ module State
137
+ # Unknown.
138
+ STATE_UNSPECIFIED = 0
139
+
140
+ # Assist operation is currently in progress.
141
+ IN_PROGRESS = 1
142
+
143
+ # Assist operation has failed.
144
+ FAILED = 2
145
+
146
+ # Assist operation has succeeded.
147
+ SUCCEEDED = 3
148
+
149
+ # Assist operation has been skipped.
150
+ SKIPPED = 4
151
+
152
+ # Assist operation has been cancelled (e.g. client closed the stream).
153
+ # May contain a partial response.
154
+ CANCELLED = 5
155
+ end
156
+
157
+ # Possible reasons for not answering an assist call.
158
+ module AssistSkippedReason
159
+ # Default value. Skip reason is not specified.
160
+ ASSIST_SKIPPED_REASON_UNSPECIFIED = 0
161
+
162
+ # The assistant ignored the query, because it did not appear to be
163
+ # answer-seeking.
164
+ NON_ASSIST_SEEKING_QUERY_IGNORED = 1
165
+
166
+ # The assistant ignored the query or refused to answer because of a
167
+ # customer policy violation (e.g., the query or the answer contained a
168
+ # banned phrase).
169
+ CUSTOMER_POLICY_VIOLATION = 2
170
+ end
171
+ end
172
+
173
+ # Multi-modal content.
174
+ # @!attribute [rw] text
175
+ # @return [::String]
176
+ # Inline text.
177
+ #
178
+ # Note: The following fields are mutually exclusive: `text`, `inline_data`, `file`, `executable_code`, `code_execution_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
179
+ # @!attribute [rw] inline_data
180
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistantContent::Blob]
181
+ # Inline binary data.
182
+ #
183
+ # Note: The following fields are mutually exclusive: `inline_data`, `text`, `file`, `executable_code`, `code_execution_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
184
+ # @!attribute [rw] file
185
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistantContent::File]
186
+ # A file, e.g., an audio summary.
187
+ #
188
+ # Note: The following fields are mutually exclusive: `file`, `text`, `inline_data`, `executable_code`, `code_execution_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
189
+ # @!attribute [rw] executable_code
190
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistantContent::ExecutableCode]
191
+ # Code generated by the model that is meant to be executed.
192
+ #
193
+ # Note: The following fields are mutually exclusive: `executable_code`, `text`, `inline_data`, `file`, `code_execution_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
194
+ # @!attribute [rw] code_execution_result
195
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistantContent::CodeExecutionResult]
196
+ # Result of executing an ExecutableCode.
197
+ #
198
+ # Note: The following fields are mutually exclusive: `code_execution_result`, `text`, `inline_data`, `file`, `executable_code`. If a field in that set is populated, all other fields in the set will automatically be cleared.
199
+ # @!attribute [rw] role
200
+ # @return [::String]
201
+ # The producer of the content. Can be "model" or "user".
202
+ # @!attribute [rw] thought
203
+ # @return [::Boolean]
204
+ # Optional. Indicates if the part is thought from the model.
205
+ class AssistantContent
206
+ include ::Google::Protobuf::MessageExts
207
+ extend ::Google::Protobuf::MessageExts::ClassMethods
208
+
209
+ # Inline blob.
210
+ # @!attribute [rw] mime_type
211
+ # @return [::String]
212
+ # Required. The media type (MIME type) of the generated data.
213
+ # @!attribute [rw] data
214
+ # @return [::String]
215
+ # Required. Raw bytes.
216
+ class Blob
217
+ include ::Google::Protobuf::MessageExts
218
+ extend ::Google::Protobuf::MessageExts::ClassMethods
219
+ end
220
+
221
+ # A file, e.g., an audio summary.
222
+ # @!attribute [rw] mime_type
223
+ # @return [::String]
224
+ # Required. The media type (MIME type) of the file.
225
+ # @!attribute [rw] file_id
226
+ # @return [::String]
227
+ # Required. The file ID.
228
+ class File
229
+ include ::Google::Protobuf::MessageExts
230
+ extend ::Google::Protobuf::MessageExts::ClassMethods
231
+ end
232
+
233
+ # Code generated by the model that is meant to be executed by the model.
234
+ # @!attribute [rw] code
235
+ # @return [::String]
236
+ # Required. The code content. Currently only supports Python.
237
+ class ExecutableCode
238
+ include ::Google::Protobuf::MessageExts
239
+ extend ::Google::Protobuf::MessageExts::ClassMethods
240
+ end
241
+
242
+ # Result of executing ExecutableCode.
243
+ # @!attribute [rw] outcome
244
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistantContent::CodeExecutionResult::Outcome]
245
+ # Required. Outcome of the code execution.
246
+ # @!attribute [rw] output
247
+ # @return [::String]
248
+ # Optional. Contains stdout when code execution is successful, stderr or
249
+ # other description otherwise.
250
+ class CodeExecutionResult
251
+ include ::Google::Protobuf::MessageExts
252
+ extend ::Google::Protobuf::MessageExts::ClassMethods
253
+
254
+ # Enumeration of possible outcomes of the code execution.
255
+ module Outcome
256
+ # Unspecified status. This value should not be used.
257
+ OUTCOME_UNSPECIFIED = 0
258
+
259
+ # Code execution completed successfully.
260
+ OUTCOME_OK = 1
261
+
262
+ # Code execution finished but with a failure. `stderr` should contain the
263
+ # reason.
264
+ OUTCOME_FAILED = 2
265
+
266
+ # Code execution ran for too long, and was cancelled. There may or may
267
+ # not be a partial output present.
268
+ OUTCOME_DEADLINE_EXCEEDED = 3
269
+ end
270
+ end
271
+ end
272
+
273
+ # A piece of content and possibly its grounding information.
274
+ #
275
+ # Not all content needs grounding. Phrases like "Of course, I will gladly
276
+ # search it for you." do not need grounding.
277
+ # @!attribute [rw] text_grounding_metadata
278
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistantGroundedContent::TextGroundingMetadata]
279
+ # Metadata for grounding based on text sources.
280
+ # @!attribute [rw] content
281
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistantContent]
282
+ # The content.
283
+ # @!attribute [rw] citation_metadata
284
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::CitationMetadata]
285
+ # Source attribution of the generated content. See also
286
+ # https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
287
+ class AssistantGroundedContent
288
+ include ::Google::Protobuf::MessageExts
289
+ extend ::Google::Protobuf::MessageExts::ClassMethods
290
+
291
+ # Grounding details for text sources.
292
+ # @!attribute [rw] segments
293
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AssistantGroundedContent::TextGroundingMetadata::Segment>]
294
+ # Grounding information for parts of the text.
295
+ # @!attribute [rw] visual_segments
296
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AssistantGroundedContent::TextGroundingMetadata::VisualSegment>]
297
+ # Grounding information for parts of the visual content.
298
+ # @!attribute [rw] references
299
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AssistantGroundedContent::TextGroundingMetadata::Reference>]
300
+ # References for the grounded text.
301
+ class TextGroundingMetadata
302
+ include ::Google::Protobuf::MessageExts
303
+ extend ::Google::Protobuf::MessageExts::ClassMethods
304
+
305
+ # Grounding information for a segment of the text.
306
+ # @!attribute [rw] start_index
307
+ # @return [::Integer]
308
+ # Zero-based index indicating the start of the segment, measured in bytes
309
+ # of a UTF-8 string (i.e. characters encoded on multiple bytes have a
310
+ # length of more than one).
311
+ # @!attribute [rw] end_index
312
+ # @return [::Integer]
313
+ # End of the segment, exclusive.
314
+ # @!attribute [rw] reference_indices
315
+ # @return [::Array<::Integer>]
316
+ # References for the segment.
317
+ # @!attribute [rw] grounding_score
318
+ # @return [::Float]
319
+ # Score for the segment.
320
+ # @!attribute [rw] text
321
+ # @return [::String]
322
+ # The text segment itself.
323
+ class Segment
324
+ include ::Google::Protobuf::MessageExts
325
+ extend ::Google::Protobuf::MessageExts::ClassMethods
326
+ end
327
+
328
+ # Grounding information for a visual segment.
329
+ # @!attribute [rw] reference_indices
330
+ # @return [::Array<::Integer>]
331
+ # References for the visual segment.
332
+ # @!attribute [rw] content_id
333
+ # @return [::String]
334
+ # The content id of the visual segment. In order to display the citation
335
+ # of the visual element, this content_id needs to match with the
336
+ # `grounded_content.content_metadata.content_id` field.
337
+ class VisualSegment
338
+ include ::Google::Protobuf::MessageExts
339
+ extend ::Google::Protobuf::MessageExts::ClassMethods
340
+ end
341
+
342
+ # Referenced content and related document metadata.
343
+ # @!attribute [rw] content
344
+ # @return [::String]
345
+ # Referenced text content.
346
+ # @!attribute [rw] code_snippet
347
+ # @return [::String]
348
+ # Chunk of code snippet from the referenced document.
349
+ # @!attribute [rw] document_metadata
350
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistantGroundedContent::TextGroundingMetadata::Reference::DocumentMetadata]
351
+ # Document metadata.
352
+ class Reference
353
+ include ::Google::Protobuf::MessageExts
354
+ extend ::Google::Protobuf::MessageExts::ClassMethods
355
+
356
+ # Document metadata.
357
+ # @!attribute [rw] language
358
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AssistantGroundedContent::TextGroundingMetadata::Reference::DocumentMetadata::Language]
359
+ # @!attribute [rw] document
360
+ # @return [::String]
361
+ # Document resource name.
362
+ # @!attribute [rw] uri
363
+ # @return [::String]
364
+ # URI for the document. It may contain a URL that redirects to the
365
+ # actual website.
366
+ # @!attribute [rw] title
367
+ # @return [::String]
368
+ # Title.
369
+ # @!attribute [rw] page_identifier
370
+ # @return [::String]
371
+ # Page identifier.
372
+ # @!attribute [rw] domain
373
+ # @return [::String]
374
+ # Domain name from the document URI. Note that the `uri` field may
375
+ # contain a URL that redirects to the actual website, in which case
376
+ # this will contain the domain name of the target site.
377
+ # @!attribute [rw] mime_type
378
+ # @return [::String]
379
+ # The mime type of the document.
380
+ # https://www.iana.org/assignments/media-types/media-types.xhtml.
381
+ class DocumentMetadata
382
+ include ::Google::Protobuf::MessageExts
383
+ extend ::Google::Protobuf::MessageExts::ClassMethods
384
+
385
+ # Language of the referenced content. For now, it is only used for
386
+ # code.
387
+ module Language
388
+ LANGUAGE_UNSPECIFIED = 0
389
+
390
+ PYTHON = 1
391
+
392
+ SQL = 2
393
+ end
394
+ end
395
+ end
396
+ end
397
+ end
398
+ end
399
+ end
400
+ end
401
+ end