@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
@@ -105,7 +105,7 @@ service DocumentService {
|
|
105
105
|
|
106
106
|
// Bulk import of multiple
|
107
107
|
// [Document][google.cloud.discoveryengine.v1alpha.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.v1alpha.Document]s to be
|
@@ -218,7 +218,7 @@ message ListDocumentsRequest {
|
|
218
218
|
// Maximum number of
|
219
219
|
// [Document][google.cloud.discoveryengine.v1alpha.Document]s to return. If
|
220
220
|
// unspecified, defaults to 100. The maximum allowed value is 1000. Values
|
221
|
-
// above 1000
|
221
|
+
// above 1000 are set to 1000.
|
222
222
|
//
|
223
223
|
// If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
224
224
|
int32 page_size = 2;
|
@@ -268,8 +268,8 @@ message CreateDocumentRequest {
|
|
268
268
|
Document document = 2 [(google.api.field_behavior) = REQUIRED];
|
269
269
|
|
270
270
|
// Required. The ID to use for the
|
271
|
-
// [Document][google.cloud.discoveryengine.v1alpha.Document], which
|
272
|
-
//
|
271
|
+
// [Document][google.cloud.discoveryengine.v1alpha.Document], which becomes
|
272
|
+
// the final component of the
|
273
273
|
// [Document.name][google.cloud.discoveryengine.v1alpha.Document.name].
|
274
274
|
//
|
275
275
|
// If the caller does not have permission to create the
|
@@ -303,14 +303,14 @@ message UpdateDocumentRequest {
|
|
303
303
|
// is not set, a `NOT_FOUND` error is returned.
|
304
304
|
Document document = 1 [(google.api.field_behavior) = REQUIRED];
|
305
305
|
|
306
|
-
// If set to true
|
306
|
+
// If set to `true` and the
|
307
307
|
// [Document][google.cloud.discoveryengine.v1alpha.Document] is not found, a
|
308
|
-
// new [Document][google.cloud.discoveryengine.v1alpha.Document]
|
308
|
+
// new [Document][google.cloud.discoveryengine.v1alpha.Document] is be
|
309
309
|
// created.
|
310
310
|
bool allow_missing = 2;
|
311
311
|
|
312
312
|
// Indicates which fields in the provided imported 'document' to update. If
|
313
|
-
// not set,
|
313
|
+
// not set, by default updates all fields.
|
314
314
|
google.protobuf.FieldMask update_mask = 3;
|
315
315
|
}
|
316
316
|
|
@@ -348,8 +348,11 @@ message GetProcessedDocumentRequest {
|
|
348
348
|
// Available for all data store parsing configs.
|
349
349
|
PARSED_DOCUMENT = 1;
|
350
350
|
|
351
|
-
// Only available if ChunkingConfig is
|
351
|
+
// Only available if ChunkingConfig is enabled on the data store.
|
352
352
|
CHUNKED_DOCUMENT = 2;
|
353
|
+
|
354
|
+
// Returns the converted PNG Image bytes if available.
|
355
|
+
PNG_CONVERTED_DOCUMENT = 3;
|
353
356
|
}
|
354
357
|
|
355
358
|
// The format of the returned processed document. If unspecified, defaults to
|
@@ -358,7 +361,7 @@ message GetProcessedDocumentRequest {
|
|
358
361
|
// Default value.
|
359
362
|
PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED = 0;
|
360
363
|
|
361
|
-
//
|
364
|
+
// Output format is a JSON string representation of processed document.
|
362
365
|
JSON = 1;
|
363
366
|
}
|
364
367
|
|
@@ -193,9 +193,9 @@ message Engine {
|
|
193
193
|
|
194
194
|
// Common configurations for an Engine.
|
195
195
|
message CommonConfig {
|
196
|
-
//
|
197
|
-
//
|
198
|
-
string company_name = 1
|
196
|
+
// The name of the company, business or entity that is associated with the
|
197
|
+
// engine. Setting this may help improve LLM related features.
|
198
|
+
string company_name = 1;
|
199
199
|
}
|
200
200
|
|
201
201
|
// Additional information of a recommendation engine.
|
@@ -367,7 +367,7 @@ message Engine {
|
|
367
367
|
// The restriction of the Engine industry vertical is based on
|
368
368
|
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]: If
|
369
369
|
// unspecified, default to `GENERIC`. Vertical on Engine has to match vertical
|
370
|
-
// of the DataStore
|
370
|
+
// of the DataStore linked to the engine.
|
371
371
|
IndustryVertical industry_vertical = 16;
|
372
372
|
|
373
373
|
// 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.v1alpha.CheckGroundingResponse.Claim.citation_indices],
|
132
|
+
// and
|
133
|
+
// [anti_citation_indices][google.cloud.discoveryengine.v1alpha.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::V1alpha";
|
|
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.v1alpha.UserEvent] per line.
|
@@ -338,8 +338,8 @@ message FirestoreSource {
|
|
338
338
|
// of 256 characters.
|
339
339
|
string database_id = 2 [(google.api.field_behavior) = REQUIRED];
|
340
340
|
|
341
|
-
// Required. The Firestore collection to copy the data from with a
|
342
|
-
// limit of 1,500 characters.
|
341
|
+
// Required. The Firestore collection (or entity) to copy the data from with a
|
342
|
+
// length limit of 1,500 characters.
|
343
343
|
string collection_id = 3 [(google.api.field_behavior) = REQUIRED];
|
344
344
|
|
345
345
|
// Intermediate Cloud Storage directory used for the import with a length
|
@@ -72,6 +72,7 @@ service ProjectService {
|
|
72
72
|
// This method can be used to retroactively accept the latest terms.
|
73
73
|
//
|
74
74
|
// Terms available for update:
|
75
|
+
//
|
75
76
|
// * [Terms for data use](https://cloud.google.com/retail/data-use-terms)
|
76
77
|
rpc ReportConsentChange(ReportConsentChangeRequest) returns (Project) {
|
77
78
|
option (google.api.http) = {
|
@@ -159,6 +160,7 @@ message ReportConsentChangeRequest {
|
|
159
160
|
|
160
161
|
// Required. The unique identifier of the terms of service to update.
|
161
162
|
// Available term ids:
|
163
|
+
//
|
162
164
|
// * `GA_DATA_USE_TERMS`: [Terms for data
|
163
165
|
// use](https://cloud.google.com/retail/data-use-terms). When using this
|
164
166
|
// service term id, the acceptable
|
@@ -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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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
|
//
|
@@ -84,10 +84,28 @@ message FieldConfig {
|
|
84
84
|
// Field value type is Boolean.
|
85
85
|
BOOLEAN = 5;
|
86
86
|
|
87
|
-
// Field value type is Geolocation.
|
87
|
+
// Field value type is Geolocation. Geolocation is expressed as an object
|
88
|
+
// with the following keys:
|
89
|
+
//
|
90
|
+
// * `id`: a string representing the location id
|
91
|
+
// * `longitude`: a number representing the longitude coordinate of the
|
92
|
+
// location
|
93
|
+
// * `latitude`: a number repesenting the latitude coordinate of the
|
94
|
+
// location
|
95
|
+
// * `address`: a string representing the full address of the location
|
96
|
+
//
|
97
|
+
// `latitude` and `longitude` must always be provided together. At least one
|
98
|
+
// of a) `address` or b) `latitude`-`longitude` pair must be provided.
|
88
99
|
GEOLOCATION = 6;
|
89
100
|
|
90
|
-
// Field value type is Datetime.
|
101
|
+
// Field value type is Datetime. Datetime can be expressed as either:
|
102
|
+
//
|
103
|
+
// * a number representing milliseconds-since-the-epoch
|
104
|
+
// * a string representing milliseconds-since-the-epoch. e.g.
|
105
|
+
// `"1420070400001"`
|
106
|
+
// * a string representing the [ISO
|
107
|
+
// 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g.
|
108
|
+
// `"2015-01-01"` or `"2015-01-01T12:10:30Z"`
|
91
109
|
DATETIME = 7;
|
92
110
|
}
|
93
111
|
|
@@ -173,6 +191,9 @@ message FieldConfig {
|
|
173
191
|
|
174
192
|
// Retrieve value from page map.
|
175
193
|
PAGEMAP = 2;
|
194
|
+
|
195
|
+
// Retrieve value from schema.org data.
|
196
|
+
SCHEMA_ORG = 4;
|
176
197
|
}
|
177
198
|
|
178
199
|
// Required. Field path of the schema field.
|
@@ -333,4 +354,18 @@ message FieldConfig {
|
|
333
354
|
// if this enum is set to METATAGS, we will only index `<author, a>`;
|
334
355
|
// if this enum is not set, we will merge them and index `<author, [a, b]>`.
|
335
356
|
repeated AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;
|
357
|
+
|
358
|
+
// Field paths for indexing custom attribute from schema.org data. More
|
359
|
+
// details of schema.org and its defined types can be found at
|
360
|
+
// [schema.org](https://schema.org).
|
361
|
+
//
|
362
|
+
// It is only used on advanced site search schema.
|
363
|
+
//
|
364
|
+
// Currently only support full path from root. The full path to a field is
|
365
|
+
// constructed by concatenating field names, starting from `_root`, with
|
366
|
+
// a period `.` as the delimiter. Examples:
|
367
|
+
//
|
368
|
+
// * Publish date of the root: _root.datePublished
|
369
|
+
// * Publish date of the reviews: _root.review.datePublished
|
370
|
+
repeated string schema_org_paths = 11;
|
336
371
|
}
|
@@ -143,9 +143,9 @@ message ListSchemasRequest {
|
|
143
143
|
// service may return fewer than this value.
|
144
144
|
//
|
145
145
|
// If unspecified, at most 100
|
146
|
-
// [Schema][google.cloud.discoveryengine.v1alpha.Schema]s
|
146
|
+
// [Schema][google.cloud.discoveryengine.v1alpha.Schema]s are returned.
|
147
147
|
//
|
148
|
-
// The maximum value is 1000; values above 1000
|
148
|
+
// The maximum value is 1000; values above 1000 are set to 1000.
|
149
149
|
int32 page_size = 2;
|
150
150
|
|
151
151
|
// A page token, received from a previous
|
@@ -190,8 +190,8 @@ message CreateSchemaRequest {
|
|
190
190
|
Schema schema = 2 [(google.api.field_behavior) = REQUIRED];
|
191
191
|
|
192
192
|
// Required. The ID to use for the
|
193
|
-
// [Schema][google.cloud.discoveryengine.v1alpha.Schema], which
|
194
|
-
//
|
193
|
+
// [Schema][google.cloud.discoveryengine.v1alpha.Schema], which becomes the
|
194
|
+
// final component of the
|
195
195
|
// [Schema.name][google.cloud.discoveryengine.v1alpha.Schema.name].
|
196
196
|
//
|
197
197
|
// This field should conform to
|
@@ -210,8 +210,8 @@ message UpdateSchemaRequest {
|
|
210
210
|
|
211
211
|
// If set to true, and the
|
212
212
|
// [Schema][google.cloud.discoveryengine.v1alpha.Schema] is not found, a new
|
213
|
-
// [Schema][google.cloud.discoveryengine.v1alpha.Schema]
|
214
|
-
//
|
213
|
+
// [Schema][google.cloud.discoveryengine.v1alpha.Schema] is created. In this
|
214
|
+
// situation, `update_mask` is ignored.
|
215
215
|
bool allow_missing = 3;
|
216
216
|
}
|
217
217
|
|
@@ -70,7 +70,9 @@ message SearchRequest {
|
|
70
70
|
}
|
71
71
|
}
|
72
72
|
|
73
|
-
// A struct to define data stores to filter on in a search call
|
73
|
+
// A struct to define data stores to filter on in a search call and
|
74
|
+
// configurations for those data stores. A maximum of 1 DataStoreSpec per
|
75
|
+
// data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
74
76
|
message DataStoreSpec {
|
75
77
|
// Required. Full resource name of
|
76
78
|
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], such as
|
@@ -112,7 +114,7 @@ message SearchRequest {
|
|
112
114
|
// Only supported on textual fields. Maximum is 10.
|
113
115
|
repeated string prefixes = 4;
|
114
116
|
|
115
|
-
// Only get facet values that
|
117
|
+
// Only get facet values that contain the given strings. For example,
|
116
118
|
// suppose "category" has three values "Action > 2022",
|
117
119
|
// "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
|
118
120
|
// "category" facet only contains "Action > 2022" and "Sci-Fi > 2022".
|
@@ -146,7 +148,7 @@ message SearchRequest {
|
|
146
148
|
// Required. The facet key specification.
|
147
149
|
FacetKey facet_key = 1 [(google.api.field_behavior) = REQUIRED];
|
148
150
|
|
149
|
-
// Maximum
|
151
|
+
// Maximum facet values that are returned for this facet. If
|
150
152
|
// unspecified, defaults to 20. The maximum allowed value is 300. Values
|
151
153
|
// above 300 are coerced to 300.
|
152
154
|
//
|
@@ -256,7 +258,7 @@ message SearchRequest {
|
|
256
258
|
// specified. The value must be formatted as an XSD `dayTimeDuration`
|
257
259
|
// value (a restricted subset of an ISO 8601 duration value). The
|
258
260
|
// pattern for this is: `[nD][T[nH][nM][nS]]`.
|
259
|
-
//
|
261
|
+
// For example, `5D`, `3DT12H30M`, `T24H`.
|
260
262
|
FRESHNESS = 2;
|
261
263
|
}
|
262
264
|
|
@@ -375,10 +377,10 @@ message SearchRequest {
|
|
375
377
|
// [Mode.AUTO][google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
|
376
378
|
MODE_UNSPECIFIED = 0;
|
377
379
|
|
378
|
-
// Search API
|
379
|
-
//
|
380
|
+
// Search API tries to find a spelling suggestion. If a suggestion is
|
381
|
+
// found, it is put in the
|
380
382
|
// [SearchResponse.corrected_query][google.cloud.discoveryengine.v1alpha.SearchResponse.corrected_query].
|
381
|
-
// The
|
383
|
+
// The spelling suggestion won't be used as the search query.
|
382
384
|
SUGGESTION_ONLY = 1;
|
383
385
|
|
384
386
|
// Automatic spell correction built by the Search API. Search will
|
@@ -386,8 +388,8 @@ message SearchRequest {
|
|
386
388
|
AUTO = 2;
|
387
389
|
}
|
388
390
|
|
389
|
-
// The mode under which spell correction
|
390
|
-
//
|
391
|
+
// The mode under which spell correction
|
392
|
+
// replaces the original search query. Defaults to
|
391
393
|
// [Mode.AUTO][google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
|
392
394
|
Mode mode = 1;
|
393
395
|
}
|
@@ -587,11 +589,7 @@ message SearchRequest {
|
|
587
589
|
}
|
588
590
|
|
589
591
|
// Specifies the search result mode. If unspecified, the
|
590
|
-
// search result mode
|
591
|
-
// [DataStore.DocumentProcessingConfig.chunking_config][]:
|
592
|
-
// * If [DataStore.DocumentProcessingConfig.chunking_config][] is specified,
|
593
|
-
// it defaults to `CHUNKS`.
|
594
|
-
// * Otherwise, it defaults to `DOCUMENTS`.
|
592
|
+
// search result mode defaults to `DOCUMENTS`.
|
595
593
|
enum SearchResultMode {
|
596
594
|
// Default value.
|
597
595
|
SEARCH_RESULT_MODE_UNSPECIFIED = 0;
|
@@ -617,11 +615,7 @@ message SearchRequest {
|
|
617
615
|
ExtractiveContentSpec extractive_content_spec = 3;
|
618
616
|
|
619
617
|
// Specifies the search result mode. If unspecified, the
|
620
|
-
// search result mode
|
621
|
-
// [DataStore.DocumentProcessingConfig.chunking_config][]:
|
622
|
-
// * If [DataStore.DocumentProcessingConfig.chunking_config][] is specified,
|
623
|
-
// it defaults to `CHUNKS`.
|
624
|
-
// * Otherwise, it defaults to `DOCUMENTS`.
|
618
|
+
// search result mode defaults to `DOCUMENTS`.
|
625
619
|
SearchResultMode search_result_mode = 4;
|
626
620
|
|
627
621
|
// Specifies the chunk spec to be returned from the search response.
|
@@ -708,7 +702,10 @@ message SearchRequest {
|
|
708
702
|
// If this field is negative, an `INVALID_ARGUMENT` is returned.
|
709
703
|
int32 offset = 6;
|
710
704
|
|
711
|
-
//
|
705
|
+
// Specs defining dataStores to filter on in a search call and configurations
|
706
|
+
// for those dataStores. This is only considered for engines with multiple
|
707
|
+
// dataStores use case. For single dataStore within an engine, they should
|
708
|
+
// use the specs at the top level.
|
712
709
|
repeated DataStoreSpec data_store_specs = 32;
|
713
710
|
|
714
711
|
// The filter syntax consists of an expression language for constructing a
|
@@ -745,7 +742,9 @@ message SearchRequest {
|
|
745
742
|
// The order in which documents are returned. Documents can be ordered by
|
746
743
|
// a field in an [Document][google.cloud.discoveryengine.v1alpha.Document]
|
747
744
|
// object. Leave it unset if ordered by relevance. `order_by` expression is
|
748
|
-
// case-sensitive.
|
745
|
+
// case-sensitive.
|
746
|
+
//
|
747
|
+
// For more information on ordering for retail search, see
|
749
748
|
// [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
|
750
749
|
//
|
751
750
|
// If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
@@ -765,7 +764,7 @@ message SearchRequest {
|
|
765
764
|
|
766
765
|
// Boost specification to boost certain documents.
|
767
766
|
// For more information on boosting, see
|
768
|
-
// [Boosting](https://cloud.google.com/
|
767
|
+
// [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
|
769
768
|
BoostSpec boost_spec = 10;
|
770
769
|
|
771
770
|
// Additional search parameters.
|
@@ -774,8 +773,7 @@ message SearchRequest {
|
|
774
773
|
//
|
775
774
|
// * `user_country_code`: string. Default empty. If set to non-empty, results
|
776
775
|
// are restricted or boosted based on the location provided.
|
777
|
-
//
|
778
|
-
// user_country_code: "au"
|
776
|
+
// For example, `user_country_code: "au"`
|
779
777
|
//
|
780
778
|
// For available codes see [Country
|
781
779
|
// Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
|
@@ -783,8 +781,7 @@ message SearchRequest {
|
|
783
781
|
// * `search_type`: double. Default empty. Enables non-webpage searching
|
784
782
|
// depending on the value. The only valid non-default value is 1,
|
785
783
|
// which enables image searching.
|
786
|
-
//
|
787
|
-
// search_type: 1
|
784
|
+
// For example, `search_type: 1`
|
788
785
|
map<string, google.protobuf.Value> params = 11;
|
789
786
|
|
790
787
|
// The query expansion specification that specifies the conditions under which
|
@@ -886,7 +883,7 @@ message SearchResponse {
|
|
886
883
|
string id = 1;
|
887
884
|
|
888
885
|
// The document data snippet in the search response. Only fields that are
|
889
|
-
// marked as retrievable are populated.
|
886
|
+
// marked as `retrievable` are populated.
|
890
887
|
Document document = 2;
|
891
888
|
|
892
889
|
// The chunk data in the search response if the
|
@@ -918,7 +915,7 @@ message SearchResponse {
|
|
918
915
|
int64 count = 3;
|
919
916
|
}
|
920
917
|
|
921
|
-
// The key for this facet.
|
918
|
+
// The key for this facet. For example, `"colors"` or `"price"`. It matches
|
922
919
|
// [SearchRequest.FacetSpec.FacetKey.key][google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.key].
|
923
920
|
string key = 1;
|
924
921
|
|
@@ -934,10 +931,10 @@ message SearchResponse {
|
|
934
931
|
message GuidedSearchResult {
|
935
932
|
// Useful attribute for search result refinements.
|
936
933
|
message RefinementAttribute {
|
937
|
-
// Attribute key used to refine the results
|
934
|
+
// Attribute key used to refine the results. For example, `"movie_type"`.
|
938
935
|
string attribute_key = 1;
|
939
936
|
|
940
|
-
// Attribute value used to refine the results
|
937
|
+
// Attribute value used to refine the results. For example, `"drama"`.
|
941
938
|
string attribute_value = 2;
|
942
939
|
}
|
943
940
|
|
@@ -948,7 +945,7 @@ message SearchResponse {
|
|
948
945
|
repeated string follow_up_questions = 2;
|
949
946
|
}
|
950
947
|
|
951
|
-
// Summary of the top N search
|
948
|
+
// Summary of the top N search results specified by the summary spec.
|
952
949
|
message Summary {
|
953
950
|
// Safety Attribute categories and their associated confidence scores.
|
954
951
|
message SafetyAttributes {
|
@@ -20,6 +20,7 @@ import "google/api/annotations.proto";
|
|
20
20
|
import "google/api/client.proto";
|
21
21
|
import "google/api/field_behavior.proto";
|
22
22
|
import "google/api/resource.proto";
|
23
|
+
import "google/cloud/discoveryengine/v1alpha/custom_tuning_model.proto";
|
23
24
|
import "google/cloud/discoveryengine/v1alpha/import_config.proto";
|
24
25
|
import "google/longrunning/operations.proto";
|
25
26
|
import "google/protobuf/timestamp.proto";
|
@@ -52,6 +53,38 @@ service SearchTuningService {
|
|
52
53
|
metadata_type: "google.cloud.discoveryengine.v1alpha.TrainCustomModelMetadata"
|
53
54
|
};
|
54
55
|
}
|
56
|
+
|
57
|
+
// Gets a list of all the custom models.
|
58
|
+
rpc ListCustomModels(ListCustomModelsRequest)
|
59
|
+
returns (ListCustomModelsResponse) {
|
60
|
+
option (google.api.http) = {
|
61
|
+
get: "/v1alpha/{data_store=projects/*/locations/*/collections/*/dataStores/*}/customModels"
|
62
|
+
};
|
63
|
+
}
|
64
|
+
}
|
65
|
+
|
66
|
+
// Request message for
|
67
|
+
// [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels]
|
68
|
+
// method.
|
69
|
+
message ListCustomModelsRequest {
|
70
|
+
// Required. The resource name of the parent Data Store, such as
|
71
|
+
// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
|
72
|
+
// This field is used to identify the data store where to fetch the models
|
73
|
+
// from.
|
74
|
+
string data_store = 1 [
|
75
|
+
(google.api.field_behavior) = REQUIRED,
|
76
|
+
(google.api.resource_reference) = {
|
77
|
+
type: "discoveryengine.googleapis.com/DataStore"
|
78
|
+
}
|
79
|
+
];
|
80
|
+
}
|
81
|
+
|
82
|
+
// Response message for
|
83
|
+
// [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels]
|
84
|
+
// method.
|
85
|
+
message ListCustomModelsResponse {
|
86
|
+
// List of custom tuning models.
|
87
|
+
repeated CustomTuningModel models = 1;
|
55
88
|
}
|
56
89
|
|
57
90
|
// Request message for
|
@@ -118,6 +151,9 @@ message TrainCustomModelRequest {
|
|
118
151
|
// The desired location of errors incurred during the data ingestion and
|
119
152
|
// training.
|
120
153
|
ImportErrorConfig error_config = 4;
|
154
|
+
|
155
|
+
// If not provided, a UUID will be generated.
|
156
|
+
string model_id = 5;
|
121
157
|
}
|
122
158
|
|
123
159
|
// Response of the
|
@@ -143,6 +179,9 @@ message TrainCustomModelResponse {
|
|
143
179
|
|
144
180
|
// The metrics of the trained model.
|
145
181
|
map<string, double> metrics = 4;
|
182
|
+
|
183
|
+
// Fully qualified name of the CustomTuningModel.
|
184
|
+
string model_name = 5;
|
146
185
|
}
|
147
186
|
|
148
187
|
// Metadata related to the progress of the TrainCustomModel operation. This is
|