@google-cloud/discoveryengine 1.3.1 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (119) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +51 -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/v1beta/common.proto +59 -8
  20. package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +52 -0
  21. package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +51 -4
  22. package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +3 -0
  23. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +40 -1
  24. package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +98 -0
  25. package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +306 -0
  26. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
  27. package/build/protos/google/cloud/discoveryengine/v1beta/engine.proto +220 -0
  28. package/build/protos/google/cloud/discoveryengine/v1beta/engine_service.proto +244 -0
  29. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +64 -0
  30. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +38 -0
  31. package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +26 -3
  32. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +150 -11
  33. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +264 -0
  34. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto +147 -0
  35. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine.proto +170 -0
  36. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine_service.proto +695 -0
  37. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -3
  38. package/build/protos/protos.d.ts +41157 -23655
  39. package/build/protos/protos.js +103188 -62466
  40. package/build/protos/protos.json +10400 -6075
  41. package/build/src/index.d.ts +10 -1
  42. package/build/src/index.js +10 -1
  43. package/build/src/v1/completion_service_client.d.ts +489 -7
  44. package/build/src/v1/completion_service_client.js +715 -11
  45. package/build/src/v1/completion_service_client_config.json +10 -0
  46. package/build/src/v1/conversational_search_service_client.d.ts +341 -3
  47. package/build/src/v1/conversational_search_service_client.js +466 -9
  48. package/build/src/v1/data_store_service_client.d.ts +1286 -0
  49. package/build/src/v1/data_store_service_client.js +1768 -0
  50. package/build/src/v1/data_store_service_client_config.json +46 -0
  51. package/build/src/v1/document_service_client.d.ts +347 -2
  52. package/build/src/v1/document_service_client.js +506 -9
  53. package/build/src/v1/engine_service_client.d.ts +1211 -0
  54. package/build/src/v1/engine_service_client.js +1731 -0
  55. package/build/src/v1/engine_service_client_config.json +46 -0
  56. package/build/src/v1/index.d.ts +3 -0
  57. package/build/src/v1/index.js +7 -1
  58. package/build/src/v1/schema_service_client.d.ts +272 -2
  59. package/build/src/v1/schema_service_client.js +402 -9
  60. package/build/src/v1/search_service_client.d.ts +515 -11
  61. package/build/src/v1/search_service_client.js +648 -15
  62. package/build/src/v1/site_search_engine_service_client.d.ts +1564 -0
  63. package/build/src/v1/site_search_engine_service_client.js +2075 -0
  64. package/build/src/v1/site_search_engine_service_client_config.json +74 -0
  65. package/build/src/v1/user_event_service_client.d.ts +272 -2
  66. package/build/src/v1/user_event_service_client.js +402 -9
  67. package/build/src/v1alpha/completion_service_client.d.ts +11 -2
  68. package/build/src/v1alpha/completion_service_client.js +37 -10
  69. package/build/src/v1alpha/conversational_search_service_client.d.ts +11 -2
  70. package/build/src/v1alpha/conversational_search_service_client.js +37 -10
  71. package/build/src/v1alpha/data_store_service_client.d.ts +11 -2
  72. package/build/src/v1alpha/data_store_service_client.js +37 -10
  73. package/build/src/v1alpha/document_service_client.d.ts +11 -2
  74. package/build/src/v1alpha/document_service_client.js +37 -10
  75. package/build/src/v1alpha/engine_service_client.d.ts +11 -2
  76. package/build/src/v1alpha/engine_service_client.js +37 -10
  77. package/build/src/v1alpha/index.js +1 -1
  78. package/build/src/v1alpha/recommendation_service_client.d.ts +11 -2
  79. package/build/src/v1alpha/recommendation_service_client.js +37 -10
  80. package/build/src/v1alpha/schema_service_client.d.ts +11 -2
  81. package/build/src/v1alpha/schema_service_client.js +37 -10
  82. package/build/src/v1alpha/search_service_client.d.ts +11 -2
  83. package/build/src/v1alpha/search_service_client.js +37 -10
  84. package/build/src/v1alpha/search_tuning_service_client.d.ts +11 -2
  85. package/build/src/v1alpha/search_tuning_service_client.js +37 -10
  86. package/build/src/v1alpha/site_search_engine_service_client.d.ts +11 -2
  87. package/build/src/v1alpha/site_search_engine_service_client.js +37 -10
  88. package/build/src/v1alpha/user_event_service_client.d.ts +11 -2
  89. package/build/src/v1alpha/user_event_service_client.js +37 -10
  90. package/build/src/v1beta/completion_service_client.d.ts +633 -7
  91. package/build/src/v1beta/completion_service_client.js +911 -11
  92. package/build/src/v1beta/completion_service_client_config.json +10 -0
  93. package/build/src/v1beta/conversational_search_service_client.d.ts +341 -3
  94. package/build/src/v1beta/conversational_search_service_client.js +466 -9
  95. package/build/src/v1beta/data_store_service_client.d.ts +1433 -0
  96. package/build/src/v1beta/data_store_service_client.js +1966 -0
  97. package/build/src/v1beta/data_store_service_client_config.json +46 -0
  98. package/build/src/v1beta/document_service_client.d.ts +491 -2
  99. package/build/src/v1beta/document_service_client.js +706 -11
  100. package/build/src/v1beta/engine_service_client.d.ts +1357 -0
  101. package/build/src/v1beta/engine_service_client.js +1928 -0
  102. package/build/src/v1beta/engine_service_client_config.json +46 -0
  103. package/build/src/v1beta/index.d.ts +4 -0
  104. package/build/src/v1beta/index.js +9 -1
  105. package/build/src/v1beta/recommendation_service_client.d.ts +420 -5
  106. package/build/src/v1beta/recommendation_service_client.js +570 -9
  107. package/build/src/v1beta/schema_service_client.d.ts +416 -2
  108. package/build/src/v1beta/schema_service_client.js +602 -11
  109. package/build/src/v1beta/search_service_client.d.ts +539 -29
  110. package/build/src/v1beta/search_service_client.js +664 -27
  111. package/build/src/v1beta/serving_config_service_client.d.ts +1102 -0
  112. package/build/src/v1beta/serving_config_service_client.js +1563 -0
  113. package/build/src/v1beta/serving_config_service_client_config.json +38 -0
  114. package/build/src/v1beta/site_search_engine_service_client.d.ts +1712 -0
  115. package/build/src/v1beta/site_search_engine_service_client.js +2271 -0
  116. package/build/src/v1beta/site_search_engine_service_client_config.json +74 -0
  117. package/build/src/v1beta/user_event_service_client.d.ts +416 -2
  118. package/build/src/v1beta/user_event_service_client.js +602 -11
  119. package/package.json +2 -2
