@google-cloud/discoveryengine 1.10.0 → 1.12.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 (129) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +33 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/evaluation.proto +232 -0
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/evaluation_service.proto +252 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +83 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query.proto +86 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_service.proto +264 -0
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_set.proto +64 -0
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_set_service.proto +258 -0
  10. package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +14 -0
  11. package/build/protos/google/cloud/discoveryengine/v1beta/chunk.proto +119 -0
  12. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +0 -5
  13. package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +31 -0
  14. package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +38 -0
  15. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +29 -2
  16. package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto +7 -1
  17. package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +23 -0
  18. package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +10 -0
  19. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
  20. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +37 -2
  21. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation.proto +231 -0
  22. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation_service.proto +252 -0
  23. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +191 -0
  24. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +111 -0
  25. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query.proto +86 -0
  26. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_service.proto +264 -0
  27. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set.proto +64 -0
  28. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set_service.proto +256 -0
  29. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +370 -8
  30. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +11 -5
  31. package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +24 -0
  32. package/build/protos/protos.d.ts +32735 -21073
  33. package/build/protos/protos.js +80768 -53241
  34. package/build/protos/protos.json +5309 -2481
  35. package/build/src/v1alpha/acl_config_service_client.d.ts +108 -0
  36. package/build/src/v1alpha/acl_config_service_client.js +157 -0
  37. package/build/src/v1alpha/chunk_service_client.d.ts +108 -0
  38. package/build/src/v1alpha/chunk_service_client.js +157 -0
  39. package/build/src/v1alpha/completion_service_client.d.ts +108 -0
  40. package/build/src/v1alpha/completion_service_client.js +157 -0
  41. package/build/src/v1alpha/control_service_client.d.ts +108 -0
  42. package/build/src/v1alpha/control_service_client.js +157 -0
  43. package/build/src/v1alpha/conversational_search_service_client.d.ts +108 -0
  44. package/build/src/v1alpha/conversational_search_service_client.js +157 -0
  45. package/build/src/v1alpha/data_store_service_client.d.ts +108 -0
  46. package/build/src/v1alpha/data_store_service_client.js +157 -0
  47. package/build/src/v1alpha/document_service_client.d.ts +108 -0
  48. package/build/src/v1alpha/document_service_client.js +157 -0
  49. package/build/src/v1alpha/engine_service_client.d.ts +108 -0
  50. package/build/src/v1alpha/engine_service_client.js +157 -0
  51. package/build/src/v1alpha/estimate_billing_service_client.d.ts +108 -0
  52. package/build/src/v1alpha/estimate_billing_service_client.js +157 -0
  53. package/build/src/v1alpha/evaluation_service_client.d.ts +2349 -0
  54. package/build/src/v1alpha/evaluation_service_client.js +3288 -0
  55. package/build/src/v1alpha/evaluation_service_client_config.json +58 -0
  56. package/build/src/v1alpha/grounded_generation_service_client.d.ts +108 -0
  57. package/build/src/v1alpha/grounded_generation_service_client.js +157 -0
  58. package/build/src/v1alpha/index.d.ts +3 -0
  59. package/build/src/v1alpha/index.js +7 -1
  60. package/build/src/v1alpha/project_service_client.d.ts +108 -0
  61. package/build/src/v1alpha/project_service_client.js +157 -0
  62. package/build/src/v1alpha/rank_service_client.d.ts +108 -0
  63. package/build/src/v1alpha/rank_service_client.js +157 -0
  64. package/build/src/v1alpha/recommendation_service_client.d.ts +108 -0
  65. package/build/src/v1alpha/recommendation_service_client.js +157 -0
  66. package/build/src/v1alpha/sample_query_service_client.d.ts +2317 -0
  67. package/build/src/v1alpha/sample_query_service_client.js +3186 -0
  68. package/build/src/v1alpha/sample_query_service_client_config.json +68 -0
  69. package/build/src/v1alpha/sample_query_set_service_client.d.ts +2176 -0
  70. package/build/src/v1alpha/sample_query_set_service_client.js +2931 -0
  71. package/build/src/v1alpha/sample_query_set_service_client_config.json +63 -0
  72. package/build/src/v1alpha/schema_service_client.d.ts +108 -0
  73. package/build/src/v1alpha/schema_service_client.js +157 -0
  74. package/build/src/v1alpha/search_service_client.d.ts +108 -0
  75. package/build/src/v1alpha/search_service_client.js +157 -0
  76. package/build/src/v1alpha/search_tuning_service_client.d.ts +108 -0
  77. package/build/src/v1alpha/search_tuning_service_client.js +157 -0
  78. package/build/src/v1alpha/serving_config_service_client.d.ts +108 -0
  79. package/build/src/v1alpha/serving_config_service_client.js +157 -0
  80. package/build/src/v1alpha/site_search_engine_service_client.d.ts +108 -0
  81. package/build/src/v1alpha/site_search_engine_service_client.js +157 -0
  82. package/build/src/v1alpha/user_event_service_client.d.ts +108 -0
  83. package/build/src/v1alpha/user_event_service_client.js +157 -0
  84. package/build/src/v1beta/completion_service_client.d.ts +328 -0
  85. package/build/src/v1beta/completion_service_client.js +423 -0
  86. package/build/src/v1beta/completion_service_client_config.json +10 -0
  87. package/build/src/v1beta/control_service_client.d.ts +237 -0
  88. package/build/src/v1beta/control_service_client.js +333 -0
  89. package/build/src/v1beta/conversational_search_service_client.d.ts +255 -0
  90. package/build/src/v1beta/conversational_search_service_client.js +333 -0
  91. package/build/src/v1beta/data_store_service_client.d.ts +246 -0
  92. package/build/src/v1beta/data_store_service_client.js +339 -0
  93. package/build/src/v1beta/document_service_client.d.ts +239 -0
  94. package/build/src/v1beta/document_service_client.js +339 -0
  95. package/build/src/v1beta/engine_service_client.d.ts +237 -0
  96. package/build/src/v1beta/engine_service_client.js +339 -0
  97. package/build/src/v1beta/evaluation_service_client.d.ts +2325 -0
  98. package/build/src/v1beta/evaluation_service_client.js +3252 -0
  99. package/build/src/v1beta/evaluation_service_client_config.json +58 -0
  100. package/build/src/v1beta/grounded_generation_service_client.d.ts +237 -0
  101. package/build/src/v1beta/grounded_generation_service_client.js +333 -0
  102. package/build/src/v1beta/index.d.ts +3 -0
  103. package/build/src/v1beta/index.js +7 -1
  104. package/build/src/v1beta/project_service_client.d.ts +237 -0
  105. package/build/src/v1beta/project_service_client.js +339 -0
  106. package/build/src/v1beta/rank_service_client.d.ts +237 -0
  107. package/build/src/v1beta/rank_service_client.js +333 -0
  108. package/build/src/v1beta/recommendation_service_client.d.ts +237 -0
  109. package/build/src/v1beta/recommendation_service_client.js +333 -0
  110. package/build/src/v1beta/sample_query_service_client.d.ts +2293 -0
  111. package/build/src/v1beta/sample_query_service_client.js +3150 -0
  112. package/build/src/v1beta/sample_query_service_client_config.json +68 -0
  113. package/build/src/v1beta/sample_query_set_service_client.d.ts +2150 -0
  114. package/build/src/v1beta/sample_query_set_service_client.js +2895 -0
  115. package/build/src/v1beta/sample_query_set_service_client_config.json +63 -0
  116. package/build/src/v1beta/schema_service_client.d.ts +237 -0
  117. package/build/src/v1beta/schema_service_client.js +339 -0
  118. package/build/src/v1beta/search_service_client.d.ts +414 -12
  119. package/build/src/v1beta/search_service_client.js +451 -8
  120. package/build/src/v1beta/search_tuning_service_client.d.ts +237 -0
  121. package/build/src/v1beta/search_tuning_service_client.js +339 -0
  122. package/build/src/v1beta/serving_config_service_client.d.ts +237 -0
  123. package/build/src/v1beta/serving_config_service_client.js +333 -0
  124. package/build/src/v1beta/site_search_engine_service_client.d.ts +237 -0
  125. package/build/src/v1beta/site_search_engine_service_client.js +339 -0
  126. package/build/src/v1beta/user_event_service_client.d.ts +312 -0
  127. package/build/src/v1beta/user_event_service_client.js +381 -0
  128. package/build/src/v1beta/user_event_service_client_config.json +5 -0
  129. package/package.json +1 -1
