@google-cloud/discoveryengine 1.3.1 → 1.4.1

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 (166) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +64 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/common.proto +54 -3
  4. package/build/protos/google/cloud/discoveryengine/v1/completion.proto +52 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +51 -4
  6. package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +3 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +40 -1
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +98 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +304 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/document.proto +1 -1
  11. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +215 -0
  12. package/build/protos/google/cloud/discoveryengine/v1/engine_service.proto +242 -0
  13. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +64 -0
  14. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +38 -0
  15. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +137 -4
  16. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +170 -0
  17. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +691 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +3 -3
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config.proto +49 -0
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config_service.proto +79 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +72 -0
  22. package/build/protos/google/cloud/discoveryengine/v1alpha/chunk_service.proto +137 -0
  23. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +77 -4
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/completion.proto +52 -0
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +44 -2
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +6 -1
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +44 -0
  28. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +80 -1
  29. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +83 -0
  30. package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +127 -0
  31. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +6 -0
  32. package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +13 -8
  33. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +3 -2
  34. package/build/protos/google/cloud/discoveryengine/v1alpha/estimate_billing_service.proto +130 -0
  35. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +64 -0
  36. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +66 -0
  37. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +3 -1
  38. package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +3 -0
  39. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +74 -13
  40. package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +24 -20
  41. package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config.proto +271 -0
  42. package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config_service.proto +147 -0
  43. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +9 -3
  44. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +7 -4
  45. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +4 -3
  46. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +59 -8
  47. package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +52 -0
  48. package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +51 -4
  49. package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +3 -0
  50. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +45 -1
  51. package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +120 -0
  52. package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +306 -0
  53. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +10 -1
  54. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +94 -0
  55. package/build/protos/google/cloud/discoveryengine/v1beta/engine.proto +220 -0
  56. package/build/protos/google/cloud/discoveryengine/v1beta/engine_service.proto +244 -0
  57. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +64 -0
  58. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +41 -0
  59. package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +26 -3
  60. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +169 -15
  61. package/build/protos/google/cloud/discoveryengine/v1beta/search_tuning_service.proto +151 -0
  62. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +265 -0
  63. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto +148 -0
  64. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine.proto +170 -0
  65. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine_service.proto +695 -0
  66. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -3
  67. package/build/protos/protos.d.ts +48530 -23682
  68. package/build/protos/protos.js +122429 -63306
  69. package/build/protos/protos.json +13438 -7286
  70. package/build/src/index.d.ts +10 -1
  71. package/build/src/index.js +10 -1
  72. package/build/src/v1/completion_service_client.d.ts +489 -7
  73. package/build/src/v1/completion_service_client.js +715 -11
  74. package/build/src/v1/completion_service_client_config.json +10 -0
  75. package/build/src/v1/conversational_search_service_client.d.ts +341 -3
  76. package/build/src/v1/conversational_search_service_client.js +466 -9
  77. package/build/src/v1/data_store_service_client.d.ts +1286 -0
  78. package/build/src/v1/data_store_service_client.js +1768 -0
  79. package/build/src/v1/data_store_service_client_config.json +46 -0
  80. package/build/src/v1/document_service_client.d.ts +347 -2
  81. package/build/src/v1/document_service_client.js +506 -9
  82. package/build/src/v1/engine_service_client.d.ts +1211 -0
  83. package/build/src/v1/engine_service_client.js +1731 -0
  84. package/build/src/v1/engine_service_client_config.json +46 -0
  85. package/build/src/v1/index.d.ts +3 -0
  86. package/build/src/v1/index.js +7 -1
  87. package/build/src/v1/schema_service_client.d.ts +272 -2
  88. package/build/src/v1/schema_service_client.js +402 -9
  89. package/build/src/v1/search_service_client.d.ts +515 -11
  90. package/build/src/v1/search_service_client.js +648 -15
  91. package/build/src/v1/site_search_engine_service_client.d.ts +1564 -0
  92. package/build/src/v1/site_search_engine_service_client.js +2075 -0
  93. package/build/src/v1/site_search_engine_service_client_config.json +74 -0
  94. package/build/src/v1/user_event_service_client.d.ts +272 -2
  95. package/build/src/v1/user_event_service_client.js +402 -9
  96. package/build/src/v1alpha/acl_config_service_client.d.ts +1233 -0
  97. package/build/src/v1alpha/acl_config_service_client.js +1765 -0
  98. package/build/src/v1alpha/acl_config_service_client_config.json +34 -0
  99. package/build/src/v1alpha/chunk_service_client.d.ts +1350 -0
  100. package/build/src/v1alpha/chunk_service_client.js +1886 -0
  101. package/build/src/v1alpha/chunk_service_client_config.json +34 -0
  102. package/build/src/v1alpha/completion_service_client.d.ts +599 -5
  103. package/build/src/v1alpha/completion_service_client.js +868 -12
  104. package/build/src/v1alpha/completion_service_client_config.json +10 -0
  105. package/build/src/v1alpha/conversational_search_service_client.d.ts +244 -3
  106. package/build/src/v1alpha/conversational_search_service_client.js +353 -10
  107. package/build/src/v1alpha/data_store_service_client.d.ts +462 -5
  108. package/build/src/v1alpha/data_store_service_client.js +599 -12
  109. package/build/src/v1alpha/data_store_service_client_config.json +8 -0
  110. package/build/src/v1alpha/document_service_client.d.ts +393 -2
  111. package/build/src/v1alpha/document_service_client.js +551 -10
  112. package/build/src/v1alpha/engine_service_client.d.ts +386 -4
  113. package/build/src/v1alpha/engine_service_client.js +551 -10
  114. package/build/src/v1alpha/estimate_billing_service_client.d.ts +1367 -0
  115. package/build/src/v1alpha/estimate_billing_service_client.js +2028 -0
  116. package/build/src/v1alpha/estimate_billing_service_client_config.json +30 -0
  117. package/build/src/v1alpha/index.d.ts +4 -0
  118. package/build/src/v1alpha/index.js +10 -2
  119. package/build/src/v1alpha/recommendation_service_client.d.ts +242 -3
  120. package/build/src/v1alpha/recommendation_service_client.js +353 -10
  121. package/build/src/v1alpha/schema_service_client.d.ts +383 -2
  122. package/build/src/v1alpha/schema_service_client.js +551 -10
  123. package/build/src/v1alpha/search_service_client.d.ts +269 -17
  124. package/build/src/v1alpha/search_service_client.js +373 -20
  125. package/build/src/v1alpha/search_tuning_service_client.d.ts +384 -3
  126. package/build/src/v1alpha/search_tuning_service_client.js +551 -10
  127. package/build/src/v1alpha/serving_config_service_client.d.ts +1369 -0
  128. package/build/src/v1alpha/serving_config_service_client.js +1935 -0
  129. package/build/src/v1alpha/serving_config_service_client_config.json +38 -0
  130. package/build/src/v1alpha/site_search_engine_service_client.d.ts +383 -2
  131. package/build/src/v1alpha/site_search_engine_service_client.js +551 -10
  132. package/build/src/v1alpha/user_event_service_client.d.ts +383 -2
  133. package/build/src/v1alpha/user_event_service_client.js +551 -10
  134. package/build/src/v1beta/completion_service_client.d.ts +708 -7
  135. package/build/src/v1beta/completion_service_client.js +1015 -11
  136. package/build/src/v1beta/completion_service_client_config.json +10 -0
  137. package/build/src/v1beta/conversational_search_service_client.d.ts +420 -3
  138. package/build/src/v1beta/conversational_search_service_client.js +570 -9
  139. package/build/src/v1beta/data_store_service_client.d.ts +1508 -0
  140. package/build/src/v1beta/data_store_service_client.js +2070 -0
  141. package/build/src/v1beta/data_store_service_client_config.json +46 -0
  142. package/build/src/v1beta/document_service_client.d.ts +566 -2
  143. package/build/src/v1beta/document_service_client.js +810 -11
  144. package/build/src/v1beta/engine_service_client.d.ts +1432 -0
  145. package/build/src/v1beta/engine_service_client.js +2032 -0
  146. package/build/src/v1beta/engine_service_client_config.json +46 -0
  147. package/build/src/v1beta/index.d.ts +5 -0
  148. package/build/src/v1beta/index.js +11 -1
  149. package/build/src/v1beta/recommendation_service_client.d.ts +495 -5
  150. package/build/src/v1beta/recommendation_service_client.js +674 -9
  151. package/build/src/v1beta/schema_service_client.d.ts +491 -2
  152. package/build/src/v1beta/schema_service_client.js +706 -11
  153. package/build/src/v1beta/search_service_client.d.ts +620 -29
  154. package/build/src/v1beta/search_service_client.js +772 -27
  155. package/build/src/v1beta/search_tuning_service_client.d.ts +1196 -0
  156. package/build/src/v1beta/search_tuning_service_client.js +1781 -0
  157. package/build/src/v1beta/search_tuning_service_client_config.json +30 -0
  158. package/build/src/v1beta/serving_config_service_client.d.ts +1217 -0
  159. package/build/src/v1beta/serving_config_service_client.js +1724 -0
  160. package/build/src/v1beta/serving_config_service_client_config.json +38 -0
  161. package/build/src/v1beta/site_search_engine_service_client.d.ts +1787 -0
  162. package/build/src/v1beta/site_search_engine_service_client.js +2375 -0
  163. package/build/src/v1beta/site_search_engine_service_client_config.json +74 -0
  164. package/build/src/v1beta/user_event_service_client.d.ts +491 -2
  165. package/build/src/v1beta/user_event_service_client.js +706 -11
  166. package/package.json +3 -3