@@ -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.
@@ -32,16 +32,61 @@ 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}"
38
- };
39
- option (google.api.resource_definition) = {
40
- type: "discoveryengine.googleapis.com/ServingConfig"
41
- pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}"
42
- pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}"
35
+ type: "discoveryengine.googleapis.com/Collection"
36
+ pattern: "projects/{project}/locations/{location}/collections/{collection}"
43
37
  };
44
38
 
39
+ // The industry vertical associated with the
40
+ // [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
41
+ enum IndustryVertical {
42
+ // Value used when unset.
43
+ INDUSTRY_VERTICAL_UNSPECIFIED = 0;
44
+
45
+ // The generic vertical for documents that are not specific to any industry
46
+ // vertical.
47
+ GENERIC = 1;
48
+
49
+ // The media industry vertical.
50
+ MEDIA = 2;
51
+ }
52
+
53
+ // The type of solution.
54
+ enum SolutionType {
55
+ // Default value.
56
+ SOLUTION_TYPE_UNSPECIFIED = 0;
57
+
58
+ // Used for Recommendations AI.
59
+ SOLUTION_TYPE_RECOMMENDATION = 1;
60
+
61
+ // Used for Discovery Search.
62
+ SOLUTION_TYPE_SEARCH = 2;
63
+
64
+ // Used for use cases related to the Generative AI agent.
65
+ SOLUTION_TYPE_CHAT = 3;
66
+ }
67
+
68
+ // Tiers of search features. Different tiers might have different
69
+ // pricing. To learn more, please check the pricing documentation.
70
+ enum SearchTier {
71
+ // Default value when the enum is unspecified. This is invalid to use.
72
+ SEARCH_TIER_UNSPECIFIED = 0;
73
+
74
+ // Standard tier.
75
+ SEARCH_TIER_STANDARD = 1;
76
+
77
+ // Enterprise tier.
78
+ SEARCH_TIER_ENTERPRISE = 2;
79
+ }
80
+
81
+ // Add-on that provides additional functionality for search.
82
+ enum SearchAddOn {
83
+ // Default value when the enum is unspecified. This is invalid to use.
84
+ SEARCH_ADD_ON_UNSPECIFIED = 0;
85
+
86
+ // Large language model add-on.
87
+ SEARCH_ADD_ON_LLM = 1;
88
+ }
89
+
45
90
  // A floating point interval.
