@google-cloud/discoveryengine 1.2.0 → 1.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (37) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +13 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +39 -4
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +98 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +307 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +370 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +336 -0
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +9 -3
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +26 -3
  10. package/build/protos/protos.d.ts +5578 -1800
  11. package/build/protos/protos.js +14034 -5272
  12. package/build/protos/protos.json +1337 -340
  13. package/build/src/v1alpha/completion_service_client.d.ts +42 -0
  14. package/build/src/v1alpha/completion_service_client.js +58 -0
  15. package/build/src/v1alpha/conversational_search_service_client.d.ts +42 -0
  16. package/build/src/v1alpha/conversational_search_service_client.js +58 -0
  17. package/build/src/v1alpha/data_store_service_client.d.ts +1060 -0
  18. package/build/src/v1alpha/data_store_service_client.js +1431 -0
  19. package/build/src/v1alpha/data_store_service_client_config.json +46 -0
  20. package/build/src/v1alpha/document_service_client.d.ts +117 -0
  21. package/build/src/v1alpha/document_service_client.js +162 -0
  22. package/build/src/v1alpha/engine_service_client.d.ts +1079 -0
  23. package/build/src/v1alpha/engine_service_client.js +1481 -0
  24. package/build/src/v1alpha/engine_service_client_config.json +58 -0
  25. package/build/src/v1alpha/index.d.ts +2 -0
  26. package/build/src/v1alpha/index.js +5 -1
  27. package/build/src/v1alpha/recommendation_service_client.d.ts +126 -3
  28. package/build/src/v1alpha/recommendation_service_client.js +162 -0
  29. package/build/src/v1alpha/schema_service_client.d.ts +42 -0
  30. package/build/src/v1alpha/schema_service_client.js +58 -0
  31. package/build/src/v1alpha/search_service_client.d.ts +195 -9
  32. package/build/src/v1alpha/search_service_client.js +214 -6
  33. package/build/src/v1alpha/site_search_engine_service_client.d.ts +117 -0
  34. package/build/src/v1alpha/site_search_engine_service_client.js +162 -0
  35. package/build/src/v1alpha/user_event_service_client.d.ts +42 -0
  36. package/build/src/v1alpha/user_event_service_client.js +58 -0
  37. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.3.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.2.0...discoveryengine-v1.3.0) (2023-11-16)
4
+
5
+
6
+ ### Features
7
+
8
+ * [discoveryengine] add data store and engine services ([#4810](https://github.com/googleapis/google-cloud-node/issues/4810)) ([7e95257](https://github.com/googleapis/google-cloud-node/commit/7e95257cb371509efce1e5b83a730cb1a1db4492))
9
+
3
10
  ## [1.2.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.1.0...discoveryengine-v1.2.0) (2023-10-18)
4
11
 
5
12
 
package/README.md CHANGED
@@ -155,6 +155,11 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
155
155
  | Conversational_search_service.get_conversation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/conversational_search_service.get_conversation.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/conversational_search_service.get_conversation.js,packages/google-cloud-discoveryengine/samples/README.md) |
156
156
  | Conversational_search_service.list_conversations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/conversational_search_service.list_conversations.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/conversational_search_service.list_conversations.js,packages/google-cloud-discoveryengine/samples/README.md) |
157
157
  | Conversational_search_service.update_conversation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/conversational_search_service.update_conversation.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/conversational_search_service.update_conversation.js,packages/google-cloud-discoveryengine/samples/README.md) |
158
+ | Data_store_service.create_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.create_data_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.create_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
159
+ | Data_store_service.delete_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.delete_data_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.delete_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
160
+ | Data_store_service.get_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.get_data_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.get_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
161
+ | Data_store_service.list_data_stores | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.list_data_stores.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.list_data_stores.js,packages/google-cloud-discoveryengine/samples/README.md) |
162
+ | Data_store_service.update_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.update_data_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.update_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
158
163
  | Document_service.create_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.create_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.create_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
159
164
  | Document_service.delete_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.delete_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.delete_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
160
165
  | Document_service.get_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.get_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.get_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -162,6 +167,14 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
162
167
  | Document_service.list_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.list_documents.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.list_documents.js,packages/google-cloud-discoveryengine/samples/README.md) |
163
168
  | Document_service.purge_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.purge_documents.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.purge_documents.js,packages/google-cloud-discoveryengine/samples/README.md) |
