@google-cloud/discoveryengine 1.3.1 → 1.4.1
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGELOG.md +14 -0
- package/README.md +64 -0
- package/build/protos/google/cloud/discoveryengine/v1/common.proto +54 -3
- package/build/protos/google/cloud/discoveryengine/v1/completion.proto +52 -0
- package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +51 -4
- package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +40 -1
- package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +98 -0
- package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +304 -0
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1/engine.proto +215 -0
- package/build/protos/google/cloud/discoveryengine/v1/engine_service.proto +242 -0
- package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +64 -0
- package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +38 -0
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +137 -4
- package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +170 -0
- package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +691 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +3 -3
- package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config.proto +49 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config_service.proto +79 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +72 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/chunk_service.proto +137 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +77 -4
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion.proto +52 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +44 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +6 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +44 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +80 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +83 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +127 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +6 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +13 -8
- package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +3 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/estimate_billing_service.proto +130 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +64 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +66 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +3 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +74 -13
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +24 -20
- package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config.proto +271 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config_service.proto +147 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +9 -3
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +7 -4
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +4 -3
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +59 -8
- package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +52 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +51 -4
- package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +45 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +120 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +306 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +10 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +94 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/engine.proto +220 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/engine_service.proto +244 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +64 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +41 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +26 -3
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +169 -15
- package/build/protos/google/cloud/discoveryengine/v1beta/search_tuning_service.proto +151 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +265 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto +148 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine.proto +170 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine_service.proto +695 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -3
- package/build/protos/protos.d.ts +48530 -23682
- package/build/protos/protos.js +122429 -63306
- package/build/protos/protos.json +13438 -7286
- package/build/src/index.d.ts +10 -1
- package/build/src/index.js +10 -1
- package/build/src/v1/completion_service_client.d.ts +489 -7
- package/build/src/v1/completion_service_client.js +715 -11
- package/build/src/v1/completion_service_client_config.json +10 -0
- package/build/src/v1/conversational_search_service_client.d.ts +341 -3
- package/build/src/v1/conversational_search_service_client.js +466 -9
- package/build/src/v1/data_store_service_client.d.ts +1286 -0
- package/build/src/v1/data_store_service_client.js +1768 -0
- package/build/src/v1/data_store_service_client_config.json +46 -0
- package/build/src/v1/document_service_client.d.ts +347 -2
- package/build/src/v1/document_service_client.js +506 -9
- package/build/src/v1/engine_service_client.d.ts +1211 -0
- package/build/src/v1/engine_service_client.js +1731 -0
- package/build/src/v1/engine_service_client_config.json +46 -0
- package/build/src/v1/index.d.ts +3 -0
- package/build/src/v1/index.js +7 -1
- package/build/src/v1/schema_service_client.d.ts +272 -2
- package/build/src/v1/schema_service_client.js +402 -9
- package/build/src/v1/search_service_client.d.ts +515 -11
- package/build/src/v1/search_service_client.js +648 -15
- package/build/src/v1/site_search_engine_service_client.d.ts +1564 -0
- package/build/src/v1/site_search_engine_service_client.js +2075 -0
- package/build/src/v1/site_search_engine_service_client_config.json +74 -0
- package/build/src/v1/user_event_service_client.d.ts +272 -2
- package/build/src/v1/user_event_service_client.js +402 -9
- package/build/src/v1alpha/acl_config_service_client.d.ts +1233 -0
- package/build/src/v1alpha/acl_config_service_client.js +1765 -0
- package/build/src/v1alpha/acl_config_service_client_config.json +34 -0
- package/build/src/v1alpha/chunk_service_client.d.ts +1350 -0
- package/build/src/v1alpha/chunk_service_client.js +1886 -0
- package/build/src/v1alpha/chunk_service_client_config.json +34 -0
- package/build/src/v1alpha/completion_service_client.d.ts +599 -5
- package/build/src/v1alpha/completion_service_client.js +868 -12
- package/build/src/v1alpha/completion_service_client_config.json +10 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +244 -3
- package/build/src/v1alpha/conversational_search_service_client.js +353 -10
- package/build/src/v1alpha/data_store_service_client.d.ts +462 -5
- package/build/src/v1alpha/data_store_service_client.js +599 -12
- package/build/src/v1alpha/data_store_service_client_config.json +8 -0
- package/build/src/v1alpha/document_service_client.d.ts +393 -2
- package/build/src/v1alpha/document_service_client.js +551 -10
- package/build/src/v1alpha/engine_service_client.d.ts +386 -4
- package/build/src/v1alpha/engine_service_client.js +551 -10
- package/build/src/v1alpha/estimate_billing_service_client.d.ts +1367 -0
- package/build/src/v1alpha/estimate_billing_service_client.js +2028 -0
- package/build/src/v1alpha/estimate_billing_service_client_config.json +30 -0
- package/build/src/v1alpha/index.d.ts +4 -0
- package/build/src/v1alpha/index.js +10 -2
- package/build/src/v1alpha/recommendation_service_client.d.ts +242 -3
- package/build/src/v1alpha/recommendation_service_client.js +353 -10
- package/build/src/v1alpha/schema_service_client.d.ts +383 -2
- package/build/src/v1alpha/schema_service_client.js +551 -10
- package/build/src/v1alpha/search_service_client.d.ts +269 -17
- package/build/src/v1alpha/search_service_client.js +373 -20
- package/build/src/v1alpha/search_tuning_service_client.d.ts +384 -3
- package/build/src/v1alpha/search_tuning_service_client.js +551 -10
- package/build/src/v1alpha/serving_config_service_client.d.ts +1369 -0
- package/build/src/v1alpha/serving_config_service_client.js +1935 -0
- package/build/src/v1alpha/serving_config_service_client_config.json +38 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +383 -2
- package/build/src/v1alpha/site_search_engine_service_client.js +551 -10
- package/build/src/v1alpha/user_event_service_client.d.ts +383 -2
- package/build/src/v1alpha/user_event_service_client.js +551 -10
- package/build/src/v1beta/completion_service_client.d.ts +708 -7
- package/build/src/v1beta/completion_service_client.js +1015 -11
- package/build/src/v1beta/completion_service_client_config.json +10 -0
- package/build/src/v1beta/conversational_search_service_client.d.ts +420 -3
- package/build/src/v1beta/conversational_search_service_client.js +570 -9
- package/build/src/v1beta/data_store_service_client.d.ts +1508 -0
- package/build/src/v1beta/data_store_service_client.js +2070 -0
- package/build/src/v1beta/data_store_service_client_config.json +46 -0
- package/build/src/v1beta/document_service_client.d.ts +566 -2
- package/build/src/v1beta/document_service_client.js +810 -11
- package/build/src/v1beta/engine_service_client.d.ts +1432 -0
- package/build/src/v1beta/engine_service_client.js +2032 -0
- package/build/src/v1beta/engine_service_client_config.json +46 -0
- package/build/src/v1beta/index.d.ts +5 -0
- package/build/src/v1beta/index.js +11 -1
- package/build/src/v1beta/recommendation_service_client.d.ts +495 -5
- package/build/src/v1beta/recommendation_service_client.js +674 -9
- package/build/src/v1beta/schema_service_client.d.ts +491 -2
- package/build/src/v1beta/schema_service_client.js +706 -11
- package/build/src/v1beta/search_service_client.d.ts +620 -29
- package/build/src/v1beta/search_service_client.js +772 -27
- package/build/src/v1beta/search_tuning_service_client.d.ts +1196 -0
- package/build/src/v1beta/search_tuning_service_client.js +1781 -0
- package/build/src/v1beta/search_tuning_service_client_config.json +30 -0
- package/build/src/v1beta/serving_config_service_client.d.ts +1217 -0
- package/build/src/v1beta/serving_config_service_client.js +1724 -0
- package/build/src/v1beta/serving_config_service_client_config.json +38 -0
- package/build/src/v1beta/site_search_engine_service_client.d.ts +1787 -0
- package/build/src/v1beta/site_search_engine_service_client.js +2375 -0
- package/build/src/v1beta/site_search_engine_service_client_config.json +74 -0
- package/build/src/v1beta/user_event_service_client.d.ts +491 -2
- package/build/src/v1beta/user_event_service_client.js +706 -11
- package/package.json +3 -3
@@ -21,6 +21,7 @@ import "google/api/client.proto";
|
|
21
21
|
import "google/api/field_behavior.proto";
|
22
22
|
import "google/api/resource.proto";
|
23
23
|
import "google/cloud/discoveryengine/v1alpha/data_store.proto";
|
24
|
+
import "google/cloud/discoveryengine/v1alpha/document_processing_config.proto";
|
24
25
|
import "google/longrunning/operations.proto";
|
25
26
|
import "google/protobuf/empty.proto";
|
26
27
|
import "google/protobuf/field_mask.proto";
|
@@ -117,6 +118,41 @@ service DataStoreService {
|
|
117
118
|
};
|
118
119
|
option (google.api.method_signature) = "data_store,update_mask";
|
119
120
|
}
|
121
|
+
|
122
|
+
// Gets a
|
123
|
+
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig].
|
124
|
+
rpc GetDocumentProcessingConfig(GetDocumentProcessingConfigRequest)
|
125
|
+
returns (DocumentProcessingConfig) {
|
126
|
+
option (google.api.http) = {
|
127
|
+
get: "/v1alpha/{name=projects/*/locations/*/dataStores/*/documentProcessingConfig}"
|
128
|
+
additional_bindings {
|
129
|
+
get: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig}"
|
130
|
+
}
|
131
|
+
};
|
132
|
+
option (google.api.method_signature) = "name";
|
133
|
+
}
|
134
|
+
|
135
|
+
// Updates the
|
136
|
+
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig].
|
137
|
+
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]
|
138
|
+
// is a singleon resource of
|
139
|
+
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. It's empty
|
140
|
+
// when [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] is
|
141
|
+
// created. The first call to this method will set up
|
142
|
+
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig].
|
143
|
+
rpc UpdateDocumentProcessingConfig(UpdateDocumentProcessingConfigRequest)
|
144
|
+
returns (DocumentProcessingConfig) {
|
145
|
+
option (google.api.http) = {
|
146
|
+
patch: "/v1alpha/{document_processing_config.name=projects/*/locations/*/dataStores/*/documentProcessingConfig}"
|
147
|
+
body: "document_processing_config"
|
148
|
+
additional_bindings {
|
149
|
+
patch: "/v1alpha/{document_processing_config.name=projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig}"
|
150
|
+
body: "document_processing_config"
|
151
|
+
}
|
152
|
+
};
|
153
|
+
option (google.api.method_signature) =
|
154
|
+
"document_processing_config,update_mask";
|
155
|
+
}
|
120
156
|
}
|
121
157
|
|
122
158
|
// Request for
|
@@ -198,7 +234,8 @@ message ListDataStoresRequest {
|
|
198
234
|
// Required. The parent branch resource name, such as
|
199
235
|
// `projects/{project}/locations/{location}/collections/{collection_id}`.
|
200
236
|
//
|
201
|
-
// If the caller does not have permission to list
|
237
|
+
// If the caller does not have permission to list
|
238
|
+
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s under this
|
202
239
|
// location, regardless of whether or not this data store exists, a
|
203
240
|
// PERMISSION_DENIED error is returned.
|
204
241
|
string parent = 1 [
|
@@ -305,3 +342,45 @@ message DeleteDataStoreMetadata {
|
|
305
342
|
// finish time.
|
306
343
|
google.protobuf.Timestamp update_time = 2;
|
307
344
|
}
|
345
|
+
|
346
|
+
// Request for
|
347
|
+
// [DataStoreService.GetDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDocumentProcessingConfig]
|
348
|
+
// method.
|
349
|
+
message GetDocumentProcessingConfigRequest {
|
350
|
+
// Required. Full DocumentProcessingConfig resource name. Format:
|
351
|
+
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig`
|
352
|
+
string name = 1 [
|
353
|
+
(google.api.field_behavior) = REQUIRED,
|
354
|
+
(google.api.resource_reference) = {
|
355
|
+
type: "discoveryengine.googleapis.com/DocumentProcessingConfig"
|
356
|
+
}
|
357
|
+
];
|
358
|
+
}
|
359
|
+
|
360
|
+
// Request for
|
361
|
+
// [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig]
|
362
|
+
// method.
|
363
|
+
message UpdateDocumentProcessingConfigRequest {
|
364
|
+
// Required. The
|
365
|
+
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]
|
366
|
+
// to update.
|
367
|
+
//
|
368
|
+
// If the caller does not have permission to update the
|
369
|
+
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig],
|
370
|
+
// then a PERMISSION_DENIED error is returned.
|
371
|
+
//
|
372
|
+
// If the
|
373
|
+
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]
|
374
|
+
// to update does not exist, a NOT_FOUND error is returned.
|
375
|
+
DocumentProcessingConfig document_processing_config = 1
|
376
|
+
[(google.api.field_behavior) = REQUIRED];
|
377
|
+
|
378
|
+
// Indicates which fields in the provided
|
379
|
+
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]
|
380
|
+
// to update. The following are the only supported fields:
|
381
|
+
//
|
382
|
+
// * [DocumentProcessingConfig.ocr_config][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ocr_config]
|
383
|
+
//
|
384
|
+
// If not set, all supported fields are updated.
|
385
|
+
google.protobuf.FieldMask update_mask = 2;
|
386
|
+
}
|
@@ -18,7 +18,9 @@ package google.cloud.discoveryengine.v1alpha;
|
|
18
18
|
|
19
19
|
import "google/api/field_behavior.proto";
|
20
20
|
import "google/api/resource.proto";
|
21
|
+
import "google/cloud/discoveryengine/v1alpha/common.proto";
|
21
22
|
import "google/protobuf/struct.proto";
|
23
|
+
import "google/protobuf/timestamp.proto";
|
22
24
|
|
23
25
|
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
|
24
26
|
option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
|
@@ -69,6 +71,76 @@ message Document {
|
|
69
71
|
string mime_type = 1;
|
70
72
|
}
|
71
73
|
|
74
|
+
// ACL Information of the Document.
|
75
|
+
message AclInfo {
|
76
|
+
// AclRestriction to model complex inheritance restrictions.
|
77
|
+
//
|
78
|
+
// Example: Modeling a "Both Permit" inheritance, where to access a
|
79
|
+
// child document, user needs to have access to parent document.
|
80
|
+
//
|
81
|
+
// Document Hierarchy - Space_S --> Page_P.
|
82
|
+
//
|
83
|
+
// Readers:
|
84
|
+
// Space_S: group_1, user_1
|
85
|
+
// Page_P: group_2, group_3, user_2
|
86
|
+
//
|
87
|
+
// Space_S ACL Restriction -
|
88
|
+
// {
|
89
|
+
// "acl_info": {
|
90
|
+
// "readers": [
|
91
|
+
// {
|
92
|
+
// "principals": [
|
93
|
+
// {
|
94
|
+
// "group_id": "group_1"
|
95
|
+
// },
|
96
|
+
// {
|
97
|
+
// "user_id": "user_1"
|
98
|
+
// }
|
99
|
+
// ]
|
100
|
+
// }
|
101
|
+
// ]
|
102
|
+
// }
|
103
|
+
// }
|
104
|
+
//
|
105
|
+
// Page_P ACL Restriction.
|
106
|
+
// {
|
107
|
+
// "acl_info": {
|
108
|
+
// "readers": [
|
109
|
+
// {
|
110
|
+
// "principals": [
|
111
|
+
// {
|
112
|
+
// "group_id": "group_2"
|
113
|
+
// },
|
114
|
+
// {
|
115
|
+
// "group_id": "group_3"
|
116
|
+
// },
|
117
|
+
// {
|
118
|
+
// "user_id": "user_2"
|
119
|
+
// }
|
120
|
+
// ],
|
121
|
+
// },
|
122
|
+
// {
|
123
|
+
// "principals": [
|
124
|
+
// {
|
125
|
+
// "group_id": "group_1"
|
126
|
+
// },
|
127
|
+
// {
|
128
|
+
// "user_id": "user_1"
|
129
|
+
// }
|
130
|
+
// ],
|
131
|
+
// }
|
132
|
+
// ]
|
133
|
+
// }
|
134
|
+
// }
|
135
|
+
message AccessRestriction {
|
136
|
+
// List of principals.
|
137
|
+
repeated Principal principals = 1;
|
138
|
+
}
|
139
|
+
|
140
|
+
// Readers of the document.
|
141
|
+
repeated AccessRestriction readers = 1;
|
142
|
+
}
|
143
|
+
|
72
144
|
// Data representation. One of
|
73
145
|
// [struct_data][google.cloud.discoveryengine.v1alpha.Document.struct_data] or
|
74
146
|
// [json_data][google.cloud.discoveryengine.v1alpha.Document.json_data] should
|
@@ -118,4 +190,15 @@ message Document {
|
|
118
190
|
// It contains derived data that are not in the original input document.
|
119
191
|
google.protobuf.Struct derived_struct_data = 6
|
120
192
|
[(google.api.field_behavior) = OUTPUT_ONLY];
|
193
|
+
|
194
|
+
// Access control information for the document.
|
195
|
+
AclInfo acl_info = 11;
|
196
|
+
|
197
|
+
// Output only. The last time the document was indexed. If this field is set,
|
198
|
+
// the document could be returned in search results.
|
199
|
+
//
|
200
|
+
// This field is OUTPUT_ONLY. If this field is not populated, it means the
|
201
|
+
// document has never been indexed.
|
202
|
+
google.protobuf.Timestamp index_time = 13
|
203
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
121
204
|
}
|
@@ -0,0 +1,127 @@
|
|
1
|
+
// Copyright 2022 Google LLC
|
2
|
+
//
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
// you may not use this file except in compliance with the License.
|
5
|
+
// You may obtain a copy of the License at
|
6
|
+
//
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
//
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
// See the License for the specific language governing permissions and
|
13
|
+
// limitations under the License.
|
14
|
+
|
15
|
+
syntax = "proto3";
|
16
|
+
|
17
|
+
package google.cloud.discoveryengine.v1alpha;
|
18
|
+
|
19
|
+
import "google/api/field_behavior.proto";
|
20
|
+
import "google/api/resource.proto";
|
21
|
+
|
22
|
+
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
|
23
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
|
24
|
+
option java_multiple_files = true;
|
25
|
+
option java_outer_classname = "DocumentProcessingConfigProto";
|
26
|
+
option java_package = "com.google.cloud.discoveryengine.v1alpha";
|
27
|
+
option objc_class_prefix = "DISCOVERYENGINE";
|
28
|
+
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
|
29
|
+
option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
|
30
|
+
|
31
|
+
// A singleton resource of
|
32
|
+
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. It's empty when
|
33
|
+
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] is created, which
|
34
|
+
// defaults to digital parser. The first call to
|
35
|
+
// [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig]
|
36
|
+
// method will initialize the config.
|
37
|
+
message DocumentProcessingConfig {
|
38
|
+
option (google.api.resource) = {
|
39
|
+
type: "discoveryengine.googleapis.com/DocumentProcessingConfig"
|
40
|
+
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig"
|
41
|
+
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig"
|
42
|
+
};
|
43
|
+
|
44
|
+
// Configuration for chunking config.
|
45
|
+
message ChunkingConfig {
|
46
|
+
// Configuration for the layout based chunking.
|
47
|
+
message LayoutBasedChunkingConfig {
|
48
|
+
// The token size limit for each chunk.
|
49
|
+
//
|
50
|
+
// Supported values: 100-500 (inclusive).
|
51
|
+
// Default value: 500.
|
52
|
+
int32 chunk_size = 1;
|
53
|
+
|
54
|
+
// Whether to include appending different levels of headings to chunks
|
55
|
+
// from the middle of the document to prevent context loss.
|
56
|
+
//
|
57
|
+
// Default value: False.
|
58
|
+
bool include_ancestor_headings = 2;
|
59
|
+
}
|
60
|
+
|
61
|
+
// Additional configs that defines the behavior of the chunking.
|
62
|
+
oneof chunk_mode {
|
63
|
+
// Configuration for the layout based chunking.
|
64
|
+
LayoutBasedChunkingConfig layout_based_chunking_config = 1;
|
65
|
+
}
|
66
|
+
}
|
67
|
+
|
68
|
+
// Related configurations applied to a specific type of document parser.
|
69
|
+
message ParsingConfig {
|
70
|
+
// The digital parsing configurations for documents.
|
71
|
+
message DigitalParsingConfig {}
|
72
|
+
|
73
|
+
// The OCR parsing configurations for documents.
|
74
|
+
message OcrParsingConfig {
|
75
|
+
// Apply additional enhanced OCR processing to a list of document
|
76
|
+
// elements.
|
77
|
+
//
|
78
|
+
// Supported values:
|
79
|
+
// * `table`: advanced table parsing model.
|
80
|
+
repeated string enhanced_document_elements = 1;
|
81
|
+
|
82
|
+
// If true, will use native text instead of OCR text on pages containing
|
83
|
+
// native text.
|
84
|
+
bool use_native_text = 2;
|
85
|
+
}
|
86
|
+
|
87
|
+
// The layout parsing configurations for documents.
|
88
|
+
message LayoutParsingConfig {}
|
89
|
+
|
90
|
+
// Configs for document processing types.
|
91
|
+
oneof type_dedicated_config {
|
92
|
+
// Configurations applied to digital parser.
|
93
|
+
DigitalParsingConfig digital_parsing_config = 1;
|
94
|
+
|
95
|
+
// Configurations applied to OCR parser. Currently it only applies to
|
96
|
+
// PDFs.
|
97
|
+
OcrParsingConfig ocr_parsing_config = 2;
|
98
|
+
|
99
|
+
// Configurations applied to layout parser.
|
100
|
+
LayoutParsingConfig layout_parsing_config = 3;
|
101
|
+
}
|
102
|
+
}
|
103
|
+
|
104
|
+
// The full resource name of the Document Processing Config.
|
105
|
+
// Format:
|
106
|
+
// `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
|
107
|
+
string name = 1;
|
108
|
+
|
109
|
+
// Whether chunking mode is enabled.
|
110
|
+
ChunkingConfig chunking_config = 3;
|
111
|
+
|
112
|
+
// Configurations for default Document parser.
|
113
|
+
// If not specified, we will configure it as default DigitalParsingConfig, and
|
114
|
+
// the default parsing config will be applied to all file types for Document
|
115
|
+
// parsing.
|
116
|
+
ParsingConfig default_parsing_config = 4;
|
117
|
+
|
118
|
+
// Map from file type to override the default parsing configuration based on
|
119
|
+
// the file type. Supported keys:
|
120
|
+
// * `pdf`: Override parsing config for PDF files, either digital parsing, ocr
|
121
|
+
// parsing or layout parsing is supported.
|
122
|
+
// * `html`: Override parsing config for HTML files, only digital parsing and
|
123
|
+
// or layout parsing are supported.
|
124
|
+
// * `docx`: Override parsing config for DOCX files, only digital parsing and
|
125
|
+
// or layout parsing are supported.
|
126
|
+
map<string, ParsingConfig> parsing_config_overrides = 5;
|
127
|
+
}
|
@@ -25,6 +25,7 @@ import "google/cloud/discoveryengine/v1alpha/import_config.proto";
|
|
25
25
|
import "google/cloud/discoveryengine/v1alpha/purge_config.proto";
|
26
26
|
import "google/longrunning/operations.proto";
|
27
27
|
import "google/protobuf/empty.proto";
|
28
|
+
import "google/protobuf/field_mask.proto";
|
28
29
|
|
29
30
|
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
|
30
31
|
option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
|
@@ -88,6 +89,7 @@ service DocumentService {
|
|
88
89
|
body: "document"
|
89
90
|
}
|
90
91
|
};
|
92
|
+
option (google.api.method_signature) = "document,update_mask";
|
91
93
|
}
|
92
94
|
|
93
95
|
// Deletes a [Document][google.cloud.discoveryengine.v1alpha.Document].
|
@@ -293,6 +295,10 @@ message UpdateDocumentRequest {
|
|
293
295
|
// new [Document][google.cloud.discoveryengine.v1alpha.Document] will be
|
294
296
|
// created.
|
295
297
|
bool allow_missing = 2;
|
298
|
+
|
299
|
+
// Indicates which fields in the provided imported 'document' to update. If
|
300
|
+
// not set, will by default update all fields.
|
301
|
+
google.protobuf.FieldMask update_mask = 3;
|
296
302
|
}
|
297
303
|
|
298
304
|
// Request message for
|
@@ -82,7 +82,7 @@ message Engine {
|
|
82
82
|
TRAINING = 2;
|
83
83
|
}
|
84
84
|
|
85
|
-
// Required. The type of engine e.g
|
85
|
+
// Required. The type of engine. e.g., `recommended-for-you`.
|
86
86
|
//
|
87
87
|
// This field together with
|
88
88
|
// [optimization_objective][Engine.optimization_objective] describe engine
|
@@ -92,7 +92,7 @@ message Engine {
|
|
92
92
|
// `more-like-this`, `most-popular-items`.
|
93
93
|
string type = 1 [(google.api.field_behavior) = REQUIRED];
|
94
94
|
|
95
|
-
// The optimization objective e.g
|
95
|
+
// The optimization objective. e.g., `cvr`.
|
96
96
|
//
|
97
97
|
// This field together with
|
98
98
|
// [optimization_objective][google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.type]
|
@@ -155,6 +155,11 @@ message Engine {
|
|
155
155
|
// database](https://www.iana.org/time-zones), e.g., America/New_York,
|
156
156
|
// Europe/Paris.
|
157
157
|
string time_zone = 3 [(google.api.field_behavior) = REQUIRED];
|
158
|
+
|
159
|
+
// Agent location for Agent creation, supported values: global/us/eu.
|
160
|
+
// If not provided, us Engine will create Agent using us-central-1 by
|
161
|
+
// default; eu Engine will create Agent using eu-west-1 by default.
|
162
|
+
string location = 4;
|
158
163
|
}
|
159
164
|
|
160
165
|
// The configurationt generate the Dialogflow agent that is associated to
|
@@ -181,16 +186,16 @@ message Engine {
|
|
181
186
|
// or
|
182
187
|
// [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines]
|
183
188
|
// API after engine creation. Please use
|
184
|
-
// [
|
185
|
-
// association after Engine is created.
|
189
|
+
// [ChatEngineMetadata.dialogflow_agent][google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata.dialogflow_agent]
|
190
|
+
// for actual agent association after Engine is created.
|
186
191
|
string dialogflow_agent_to_link = 2;
|
187
192
|
}
|
188
193
|
|
189
194
|
// Common configurations for an Engine.
|
190
195
|
message CommonConfig {
|
191
|
-
// The name of the company, business or entity that is associated
|
192
|
-
// engine. Setting this may help improve LLM related features.
|
193
|
-
string company_name = 1;
|
196
|
+
// Immutable. The name of the company, business or entity that is associated
|
197
|
+
// with the engine. Setting this may help improve LLM related features.
|
198
|
+
string company_name = 1 [(google.api.field_behavior) = IMMUTABLE];
|
194
199
|
}
|
195
200
|
|
196
201
|
// Additional information of a recommendation engine.
|
@@ -352,7 +357,7 @@ message Engine {
|
|
352
357
|
// Note that when used in
|
353
358
|
// [CreateEngineRequest][google.cloud.discoveryengine.v1alpha.CreateEngineRequest],
|
354
359
|
// one DataStore id must be provided as the system will use it for necessary
|
355
|
-
//
|
360
|
+
// initializations.
|
356
361
|
repeated string data_store_ids = 5;
|
357
362
|
|
358
363
|
// Required. The solutions of the engine.
|
@@ -94,7 +94,7 @@ service EngineService {
|
|
94
94
|
}
|
95
95
|
|
96
96
|
// Pauses the training of an existing engine. Only applicable if
|
97
|
-
// [
|
97
|
+
// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
|
98
98
|
// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
|
99
99
|
rpc PauseEngine(PauseEngineRequest) returns (Engine) {
|
100
100
|
option (google.api.http) = {
|
@@ -115,7 +115,8 @@ service EngineService {
|
|
115
115
|
option (google.api.method_signature) = "name";
|
116
116
|
}
|
117
117
|
|
118
|
-
// Tunes an existing engine. Only applicable if
|
118
|
+
// Tunes an existing engine. Only applicable if
|
119
|
+
// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
|
119
120
|
// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
|
120
121
|
rpc TuneEngine(TuneEngineRequest) returns (google.longrunning.Operation) {
|
121
122
|
option (google.api.http) = {
|
@@ -0,0 +1,130 @@
|
|
1
|
+
// Copyright 2022 Google LLC
|
2
|
+
//
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
// you may not use this file except in compliance with the License.
|
5
|
+
// You may obtain a copy of the License at
|
6
|
+
//
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
//
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
// See the License for the specific language governing permissions and
|
13
|
+
// limitations under the License.
|
14
|
+
|
15
|
+
syntax = "proto3";
|
16
|
+
|
17
|
+
package google.cloud.discoveryengine.v1alpha;
|
18
|
+
|
19
|
+
import "google/api/annotations.proto";
|
20
|
+
import "google/api/client.proto";
|
21
|
+
import "google/api/field_behavior.proto";
|
22
|
+
import "google/api/resource.proto";
|
23
|
+
import "google/cloud/discoveryengine/v1alpha/import_config.proto";
|
24
|
+
import "google/longrunning/operations.proto";
|
25
|
+
import "google/protobuf/timestamp.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 = "EstimateBillingServiceProto";
|
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 billing estimations resources.
|
37
|
+
service EstimateBillingService {
|
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
|
+
// Estimates the data size to be used by a customer.
|
43
|
+
rpc EstimateDataSize(EstimateDataSizeRequest)
|
44
|
+
returns (google.longrunning.Operation) {
|
45
|
+
option (google.api.http) = {
|
46
|
+
post: "/v1alpha/{location=projects/*/locations/*}:estimateDataSize"
|
47
|
+
body: "*"
|
48
|
+
};
|
49
|
+
option (google.longrunning.operation_info) = {
|
50
|
+
response_type: "google.cloud.discoveryengine.v1alpha.EstimateDataSizeResponse"
|
51
|
+
metadata_type: "google.cloud.discoveryengine.v1alpha.EstimateDataSizeMetadata"
|
52
|
+
};
|
53
|
+
}
|
54
|
+
}
|
55
|
+
|
56
|
+
// Request message for
|
57
|
+
// [EstimateBillingService.EstimateDataSize][google.cloud.discoveryengine.v1alpha.EstimateBillingService.EstimateDataSize]
|
58
|
+
// method
|
59
|
+
message EstimateDataSizeRequest {
|
60
|
+
// Data source is a set of website patterns that we crawl to get
|
61
|
+
// the total number of websites.
|
62
|
+
message WebsiteDataSource {
|
63
|
+
// URI patterns that we use to crawl.
|
64
|
+
message EstimatorUriPattern {
|
65
|
+
// User provided URI pattern. For example, `foo.com/bar/*`.
|
66
|
+
string provided_uri_pattern = 1;
|
67
|
+
|
68
|
+
// Whether we infer the generated URI or use the exact provided one.
|
69
|
+
bool exact_match = 2;
|
70
|
+
|
71
|
+
// Whether the pattern is exclusive or not. If set to true, the pattern is
|
72
|
+
// considered exclusive. If unset or set to false, the pattern is
|
73
|
+
// considered inclusive by default.
|
74
|
+
bool exclusive = 3;
|
75
|
+
}
|
76
|
+
|
77
|
+
// Required. The URI patterns to estimate the data sizes. At most 10
|
78
|
+
// patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown.
|
79
|
+
repeated EstimatorUriPattern estimator_uri_patterns = 1
|
80
|
+
[(google.api.field_behavior) = REQUIRED];
|
81
|
+
}
|
82
|
+
|
83
|
+
// Data source contains files either in Cloud Storage or BigQuery.
|
84
|
+
message FileDataSource {
|
85
|
+
// Which source contains the files to be used.
|
86
|
+
oneof source {
|
87
|
+
// Cloud Storage location for the input content.
|
88
|
+
GcsSource gcs_source = 1;
|
89
|
+
|
90
|
+
// BigQuery input source.
|
91
|
+
BigQuerySource bigquery_source = 2;
|
92
|
+
}
|
93
|
+
}
|
94
|
+
|
95
|
+
// Data source for which we are estimating its size.
|
96
|
+
oneof data_source {
|
97
|
+
// Website data.
|
98
|
+
WebsiteDataSource website_data_source = 2;
|
99
|
+
|
100
|
+
// Structured or unstructured data.
|
101
|
+
FileDataSource file_data_source = 3;
|
102
|
+
}
|
103
|
+
|
104
|
+
// Required. Full resource name of the location, such as
|
105
|
+
// `projects/{project}/locations/{location}`.
|
106
|
+
string location = 1 [
|
107
|
+
(google.api.field_behavior) = REQUIRED,
|
108
|
+
(google.api.resource_reference) = {
|
109
|
+
type: "discoveryengine.googleapis.com/Location"
|
110
|
+
}
|
111
|
+
];
|
112
|
+
}
|
113
|
+
|
114
|
+
// Response of the EstimateDataSize request. If the long running
|
115
|
+
// operation was successful, then this message is returned by the
|
116
|
+
// google.longrunning.Operations.response field if the operation was successful.
|
117
|
+
message EstimateDataSizeResponse {
|
118
|
+
// Data size in terms of bytes.
|
119
|
+
int64 data_size_bytes = 1;
|
120
|
+
|
121
|
+
// Total number of documents.
|
122
|
+
int64 document_count = 2;
|
123
|
+
}
|
124
|
+
|
125
|
+
// Metadata related to the progress of the EstimateDataSize operation. This is
|
126
|
+
// returned by the google.longrunning.Operation.metadata field.
|
127
|
+
message EstimateDataSizeMetadata {
|
128
|
+
// Operation create time.
|
129
|
+
google.protobuf.Timestamp create_time = 1;
|
130
|
+
}
|
@@ -18,6 +18,7 @@ package google.cloud.discoveryengine.v1alpha;
|
|
18
18
|
|
19
19
|
import "google/api/field_behavior.proto";
|
20
20
|
import "google/api/resource.proto";
|
21
|
+
import "google/cloud/discoveryengine/v1alpha/completion.proto";
|
21
22
|
import "google/cloud/discoveryengine/v1alpha/document.proto";
|
22
23
|
import "google/cloud/discoveryengine/v1alpha/user_event.proto";
|
23
24
|
import "google/protobuf/timestamp.proto";
|
@@ -341,3 +342,66 @@ message ImportDocumentsResponse {
|
|
341
342
|
// Echoes the destination for the complete errors in the request if set.
|
342
343
|
ImportErrorConfig error_config = 2;
|
343
344
|
}
|
345
|
+
|
346
|
+
// Request message for
|
347
|
+
// [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries]
|
348
|
+
// method.
|
349
|
+
message ImportSuggestionDenyListEntriesRequest {
|
350
|
+
// The inline source for SuggestionDenyListEntry.
|
351
|
+
message InlineSource {
|
352
|
+
// Required. A list of all denylist entries to import. Max of 1000 items.
|
353
|
+
repeated SuggestionDenyListEntry entries = 1
|
354
|
+
[(google.api.field_behavior) = REQUIRED];
|
355
|
+
}
|
356
|
+
|
357
|
+
// The source of the updated SuggestionDenyList.
|
358
|
+
oneof source {
|
359
|
+
// The Inline source for the input content for suggestion deny list entries.
|
360
|
+
InlineSource inline_source = 2;
|
361
|
+
|
362
|
+
// Cloud Storage location for the input content.
|
363
|
+
//
|
364
|
+
// Only 1 file can be specified that contains all entries to import.
|
365
|
+
// Supported values `gcs_source.schema` for autocomplete suggestion deny
|
366
|
+
// list entry imports:
|
367
|
+
//
|
368
|
+
// * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry]
|
369
|
+
// per line.
|
370
|
+
GcsSource gcs_source = 3;
|
371
|
+
}
|
372
|
+
|
373
|
+
// Required. The parent data store resource name for which to import denylist
|
374
|
+
// entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
|
375
|
+
string parent = 1 [
|
376
|
+
(google.api.field_behavior) = REQUIRED,
|
377
|
+
(google.api.resource_reference) = {
|
378
|
+
type: "discoveryengine.googleapis.com/DataStore"
|
379
|
+
}
|
380
|
+
];
|
381
|
+
}
|
382
|
+
|
383
|
+
// Response message for
|
384
|
+
// [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries]
|
385
|
+
// method.
|
386
|
+
message ImportSuggestionDenyListEntriesResponse {
|
387
|
+
// A sample of errors encountered while processing the request.
|
388
|
+
repeated google.rpc.Status error_samples = 1;
|
389
|
+
|
390
|
+
// Count of deny list entries successfully imported.
|
391
|
+
int64 imported_entries_count = 2;
|
392
|
+
|
393
|
+
// Count of deny list entries that failed to be imported.
|
394
|
+
int64 failed_entries_count = 3;
|
395
|
+
}
|
396
|
+
|
397
|
+
// Metadata related to the progress of the ImportSuggestionDenyListEntries
|
398
|
+
// operation. This is returned by the google.longrunning.Operation.metadata
|
399
|
+
// field.
|
400
|
+
message ImportSuggestionDenyListEntriesMetadata {
|
401
|
+
// Operation create time.
|
402
|
+
google.protobuf.Timestamp create_time = 1;
|
403
|
+
|
404
|
+
// Operation last update time. If the operation is done, this is also the
|
405
|
+
// finish time.
|
406
|
+
google.protobuf.Timestamp update_time = 2;
|
407
|
+
}
|