@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.
- package/CHANGELOG.md +14 -0
- package/README.md +64 -0
- package/build/protos/google/cloud/discoveryengine/v1/common.proto +54 -3
- package/build/protos/google/cloud/discoveryengine/v1/completion.proto +52 -0
- package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +51 -4
- package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +40 -1
- package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +98 -0
- package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +304 -0
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1/engine.proto +215 -0
- package/build/protos/google/cloud/discoveryengine/v1/engine_service.proto +242 -0
- package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +64 -0
- package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +38 -0
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +137 -4
- package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +170 -0
- package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +691 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +3 -3
- package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config.proto +49 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config_service.proto +79 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +72 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/chunk_service.proto +137 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +77 -4
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion.proto +52 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +44 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +6 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +44 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +80 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +83 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +127 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +6 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +13 -8
- package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +3 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/estimate_billing_service.proto +130 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +64 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +66 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +3 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +74 -13
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +24 -20
- package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config.proto +271 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config_service.proto +147 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +9 -3
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +7 -4
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +4 -3
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +59 -8
- package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +52 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +51 -4
- package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +45 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +120 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +306 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +10 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +94 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/engine.proto +220 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/engine_service.proto +244 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +64 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +41 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +26 -3
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +169 -15
- package/build/protos/google/cloud/discoveryengine/v1beta/search_tuning_service.proto +151 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +265 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto +148 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine.proto +170 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine_service.proto +695 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -3
- package/build/protos/protos.d.ts +48530 -23682
- package/build/protos/protos.js +122429 -63306
- package/build/protos/protos.json +13438 -7286
- package/build/src/index.d.ts +10 -1
- package/build/src/index.js +10 -1
- package/build/src/v1/completion_service_client.d.ts +489 -7
- package/build/src/v1/completion_service_client.js +715 -11
- package/build/src/v1/completion_service_client_config.json +10 -0
- package/build/src/v1/conversational_search_service_client.d.ts +341 -3
- package/build/src/v1/conversational_search_service_client.js +466 -9
- package/build/src/v1/data_store_service_client.d.ts +1286 -0
- package/build/src/v1/data_store_service_client.js +1768 -0
- package/build/src/v1/data_store_service_client_config.json +46 -0
- package/build/src/v1/document_service_client.d.ts +347 -2
- package/build/src/v1/document_service_client.js +506 -9
- package/build/src/v1/engine_service_client.d.ts +1211 -0
- package/build/src/v1/engine_service_client.js +1731 -0
- package/build/src/v1/engine_service_client_config.json +46 -0
- package/build/src/v1/index.d.ts +3 -0
- package/build/src/v1/index.js +7 -1
- package/build/src/v1/schema_service_client.d.ts +272 -2
- package/build/src/v1/schema_service_client.js +402 -9
- package/build/src/v1/search_service_client.d.ts +515 -11
- package/build/src/v1/search_service_client.js +648 -15
- package/build/src/v1/site_search_engine_service_client.d.ts +1564 -0
- package/build/src/v1/site_search_engine_service_client.js +2075 -0
- package/build/src/v1/site_search_engine_service_client_config.json +74 -0
- package/build/src/v1/user_event_service_client.d.ts +272 -2
- package/build/src/v1/user_event_service_client.js +402 -9
- package/build/src/v1alpha/acl_config_service_client.d.ts +1233 -0
- package/build/src/v1alpha/acl_config_service_client.js +1765 -0
- package/build/src/v1alpha/acl_config_service_client_config.json +34 -0
- package/build/src/v1alpha/chunk_service_client.d.ts +1350 -0
- package/build/src/v1alpha/chunk_service_client.js +1886 -0
- package/build/src/v1alpha/chunk_service_client_config.json +34 -0
- package/build/src/v1alpha/completion_service_client.d.ts +599 -5
- package/build/src/v1alpha/completion_service_client.js +868 -12
- package/build/src/v1alpha/completion_service_client_config.json +10 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +244 -3
- package/build/src/v1alpha/conversational_search_service_client.js +353 -10
- package/build/src/v1alpha/data_store_service_client.d.ts +462 -5
- package/build/src/v1alpha/data_store_service_client.js +599 -12
- package/build/src/v1alpha/data_store_service_client_config.json +8 -0
- package/build/src/v1alpha/document_service_client.d.ts +393 -2
- package/build/src/v1alpha/document_service_client.js +551 -10
- package/build/src/v1alpha/engine_service_client.d.ts +386 -4
- package/build/src/v1alpha/engine_service_client.js +551 -10
- package/build/src/v1alpha/estimate_billing_service_client.d.ts +1367 -0
- package/build/src/v1alpha/estimate_billing_service_client.js +2028 -0
- package/build/src/v1alpha/estimate_billing_service_client_config.json +30 -0
- package/build/src/v1alpha/index.d.ts +4 -0
- package/build/src/v1alpha/index.js +10 -2
- package/build/src/v1alpha/recommendation_service_client.d.ts +242 -3
- package/build/src/v1alpha/recommendation_service_client.js +353 -10
- package/build/src/v1alpha/schema_service_client.d.ts +383 -2
- package/build/src/v1alpha/schema_service_client.js +551 -10
- package/build/src/v1alpha/search_service_client.d.ts +269 -17
- package/build/src/v1alpha/search_service_client.js +373 -20
- package/build/src/v1alpha/search_tuning_service_client.d.ts +384 -3
- package/build/src/v1alpha/search_tuning_service_client.js +551 -10
- package/build/src/v1alpha/serving_config_service_client.d.ts +1369 -0
- package/build/src/v1alpha/serving_config_service_client.js +1935 -0
- package/build/src/v1alpha/serving_config_service_client_config.json +38 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +383 -2
- package/build/src/v1alpha/site_search_engine_service_client.js +551 -10
- package/build/src/v1alpha/user_event_service_client.d.ts +383 -2
- package/build/src/v1alpha/user_event_service_client.js +551 -10
- package/build/src/v1beta/completion_service_client.d.ts +708 -7
- package/build/src/v1beta/completion_service_client.js +1015 -11
- package/build/src/v1beta/completion_service_client_config.json +10 -0
- package/build/src/v1beta/conversational_search_service_client.d.ts +420 -3
- package/build/src/v1beta/conversational_search_service_client.js +570 -9
- package/build/src/v1beta/data_store_service_client.d.ts +1508 -0
- package/build/src/v1beta/data_store_service_client.js +2070 -0
- package/build/src/v1beta/data_store_service_client_config.json +46 -0
- package/build/src/v1beta/document_service_client.d.ts +566 -2
- package/build/src/v1beta/document_service_client.js +810 -11
- package/build/src/v1beta/engine_service_client.d.ts +1432 -0
- package/build/src/v1beta/engine_service_client.js +2032 -0
- package/build/src/v1beta/engine_service_client_config.json +46 -0
- package/build/src/v1beta/index.d.ts +5 -0
- package/build/src/v1beta/index.js +11 -1
- package/build/src/v1beta/recommendation_service_client.d.ts +495 -5
- package/build/src/v1beta/recommendation_service_client.js +674 -9
- package/build/src/v1beta/schema_service_client.d.ts +491 -2
- package/build/src/v1beta/schema_service_client.js +706 -11
- package/build/src/v1beta/search_service_client.d.ts +620 -29
- package/build/src/v1beta/search_service_client.js +772 -27
- package/build/src/v1beta/search_tuning_service_client.d.ts +1196 -0
- package/build/src/v1beta/search_tuning_service_client.js +1781 -0
- package/build/src/v1beta/search_tuning_service_client_config.json +30 -0
- package/build/src/v1beta/serving_config_service_client.d.ts +1217 -0
- package/build/src/v1beta/serving_config_service_client.js +1724 -0
- package/build/src/v1beta/serving_config_service_client_config.json +38 -0
- package/build/src/v1beta/site_search_engine_service_client.d.ts +1787 -0
- package/build/src/v1beta/site_search_engine_service_client.js +2375 -0
- package/build/src/v1beta/site_search_engine_service_client_config.json +74 -0
- package/build/src/v1beta/user_event_service_client.d.ts +491 -2
- package/build/src/v1beta/user_event_service_client.js +706 -11
- package/package.json +3 -3
|
@@ -0,0 +1,147 @@
|
|
|
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/serving_config.proto";
|
|
24
|
+
import "google/protobuf/field_mask.proto";
|
|
25
|
+
|
|
26
|
+
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
|
|
27
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
|
|
28
|
+
option java_multiple_files = true;
|
|
29
|
+
option java_outer_classname = "ServingConfigServiceProto";
|
|
30
|
+
option java_package = "com.google.cloud.discoveryengine.v1alpha";
|
|
31
|
+
option objc_class_prefix = "DISCOVERYENGINE";
|
|
32
|
+
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
|
|
33
|
+
option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
|
|
34
|
+
|
|
35
|
+
// Service for operations related to [ServingConfig][].
|
|
36
|
+
service ServingConfigService {
|
|
37
|
+
option (google.api.default_host) = "discoveryengine.googleapis.com";
|
|
38
|
+
option (google.api.oauth_scopes) =
|
|
39
|
+
"https://www.googleapis.com/auth/cloud-platform";
|
|
40
|
+
|
|
41
|
+
// Updates a ServingConfig.
|
|
42
|
+
//
|
|
43
|
+
// Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
44
|
+
rpc UpdateServingConfig(UpdateServingConfigRequest) returns (ServingConfig) {
|
|
45
|
+
option (google.api.http) = {
|
|
46
|
+
patch: "/v1alpha/{serving_config.name=projects/*/locations/*/dataStores/*/servingConfigs/*}"
|
|
47
|
+
body: "serving_config"
|
|
48
|
+
additional_bindings {
|
|
49
|
+
patch: "/v1alpha/{serving_config.name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}"
|
|
50
|
+
body: "serving_config"
|
|
51
|
+
}
|
|
52
|
+
additional_bindings {
|
|
53
|
+
patch: "/v1alpha/{serving_config.name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}"
|
|
54
|
+
body: "serving_config"
|
|
55
|
+
}
|
|
56
|
+
};
|
|
57
|
+
option (google.api.method_signature) = "serving_config,update_mask";
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
// Gets a ServingConfig.
|
|
61
|
+
//
|
|
62
|
+
// Returns a NotFound error if the ServingConfig does not exist.
|
|
63
|
+
rpc GetServingConfig(GetServingConfigRequest) returns (ServingConfig) {
|
|
64
|
+
option (google.api.http) = {
|
|
65
|
+
get: "/v1alpha/{name=projects/*/locations/*/dataStores/*/servingConfigs/*}"
|
|
66
|
+
additional_bindings {
|
|
67
|
+
get: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}"
|
|
68
|
+
}
|
|
69
|
+
additional_bindings {
|
|
70
|
+
get: "/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}"
|
|
71
|
+
}
|
|
72
|
+
};
|
|
73
|
+
option (google.api.method_signature) = "name";
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
// Lists all ServingConfigs linked to this dataStore.
|
|
77
|
+
rpc ListServingConfigs(ListServingConfigsRequest)
|
|
78
|
+
returns (ListServingConfigsResponse) {
|
|
79
|
+
option (google.api.http) = {
|
|
80
|
+
get: "/v1alpha/{parent=projects/*/locations/*/dataStores/*}/servingConfigs"
|
|
81
|
+
additional_bindings {
|
|
82
|
+
get: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/servingConfigs"
|
|
83
|
+
}
|
|
84
|
+
additional_bindings {
|
|
85
|
+
get: "/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/servingConfigs"
|
|
86
|
+
}
|
|
87
|
+
};
|
|
88
|
+
option (google.api.method_signature) = "parent";
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
// Request for UpdateServingConfig method.
|
|
93
|
+
message UpdateServingConfigRequest {
|
|
94
|
+
// Required. The ServingConfig to update.
|
|
95
|
+
ServingConfig serving_config = 1 [(google.api.field_behavior) = REQUIRED];
|
|
96
|
+
|
|
97
|
+
// Indicates which fields in the provided
|
|
98
|
+
// [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] to
|
|
99
|
+
// update. The following are NOT supported:
|
|
100
|
+
//
|
|
101
|
+
// * [ServingConfig.name][google.cloud.discoveryengine.v1alpha.ServingConfig.name]
|
|
102
|
+
//
|
|
103
|
+
// If not set, all supported fields are updated.
|
|
104
|
+
google.protobuf.FieldMask update_mask = 2;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
// Request for GetServingConfig method.
|
|
108
|
+
message GetServingConfigRequest {
|
|
109
|
+
// Required. The resource name of the ServingConfig to get. Format:
|
|
110
|
+
// `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`
|
|
111
|
+
string name = 1 [
|
|
112
|
+
(google.api.field_behavior) = REQUIRED,
|
|
113
|
+
(google.api.resource_reference) = {
|
|
114
|
+
type: "discoveryengine.googleapis.com/ServingConfig"
|
|
115
|
+
}
|
|
116
|
+
];
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
// Request for ListServingConfigs method.
|
|
120
|
+
message ListServingConfigsRequest {
|
|
121
|
+
// Required. Full resource name of the parent resource. Format:
|
|
122
|
+
// `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
|
|
123
|
+
string parent = 1 [
|
|
124
|
+
(google.api.field_behavior) = REQUIRED,
|
|
125
|
+
(google.api.resource_reference) = {
|
|
126
|
+
child_type: "discoveryengine.googleapis.com/ServingConfig"
|
|
127
|
+
}
|
|
128
|
+
];
|
|
129
|
+
|
|
130
|
+
// Optional. Maximum number of results to return. If unspecified, defaults
|
|
131
|
+
// to 100. If a value greater than 100 is provided, at most 100 results are
|
|
132
|
+
// returned.
|
|
133
|
+
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
134
|
+
|
|
135
|
+
// Optional. A page token, received from a previous `ListServingConfigs` call.
|
|
136
|
+
// Provide this to retrieve the subsequent page.
|
|
137
|
+
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
// Response for ListServingConfigs method.
|
|
141
|
+
message ListServingConfigsResponse {
|
|
142
|
+
// All the ServingConfigs for a given dataStore.
|
|
143
|
+
repeated ServingConfig serving_configs = 1;
|
|
144
|
+
|
|
145
|
+
// Pagination token, if not returned indicates the last page.
|
|
146
|
+
string next_page_token = 2;
|
|
147
|
+
}
|
|
@@ -53,8 +53,14 @@ message TargetSite {
|
|
|
53
53
|
|
|
54
54
|
// Site search indexing failure reasons.
|
|
55
55
|
message FailureReason {
|
|
56
|
-
|
|
56
|
+
// Failed due to insufficient quota.
|
|
57
|
+
message QuotaFailure {
|
|
58
|
+
// This number is an estimation on how much total quota this project needs
|
|
59
|
+
// to successfully complete indexing.
|
|
60
|
+
int64 total_required_quota = 1;
|
|
61
|
+
}
|
|
57
62
|
|
|
63
|
+
// Failure reason.
|
|
58
64
|
oneof failure {
|
|
59
65
|
// Failed due to insufficient quota.
|
|
60
66
|
QuotaFailure quota_failure = 1;
|
|
@@ -108,7 +114,7 @@ message TargetSite {
|
|
|
108
114
|
(google.api.field_behavior) = INPUT_ONLY
|
|
109
115
|
];
|
|
110
116
|
|
|
111
|
-
// The type of the target site, e.g
|
|
117
|
+
// The type of the target site, e.g., whether the site is to be included or
|
|
112
118
|
// excluded.
|
|
113
119
|
Type type = 3;
|
|
114
120
|
|
|
@@ -152,7 +158,7 @@ message SiteVerificationInfo {
|
|
|
152
158
|
// Site ownership pending verification or verification failed.
|
|
153
159
|
UNVERIFIED = 2;
|
|
154
160
|
|
|
155
|
-
// Site exempt from verification, e.g
|
|
161
|
+
// Site exempt from verification, e.g., a public website that opens to all.
|
|
156
162
|
EXEMPTED = 3;
|
|
157
163
|
}
|
|
158
164
|
|
|
@@ -275,7 +275,9 @@ message CreateTargetSiteMetadata {
|
|
|
275
275
|
google.protobuf.Timestamp update_time = 2;
|
|
276
276
|
}
|
|
277
277
|
|
|
278
|
-
// Request message for
|
|
278
|
+
// Request message for
|
|
279
|
+
// [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites]
|
|
280
|
+
// method.
|
|
279
281
|
message BatchCreateTargetSitesRequest {
|
|
280
282
|
// Required. The parent resource shared by all TargetSites being created.
|
|
281
283
|
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
|
|
@@ -430,8 +432,9 @@ message ListTargetSitesResponse {
|
|
|
430
432
|
}
|
|
431
433
|
|
|
432
434
|
// Metadata related to the progress of the
|
|
433
|
-
// [SiteSearchEngineService.
|
|
434
|
-
// returned by the google.longrunning.Operation.metadata
|
|
435
|
+
// [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites]
|
|
436
|
+
// operation. This will be returned by the google.longrunning.Operation.metadata
|
|
437
|
+
// field.
|
|
435
438
|
message BatchCreateTargetSiteMetadata {
|
|
436
439
|
// Operation create time.
|
|
437
440
|
google.protobuf.Timestamp create_time = 1;
|
|
@@ -546,7 +549,7 @@ message RecrawlUrisResponse {
|
|
|
546
549
|
// Details about why a particular URI failed to be crawled. Each FailureInfo
|
|
547
550
|
// contains one FailureReason per CorpusType.
|
|
548
551
|
message FailureInfo {
|
|
549
|
-
// Details about why crawling failed for a particular CorpusType, e.g
|
|
552
|
+
// Details about why crawling failed for a particular CorpusType, e.g.,
|
|
550
553
|
// DESKTOP and MOBILE crawling may fail for different reasons.
|
|
551
554
|
message FailureReason {
|
|
552
555
|
// CorpusType for the failed crawling operation.
|
|
@@ -146,9 +146,10 @@ message UserEvent {
|
|
|
146
146
|
// conforming to https://google.aip.dev/160#filtering.
|
|
147
147
|
//
|
|
148
148
|
// Similarly, for `view-item-list` events that are generated from a
|
|
149
|
-
// [
|
|
150
|
-
// directly from
|
|
151
|
-
//
|
|
149
|
+
// [RecommendRequest][google.cloud.discoveryengine.v1alpha.RecommendRequest],
|
|
150
|
+
// this field may be populated directly from
|
|
151
|
+
// [RecommendRequest.filter][google.cloud.discoveryengine.v1alpha.RecommendRequest.filter]
|
|
152
|
+
// conforming to https://google.aip.dev/160#filtering.
|
|
152
153
|
//
|
|
153
154
|
// The value must be a UTF-8 encoded string with a length limit of 1,000
|
|
154
155
|
// 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/
|
|
36
|
-
pattern: "projects/{project}/locations/{location}/
|
|
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
|
-
//
|
|
69
|
-
//
|
|
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.
|
package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto
CHANGED
|
@@ -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,29 @@ 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;
|
|
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;
|
|
187
231
|
}
|
|
188
232
|
|
|
189
233
|
// Response message for
|
|
@@ -227,7 +271,7 @@ message UpdateConversationRequest {
|
|
|
227
271
|
// [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to update.
|
|
228
272
|
// The following are NOT supported:
|
|
229
273
|
//
|
|
230
|
-
// * [
|
|
274
|
+
// * [Conversation.name][google.cloud.discoveryengine.v1beta.Conversation.name]
|
|
231
275
|
//
|
|
232
276
|
// If not set or empty, all supported fields are updated.
|
|
233
277
|
google.protobuf.FieldMask update_mask = 2;
|