@google-cloud/discoveryengine 2.2.0 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -0
- package/build/protos/google/cloud/discoveryengine/v1/answer.proto +17 -0
- package/build/protos/google/cloud/discoveryengine/v1/assist_answer.proto +251 -0
- package/build/protos/google/cloud/discoveryengine/v1/assistant.proto +44 -0
- package/build/protos/google/cloud/discoveryengine/v1/assistant_service.proto +217 -0
- package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +52 -0
- package/build/protos/google/cloud/discoveryengine/v1/cmek_config_service.proto +300 -0
- package/build/protos/google/cloud/discoveryengine/v1/common.proto +67 -0
- package/build/protos/google/cloud/discoveryengine/v1/control.proto +1 -3
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +18 -3
- package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +54 -2
- package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +14 -0
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +95 -4
- package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +28 -1
- package/build/protos/google/cloud/discoveryengine/v1/engine.proto +131 -6
- package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +8 -0
- package/build/protos/google/cloud/discoveryengine/v1/grounding.proto +9 -0
- package/build/protos/google/cloud/discoveryengine/v1/identity_mapping_store.proto +84 -0
- package/build/protos/google/cloud/discoveryengine/v1/identity_mapping_store_service.proto +375 -0
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +14 -14
- package/build/protos/google/cloud/discoveryengine/v1/session.proto +21 -8
- package/build/protos/google/cloud/discoveryengine/v1/session_service.proto +128 -0
- package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +6 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_license.proto +98 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_license_service.proto +191 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +15 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +30 -9
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +8 -14
- package/build/protos/google/cloud/discoveryengine/v1alpha/session.proto +238 -8
- package/build/protos/google/cloud/discoveryengine/v1alpha/session_service.proto +201 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +26 -5
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +8 -14
- package/build/protos/google/cloud/discoveryengine/v1beta/session.proto +40 -8
- package/build/protos/google/cloud/discoveryengine/v1beta/session_service.proto +128 -0
- package/build/protos/protos.d.ts +21218 -11675
- package/build/protos/protos.js +92642 -66407
- package/build/protos/protos.json +5854 -2801
- package/build/src/index.d.ts +16 -1
- package/build/src/index.js +12 -2
- package/build/src/v1/assistant_service_client.d.ts +2058 -0
- package/build/src/v1/assistant_service_client.js +2957 -0
- package/build/src/v1/assistant_service_client_config.json +43 -0
- package/build/src/v1/assistant_service_proto_list.json +48 -0
- package/build/src/v1/cmek_config_service_client.d.ts +2398 -0
- package/build/src/v1/cmek_config_service_client.js +3426 -0
- package/build/src/v1/cmek_config_service_client_config.json +42 -0
- package/build/src/v1/cmek_config_service_proto_list.json +48 -0
- package/build/src/v1/completion_service_client.d.ts +345 -144
- package/build/src/v1/completion_service_client.js +482 -198
- package/build/src/v1/completion_service_proto_list.json +10 -1
- package/build/src/v1/control_service_client.d.ts +345 -144
- package/build/src/v1/control_service_client.js +498 -196
- package/build/src/v1/control_service_proto_list.json +10 -1
- package/build/src/v1/conversational_search_service_client.d.ts +392 -155
- package/build/src/v1/conversational_search_service_client.js +572 -204
- package/build/src/v1/conversational_search_service_proto_list.json +10 -1
- package/build/src/v1/data_store_service_client.d.ts +351 -144
- package/build/src/v1/data_store_service_client.js +488 -198
- package/build/src/v1/data_store_service_proto_list.json +10 -1
- package/build/src/v1/document_service_client.d.ts +345 -144
- package/build/src/v1/document_service_client.js +506 -198
- package/build/src/v1/document_service_proto_list.json +10 -1
- package/build/src/v1/engine_service_client.d.ts +345 -144
- package/build/src/v1/engine_service_client.js +488 -198
- package/build/src/v1/engine_service_proto_list.json +10 -1
- package/build/src/v1/gapic_metadata.json +270 -0
- package/build/src/v1/grounded_generation_service_client.d.ts +345 -144
- package/build/src/v1/grounded_generation_service_client.js +486 -196
- package/build/src/v1/grounded_generation_service_proto_list.json +10 -1
- package/build/src/v1/identity_mapping_store_service_client.d.ts +2581 -0
- package/build/src/v1/identity_mapping_store_service_client.js +3601 -0
- package/build/src/v1/identity_mapping_store_service_client_config.json +54 -0
- package/build/src/v1/identity_mapping_store_service_proto_list.json +48 -0
- package/build/src/v1/index.d.ts +5 -0
- package/build/src/v1/index.js +11 -1
- package/build/src/v1/project_service_client.d.ts +345 -144
- package/build/src/v1/project_service_client.js +476 -198
- package/build/src/v1/project_service_proto_list.json +10 -1
- package/build/src/v1/rank_service_client.d.ts +345 -144
- package/build/src/v1/rank_service_client.js +480 -196
- package/build/src/v1/rank_service_proto_list.json +10 -1
- package/build/src/v1/recommendation_service_client.d.ts +345 -144
- package/build/src/v1/recommendation_service_client.js +480 -196
- package/build/src/v1/recommendation_service_proto_list.json +10 -1
- package/build/src/v1/schema_service_client.d.ts +345 -144
- package/build/src/v1/schema_service_client.js +482 -198
- package/build/src/v1/schema_service_proto_list.json +10 -1
- package/build/src/v1/search_service_client.d.ts +393 -228
- package/build/src/v1/search_service_client.js +506 -252
- package/build/src/v1/search_service_proto_list.json +10 -1
- package/build/src/v1/search_tuning_service_client.d.ts +345 -144
- package/build/src/v1/search_tuning_service_client.js +482 -198
- package/build/src/v1/search_tuning_service_proto_list.json +10 -1
- package/build/src/v1/serving_config_service_client.d.ts +345 -144
- package/build/src/v1/serving_config_service_client.js +480 -196
- package/build/src/v1/serving_config_service_proto_list.json +10 -1
- package/build/src/v1/session_service_client.d.ts +2326 -0
- package/build/src/v1/session_service_client.js +3218 -0
- package/build/src/v1/session_service_client_config.json +63 -0
- package/build/src/v1/session_service_proto_list.json +48 -0
- package/build/src/v1/site_search_engine_service_client.d.ts +345 -144
- package/build/src/v1/site_search_engine_service_client.js +494 -198
- package/build/src/v1/site_search_engine_service_proto_list.json +10 -1
- package/build/src/v1/user_event_service_client.d.ts +345 -144
- package/build/src/v1/user_event_service_client.js +488 -198
- package/build/src/v1/user_event_service_proto_list.json +10 -1
- package/build/src/v1/user_license_service_client.d.ts +2367 -0
- package/build/src/v1/user_license_service_client.js +3346 -0
- package/build/src/v1/user_license_service_client_config.json +34 -0
- package/build/src/v1/user_license_service_proto_list.json +48 -0
- package/build/src/v1alpha/acl_config_service_client.d.ts +144 -144
- package/build/src/v1alpha/acl_config_service_client.js +208 -196
- package/build/src/v1alpha/acl_config_service_proto_list.json +1 -0
- package/build/src/v1alpha/chunk_service_client.d.ts +144 -144
- package/build/src/v1alpha/chunk_service_client.js +202 -196
- package/build/src/v1alpha/chunk_service_proto_list.json +1 -0
- package/build/src/v1alpha/completion_service_client.d.ts +144 -144
- package/build/src/v1alpha/completion_service_client.js +203 -197
- package/build/src/v1alpha/completion_service_proto_list.json +1 -0
- package/build/src/v1alpha/control_service_client.d.ts +144 -144
- package/build/src/v1alpha/control_service_client.js +220 -196
- package/build/src/v1alpha/control_service_proto_list.json +1 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +221 -167
- package/build/src/v1alpha/conversational_search_service_client.js +310 -210
- package/build/src/v1alpha/conversational_search_service_proto_list.json +1 -0
- package/build/src/v1alpha/data_store_service_client.d.ts +144 -144
- package/build/src/v1alpha/data_store_service_client.js +221 -197
- package/build/src/v1alpha/data_store_service_proto_list.json +1 -0
- package/build/src/v1alpha/document_service_client.d.ts +144 -144
- package/build/src/v1alpha/document_service_client.js +233 -197
- package/build/src/v1alpha/document_service_proto_list.json +1 -0
- package/build/src/v1alpha/engine_service_client.d.ts +144 -144
- package/build/src/v1alpha/engine_service_client.js +221 -197
- package/build/src/v1alpha/engine_service_proto_list.json +1 -0
- package/build/src/v1alpha/estimate_billing_service_client.d.ts +144 -144
- package/build/src/v1alpha/estimate_billing_service_client.js +197 -197
- package/build/src/v1alpha/estimate_billing_service_proto_list.json +1 -0
- package/build/src/v1alpha/evaluation_service_client.d.ts +144 -144
- package/build/src/v1alpha/evaluation_service_client.js +203 -197
- package/build/src/v1alpha/evaluation_service_proto_list.json +1 -0
- package/build/src/v1alpha/gapic_metadata.json +82 -0
- package/build/src/v1alpha/grounded_generation_service_client.d.ts +144 -144
- package/build/src/v1alpha/grounded_generation_service_client.js +202 -196
- package/build/src/v1alpha/grounded_generation_service_proto_list.json +1 -0
- package/build/src/v1alpha/index.d.ts +1 -0
- package/build/src/v1alpha/index.js +3 -1
- package/build/src/v1alpha/project_service_client.d.ts +144 -144
- package/build/src/v1alpha/project_service_client.js +209 -197
- package/build/src/v1alpha/project_service_proto_list.json +1 -0
- package/build/src/v1alpha/rank_service_client.d.ts +144 -144
- package/build/src/v1alpha/rank_service_client.js +202 -196
- package/build/src/v1alpha/rank_service_proto_list.json +1 -0
- package/build/src/v1alpha/recommendation_service_client.d.ts +144 -144
- package/build/src/v1alpha/recommendation_service_client.js +202 -196
- package/build/src/v1alpha/recommendation_service_proto_list.json +1 -0
- package/build/src/v1alpha/sample_query_service_client.d.ts +144 -144
- package/build/src/v1alpha/sample_query_service_client.js +221 -197
- package/build/src/v1alpha/sample_query_service_proto_list.json +1 -0
- package/build/src/v1alpha/sample_query_set_service_client.d.ts +144 -144
- package/build/src/v1alpha/sample_query_set_service_client.js +220 -196
- package/build/src/v1alpha/sample_query_set_service_proto_list.json +1 -0
- package/build/src/v1alpha/schema_service_client.d.ts +144 -144
- package/build/src/v1alpha/schema_service_client.js +203 -197
- package/build/src/v1alpha/schema_service_proto_list.json +1 -0
- package/build/src/v1alpha/search_service_client.d.ts +168 -186
- package/build/src/v1alpha/search_service_client.js +212 -224
- package/build/src/v1alpha/search_service_proto_list.json +1 -0
- package/build/src/v1alpha/search_tuning_service_client.d.ts +144 -144
- package/build/src/v1alpha/search_tuning_service_client.js +203 -197
- package/build/src/v1alpha/search_tuning_service_proto_list.json +1 -0
- package/build/src/v1alpha/serving_config_service_client.d.ts +144 -144
- package/build/src/v1alpha/serving_config_service_client.js +208 -196
- package/build/src/v1alpha/serving_config_service_proto_list.json +1 -0
- package/build/src/v1alpha/session_service_client.d.ts +2331 -0
- package/build/src/v1alpha/session_service_client.js +3161 -0
- package/build/src/v1alpha/session_service_client_config.json +68 -0
- package/build/src/v1alpha/session_service_proto_list.json +49 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +144 -144
- package/build/src/v1alpha/site_search_engine_service_client.js +215 -197
- package/build/src/v1alpha/site_search_engine_service_proto_list.json +1 -0
- package/build/src/v1alpha/user_event_service_client.d.ts +144 -144
- package/build/src/v1alpha/user_event_service_client.js +209 -197
- package/build/src/v1alpha/user_event_service_proto_list.json +1 -0
- package/build/src/v1beta/completion_service_client.d.ts +144 -144
- package/build/src/v1beta/completion_service_client.js +209 -197
- package/build/src/v1beta/completion_service_proto_list.json +1 -0
- package/build/src/v1beta/control_service_client.d.ts +144 -144
- package/build/src/v1beta/control_service_client.js +220 -196
- package/build/src/v1beta/control_service_proto_list.json +1 -0
- package/build/src/v1beta/conversational_search_service_client.d.ts +215 -161
- package/build/src/v1beta/conversational_search_service_client.js +308 -208
- package/build/src/v1beta/conversational_search_service_proto_list.json +1 -0
- package/build/src/v1beta/data_store_service_client.d.ts +144 -144
- package/build/src/v1beta/data_store_service_client.js +209 -197
- package/build/src/v1beta/data_store_service_proto_list.json +1 -0
- package/build/src/v1beta/document_service_client.d.ts +144 -144
- package/build/src/v1beta/document_service_client.js +227 -197
- package/build/src/v1beta/document_service_proto_list.json +1 -0
- package/build/src/v1beta/engine_service_client.d.ts +144 -144
- package/build/src/v1beta/engine_service_client.js +221 -197
- package/build/src/v1beta/engine_service_proto_list.json +1 -0
- package/build/src/v1beta/evaluation_service_client.d.ts +144 -144
- package/build/src/v1beta/evaluation_service_client.js +203 -197
- package/build/src/v1beta/evaluation_service_proto_list.json +1 -0
- package/build/src/v1beta/gapic_metadata.json +68 -0
- package/build/src/v1beta/grounded_generation_service_client.d.ts +144 -144
- package/build/src/v1beta/grounded_generation_service_client.js +208 -196
- package/build/src/v1beta/grounded_generation_service_proto_list.json +1 -0
- package/build/src/v1beta/index.d.ts +1 -0
- package/build/src/v1beta/index.js +3 -1
- package/build/src/v1beta/project_service_client.d.ts +144 -144
- package/build/src/v1beta/project_service_client.js +197 -197
- package/build/src/v1beta/project_service_proto_list.json +1 -0
- package/build/src/v1beta/rank_service_client.d.ts +144 -144
- package/build/src/v1beta/rank_service_client.js +202 -196
- package/build/src/v1beta/rank_service_proto_list.json +1 -0
- package/build/src/v1beta/recommendation_service_client.d.ts +144 -144
- package/build/src/v1beta/recommendation_service_client.js +202 -196
- package/build/src/v1beta/recommendation_service_proto_list.json +1 -0
- package/build/src/v1beta/sample_query_service_client.d.ts +144 -144
- package/build/src/v1beta/sample_query_service_client.js +221 -197
- package/build/src/v1beta/sample_query_service_proto_list.json +1 -0
- package/build/src/v1beta/sample_query_set_service_client.d.ts +144 -144
- package/build/src/v1beta/sample_query_set_service_client.js +220 -196
- package/build/src/v1beta/sample_query_set_service_proto_list.json +1 -0
- package/build/src/v1beta/schema_service_client.d.ts +144 -144
- package/build/src/v1beta/schema_service_client.js +203 -197
- package/build/src/v1beta/schema_service_proto_list.json +1 -0
- package/build/src/v1beta/search_service_client.d.ts +192 -228
- package/build/src/v1beta/search_service_client.js +228 -252
- package/build/src/v1beta/search_service_proto_list.json +1 -0
- package/build/src/v1beta/search_tuning_service_client.d.ts +144 -144
- package/build/src/v1beta/search_tuning_service_client.js +203 -197
- package/build/src/v1beta/search_tuning_service_proto_list.json +1 -0
- package/build/src/v1beta/serving_config_service_client.d.ts +144 -144
- package/build/src/v1beta/serving_config_service_client.js +208 -196
- package/build/src/v1beta/serving_config_service_proto_list.json +1 -0
- package/build/src/v1beta/session_service_client.d.ts +2266 -0
- package/build/src/v1beta/session_service_client.js +3136 -0
- package/build/src/v1beta/session_service_client_config.json +63 -0
- package/build/src/v1beta/session_service_proto_list.json +45 -0
- package/build/src/v1beta/site_search_engine_service_client.d.ts +144 -144
- package/build/src/v1beta/site_search_engine_service_client.js +215 -197
- package/build/src/v1beta/site_search_engine_service_proto_list.json +1 -0
- package/build/src/v1beta/user_event_service_client.d.ts +144 -144
- package/build/src/v1beta/user_event_service_client.js +209 -197
- package/build/src/v1beta/user_event_service_proto_list.json +1 -0
- package/package.json +7 -7
- package/CHANGELOG.md +0 -274
@@ -0,0 +1,375 @@
|
|
1
|
+
// Copyright 2025 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.v1;
|
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/v1/identity_mapping_store.proto";
|
24
|
+
import "google/longrunning/operations.proto";
|
25
|
+
import "google/protobuf/empty.proto";
|
26
|
+
import "google/protobuf/timestamp.proto";
|
27
|
+
import "google/rpc/status.proto";
|
28
|
+
|
29
|
+
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
|
30
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
|
31
|
+
option java_multiple_files = true;
|
32
|
+
option java_outer_classname = "IdentityMappingStoreServiceProto";
|
33
|
+
option java_package = "com.google.cloud.discoveryengine.v1";
|
34
|
+
option objc_class_prefix = "DISCOVERYENGINE";
|
35
|
+
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
|
36
|
+
option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
|
37
|
+
|
38
|
+
// Service for managing Identity Mapping Stores.
|
39
|
+
service IdentityMappingStoreService {
|
40
|
+
option (google.api.default_host) = "discoveryengine.googleapis.com";
|
41
|
+
option (google.api.oauth_scopes) =
|
42
|
+
"https://www.googleapis.com/auth/cloud-platform";
|
43
|
+
|
44
|
+
// Creates a new Identity Mapping Store.
|
45
|
+
rpc CreateIdentityMappingStore(CreateIdentityMappingStoreRequest)
|
46
|
+
returns (IdentityMappingStore) {
|
47
|
+
option (google.api.http) = {
|
48
|
+
post: "/v1/{parent=projects/*/locations/*}/identityMappingStores"
|
49
|
+
body: "identity_mapping_store"
|
50
|
+
};
|
51
|
+
option (google.api.method_signature) =
|
52
|
+
"parent,identity_mapping_store,identity_mapping_store_id";
|
53
|
+
}
|
54
|
+
|
55
|
+
// Gets the Identity Mapping Store.
|
56
|
+
rpc GetIdentityMappingStore(GetIdentityMappingStoreRequest)
|
57
|
+
returns (IdentityMappingStore) {
|
58
|
+
option (google.api.http) = {
|
59
|
+
get: "/v1/{name=projects/*/locations/*/identityMappingStores/*}"
|
60
|
+
};
|
61
|
+
option (google.api.method_signature) = "name";
|
62
|
+
}
|
63
|
+
|
64
|
+
// Deletes the Identity Mapping Store.
|
65
|
+
rpc DeleteIdentityMappingStore(DeleteIdentityMappingStoreRequest)
|
66
|
+
returns (google.longrunning.Operation) {
|
67
|
+
option (google.api.http) = {
|
68
|
+
delete: "/v1/{name=projects/*/locations/*/identityMappingStores/*}"
|
69
|
+
};
|
70
|
+
option (google.api.method_signature) = "name";
|
71
|
+
option (google.longrunning.operation_info) = {
|
72
|
+
response_type: "google.protobuf.Empty"
|
73
|
+
metadata_type: "google.cloud.discoveryengine.v1.DeleteIdentityMappingStoreMetadata"
|
74
|
+
};
|
75
|
+
}
|
76
|
+
|
77
|
+
// Imports a list of Identity Mapping Entries to an Identity Mapping Store.
|
78
|
+
rpc ImportIdentityMappings(ImportIdentityMappingsRequest)
|
79
|
+
returns (google.longrunning.Operation) {
|
80
|
+
option (google.api.http) = {
|
81
|
+
post: "/v1/{identity_mapping_store=projects/*/locations/*/identityMappingStores/*}:importIdentityMappings"
|
82
|
+
body: "*"
|
83
|
+
};
|
84
|
+
option (google.longrunning.operation_info) = {
|
85
|
+
response_type: "google.cloud.discoveryengine.v1.ImportIdentityMappingsResponse"
|
86
|
+
metadata_type: "google.cloud.discoveryengine.v1.IdentityMappingEntryOperationMetadata"
|
87
|
+
};
|
88
|
+
}
|
89
|
+
|
90
|
+
// Purges specified or all Identity Mapping Entries from an Identity Mapping
|
91
|
+
// Store.
|
92
|
+
rpc PurgeIdentityMappings(PurgeIdentityMappingsRequest)
|
93
|
+
returns (google.longrunning.Operation) {
|
94
|
+
option (google.api.http) = {
|
95
|
+
post: "/v1/{identity_mapping_store=projects/*/locations/*/identityMappingStores/*}:purgeIdentityMappings"
|
96
|
+
body: "*"
|
97
|
+
};
|
98
|
+
option (google.longrunning.operation_info) = {
|
99
|
+
response_type: "google.protobuf.Empty"
|
100
|
+
metadata_type: "google.cloud.discoveryengine.v1.IdentityMappingEntryOperationMetadata"
|
101
|
+
};
|
102
|
+
}
|
103
|
+
|
104
|
+
// Lists Identity Mappings in an Identity Mapping Store.
|
105
|
+
rpc ListIdentityMappings(ListIdentityMappingsRequest)
|
106
|
+
returns (ListIdentityMappingsResponse) {
|
107
|
+
option (google.api.http) = {
|
108
|
+
get: "/v1/{identity_mapping_store=projects/*/locations/*/identityMappingStores/*}:listIdentityMappings"
|
109
|
+
};
|
110
|
+
}
|
111
|
+
|
112
|
+
// Lists all Identity Mapping Stores.
|
113
|
+
rpc ListIdentityMappingStores(ListIdentityMappingStoresRequest)
|
114
|
+
returns (ListIdentityMappingStoresResponse) {
|
115
|
+
option (google.api.http) = {
|
116
|
+
get: "/v1/{parent=projects/*/locations/*}/identityMappingStores"
|
117
|
+
};
|
118
|
+
option (google.api.method_signature) = "parent";
|
119
|
+
}
|
120
|
+
}
|
121
|
+
|
122
|
+
// Request message for
|
123
|
+
// [IdentityMappingStoreService.CreateIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.CreateIdentityMappingStore]
|
124
|
+
message CreateIdentityMappingStoreRequest {
|
125
|
+
// CMEK options for the Identity Mapping Store. Setting this field will
|
126
|
+
// override the default CmekConfig if one is set for the project.
|
127
|
+
oneof cmek_options {
|
128
|
+
// Resource name of the CmekConfig to use for protecting this Identity
|
129
|
+
// Mapping Store.
|
130
|
+
string cmek_config_name = 5 [(google.api.resource_reference) = {
|
131
|
+
type: "discoveryengine.googleapis.com/CmekConfig"
|
132
|
+
}];
|
133
|
+
|
134
|
+
// Identity Mapping Store without CMEK protections. If a default CmekConfig
|
135
|
+
// is set for the project, setting this field will override the default
|
136
|
+
// CmekConfig as well.
|
137
|
+
bool disable_cmek = 6;
|
138
|
+
}
|
139
|
+
|
140
|
+
// Required. The parent collection resource name, such as
|
141
|
+
// `projects/{project}/locations/{location}`.
|
142
|
+
string parent = 1 [
|
143
|
+
(google.api.field_behavior) = REQUIRED,
|
144
|
+
(google.api.resource_reference) = {
|
145
|
+
type: "discoveryengine.googleapis.com/Location"
|
146
|
+
}
|
147
|
+
];
|
148
|
+
|
149
|
+
// Required. The ID of the Identity Mapping Store to create.
|
150
|
+
//
|
151
|
+
// The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
|
152
|
+
// (_), and hyphens (-). The maximum length is 63 characters.
|
153
|
+
string identity_mapping_store_id = 2 [(google.api.field_behavior) = REQUIRED];
|
154
|
+
|
155
|
+
// Required. The Identity Mapping Store to create.
|
156
|
+
IdentityMappingStore identity_mapping_store = 3
|
157
|
+
[(google.api.field_behavior) = REQUIRED];
|
158
|
+
}
|
159
|
+
|
160
|
+
// Request message for
|
161
|
+
// [IdentityMappingStoreService.GetIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.GetIdentityMappingStore]
|
162
|
+
message GetIdentityMappingStoreRequest {
|
163
|
+
// Required. The name of the Identity Mapping Store to get.
|
164
|
+
// Format:
|
165
|
+
// `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
|
166
|
+
string name = 1 [
|
167
|
+
(google.api.field_behavior) = REQUIRED,
|
168
|
+
(google.api.resource_reference) = {
|
169
|
+
type: "discoveryengine.googleapis.com/IdentityMappingStore"
|
170
|
+
}
|
171
|
+
];
|
172
|
+
}
|
173
|
+
|
174
|
+
// Request message for
|
175
|
+
// [IdentityMappingStoreService.DeleteIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.DeleteIdentityMappingStore]
|
176
|
+
message DeleteIdentityMappingStoreRequest {
|
177
|
+
// Required. The name of the Identity Mapping Store to delete.
|
178
|
+
// Format:
|
179
|
+
// `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
|
180
|
+
string name = 1 [
|
181
|
+
(google.api.field_behavior) = REQUIRED,
|
182
|
+
(google.api.resource_reference) = {
|
183
|
+
type: "discoveryengine.googleapis.com/IdentityMappingStore"
|
184
|
+
}
|
185
|
+
];
|
186
|
+
}
|
187
|
+
|
188
|
+
// Request message for
|
189
|
+
// [IdentityMappingStoreService.ImportIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ImportIdentityMappings]
|
190
|
+
message ImportIdentityMappingsRequest {
|
191
|
+
// The inline source to import identity mapping entries from.
|
192
|
+
message InlineSource {
|
193
|
+
// A maximum of 10000 entries can be imported at one time
|
194
|
+
repeated IdentityMappingEntry identity_mapping_entries = 1;
|
195
|
+
}
|
196
|
+
|
197
|
+
// The source of the input.
|
198
|
+
oneof source {
|
199
|
+
// The inline source to import identity mapping entries from.
|
200
|
+
InlineSource inline_source = 2;
|
201
|
+
}
|
202
|
+
|
203
|
+
// Required. The name of the Identity Mapping Store to import Identity Mapping
|
204
|
+
// Entries to. Format:
|
205
|
+
// `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
|
206
|
+
string identity_mapping_store = 1 [
|
207
|
+
(google.api.field_behavior) = REQUIRED,
|
208
|
+
(google.api.resource_reference) = {
|
209
|
+
type: "discoveryengine.googleapis.com/IdentityMappingStore"
|
210
|
+
}
|
211
|
+
];
|
212
|
+
}
|
213
|
+
|
214
|
+
// Response message for
|
215
|
+
// [IdentityMappingStoreService.ImportIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ImportIdentityMappings]
|
216
|
+
message ImportIdentityMappingsResponse {
|
217
|
+
// A sample of errors encountered while processing the request.
|
218
|
+
repeated google.rpc.Status error_samples = 1;
|
219
|
+
}
|
220
|
+
|
221
|
+
// Request message for
|
222
|
+
// [IdentityMappingStoreService.PurgeIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.PurgeIdentityMappings]
|
223
|
+
message PurgeIdentityMappingsRequest {
|
224
|
+
// The inline source to purge identity mapping entries from.
|
225
|
+
message InlineSource {
|
226
|
+
// A maximum of 10000 entries can be purged at one time
|
227
|
+
repeated IdentityMappingEntry identity_mapping_entries = 1;
|
228
|
+
}
|
229
|
+
|
230
|
+
// The source of the input.
|
231
|
+
oneof source {
|
232
|
+
// The inline source to purge identity mapping entries from.
|
233
|
+
InlineSource inline_source = 2;
|
234
|
+
}
|
235
|
+
|
236
|
+
// Required. The name of the Identity Mapping Store to purge Identity Mapping
|
237
|
+
// Entries from. Format:
|
238
|
+
// `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
|
239
|
+
string identity_mapping_store = 1 [
|
240
|
+
(google.api.field_behavior) = REQUIRED,
|
241
|
+
(google.api.resource_reference) = {
|
242
|
+
type: "discoveryengine.googleapis.com/IdentityMappingStore"
|
243
|
+
}
|
244
|
+
];
|
245
|
+
|
246
|
+
// Filter matching identity mappings to purge.
|
247
|
+
// The eligible field for filtering is:
|
248
|
+
// * `update_time`: in ISO 8601 "zulu" format.
|
249
|
+
// * `external_id`
|
250
|
+
//
|
251
|
+
// Examples:
|
252
|
+
//
|
253
|
+
// * Deleting all identity mappings updated in a time range:
|
254
|
+
// `update_time > "2012-04-23T18:25:43.511Z" AND update_time <
|
255
|
+
// "2012-04-23T18:30:43.511Z"`
|
256
|
+
// * Deleting all identity mappings for a given external_id:
|
257
|
+
// `external_id = "id1"`
|
258
|
+
// * Deleting all identity mappings inside an identity mapping store:
|
259
|
+
// `*`
|
260
|
+
//
|
261
|
+
// The filtering fields are assumed to have an implicit AND.
|
262
|
+
// Should not be used with source. An error will be thrown, if both are
|
263
|
+
// provided.
|
264
|
+
string filter = 3;
|
265
|
+
|
266
|
+
// Actually performs the purge. If `force` is set to false, return the
|
267
|
+
// expected purge count without deleting any identity mappings. This field is
|
268
|
+
// only supported for purge with filter. For input source this field is
|
269
|
+
// ignored and data will be purged regardless of the value of this field.
|
270
|
+
optional bool force = 4;
|
271
|
+
}
|
272
|
+
|
273
|
+
// Request message for
|
274
|
+
// [IdentityMappingStoreService.ListIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappings]
|
275
|
+
message ListIdentityMappingsRequest {
|
276
|
+
// Required. The name of the Identity Mapping Store to list Identity Mapping
|
277
|
+
// Entries in. Format:
|
278
|
+
// `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
|
279
|
+
string identity_mapping_store = 1 [
|
280
|
+
(google.api.field_behavior) = REQUIRED,
|
281
|
+
(google.api.resource_reference) = {
|
282
|
+
type: "discoveryengine.googleapis.com/IdentityMappingStore"
|
283
|
+
}
|
284
|
+
];
|
285
|
+
|
286
|
+
// Maximum number of IdentityMappings to return. If unspecified, defaults
|
287
|
+
// to 2000. The maximum allowed value is 10000. Values above 10000 will be
|
288
|
+
// coerced to 10000.
|
289
|
+
int32 page_size = 2;
|
290
|
+
|
291
|
+
// A page token, received from a previous `ListIdentityMappings` call.
|
292
|
+
// Provide this to retrieve the subsequent page.
|
293
|
+
//
|
294
|
+
// When paginating, all other parameters provided to
|
295
|
+
// `ListIdentityMappings` must match the call that provided the page
|
296
|
+
// token.
|
297
|
+
string page_token = 3;
|
298
|
+
}
|
299
|
+
|
300
|
+
// Response message for
|
301
|
+
// [IdentityMappingStoreService.ListIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappings]
|
302
|
+
message ListIdentityMappingsResponse {
|
303
|
+
// The Identity Mapping Entries.
|
304
|
+
repeated IdentityMappingEntry identity_mapping_entries = 1;
|
305
|
+
|
306
|
+
// A token that can be sent as `page_token` to retrieve the next page. If this
|
307
|
+
// field is omitted, there are no subsequent pages.
|
308
|
+
string next_page_token = 2;
|
309
|
+
}
|
310
|
+
|
311
|
+
// Request message for
|
312
|
+
// [IdentityMappingStoreService.ListIdentityMappingStores][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappingStores]
|
313
|
+
message ListIdentityMappingStoresRequest {
|
314
|
+
// Required. The parent of the Identity Mapping Stores to list.
|
315
|
+
// Format:
|
316
|
+
// `projects/{project}/locations/{location}`.
|
317
|
+
string parent = 1 [
|
318
|
+
(google.api.field_behavior) = REQUIRED,
|
319
|
+
(google.api.resource_reference) = {
|
320
|
+
type: "discoveryengine.googleapis.com/Location"
|
321
|
+
}
|
322
|
+
];
|
323
|
+
|
324
|
+
// Maximum number of IdentityMappingStores to return. If unspecified, defaults
|
325
|
+
// to 100. The maximum allowed value is 1000. Values above 1000 will be
|
326
|
+
// coerced to 1000.
|
327
|
+
int32 page_size = 2;
|
328
|
+
|
329
|
+
// A page token, received from a previous `ListIdentityMappingStores` call.
|
330
|
+
// Provide this to retrieve the subsequent page.
|
331
|
+
//
|
332
|
+
// When paginating, all other parameters provided to
|
333
|
+
// `ListIdentityMappingStores` must match the call that provided the page
|
334
|
+
// token.
|
335
|
+
string page_token = 3;
|
336
|
+
}
|
337
|
+
|
338
|
+
// Response message for
|
339
|
+
// [IdentityMappingStoreService.ListIdentityMappingStores][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappingStores]
|
340
|
+
message ListIdentityMappingStoresResponse {
|
341
|
+
// The Identity Mapping Stores.
|
342
|
+
repeated IdentityMappingStore identity_mapping_stores = 1;
|
343
|
+
|
344
|
+
// A token that can be sent as `page_token` to retrieve the next page. If this
|
345
|
+
// field is omitted, there are no subsequent pages.
|
346
|
+
string next_page_token = 2;
|
347
|
+
}
|
348
|
+
|
349
|
+
// IdentityMappingEntry LongRunningOperation metadata for
|
350
|
+
// [IdentityMappingStoreService.ImportIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ImportIdentityMappings]
|
351
|
+
// and
|
352
|
+
// [IdentityMappingStoreService.PurgeIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.PurgeIdentityMappings]
|
353
|
+
message IdentityMappingEntryOperationMetadata {
|
354
|
+
// The number of IdentityMappingEntries that were successfully processed.
|
355
|
+
int64 success_count = 1;
|
356
|
+
|
357
|
+
// The number of IdentityMappingEntries that failed to be processed.
|
358
|
+
int64 failure_count = 2;
|
359
|
+
|
360
|
+
// The total number of IdentityMappingEntries that were processed.
|
361
|
+
int64 total_count = 3;
|
362
|
+
}
|
363
|
+
|
364
|
+
// Metadata related to the progress of the
|
365
|
+
// [IdentityMappingStoreService.DeleteIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.DeleteIdentityMappingStore]
|
366
|
+
// operation. This will be returned by the google.longrunning.Operation.metadata
|
367
|
+
// field.
|
368
|
+
message DeleteIdentityMappingStoreMetadata {
|
369
|
+
// Operation create time.
|
370
|
+
google.protobuf.Timestamp create_time = 1;
|
371
|
+
|
372
|
+
// Operation last update time. If the operation is done, this is also the
|
373
|
+
// finish time.
|
374
|
+
google.protobuf.Timestamp update_time = 2;
|
375
|
+
}
|
@@ -121,6 +121,12 @@ message SearchRequest {
|
|
121
121
|
// For more information on boosting, see
|
122
122
|
// [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
|
123
123
|
BoostSpec boost_spec = 6 [(google.api.field_behavior) = OPTIONAL];
|
124
|
+
|
125
|
+
// Optional. Custom search operators which if specified will be used to
|
126
|
+
// filter results from workspace data stores. For more information on custom
|
127
|
+
// search operators, see
|
128
|
+
// [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
|
129
|
+
string custom_search_operators = 7 [(google.api.field_behavior) = OPTIONAL];
|
124
130
|
}
|
125
131
|
|
126
132
|
// A facet specification to perform faceted search.
|
@@ -1028,22 +1034,16 @@ message SearchRequest {
|
|
1028
1034
|
// between /search API calls and /answer API calls.
|
1029
1035
|
//
|
1030
1036
|
// Example #1 (multi-turn /search API calls):
|
1031
|
-
//
|
1032
|
-
//
|
1033
|
-
//
|
1034
|
-
//
|
1035
|
-
//
|
1036
|
-
// be interpreted as "How did Alphabet do in 2023?".
|
1037
|
+
// Call /search API with the session ID generated in the first call.
|
1038
|
+
// Here, the previous search query gets considered in query
|
1039
|
+
// standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
1040
|
+
// and the current query is "How about 2023?", the current query will
|
1041
|
+
// be interpreted as "How did Alphabet do in 2023?".
|
1037
1042
|
//
|
1038
1043
|
// Example #2 (coordination between /search API calls and /answer API calls):
|
1039
|
-
//
|
1040
|
-
//
|
1041
|
-
//
|
1042
|
-
// results from the first search call.
|
1043
|
-
//
|
1044
|
-
// Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
1045
|
-
// gets automatically created. Otherwise, users can use the create-session API
|
1046
|
-
// to create a session manually.
|
1044
|
+
// Call /answer API with the session ID generated in the first call.
|
1045
|
+
// Here, the answer generation happens in the context of the search
|
1046
|
+
// results from the first search call.
|
1047
1047
|
//
|
1048
1048
|
// Multi-turn Search feature is currently at private GA stage. Please use
|
1049
1049
|
// v1alpha or v1beta version instead before we launch this feature to public
|
@@ -37,21 +37,27 @@ message Session {
|
|
37
37
|
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}"
|
38
38
|
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}"
|
39
39
|
pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}"
|
40
|
+
plural: "sessions"
|
41
|
+
singular: "session"
|
40
42
|
};
|
41
43
|
|
42
44
|
// Represents a turn, including a query from the user and a
|
43
45
|
// answer from service.
|
44
46
|
message Turn {
|
45
|
-
// The user query.
|
46
|
-
|
47
|
+
// Optional. The user query. May not be set if this turn is merely
|
48
|
+
// regenerating an answer to a different turn
|
49
|
+
Query query = 1 [(google.api.field_behavior) = OPTIONAL];
|
47
50
|
|
48
|
-
// The resource name of the answer to the user query.
|
51
|
+
// Optional. The resource name of the answer to the user query.
|
49
52
|
//
|
50
53
|
// Only set if the answer generation (/answer API call) happened in this
|
51
54
|
// turn.
|
52
|
-
string answer = 2 [
|
53
|
-
|
54
|
-
|
55
|
+
string answer = 2 [
|
56
|
+
(google.api.field_behavior) = OPTIONAL,
|
57
|
+
(google.api.resource_reference) = {
|
58
|
+
type: "discoveryengine.googleapis.com/Answer"
|
59
|
+
}
|
60
|
+
];
|
55
61
|
|
56
62
|
// Output only. In
|
57
63
|
// [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1.ConversationalSearchService.GetSession]
|
@@ -60,6 +66,13 @@ message Session {
|
|
60
66
|
// is set to true, this field will be populated when getting answer query
|
61
67
|
// session.
|
62
68
|
Answer detailed_answer = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
|
69
|
+
|
70
|
+
// Optional. Represents metadata related to the query config, for example
|
71
|
+
// LLM model and version used, model parameters (temperature, grounding
|
72
|
+
// parameters, etc.). The prefix "google." is reserved for Google-developed
|
73
|
+
// functionality.
|
74
|
+
map<string, string> query_config = 16
|
75
|
+
[(google.api.field_behavior) = OPTIONAL];
|
63
76
|
}
|
64
77
|
|
65
78
|
// Enumeration of the state of the session.
|
@@ -111,6 +124,6 @@ message Query {
|
|
111
124
|
string text = 2;
|
112
125
|
}
|
113
126
|
|
114
|
-
// Unique Id for the query.
|
115
|
-
string query_id = 1;
|
127
|
+
// Output only. Unique Id for the query.
|
128
|
+
string query_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
|
116
129
|
}
|
@@ -0,0 +1,128 @@
|
|
1
|
+
// Copyright 2025 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.v1;
|
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/v1/conversational_search_service.proto";
|
24
|
+
import "google/cloud/discoveryengine/v1/session.proto";
|
25
|
+
import "google/protobuf/empty.proto";
|
26
|
+
|
27
|
+
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
|
28
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
|
29
|
+
option java_multiple_files = true;
|
30
|
+
option java_outer_classname = "SessionServiceProto";
|
31
|
+
option java_package = "com.google.cloud.discoveryengine.v1";
|
32
|
+
option objc_class_prefix = "DISCOVERYENGINE";
|
33
|
+
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
|
34
|
+
option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
|
35
|
+
|
36
|
+
// Service for managing Sessions and Session-related resources.
|
37
|
+
service SessionService {
|
38
|
+
option (google.api.default_host) = "discoveryengine.googleapis.com";
|
39
|
+
option (google.api.oauth_scopes) =
|
40
|
+
"https://www.googleapis.com/auth/cloud-platform";
|
41
|
+
|
42
|
+
// Creates a Session.
|
43
|
+
//
|
44
|
+
// If the [Session][google.cloud.discoveryengine.v1.Session] to create already
|
45
|
+
// exists, an ALREADY_EXISTS error is returned.
|
46
|
+
rpc CreateSession(CreateSessionRequest) returns (Session) {
|
47
|
+
option (google.api.http) = {
|
48
|
+
post: "/v1/{parent=projects/*/locations/*/dataStores/*}/sessions"
|
49
|
+
body: "session"
|
50
|
+
additional_bindings {
|
51
|
+
post: "/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/sessions"
|
52
|
+
body: "session"
|
53
|
+
}
|
54
|
+
additional_bindings {
|
55
|
+
post: "/v1/{parent=projects/*/locations/*/collections/*/engines/*}/sessions"
|
56
|
+
body: "session"
|
57
|
+
}
|
58
|
+
};
|
59
|
+
option (google.api.method_signature) = "parent,session";
|
60
|
+
}
|
61
|
+
|
62
|
+
// Deletes a Session.
|
63
|
+
//
|
64
|
+
// If the [Session][google.cloud.discoveryengine.v1.Session] to delete does
|
65
|
+
// not exist, a NOT_FOUND error is returned.
|
66
|
+
rpc DeleteSession(DeleteSessionRequest) returns (google.protobuf.Empty) {
|
67
|
+
option (google.api.http) = {
|
68
|
+
delete: "/v1/{name=projects/*/locations/*/dataStores/*/sessions/*}"
|
69
|
+
additional_bindings {
|
70
|
+
delete: "/v1/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}"
|
71
|
+
}
|
72
|
+
additional_bindings {
|
73
|
+
delete: "/v1/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}"
|
74
|
+
}
|
75
|
+
};
|
76
|
+
option (google.api.method_signature) = "name";
|
77
|
+
}
|
78
|
+
|
79
|
+
// Updates a Session.
|
80
|
+
//
|
81
|
+
// [Session][google.cloud.discoveryengine.v1.Session] action type cannot be
|
82
|
+
// changed. If the [Session][google.cloud.discoveryengine.v1.Session] to
|
83
|
+
// update does not exist, a NOT_FOUND error is returned.
|
84
|
+
rpc UpdateSession(UpdateSessionRequest) returns (Session) {
|
85
|
+
option (google.api.http) = {
|
86
|
+
patch: "/v1/{session.name=projects/*/locations/*/dataStores/*/sessions/*}"
|
87
|
+
body: "session"
|
88
|
+
additional_bindings {
|
89
|
+
patch: "/v1/{session.name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}"
|
90
|
+
body: "session"
|
91
|
+
}
|
92
|
+
additional_bindings {
|
93
|
+
patch: "/v1/{session.name=projects/*/locations/*/collections/*/engines/*/sessions/*}"
|
94
|
+
body: "session"
|
95
|
+
}
|
96
|
+
};
|
97
|
+
option (google.api.method_signature) = "session,update_mask";
|
98
|
+
}
|
99
|
+
|
100
|
+
// Gets a Session.
|
101
|
+
rpc GetSession(GetSessionRequest) returns (Session) {
|
102
|
+
option (google.api.http) = {
|
103
|
+
get: "/v1/{name=projects/*/locations/*/dataStores/*/sessions/*}"
|
104
|
+
additional_bindings {
|
105
|
+
get: "/v1/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}"
|
106
|
+
}
|
107
|
+
additional_bindings {
|
108
|
+
get: "/v1/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}"
|
109
|
+
}
|
110
|
+
};
|
111
|
+
option (google.api.method_signature) = "name";
|
112
|
+
}
|
113
|
+
|
114
|
+
// Lists all Sessions by their parent
|
115
|
+
// [DataStore][google.cloud.discoveryengine.v1.DataStore].
|
116
|
+
rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse) {
|
117
|
+
option (google.api.http) = {
|
118
|
+
get: "/v1/{parent=projects/*/locations/*/dataStores/*}/sessions"
|
119
|
+
additional_bindings {
|
120
|
+
get: "/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/sessions"
|
121
|
+
}
|
122
|
+
additional_bindings {
|
123
|
+
get: "/v1/{parent=projects/*/locations/*/collections/*/engines/*}/sessions"
|
124
|
+
}
|
125
|
+
};
|
126
|
+
option (google.api.method_signature) = "parent";
|
127
|
+
}
|
128
|
+
}
|
@@ -100,6 +100,12 @@ message TargetSite {
|
|
100
100
|
// 1. target site deleted if unindexing is successful;
|
101
101
|
// 2. state reverts to SUCCEEDED if the unindexing fails.
|
102
102
|
DELETING = 4;
|
103
|
+
|
104
|
+
// The target site change is pending but cancellable.
|
105
|
+
CANCELLABLE = 5;
|
106
|
+
|
107
|
+
// The target site change is cancelled.
|
108
|
+
CANCELLED = 6;
|
103
109
|
}
|
104
110
|
|
105
111
|
// Output only. The fully qualified resource name of the target site.
|