@google-cloud/discoveryengine 1.6.0 → 1.8.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 (185) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/README.md +24 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/common.proto +14 -2
  4. package/build/protos/google/cloud/discoveryengine/v1/completion.proto +1 -1
  5. package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +1 -1
  6. package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +1 -1
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +6 -1
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +18 -1
  9. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +1 -1
  10. package/build/protos/google/cloud/discoveryengine/v1/document.proto +10 -1
  11. package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +7 -1
  12. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +3 -3
  13. package/build/protos/google/cloud/discoveryengine/v1/engine_service.proto +1 -1
  14. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +285 -23
  15. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +4 -1
  16. package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +228 -0
  17. package/build/protos/google/cloud/discoveryengine/v1/schema.proto +1 -1
  18. package/build/protos/google/cloud/discoveryengine/v1/schema_service.proto +1 -1
  19. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +126 -22
  20. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +1 -1
  21. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +1 -1
  22. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +17 -12
  23. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +1 -1
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config.proto +1 -1
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config_service.proto +1 -1
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/answer.proto +328 -0
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +42 -2
  28. package/build/protos/google/cloud/discoveryengine/v1alpha/chunk_service.proto +1 -1
  29. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +22 -2
  30. package/build/protos/google/cloud/discoveryengine/v1alpha/completion.proto +1 -1
  31. package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +1 -1
  32. package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +1 -1
  33. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +575 -1
  34. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +1 -1
  35. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +1 -1
  36. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +20 -1
  37. package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +4 -7
  38. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +65 -1
  39. package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +3 -3
  40. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +1 -1
  41. package/build/protos/google/cloud/discoveryengine/v1alpha/estimate_billing_service.proto +1 -1
  42. package/build/protos/google/cloud/discoveryengine/v1alpha/grounded_generation_service.proto +120 -0
  43. package/build/protos/google/cloud/discoveryengine/v1alpha/grounding.proto +55 -0
  44. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +284 -25
  45. package/build/protos/google/cloud/discoveryengine/v1alpha/project.proto +102 -0
  46. package/build/protos/google/cloud/discoveryengine/v1alpha/project_service.proto +171 -0
  47. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +1 -1
  48. package/build/protos/google/cloud/discoveryengine/v1alpha/rank_service.proto +1 -1
  49. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +1 -1
  50. package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +22 -1
  51. package/build/protos/google/cloud/discoveryengine/v1alpha/schema_service.proto +1 -1
  52. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +159 -25
  53. package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +10 -4
  54. package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config.proto +1 -1
  55. package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config_service.proto +3 -2
  56. package/build/protos/google/cloud/discoveryengine/v1alpha/session.proto +94 -0
  57. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +1 -1
  58. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +1 -1
  59. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +2 -2
  60. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +1 -1
  61. package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +328 -0
  62. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +31 -2
  63. package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +1 -1
  64. package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +1 -1
  65. package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +1 -1
  66. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +560 -1
  67. package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +1 -1
  68. package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +1 -1
  69. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
  70. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +4 -7
  71. package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +7 -1
  72. package/build/protos/google/cloud/discoveryengine/v1beta/engine.proto +3 -3
  73. package/build/protos/google/cloud/discoveryengine/v1beta/engine_service.proto +94 -1
  74. package/build/protos/google/cloud/discoveryengine/v1beta/grounded_generation_service.proto +120 -0
  75. package/build/protos/google/cloud/discoveryengine/v1beta/grounding.proto +55 -0
  76. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +284 -25
  77. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +1 -1
  78. package/build/protos/google/cloud/discoveryengine/v1beta/rank_service.proto +115 -0
  79. package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +1 -1
  80. package/build/protos/google/cloud/discoveryengine/v1beta/schema.proto +1 -1
  81. package/build/protos/google/cloud/discoveryengine/v1beta/schema_service.proto +1 -1
  82. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +143 -23
  83. package/build/protos/google/cloud/discoveryengine/v1beta/search_tuning_service.proto +8 -2
  84. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +1 -1
  85. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto +1 -1
  86. package/build/protos/google/cloud/discoveryengine/v1beta/session.proto +94 -0
  87. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine.proto +1 -1
  88. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine_service.proto +1 -1
  89. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +2 -2
  90. package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +1 -1
  91. package/build/protos/protos.d.ts +44799 -26093
  92. package/build/protos/protos.js +120465 -74222
  93. package/build/protos/protos.json +8911 -4556
  94. package/build/src/index.d.ts +4 -1
  95. package/build/src/index.js +4 -1
  96. package/build/src/v1/conversational_search_service_client.d.ts +4 -0
  97. package/build/src/v1/document_service_client.d.ts +47 -19
  98. package/build/src/v1/index.d.ts +1 -0
  99. package/build/src/v1/index.js +3 -1
  100. package/build/src/v1/recommendation_service_client.d.ts +1087 -0
  101. package/build/src/v1/recommendation_service_client.js +1432 -0
  102. package/build/src/v1/recommendation_service_client_config.json +43 -0
  103. package/build/src/v1/search_service_client.d.ts +27 -9
  104. package/build/src/v1/search_service_client.js +18 -6
  105. package/build/src/v1/search_service_client_config.json +5 -5
  106. package/build/src/v1alpha/acl_config_service_client.d.ts +330 -0
  107. package/build/src/v1alpha/acl_config_service_client.js +454 -0
  108. package/build/src/v1alpha/chunk_service_client.d.ts +330 -0
  109. package/build/src/v1alpha/chunk_service_client.js +454 -0
  110. package/build/src/v1alpha/completion_service_client.d.ts +330 -0
  111. package/build/src/v1alpha/completion_service_client.js +457 -0
  112. package/build/src/v1alpha/conversational_search_service_client.d.ts +674 -0
  113. package/build/src/v1alpha/conversational_search_service_client.js +724 -0
  114. package/build/src/v1alpha/conversational_search_service_client_config.json +35 -0
  115. package/build/src/v1alpha/data_store_service_client.d.ts +330 -0
  116. package/build/src/v1alpha/data_store_service_client.js +457 -0
  117. package/build/src/v1alpha/document_service_client.d.ts +410 -21
  118. package/build/src/v1alpha/document_service_client.js +479 -0
  119. package/build/src/v1alpha/document_service_client_config.json +5 -0
  120. package/build/src/v1alpha/engine_service_client.d.ts +330 -0
  121. package/build/src/v1alpha/engine_service_client.js +457 -0
  122. package/build/src/v1alpha/estimate_billing_service_client.d.ts +330 -0
  123. package/build/src/v1alpha/estimate_billing_service_client.js +457 -0
  124. package/build/src/v1alpha/grounded_generation_service_client.d.ts +1574 -0
  125. package/build/src/v1alpha/grounded_generation_service_client.js +2248 -0
  126. package/build/src/v1alpha/grounded_generation_service_client_config.json +43 -0
  127. package/build/src/v1alpha/index.d.ts +3 -1
  128. package/build/src/v1alpha/index.js +7 -3
  129. package/build/src/v1alpha/project_service_client.d.ts +1756 -0
  130. package/build/src/v1alpha/project_service_client.js +2500 -0
  131. package/build/src/v1alpha/project_service_client_config.json +38 -0
  132. package/build/src/v1alpha/rank_service_client.d.ts +330 -0
  133. package/build/src/v1alpha/rank_service_client.js +454 -0
  134. package/build/src/v1alpha/rank_service_client_config.json +15 -2
  135. package/build/src/v1alpha/recommendation_service_client.d.ts +330 -0
  136. package/build/src/v1alpha/recommendation_service_client.js +454 -0
  137. package/build/src/v1alpha/schema_service_client.d.ts +330 -0
  138. package/build/src/v1alpha/schema_service_client.js +457 -0
  139. package/build/src/v1alpha/search_service_client.d.ts +360 -15
  140. package/build/src/v1alpha/search_service_client.js +474 -10
  141. package/build/src/v1alpha/search_service_client_config.json +5 -5
  142. package/build/src/v1alpha/search_tuning_service_client.d.ts +330 -0
  143. package/build/src/v1alpha/search_tuning_service_client.js +457 -0
  144. package/build/src/v1alpha/serving_config_service_client.d.ts +317 -1
  145. package/build/src/v1alpha/serving_config_service_client.js +434 -1
  146. package/build/src/v1alpha/site_search_engine_service_client.d.ts +330 -0
  147. package/build/src/v1alpha/site_search_engine_service_client.js +457 -0
  148. package/build/src/v1alpha/user_event_service_client.d.ts +330 -0
  149. package/build/src/v1alpha/user_event_service_client.js +457 -0
  150. package/build/src/v1beta/completion_service_client.d.ts +315 -0
  151. package/build/src/v1beta/completion_service_client.js +432 -0
  152. package/build/src/v1beta/conversational_search_service_client.d.ts +659 -0
  153. package/build/src/v1beta/conversational_search_service_client.js +702 -0
  154. package/build/src/v1beta/conversational_search_service_client_config.json +35 -0
  155. package/build/src/v1beta/data_store_service_client.d.ts +315 -0
  156. package/build/src/v1beta/data_store_service_client.js +432 -0
  157. package/build/src/v1beta/document_service_client.d.ts +361 -21
  158. package/build/src/v1beta/document_service_client.js +432 -0
  159. package/build/src/v1beta/engine_service_client.d.ts +410 -0
  160. package/build/src/v1beta/engine_service_client.js +518 -0
  161. package/build/src/v1beta/engine_service_client_config.json +12 -0
  162. package/build/src/v1beta/grounded_generation_service_client.d.ts +1406 -0
  163. package/build/src/v1beta/grounded_generation_service_client.js +2014 -0
  164. package/build/src/v1beta/grounded_generation_service_client_config.json +43 -0
  165. package/build/src/v1beta/index.d.ts +2 -0
  166. package/build/src/v1beta/index.js +5 -1
  167. package/build/src/v1beta/rank_service_client.d.ts +1416 -0
  168. package/build/src/v1beta/rank_service_client.js +2015 -0
  169. package/build/src/v1beta/rank_service_client_config.json +43 -0
  170. package/build/src/v1beta/recommendation_service_client.d.ts +315 -0
  171. package/build/src/v1beta/recommendation_service_client.js +432 -0
  172. package/build/src/v1beta/schema_service_client.d.ts +315 -0
  173. package/build/src/v1beta/schema_service_client.js +432 -0
  174. package/build/src/v1beta/search_service_client.d.ts +342 -12
  175. package/build/src/v1beta/search_service_client.js +450 -8
  176. package/build/src/v1beta/search_service_client_config.json +5 -5
  177. package/build/src/v1beta/search_tuning_service_client.d.ts +315 -0
  178. package/build/src/v1beta/search_tuning_service_client.js +432 -0
  179. package/build/src/v1beta/serving_config_service_client.d.ts +315 -0
  180. package/build/src/v1beta/serving_config_service_client.js +432 -0
  181. package/build/src/v1beta/site_search_engine_service_client.d.ts +315 -0
  182. package/build/src/v1beta/site_search_engine_service_client.js +432 -0
  183. package/build/src/v1beta/user_event_service_client.d.ts +315 -0
  184. package/build/src/v1beta/user_event_service_client.js +432 -0
  185. package/package.json +1 -1
