@google-cloud/discoveryengine 1.8.0 → 1.9.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/CHANGELOG.md +8 -0
- package/README.md +33 -4
- package/build/protos/google/cloud/discoveryengine/v1/answer.proto +337 -0
- package/build/protos/google/cloud/discoveryengine/v1/common.proto +33 -0
- package/build/protos/google/cloud/discoveryengine/v1/control.proto +214 -0
- package/build/protos/google/cloud/discoveryengine/v1/control_service.proto +236 -0
- package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +2 -2
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +569 -0
- package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +4 -0
- package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +2 -2
- package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +92 -0
- package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +6 -6
- package/build/protos/google/cloud/discoveryengine/v1/engine.proto +4 -4
- package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +149 -0
- package/build/protos/google/cloud/discoveryengine/v1/grounding.proto +58 -0
- package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +4 -4
- package/build/protos/google/cloud/discoveryengine/v1/project.proto +103 -0
- package/build/protos/google/cloud/discoveryengine/v1/project_service.proto +90 -0
- package/build/protos/google/cloud/discoveryengine/v1/rank_service.proto +131 -0
- package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +20 -19
- package/build/protos/google/cloud/discoveryengine/v1/schema_service.proto +5 -5
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +23 -18
- package/build/protos/google/cloud/discoveryengine/v1/session.proto +97 -0
- package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +28 -3
- package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +18 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/answer.proto +9 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +7 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +16 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/control.proto +217 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/control_service.proto +236 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +2 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +19 -3
- package/build/protos/google/cloud/discoveryengine/v1alpha/custom_tuning_model.proto +87 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +2 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +1 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +12 -9
- package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +4 -4
- package/build/protos/google/cloud/discoveryengine/v1alpha/grounded_generation_service.proto +30 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/grounding.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +4 -4
- package/build/protos/google/cloud/discoveryengine/v1alpha/project.proto +1 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/project_service.proto +2 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/rank_service.proto +19 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +20 -19
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +37 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema_service.proto +6 -6
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +28 -31
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +39 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/session.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +29 -3
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +18 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +10 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +16 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/control.proto +216 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/control_service.proto +236 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +2 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +19 -3
- package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto +87 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +2 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +1 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +7 -8
- package/build/protos/google/cloud/discoveryengine/v1beta/engine.proto +4 -4
- package/build/protos/google/cloud/discoveryengine/v1beta/grounded_generation_service.proto +30 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/grounding.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +4 -4
- package/build/protos/google/cloud/discoveryengine/v1beta/project.proto +103 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/project_service.proto +90 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/rank_service.proto +19 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +20 -19
- package/build/protos/google/cloud/discoveryengine/v1beta/schema_service.proto +5 -5
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +30 -24
- package/build/protos/google/cloud/discoveryengine/v1beta/search_tuning_service.proto +39 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/session.proto +4 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +28 -3
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +18 -2
- package/build/protos/protos.d.ts +52350 -38733
- package/build/protos/protos.js +136479 -103212
- package/build/protos/protos.json +9460 -5916
- package/build/src/index.d.ts +13 -1
- package/build/src/index.js +13 -1
- package/build/src/v1/completion_service_client.d.ts +549 -0
- package/build/src/v1/completion_service_client.js +771 -0
- package/build/src/v1/control_service_client.d.ts +1623 -0
- package/build/src/v1/control_service_client.js +2218 -0
- package/build/src/v1/control_service_client_config.json +63 -0
- package/build/src/v1/conversational_search_service_client.d.ts +893 -0
- package/build/src/v1/conversational_search_service_client.js +1040 -14
- package/build/src/v1/conversational_search_service_client_config.json +35 -0
- package/build/src/v1/data_store_service_client.d.ts +555 -6
- package/build/src/v1/data_store_service_client.js +775 -4
- package/build/src/v1/document_service_client.d.ts +557 -8
- package/build/src/v1/document_service_client.js +773 -2
- package/build/src/v1/engine_service_client.d.ts +549 -0
- package/build/src/v1/engine_service_client.js +771 -0
- package/build/src/v1/grounded_generation_service_client.d.ts +1439 -0
- package/build/src/v1/grounded_generation_service_client.js +2036 -0
- package/build/src/v1/grounded_generation_service_client_config.json +43 -0
- package/build/src/v1/index.d.ts +4 -0
- package/build/src/v1/index.js +9 -1
- package/build/src/v1/project_service_client.d.ts +1533 -0
- package/build/src/v1/project_service_client.js +2255 -0
- package/build/src/v1/project_service_client_config.json +43 -0
- package/build/src/v1/rank_service_client.d.ts +1449 -0
- package/build/src/v1/rank_service_client.js +2037 -0
- package/build/src/v1/rank_service_client_config.json +43 -0
- package/build/src/v1/recommendation_service_client.d.ts +568 -18
- package/build/src/v1/recommendation_service_client.js +756 -0
- package/build/src/v1/schema_service_client.d.ts +558 -9
- package/build/src/v1/schema_service_client.js +775 -4
- package/build/src/v1/search_service_client.d.ts +579 -21
- package/build/src/v1/search_service_client.js +776 -14
- package/build/src/v1/site_search_engine_service_client.d.ts +549 -0
- package/build/src/v1/site_search_engine_service_client.js +771 -0
- package/build/src/v1/user_event_service_client.d.ts +562 -2
- package/build/src/v1/user_event_service_client.js +771 -0
- package/build/src/v1alpha/acl_config_service_client.d.ts +237 -0
- package/build/src/v1alpha/acl_config_service_client.js +326 -0
- package/build/src/v1alpha/chunk_service_client.d.ts +237 -0
- package/build/src/v1alpha/chunk_service_client.js +326 -0
- package/build/src/v1alpha/completion_service_client.d.ts +237 -0
- package/build/src/v1alpha/completion_service_client.js +340 -0
- package/build/src/v1alpha/control_service_client.d.ts +2013 -0
- package/build/src/v1alpha/control_service_client.js +2757 -0
- package/build/src/v1alpha/control_service_client_config.json +63 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +239 -2
- package/build/src/v1alpha/conversational_search_service_client.js +326 -0
- package/build/src/v1alpha/data_store_service_client.d.ts +243 -6
- package/build/src/v1alpha/data_store_service_client.js +344 -4
- package/build/src/v1alpha/document_service_client.d.ts +246 -9
- package/build/src/v1alpha/document_service_client.js +342 -2
- package/build/src/v1alpha/engine_service_client.d.ts +237 -0
- package/build/src/v1alpha/engine_service_client.js +340 -0
- package/build/src/v1alpha/estimate_billing_service_client.d.ts +237 -0
- package/build/src/v1alpha/estimate_billing_service_client.js +340 -0
- package/build/src/v1alpha/grounded_generation_service_client.d.ts +256 -1
- package/build/src/v1alpha/grounded_generation_service_client.js +326 -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 +239 -0
- package/build/src/v1alpha/project_service_client.js +340 -0
- package/build/src/v1alpha/project_service_client_config.json +21 -6
- package/build/src/v1alpha/rank_service_client.d.ts +255 -0
- package/build/src/v1alpha/rank_service_client.js +326 -0
- package/build/src/v1alpha/recommendation_service_client.d.ts +256 -18
- package/build/src/v1alpha/recommendation_service_client.js +326 -0
- package/build/src/v1alpha/schema_service_client.d.ts +247 -10
- package/build/src/v1alpha/schema_service_client.js +344 -4
- package/build/src/v1alpha/search_service_client.d.ts +267 -21
- package/build/src/v1alpha/search_service_client.js +346 -14
- package/build/src/v1alpha/search_tuning_service_client.d.ts +265 -0
- package/build/src/v1alpha/search_tuning_service_client.js +365 -1
- package/build/src/v1alpha/search_tuning_service_client_config.json +4 -0
- package/build/src/v1alpha/serving_config_service_client.d.ts +237 -0
- package/build/src/v1alpha/serving_config_service_client.js +326 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +237 -0
- package/build/src/v1alpha/site_search_engine_service_client.js +340 -0
- package/build/src/v1alpha/user_event_service_client.d.ts +250 -2
- package/build/src/v1alpha/user_event_service_client.js +340 -0
- package/build/src/v1beta/completion_service_client.d.ts +252 -0
- package/build/src/v1beta/completion_service_client.js +359 -0
- package/build/src/v1beta/control_service_client.d.ts +1860 -0
- package/build/src/v1beta/control_service_client.js +2545 -0
- package/build/src/v1beta/control_service_client_config.json +63 -0
- package/build/src/v1beta/conversational_search_service_client.d.ts +254 -2
- package/build/src/v1beta/conversational_search_service_client.js +348 -0
- package/build/src/v1beta/data_store_service_client.d.ts +258 -6
- package/build/src/v1beta/data_store_service_client.js +363 -4
- package/build/src/v1beta/document_service_client.d.ts +261 -10
- package/build/src/v1beta/document_service_client.js +361 -2
- package/build/src/v1beta/engine_service_client.d.ts +252 -0
- package/build/src/v1beta/engine_service_client.js +359 -0
- package/build/src/v1beta/grounded_generation_service_client.d.ts +271 -1
- package/build/src/v1beta/grounded_generation_service_client.js +348 -0
- package/build/src/v1beta/index.d.ts +2 -0
- package/build/src/v1beta/index.js +5 -1
- package/build/src/v1beta/project_service_client.d.ts +1770 -0
- package/build/src/v1beta/project_service_client.js +2576 -0
- package/build/src/v1beta/project_service_client_config.json +43 -0
- package/build/src/v1beta/rank_service_client.d.ts +270 -0
- package/build/src/v1beta/rank_service_client.js +348 -0
- package/build/src/v1beta/recommendation_service_client.d.ts +271 -18
- package/build/src/v1beta/recommendation_service_client.js +348 -0
- package/build/src/v1beta/schema_service_client.d.ts +261 -9
- package/build/src/v1beta/schema_service_client.js +363 -4
- package/build/src/v1beta/search_service_client.d.ts +282 -21
- package/build/src/v1beta/search_service_client.js +368 -14
- package/build/src/v1beta/search_tuning_service_client.d.ts +280 -0
- package/build/src/v1beta/search_tuning_service_client.js +384 -1
- package/build/src/v1beta/search_tuning_service_client_config.json +4 -0
- package/build/src/v1beta/serving_config_service_client.d.ts +237 -0
- package/build/src/v1beta/serving_config_service_client.js +326 -0
- package/build/src/v1beta/site_search_engine_service_client.d.ts +252 -0
- package/build/src/v1beta/site_search_engine_service_client.js +359 -0
- package/build/src/v1beta/user_event_service_client.d.ts +265 -2
- package/build/src/v1beta/user_event_service_client.js +359 -0
- package/package.json +2 -2
package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto
CHANGED
@@ -536,6 +536,13 @@ message AnswerQueryRequest {
|
|
536
536
|
// generating answers for non-answer seeking queries and return
|
537
537
|
// fallback messages instead.
|
538
538
|
bool ignore_non_answer_seeking_query = 6;
|
539
|
+
|
540
|
+
// Specifies whether to filter out queries that have low relevance.
|
541
|
+
//
|
542
|
+
// If this field is set to `false`, all search results are used regardless
|
543
|
+
// of relevance to generate answers. If set to `true` or unset, the behavior
|
544
|
+
// will be determined automatically by the service.
|
545
|
+
optional bool ignore_low_relevant_content = 7;
|
539
546
|
}
|
540
547
|
|
541
548
|
// Search specification.
|
@@ -579,6 +586,12 @@ message AnswerQueryRequest {
|
|
579
586
|
//
|
580
587
|
// If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
581
588
|
string order_by = 4;
|
589
|
+
|
590
|
+
// Specs defining dataStores to filter on in a search call and
|
591
|
+
// configurations for those dataStores. This is only considered for
|
592
|
+
// engines with multiple dataStores use case. For single dataStore within
|
593
|
+
// an engine, they should use the specs at the top level.
|
594
|
+
repeated SearchRequest.DataStoreSpec data_store_specs = 7;
|
582
595
|
}
|
583
596
|
|
584
597
|
// Search result list.
|
@@ -699,7 +712,7 @@ message AnswerQueryRequest {
|
|
699
712
|
bool disable = 1;
|
700
713
|
|
701
714
|
// Max rephrase steps.
|
702
|
-
// The max number is
|
715
|
+
// The max number is 5 steps.
|
703
716
|
// If not set or set to < 1, it will be set to 1 by default.
|
704
717
|
int32 max_rephrase_steps = 2;
|
705
718
|
}
|
@@ -731,8 +744,8 @@ message AnswerQueryRequest {
|
|
731
744
|
//
|
732
745
|
// When session field is not set, the API is in sessionless mode.
|
733
746
|
//
|
734
|
-
// We support auto session mode: users can use the wildcard symbol
|
735
|
-
// session
|
747
|
+
// We support auto session mode: users can use the wildcard symbol `-` as
|
748
|
+
// session ID. A new ID will be automatically generated and assigned.
|
736
749
|
string session = 3 [(google.api.resource_reference) = {
|
737
750
|
type: "discoveryengine.googleapis.com/Session"
|
738
751
|
}];
|
@@ -792,6 +805,9 @@ message AnswerQueryResponse {
|
|
792
805
|
// [AnswerQueryRequest][google.cloud.discoveryengine.v1beta.AnswerQueryRequest]
|
793
806
|
// request.
|
794
807
|
Session session = 2;
|
808
|
+
|
809
|
+
// A global unique ID used for logging.
|
810
|
+
string answer_query_token = 3;
|
795
811
|
}
|
796
812
|
|
797
813
|
// Request for GetAnswer method.
|
@@ -0,0 +1,87 @@
|
|
1
|
+
// Copyright 2024 Google LLC
|
2
|
+
//
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
// you may not use this file except in compliance with the License.
|
5
|
+
// You may obtain a copy of the License at
|
6
|
+
//
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
//
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
// See the License for the specific language governing permissions and
|
13
|
+
// limitations under the License.
|
14
|
+
|
15
|
+
syntax = "proto3";
|
16
|
+
|
17
|
+
package google.cloud.discoveryengine.v1beta;
|
18
|
+
|
19
|
+
import "google/api/field_behavior.proto";
|
20
|
+
import "google/api/resource.proto";
|
21
|
+
import "google/protobuf/timestamp.proto";
|
22
|
+
|
23
|
+
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
|
24
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
|
25
|
+
option java_multiple_files = true;
|
26
|
+
option java_outer_classname = "CustomTuningModelProto";
|
27
|
+
option java_package = "com.google.cloud.discoveryengine.v1beta";
|
28
|
+
option objc_class_prefix = "DISCOVERYENGINE";
|
29
|
+
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
|
30
|
+
option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
|
31
|
+
|
32
|
+
// Metadata that describes a custom tuned model.
|
33
|
+
message CustomTuningModel {
|
34
|
+
option (google.api.resource) = {
|
35
|
+
type: "discoveryengine.googleapis.com/CustomTuningModel"
|
36
|
+
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}"
|
37
|
+
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}"
|
38
|
+
};
|
39
|
+
|
40
|
+
// The state of the model.
|
41
|
+
enum ModelState {
|
42
|
+
// Default value.
|
43
|
+
MODEL_STATE_UNSPECIFIED = 0;
|
44
|
+
|
45
|
+
// The model is in a paused training state.
|
46
|
+
TRAINING_PAUSED = 1;
|
47
|
+
|
48
|
+
// The model is currently training.
|
49
|
+
TRAINING = 2;
|
50
|
+
|
51
|
+
// The model has successfully completed training.
|
52
|
+
TRAINING_COMPLETE = 3;
|
53
|
+
|
54
|
+
// The model is ready for serving.
|
55
|
+
READY_FOR_SERVING = 4;
|
56
|
+
|
57
|
+
// The model training failed.
|
58
|
+
TRAINING_FAILED = 5;
|
59
|
+
}
|
60
|
+
|
61
|
+
// Required. The fully qualified resource name of the model.
|
62
|
+
//
|
63
|
+
// Format:
|
64
|
+
// `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`
|
65
|
+
// model must be an alpha-numerical string with limit of 40 characters.
|
66
|
+
string name = 1 [
|
67
|
+
(google.api.field_behavior) = REQUIRED,
|
68
|
+
(google.api.resource_reference) = {
|
69
|
+
type: "discoveryengine.googleapis.com/CustomTuningModel"
|
70
|
+
}
|
71
|
+
];
|
72
|
+
|
73
|
+
// The display name of the model.
|
74
|
+
string display_name = 2;
|
75
|
+
|
76
|
+
// The version of the model.
|
77
|
+
int64 model_version = 3;
|
78
|
+
|
79
|
+
// The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
|
80
|
+
ModelState model_state = 4;
|
81
|
+
|
82
|
+
// Timestamp the Model was created at.
|
83
|
+
google.protobuf.Timestamp create_time = 5;
|
84
|
+
|
85
|
+
// Timestamp the model training was initiated.
|
86
|
+
google.protobuf.Timestamp training_start_time = 6;
|
87
|
+
}
|
@@ -227,8 +227,8 @@ message ListDataStoresRequest {
|
|
227
227
|
// INVALID_ARGUMENT error is returned.
|
228
228
|
string page_token = 3;
|
229
229
|
|
230
|
-
// Filter by solution type.
|
231
|
-
// 'solution_type:SOLUTION_TYPE_SEARCH'
|
230
|
+
// Filter by solution type .
|
231
|
+
// For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`
|
232
232
|
string filter = 4;
|
233
233
|
}
|
234
234
|
|
@@ -81,6 +81,7 @@ message DocumentProcessingConfig {
|
|
81
81
|
|
82
82
|
// Map from file type to override the default parsing configuration based on
|
83
83
|
// the file type. Supported keys:
|
84
|
+
//
|
84
85
|
// * `pdf`: Override parsing config for PDF files, either digital parsing, ocr
|
85
86
|
// parsing or layout parsing is supported.
|
86
87
|
// * `html`: Override parsing config for HTML files, only digital parsing and
|
@@ -105,7 +105,7 @@ service DocumentService {
|
|
105
105
|
|
106
106
|
// Bulk import of multiple
|
107
107
|
// [Document][google.cloud.discoveryengine.v1beta.Document]s. Request
|
108
|
-
// processing may be synchronous. Non-existing items
|
108
|
+
// processing may be synchronous. Non-existing items are created.
|
109
109
|
//
|
110
110
|
// Note: It is possible for a subset of the
|
111
111
|
// [Document][google.cloud.discoveryengine.v1beta.Document]s to be
|
@@ -204,7 +204,7 @@ message ListDocumentsRequest {
|
|
204
204
|
|
205
205
|
// Maximum number of [Document][google.cloud.discoveryengine.v1beta.Document]s
|
206
206
|
// to return. If unspecified, defaults to 100. The maximum allowed value is
|
207
|
-
// 1000. Values above 1000
|
207
|
+
// 1000. Values above 1000 are set to 1000.
|
208
208
|
//
|
209
209
|
// If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
210
210
|
int32 page_size = 2;
|
@@ -254,8 +254,8 @@ message CreateDocumentRequest {
|
|
254
254
|
Document document = 2 [(google.api.field_behavior) = REQUIRED];
|
255
255
|
|
256
256
|
// Required. The ID to use for the
|
257
|
-
// [Document][google.cloud.discoveryengine.v1beta.Document], which
|
258
|
-
//
|
257
|
+
// [Document][google.cloud.discoveryengine.v1beta.Document], which becomes the
|
258
|
+
// final component of the
|
259
259
|
// [Document.name][google.cloud.discoveryengine.v1beta.Document.name].
|
260
260
|
//
|
261
261
|
// If the caller does not have permission to create the
|
@@ -289,14 +289,13 @@ message UpdateDocumentRequest {
|
|
289
289
|
// is not set, a `NOT_FOUND` error is returned.
|
290
290
|
Document document = 1 [(google.api.field_behavior) = REQUIRED];
|
291
291
|
|
292
|
-
// If set to true
|
292
|
+
// If set to `true` and the
|
293
293
|
// [Document][google.cloud.discoveryengine.v1beta.Document] is not found, a
|
294
|
-
// new [Document][google.cloud.discoveryengine.v1beta.Document]
|
295
|
-
// created.
|
294
|
+
// new [Document][google.cloud.discoveryengine.v1beta.Document] is be created.
|
296
295
|
bool allow_missing = 2;
|
297
296
|
|
298
297
|
// Indicates which fields in the provided imported 'document' to update. If
|
299
|
-
// not set,
|
298
|
+
// not set, by default updates all fields.
|
300
299
|
google.protobuf.FieldMask update_mask = 3;
|
301
300
|
}
|
302
301
|
|
@@ -118,9 +118,9 @@ message Engine {
|
|
118
118
|
|
119
119
|
// Common configurations for an Engine.
|
120
120
|
message CommonConfig {
|
121
|
-
//
|
122
|
-
//
|
123
|
-
string company_name = 1
|
121
|
+
// The name of the company, business or entity that is associated with the
|
122
|
+
// engine. Setting this may help improve LLM related features.
|
123
|
+
string company_name = 1;
|
124
124
|
}
|
125
125
|
|
126
126
|
// Additional information of a Chat Engine.
|
@@ -212,7 +212,7 @@ message Engine {
|
|
212
212
|
// The restriction of the Engine industry vertical is based on
|
213
213
|
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore]: If unspecified,
|
214
214
|
// default to `GENERIC`. Vertical on Engine has to match vertical of the
|
215
|
-
// DataStore
|
215
|
+
// DataStore linked to the engine.
|
216
216
|
IndustryVertical industry_vertical = 16;
|
217
217
|
|
218
218
|
// Common config spec that specifies the metadata of the engine.
|
@@ -69,7 +69,7 @@ message CheckGroundingRequest {
|
|
69
69
|
}
|
70
70
|
];
|
71
71
|
|
72
|
-
// Answer candidate to check.
|
72
|
+
// Answer candidate to check. Can have a maximum length of 1024 characters.
|
73
73
|
string answer_candidate = 2;
|
74
74
|
|
75
75
|
// List of facts for the grounding check.
|
@@ -78,6 +78,25 @@ message CheckGroundingRequest {
|
|
78
78
|
|
79
79
|
// Configuration of the grounding check.
|
80
80
|
CheckGroundingSpec grounding_spec = 4;
|
81
|
+
|
82
|
+
// The user labels applied to a resource must meet the following requirements:
|
83
|
+
//
|
84
|
+
// * Each resource can have multiple labels, up to a maximum of 64.
|
85
|
+
// * Each label must be a key-value pair.
|
86
|
+
// * Keys have a minimum length of 1 character and a maximum length of 63
|
87
|
+
// characters and cannot be empty. Values can be empty and have a maximum
|
88
|
+
// length of 63 characters.
|
89
|
+
// * Keys and values can contain only lowercase letters, numeric characters,
|
90
|
+
// underscores, and dashes. All characters must use UTF-8 encoding, and
|
91
|
+
// international characters are allowed.
|
92
|
+
// * The key portion of a label must be unique. However, you can use the same
|
93
|
+
// key with multiple resources.
|
94
|
+
// * Keys must start with a lowercase letter or international character.
|
95
|
+
//
|
96
|
+
// See [Google Cloud
|
97
|
+
// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
98
|
+
// for more details.
|
99
|
+
map<string, string> user_labels = 5;
|
81
100
|
}
|
82
101
|
|
83
102
|
// Response message for the
|
@@ -104,6 +123,16 @@ message CheckGroundingResponse {
|
|
104
123
|
// supporting for the claim. A citation to a fact indicates that the claim
|
105
124
|
// is supported by the fact.
|
106
125
|
repeated int32 citation_indices = 4;
|
126
|
+
|
127
|
+
// Indicates that this claim required grounding check. When the system
|
128
|
+
// decided this claim doesn't require attribution/grounding check, this
|
129
|
+
// field will be set to false. In that case, no grounding check was done for
|
130
|
+
// the claim and therefore
|
131
|
+
// [citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.citation_indices],
|
132
|
+
// and
|
133
|
+
// [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices]
|
134
|
+
// should not be returned.
|
135
|
+
optional bool grounding_check_required = 6;
|
107
136
|
}
|
108
137
|
|
109
138
|
// The support score for the input answer candidate.
|
@@ -50,6 +50,9 @@ message FactChunk {
|
|
50
50
|
// retrieved.
|
51
51
|
string source = 2;
|
52
52
|
|
53
|
+
// The index of this chunk. Currently, only used for the streaming mode.
|
54
|
+
int32 index = 4;
|
55
|
+
|
53
56
|
// More fine-grained information for the source reference.
|
54
57
|
map<string, string> source_metadata = 3;
|
55
58
|
}
|
@@ -37,7 +37,7 @@ option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
|
|
37
37
|
|
38
38
|
// Cloud Storage location for input content.
|
39
39
|
message GcsSource {
|
40
|
-
// Required. Cloud Storage URIs to input files. URI can be up to
|
40
|
+
// Required. Cloud Storage URIs to input files. Each URI can be up to
|
41
41
|
// 2000 characters long. URIs can match the full object path (for example,
|
42
42
|
// `gs://bucket/directory/object.json`) or a pattern matching one or more
|
43
43
|
// files, such as `gs://bucket/directory/*.json`.
|
@@ -67,7 +67,7 @@ message GcsSource {
|
|
67
67
|
// data store. Each entry after the header is imported as a Document.
|
68
68
|
// This can only be used by the GENERIC Data Store vertical.
|
69
69
|
//
|
70
|
-
// Supported values for user
|
70
|
+
// Supported values for user event imports:
|
71
71
|
//
|
72
72
|
// * `user_event` (default): One JSON
|
73
73
|
// [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] per line.
|
@@ -337,8 +337,8 @@ message FirestoreSource {
|
|
337
337
|
// of 256 characters.
|
338
338
|
string database_id = 2 [(google.api.field_behavior) = REQUIRED];
|
339
339
|
|
340
|
-
// Required. The Firestore collection to copy the data from with a
|
341
|
-
// limit of 1,500 characters.
|
340
|
+
// Required. The Firestore collection (or entity) to copy the data from with a
|
341
|
+
// length limit of 1,500 characters.
|
342
342
|
string collection_id = 3 [(google.api.field_behavior) = REQUIRED];
|
343
343
|
|
344
344
|
// Intermediate Cloud Storage directory used for the import with a length
|
@@ -0,0 +1,103 @@
|
|
1
|
+
// Copyright 2024 Google LLC
|
2
|
+
//
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
// you may not use this file except in compliance with the License.
|
5
|
+
// You may obtain a copy of the License at
|
6
|
+
//
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
//
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
// See the License for the specific language governing permissions and
|
13
|
+
// limitations under the License.
|
14
|
+
|
15
|
+
syntax = "proto3";
|
16
|
+
|
17
|
+
package google.cloud.discoveryengine.v1beta;
|
18
|
+
|
19
|
+
import "google/api/field_behavior.proto";
|
20
|
+
import "google/api/resource.proto";
|
21
|
+
import "google/protobuf/timestamp.proto";
|
22
|
+
|
23
|
+
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
|
24
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
|
25
|
+
option java_multiple_files = true;
|
26
|
+
option java_outer_classname = "ProjectProto";
|
27
|
+
option java_package = "com.google.cloud.discoveryengine.v1beta";
|
28
|
+
option objc_class_prefix = "DISCOVERYENGINE";
|
29
|
+
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
|
30
|
+
option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
|
31
|
+
|
32
|
+
// Metadata and configurations for a Google Cloud project in the service.
|
33
|
+
message Project {
|
34
|
+
option (google.api.resource) = {
|
35
|
+
type: "discoveryengine.googleapis.com/Project"
|
36
|
+
pattern: "projects/{project}"
|
37
|
+
};
|
38
|
+
|
39
|
+
// Metadata about the terms of service.
|
40
|
+
message ServiceTerms {
|
41
|
+
// The agreement states this terms of service.
|
42
|
+
enum State {
|
43
|
+
// The default value of the enum. This value is not actually used.
|
44
|
+
STATE_UNSPECIFIED = 0;
|
45
|
+
|
46
|
+
// The project has given consent to the terms of service.
|
47
|
+
TERMS_ACCEPTED = 1;
|
48
|
+
|
49
|
+
// The project is pending to review and accept the terms of service.
|
50
|
+
TERMS_PENDING = 2;
|
51
|
+
|
52
|
+
// The project has declined or revoked the agreement to terms of service.
|
53
|
+
TERMS_DECLINED = 3;
|
54
|
+
}
|
55
|
+
|
56
|
+
// The unique identifier of this terms of service.
|
57
|
+
// Available terms:
|
58
|
+
//
|
59
|
+
// * `GA_DATA_USE_TERMS`: [Terms for data
|
60
|
+
// use](https://cloud.google.com/retail/data-use-terms). When using this as
|
61
|
+
// `id`, the acceptable
|
62
|
+
// [version][google.cloud.discoveryengine.v1beta.Project.ServiceTerms.version]
|
63
|
+
// to provide is `2022-11-23`.
|
64
|
+
string id = 1;
|
65
|
+
|
66
|
+
// The version string of the terms of service.
|
67
|
+
// For acceptable values, see the comments for
|
68
|
+
// [id][google.cloud.discoveryengine.v1beta.Project.ServiceTerms.id] above.
|
69
|
+
string version = 2;
|
70
|
+
|
71
|
+
// Whether the project has accepted/rejected the service terms or it is
|
72
|
+
// still pending.
|
73
|
+
State state = 4;
|
74
|
+
|
75
|
+
// The last time when the project agreed to the terms of service.
|
76
|
+
google.protobuf.Timestamp accept_time = 5;
|
77
|
+
|
78
|
+
// The last time when the project declined or revoked the agreement to terms
|
79
|
+
// of service.
|
80
|
+
google.protobuf.Timestamp decline_time = 6;
|
81
|
+
}
|
82
|
+
|
83
|
+
// Output only. Full resource name of the project, for example
|
84
|
+
// `projects/{project_number}`.
|
85
|
+
// Note that when making requests, project number and project id are both
|
86
|
+
// acceptable, but the server will always respond in project number.
|
87
|
+
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
|
88
|
+
|
89
|
+
// Output only. The timestamp when this project is created.
|
90
|
+
google.protobuf.Timestamp create_time = 2
|
91
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
92
|
+
|
93
|
+
// Output only. The timestamp when this project is successfully provisioned.
|
94
|
+
// Empty value means this project is still provisioning and is not ready for
|
95
|
+
// use.
|
96
|
+
google.protobuf.Timestamp provision_completion_time = 3
|
97
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
98
|
+
|
99
|
+
// Output only. A map of terms of services. The key is the `id` of
|
100
|
+
// [ServiceTerms][google.cloud.discoveryengine.v1beta.Project.ServiceTerms].
|
101
|
+
map<string, ServiceTerms> service_terms_map = 4
|
102
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
103
|
+
}
|
@@ -0,0 +1,90 @@
|
|
1
|
+
// Copyright 2024 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/project.proto";
|
24
|
+
import "google/longrunning/operations.proto";
|
25
|
+
|
26
|
+
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
|
27
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
|
28
|
+
option java_multiple_files = true;
|
29
|
+
option java_outer_classname = "ProjectServiceProto";
|
30
|
+
option java_package = "com.google.cloud.discoveryengine.v1beta";
|
31
|
+
option objc_class_prefix = "DISCOVERYENGINE";
|
32
|
+
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
|
33
|
+
option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
|
34
|
+
|
35
|
+
// Service for operations on the
|
36
|
+
// [Project][google.cloud.discoveryengine.v1beta.Project].
|
37
|
+
service ProjectService {
|
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
|
+
// Provisions the project resource. During the
|
43
|
+
// process, related systems will get prepared and initialized.
|
44
|
+
//
|
45
|
+
// Caller must read the [Terms for data
|
46
|
+
// use](https://cloud.google.com/retail/data-use-terms), and optionally
|
47
|
+
// specify in request to provide consent to that service terms.
|
48
|
+
rpc ProvisionProject(ProvisionProjectRequest)
|
49
|
+
returns (google.longrunning.Operation) {
|
50
|
+
option (google.api.http) = {
|
51
|
+
post: "/v1beta/{name=projects/*}:provision"
|
52
|
+
body: "*"
|
53
|
+
};
|
54
|
+
option (google.api.method_signature) = "name";
|
55
|
+
option (google.longrunning.operation_info) = {
|
56
|
+
response_type: "google.cloud.discoveryengine.v1beta.Project"
|
57
|
+
metadata_type: "google.cloud.discoveryengine.v1beta.ProvisionProjectMetadata"
|
58
|
+
};
|
59
|
+
}
|
60
|
+
}
|
61
|
+
|
62
|
+
// Request for
|
63
|
+
// [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1beta.ProjectService.ProvisionProject]
|
64
|
+
// method.
|
65
|
+
message ProvisionProjectRequest {
|
66
|
+
// Required. Full resource name of a
|
67
|
+
// [Project][google.cloud.discoveryengine.v1beta.Project], such as
|
68
|
+
// `projects/{project_id_or_number}`.
|
69
|
+
string name = 1 [
|
70
|
+
(google.api.field_behavior) = REQUIRED,
|
71
|
+
(google.api.resource_reference) = {
|
72
|
+
type: "discoveryengine.googleapis.com/Project"
|
73
|
+
}
|
74
|
+
];
|
75
|
+
|
76
|
+
// Required. Set to `true` to specify that caller has read and would like to
|
77
|
+
// give consent to the [Terms for data
|
78
|
+
// use](https://cloud.google.com/retail/data-use-terms).
|
79
|
+
bool accept_data_use_terms = 2 [(google.api.field_behavior) = REQUIRED];
|
80
|
+
|
81
|
+
// Required. The version of the [Terms for data
|
82
|
+
// use](https://cloud.google.com/retail/data-use-terms) that caller has read
|
83
|
+
// and would like to give consent to.
|
84
|
+
//
|
85
|
+
// Acceptable version is `2022-11-23`, and this may change over time.
|
86
|
+
string data_use_terms_version = 3 [(google.api.field_behavior) = REQUIRED];
|
87
|
+
}
|
88
|
+
|
89
|
+
// Metadata associated with a project provision operation.
|
90
|
+
message ProvisionProjectMetadata {}
|
@@ -104,6 +104,25 @@ message RankRequest {
|
|
104
104
|
// If true, the response will contain only record ID and score. By default, it
|
105
105
|
// is false, the response will contain record details.
|
106
106
|
bool ignore_record_details_in_response = 6;
|
107
|
+
|
108
|
+
// The user labels applied to a resource must meet the following requirements:
|
109
|
+
//
|
110
|
+
// * Each resource can have multiple labels, up to a maximum of 64.
|
111
|
+
// * Each label must be a key-value pair.
|
112
|
+
// * Keys have a minimum length of 1 character and a maximum length of 63
|
113
|
+
// characters and cannot be empty. Values can be empty and have a maximum
|
114
|
+
// length of 63 characters.
|
115
|
+
// * Keys and values can contain only lowercase letters, numeric characters,
|
116
|
+
// underscores, and dashes. All characters must use UTF-8 encoding, and
|
117
|
+
// international characters are allowed.
|
118
|
+
// * The key portion of a label must be unique. However, you can use the same
|
119
|
+
// key with multiple resources.
|
120
|
+
// * Keys must start with a lowercase letter or international character.
|
121
|
+
//
|
122
|
+
// See [Google Cloud
|
123
|
+
// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
124
|
+
// for more details.
|
125
|
+
map<string, string> user_labels = 7;
|
107
126
|
}
|
108
127
|
|
109
128
|
// Response message for
|
@@ -64,7 +64,7 @@ message RecommendRequest {
|
|
64
64
|
// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
|
65
65
|
//
|
66
66
|
// One default serving config is created along with your recommendation engine
|
67
|
-
// creation. The engine ID
|
67
|
+
// creation. The engine ID is used as the ID of the default serving
|
68
68
|
// config. For example, for Engine
|
69
69
|
// `projects/*/locations/global/collections/*/engines/my-engine`, you can use
|
70
70
|
// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
|
@@ -97,9 +97,9 @@ message RecommendRequest {
|
|
97
97
|
UserEvent user_event = 2 [(google.api.field_behavior) = REQUIRED];
|
98
98
|
|
99
99
|
// Maximum number of results to return. Set this property
|
100
|
-
// to the number of recommendation results needed. If zero, the service
|
101
|
-
//
|
102
|
-
// above 100
|
100
|
+
// to the number of recommendation results needed. If zero, the service
|
101
|
+
// chooses a reasonable default. The maximum allowed value is 100. Values
|
102
|
+
// above 100 are set to 100.
|
103
103
|
int32 page_size = 3;
|
104
104
|
|
105
105
|
// Filter for restricting recommendation results with a length limit of 5,000
|
@@ -120,19 +120,19 @@ message RecommendRequest {
|
|
120
120
|
// * (available: true) AND
|
121
121
|
// (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
|
122
122
|
//
|
123
|
-
// If your filter blocks all results, the API
|
123
|
+
// If your filter blocks all results, the API returns generic
|
124
124
|
// (unfiltered) popular Documents. If you only want results strictly matching
|
125
|
-
// the filters, set `strictFiltering` to
|
125
|
+
// the filters, set `strictFiltering` to `true` in
|
126
126
|
// [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params]
|
127
127
|
// to receive empty results instead.
|
128
128
|
//
|
129
|
-
// Note that the API
|
129
|
+
// Note that the API never returns
|
130
130
|
// [Document][google.cloud.discoveryengine.v1beta.Document]s with
|
131
|
-
// `storageStatus`
|
131
|
+
// `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
|
132
132
|
string filter = 4;
|
133
133
|
|
134
|
-
// Use validate only mode for this recommendation query. If set to true
|
135
|
-
// fake model
|
134
|
+
// Use validate only mode for this recommendation query. If set to `true`, a
|
135
|
+
// fake model is used that returns arbitrary Document IDs.
|
136
136
|
// Note that the validate only mode should only be used for testing the API,
|
137
137
|
// or if the model is not ready.
|
138
138
|
bool validate_only = 5;
|
@@ -141,16 +141,17 @@ message RecommendRequest {
|
|
141
141
|
//
|
142
142
|
// Allowed values:
|
143
143
|
//
|
144
|
-
// * `returnDocument`: Boolean. If set to true
|
145
|
-
// object
|
144
|
+
// * `returnDocument`: Boolean. If set to `true`, the associated Document
|
145
|
+
// object is returned in
|
146
146
|
// [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
|
147
|
-
// * `returnScore`: Boolean. If set to true, the recommendation
|
148
|
-
// corresponding to each returned Document
|
147
|
+
// * `returnScore`: Boolean. If set to true, the recommendation score
|
148
|
+
// corresponding to each returned Document is set in
|
149
149
|
// [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
|
150
|
-
// The given
|
151
|
-
//
|
152
|
-
// * `strictFiltering`: Boolean. True by default. If set to false
|
153
|
-
//
|
150
|
+
// The given score indicates the probability of a Document conversion given
|
151
|
+
// the user's context and history.
|
152
|
+
// * `strictFiltering`: Boolean. True by default. If set to `false`, the
|
153
|
+
// service
|
154
|
+
// returns generic (unfiltered) popular Documents instead of empty if
|
154
155
|
// your filter blocks all recommendation results.
|
155
156
|
// * `diversityLevel`: String. Default empty. If set to be non-empty, then
|
156
157
|
// it needs to be one of:
|
@@ -198,7 +199,7 @@ message RecommendResponse {
|
|
198
199
|
// [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
|
199
200
|
Document document = 2;
|
200
201
|
|
201
|
-
// Additional Document metadata
|
202
|
+
// Additional Document metadata or annotations.
|
202
203
|
//
|
203
204
|
// Possible values:
|
204
205
|
//
|