@@ -142,9 +142,9 @@ message UserEvent {
142
142
  // conforming to https://google.aip.dev/160#filtering.
143
143
  //
144
144
  // Similarly, for `view-item-list` events that are generated from a
145
- // [RecommendationService.RecommendRequest][], this field may be populated
146
- // directly from [RecommendationService.RecommendRequest.filter][] conforming
147
- // to https://google.aip.dev/160#filtering.
145
+ // [RecommendRequest][], this field may be populated directly from
146
+ // [RecommendRequest.filter][] conforming to
147
+ // https://google.aip.dev/160#filtering.
148
148
  //
149
149
  // The value must be a UTF-8 encoded string with a length limit of 1,000
150
150
  // characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
@@ -0,0 +1,49 @@
1
+ // Copyright 2022 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/cloud/discoveryengine/v1alpha/common.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 = "AclConfigProto";
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
+ // Access Control Configuration.
33
+ message AclConfig {
34
+ option (google.api.resource) = {
35
+ type: "discoveryengine.googleapis.com/AclConfig"
36
+ pattern: "projects/{project}/locations/{location}/aclConfig"
37
+ };
38
+
39
+ // Immutable. The full resource name of the acl configuration.
40
+ // Format:
41
+ // `projects/{project}/locations/{location}/aclConfig`.
42
+ //
43
+ // This field must be a UTF-8 encoded string with a length limit of 1024
44
+ // characters.
45
+ string name = 1 [(google.api.field_behavior) = IMMUTABLE];
46
+
47
+ // Identity provider config.
48
+ IdpConfig idp_config = 2;
49
+ }
@@ -0,0 +1,79 @@
1
+ // Copyright 2022 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/acl_config.proto";
24
+
25
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
26
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
27
+ option java_multiple_files = true;
28
+ option java_outer_classname = "AclConfigServiceProto";
29
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
30
+ option objc_class_prefix = "DISCOVERYENGINE";
31
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
32
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
33
+
34
+ // Service for managing Acl Configuration.
35
+ service AclConfigService {
36
+ option (google.api.default_host) = "discoveryengine.googleapis.com";
37
+ option (google.api.oauth_scopes) =
38
+ "https://www.googleapis.com/auth/cloud-platform";
39
+
40
+ // Default Acl Configuration for use in a location of a customer's project.
41
+ // Updates will only reflect to new data stores. Existing data stores will
42
+ // still use the old value.
43
+ rpc UpdateAclConfig(UpdateAclConfigRequest) returns (AclConfig) {
44
+ option (google.api.http) = {
45
+ patch: "/v1alpha/{acl_config.name=projects/*/locations/*/aclConfig}"
46
+ body: "acl_config"
47
+ };
48
+ }
49
+
50
+ // Gets the [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig].
51
+ rpc GetAclConfig(GetAclConfigRequest) returns (AclConfig) {
52
+ option (google.api.http) = {
53
+ get: "/v1alpha/{name=projects/*/locations/*/aclConfig}"
54
+ };
55
+ option (google.api.method_signature) = "name";
56
+ }
57
+ }
58
+
59
+ // Request message for GetAclConfigRequest method.
60
+ message GetAclConfigRequest {
61
+ // Required. Resource name of
62
+ // [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], such as
63
+ // `projects/*/locations/*/aclConfig`.
64
+ //
65
+ // If the caller does not have permission to access the
66
+ // [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], regardless of
67
+ // whether or not it exists, a PERMISSION_DENIED error is returned.
68
+ string name = 1 [
69
+ (google.api.field_behavior) = REQUIRED,
70
+ (google.api.resource_reference) = {
71
+ type: "discoveryengine.googleapis.com/AclConfig"
72
+ }
73
+ ];
74
+ }
75
+
76
+ // Request message for UpdateAclConfig method.
77
+ message UpdateAclConfigRequest {
78
+ AclConfig acl_config = 1 [(google.api.field_behavior) = REQUIRED];
79
+ }
@@ -0,0 +1,72 @@
1
+ // Copyright 2022 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/struct.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 = "ChunkProto";
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
+ // Chunk captures all raw metadata information of items to be recommended or
33
+ // searched in the chunk mode.
34
+ message Chunk {
35
+ option (google.api.resource) = {
36
+ type: "discoveryengine.googleapis.com/Chunk"
37
+ pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}"
38
+ pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}"
39
+ };
40
+
41
+ // Document metadata contains the information of the document of the current
42
+ // chunk.
43
+ message DocumentMetadata {
44
+ // Uri of the document.
45
+ string uri = 1;
46
+
47
+ // Title of the document.
48
+ string title = 2;
49
+ }
50
+
51
+ // The full resource name of the chunk.
52
+ // Format:
53
+ // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`.
54
+ //
55
+ // This field must be a UTF-8 encoded string with a length limit of 1024
56
+ // characters.
57
+ string name = 1;
58
+
59
+ // Unique chunk id of the current chunk.
60
+ string id = 2;
61
+
62
+ // Content is a string from a document (parsed content).
63
+ string content = 3;
64
+
65
+ // Metadata of the document from the current chunk.
66
+ DocumentMetadata document_metadata = 5;
67
+
68
+ // Output only. This field is OUTPUT_ONLY.
69
+ // It contains derived data that are not in the original input document.
70
+ google.protobuf.Struct derived_struct_data = 4
71
+ [(google.api.field_behavior) = OUTPUT_ONLY];
72
+ }
@@ -0,0 +1,137 @@
1
+ // Copyright 2022 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/chunk.proto";
24
+
25
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
26
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
27
+ option java_multiple_files = true;
28
+ option java_outer_classname = "ChunkServiceProto";
29
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
30
+ option objc_class_prefix = "DISCOVERYENGINE";
31
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
32
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
33
+
34
+ // Service for displaying processed
35
+ // [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] information of the
36
+ // customer's unstructured data.
37
+ service ChunkService {
38
+ option (google.api.default_host) = "discoveryengine.googleapis.com";
39
+ option (google.api.oauth_scopes) =
40
+ "https://www.googleapis.com/auth/cloud-platform";
41
+
42
+ // Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].
43
+ rpc GetChunk(GetChunkRequest) returns (Chunk) {
44
+ option (google.api.http) = {
45
+ get: "/v1alpha/{name=projects/*/locations/*/dataStores/*/branches/*/documents/*/chunks/*}"
46
+ additional_bindings {
47
+ get: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*/chunks/*}"
48
+ }
49
+ };
50
+ option (google.api.method_signature) = "name";
51
+ }
52
+
53
+ // Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
54
+ rpc ListChunks(ListChunksRequest) returns (ListChunksResponse) {
55
+ option (google.api.http) = {
56
+ get: "/v1alpha/{parent=projects/*/locations/*/dataStores/*/branches/*/documents/*}/chunks"
57
+ additional_bindings {
58
+ get: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}/chunks"
59
+ }
60
+ };
61
+ option (google.api.method_signature) = "parent";
62
+ }
63
+ }
64
+
65
+ // Request message for
66
+ // [ChunkService.GetChunk][google.cloud.discoveryengine.v1alpha.ChunkService.GetChunk]
67
+ // method.
68
+ message GetChunkRequest {
69
+ // Required. Full resource name of
70
+ // [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], such as
71
+ // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`.
72
+ //
73
+ // If the caller does not have permission to access the
74
+ // [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], regardless of whether
75
+ // or not it exists, a `PERMISSION_DENIED` error is returned.
76
+ //
77
+ // If the requested [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] does
78
+ // not exist, a `NOT_FOUND` error is returned.
79
+ string name = 1 [
80
+ (google.api.field_behavior) = REQUIRED,
81
+ (google.api.resource_reference) = {
82
+ type: "discoveryengine.googleapis.com/Chunk"
83
+ }
84
+ ];
85
+ }
86
+
87
+ // Request message for
88
+ // [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks]
89
+ // method.
90
+ message ListChunksRequest {
91
+ // Required. The parent document resource name, such as
92
+ // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
93
+ //
94
+ // If the caller does not have permission to list
95
+ // [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s under this document,
96
+ // regardless of whether or not this document exists, a `PERMISSION_DENIED`
97
+ // error is returned.
98
+ string parent = 1 [
99
+ (google.api.field_behavior) = REQUIRED,
100
+ (google.api.resource_reference) = {
101
+ type: "discoveryengine.googleapis.com/Document"
102
+ }
103
+ ];
104
+
105
+ // Maximum number of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s to
106
+ // return. If unspecified, defaults to 100. The maximum allowed value is 1000.
107
+ // Values above 1000 will be coerced to 1000.
108
+ //
109
+ // If this field is negative, an `INVALID_ARGUMENT` error is returned.
110
+ int32 page_size = 2;
111
+
112
+ // A page token
113
+ // [ListChunksResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListChunksResponse.next_page_token],
114
+ // received from a previous
115
+ // [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks]
116
+ // call. Provide this to retrieve the subsequent page.
117
+ //
118
+ // When paginating, all other parameters provided to
119
+ // [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks]
120
+ // must match the call that provided the page token. Otherwise, an
121
+ // `INVALID_ARGUMENT` error is returned.
122
+ string page_token = 3;
123
+ }
124
+
125
+ // Response message for
126
+ // [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks]
127
+ // method.
128
+ message ListChunksResponse {
129
+ // The [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
130
+ repeated Chunk chunks = 1;
131
+
132
+ // A token that can be sent as
133
+ // [ListChunksRequest.page_token][google.cloud.discoveryengine.v1alpha.ListChunksRequest.page_token]
134
+ // to retrieve the next page. If this field is omitted, there are no
135
+ // subsequent pages.
136
+ string next_page_token = 2;
137
+ }
@@ -36,10 +36,8 @@ option (google.api.resource_definition) = {
36
36
  pattern: "projects/{project}/locations/{location}/collections/{collection}"
37
37
  };
38
38
  option (google.api.resource_definition) = {
39
- type: "discoveryengine.googleapis.com/ServingConfig"
40
- pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}"
41
- pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}"
42
- pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}"
39
+ type: "discoveryengine.googleapis.com/Location"
40
+ pattern: "projects/{project}/locations/{location}"
43
41
  };
44
42
 
45
43
  // The industry vertical associated with the
@@ -178,8 +176,83 @@ message UserInfo {
178
176
  string user_agent = 2;
179
177
  }
180
178
 
179
+ // Defines embedding config, used for bring your own embeddings feature.
180
+ message EmbeddingConfig {
181
+ // Full field path in the schema mapped as embedding field.
182
+ string field_path = 1;
183
+ }
184
+
181
185
  // Double list.
182
186
  message DoubleList {
183
187
  // Double values.
184
188
  repeated double values = 1;
185
189
  }
190
+
191
+ // Defines guided search spec.
192
+ message GuidedSearchSpec {
193
+ // Whether or not to enable and include refinement attributes in gudied search
194
+ // result.
195
+ bool enable_refinement_attributes = 1;
196
+
197
+ // Whether or not to enable and include related questions in search response.
198
+ bool enable_related_questions = 2;
199
+
200
+ // Max number of related questions to be returned. The valid range is [1, 5].
201
+ // If enable_related_questions is true, the default value is 3.
202
+ int32 max_related_questions = 3;
203
+ }
204
+
205
+ // Defines custom fine tuning spec.
206
+ message CustomFineTuningSpec {
207
+ // Whether or not to enable and include custom fine tuned search adaptor
208
+ // model.
209
+ bool enable_search_adaptor = 1;
210
+ }
211
+
212
+ // Identity Provider Config.
213
+ message IdpConfig {
214
+ // Third party IDP Config.
215
+ message ExternalIdpConfig {
216
+ // Workforce pool name.
217
+ // Example: "locations/global/workforcePools/pool_id"
218
+ string workforce_pool_name = 1;
219
+ }
220
+
221
+ // Identity Provider Type.
222
+ enum IdpType {
223
+ // Default value. ACL search not enabled.
224
+ IDP_TYPE_UNSPECIFIED = 0;
225
+
226
+ // Google 1P provider.
227
+ GSUITE = 1;
228
+
229
+ // Third party provider.
230
+ THIRD_PARTY = 2;
231
+ }
232
+
233
+ // Identity provider type configured.
234
+ IdpType idp_type = 1;
235
+
236
+ // External Identity provider config.
237
+ ExternalIdpConfig external_idp_config = 2;
238
+ }
239
+
240
+ // Principal identifier of a user or a group.
241
+ message Principal {
242
+ // Union field principal. Principal can be a user or a group.
243
+ oneof principal {
244
+ // User identifier.
245
+ // For Google Workspace user account, user_id should be the google workspace
246
+ // user email.
247
+ // For non-google identity provider user account, user_id is the mapped user
248
+ // identifier configured during the workforcepool config.
249
+ string user_id = 1;
250
+
251
+ // Group identifier.
252
+ // For Google Workspace user account, group_id should be the google
253
+ // workspace group email.
254
+ // For non-google identity provider user account, group_id is the mapped
255
+ // group identifier configured during the workforcepool config.
256
+ string group_id = 2;
257
+ }
258
+ }
@@ -0,0 +1,52 @@
1
+ // Copyright 2022 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
+
21
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
22
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
23
+ option java_multiple_files = true;
24
+ option java_outer_classname = "CompletionProto";
25
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
26
+ option objc_class_prefix = "DISCOVERYENGINE";
27
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
28
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
29
+
30
+ // Suggestion deny list entry identifying the phrase to block from suggestions
31
+ // and the applied operation for the phrase.
32
+ message SuggestionDenyListEntry {
33
+ // Operator for matching with the generated suggestions.
34
+ enum MatchOperator {
35
+ // Default value. Should not be used
36
+ MATCH_OPERATOR_UNSPECIFIED = 0;
37
+
38
+ // If the suggestion is an exact match to the block_phrase, then block it.
39
+ EXACT_MATCH = 1;
40
+
41
+ // If the suggestion contains the block_phrase, then block it.
42
+ CONTAINS = 2;
43
+ }
44
+
45
+ // Required. Phrase to block from suggestions served. Can be maximum 125
46
+ // characters.
47
+ string block_phrase = 1 [(google.api.field_behavior) = REQUIRED];
48
+
49
+ // Required. The match operator to apply for this phrase. Whether to block the
50
+ // exact phrase, or block any suggestions containing this phrase.
51
+ MatchOperator match_operator = 2 [(google.api.field_behavior) = REQUIRED];
52
+ }
@@ -20,6 +20,9 @@ import "google/api/annotations.proto";
20
20
  import "google/api/client.proto";
21
21
  import "google/api/field_behavior.proto";
22
22
  import "google/api/resource.proto";
23
+ import "google/cloud/discoveryengine/v1alpha/import_config.proto";
24
+ import "google/cloud/discoveryengine/v1alpha/purge_config.proto";
25
+ import "google/longrunning/operations.proto";
23
26
 
24
27
  option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
25
28
  option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
@@ -45,6 +48,44 @@ service CompletionService {
45
48
  }
46
49
  };
47
50
  }
51
+
52
+ // Imports all
53
+ // [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry]
54
+ // for a DataStore.
55
+ rpc ImportSuggestionDenyListEntries(ImportSuggestionDenyListEntriesRequest)
56
+ returns (google.longrunning.Operation) {
57
+ option (google.api.http) = {
58
+ post: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/suggestionDenyListEntries:import"
59
+ body: "*"
60
+ additional_bindings {
61
+ post: "/v1alpha/{parent=projects/*/locations/*/dataStores/*}/suggestionDenyListEntries:import"
62
+ body: "*"
63
+ }
64
+ };
65
+ option (google.longrunning.operation_info) = {
66
+ response_type: "google.cloud.discoveryengine.v1alpha.ImportSuggestionDenyListEntriesResponse"
67
+ metadata_type: "google.cloud.discoveryengine.v1alpha.ImportSuggestionDenyListEntriesMetadata"
68
+ };
69
+ }
70
+
71
+ // Permanently deletes all
72
+ // [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry]
73
+ // for a DataStore.
74
+ rpc PurgeSuggestionDenyListEntries(PurgeSuggestionDenyListEntriesRequest)
75
+ returns (google.longrunning.Operation) {
76
+ option (google.api.http) = {
77
+ post: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/suggestionDenyListEntries:purge"
78
+ body: "*"
79
+ additional_bindings {
80
+ post: "/v1alpha/{parent=projects/*/locations/*/dataStores/**}/suggestionDenyListEntries:purge"
81
+ body: "*"
82
+ }
83
+ };
84
+ option (google.longrunning.operation_info) = {
85
+ response_type: "google.cloud.discoveryengine.v1alpha.PurgeSuggestionDenyListEntriesResponse"
86
+ metadata_type: "google.cloud.discoveryengine.v1alpha.PurgeSuggestionDenyListEntriesMetadata"
87
+ };
88
+ }
48
89
  }
49
90
 
50
91
  // Request message for
@@ -65,8 +106,9 @@ message CompleteQueryRequest {
65
106
  // 128 characters.
66
107
  string query = 2 [(google.api.field_behavior) = REQUIRED];
67
108
 
68
- // Selects data model of query suggestions for serving. Currently supported
69
- // values:
109
+ // Specifies the autocomplete data model. This overrides any model specified
110
+ // in the Configuration > Autocomplete section of the Cloud console. Currently
111
+ // supported values:
70
112
  //
71
113
  // * `document` - Using suggestions generated from user-imported documents.
72
114
  // * `search-history` - Using suggestions generated from the past history of
@@ -223,6 +223,11 @@ message ConverseConversationRequest {
223
223
  // operators, see
224
224
  // [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
225
225
  string filter = 9;
226
+
227
+ // Boost specification to boost certain documents in search results which may
228
+ // affect the converse response. For more information on boosting, see
229
+ // [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
230
+ SearchRequest.BoostSpec boost_spec = 10;
226
231
  }
227
232
 
228
233
  // Response message for
@@ -266,7 +271,7 @@ message UpdateConversationRequest {
266
271
  // [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
267
272
  // update. The following are NOT supported:
268
273
  //
269
- // * [conversation.name][]
274
+ // * [Conversation.name][google.cloud.discoveryengine.v1alpha.Conversation.name]
270
275
  //
271
276
  // If not set or empty, all supported fields are updated.
272
277
  google.protobuf.FieldMask update_mask = 2;
@@ -19,6 +19,8 @@ package google.cloud.discoveryengine.v1alpha;
19
19
  import "google/api/field_behavior.proto";
20
20
  import "google/api/resource.proto";
21
21
  import "google/cloud/discoveryengine/v1alpha/common.proto";
22
+ import "google/cloud/discoveryengine/v1alpha/document_processing_config.proto";
23
+ import "google/cloud/discoveryengine/v1alpha/schema.proto";
22
24
  import "google/protobuf/timestamp.proto";
23
25
 
24
26
  option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
@@ -95,4 +97,46 @@ message DataStore {
95
97
  // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] was created at.
96
98
  google.protobuf.Timestamp create_time = 4
97
99
  [(google.api.field_behavior) = OUTPUT_ONLY];
100
+
101
+ // Output only. Data store level identity provider config.
102
+ IdpConfig idp_config = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
103
+
104
+ // Immutable. Whether data in the
105
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] has ACL
106
+ // information. If set to `true`, the source data must have ACL. ACL will be
107
+ // ingested when data is ingested by
108
+ // [DocumentService.ImportDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments]
109
+ // methods.
110
+ //
111
+ // When ACL is enabled for the
112
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore],
113
+ // [Document][google.cloud.discoveryengine.v1alpha.Document] can't be accessed
114
+ // by calling
115
+ // [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument]
116
+ // or
117
+ // [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments].
118
+ //
119
+ // Currently ACL is only supported in `GENERIC` industry vertical with
120
+ // non-`PUBLIC_WEBSITE` content config.
121
+ bool acl_enabled = 24 [(google.api.field_behavior) = IMMUTABLE];
122
+
123
+ // Configuration for Document understanding and enrichment.
124
+ DocumentProcessingConfig document_processing_config = 27;
125
+
126
+ // The start schema to use for this
127
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] when
128
+ // provisioning it. If unset, a default vertical specialized schema will be
129
+ // used.
130
+ //
131
+ // This field is only used by [CreateDataStore][] API, and will be ignored if
132
+ // used in other APIs. This field will be omitted from all API responses
133
+ // including [CreateDataStore][] API. To retrieve a schema of a
134
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], use
135
+ // [SchemaService.GetSchema][google.cloud.discoveryengine.v1alpha.SchemaService.GetSchema]
136
+ // API instead.
137
+ //
138
+ // The provided schema will be validated against certain rules on schema.
139
+ // Learn more from [this
140
+ // doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
141
+ Schema starting_schema = 28;
98
142
  }