@@ -1,4 +1,4 @@
1
- // Copyright 2022 Google LLC
1
+ // Copyright 2024 Google LLC
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -46,6 +46,40 @@ message Chunk {
46
46
 
47
47
  // Title of the document.
48
48
  string title = 2;
49
+
50
+ // Data representation.
51
+ // The structured JSON data for the document. It should conform to the
52
+ // registered [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an
53
+ // `INVALID_ARGUMENT` error is thrown.
54
+ google.protobuf.Struct struct_data = 3;
55
+ }
56
+
57
+ // Page span of the chunk.
58
+ message PageSpan {
59
+ // The start page of the chunk.
60
+ int32 page_start = 1;
61
+
62
+ // The end page of the chunk.
63
+ int32 page_end = 2;
64
+ }
65
+
66
+ // Metadata of the current chunk. This field is only populated on
67
+ // [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]
68
+ // API.
69
+ message ChunkMetadata {
70
+ // The previous chunks of the current chunk. The number is controlled by
71
+ // [SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks].
72
+ // This field is only populated on
73
+ // [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]
74
+ // API.
75
+ repeated Chunk previous_chunks = 1;
76
+
77
+ // The next chunks of the current chunk. The number is controlled by
78
+ // [SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks].
79
+ // This field is only populated on
80
+ // [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]
81
+ // API.
82
+ repeated Chunk next_chunks = 2;
49
83
  }