164
169
  | Document_service.update_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.update_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.update_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
170
+ | Engine_service.create_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.create_engine.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.create_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
171
+ | Engine_service.delete_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.delete_engine.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.delete_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
172
+ | Engine_service.get_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.get_engine.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.get_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
173
+ | Engine_service.list_engines | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.list_engines.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.list_engines.js,packages/google-cloud-discoveryengine/samples/README.md) |
174
+ | Engine_service.pause_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.pause_engine.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.pause_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
175
+ | Engine_service.resume_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.resume_engine.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.resume_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
176
+ | Engine_service.tune_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.tune_engine.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.tune_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
177
+ | Engine_service.update_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.update_engine.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.update_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
165
178
  | Recommendation_service.recommend | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/recommendation_service.recommend.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/recommendation_service.recommend.js,packages/google-cloud-discoveryengine/samples/README.md) |
166
179
  | Schema_service.create_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.create_schema.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.create_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
167
180
  | Schema_service.delete_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.delete_schema.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.delete_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -32,9 +32,8 @@ option (google.api.resource_definition) = {
32
32
  pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}"
33
33
  };
34
34
  option (google.api.resource_definition) = {
35
- type: "discoveryengine.googleapis.com/DataStore"
36
- pattern: "projects/{project}/locations/{location}/dataStores/{data_store}"
37
- pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}"
35
+ type: "discoveryengine.googleapis.com/Collection"
36
+ pattern: "projects/{project}/locations/{location}/collections/{collection}"
38
37
  };
39
38
  option (google.api.resource_definition) = {
40
39
  type: "discoveryengine.googleapis.com/ServingConfig"
@@ -43,11 +42,25 @@ option (google.api.resource_definition) = {
43
42
  pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}"
44
43
  };
45
44
  option (google.api.resource_definition) = {
46
- type: "discoveryengine.googleapis.com/SiteSearchEngine",
45
+ type: "discoveryengine.googleapis.com/SiteSearchEngine"
47
46
  pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine"
48
47
  pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine"
49
48
  };
50
49
 
50
+ // The industry vertical associated with the
51
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
52
+ enum IndustryVertical {
53
+ // Value used when unset.
54
+ INDUSTRY_VERTICAL_UNSPECIFIED = 0;
55
+
56
+ // The generic vertical for documents that are not specific to any industry
57
+ // vertical.
58
+ GENERIC = 1;
59
+
60
+ // The media industry vertical.
61
+ MEDIA = 2;
62
+ }
63
+
51
64
  // The type of solution.