46
91
  message Interval {
47
92
  // The lower bound of the interval. If neither of the min fields are
@@ -127,6 +172,12 @@ message UserInfo {
127
172
  string user_agent = 2;
128
173
  }
129
174
 
175
+ // Defines embedding config, used for bring your own embeddings feature.
176
+ message EmbeddingConfig {
177
+ // Full field path in the schema mapped as embedding field.
178
+ string field_path = 1;
179
+ }
180
+
130
181
  // Double list.
131
182
  message DoubleList {
132
183
  // Double values.
@@ -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.v1beta;
18
+
19
+ import "google/api/field_behavior.proto";
20
+
21
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
22
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
23
+ option java_multiple_files = true;
24
+ option java_outer_classname = "CompletionProto";
25
+ option java_package = "com.google.cloud.discoveryengine.v1beta";
26
+ option objc_class_prefix = "DISCOVERYENGINE";
27
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
28
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
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/v1beta/import_config.proto";
24
+ import "google/cloud/discoveryengine/v1beta/purge_config.proto";
25
+ import "google/longrunning/operations.proto";
23
26
 
24
27
  option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
25
28
  option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
@@ -45,6 +48,44 @@ service CompletionService {
45
48
  }
46
49
  };
47
50
  }
51
+
52
+ // Imports all
53
+ // [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry]
54
+ // for a DataStore.
55
+ rpc ImportSuggestionDenyListEntries(ImportSuggestionDenyListEntriesRequest)
56
+ returns (google.longrunning.Operation) {
57
+ option (google.api.http) = {
58
+ post: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/suggestionDenyListEntries:import"
59
+ body: "*"
60
+ additional_bindings {
61
+ post: "/v1beta/{parent=projects/*/locations/*/dataStores/*}/suggestionDenyListEntries:import"
62
+ body: "*"
63
+ }
64
+ };
65
+ option (google.longrunning.operation_info) = {
66
+ response_type: "google.cloud.discoveryengine.v1beta.ImportSuggestionDenyListEntriesResponse"
67
+ metadata_type: "google.cloud.discoveryengine.v1beta.ImportSuggestionDenyListEntriesMetadata"
68
+ };
69
+ }
70
+
71
+ // Permanently deletes all
72
+ // [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry]
73
+ // for a DataStore.
74
+ rpc PurgeSuggestionDenyListEntries(PurgeSuggestionDenyListEntriesRequest)
75
+ returns (google.longrunning.Operation) {
76
+ option (google.api.http) = {
77
+ post: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/suggestionDenyListEntries:purge"
78
+ body: "*"
79
+ additional_bindings {
80
+ post: "/v1beta/{parent=projects/*/locations/*/dataStores/**}/suggestionDenyListEntries:purge"
81
+ body: "*"
82
+ }
83
+ };
84
+ option (google.longrunning.operation_info) = {
85
+ response_type: "google.cloud.discoveryengine.v1beta.PurgeSuggestionDenyListEntriesResponse"
86
+ metadata_type: "google.cloud.discoveryengine.v1beta.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
@@ -80,8 +122,7 @@ message CompleteQueryRequest {
80
122
  // Default values:
81
123
  //
82
124
  // * `document` is the default model for regular dataStores.
83
- // * `search-history` is the default model for
84
- // [IndustryVertical.SITE_SEARCH][] dataStores.
125
+ // * `search-history` is the default model for site search dataStores.
85
126
  string query_model = 3;
86
127
 
87
128
  // A unique identifier for tracking visitors. For example, this could be
@@ -115,6 +156,12 @@ message CompleteQueryResponse {
115
156
  message QuerySuggestion {
116
157
  // The suggestion for the query.
117
158
  string suggestion = 1;
159
+
160
+ // The unique document field paths that serve as the source of this
161
+ // suggestion if it was generated from completable fields.
162
+ //
163
+ // This field is only populated for the document-completable model.
164
+ repeated string completable_field_paths = 2;
118
165
  }
119
166
 
120
167
  // Results of the matched query suggestions. The result list is ordered and
@@ -36,6 +36,7 @@ message Conversation {
36
36
  type: "discoveryengine.googleapis.com/Conversation"
37
37
  pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}"
38
38
  pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}"
39
+ pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}"
39
40
  };
40
41
 
41
42
  // Enumeration of the state of the conversation.
@@ -52,6 +53,8 @@ message Conversation {
52
53
 
53
54
  // Immutable. Fully qualified name
54
55
  // `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
56
+ // or
57
+ // `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
55
58
  string name = 1 [(google.api.field_behavior) = IMMUTABLE];
56
59
 
57
60
  // The state of the Conversation.
@@ -50,6 +50,10 @@ service ConversationalSearchService {
50
50
  post: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}:converse"
51
51
  body: "*"
52
52
  }
53
+ additional_bindings {
54
+ post: "/v1beta/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}:converse"
55
+ body: "*"
56
+ }
53
57
  };