50
84
 
51
85
  // The full resource name of the chunk.
@@ -56,7 +90,7 @@ message Chunk {
56
90
  // characters.
57
91
  string name = 1;
58
92
 
59
- // Unique chunk id of the current chunk.
93
+ // Unique chunk ID of the current chunk.
60
94
  string id = 2;
61
95
 
62
96
  // Content is a string from a document (parsed content).
@@ -69,4 +103,10 @@ message Chunk {
69
103
  // It contains derived data that are not in the original input document.
70
104
  google.protobuf.Struct derived_struct_data = 4
71
105
  [(google.api.field_behavior) = OUTPUT_ONLY];
106
+
107
+ // Page span of the chunk.
108
+ PageSpan page_span = 6;
109
+
110
+ // Output only. Metadata of the current chunk.
111
+ ChunkMetadata chunk_metadata = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
72
112
  }
@@ -1,4 +1,4 @@
1
- // Copyright 2022 Google LLC
1
+ // Copyright 2024 Google LLC
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -1,4 +1,4 @@
1
- // Copyright 2022 Google LLC
1
+ // Copyright 2024 Google LLC
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -39,6 +39,18 @@ option (google.api.resource_definition) = {
39
39
  type: "discoveryengine.googleapis.com/Location"
40
40
  pattern: "projects/{project}/locations/{location}"
41
41
  };
42
+ option (google.api.resource_definition) = {
43
+ type: "discoveryengine.googleapis.com/GroundingConfig"
44
+ pattern: "projects/{project}/locations/{location}/groundingConfigs/{grounding_config}"
45
+ };
46
+ option (google.api.resource_definition) = {
47
+ type: "discoveryengine.googleapis.com/RankingConfig"
48
+ pattern: "projects/{project}/locations/{location}/rankingConfigs/{ranking_config}"
49
+ };
50
+ option (google.api.resource_definition) = {
51
+ type: "healthcare.googleapis.com/FhirStore"
52
+ pattern: "projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}"
53
+ };
42
54
 
43
55
  // The industry vertical associated with the
44
56
  // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
@@ -52,6 +64,9 @@ enum IndustryVertical {
52
64
 
53
65
  // The media industry vertical.
54
66
  MEDIA = 2;
67
+
68
+ // The healthcare FHIR vertical.
69
+ HEALTHCARE_FHIR = 7;
55
70
  }
56
71
 
57
72
  // The type of solution.
@@ -67,10 +82,15 @@ enum SolutionType {
67
82
 
68
83
  // Used for use cases related to the Generative AI agent.
69
84
  SOLUTION_TYPE_CHAT = 3;
85
+
86
+ // Used for use cases related to the Generative Chat agent.
87
+ // It's used for Generative chat engine only, the associated data stores
88
+ // must enrolled with `SOLUTION_TYPE_CHAT` solution.
89
+ SOLUTION_TYPE_GENERATIVE_CHAT = 4;
70
90
  }
71
91
 
72
92
  // Tiers of search features. Different tiers might have different
73
- // pricing. To learn more, please check the pricing documentation.
93
+ // pricing. To learn more, check the pricing documentation.
74
94
  enum SearchTier {
75
95
  // Default value when the enum is unspecified. This is invalid to use.
76
96
  SEARCH_TIER_UNSPECIFIED = 0;
@@ -1,4 +1,4 @@
1
- // Copyright 2022 Google LLC
1
+ // Copyright 2024 Google LLC
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -1,4 +1,4 @@
1
- // Copyright 2022 Google LLC
1
+ // Copyright 2024 Google LLC
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -1,4 +1,4 @@
1
- // Copyright 2022 Google LLC
1
+ // Copyright 2024 Google LLC
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.