@@ -0,0 +1,264 @@
1
+ // Copyright 2024 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+
15
+ syntax = "proto3";
16
+
17
+ package google.cloud.discoveryengine.v1alpha;
18
+
19
+ import "google/api/annotations.proto";
20
+ import "google/api/client.proto";
21
+ import "google/api/field_behavior.proto";
22
+ import "google/api/resource.proto";
23
+ import "google/cloud/discoveryengine/v1alpha/import_config.proto";
24
+ import "google/cloud/discoveryengine/v1alpha/sample_query.proto";
25
+ import "google/longrunning/operations.proto";
26
+ import "google/protobuf/empty.proto";
27
+ import "google/protobuf/field_mask.proto";
28
+
29
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
30
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
31
+ option java_multiple_files = true;
32
+ option java_outer_classname = "SampleQueryServiceProto";
33
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
34
+ option objc_class_prefix = "DISCOVERYENGINE";
35
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
36
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
37
+
38
+ // Service for managing
39
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s,
40
+ service SampleQueryService {
41
+ option (google.api.default_host) = "discoveryengine.googleapis.com";
42
+ option (google.api.oauth_scopes) =
43
+ "https://www.googleapis.com/auth/cloud-platform";
44
+
45
+ // Gets a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
46
+ rpc GetSampleQuery(GetSampleQueryRequest) returns (SampleQuery) {
47
+ option (google.api.http) = {
48
+ get: "/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/sampleQueries/*}"
49
+ };
50
+ option (google.api.method_signature) = "name";
51
+ }
52
+
53
+ // Gets a list of
54
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s.
55
+ rpc ListSampleQueries(ListSampleQueriesRequest)
56
+ returns (ListSampleQueriesResponse) {
57
+ option (google.api.http) = {
58
+ get: "/v1alpha/{parent=projects/*/locations/*/sampleQuerySets/*}/sampleQueries"
59
+ };
60
+ option (google.api.method_signature) = "parent";
61
+ }
62
+
63
+ // Creates a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]
64
+ rpc CreateSampleQuery(CreateSampleQueryRequest) returns (SampleQuery) {
65
+ option (google.api.http) = {
66
+ post: "/v1alpha/{parent=projects/*/locations/*/sampleQuerySets/*}/sampleQueries"
67
+ body: "sample_query"
68
+ };
69
+ option (google.api.method_signature) =
70
+ "parent,sample_query,sample_query_id";
71
+ }
72
+
73
+ // Updates a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
74
+ rpc UpdateSampleQuery(UpdateSampleQueryRequest) returns (SampleQuery) {
75
+ option (google.api.http) = {
76
+ patch: "/v1alpha/{sample_query.name=projects/*/locations/*/sampleQuerySets/*/sampleQueries/*}"
77
+ body: "sample_query"
78
+ };
79
+ option (google.api.method_signature) = "sample_query,update_mask";
80
+ }
81
+
82
+ // Deletes a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
83
+ rpc DeleteSampleQuery(DeleteSampleQueryRequest)
84
+ returns (google.protobuf.Empty) {
85
+ option (google.api.http) = {
86
+ delete: "/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/sampleQueries/*}"
87
+ };
88
+ option (google.api.method_signature) = "name";
89
+ }
90
+
91
+ // Bulk import of multiple
92
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s. Sample
93
+ // queries that already exist may be deleted.
94
+ //
95
+ // Note: It is possible for a subset of the
96
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s to be
97
+ // successfully imported.
98
+ rpc ImportSampleQueries(ImportSampleQueriesRequest)
99
+ returns (google.longrunning.Operation) {
100
+ option (google.api.http) = {
101
+ post: "/v1alpha/{parent=projects/*/locations/*/sampleQuerySets/*}/sampleQueries:import"
102
+ body: "*"
103
+ };
104
+ option (google.longrunning.operation_info) = {
105
+ response_type: "google.cloud.discoveryengine.v1alpha.ImportSampleQueriesResponse"
106
+ metadata_type: "google.cloud.discoveryengine.v1alpha.ImportSampleQueriesMetadata"
107
+ };
108
+ }
109
+ }
110
+
111
+ // Request message for
112
+ // [SampleQueryService.GetSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.GetSampleQuery]
113
+ // method.
114
+ message GetSampleQueryRequest {
115
+ // Required. Full resource name of
116
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], such as
117
+ // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
118
+ //
119
+ // If the caller does not have permission to access the
120
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless
121
+ // of whether or not it exists, a PERMISSION_DENIED error is returned.
122
+ //
123
+ // If the requested
124
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] does not
125
+ // exist, a NOT_FOUND error is returned.
126
+ string name = 1 [
127
+ (google.api.field_behavior) = REQUIRED,
128
+ (google.api.resource_reference) = {
129
+ type: "discoveryengine.googleapis.com/SampleQuery"
130
+ }
131
+ ];
132
+ }
133
+
134
+ // Request message for
135
+ // [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries]
136
+ // method.
137
+ message ListSampleQueriesRequest {
138
+ // Required. The parent sample query set resource name, such as
139
+ // `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
140
+ //
141
+ // If the caller does not have permission to list
142
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s under this
143
+ // sample query set, regardless of whether or not this sample query set
144
+ // exists, a `PERMISSION_DENIED` error is returned.
145
+ string parent = 1 [
146
+ (google.api.field_behavior) = REQUIRED,
147
+ (google.api.resource_reference) = {
148
+ type: "discoveryengine.googleapis.com/SampleQuerySet"
149
+ }
150
+ ];
151
+
152
+ // Maximum number of
153
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s to return.
154
+ // If unspecified, defaults to 100. The maximum allowed value is 1000. Values
155
+ // above 1000 will be coerced to 1000.
156
+ //
157
+ // If this field is negative, an `INVALID_ARGUMENT` error is returned.
158
+ int32 page_size = 2;
159
+
160
+ // A page token
161
+ // [ListSampleQueriesResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListSampleQueriesResponse.next_page_token],
162
+ // received from a previous
163
+ // [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries]
164
+ // call. Provide this to retrieve the subsequent page.
165
+ //
166
+ // When paginating, all other parameters provided to
167
+ // [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries]
168
+ // must match the call that provided the page token. Otherwise, an
169
+ // `INVALID_ARGUMENT` error is returned.
170
+ string page_token = 3;
171
+ }
172
+
173
+ // Response message for
174
+ // [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries]
175
+ // method.
176
+ message ListSampleQueriesResponse {
177
+ // The [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s.
178
+ repeated SampleQuery sample_queries = 1;
179
+
180
+ // A token that can be sent as
181
+ // [ListSampleQueriesRequest.page_token][google.cloud.discoveryengine.v1alpha.ListSampleQueriesRequest.page_token]
182
+ // to retrieve the next page. If this field is omitted, there are no
183
+ // subsequent pages.
184
+ string next_page_token = 2;
185
+ }
186
+
187
+ // Request message for
188
+ // [SampleQueryService.CreateSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.CreateSampleQuery]
189
+ // method.
190
+ message CreateSampleQueryRequest {
191
+ // Required. The parent resource name, such as
192
+ // `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
193
+ string parent = 1 [
194
+ (google.api.field_behavior) = REQUIRED,
195
+ (google.api.resource_reference) = {
196
+ type: "discoveryengine.googleapis.com/SampleQuerySet"
197
+ }
198
+ ];
199
+
200
+ // Required. The
201
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] to create.
202
+ SampleQuery sample_query = 2 [(google.api.field_behavior) = REQUIRED];
203
+
204
+ // Required. The ID to use for the
205
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], which will
206
+ // become the final component of the
207
+ // [SampleQuery.name][google.cloud.discoveryengine.v1alpha.SampleQuery.name].
208
+ //
209
+ // If the caller does not have permission to create the
210
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless
211
+ // of whether or not it exists, a `PERMISSION_DENIED` error is returned.
212
+ //
213
+ // This field must be unique among all
214
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s with the
215
+ // same
216
+ // [parent][google.cloud.discoveryengine.v1alpha.CreateSampleQueryRequest.parent].
217
+ // Otherwise, an `ALREADY_EXISTS` error is returned.
218
+ //
219
+ // This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
220
+ // standard with a length limit of 63 characters. Otherwise, an
221
+ // `INVALID_ARGUMENT` error is returned.
222
+ string sample_query_id = 3 [(google.api.field_behavior) = REQUIRED];
223
+ }
224
+
225
+ // Request message for
226
+ // [SampleQueryService.UpdateSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.UpdateSampleQuery]
227
+ // method.
228
+ message UpdateSampleQueryRequest {
229
+ // Required. The simple query to update.
230
+ //
231
+ // If the caller does not have permission to update the
232
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless
233
+ // of whether or not it exists, a `PERMISSION_DENIED` error is returned.
234
+ //
235
+ // If the [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] to
236
+ // update does not exist a `NOT_FOUND` error is returned.
237
+ SampleQuery sample_query = 1 [(google.api.field_behavior) = REQUIRED];
238
+
239
+ // Indicates which fields in the provided imported 'simple query' to update.
240
+ // If not set, will by default update all fields.
241
+ google.protobuf.FieldMask update_mask = 2;
242
+ }
243
+
244
+ // Request message for
245
+ // [SampleQueryService.DeleteSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.DeleteSampleQuery]
246
+ // method.
247
+ message DeleteSampleQueryRequest {
248
+ // Required. Full resource name of
249
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], such as
250
+ // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
251
+ //
252
+ // If the caller does not have permission to delete the
253
+ // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless
254
+ // of whether or not it exists, a `PERMISSION_DENIED` error is returned.
255
+ //
256
+ // If the [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] to
257
+ // delete does not exist, a `NOT_FOUND` error is returned.
258
+ string name = 1 [
259
+ (google.api.field_behavior) = REQUIRED,
260
+ (google.api.resource_reference) = {
261
+ type: "discoveryengine.googleapis.com/SampleQuery"
262
+ }
263
+ ];
264
+ }
@@ -0,0 +1,64 @@
1
+ // Copyright 2024 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+
15
+ syntax = "proto3";
16
+
17
+ package google.cloud.discoveryengine.v1alpha;
18
+
19
+ import "google/api/field_behavior.proto";
20
+ import "google/api/resource.proto";
21
+ import "google/protobuf/timestamp.proto";
22
+
23
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
24
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
25
+ option java_multiple_files = true;
26
+ option java_outer_classname = "SampleQuerySetProto";
27
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
28
+ option objc_class_prefix = "DISCOVERYENGINE";
29
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
30
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
31
+
32
+ // A SampleQuerySet is the parent resource of SampleQuery, and contains the
33
+ // configurations shared by all SampleQuery under it.
34
+ message SampleQuerySet {
35
+ option (google.api.resource) = {
36
+ type: "discoveryengine.googleapis.com/SampleQuerySet"
37
+ pattern: "projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}"
38
+ };
39
+
40
+ // Identifier. The full resource name of the
41
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], in
42
+ // the format of
43
+ // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
44
+ //
45
+ // This field must be a UTF-8 encoded string with a length limit of 1024
46
+ // characters.
47
+ string name = 1 [(google.api.field_behavior) = IDENTIFIER];
48
+
49
+ // Required. The sample query set display name.
50
+ //
51
+ // This field must be a UTF-8 encoded string with a length limit of 128
52
+ // characters.
53
+ string display_name = 2 [(google.api.field_behavior) = REQUIRED];
54
+
55
+ // Output only. Timestamp the
56
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] was
57
+ // created at.
58
+ google.protobuf.Timestamp create_time = 3
59
+ [(google.api.field_behavior) = OUTPUT_ONLY];
60
+
61
+ // The description of the
62
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
63
+ string description = 4;
64
+ }
@@ -0,0 +1,258 @@
1
+ // Copyright 2024 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+
15
+ syntax = "proto3";
16
+
17
+ package google.cloud.discoveryengine.v1alpha;
18
+
19
+ import "google/api/annotations.proto";
20
+ import "google/api/client.proto";
21
+ import "google/api/field_behavior.proto";
22
+ import "google/api/resource.proto";
23
+ import "google/cloud/discoveryengine/v1alpha/sample_query_set.proto";
24
+ import "google/protobuf/empty.proto";
25
+ import "google/protobuf/field_mask.proto";
26
+
27
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
28
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
29
+ option java_multiple_files = true;
30
+ option java_outer_classname = "SampleQuerySetServiceProto";
31
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
32
+ option objc_class_prefix = "DISCOVERYENGINE";
33
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
34
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
35
+
36
+ // Service for managing
37
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s,
38
+ service SampleQuerySetService {
39
+ option (google.api.default_host) = "discoveryengine.googleapis.com";
40
+ option (google.api.oauth_scopes) =
41
+ "https://www.googleapis.com/auth/cloud-platform";
42
+
43
+ // Gets a
44
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
45
+ rpc GetSampleQuerySet(GetSampleQuerySetRequest) returns (SampleQuerySet) {
46
+ option (google.api.http) = {
47
+ get: "/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*}"
48
+ };
49
+ option (google.api.method_signature) = "name";
50
+ }
51
+
52
+ // Gets a list of
53
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s.
54
+ rpc ListSampleQuerySets(ListSampleQuerySetsRequest)
55
+ returns (ListSampleQuerySetsResponse) {
56
+ option (google.api.http) = {
57
+ get: "/v1alpha/{parent=projects/*/locations/*}/sampleQuerySets"
58
+ };
59
+ option (google.api.method_signature) = "parent";
60
+ }
61
+
62
+ // Creates a
63
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]
64
+ rpc CreateSampleQuerySet(CreateSampleQuerySetRequest)
65
+ returns (SampleQuerySet) {
66
+ option (google.api.http) = {
67
+ post: "/v1alpha/{parent=projects/*/locations/*}/sampleQuerySets"
68
+ body: "sample_query_set"
69
+ };
70
+ option (google.api.method_signature) =
71
+ "parent,sample_query_set,sample_query_set_id";
72
+ }
73
+
74
+ // Updates a
75
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
76
+ rpc UpdateSampleQuerySet(UpdateSampleQuerySetRequest)
77
+ returns (SampleQuerySet) {
78
+ option (google.api.http) = {
79
+ patch: "/v1alpha/{sample_query_set.name=projects/*/locations/*/sampleQuerySets/*}"
80
+ body: "sample_query_set"
81
+ };
82
+ option (google.api.method_signature) = "sample_query_set,update_mask";
83
+ }
84
+
85
+ // Deletes a
86
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
87
+ rpc DeleteSampleQuerySet(DeleteSampleQuerySetRequest)
88
+ returns (google.protobuf.Empty) {
89
+ option (google.api.http) = {
90
+ delete: "/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*}"
91
+ };
92
+ option (google.api.method_signature) = "name";
93
+ }
94
+ }
95
+
96
+ // Request message for
97
+ // [SampleQuerySetService.GetSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.GetSampleQuerySet]
98
+ // method.
99
+ message GetSampleQuerySetRequest {
100
+ // Required. Full resource name of
101
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], such
102
+ // as
103
+ // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
104
+ //
105
+ // If the caller does not have permission to access the
106
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
107
+ // regardless of whether or not it exists, a PERMISSION_DENIED error is
108
+ // returned.
109
+ //
110
+ // If the requested
111
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] does
112
+ // not exist, a NOT_FOUND error is returned.
113
+ string name = 1 [
114
+ (google.api.field_behavior) = REQUIRED,
115
+ (google.api.resource_reference) = {
116
+ type: "discoveryengine.googleapis.com/SampleQuerySet"
117
+ }
118
+ ];
119
+ }
120
+
121
+ // Request message for
122
+ // [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets]
123
+ // method.
124
+ message ListSampleQuerySetsRequest {
125
+ // Required. The parent location resource name, such as
126
+ // `projects/{project}/locations/{location}`.
127
+ //
128
+ // If the caller does not have permission to list
129
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s
130
+ // under this location, regardless of whether or not this location exists, a
131
+ // `PERMISSION_DENIED` error is returned.
132
+ string parent = 1 [
133
+ (google.api.field_behavior) = REQUIRED,
134
+ (google.api.resource_reference) = {
135
+ type: "discoveryengine.googleapis.com/Location"
136
+ }
137
+ ];
138
+
139
+ // Maximum number of
140
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s to
141
+ // return. If unspecified, defaults to 100. The maximum allowed value is 1000.
142
+ // Values above 1000 will be coerced to 1000.
143
+ //
144
+ // If this field is negative, an `INVALID_ARGUMENT` error is returned.
145
+ int32 page_size = 2;
146
+
147
+ // A page token
148
+ // [ListSampleQuerySetsResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsResponse.next_page_token],
149
+ // received from a previous
150
+ // [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets]
151
+ // call. Provide this to retrieve the subsequent page.
152
+ //
153
+ // When paginating, all other parameters provided to
154
+ // [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets]
155
+ // must match the call that provided the page token. Otherwise, an
156
+ // `INVALID_ARGUMENT` error is returned.
157
+ string page_token = 3;
158
+ }
159
+
160
+ // Response message for
161
+ // [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets]
162
+ // method.
163
+ message ListSampleQuerySetsResponse {
164
+ // The [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s.
165
+ repeated SampleQuerySet sample_query_sets = 1;
166
+
167
+ // A token that can be sent as
168
+ // [ListSampleQuerySetsRequest.page_token][google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsRequest.page_token]
169
+ // to retrieve the next page. If this field is omitted, there are no
170
+ // subsequent pages.
171
+ string next_page_token = 2;
172
+ }
173
+
174
+ // Request message for
175
+ // [SampleQuerySetService.CreateSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.CreateSampleQuerySet]
176
+ // method.
177
+ message CreateSampleQuerySetRequest {
178
+ // Required. The parent resource name, such as
179
+ // `projects/{project}/locations/{location}`.
180
+ string parent = 1 [
181
+ (google.api.field_behavior) = REQUIRED,
182
+ (google.api.resource_reference) = {
183
+ type: "discoveryengine.googleapis.com/Location"
184
+ }
185
+ ];
186
+
187
+ // Required. The
188
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] to
189
+ // create.
190
+ SampleQuerySet sample_query_set = 2 [(google.api.field_behavior) = REQUIRED];
191
+
192
+ // Required. The ID to use for the
193
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
194
+ // which will become the final component of the
195
+ // [SampleQuerySet.name][google.cloud.discoveryengine.v1alpha.SampleQuerySet.name].
196
+ //
197
+ // If the caller does not have permission to create the
198
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
199
+ // regardless of whether or not it exists, a `PERMISSION_DENIED` error is
200
+ // returned.
201
+ //
202
+ // This field must be unique among all
203
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s with
204
+ // the same
205
+ // [parent][google.cloud.discoveryengine.v1alpha.CreateSampleQuerySetRequest.parent].
206
+ // Otherwise, an `ALREADY_EXISTS` error is returned.
207
+ //
208
+ // This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
209
+ // standard with a length limit of 63 characters. Otherwise, an
210
+ // `INVALID_ARGUMENT` error is returned.
211
+ string sample_query_set_id = 3 [(google.api.field_behavior) = REQUIRED];
212
+ }
213
+
214
+ // Request message for
215
+ // [SampleQuerySetService.UpdateSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.UpdateSampleQuerySet]
216
+ // method.
217
+ message UpdateSampleQuerySetRequest {
218
+ // Required. The sample query set to update.
219
+ //
220
+ // If the caller does not have permission to update the
221
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
222
+ // regardless of whether or not it exists, a `PERMISSION_DENIED` error is
223
+ // returned.
224
+ //
225
+ // If the
226
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] to
227
+ // update does not exist a `NOT_FOUND` error is returned.
228
+ SampleQuerySet sample_query_set = 1 [(google.api.field_behavior) = REQUIRED];
229
+
230
+ // Indicates which fields in the provided imported 'sample query set' to
231
+ // update. If not set, will by default update all fields.
232
+ google.protobuf.FieldMask update_mask = 2;
233
+ }
234
+
235
+ // Request message for
236
+ // [SampleQuerySetService.DeleteSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.DeleteSampleQuerySet]
237
+ // method.
238
+ message DeleteSampleQuerySetRequest {
239
+ // Required. Full resource name of
240
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], such
241
+ // as
242
+ // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
243
+ //
244
+ // If the caller does not have permission to delete the
245
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
246
+ // regardless of whether or not it exists, a `PERMISSION_DENIED` error is
247
+ // returned.
248
+ //
249
+ // If the
250
+ // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] to
251
+ // delete does not exist, a `NOT_FOUND` error is returned.
252
+ string name = 1 [
253
+ (google.api.field_behavior) = REQUIRED,
254
+ (google.api.resource_reference) = {
255
+ type: "discoveryengine.googleapis.com/SampleQuerySet"
256
+ }
257
+ ];
258
+ }
@@ -188,6 +188,14 @@ message Answer {
188
188
  // If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on,
189
189
  // populate chunk info.
190
190
  repeated ChunkInfo chunk_info = 5;
191
+
192
+ // Data representation.
193
+ // The structured JSON data for the document.
194
+ // It's populated from the struct data from the Document
195
+ // , or the Chunk in
196
+ // search result
197
+ // .
198
+ google.protobuf.Struct struct_data = 6;
191
199
  }
192
200
 
193
201
  // Search results observed by the search action, it can be snippets info
@@ -296,6 +304,12 @@ message Answer {
296
304
  // Google skips the answer if there is a potential policy violation
297
305
  // detected. This includes content that may be violent or toxic.
298
306
  POTENTIAL_POLICY_VIOLATION = 4;
307
+
308
+ // The no relevant content case.
309
+ //
310
+ // Google skips the answer if there is no relevant content in the
311
+ // retrieved search results.
312
+ NO_RELEVANT_CONTENT = 5;
299
313
  }
300
314
 
301
315
  // Immutable. Fully qualified name