54
58
  option (google.api.method_signature) = "name,query";
55
59
  }
@@ -66,6 +70,10 @@ service ConversationalSearchService {
66
70
  post: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations"
67
71
  body: "conversation"
68
72
  }
73
+ additional_bindings {
74
+ post: "/v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/conversations"
75
+ body: "conversation"
76
+ }
69
77
  };
70
78
  option (google.api.method_signature) = "parent,conversation";
71
79
  }
@@ -81,6 +89,9 @@ service ConversationalSearchService {
81
89
  additional_bindings {
82
90
  delete: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}"
83
91
  }
92
+ additional_bindings {
93
+ delete: "/v1beta/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}"
94
+ }
84
95
  };
85
96
  option (google.api.method_signature) = "name";
86
97
  }
@@ -99,6 +110,10 @@ service ConversationalSearchService {
99
110
  patch: "/v1beta/{conversation.name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}"
100
111
  body: "conversation"
101
112
  }
113
+ additional_bindings {
114
+ patch: "/v1beta/{conversation.name=projects/*/locations/*/collections/*/engines/*/conversations/*}"
115
+ body: "conversation"
116
+ }
102
117
  };
103
118
  option (google.api.method_signature) = "conversation,update_mask";
104
119
  }
@@ -110,6 +125,9 @@ service ConversationalSearchService {
110
125
  additional_bindings {
111
126
  get: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}"
112
127
  }
128
+ additional_bindings {
129
+ get: "/v1beta/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}"
130
+ }
113
131
  };
114
132
  option (google.api.method_signature) = "name";
115
133
  }
@@ -123,6 +141,9 @@ service ConversationalSearchService {
123
141
  additional_bindings {
124
142
  get: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations"
125
143
  }
144
+ additional_bindings {
145
+ get: "/v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/conversations"
146
+ }
126
147
  };
127
148
  option (google.api.method_signature) = "parent";
128
149
  }
@@ -184,6 +205,24 @@ message ConverseConversationRequest {
184
205
 
185
206
  // A specification for configuring the summary returned in the response.
186
207
  SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;
208
+
209
+ // The filter syntax consists of an expression language for constructing a
210
+ // predicate from one or more fields of the documents being filtered. Filter
211
+ // expression is case-sensitive. This will be used to filter search results
212
+ // which may affect the summary response.
213
+ //
214
+ // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
215
+ //
216
+ // Filtering in Vertex AI Search is done by mapping the LHS filter key to a
217
+ // key property defined in the Vertex AI Search backend -- this mapping is
218
+ // defined by the customer in their schema. For example a media customer might
219
+ // have a field 'name' in their schema. In this case the filter would look
220
+ // like this: filter --> name:'ANY("king kong")'
221
+ //
222
+ // For more information about filtering including syntax and filter
223
+ // operators, see
224
+ // [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
225
+ string filter = 9;
187
226
  }
188
227
 
189
228
  // Response message for
@@ -227,7 +266,7 @@ message UpdateConversationRequest {
227
266
  // [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to update.
228
267
  // The following are NOT supported:
229
268
  //
230
- // * [conversation.name][]
269
+ // * [Conversation.name][google.cloud.discoveryengine.v1beta.Conversation.name]
231
270
  //
232
271
  // If not set or empty, all supported fields are updated.
233
272
  google.protobuf.FieldMask update_mask = 2;
@@ -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.v1beta;
18
+
19
+ import "google/api/field_behavior.proto";
20
+ import "google/api/resource.proto";
21
+ import "google/cloud/discoveryengine/v1beta/common.proto";
22
+ import "google/protobuf/timestamp.proto";
23
+
24
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
25
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
26
+ option java_multiple_files = true;
27
+ option java_outer_classname = "DataStoreProto";
28
+ option java_package = "com.google.cloud.discoveryengine.v1beta";
29
+ option objc_class_prefix = "DISCOVERYENGINE";
30
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
31
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
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.v1beta.Document.content].
48
+ NO_CONTENT = 1;
49
+
50
+ // Only contains documents with
51
+ // [Document.content][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.DataStore] was created at.
96
+ google.protobuf.Timestamp create_time = 4
97
+ [(google.api.field_behavior) = OUTPUT_ONLY];
98
+ }