@google-cloud/discoveryengine 2.3.0 → 2.5.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 +20 -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/conversational_search_service.proto +15 -3
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +160 -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/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 +136 -18
- 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 +136 -18
- 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 +15854 -10608
- package/build/protos/protos.js +47009 -33222
- package/build/protos/protos.json +5357 -3208
- package/build/src/index.d.ts +7 -1
- package/build/src/index.js +6 -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 +255 -144
- package/build/src/v1/cmek_config_service_client.js +348 -196
- package/build/src/v1/cmek_config_service_proto_list.json +4 -0
- package/build/src/v1/completion_service_client.d.ts +255 -144
- package/build/src/v1/completion_service_client.js +348 -196
- package/build/src/v1/completion_service_proto_list.json +4 -0
- package/build/src/v1/control_service_client.d.ts +255 -144
- package/build/src/v1/control_service_client.js +348 -196
- package/build/src/v1/control_service_proto_list.json +4 -0
- package/build/src/v1/conversational_search_service_client.d.ts +302 -155
- package/build/src/v1/conversational_search_service_client.js +380 -204
- package/build/src/v1/conversational_search_service_proto_list.json +4 -0
- package/build/src/v1/data_store_service_client.d.ts +255 -144
- package/build/src/v1/data_store_service_client.js +348 -196
- package/build/src/v1/data_store_service_proto_list.json +4 -0
- package/build/src/v1/document_service_client.d.ts +255 -144
- package/build/src/v1/document_service_client.js +348 -196
- package/build/src/v1/document_service_proto_list.json +4 -0
- package/build/src/v1/engine_service_client.d.ts +255 -144
- package/build/src/v1/engine_service_client.js +348 -196
- package/build/src/v1/engine_service_proto_list.json +4 -0
- package/build/src/v1/gapic_metadata.json +86 -0
- package/build/src/v1/grounded_generation_service_client.d.ts +255 -144
- package/build/src/v1/grounded_generation_service_client.js +348 -196
- package/build/src/v1/grounded_generation_service_proto_list.json +4 -0
- package/build/src/v1/identity_mapping_store_service_client.d.ts +255 -144
- package/build/src/v1/identity_mapping_store_service_client.js +353 -201
- package/build/src/v1/identity_mapping_store_service_proto_list.json +4 -0
- package/build/src/v1/index.d.ts +2 -0
- package/build/src/v1/index.js +5 -1
- package/build/src/v1/project_service_client.d.ts +255 -144
- package/build/src/v1/project_service_client.js +348 -196
- package/build/src/v1/project_service_proto_list.json +4 -0
- package/build/src/v1/rank_service_client.d.ts +255 -144
- package/build/src/v1/rank_service_client.js +348 -196
- package/build/src/v1/rank_service_proto_list.json +4 -0
- package/build/src/v1/recommendation_service_client.d.ts +255 -144
- package/build/src/v1/recommendation_service_client.js +348 -196
- package/build/src/v1/recommendation_service_proto_list.json +4 -0
- package/build/src/v1/schema_service_client.d.ts +255 -144
- package/build/src/v1/schema_service_client.js +348 -196
- package/build/src/v1/schema_service_proto_list.json +4 -0
- package/build/src/v1/search_service_client.d.ts +861 -228
- package/build/src/v1/search_service_client.js +752 -252
- package/build/src/v1/search_service_proto_list.json +4 -0
- package/build/src/v1/search_tuning_service_client.d.ts +255 -144
- package/build/src/v1/search_tuning_service_client.js +348 -196
- package/build/src/v1/search_tuning_service_proto_list.json +4 -0
- package/build/src/v1/serving_config_service_client.d.ts +255 -144
- package/build/src/v1/serving_config_service_client.js +348 -196
- package/build/src/v1/serving_config_service_proto_list.json +4 -0
- 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 +255 -144
- package/build/src/v1/site_search_engine_service_client.js +348 -196
- package/build/src/v1/site_search_engine_service_proto_list.json +4 -0
- package/build/src/v1/user_event_service_client.d.ts +255 -144
- package/build/src/v1/user_event_service_client.js +348 -196
- package/build/src/v1/user_event_service_proto_list.json +4 -0
- package/build/src/v1/user_license_service_client.d.ts +255 -144
- package/build/src/v1/user_license_service_client.js +348 -196
- package/build/src/v1/user_license_service_proto_list.json +4 -0
- package/build/src/v1alpha/acl_config_service_client.d.ts +144 -144
- package/build/src/v1alpha/acl_config_service_client.js +196 -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 +196 -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 +196 -196
- 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 +196 -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 +244 -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 +196 -196
- 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 +196 -196
- 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 +196 -196
- 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 +196 -196
- 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 +196 -196
- 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 +196 -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 +196 -196
- 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 +196 -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 +196 -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 +196 -196
- 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 +196 -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 +196 -196
- package/build/src/v1alpha/schema_service_proto_list.json +1 -0
- package/build/src/v1alpha/search_service_client.d.ts +378 -198
- package/build/src/v1alpha/search_service_client.js +352 -232
- 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 +196 -196
- 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 +196 -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 +196 -196
- 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 +196 -196
- 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 +196 -196
- 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 +196 -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 +242 -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 +196 -196
- 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 +196 -196
- 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 +196 -196
- 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 +196 -196
- 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 +196 -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 +196 -196
- 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 +196 -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 +196 -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 +196 -196
- 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 +196 -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 +196 -196
- package/build/src/v1beta/schema_service_proto_list.json +1 -0
- package/build/src/v1beta/search_service_client.d.ts +612 -252
- package/build/src/v1beta/search_service_client.js +508 -268
- 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 +196 -196
- 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 +196 -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 +196 -196
- 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 +196 -196
- package/build/src/v1beta/user_event_service_proto_list.json +1 -0
- package/package.json +1 -1
@@ -0,0 +1,201 @@
|
|
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.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/conversational_search_service.proto";
|
24
|
+
import "google/cloud/discoveryengine/v1alpha/session.proto";
|
25
|
+
import "google/protobuf/empty.proto";
|
26
|
+
|
27
|
+
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
|
28
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
|
29
|
+
option java_multiple_files = true;
|
30
|
+
option java_outer_classname = "SessionServiceProto";
|
31
|
+
option java_package = "com.google.cloud.discoveryengine.v1alpha";
|
32
|
+
option objc_class_prefix = "DISCOVERYENGINE";
|
33
|
+
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
|
34
|
+
option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
|
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.v1alpha.Session] to create
|
45
|
+
// already exists, an ALREADY_EXISTS error is returned.
|
46
|
+
rpc CreateSession(CreateSessionRequest) returns (Session) {
|
47
|
+
option (google.api.http) = {
|
48
|
+
post: "/v1alpha/{parent=projects/*/locations/*/dataStores/*}/sessions"
|
49
|
+
body: "session"
|
50
|
+
additional_bindings {
|
51
|
+
post: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/sessions"
|
52
|
+
body: "session"
|
53
|
+
}
|
54
|
+
additional_bindings {
|
55
|
+
post: "/v1alpha/{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.v1alpha.Session] to delete
|
65
|
+
// does not exist, a NOT_FOUND error is returned.
|
66
|
+
rpc DeleteSession(DeleteSessionRequest) returns (google.protobuf.Empty) {
|
67
|
+
option (google.api.http) = {
|
68
|
+
delete: "/v1alpha/{name=projects/*/locations/*/dataStores/*/sessions/*}"
|
69
|
+
additional_bindings {
|
70
|
+
delete: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}"
|
71
|
+
}
|
72
|
+
additional_bindings {
|
73
|
+
delete: "/v1alpha/{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.v1alpha.Session] action type cannot
|
82
|
+
// be changed. If the [Session][google.cloud.discoveryengine.v1alpha.Session]
|
83
|
+
// to update does not exist, a NOT_FOUND error is returned.
|
84
|
+
rpc UpdateSession(UpdateSessionRequest) returns (Session) {
|
85
|
+
option (google.api.http) = {
|
86
|
+
patch: "/v1alpha/{session.name=projects/*/locations/*/dataStores/*/sessions/*}"
|
87
|
+
body: "session"
|
88
|
+
additional_bindings {
|
89
|
+
patch: "/v1alpha/{session.name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}"
|
90
|
+
body: "session"
|
91
|
+
}
|
92
|
+
additional_bindings {
|
93
|
+
patch: "/v1alpha/{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: "/v1alpha/{name=projects/*/locations/*/dataStores/*/sessions/*}"
|
104
|
+
additional_bindings {
|
105
|
+
get: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}"
|
106
|
+
}
|
107
|
+
additional_bindings {
|
108
|
+
get: "/v1alpha/{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.v1alpha.DataStore].
|
116
|
+
rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse) {
|
117
|
+
option (google.api.http) = {
|
118
|
+
get: "/v1alpha/{parent=projects/*/locations/*/dataStores/*}/sessions"
|
119
|
+
additional_bindings {
|
120
|
+
get: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/sessions"
|
121
|
+
}
|
122
|
+
additional_bindings {
|
123
|
+
get: "/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/sessions"
|
124
|
+
}
|
125
|
+
};
|
126
|
+
option (google.api.method_signature) = "parent";
|
127
|
+
}
|
128
|
+
|
129
|
+
// Lists metadata for all files in the current session.
|
130
|
+
rpc ListFiles(ListFilesRequest) returns (ListFilesResponse) {
|
131
|
+
option (google.api.http) = {
|
132
|
+
get: "/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/sessions/*}/files"
|
133
|
+
};
|
134
|
+
option (google.api.method_signature) = "parent";
|
135
|
+
}
|
136
|
+
}
|
137
|
+
|
138
|
+
// Request message for
|
139
|
+
// [SessionService.ListFiles][google.cloud.discoveryengine.v1alpha.SessionService.ListFiles]
|
140
|
+
// method.
|
141
|
+
message ListFilesRequest {
|
142
|
+
// Required. The resource name of the Session.
|
143
|
+
// Format:
|
144
|
+
// `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
|
145
|
+
// Name of the session resource to which the file belong.
|
146
|
+
string parent = 1 [
|
147
|
+
(google.api.field_behavior) = REQUIRED,
|
148
|
+
(google.api.resource_reference) = {
|
149
|
+
type: "discoveryengine.googleapis.com/Session"
|
150
|
+
}
|
151
|
+
];
|
152
|
+
|
153
|
+
// Optional. The filter syntax consists of an expression language for
|
154
|
+
// constructing a predicate from one or more fields of the files being
|
155
|
+
// filtered. Filter expression is case-sensitive. Currently supported field
|
156
|
+
// names are:
|
157
|
+
// * upload_time
|
158
|
+
// * last_add_time
|
159
|
+
// * last_use_time
|
160
|
+
// * file_name
|
161
|
+
// * mime_type
|
162
|
+
//
|
163
|
+
// Some examples of filters would be:
|
164
|
+
// * "file_name = 'file_1'"
|
165
|
+
// * "file_name = 'file_1' AND mime_type = 'text/plain'"
|
166
|
+
// * "last_use_time > '2025-06-14T12:00:00Z'"
|
167
|
+
//
|
168
|
+
// For a full description of the filter format, please
|
169
|
+
// see https://google.aip.dev/160.
|
170
|
+
string filter = 2 [(google.api.field_behavior) = OPTIONAL];
|
171
|
+
|
172
|
+
// Optional. The maximum number of files to return. The service may return
|
173
|
+
// fewer than this value. If unspecified, at most 100 files will be returned.
|
174
|
+
// The maximum value is 1000; values above 1000 will be coerced to 1000.
|
175
|
+
// If user specifies a value less than or equal to 0 - the request will be
|
176
|
+
// rejected with an INVALID_ARGUMENT error.
|
177
|
+
int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];
|
178
|
+
|
179
|
+
// Optional. A page token received from a previous `ListFiles` call.
|
180
|
+
// Provide this to retrieve the subsequent page.
|
181
|
+
//
|
182
|
+
// When paginating, all other parameters provided to `ListFiles`
|
183
|
+
// must match the call that provided the page token (except `page_size`, which
|
184
|
+
// may differ).
|
185
|
+
string page_token = 4 [(google.api.field_behavior) = OPTIONAL];
|
186
|
+
}
|
187
|
+
|
188
|
+
// Response message for
|
189
|
+
// [SessionService.ListFiles][google.cloud.discoveryengine.v1alpha.SessionService.ListFiles]
|
190
|
+
// method.
|
191
|
+
message ListFilesResponse {
|
192
|
+
// The [FileMetadata][google.cloud.discoveryengine.v1alpha.FileMetadata]s.
|
193
|
+
repeated FileMetadata files = 1;
|
194
|
+
|
195
|
+
// A token to retrieve next page of results.
|
196
|
+
// Pass this value in the
|
197
|
+
// [ListFilesRequest.page_token][google.cloud.discoveryengine.v1main.ListFilesRequest.page_token]
|
198
|
+
// field in the subsequent call to `ListFiles` method to
|
199
|
+
// retrieve the next page of results.
|
200
|
+
string next_page_token = 3;
|
201
|
+
}
|
package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto
CHANGED
@@ -980,6 +980,10 @@ message GetSessionRequest {
|
|
980
980
|
type: "discoveryengine.googleapis.com/Session"
|
981
981
|
}
|
982
982
|
];
|
983
|
+
|
984
|
+
// Optional. If set to true, the full session including all answer details
|
985
|
+
// will be returned.
|
986
|
+
bool include_answer_details = 2 [(google.api.field_behavior) = OPTIONAL];
|
983
987
|
}
|
984
988
|
|
985
989
|
// Request for ListSessions method.
|
@@ -1001,23 +1005,40 @@ message ListSessionsRequest {
|
|
1001
1005
|
// Provide this to retrieve the subsequent page.
|
1002
1006
|
string page_token = 3;
|
1003
1007
|
|
1004
|
-
// A
|
1005
|
-
//
|
1008
|
+
// A comma-separated list of fields to filter by, in EBNF grammar.
|
1009
|
+
// The supported fields are:
|
1010
|
+
// * `user_pseudo_id`
|
1011
|
+
// * `state`
|
1012
|
+
// * `display_name`
|
1013
|
+
// * `starred`
|
1014
|
+
// * `is_pinned`
|
1015
|
+
// * `labels`
|
1016
|
+
// * `create_time`
|
1017
|
+
// * `update_time`
|
1006
1018
|
//
|
1007
|
-
//
|
1019
|
+
// Examples:
|
1008
1020
|
// "user_pseudo_id = some_id"
|
1021
|
+
// "display_name = \"some_name\""
|
1022
|
+
// "starred = true"
|
1023
|
+
// "is_pinned=true AND (NOT labels:hidden)"
|
1024
|
+
// "create_time > \"1970-01-01T12:00:00Z\""
|
1009
1025
|
string filter = 4;
|
1010
1026
|
|
1011
1027
|
// A comma-separated list of fields to order by, sorted in ascending order.
|
1012
1028
|
// Use "desc" after a field name for descending.
|
1013
1029
|
// Supported fields:
|
1030
|
+
//
|
1014
1031
|
// * `update_time`
|
1015
1032
|
// * `create_time`
|
1016
1033
|
// * `session_name`
|
1034
|
+
// * `is_pinned`
|
1017
1035
|
//
|
1018
1036
|
// Example:
|
1019
|
-
//
|
1020
|
-
// "
|
1037
|
+
//
|
1038
|
+
// * "update_time desc"
|
1039
|
+
// * "create_time"
|
1040
|
+
// * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
|
1041
|
+
// by update_time.
|
1021
1042
|
string order_by = 5;
|
1022
1043
|
}
|
1023
1044
|
|
@@ -1038,8 +1038,14 @@ message SearchRequest {
|
|
1038
1038
|
// The ranking expression controls the customized ranking on retrieval
|
1039
1039
|
// documents. This overrides
|
1040
1040
|
// [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression].
|
1041
|
-
// The
|
1042
|
-
//
|
1041
|
+
// The syntax and supported features depend on the
|
1042
|
+
// `ranking_expression_backend` value. If `ranking_expression_backend` is not
|
1043
|
+
// provided, it defaults to `RANK_BY_EMBEDDING`.
|
1044
|
+
//
|
1045
|
+
// If
|
1046
|
+
// [ranking_expression_backend][google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend]
|
1047
|
+
// is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
|
1048
|
+
// function or multiple functions that are joined by "+".
|
1043
1049
|
//
|
1044
1050
|
// * ranking_expression = function, { " + ", function };
|
1045
1051
|
//
|
@@ -1054,15 +1060,90 @@ message SearchRequest {
|
|
1054
1060
|
// between query and document.
|
1055
1061
|
// * `embedding_field_path`: the document embedding field
|
1056
1062
|
// used with query embedding vector.
|
1057
|
-
// * `dotProduct`: embedding function between embedding_field_path and
|
1058
|
-
// embedding vector.
|
1063
|
+
// * `dotProduct`: embedding function between `embedding_field_path` and
|
1064
|
+
// query embedding vector.
|
1059
1065
|
//
|
1060
1066
|
// Example ranking expression:
|
1061
1067
|
//
|
1062
1068
|
// If document has an embedding field doc_embedding, the ranking expression
|
1063
1069
|
// could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
1070
|
+
//
|
1071
|
+
// If
|
1072
|
+
// [ranking_expression_backend][google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend]
|
1073
|
+
// is set to `RANK_BY_FORMULA`, the following expression types (and
|
1074
|
+
// combinations of those chained using + or
|
1075
|
+
// * operators) are supported:
|
1076
|
+
//
|
1077
|
+
// * `double`
|
1078
|
+
// * `signal`
|
1079
|
+
// * `log(signal)`
|
1080
|
+
// * `exp(signal)`
|
1081
|
+
// * `rr(signal, double > 0)` -- reciprocal rank transformation with second
|
1082
|
+
// argument being a denominator constant.
|
1083
|
+
// * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
|
1084
|
+
// * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
|
1085
|
+
// signal2 | double, else returns signal1.
|
1086
|
+
//
|
1087
|
+
// Here are a few examples of ranking formulas that use the supported
|
1088
|
+
// ranking expression types:
|
1089
|
+
//
|
1090
|
+
// - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
|
1091
|
+
// -- mostly rank by the logarithm of `keyword_similarity_score` with slight
|
1092
|
+
// `semantic_smilarity_score` adjustment.
|
1093
|
+
// - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
|
1094
|
+
// is_nan(keyword_similarity_score)` -- rank by the exponent of
|
1095
|
+
// `semantic_similarity_score` filling the value with 0 if it's NaN, also
|
1096
|
+
// add constant 0.3 adjustment to the final score if
|
1097
|
+
// `semantic_similarity_score` is NaN.
|
1098
|
+
// - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
|
1099
|
+
// rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
|
1100
|
+
// of `keyword_similarity_score` with slight adjustment of reciprocal rank
|
1101
|
+
// of `semantic_smilarity_score`.
|
1102
|
+
//
|
1103
|
+
// The following signals are supported:
|
1104
|
+
//
|
1105
|
+
// * `semantic_similarity_score`: semantic similarity adjustment that is
|
1106
|
+
// calculated using the embeddings generated by a proprietary Google model.
|
1107
|
+
// This score determines how semantically similar a search query is to a
|
1108
|
+
// document.
|
1109
|
+
// * `keyword_similarity_score`: keyword match adjustment uses the Best
|
1110
|
+
// Match 25 (BM25) ranking function. This score is calculated using a
|
1111
|
+
// probabilistic model to estimate the probability that a document is
|
1112
|
+
// relevant to a given query.
|
1113
|
+
// * `relevance_score`: semantic relevance adjustment that uses a
|
1114
|
+
// proprietary Google model to determine the meaning and intent behind a
|
1115
|
+
// user's query in context with the content in the documents.
|
1116
|
+
// * `pctr_rank`: predicted conversion rate adjustment as a rank use
|
1117
|
+
// predicted Click-through rate (pCTR) to gauge the relevance and
|
1118
|
+
// attractiveness of a search result from a user's perspective. A higher
|
1119
|
+
// pCTR suggests that the result is more likely to satisfy the user's query
|
1120
|
+
// and intent, making it a valuable signal for ranking.
|
1121
|
+
// * `freshness_rank`: freshness adjustment as a rank
|
1122
|
+
// * `document_age`: The time in hours elapsed since the document was last
|
1123
|
+
// updated, a floating-point number (e.g., 0.25 means 15 minutes).
|
1124
|
+
// * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
|
1125
|
+
// Google model to determine the keyword-based overlap between the query and
|
1126
|
+
// the document.
|
1127
|
+
// * `base_rank`: the default rank of the result
|
1064
1128
|
string ranking_expression = 26;
|
1065
1129
|
|
1130
|
+
// The backend to use for the ranking expression evaluation.
|
1131
|
+
enum RankingExpressionBackend {
|
1132
|
+
reserved 1, 2;
|
1133
|
+
|
1134
|
+
// Default option for unspecified/unknown values.
|
1135
|
+
RANKING_EXPRESSION_BACKEND_UNSPECIFIED = 0;
|
1136
|
+
// Ranking by custom embedding model, the default way to evaluate the
|
1137
|
+
// ranking expression.
|
1138
|
+
RANK_BY_EMBEDDING = 3;
|
1139
|
+
// Ranking by custom formula.
|
1140
|
+
RANK_BY_FORMULA = 4;
|
1141
|
+
}
|
1142
|
+
|
1143
|
+
// The backend to use for the ranking expression evaluation.
|
1144
|
+
RankingExpressionBackend ranking_expression_backend = 53
|
1145
|
+
[(google.api.field_behavior) = OPTIONAL];
|
1146
|
+
|
1066
1147
|
// Whether to turn on safe search. This is only supported for
|
1067
1148
|
// website search.
|
1068
1149
|
bool safe_search = 20;
|
@@ -1102,22 +1183,16 @@ message SearchRequest {
|
|
1102
1183
|
// between /search API calls and /answer API calls.
|
1103
1184
|
//
|
1104
1185
|
// Example #1 (multi-turn /search API calls):
|
1105
|
-
//
|
1106
|
-
//
|
1107
|
-
//
|
1108
|
-
//
|
1109
|
-
//
|
1110
|
-
// be interpreted as "How did Alphabet do in 2023?".
|
1186
|
+
// Call /search API with the session ID generated in the first call.
|
1187
|
+
// Here, the previous search query gets considered in query
|
1188
|
+
// standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
1189
|
+
// and the current query is "How about 2023?", the current query will
|
1190
|
+
// be interpreted as "How did Alphabet do in 2023?".
|
1111
1191
|
//
|
1112
1192
|
// Example #2 (coordination between /search API calls and /answer API calls):
|
1113
|
-
//
|
1114
|
-
//
|
1115
|
-
//
|
1116
|
-
// results from the first search call.
|
1117
|
-
//
|
1118
|
-
// Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
1119
|
-
// gets automatically created. Otherwise, users can use the create-session API
|
1120
|
-
// to create a session manually.
|
1193
|
+
// Call /answer API with the session ID generated in the first call.
|
1194
|
+
// Here, the answer generation happens in the context of the search
|
1195
|
+
// results from the first search call.
|
1121
1196
|
//
|
1122
1197
|
// Multi-turn Search feature is currently at private GA stage. Please use
|
1123
1198
|
// v1alpha or v1beta version instead before we launch this feature to public
|
@@ -1173,6 +1248,49 @@ message SearchResponse {
|
|
1173
1248
|
|
1174
1249
|
// Google provided available scores.
|
1175
1250
|
map<string, DoubleList> model_scores = 4;
|
1251
|
+
|
1252
|
+
// A set of ranking signals.
|
1253
|
+
message RankSignals {
|
1254
|
+
reserved 5;
|
1255
|
+
|
1256
|
+
// Keyword matching adjustment.
|
1257
|
+
optional float keyword_similarity_score = 1
|
1258
|
+
[(google.api.field_behavior) = OPTIONAL];
|
1259
|
+
// Semantic relevance adjustment.
|
1260
|
+
optional float relevance_score = 2
|
1261
|
+
[(google.api.field_behavior) = OPTIONAL];
|
1262
|
+
// Semantic similarity adjustment.
|
1263
|
+
optional float semantic_similarity_score = 3
|
1264
|
+
[(google.api.field_behavior) = OPTIONAL];
|
1265
|
+
// Predicted conversion rate adjustment as a rank.
|
1266
|
+
optional float pctr_rank = 4 [(google.api.field_behavior) = OPTIONAL];
|
1267
|
+
// Topicality adjustment as a rank.
|
1268
|
+
optional float topicality_rank = 6
|
1269
|
+
[(google.api.field_behavior) = OPTIONAL];
|
1270
|
+
// Age of the document in hours.
|
1271
|
+
optional float document_age = 7 [(google.api.field_behavior) = OPTIONAL];
|
1272
|
+
// Combined custom boosts for a doc.
|
1273
|
+
optional float boosting_factor = 8
|
1274
|
+
[(google.api.field_behavior) = OPTIONAL];
|
1275
|
+
|
1276
|
+
// The default rank of the result.
|
1277
|
+
float default_rank = 32 [(google.api.field_behavior) = OPTIONAL];
|
1278
|
+
|
1279
|
+
// Custom clearbox signal represented by name and value pair.
|
1280
|
+
message CustomSignal {
|
1281
|
+
// Name of the signal.
|
1282
|
+
string name = 1 [(google.api.field_behavior) = OPTIONAL];
|
1283
|
+
// Float value representing the ranking signal (e.g. 1.25 for BM25).
|
1284
|
+
float value = 2 [(google.api.field_behavior) = OPTIONAL];
|
1285
|
+
}
|
1286
|
+
|
1287
|
+
// A list of custom clearbox signals.
|
1288
|
+
repeated CustomSignal custom_signals = 33
|
1289
|
+
[(google.api.field_behavior) = OPTIONAL];
|
1290
|
+
}
|
1291
|
+
|
1292
|
+
// A set of ranking signals associated with the result.
|
1293
|
+
RankSignals rank_signals = 7 [(google.api.field_behavior) = OPTIONAL];
|
1176
1294
|
}
|
1177
1295
|
|
1178
1296
|
// A facet result.
|
@@ -18,6 +18,7 @@ package google.cloud.discoveryengine.v1beta;
|
|
18
18
|
|
19
19
|
import "google/api/field_behavior.proto";
|
20
20
|
import "google/api/resource.proto";
|
21
|
+
import "google/cloud/discoveryengine/v1beta/answer.proto";
|
21
22
|
import "google/protobuf/timestamp.proto";
|
22
23
|
|
23
24
|
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
|
@@ -36,21 +37,42 @@ message Session {
|
|
36
37
|
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}"
|
37
38
|
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}"
|
38
39
|
pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}"
|
40
|
+
plural: "sessions"
|
41
|
+
singular: "session"
|
39
42
|
};
|
40
43
|
|
41
44
|
// Represents a turn, including a query from the user and a
|
42
45
|
// answer from service.
|
43
46
|
message Turn {
|
44
|
-
// The user query.
|
45
|
-
|
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];
|
46
50
|
|
47
|
-
// The resource name of the answer to the user query.
|
51
|
+
// Optional. The resource name of the answer to the user query.
|
48
52
|
//
|
49
53
|
// Only set if the answer generation (/answer API call) happened in this
|
50
54
|
// turn.
|
51
|
-
string answer = 2 [
|
52
|
-
|
53
|
-
|
55
|
+
string answer = 2 [
|
56
|
+
(google.api.field_behavior) = OPTIONAL,
|
57
|
+
(google.api.resource_reference) = {
|
58
|
+
type: "discoveryengine.googleapis.com/Answer"
|
59
|
+
}
|
60
|
+
];
|
61
|
+
|
62
|
+
// Output only. In
|
63
|
+
// [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetSession]
|
64
|
+
// API, if
|
65
|
+
// [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1beta.GetSessionRequest.include_answer_details]
|
66
|
+
// is set to true, this field will be populated when getting answer query
|
67
|
+
// session.
|
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];
|
54
76
|
}
|
55
77
|
|
56
78
|
// Enumeration of the state of the session.
|
@@ -66,6 +88,12 @@ message Session {
|
|
66
88
|
// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
|
67
89
|
string name = 1 [(google.api.field_behavior) = IMMUTABLE];
|
68
90
|
|
91
|
+
// Optional. The display name of the session.
|
92
|
+
//
|
93
|
+
// This field is used to identify the session in the UI.
|
94
|
+
// By default, the display name is the first turn query text in the session.
|
95
|
+
string display_name = 7 [(google.api.field_behavior) = OPTIONAL];
|
96
|
+
|
69
97
|
// The state of the session.
|
70
98
|
State state = 2;
|
71
99
|
|
@@ -82,6 +110,10 @@ message Session {
|
|
82
110
|
// Output only. The time the session finished.
|
83
111
|
google.protobuf.Timestamp end_time = 6
|
84
112
|
[(google.api.field_behavior) = OUTPUT_ONLY];
|
113
|
+
|
114
|
+
// Optional. Whether the session is pinned, pinned session will be displayed
|
115
|
+
// on the top of the session list.
|
116
|
+
bool is_pinned = 8 [(google.api.field_behavior) = OPTIONAL];
|
85
117
|
}
|
86
118
|
|
87
119
|
// Defines a user inputed query.
|
@@ -92,6 +124,6 @@ message Query {
|
|
92
124
|
string text = 2;
|
93
125
|
}
|
94
126
|
|
95
|
-
// Unique Id for the query.
|
96
|
-
string query_id = 1;
|
127
|
+
// Output only. Unique Id for the query.
|
128
|
+
string query_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
|
97
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.v1beta;
|
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/v1beta/conversational_search_service.proto";
|
24
|
+
import "google/cloud/discoveryengine/v1beta/session.proto";
|
25
|
+
import "google/protobuf/empty.proto";
|
26
|
+
|
27
|
+
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
|
28
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
|
29
|
+
option java_multiple_files = true;
|
30
|
+
option java_outer_classname = "SessionServiceProto";
|
31
|
+
option java_package = "com.google.cloud.discoveryengine.v1beta";
|
32
|
+
option objc_class_prefix = "DISCOVERYENGINE";
|
33
|
+
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
|
34
|
+
option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
|
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.v1beta.Session] to create
|
45
|
+
// already exists, an ALREADY_EXISTS error is returned.
|
46
|
+
rpc CreateSession(CreateSessionRequest) returns (Session) {
|
47
|
+
option (google.api.http) = {
|
48
|
+
post: "/v1beta/{parent=projects/*/locations/*/dataStores/*}/sessions"
|
49
|
+
body: "session"
|
50
|
+
additional_bindings {
|
51
|
+
post: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/sessions"
|
52
|
+
body: "session"
|
53
|
+
}
|
54
|
+
additional_bindings {
|
55
|
+
post: "/v1beta/{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.v1beta.Session] to delete
|
65
|
+
// does not exist, a NOT_FOUND error is returned.
|
66
|
+
rpc DeleteSession(DeleteSessionRequest) returns (google.protobuf.Empty) {
|
67
|
+
option (google.api.http) = {
|
68
|
+
delete: "/v1beta/{name=projects/*/locations/*/dataStores/*/sessions/*}"
|
69
|
+
additional_bindings {
|
70
|
+
delete: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}"
|
71
|
+
}
|
72
|
+
additional_bindings {
|
73
|
+
delete: "/v1beta/{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.v1beta.Session] action type cannot
|
82
|
+
// be changed. If the [Session][google.cloud.discoveryengine.v1beta.Session]
|
83
|
+
// to update does not exist, a NOT_FOUND error is returned.
|
84
|
+
rpc UpdateSession(UpdateSessionRequest) returns (Session) {
|
85
|
+
option (google.api.http) = {
|
86
|
+
patch: "/v1beta/{session.name=projects/*/locations/*/dataStores/*/sessions/*}"
|
87
|
+
body: "session"
|
88
|
+
additional_bindings {
|
89
|
+
patch: "/v1beta/{session.name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}"
|
90
|
+
body: "session"
|
91
|
+
}
|
92
|
+
additional_bindings {
|
93
|
+
patch: "/v1beta/{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: "/v1beta/{name=projects/*/locations/*/dataStores/*/sessions/*}"
|
104
|
+
additional_bindings {
|
105
|
+
get: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}"
|
106
|
+
}
|
107
|
+
additional_bindings {
|
108
|
+
get: "/v1beta/{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.v1beta.DataStore].
|
116
|
+
rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse) {
|
117
|
+
option (google.api.http) = {
|
118
|
+
get: "/v1beta/{parent=projects/*/locations/*/dataStores/*}/sessions"
|
119
|
+
additional_bindings {
|
120
|
+
get: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/sessions"
|
121
|
+
}
|
122
|
+
additional_bindings {
|
123
|
+
get: "/v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/sessions"
|
124
|
+
}
|
125
|
+
};
|
126
|
+
option (google.api.method_signature) = "parent";
|
127
|
+
}
|
128
|
+
}
|