52
65
  enum SolutionType {
53
66
  // Default value.
@@ -63,6 +76,28 @@ enum SolutionType {
63
76
  SOLUTION_TYPE_CHAT = 3;
64
77
  }
65
78
 
79
+ // Tiers of search features. Different tiers might have different
80
+ // pricing. To learn more, please check the pricing documentation.
81
+ enum SearchTier {
82
+ // Default value when the enum is unspecified. This is invalid to use.
83
+ SEARCH_TIER_UNSPECIFIED = 0;
84
+
85
+ // Standard tier.
86
+ SEARCH_TIER_STANDARD = 1;
87
+
88
+ // Enterprise tier.
89
+ SEARCH_TIER_ENTERPRISE = 2;
90
+ }
91
+
92
+ // Add-on that provides additional functionality for search.
93
+ enum SearchAddOn {
94
+ // Default value when the enum is unspecified. This is invalid to use.
95
+ SEARCH_ADD_ON_UNSPECIFIED = 0;
96
+
97
+ // Large language model add-on.
98
+ SEARCH_ADD_ON_LLM = 1;
99
+ }
100
+
66
101
  // A floating point interval.
67
102
  message Interval {
68
103
  // The lower bound of the interval. If neither of the min fields are
@@ -0,0 +1,98 @@
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
+ import "google/protobuf/timestamp.proto";
23
+
24
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
25
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
26
+ option java_multiple_files = true;
27
+ option java_outer_classname = "DataStoreProto";
28
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
29
+ option objc_class_prefix = "DISCOVERYENGINE";
30
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
31
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
32
+
33
+ // DataStore captures global settings and configs at the DataStore level.
34
+ message DataStore {
35
+ option (google.api.resource) = {
36
+ type: "discoveryengine.googleapis.com/DataStore"
37
+ pattern: "projects/{project}/locations/{location}/dataStores/{data_store}"
38
+ pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}"
39
+ };
40
+
41
+ // Content config of the data store.
42
+ enum ContentConfig {
43
+ // Default value.
44
+ CONTENT_CONFIG_UNSPECIFIED = 0;
45
+
46
+ // Only contains documents without any
47
+ // [Document.content][google.cloud.discoveryengine.v1alpha.Document.content].
48
+ NO_CONTENT = 1;
49
+
50
+ // Only contains documents with
51
+ // [Document.content][google.cloud.discoveryengine.v1alpha.Document.content].
52
+ CONTENT_REQUIRED = 2;
53
+
54
+ // The data store is used for public website search.
55
+ PUBLIC_WEBSITE = 3;
56
+ }
57
+
58
+ // Immutable. The full resource name of the data store.
59
+ // Format:
60
+ // `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
61
+ //
62
+ // This field must be a UTF-8 encoded string with a length limit of 1024
63
+ // characters.
64
+ string name = 1 [(google.api.field_behavior) = IMMUTABLE];
65
+
66
+ // Required. The data store display name.
67
+ //
68
+ // This field must be a UTF-8 encoded string with a length limit of 128
69
+ // characters. Otherwise, an INVALID_ARGUMENT error is returned.
70
+ string display_name = 2 [(google.api.field_behavior) = REQUIRED];
71
+
72
+ // Immutable. The industry vertical that the data store registers.
73
+ IndustryVertical industry_vertical = 3
74
+ [(google.api.field_behavior) = IMMUTABLE];
75
+
76
+ // The solutions that the data store enrolls. Available solutions for each
77
+ // [industry_vertical][google.cloud.discoveryengine.v1alpha.DataStore.industry_vertical]:
78
+ //
79
+ // * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`.
80
+ // * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other
81
+ // solutions cannot be enrolled.
82
+ repeated SolutionType solution_types = 5;
83
+
84
+ // Output only. The id of the default
85
+ // [Schema][google.cloud.discoveryengine.v1alpha.Schema] asscociated to this
86
+ // data store.
87
+ string default_schema_id = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
88
+
89
+ // Immutable. The content config of the data store. If this field is unset,
90
+ // the server behavior defaults to
91
+ // [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.NO_CONTENT].
92
+ ContentConfig content_config = 6 [(google.api.field_behavior) = IMMUTABLE];
93
+
94
+ // Output only. Timestamp the
95
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] was created at.
96
+ google.protobuf.Timestamp create_time = 4
97
+ [(google.api.field_behavior) = OUTPUT_ONLY];
98
+ }
@@ -0,0 +1,307 @@
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/data_store.proto";
24
+ import "google/longrunning/operations.proto";
25
+ import "google/protobuf/empty.proto";
26
+ import "google/protobuf/field_mask.proto";
27
+ import "google/protobuf/timestamp.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 = "DataStoreServiceProto";
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
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] configuration.
40
+ service DataStoreService {
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
+ // Creates a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
46
+ //
47
+ // DataStore is for storing
48
+ // [Documents][google.cloud.discoveryengine.v1alpha.Document]. To serve these
49
+ // documents for Search, or Recommendation use case, an
50
+ // [Engine][google.cloud.discoveryengine.v1alpha.Engine] needs to be created
51
+ // separately.
52
+ rpc CreateDataStore(CreateDataStoreRequest)
53
+ returns (google.longrunning.Operation) {
54
+ option (google.api.http) = {
55
+ post: "/v1alpha/{parent=projects/*/locations/*}/dataStores"
56
+ body: "data_store"
57
+ additional_bindings {
58
+ post: "/v1alpha/{parent=projects/*/locations/*/collections/*}/dataStores"
59
+ body: "data_store"
60
+ }
61
+ };
62
+ option (google.api.method_signature) = "parent,data_store,data_store_id";
63
+ option (google.longrunning.operation_info) = {
64
+ response_type: "google.cloud.discoveryengine.v1alpha.DataStore"
65
+ metadata_type: "google.cloud.discoveryengine.v1alpha.CreateDataStoreMetadata"
66
+ };
67
+ }
68
+
69
+ // Gets a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
70
+ rpc GetDataStore(GetDataStoreRequest) returns (DataStore) {
71
+ option (google.api.http) = {
72
+ get: "/v1alpha/{name=projects/*/locations/*/dataStores/*}"
73
+ additional_bindings {
74
+ get: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*}"
75
+ }
76
+ };
77
+ option (google.api.method_signature) = "name";
78
+ }
79
+
80
+ // Lists all the [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s
81
+ // associated with the project.
82
+ rpc ListDataStores(ListDataStoresRequest) returns (ListDataStoresResponse) {
83
+ option (google.api.http) = {
84
+ get: "/v1alpha/{parent=projects/*/locations/*}/dataStores"
85
+ additional_bindings {
86
+ get: "/v1alpha/{parent=projects/*/locations/*/collections/*}/dataStores"
87
+ }
88
+ };
89
+ option (google.api.method_signature) = "parent";
90
+ }
91
+
92
+ // Deletes a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
93
+ rpc DeleteDataStore(DeleteDataStoreRequest)
94
+ returns (google.longrunning.Operation) {
95
+ option (google.api.http) = {
96
+ delete: "/v1alpha/{name=projects/*/locations/*/dataStores/*}"
97
+ additional_bindings {
98
+ delete: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*}"
99
+ }
100
+ };
101
+ option (google.api.method_signature) = "name";
102
+ option (google.longrunning.operation_info) = {
103
+ response_type: "google.protobuf.Empty"
104
+ metadata_type: "google.cloud.discoveryengine.v1alpha.DeleteDataStoreMetadata"
105
+ };
106
+ }
107
+
108
+ // Updates a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]
109
+ rpc UpdateDataStore(UpdateDataStoreRequest) returns (DataStore) {
110
+ option (google.api.http) = {
111
+ patch: "/v1alpha/{data_store.name=projects/*/locations/*/dataStores/*}"
112
+ body: "data_store"
113
+ additional_bindings {
114
+ patch: "/v1alpha/{data_store.name=projects/*/locations/*/collections/*/dataStores/*}"
115
+ body: "data_store"
116
+ }
117
+ };
118
+ option (google.api.method_signature) = "data_store,update_mask";
119
+ }
120
+ }
121
+
122
+ // Request for
123
+ // [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.CreateDataStore]
124
+ // method.
125
+ message CreateDataStoreRequest {
126
+ // Required. The parent resource name, such as
127
+ // `projects/{project}/locations/{location}/collections/{collection}`.
128
+ string parent = 1 [
129
+ (google.api.field_behavior) = REQUIRED,
130
+ (google.api.resource_reference) = {
131
+ type: "discoveryengine.googleapis.com/Collection"
132
+ }
133
+ ];
134
+
135
+ // Required. The [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]
136
+ // to create.
137
+ DataStore data_store = 2 [(google.api.field_behavior) = REQUIRED];
138
+
139
+ // Required. The ID to use for the
140
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], which will
141
+ // become the final component of the
142
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]'s resource
143
+ // name.
144
+ //
145
+ // This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
146
+ // standard with a length limit of 63 characters. Otherwise, an
147
+ // INVALID_ARGUMENT error is returned.
148
+ string data_store_id = 3 [(google.api.field_behavior) = REQUIRED];
149
+
150
+ // A boolean flag indicating whether user want to directly create an advanced
151
+ // data store for site search.
152
+ // If the data store is not configured as site
153
+ // search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
154
+ // be ignored.
155
+ bool create_advanced_site_search = 4;
156
+ }
157
+
158
+ // Request message for
159
+ // [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDataStore]
160
+ // method.
161
+ message GetDataStoreRequest {
162
+ // Required. Full resource name of
163
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], such as
164
+ // `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
165
+ //
166
+ // If the caller does not have permission to access the
167
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], regardless of
168
+ // whether or not it exists, a PERMISSION_DENIED error is returned.
169
+ //
170
+ // If the requested
171
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] does not exist,
172
+ // a NOT_FOUND error is returned.
173
+ string name = 1 [
174
+ (google.api.field_behavior) = REQUIRED,
175
+ (google.api.resource_reference) = {
176
+ type: "discoveryengine.googleapis.com/DataStore"
177
+ }
178
+ ];
179
+ }
180
+
181
+ // Metadata related to the progress of the
182
+ // [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.CreateDataStore]
183
+ // operation. This will be returned by the google.longrunning.Operation.metadata
184
+ // field.
185
+ message CreateDataStoreMetadata {
186
+ // Operation create time.
187
+ google.protobuf.Timestamp create_time = 1;
188
+
189
+ // Operation last update time. If the operation is done, this is also the
190
+ // finish time.
191
+ google.protobuf.Timestamp update_time = 2;
192
+ }
193
+
194
+ // Request message for
195
+ // [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores]
196
+ // method.
197
+ message ListDataStoresRequest {
198
+ // Required. The parent branch resource name, such as
199
+ // `projects/{project}/locations/{location}/collections/{collection_id}`.
200
+ //
201
+ // If the caller does not have permission to list [DataStores][]s under this
202
+ // location, regardless of whether or not this data store exists, a
203
+ // PERMISSION_DENIED error is returned.
204
+ string parent = 1 [
205
+ (google.api.field_behavior) = REQUIRED,
206
+ (google.api.resource_reference) = {
207
+ type: "discoveryengine.googleapis.com/Collection"
208
+ }
209
+ ];
210
+
211
+ // Maximum number of
212
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s to return. If
213
+ // unspecified, defaults to 10. The maximum allowed value is 50. Values above
214
+ // 50 will be coerced to 50.
215
+ //
216
+ // If this field is negative, an INVALID_ARGUMENT is returned.
217
+ int32 page_size = 2;
218
+
219
+ // A page token
220
+ // [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListDataStoresResponse.next_page_token],
221
+ // received from a previous
222
+ // [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores]
223
+ // call. Provide this to retrieve the subsequent page.
224
+ //
225
+ // When paginating, all other parameters provided to
226
+ // [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores]
227
+ // must match the call that provided the page token. Otherwise, an
228
+ // INVALID_ARGUMENT error is returned.
229
+ string page_token = 3;
230
+
231
+ // Filter by solution type. For example: filter =
232
+ // 'solution_type:SOLUTION_TYPE_SEARCH'
233
+ string filter = 4;
234
+ }
235
+
236
+ // Response message for
237
+ // [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores]
238
+ // method.
239
+ message ListDataStoresResponse {
240
+ // All the customer's
241
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s.
242
+ repeated DataStore data_stores = 1;
243
+
244
+ // A token that can be sent as
245
+ // [ListDataStoresRequest.page_token][google.cloud.discoveryengine.v1alpha.ListDataStoresRequest.page_token]
246
+ // to retrieve the next page. If this field is omitted, there are no
247
+ // subsequent pages.
248
+ string next_page_token = 2;
249
+ }
250
+
251
+ // Request message for
252
+ // [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.DeleteDataStore]
253
+ // method.
254
+ message DeleteDataStoreRequest {
255
+ // Required. Full resource name of
256
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], such as
257
+ // `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
258
+ //
259
+ // If the caller does not have permission to delete the
260
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], regardless of
261
+ // whether or not it exists, a PERMISSION_DENIED error is returned.
262
+ //
263
+ // If the [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] to
264
+ // delete does not exist, a NOT_FOUND error is returned.
265
+ string name = 1 [
266
+ (google.api.field_behavior) = REQUIRED,
267
+ (google.api.resource_reference) = {
268
+ type: "discoveryengine.googleapis.com/DataStore"
269
+ }
270
+ ];
271
+ }
272
+
273
+ // Request message for
274
+ // [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDataStore]
275
+ // method.
276
+ message UpdateDataStoreRequest {
277
+ // Required. The [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]
278
+ // to update.
279
+ //
280
+ // If the caller does not have permission to update the
281
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], regardless of
282
+ // whether or not it exists, a PERMISSION_DENIED error is returned.
283
+ //
284
+ // If the [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] to
285
+ // update does not exist, a NOT_FOUND error is returned.
286
+ DataStore data_store = 1 [(google.api.field_behavior) = REQUIRED];
287
+
288
+ // Indicates which fields in the provided
289
+ // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] to update.
290
+ //
291
+ // If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
292
+ // is returned.
293
+ google.protobuf.FieldMask update_mask = 2;
294
+ }
295
+
296
+ // Metadata related to the progress of the
297
+ // [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.DeleteDataStore]
298
+ // operation. This will be returned by the google.longrunning.Operation.metadata
299
+ // field.
300
+ message DeleteDataStoreMetadata {
301
+ // Operation create time.
302
+ google.protobuf.Timestamp create_time = 1;
303
+
304
+ // Operation last update time. If the operation is done, this is also the
305
+ // finish time.
306
+ google.protobuf.Timestamp update_time = 2;
307
+ }