@googleapis/discoveryengine 5.0.0 → 6.1.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 +18 -0
- package/build/v1alpha.d.ts +1665 -163
- package/build/v1alpha.js +432 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +2630 -133
- package/build/v1beta.js +1894 -266
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1alpha.ts +2786 -190
- package/v1beta.ts +9943 -3276
package/build/v1alpha.d.ts
CHANGED
|
@@ -203,7 +203,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
203
203
|
token?: string | null;
|
|
204
204
|
}
|
|
205
205
|
/**
|
|
206
|
-
* Metadata related to the progress of the SiteSearchEngineService.
|
|
206
|
+
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
207
207
|
*/
|
|
208
208
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata {
|
|
209
209
|
/**
|
|
@@ -216,7 +216,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
216
216
|
updateTime?: string | null;
|
|
217
217
|
}
|
|
218
218
|
/**
|
|
219
|
-
* Request message for SiteSearchEngineService.
|
|
219
|
+
* Request message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
220
220
|
*/
|
|
221
221
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest {
|
|
222
222
|
/**
|
|
@@ -284,7 +284,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
284
284
|
*/
|
|
285
285
|
query?: string | null;
|
|
286
286
|
/**
|
|
287
|
-
*
|
|
287
|
+
* Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
288
288
|
*/
|
|
289
289
|
queryModel?: string | null;
|
|
290
290
|
/**
|
|
@@ -528,6 +528,15 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
528
528
|
*/
|
|
529
529
|
text?: string[] | null;
|
|
530
530
|
}
|
|
531
|
+
/**
|
|
532
|
+
* Defines custom fine tuning spec.
|
|
533
|
+
*/
|
|
534
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec {
|
|
535
|
+
/**
|
|
536
|
+
* Whether or not to enable and include custom fine tuned search adaptor model.
|
|
537
|
+
*/
|
|
538
|
+
enableSearchAdaptor?: boolean | null;
|
|
539
|
+
}
|
|
531
540
|
/**
|
|
532
541
|
* DataStore captures global settings and configs at the DataStore level.
|
|
533
542
|
*/
|
|
@@ -613,6 +622,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
613
622
|
*/
|
|
614
623
|
updateTime?: string | null;
|
|
615
624
|
}
|
|
625
|
+
/**
|
|
626
|
+
* The digital parsing configurations for documents.
|
|
627
|
+
*/
|
|
628
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {
|
|
629
|
+
}
|
|
616
630
|
/**
|
|
617
631
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
618
632
|
*/
|
|
@@ -690,7 +704,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
690
704
|
*/
|
|
691
705
|
rawBytes?: string | null;
|
|
692
706
|
/**
|
|
693
|
-
* The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 100 MB.
|
|
707
|
+
* The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 100 MB for other formats.
|
|
694
708
|
*/
|
|
695
709
|
uri?: string | null;
|
|
696
710
|
}
|
|
@@ -724,13 +738,40 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
724
738
|
*/
|
|
725
739
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
|
|
726
740
|
/**
|
|
727
|
-
*
|
|
741
|
+
* Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing.
|
|
742
|
+
*/
|
|
743
|
+
defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
744
|
+
/**
|
|
745
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
728
746
|
*/
|
|
729
747
|
name?: string | null;
|
|
730
748
|
/**
|
|
731
|
-
* The OCR config. Currently it only applies to PDFs.
|
|
749
|
+
* [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs.
|
|
732
750
|
*/
|
|
733
751
|
ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
752
|
+
/**
|
|
753
|
+
* Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported.
|
|
754
|
+
*/
|
|
755
|
+
parsingConfigOverrides?: {
|
|
756
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
757
|
+
} | null;
|
|
758
|
+
}
|
|
759
|
+
/**
|
|
760
|
+
* Related configurations applied to a specific type of document parser.
|
|
761
|
+
*/
|
|
762
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig {
|
|
763
|
+
/**
|
|
764
|
+
* Configurations applied to digital parser.
|
|
765
|
+
*/
|
|
766
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig;
|
|
767
|
+
/**
|
|
768
|
+
* Configurations applied to layout parser.
|
|
769
|
+
*/
|
|
770
|
+
layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig;
|
|
771
|
+
/**
|
|
772
|
+
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
773
|
+
*/
|
|
774
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig;
|
|
734
775
|
}
|
|
735
776
|
/**
|
|
736
777
|
* Double list.
|
|
@@ -741,6 +782,15 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
741
782
|
*/
|
|
742
783
|
values?: number[] | null;
|
|
743
784
|
}
|
|
785
|
+
/**
|
|
786
|
+
* Defines embedding config, used for bring your own embeddings feature.
|
|
787
|
+
*/
|
|
788
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEmbeddingConfig {
|
|
789
|
+
/**
|
|
790
|
+
* Full field path in the schema mapped as embedding field.
|
|
791
|
+
*/
|
|
792
|
+
fieldPath?: string | null;
|
|
793
|
+
}
|
|
744
794
|
/**
|
|
745
795
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
746
796
|
*/
|
|
@@ -785,7 +835,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
785
835
|
*/
|
|
786
836
|
createTime?: string | null;
|
|
787
837
|
/**
|
|
788
|
-
* The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary
|
|
838
|
+
* The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
|
|
789
839
|
*/
|
|
790
840
|
dataStoreIds?: string[] | null;
|
|
791
841
|
/**
|
|
@@ -834,7 +884,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
834
884
|
*/
|
|
835
885
|
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
|
|
836
886
|
/**
|
|
837
|
-
* The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use
|
|
887
|
+
* The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
|
|
838
888
|
*/
|
|
839
889
|
dialogflowAgentToLink?: string | null;
|
|
840
890
|
}
|
|
@@ -850,6 +900,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
850
900
|
* Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
|
|
851
901
|
*/
|
|
852
902
|
defaultLanguageCode?: string | null;
|
|
903
|
+
/**
|
|
904
|
+
* Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
|
|
905
|
+
*/
|
|
906
|
+
location?: string | null;
|
|
853
907
|
/**
|
|
854
908
|
* Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
|
|
855
909
|
*/
|
|
@@ -869,7 +923,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
869
923
|
*/
|
|
870
924
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineCommonConfig {
|
|
871
925
|
/**
|
|
872
|
-
* The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
926
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
873
927
|
*/
|
|
874
928
|
companyName?: string | null;
|
|
875
929
|
}
|
|
@@ -878,7 +932,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
878
932
|
*/
|
|
879
933
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
|
|
880
934
|
/**
|
|
881
|
-
* The optimization objective e.g
|
|
935
|
+
* The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` =\> `ctr` `others-you-may-like` =\> `ctr`
|
|
882
936
|
*/
|
|
883
937
|
optimizationObjective?: string | null;
|
|
884
938
|
/**
|
|
@@ -890,7 +944,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
890
944
|
*/
|
|
891
945
|
trainingState?: string | null;
|
|
892
946
|
/**
|
|
893
|
-
* Required. The type of engine e.g
|
|
947
|
+
* Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
|
|
894
948
|
*/
|
|
895
949
|
type?: string | null;
|
|
896
950
|
}
|
|
@@ -969,7 +1023,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
969
1023
|
websiteDataSource?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource;
|
|
970
1024
|
}
|
|
971
1025
|
/**
|
|
972
|
-
* Data source contains files either in
|
|
1026
|
+
* Data source contains files either in Cloud Storage or BigQuery.
|
|
973
1027
|
*/
|
|
974
1028
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource {
|
|
975
1029
|
/**
|
|
@@ -1091,6 +1145,23 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1091
1145
|
*/
|
|
1092
1146
|
inputUris?: string[] | null;
|
|
1093
1147
|
}
|
|
1148
|
+
/**
|
|
1149
|
+
* Defines guided search spec.
|
|
1150
|
+
*/
|
|
1151
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec {
|
|
1152
|
+
/**
|
|
1153
|
+
* Whether or not to enable and include refinement attributes in gudied search result.
|
|
1154
|
+
*/
|
|
1155
|
+
enableRefinementAttributes?: boolean | null;
|
|
1156
|
+
/**
|
|
1157
|
+
* Whether or not to enable and include related questions in search response.
|
|
1158
|
+
*/
|
|
1159
|
+
enableRelatedQuestions?: boolean | null;
|
|
1160
|
+
/**
|
|
1161
|
+
* Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3.
|
|
1162
|
+
*/
|
|
1163
|
+
maxRelatedQuestions?: number | null;
|
|
1164
|
+
}
|
|
1094
1165
|
/**
|
|
1095
1166
|
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1096
1167
|
*/
|
|
@@ -1176,6 +1247,58 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1176
1247
|
*/
|
|
1177
1248
|
gcsPrefix?: string | null;
|
|
1178
1249
|
}
|
|
1250
|
+
/**
|
|
1251
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1252
|
+
*/
|
|
1253
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata {
|
|
1254
|
+
/**
|
|
1255
|
+
* Operation create time.
|
|
1256
|
+
*/
|
|
1257
|
+
createTime?: string | null;
|
|
1258
|
+
/**
|
|
1259
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1260
|
+
*/
|
|
1261
|
+
updateTime?: string | null;
|
|
1262
|
+
}
|
|
1263
|
+
/**
|
|
1264
|
+
* Request message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
1265
|
+
*/
|
|
1266
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest {
|
|
1267
|
+
/**
|
|
1268
|
+
* Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line.
|
|
1269
|
+
*/
|
|
1270
|
+
gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource;
|
|
1271
|
+
/**
|
|
1272
|
+
* The Inline source for the input content for suggestion deny list entries.
|
|
1273
|
+
*/
|
|
1274
|
+
inlineSource?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource;
|
|
1275
|
+
}
|
|
1276
|
+
/**
|
|
1277
|
+
* The inline source for SuggestionDenyListEntry.
|
|
1278
|
+
*/
|
|
1279
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource {
|
|
1280
|
+
/**
|
|
1281
|
+
* Required. A list of all denylist entries to import. Max of 1000 items.
|
|
1282
|
+
*/
|
|
1283
|
+
entries?: Schema$GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry[];
|
|
1284
|
+
}
|
|
1285
|
+
/**
|
|
1286
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
1287
|
+
*/
|
|
1288
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse {
|
|
1289
|
+
/**
|
|
1290
|
+
* A sample of errors encountered while processing the request.
|
|
1291
|
+
*/
|
|
1292
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
1293
|
+
/**
|
|
1294
|
+
* Count of deny list entries that failed to be imported.
|
|
1295
|
+
*/
|
|
1296
|
+
failedEntriesCount?: string | null;
|
|
1297
|
+
/**
|
|
1298
|
+
* Count of deny list entries successfully imported.
|
|
1299
|
+
*/
|
|
1300
|
+
importedEntriesCount?: string | null;
|
|
1301
|
+
}
|
|
1179
1302
|
/**
|
|
1180
1303
|
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1181
1304
|
*/
|
|
@@ -1269,6 +1392,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1269
1392
|
*/
|
|
1270
1393
|
minimum?: number | null;
|
|
1271
1394
|
}
|
|
1395
|
+
/**
|
|
1396
|
+
* The layout parsing configurations for documents.
|
|
1397
|
+
*/
|
|
1398
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig {
|
|
1399
|
+
}
|
|
1272
1400
|
/**
|
|
1273
1401
|
* Response for ListConversations method.
|
|
1274
1402
|
*/
|
|
@@ -1334,6 +1462,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1334
1462
|
*/
|
|
1335
1463
|
schemas?: Schema$GoogleCloudDiscoveryengineV1alphaSchema[];
|
|
1336
1464
|
}
|
|
1465
|
+
/**
|
|
1466
|
+
* Response for ListServingConfigs method.
|
|
1467
|
+
*/
|
|
1468
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse {
|
|
1469
|
+
/**
|
|
1470
|
+
* Pagination token, if not returned indicates the last page.
|
|
1471
|
+
*/
|
|
1472
|
+
nextPageToken?: string | null;
|
|
1473
|
+
/**
|
|
1474
|
+
* All the ServingConfigs for a given dataStore.
|
|
1475
|
+
*/
|
|
1476
|
+
servingConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig[];
|
|
1477
|
+
}
|
|
1337
1478
|
/**
|
|
1338
1479
|
* Response message for SiteSearchEngineService.ListTargetSites method.
|
|
1339
1480
|
*/
|
|
@@ -1387,7 +1528,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1387
1528
|
*/
|
|
1388
1529
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig {
|
|
1389
1530
|
/**
|
|
1390
|
-
* Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply.
|
|
1531
|
+
* Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files.
|
|
1391
1532
|
*/
|
|
1392
1533
|
enabled?: boolean | null;
|
|
1393
1534
|
/**
|
|
@@ -1399,6 +1540,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1399
1540
|
*/
|
|
1400
1541
|
useNativeText?: boolean | null;
|
|
1401
1542
|
}
|
|
1543
|
+
/**
|
|
1544
|
+
* The OCR parsing configurations for documents.
|
|
1545
|
+
*/
|
|
1546
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig {
|
|
1547
|
+
/**
|
|
1548
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
1549
|
+
*/
|
|
1550
|
+
enhancedDocumentElements?: string[] | null;
|
|
1551
|
+
/**
|
|
1552
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
1553
|
+
*/
|
|
1554
|
+
useNativeText?: boolean | null;
|
|
1555
|
+
}
|
|
1402
1556
|
/**
|
|
1403
1557
|
* Detailed page information.
|
|
1404
1558
|
*/
|
|
@@ -1493,6 +1647,37 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1493
1647
|
*/
|
|
1494
1648
|
purgeSample?: string[] | null;
|
|
1495
1649
|
}
|
|
1650
|
+
/**
|
|
1651
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1652
|
+
*/
|
|
1653
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata {
|
|
1654
|
+
/**
|
|
1655
|
+
* Operation create time.
|
|
1656
|
+
*/
|
|
1657
|
+
createTime?: string | null;
|
|
1658
|
+
/**
|
|
1659
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1660
|
+
*/
|
|
1661
|
+
updateTime?: string | null;
|
|
1662
|
+
}
|
|
1663
|
+
/**
|
|
1664
|
+
* Request message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
1665
|
+
*/
|
|
1666
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest {
|
|
1667
|
+
}
|
|
1668
|
+
/**
|
|
1669
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
1670
|
+
*/
|
|
1671
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse {
|
|
1672
|
+
/**
|
|
1673
|
+
* A sample of errors encountered while processing the request.
|
|
1674
|
+
*/
|
|
1675
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
1676
|
+
/**
|
|
1677
|
+
* Number of suggestion deny list entries purged.
|
|
1678
|
+
*/
|
|
1679
|
+
purgeCount?: string | null;
|
|
1680
|
+
}
|
|
1496
1681
|
/**
|
|
1497
1682
|
* Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1498
1683
|
*/
|
|
@@ -1678,7 +1863,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1678
1863
|
uri?: string | null;
|
|
1679
1864
|
}
|
|
1680
1865
|
/**
|
|
1681
|
-
* Details about why crawling failed for a particular CorpusType, e.g
|
|
1866
|
+
* Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.
|
|
1682
1867
|
*/
|
|
1683
1868
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason {
|
|
1684
1869
|
/**
|
|
@@ -1794,7 +1979,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1794
1979
|
*/
|
|
1795
1980
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
1796
1981
|
/**
|
|
1797
|
-
* Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.
|
|
1982
|
+
* Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
|
|
1798
1983
|
*/
|
|
1799
1984
|
embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
|
|
1800
1985
|
/**
|
|
@@ -1914,7 +2099,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1914
2099
|
*/
|
|
1915
2100
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec {
|
|
1916
2101
|
/**
|
|
1917
|
-
* The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most
|
|
2102
|
+
* The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
|
|
1918
2103
|
*/
|
|
1919
2104
|
maxExtractiveAnswerCount?: number | null;
|
|
1920
2105
|
/**
|
|
@@ -1994,7 +2179,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1994
2179
|
*/
|
|
1995
2180
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
1996
2181
|
/**
|
|
1997
|
-
* The string
|
|
2182
|
+
* The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. LINT.IfChange * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English. LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/pages/configurations/widget_tab.ts)
|
|
1998
2183
|
*/
|
|
1999
2184
|
version?: string | null;
|
|
2000
2185
|
}
|
|
@@ -2326,7 +2511,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2326
2511
|
*/
|
|
2327
2512
|
title?: string | null;
|
|
2328
2513
|
/**
|
|
2329
|
-
*
|
|
2514
|
+
* Cloud Storage or HTTP uri for the document.
|
|
2330
2515
|
*/
|
|
2331
2516
|
uri?: string | null;
|
|
2332
2517
|
}
|
|
@@ -2360,6 +2545,126 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2360
2545
|
*/
|
|
2361
2546
|
summary?: string | null;
|
|
2362
2547
|
}
|
|
2548
|
+
/**
|
|
2549
|
+
* Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.
|
|
2550
|
+
*/
|
|
2551
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfig {
|
|
2552
|
+
/**
|
|
2553
|
+
* Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.
|
|
2554
|
+
*/
|
|
2555
|
+
boostControlIds?: string[] | null;
|
|
2556
|
+
/**
|
|
2557
|
+
* Output only. ServingConfig created timestamp.
|
|
2558
|
+
*/
|
|
2559
|
+
createTime?: string | null;
|
|
2560
|
+
/**
|
|
2561
|
+
* Custom fine tuning configs.
|
|
2562
|
+
*/
|
|
2563
|
+
customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
2564
|
+
/**
|
|
2565
|
+
* Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
2566
|
+
*/
|
|
2567
|
+
displayName?: string | null;
|
|
2568
|
+
/**
|
|
2569
|
+
* Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
2570
|
+
*/
|
|
2571
|
+
dissociateControlIds?: string[] | null;
|
|
2572
|
+
/**
|
|
2573
|
+
* How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
2574
|
+
*/
|
|
2575
|
+
diversityLevel?: string | null;
|
|
2576
|
+
/**
|
|
2577
|
+
* Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config.
|
|
2578
|
+
*/
|
|
2579
|
+
embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEmbeddingConfig;
|
|
2580
|
+
/**
|
|
2581
|
+
* Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.
|
|
2582
|
+
*/
|
|
2583
|
+
filterControlIds?: string[] | null;
|
|
2584
|
+
/**
|
|
2585
|
+
* The GenericConfig of the serving configuration.
|
|
2586
|
+
*/
|
|
2587
|
+
genericConfig?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig;
|
|
2588
|
+
/**
|
|
2589
|
+
* Guided search configs.
|
|
2590
|
+
*/
|
|
2591
|
+
guidedSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec;
|
|
2592
|
+
/**
|
|
2593
|
+
* Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.
|
|
2594
|
+
*/
|
|
2595
|
+
ignoreControlIds?: string[] | null;
|
|
2596
|
+
/**
|
|
2597
|
+
* The MediaConfig of the serving configuration.
|
|
2598
|
+
*/
|
|
2599
|
+
mediaConfig?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig;
|
|
2600
|
+
/**
|
|
2601
|
+
* The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
2602
|
+
*/
|
|
2603
|
+
modelId?: string | null;
|
|
2604
|
+
/**
|
|
2605
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
2606
|
+
*/
|
|
2607
|
+
name?: string | null;
|
|
2608
|
+
/**
|
|
2609
|
+
* Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
2610
|
+
*/
|
|
2611
|
+
onewaySynonymsControlIds?: string[] | null;
|
|
2612
|
+
rankingExpression?: string | null;
|
|
2613
|
+
/**
|
|
2614
|
+
* IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
2615
|
+
*/
|
|
2616
|
+
redirectControlIds?: string[] | null;
|
|
2617
|
+
/**
|
|
2618
|
+
* Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
2619
|
+
*/
|
|
2620
|
+
replacementControlIds?: string[] | null;
|
|
2621
|
+
/**
|
|
2622
|
+
* Required. Immutable. Specifies the solution type that a serving config can be associated with.
|
|
2623
|
+
*/
|
|
2624
|
+
solutionType?: string | null;
|
|
2625
|
+
/**
|
|
2626
|
+
* Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
2627
|
+
*/
|
|
2628
|
+
synonymsControlIds?: string[] | null;
|
|
2629
|
+
/**
|
|
2630
|
+
* Output only. ServingConfig updated timestamp.
|
|
2631
|
+
*/
|
|
2632
|
+
updateTime?: string | null;
|
|
2633
|
+
}
|
|
2634
|
+
/**
|
|
2635
|
+
* Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.
|
|
2636
|
+
*/
|
|
2637
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig {
|
|
2638
|
+
/**
|
|
2639
|
+
* Specifies the expected behavior of content search. Only valid for content-search enabled data store.
|
|
2640
|
+
*/
|
|
2641
|
+
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
2642
|
+
}
|
|
2643
|
+
/**
|
|
2644
|
+
* Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
2645
|
+
*/
|
|
2646
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig {
|
|
2647
|
+
/**
|
|
2648
|
+
* Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
|
|
2649
|
+
*/
|
|
2650
|
+
contentFreshnessCutoffDays?: number | null;
|
|
2651
|
+
/**
|
|
2652
|
+
* Specifies the content watched minutes threshold for demotion.
|
|
2653
|
+
*/
|
|
2654
|
+
contentWatchedMinutesThreshold?: number | null;
|
|
2655
|
+
/**
|
|
2656
|
+
* Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
|
|
2657
|
+
*/
|
|
2658
|
+
contentWatchedPercentageThreshold?: number | null;
|
|
2659
|
+
/**
|
|
2660
|
+
* Specifies the content watched minutes threshold for demotion.
|
|
2661
|
+
*/
|
|
2662
|
+
contentWatchedSecondsThreshold?: number | null;
|
|
2663
|
+
/**
|
|
2664
|
+
* Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.
|
|
2665
|
+
*/
|
|
2666
|
+
demotionEventType?: string | null;
|
|
2667
|
+
}
|
|
2363
2668
|
/**
|
|
2364
2669
|
* SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
|
|
2365
2670
|
*/
|
|
@@ -2382,6 +2687,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2382
2687
|
*/
|
|
2383
2688
|
verifyTime?: string | null;
|
|
2384
2689
|
}
|
|
2690
|
+
/**
|
|
2691
|
+
* Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
|
|
2692
|
+
*/
|
|
2693
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry {
|
|
2694
|
+
/**
|
|
2695
|
+
* Required. Phrase to block from suggestions served. Can be maximum 125 characters.
|
|
2696
|
+
*/
|
|
2697
|
+
blockPhrase?: string | null;
|
|
2698
|
+
/**
|
|
2699
|
+
* Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase.
|
|
2700
|
+
*/
|
|
2701
|
+
matchOperator?: string | null;
|
|
2702
|
+
}
|
|
2385
2703
|
/**
|
|
2386
2704
|
* A target site for the SiteSearchEngine.
|
|
2387
2705
|
*/
|
|
@@ -2415,7 +2733,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2415
2733
|
*/
|
|
2416
2734
|
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo;
|
|
2417
2735
|
/**
|
|
2418
|
-
* The type of the target site, e.g
|
|
2736
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
2419
2737
|
*/
|
|
2420
2738
|
type?: string | null;
|
|
2421
2739
|
/**
|
|
@@ -2433,6 +2751,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2433
2751
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
2434
2752
|
}
|
|
2435
2753
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
2754
|
+
/**
|
|
2755
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
2756
|
+
*/
|
|
2757
|
+
totalRequiredQuota?: string | null;
|
|
2436
2758
|
}
|
|
2437
2759
|
/**
|
|
2438
2760
|
* Defines text input.
|
|
@@ -2469,7 +2791,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2469
2791
|
*/
|
|
2470
2792
|
errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
|
|
2471
2793
|
/**
|
|
2472
|
-
*
|
|
2794
|
+
* Cloud Storage training input.
|
|
2473
2795
|
*/
|
|
2474
2796
|
gcsTrainingInput?: Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput;
|
|
2475
2797
|
/**
|
|
@@ -2478,23 +2800,23 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2478
2800
|
modelType?: string | null;
|
|
2479
2801
|
}
|
|
2480
2802
|
/**
|
|
2481
|
-
*
|
|
2803
|
+
* Cloud Storage training data input.
|
|
2482
2804
|
*/
|
|
2483
2805
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput {
|
|
2484
2806
|
/**
|
|
2485
|
-
* The
|
|
2807
|
+
* The Cloud Storage corpus data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: {"_id": "doc1", title: "relevant doc", "text": "relevant text"\}
|
|
2486
2808
|
*/
|
|
2487
2809
|
corpusDataPath?: string | null;
|
|
2488
2810
|
/**
|
|
2489
|
-
* The gcs query data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file.
|
|
2811
|
+
* The gcs query data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"\}
|
|
2490
2812
|
*/
|
|
2491
2813
|
queryDataPath?: string | null;
|
|
2492
2814
|
/**
|
|
2493
|
-
*
|
|
2815
|
+
* Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path.
|
|
2494
2816
|
*/
|
|
2495
2817
|
testDataPath?: string | null;
|
|
2496
2818
|
/**
|
|
2497
|
-
*
|
|
2819
|
+
* Cloud Storage training data path whose format should be gs:///. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in [0, inf+). The larger the number is, the more relevant the pair is. Example: query-id\tcorpus-id\tscore query1\tdoc1\t1
|
|
2498
2820
|
*/
|
|
2499
2821
|
trainDataPath?: string | null;
|
|
2500
2822
|
}
|
|
@@ -2624,7 +2946,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2624
2946
|
*/
|
|
2625
2947
|
eventType?: string | null;
|
|
2626
2948
|
/**
|
|
2627
|
-
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a
|
|
2949
|
+
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
2628
2950
|
*/
|
|
2629
2951
|
filter?: string | null;
|
|
2630
2952
|
/**
|
|
@@ -2790,6 +3112,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2790
3112
|
fieldsUiComponentsMap?: {
|
|
2791
3113
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
2792
3114
|
} | null;
|
|
3115
|
+
/**
|
|
3116
|
+
* Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
|
|
3117
|
+
*/
|
|
3118
|
+
industryVertical?: string | null;
|
|
2793
3119
|
/**
|
|
2794
3120
|
* Output only. Whether LLM is enabled in the corresponding data store.
|
|
2795
3121
|
*/
|
|
@@ -2914,9 +3240,9 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2914
3240
|
uToken?: string | null;
|
|
2915
3241
|
}
|
|
2916
3242
|
/**
|
|
2917
|
-
* Metadata
|
|
3243
|
+
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
2918
3244
|
*/
|
|
2919
|
-
export interface Schema$
|
|
3245
|
+
export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
|
|
2920
3246
|
/**
|
|
2921
3247
|
* Operation create time.
|
|
2922
3248
|
*/
|
|
@@ -2927,9 +3253,18 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2927
3253
|
updateTime?: string | null;
|
|
2928
3254
|
}
|
|
2929
3255
|
/**
|
|
2930
|
-
*
|
|
3256
|
+
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
2931
3257
|
*/
|
|
2932
|
-
export interface Schema$
|
|
3258
|
+
export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse {
|
|
3259
|
+
/**
|
|
3260
|
+
* TargetSites created.
|
|
3261
|
+
*/
|
|
3262
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[];
|
|
3263
|
+
}
|
|
3264
|
+
/**
|
|
3265
|
+
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3266
|
+
*/
|
|
3267
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata {
|
|
2933
3268
|
/**
|
|
2934
3269
|
* Operation create time.
|
|
2935
3270
|
*/
|
|
@@ -2940,147 +3275,155 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2940
3275
|
updateTime?: string | null;
|
|
2941
3276
|
}
|
|
2942
3277
|
/**
|
|
2943
|
-
*
|
|
3278
|
+
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
2944
3279
|
*/
|
|
2945
|
-
export interface Schema$
|
|
2946
|
-
/**
|
|
2947
|
-
* Operation create time.
|
|
2948
|
-
*/
|
|
2949
|
-
createTime?: string | null;
|
|
3280
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse {
|
|
2950
3281
|
/**
|
|
2951
|
-
*
|
|
3282
|
+
* TargetSites created.
|
|
2952
3283
|
*/
|
|
2953
|
-
|
|
3284
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[];
|
|
3285
|
+
}
|
|
3286
|
+
/**
|
|
3287
|
+
* Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3288
|
+
*/
|
|
3289
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata {
|
|
2954
3290
|
/**
|
|
2955
|
-
*
|
|
3291
|
+
* Operation create time.
|
|
2956
3292
|
*/
|
|
2957
|
-
|
|
3293
|
+
createTime?: string | null;
|
|
2958
3294
|
/**
|
|
2959
3295
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
2960
3296
|
*/
|
|
2961
3297
|
updateTime?: string | null;
|
|
2962
3298
|
}
|
|
2963
3299
|
/**
|
|
2964
|
-
*
|
|
3300
|
+
* Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
2965
3301
|
*/
|
|
2966
|
-
export interface Schema$
|
|
3302
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEngineMetadata {
|
|
2967
3303
|
/**
|
|
2968
|
-
*
|
|
3304
|
+
* Operation create time.
|
|
2969
3305
|
*/
|
|
2970
|
-
|
|
3306
|
+
createTime?: string | null;
|
|
2971
3307
|
/**
|
|
2972
|
-
*
|
|
3308
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
2973
3309
|
*/
|
|
2974
|
-
|
|
3310
|
+
updateTime?: string | null;
|
|
2975
3311
|
}
|
|
2976
3312
|
/**
|
|
2977
|
-
*
|
|
3313
|
+
* Metadata for Create Schema LRO.
|
|
2978
3314
|
*/
|
|
2979
|
-
export interface Schema$
|
|
3315
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata {
|
|
2980
3316
|
/**
|
|
2981
|
-
*
|
|
3317
|
+
* Operation create time.
|
|
2982
3318
|
*/
|
|
2983
|
-
|
|
3319
|
+
createTime?: string | null;
|
|
3320
|
+
/**
|
|
3321
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3322
|
+
*/
|
|
3323
|
+
updateTime?: string | null;
|
|
2984
3324
|
}
|
|
2985
3325
|
/**
|
|
2986
|
-
* Metadata related to the progress of the
|
|
3326
|
+
* Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
2987
3327
|
*/
|
|
2988
|
-
export interface Schema$
|
|
3328
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata {
|
|
2989
3329
|
/**
|
|
2990
3330
|
* Operation create time.
|
|
2991
3331
|
*/
|
|
2992
3332
|
createTime?: string | null;
|
|
2993
|
-
/**
|
|
2994
|
-
* Count of entries that encountered errors while processing.
|
|
2995
|
-
*/
|
|
2996
|
-
failureCount?: string | null;
|
|
2997
|
-
/**
|
|
2998
|
-
* Count of entries that were processed successfully.
|
|
2999
|
-
*/
|
|
3000
|
-
successCount?: string | null;
|
|
3001
3333
|
/**
|
|
3002
3334
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3003
3335
|
*/
|
|
3004
3336
|
updateTime?: string | null;
|
|
3005
3337
|
}
|
|
3006
3338
|
/**
|
|
3007
|
-
*
|
|
3339
|
+
* DataStore captures global settings and configs at the DataStore level.
|
|
3008
3340
|
*/
|
|
3009
|
-
export interface Schema$
|
|
3341
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore {
|
|
3010
3342
|
/**
|
|
3011
|
-
*
|
|
3343
|
+
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
3012
3344
|
*/
|
|
3013
|
-
|
|
3345
|
+
contentConfig?: string | null;
|
|
3014
3346
|
/**
|
|
3015
|
-
*
|
|
3347
|
+
* Output only. Timestamp the DataStore was created at.
|
|
3016
3348
|
*/
|
|
3017
|
-
|
|
3349
|
+
createTime?: string | null;
|
|
3018
3350
|
/**
|
|
3019
|
-
*
|
|
3351
|
+
* Output only. The id of the default Schema asscociated to this data store.
|
|
3020
3352
|
*/
|
|
3021
|
-
|
|
3353
|
+
defaultSchemaId?: string | null;
|
|
3022
3354
|
/**
|
|
3023
|
-
*
|
|
3355
|
+
* Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3024
3356
|
*/
|
|
3025
|
-
|
|
3357
|
+
displayName?: string | null;
|
|
3358
|
+
/**
|
|
3359
|
+
* Immutable. The industry vertical that the data store registers.
|
|
3360
|
+
*/
|
|
3361
|
+
industryVertical?: string | null;
|
|
3362
|
+
/**
|
|
3363
|
+
* Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
3364
|
+
*/
|
|
3365
|
+
name?: string | null;
|
|
3366
|
+
/**
|
|
3367
|
+
* The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
|
|
3368
|
+
*/
|
|
3369
|
+
solutionTypes?: string[] | null;
|
|
3026
3370
|
}
|
|
3027
3371
|
/**
|
|
3028
|
-
* Metadata related to the progress of the
|
|
3372
|
+
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3029
3373
|
*/
|
|
3030
|
-
export interface Schema$
|
|
3374
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
|
|
3031
3375
|
/**
|
|
3032
3376
|
* Operation create time.
|
|
3033
3377
|
*/
|
|
3034
3378
|
createTime?: string | null;
|
|
3035
3379
|
/**
|
|
3036
|
-
*
|
|
3380
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3037
3381
|
*/
|
|
3038
|
-
|
|
3382
|
+
updateTime?: string | null;
|
|
3383
|
+
}
|
|
3384
|
+
/**
|
|
3385
|
+
* Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3386
|
+
*/
|
|
3387
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata {
|
|
3039
3388
|
/**
|
|
3040
|
-
*
|
|
3389
|
+
* Operation create time.
|
|
3041
3390
|
*/
|
|
3042
|
-
|
|
3391
|
+
createTime?: string | null;
|
|
3043
3392
|
/**
|
|
3044
3393
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3045
3394
|
*/
|
|
3046
3395
|
updateTime?: string | null;
|
|
3047
3396
|
}
|
|
3048
3397
|
/**
|
|
3049
|
-
*
|
|
3398
|
+
* Metadata for DeleteSchema LRO.
|
|
3050
3399
|
*/
|
|
3051
|
-
export interface Schema$
|
|
3400
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata {
|
|
3052
3401
|
/**
|
|
3053
|
-
*
|
|
3402
|
+
* Operation create time.
|
|
3054
3403
|
*/
|
|
3055
|
-
|
|
3404
|
+
createTime?: string | null;
|
|
3056
3405
|
/**
|
|
3057
|
-
*
|
|
3406
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3058
3407
|
*/
|
|
3059
|
-
|
|
3408
|
+
updateTime?: string | null;
|
|
3060
3409
|
}
|
|
3061
3410
|
/**
|
|
3062
|
-
*
|
|
3411
|
+
* Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3063
3412
|
*/
|
|
3064
|
-
export interface Schema$
|
|
3065
|
-
/**
|
|
3066
|
-
* The JSON representation of the schema.
|
|
3067
|
-
*/
|
|
3068
|
-
jsonSchema?: string | null;
|
|
3413
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata {
|
|
3069
3414
|
/**
|
|
3070
|
-
*
|
|
3415
|
+
* Operation create time.
|
|
3071
3416
|
*/
|
|
3072
|
-
|
|
3417
|
+
createTime?: string | null;
|
|
3073
3418
|
/**
|
|
3074
|
-
*
|
|
3419
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3075
3420
|
*/
|
|
3076
|
-
|
|
3077
|
-
[key: string]: any;
|
|
3078
|
-
} | null;
|
|
3421
|
+
updateTime?: string | null;
|
|
3079
3422
|
}
|
|
3080
3423
|
/**
|
|
3081
|
-
* Metadata
|
|
3424
|
+
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3082
3425
|
*/
|
|
3083
|
-
export interface Schema$
|
|
3426
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata {
|
|
3084
3427
|
/**
|
|
3085
3428
|
* Operation create time.
|
|
3086
3429
|
*/
|
|
@@ -3091,9 +3434,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3091
3434
|
updateTime?: string | null;
|
|
3092
3435
|
}
|
|
3093
3436
|
/**
|
|
3094
|
-
*
|
|
3437
|
+
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
3095
3438
|
*/
|
|
3096
|
-
export interface Schema$
|
|
3439
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {
|
|
3440
|
+
}
|
|
3441
|
+
/**
|
|
3442
|
+
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3443
|
+
*/
|
|
3444
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata {
|
|
3097
3445
|
/**
|
|
3098
3446
|
* Operation create time.
|
|
3099
3447
|
*/
|
|
@@ -3104,22 +3452,128 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3104
3452
|
updateTime?: string | null;
|
|
3105
3453
|
}
|
|
3106
3454
|
/**
|
|
3107
|
-
*
|
|
3455
|
+
* Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
|
3108
3456
|
*/
|
|
3109
|
-
export interface Schema$
|
|
3457
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse {
|
|
3458
|
+
}
|
|
3459
|
+
/**
|
|
3460
|
+
* Metadata that describes the training and serving parameters of an Engine.
|
|
3461
|
+
*/
|
|
3462
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngine {
|
|
3110
3463
|
/**
|
|
3111
|
-
*
|
|
3464
|
+
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3465
|
+
*/
|
|
3466
|
+
chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig;
|
|
3467
|
+
/**
|
|
3468
|
+
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3469
|
+
*/
|
|
3470
|
+
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata;
|
|
3471
|
+
/**
|
|
3472
|
+
* Common config spec that specifies the metadata of the engine.
|
|
3473
|
+
*/
|
|
3474
|
+
commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig;
|
|
3475
|
+
/**
|
|
3476
|
+
* Output only. Timestamp the Recommendation Engine was created at.
|
|
3112
3477
|
*/
|
|
3113
3478
|
createTime?: string | null;
|
|
3114
3479
|
/**
|
|
3115
|
-
*
|
|
3480
|
+
* The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
|
|
3481
|
+
*/
|
|
3482
|
+
dataStoreIds?: string[] | null;
|
|
3483
|
+
/**
|
|
3484
|
+
* Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
|
|
3485
|
+
*/
|
|
3486
|
+
displayName?: string | null;
|
|
3487
|
+
/**
|
|
3488
|
+
* The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.
|
|
3489
|
+
*/
|
|
3490
|
+
industryVertical?: string | null;
|
|
3491
|
+
/**
|
|
3492
|
+
* Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3493
|
+
*/
|
|
3494
|
+
name?: string | null;
|
|
3495
|
+
/**
|
|
3496
|
+
* Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
3497
|
+
*/
|
|
3498
|
+
searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
|
|
3499
|
+
/**
|
|
3500
|
+
* Required. The solutions of the engine.
|
|
3501
|
+
*/
|
|
3502
|
+
solutionType?: string | null;
|
|
3503
|
+
/**
|
|
3504
|
+
* Output only. Timestamp the Recommendation Engine was last updated.
|
|
3116
3505
|
*/
|
|
3117
3506
|
updateTime?: string | null;
|
|
3118
3507
|
}
|
|
3508
|
+
/**
|
|
3509
|
+
* Configurations for a Chat Engine.
|
|
3510
|
+
*/
|
|
3511
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig {
|
|
3512
|
+
/**
|
|
3513
|
+
* The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
3514
|
+
*/
|
|
3515
|
+
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
|
|
3516
|
+
/**
|
|
3517
|
+
* The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
|
|
3518
|
+
*/
|
|
3519
|
+
dialogflowAgentToLink?: string | null;
|
|
3520
|
+
}
|
|
3521
|
+
/**
|
|
3522
|
+
* Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
3523
|
+
*/
|
|
3524
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig {
|
|
3525
|
+
/**
|
|
3526
|
+
* Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
|
|
3527
|
+
*/
|
|
3528
|
+
business?: string | null;
|
|
3529
|
+
/**
|
|
3530
|
+
* Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
|
|
3531
|
+
*/
|
|
3532
|
+
defaultLanguageCode?: string | null;
|
|
3533
|
+
/**
|
|
3534
|
+
* Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
|
|
3535
|
+
*/
|
|
3536
|
+
location?: string | null;
|
|
3537
|
+
/**
|
|
3538
|
+
* Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
|
|
3539
|
+
*/
|
|
3540
|
+
timeZone?: string | null;
|
|
3541
|
+
}
|
|
3542
|
+
/**
|
|
3543
|
+
* Additional information of a Chat Engine. Fields in this message are output only.
|
|
3544
|
+
*/
|
|
3545
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata {
|
|
3546
|
+
/**
|
|
3547
|
+
* The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
|
|
3548
|
+
*/
|
|
3549
|
+
dialogflowAgent?: string | null;
|
|
3550
|
+
}
|
|
3551
|
+
/**
|
|
3552
|
+
* Common configurations for an Engine.
|
|
3553
|
+
*/
|
|
3554
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig {
|
|
3555
|
+
/**
|
|
3556
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
3557
|
+
*/
|
|
3558
|
+
companyName?: string | null;
|
|
3559
|
+
}
|
|
3560
|
+
/**
|
|
3561
|
+
* Configurations for a Search Engine.
|
|
3562
|
+
*/
|
|
3563
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
3564
|
+
/**
|
|
3565
|
+
* The add-on that this search engine enables.
|
|
3566
|
+
*/
|
|
3567
|
+
searchAddOns?: string[] | null;
|
|
3568
|
+
/**
|
|
3569
|
+
* The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
|
|
3570
|
+
*/
|
|
3571
|
+
searchTier?: string | null;
|
|
3572
|
+
}
|
|
3119
3573
|
/**
|
|
3120
3574
|
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3121
3575
|
*/
|
|
3122
|
-
export interface Schema$
|
|
3576
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
|
|
3123
3577
|
/**
|
|
3124
3578
|
* Operation create time.
|
|
3125
3579
|
*/
|
|
@@ -3140,11 +3594,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3140
3594
|
/**
|
|
3141
3595
|
* Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
|
|
3142
3596
|
*/
|
|
3143
|
-
export interface Schema$
|
|
3597
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsResponse {
|
|
3144
3598
|
/**
|
|
3145
3599
|
* Echoes the destination for the complete errors in the request if set.
|
|
3146
3600
|
*/
|
|
3147
|
-
errorConfig?: Schema$
|
|
3601
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
3148
3602
|
/**
|
|
3149
3603
|
* A sample of errors encountered while processing the request.
|
|
3150
3604
|
*/
|
|
@@ -3153,16 +3607,46 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3153
3607
|
/**
|
|
3154
3608
|
* Configuration of destination for Import related errors.
|
|
3155
3609
|
*/
|
|
3156
|
-
export interface Schema$
|
|
3610
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig {
|
|
3157
3611
|
/**
|
|
3158
3612
|
* Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
|
|
3159
3613
|
*/
|
|
3160
3614
|
gcsPrefix?: string | null;
|
|
3161
3615
|
}
|
|
3616
|
+
/**
|
|
3617
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3618
|
+
*/
|
|
3619
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata {
|
|
3620
|
+
/**
|
|
3621
|
+
* Operation create time.
|
|
3622
|
+
*/
|
|
3623
|
+
createTime?: string | null;
|
|
3624
|
+
/**
|
|
3625
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3626
|
+
*/
|
|
3627
|
+
updateTime?: string | null;
|
|
3628
|
+
}
|
|
3629
|
+
/**
|
|
3630
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
3631
|
+
*/
|
|
3632
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse {
|
|
3633
|
+
/**
|
|
3634
|
+
* A sample of errors encountered while processing the request.
|
|
3635
|
+
*/
|
|
3636
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3637
|
+
/**
|
|
3638
|
+
* Count of deny list entries that failed to be imported.
|
|
3639
|
+
*/
|
|
3640
|
+
failedEntriesCount?: string | null;
|
|
3641
|
+
/**
|
|
3642
|
+
* Count of deny list entries successfully imported.
|
|
3643
|
+
*/
|
|
3644
|
+
importedEntriesCount?: string | null;
|
|
3645
|
+
}
|
|
3162
3646
|
/**
|
|
3163
3647
|
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3164
3648
|
*/
|
|
3165
|
-
export interface Schema$
|
|
3649
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata {
|
|
3166
3650
|
/**
|
|
3167
3651
|
* Operation create time.
|
|
3168
3652
|
*/
|
|
@@ -3183,81 +3667,765 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3183
3667
|
/**
|
|
3184
3668
|
* Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
|
|
3185
3669
|
*/
|
|
3186
|
-
export interface Schema$
|
|
3670
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsResponse {
|
|
3187
3671
|
/**
|
|
3188
3672
|
* Echoes the destination for the complete errors if this field was set in the request.
|
|
3189
3673
|
*/
|
|
3190
|
-
errorConfig?: Schema$
|
|
3674
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
3191
3675
|
/**
|
|
3192
3676
|
* A sample of errors encountered while processing the request.
|
|
3193
3677
|
*/
|
|
3194
3678
|
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3195
3679
|
/**
|
|
3196
|
-
* Count of user events imported with complete existing Documents.
|
|
3680
|
+
* Count of user events imported with complete existing Documents.
|
|
3681
|
+
*/
|
|
3682
|
+
joinedEventsCount?: string | null;
|
|
3683
|
+
/**
|
|
3684
|
+
* Count of user events imported, but with Document information not found in the existing Branch.
|
|
3685
|
+
*/
|
|
3686
|
+
unjoinedEventsCount?: string | null;
|
|
3687
|
+
}
|
|
3688
|
+
/**
|
|
3689
|
+
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3690
|
+
*/
|
|
3691
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
|
|
3692
|
+
/**
|
|
3693
|
+
* Operation create time.
|
|
3694
|
+
*/
|
|
3695
|
+
createTime?: string | null;
|
|
3696
|
+
/**
|
|
3697
|
+
* Count of entries that encountered errors while processing.
|
|
3698
|
+
*/
|
|
3699
|
+
failureCount?: string | null;
|
|
3700
|
+
/**
|
|
3701
|
+
* Count of entries that were deleted successfully.
|
|
3702
|
+
*/
|
|
3703
|
+
successCount?: string | null;
|
|
3704
|
+
/**
|
|
3705
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3706
|
+
*/
|
|
3707
|
+
updateTime?: string | null;
|
|
3708
|
+
}
|
|
3709
|
+
/**
|
|
3710
|
+
* Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
|
|
3711
|
+
*/
|
|
3712
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse {
|
|
3713
|
+
/**
|
|
3714
|
+
* The total count of documents purged as a result of the operation.
|
|
3715
|
+
*/
|
|
3716
|
+
purgeCount?: string | null;
|
|
3717
|
+
/**
|
|
3718
|
+
* A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.
|
|
3719
|
+
*/
|
|
3720
|
+
purgeSample?: string[] | null;
|
|
3721
|
+
}
|
|
3722
|
+
/**
|
|
3723
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3724
|
+
*/
|
|
3725
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata {
|
|
3726
|
+
/**
|
|
3727
|
+
* Operation create time.
|
|
3728
|
+
*/
|
|
3729
|
+
createTime?: string | null;
|
|
3730
|
+
/**
|
|
3731
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3732
|
+
*/
|
|
3733
|
+
updateTime?: string | null;
|
|
3734
|
+
}
|
|
3735
|
+
/**
|
|
3736
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
3737
|
+
*/
|
|
3738
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse {
|
|
3739
|
+
/**
|
|
3740
|
+
* A sample of errors encountered while processing the request.
|
|
3741
|
+
*/
|
|
3742
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3743
|
+
/**
|
|
3744
|
+
* Number of suggestion deny list entries purged.
|
|
3745
|
+
*/
|
|
3746
|
+
purgeCount?: string | null;
|
|
3747
|
+
}
|
|
3748
|
+
/**
|
|
3749
|
+
* Defines the structure and layout of a type of document data.
|
|
3750
|
+
*/
|
|
3751
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSchema {
|
|
3752
|
+
/**
|
|
3753
|
+
* The JSON representation of the schema.
|
|
3754
|
+
*/
|
|
3755
|
+
jsonSchema?: string | null;
|
|
3756
|
+
/**
|
|
3757
|
+
* Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
3758
|
+
*/
|
|
3759
|
+
name?: string | null;
|
|
3760
|
+
/**
|
|
3761
|
+
* The structured representation of the schema.
|
|
3762
|
+
*/
|
|
3763
|
+
structSchema?: {
|
|
3764
|
+
[key: string]: any;
|
|
3765
|
+
} | null;
|
|
3766
|
+
}
|
|
3767
|
+
/**
|
|
3768
|
+
* Verification information for target sites in advanced site search.
|
|
3769
|
+
*/
|
|
3770
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo {
|
|
3771
|
+
/**
|
|
3772
|
+
* Site verification state indicating the ownership and validity.
|
|
3773
|
+
*/
|
|
3774
|
+
siteVerificationState?: string | null;
|
|
3775
|
+
/**
|
|
3776
|
+
* Latest site verification time.
|
|
3777
|
+
*/
|
|
3778
|
+
verifyTime?: string | null;
|
|
3779
|
+
}
|
|
3780
|
+
/**
|
|
3781
|
+
* A target site for the SiteSearchEngine.
|
|
3782
|
+
*/
|
|
3783
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSite {
|
|
3784
|
+
/**
|
|
3785
|
+
* Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
|
|
3786
|
+
*/
|
|
3787
|
+
exactMatch?: boolean | null;
|
|
3788
|
+
/**
|
|
3789
|
+
* Output only. Failure reason.
|
|
3790
|
+
*/
|
|
3791
|
+
failureReason?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason;
|
|
3792
|
+
/**
|
|
3793
|
+
* Output only. This is system-generated based on the provided_uri_pattern.
|
|
3794
|
+
*/
|
|
3795
|
+
generatedUriPattern?: string | null;
|
|
3796
|
+
/**
|
|
3797
|
+
* Output only. Indexing status.
|
|
3798
|
+
*/
|
|
3799
|
+
indexingStatus?: string | null;
|
|
3800
|
+
/**
|
|
3801
|
+
* Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated.
|
|
3802
|
+
*/
|
|
3803
|
+
name?: string | null;
|
|
3804
|
+
/**
|
|
3805
|
+
* Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
|
|
3806
|
+
*/
|
|
3807
|
+
providedUriPattern?: string | null;
|
|
3808
|
+
/**
|
|
3809
|
+
* Output only. Site ownership and validity verification status.
|
|
3810
|
+
*/
|
|
3811
|
+
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo;
|
|
3812
|
+
/**
|
|
3813
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
3814
|
+
*/
|
|
3815
|
+
type?: string | null;
|
|
3816
|
+
/**
|
|
3817
|
+
* Output only. The target site's last updated time.
|
|
3818
|
+
*/
|
|
3819
|
+
updateTime?: string | null;
|
|
3820
|
+
}
|
|
3821
|
+
/**
|
|
3822
|
+
* Site search indexing failure reasons.
|
|
3823
|
+
*/
|
|
3824
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason {
|
|
3825
|
+
/**
|
|
3826
|
+
* Failed due to insufficient quota.
|
|
3827
|
+
*/
|
|
3828
|
+
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure;
|
|
3829
|
+
}
|
|
3830
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure {
|
|
3831
|
+
/**
|
|
3832
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
3833
|
+
*/
|
|
3834
|
+
totalRequiredQuota?: string | null;
|
|
3835
|
+
}
|
|
3836
|
+
/**
|
|
3837
|
+
* Metadata for UpdateSchema LRO.
|
|
3838
|
+
*/
|
|
3839
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
|
|
3840
|
+
/**
|
|
3841
|
+
* Operation create time.
|
|
3842
|
+
*/
|
|
3843
|
+
createTime?: string | null;
|
|
3844
|
+
/**
|
|
3845
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3846
|
+
*/
|
|
3847
|
+
updateTime?: string | null;
|
|
3848
|
+
}
|
|
3849
|
+
/**
|
|
3850
|
+
* Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3851
|
+
*/
|
|
3852
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata {
|
|
3853
|
+
/**
|
|
3854
|
+
* Operation create time.
|
|
3855
|
+
*/
|
|
3856
|
+
createTime?: string | null;
|
|
3857
|
+
/**
|
|
3858
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3859
|
+
*/
|
|
3860
|
+
updateTime?: string | null;
|
|
3861
|
+
}
|
|
3862
|
+
/**
|
|
3863
|
+
* Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3864
|
+
*/
|
|
3865
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateDataStoreMetadata {
|
|
3866
|
+
/**
|
|
3867
|
+
* Operation create time.
|
|
3868
|
+
*/
|
|
3869
|
+
createTime?: string | null;
|
|
3870
|
+
/**
|
|
3871
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3872
|
+
*/
|
|
3873
|
+
updateTime?: string | null;
|
|
3874
|
+
}
|
|
3875
|
+
/**
|
|
3876
|
+
* Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3877
|
+
*/
|
|
3878
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateEngineMetadata {
|
|
3879
|
+
/**
|
|
3880
|
+
* Operation create time.
|
|
3881
|
+
*/
|
|
3882
|
+
createTime?: string | null;
|
|
3883
|
+
/**
|
|
3884
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3885
|
+
*/
|
|
3886
|
+
updateTime?: string | null;
|
|
3887
|
+
}
|
|
3888
|
+
/**
|
|
3889
|
+
* Metadata for Create Schema LRO.
|
|
3890
|
+
*/
|
|
3891
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateSchemaMetadata {
|
|
3892
|
+
/**
|
|
3893
|
+
* Operation create time.
|
|
3894
|
+
*/
|
|
3895
|
+
createTime?: string | null;
|
|
3896
|
+
/**
|
|
3897
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3898
|
+
*/
|
|
3899
|
+
updateTime?: string | null;
|
|
3900
|
+
}
|
|
3901
|
+
/**
|
|
3902
|
+
* Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3903
|
+
*/
|
|
3904
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata {
|
|
3905
|
+
/**
|
|
3906
|
+
* Operation create time.
|
|
3907
|
+
*/
|
|
3908
|
+
createTime?: string | null;
|
|
3909
|
+
/**
|
|
3910
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3911
|
+
*/
|
|
3912
|
+
updateTime?: string | null;
|
|
3913
|
+
}
|
|
3914
|
+
/**
|
|
3915
|
+
* DataStore captures global settings and configs at the DataStore level.
|
|
3916
|
+
*/
|
|
3917
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataStore {
|
|
3918
|
+
/**
|
|
3919
|
+
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
3920
|
+
*/
|
|
3921
|
+
contentConfig?: string | null;
|
|
3922
|
+
/**
|
|
3923
|
+
* Output only. Timestamp the DataStore was created at.
|
|
3924
|
+
*/
|
|
3925
|
+
createTime?: string | null;
|
|
3926
|
+
/**
|
|
3927
|
+
* Output only. The id of the default Schema asscociated to this data store.
|
|
3928
|
+
*/
|
|
3929
|
+
defaultSchemaId?: string | null;
|
|
3930
|
+
/**
|
|
3931
|
+
* Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3932
|
+
*/
|
|
3933
|
+
displayName?: string | null;
|
|
3934
|
+
/**
|
|
3935
|
+
* Immutable. The industry vertical that the data store registers.
|
|
3936
|
+
*/
|
|
3937
|
+
industryVertical?: string | null;
|
|
3938
|
+
/**
|
|
3939
|
+
* Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
3940
|
+
*/
|
|
3941
|
+
name?: string | null;
|
|
3942
|
+
/**
|
|
3943
|
+
* The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
|
|
3944
|
+
*/
|
|
3945
|
+
solutionTypes?: string[] | null;
|
|
3946
|
+
}
|
|
3947
|
+
/**
|
|
3948
|
+
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3949
|
+
*/
|
|
3950
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
|
|
3951
|
+
/**
|
|
3952
|
+
* Operation create time.
|
|
3953
|
+
*/
|
|
3954
|
+
createTime?: string | null;
|
|
3955
|
+
/**
|
|
3956
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3957
|
+
*/
|
|
3958
|
+
updateTime?: string | null;
|
|
3959
|
+
}
|
|
3960
|
+
/**
|
|
3961
|
+
* Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3962
|
+
*/
|
|
3963
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteEngineMetadata {
|
|
3964
|
+
/**
|
|
3965
|
+
* Operation create time.
|
|
3966
|
+
*/
|
|
3967
|
+
createTime?: string | null;
|
|
3968
|
+
/**
|
|
3969
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3970
|
+
*/
|
|
3971
|
+
updateTime?: string | null;
|
|
3972
|
+
}
|
|
3973
|
+
/**
|
|
3974
|
+
* Metadata for DeleteSchema LRO.
|
|
3975
|
+
*/
|
|
3976
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteSchemaMetadata {
|
|
3977
|
+
/**
|
|
3978
|
+
* Operation create time.
|
|
3979
|
+
*/
|
|
3980
|
+
createTime?: string | null;
|
|
3981
|
+
/**
|
|
3982
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3983
|
+
*/
|
|
3984
|
+
updateTime?: string | null;
|
|
3985
|
+
}
|
|
3986
|
+
/**
|
|
3987
|
+
* Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3988
|
+
*/
|
|
3989
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata {
|
|
3990
|
+
/**
|
|
3991
|
+
* Operation create time.
|
|
3992
|
+
*/
|
|
3993
|
+
createTime?: string | null;
|
|
3994
|
+
/**
|
|
3995
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3996
|
+
*/
|
|
3997
|
+
updateTime?: string | null;
|
|
3998
|
+
}
|
|
3999
|
+
/**
|
|
4000
|
+
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4001
|
+
*/
|
|
4002
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata {
|
|
4003
|
+
/**
|
|
4004
|
+
* Operation create time.
|
|
4005
|
+
*/
|
|
4006
|
+
createTime?: string | null;
|
|
4007
|
+
/**
|
|
4008
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4009
|
+
*/
|
|
4010
|
+
updateTime?: string | null;
|
|
4011
|
+
}
|
|
4012
|
+
/**
|
|
4013
|
+
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
4014
|
+
*/
|
|
4015
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {
|
|
4016
|
+
}
|
|
4017
|
+
/**
|
|
4018
|
+
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4019
|
+
*/
|
|
4020
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
|
|
4021
|
+
/**
|
|
4022
|
+
* Operation create time.
|
|
4023
|
+
*/
|
|
4024
|
+
createTime?: string | null;
|
|
4025
|
+
/**
|
|
4026
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4027
|
+
*/
|
|
4028
|
+
updateTime?: string | null;
|
|
4029
|
+
}
|
|
4030
|
+
/**
|
|
4031
|
+
* Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
|
4032
|
+
*/
|
|
4033
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {
|
|
4034
|
+
}
|
|
4035
|
+
/**
|
|
4036
|
+
* Metadata that describes the training and serving parameters of an Engine.
|
|
4037
|
+
*/
|
|
4038
|
+
export interface Schema$GoogleCloudDiscoveryengineV1Engine {
|
|
4039
|
+
/**
|
|
4040
|
+
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
4041
|
+
*/
|
|
4042
|
+
chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig;
|
|
4043
|
+
/**
|
|
4044
|
+
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
4045
|
+
*/
|
|
4046
|
+
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata;
|
|
4047
|
+
/**
|
|
4048
|
+
* Common config spec that specifies the metadata of the engine.
|
|
4049
|
+
*/
|
|
4050
|
+
commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig;
|
|
4051
|
+
/**
|
|
4052
|
+
* Output only. Timestamp the Recommendation Engine was created at.
|
|
4053
|
+
*/
|
|
4054
|
+
createTime?: string | null;
|
|
4055
|
+
/**
|
|
4056
|
+
* The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
|
|
4057
|
+
*/
|
|
4058
|
+
dataStoreIds?: string[] | null;
|
|
4059
|
+
/**
|
|
4060
|
+
* Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
|
|
4061
|
+
*/
|
|
4062
|
+
displayName?: string | null;
|
|
4063
|
+
/**
|
|
4064
|
+
* The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.
|
|
4065
|
+
*/
|
|
4066
|
+
industryVertical?: string | null;
|
|
4067
|
+
/**
|
|
4068
|
+
* Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
4069
|
+
*/
|
|
4070
|
+
name?: string | null;
|
|
4071
|
+
/**
|
|
4072
|
+
* Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
4073
|
+
*/
|
|
4074
|
+
searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
|
|
4075
|
+
/**
|
|
4076
|
+
* Required. The solutions of the engine.
|
|
4077
|
+
*/
|
|
4078
|
+
solutionType?: string | null;
|
|
4079
|
+
/**
|
|
4080
|
+
* Output only. Timestamp the Recommendation Engine was last updated.
|
|
4081
|
+
*/
|
|
4082
|
+
updateTime?: string | null;
|
|
4083
|
+
}
|
|
4084
|
+
/**
|
|
4085
|
+
* Configurations for a Chat Engine.
|
|
4086
|
+
*/
|
|
4087
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig {
|
|
4088
|
+
/**
|
|
4089
|
+
* The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
4090
|
+
*/
|
|
4091
|
+
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
|
|
4092
|
+
/**
|
|
4093
|
+
* The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
|
|
4094
|
+
*/
|
|
4095
|
+
dialogflowAgentToLink?: string | null;
|
|
4096
|
+
}
|
|
4097
|
+
/**
|
|
4098
|
+
* Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
4099
|
+
*/
|
|
4100
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig {
|
|
4101
|
+
/**
|
|
4102
|
+
* Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
|
|
4103
|
+
*/
|
|
4104
|
+
business?: string | null;
|
|
4105
|
+
/**
|
|
4106
|
+
* Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
|
|
4107
|
+
*/
|
|
4108
|
+
defaultLanguageCode?: string | null;
|
|
4109
|
+
/**
|
|
4110
|
+
* Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
|
|
4111
|
+
*/
|
|
4112
|
+
location?: string | null;
|
|
4113
|
+
/**
|
|
4114
|
+
* Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
|
|
4115
|
+
*/
|
|
4116
|
+
timeZone?: string | null;
|
|
4117
|
+
}
|
|
4118
|
+
/**
|
|
4119
|
+
* Additional information of a Chat Engine. Fields in this message are output only.
|
|
4120
|
+
*/
|
|
4121
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata {
|
|
4122
|
+
/**
|
|
4123
|
+
* The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
|
|
4124
|
+
*/
|
|
4125
|
+
dialogflowAgent?: string | null;
|
|
4126
|
+
}
|
|
4127
|
+
/**
|
|
4128
|
+
* Common configurations for an Engine.
|
|
4129
|
+
*/
|
|
4130
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig {
|
|
4131
|
+
/**
|
|
4132
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
4133
|
+
*/
|
|
4134
|
+
companyName?: string | null;
|
|
4135
|
+
}
|
|
4136
|
+
/**
|
|
4137
|
+
* Configurations for a Search Engine.
|
|
4138
|
+
*/
|
|
4139
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
4140
|
+
/**
|
|
4141
|
+
* The add-on that this search engine enables.
|
|
4142
|
+
*/
|
|
4143
|
+
searchAddOns?: string[] | null;
|
|
4144
|
+
/**
|
|
4145
|
+
* The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
|
|
4146
|
+
*/
|
|
4147
|
+
searchTier?: string | null;
|
|
4148
|
+
}
|
|
4149
|
+
/**
|
|
4150
|
+
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
4151
|
+
*/
|
|
4152
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsMetadata {
|
|
4153
|
+
/**
|
|
4154
|
+
* Operation create time.
|
|
4155
|
+
*/
|
|
4156
|
+
createTime?: string | null;
|
|
4157
|
+
/**
|
|
4158
|
+
* Count of entries that encountered errors while processing.
|
|
4159
|
+
*/
|
|
4160
|
+
failureCount?: string | null;
|
|
4161
|
+
/**
|
|
4162
|
+
* Count of entries that were processed successfully.
|
|
4163
|
+
*/
|
|
4164
|
+
successCount?: string | null;
|
|
4165
|
+
/**
|
|
4166
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4167
|
+
*/
|
|
4168
|
+
updateTime?: string | null;
|
|
4169
|
+
}
|
|
4170
|
+
/**
|
|
4171
|
+
* Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
|
|
4172
|
+
*/
|
|
4173
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsResponse {
|
|
4174
|
+
/**
|
|
4175
|
+
* Echoes the destination for the complete errors in the request if set.
|
|
4176
|
+
*/
|
|
4177
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig;
|
|
4178
|
+
/**
|
|
4179
|
+
* A sample of errors encountered while processing the request.
|
|
4180
|
+
*/
|
|
4181
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4182
|
+
}
|
|
4183
|
+
/**
|
|
4184
|
+
* Configuration of destination for Import related errors.
|
|
4185
|
+
*/
|
|
4186
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig {
|
|
4187
|
+
/**
|
|
4188
|
+
* Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
|
|
4189
|
+
*/
|
|
4190
|
+
gcsPrefix?: string | null;
|
|
4191
|
+
}
|
|
4192
|
+
/**
|
|
4193
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
4194
|
+
*/
|
|
4195
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata {
|
|
4196
|
+
/**
|
|
4197
|
+
* Operation create time.
|
|
4198
|
+
*/
|
|
4199
|
+
createTime?: string | null;
|
|
4200
|
+
/**
|
|
4201
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4202
|
+
*/
|
|
4203
|
+
updateTime?: string | null;
|
|
4204
|
+
}
|
|
4205
|
+
/**
|
|
4206
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
4207
|
+
*/
|
|
4208
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse {
|
|
4209
|
+
/**
|
|
4210
|
+
* A sample of errors encountered while processing the request.
|
|
4211
|
+
*/
|
|
4212
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4213
|
+
/**
|
|
4214
|
+
* Count of deny list entries that failed to be imported.
|
|
4215
|
+
*/
|
|
4216
|
+
failedEntriesCount?: string | null;
|
|
4217
|
+
/**
|
|
4218
|
+
* Count of deny list entries successfully imported.
|
|
4219
|
+
*/
|
|
4220
|
+
importedEntriesCount?: string | null;
|
|
4221
|
+
}
|
|
4222
|
+
/**
|
|
4223
|
+
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
4224
|
+
*/
|
|
4225
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsMetadata {
|
|
4226
|
+
/**
|
|
4227
|
+
* Operation create time.
|
|
4228
|
+
*/
|
|
4229
|
+
createTime?: string | null;
|
|
4230
|
+
/**
|
|
4231
|
+
* Count of entries that encountered errors while processing.
|
|
4232
|
+
*/
|
|
4233
|
+
failureCount?: string | null;
|
|
4234
|
+
/**
|
|
4235
|
+
* Count of entries that were processed successfully.
|
|
4236
|
+
*/
|
|
4237
|
+
successCount?: string | null;
|
|
4238
|
+
/**
|
|
4239
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4240
|
+
*/
|
|
4241
|
+
updateTime?: string | null;
|
|
4242
|
+
}
|
|
4243
|
+
/**
|
|
4244
|
+
* Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
|
|
4245
|
+
*/
|
|
4246
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsResponse {
|
|
4247
|
+
/**
|
|
4248
|
+
* Echoes the destination for the complete errors if this field was set in the request.
|
|
4249
|
+
*/
|
|
4250
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig;
|
|
4251
|
+
/**
|
|
4252
|
+
* A sample of errors encountered while processing the request.
|
|
4253
|
+
*/
|
|
4254
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4255
|
+
/**
|
|
4256
|
+
* Count of user events imported with complete existing Documents.
|
|
4257
|
+
*/
|
|
4258
|
+
joinedEventsCount?: string | null;
|
|
4259
|
+
/**
|
|
4260
|
+
* Count of user events imported, but with Document information not found in the existing Branch.
|
|
4261
|
+
*/
|
|
4262
|
+
unjoinedEventsCount?: string | null;
|
|
4263
|
+
}
|
|
4264
|
+
/**
|
|
4265
|
+
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4266
|
+
*/
|
|
4267
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata {
|
|
4268
|
+
/**
|
|
4269
|
+
* Operation create time.
|
|
4270
|
+
*/
|
|
4271
|
+
createTime?: string | null;
|
|
4272
|
+
/**
|
|
4273
|
+
* Count of entries that encountered errors while processing.
|
|
4274
|
+
*/
|
|
4275
|
+
failureCount?: string | null;
|
|
4276
|
+
/**
|
|
4277
|
+
* Count of entries that were deleted successfully.
|
|
4278
|
+
*/
|
|
4279
|
+
successCount?: string | null;
|
|
4280
|
+
/**
|
|
4281
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4282
|
+
*/
|
|
4283
|
+
updateTime?: string | null;
|
|
4284
|
+
}
|
|
4285
|
+
/**
|
|
4286
|
+
* Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
|
|
4287
|
+
*/
|
|
4288
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsResponse {
|
|
4289
|
+
/**
|
|
4290
|
+
* The total count of documents purged as a result of the operation.
|
|
4291
|
+
*/
|
|
4292
|
+
purgeCount?: string | null;
|
|
4293
|
+
/**
|
|
4294
|
+
* A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.
|
|
4295
|
+
*/
|
|
4296
|
+
purgeSample?: string[] | null;
|
|
4297
|
+
}
|
|
4298
|
+
/**
|
|
4299
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
4300
|
+
*/
|
|
4301
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata {
|
|
4302
|
+
/**
|
|
4303
|
+
* Operation create time.
|
|
4304
|
+
*/
|
|
4305
|
+
createTime?: string | null;
|
|
4306
|
+
/**
|
|
4307
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4308
|
+
*/
|
|
4309
|
+
updateTime?: string | null;
|
|
4310
|
+
}
|
|
4311
|
+
/**
|
|
4312
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
4313
|
+
*/
|
|
4314
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse {
|
|
4315
|
+
/**
|
|
4316
|
+
* A sample of errors encountered while processing the request.
|
|
4317
|
+
*/
|
|
4318
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4319
|
+
/**
|
|
4320
|
+
* Number of suggestion deny list entries purged.
|
|
4321
|
+
*/
|
|
4322
|
+
purgeCount?: string | null;
|
|
4323
|
+
}
|
|
4324
|
+
/**
|
|
4325
|
+
* Defines the structure and layout of a type of document data.
|
|
4326
|
+
*/
|
|
4327
|
+
export interface Schema$GoogleCloudDiscoveryengineV1Schema {
|
|
4328
|
+
/**
|
|
4329
|
+
* The JSON representation of the schema.
|
|
4330
|
+
*/
|
|
4331
|
+
jsonSchema?: string | null;
|
|
4332
|
+
/**
|
|
4333
|
+
* Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
4334
|
+
*/
|
|
4335
|
+
name?: string | null;
|
|
4336
|
+
/**
|
|
4337
|
+
* The structured representation of the schema.
|
|
4338
|
+
*/
|
|
4339
|
+
structSchema?: {
|
|
4340
|
+
[key: string]: any;
|
|
4341
|
+
} | null;
|
|
4342
|
+
}
|
|
4343
|
+
/**
|
|
4344
|
+
* Verification information for target sites in advanced site search.
|
|
4345
|
+
*/
|
|
4346
|
+
export interface Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo {
|
|
4347
|
+
/**
|
|
4348
|
+
* Site verification state indicating the ownership and validity.
|
|
4349
|
+
*/
|
|
4350
|
+
siteVerificationState?: string | null;
|
|
4351
|
+
/**
|
|
4352
|
+
* Latest site verification time.
|
|
4353
|
+
*/
|
|
4354
|
+
verifyTime?: string | null;
|
|
4355
|
+
}
|
|
4356
|
+
/**
|
|
4357
|
+
* A target site for the SiteSearchEngine.
|
|
4358
|
+
*/
|
|
4359
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSite {
|
|
4360
|
+
/**
|
|
4361
|
+
* Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
|
|
4362
|
+
*/
|
|
4363
|
+
exactMatch?: boolean | null;
|
|
4364
|
+
/**
|
|
4365
|
+
* Output only. Failure reason.
|
|
4366
|
+
*/
|
|
4367
|
+
failureReason?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason;
|
|
4368
|
+
/**
|
|
4369
|
+
* Output only. This is system-generated based on the provided_uri_pattern.
|
|
4370
|
+
*/
|
|
4371
|
+
generatedUriPattern?: string | null;
|
|
4372
|
+
/**
|
|
4373
|
+
* Output only. Indexing status.
|
|
3197
4374
|
*/
|
|
3198
|
-
|
|
4375
|
+
indexingStatus?: string | null;
|
|
3199
4376
|
/**
|
|
3200
|
-
*
|
|
4377
|
+
* Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated.
|
|
3201
4378
|
*/
|
|
3202
|
-
|
|
3203
|
-
}
|
|
3204
|
-
/**
|
|
3205
|
-
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3206
|
-
*/
|
|
3207
|
-
export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata {
|
|
4379
|
+
name?: string | null;
|
|
3208
4380
|
/**
|
|
3209
|
-
*
|
|
4381
|
+
* Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
|
|
3210
4382
|
*/
|
|
3211
|
-
|
|
4383
|
+
providedUriPattern?: string | null;
|
|
3212
4384
|
/**
|
|
3213
|
-
*
|
|
4385
|
+
* Output only. Site ownership and validity verification status.
|
|
3214
4386
|
*/
|
|
3215
|
-
|
|
4387
|
+
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo;
|
|
3216
4388
|
/**
|
|
3217
|
-
*
|
|
4389
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
3218
4390
|
*/
|
|
3219
|
-
|
|
4391
|
+
type?: string | null;
|
|
3220
4392
|
/**
|
|
3221
|
-
*
|
|
4393
|
+
* Output only. The target site's last updated time.
|
|
3222
4394
|
*/
|
|
3223
4395
|
updateTime?: string | null;
|
|
3224
4396
|
}
|
|
3225
4397
|
/**
|
|
3226
|
-
*
|
|
4398
|
+
* Site search indexing failure reasons.
|
|
3227
4399
|
*/
|
|
3228
|
-
export interface Schema$
|
|
4400
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason {
|
|
3229
4401
|
/**
|
|
3230
|
-
*
|
|
4402
|
+
* Failed due to insufficient quota.
|
|
3231
4403
|
*/
|
|
3232
|
-
|
|
4404
|
+
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure;
|
|
4405
|
+
}
|
|
4406
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure {
|
|
3233
4407
|
/**
|
|
3234
|
-
*
|
|
4408
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
3235
4409
|
*/
|
|
3236
|
-
|
|
4410
|
+
totalRequiredQuota?: string | null;
|
|
3237
4411
|
}
|
|
3238
4412
|
/**
|
|
3239
|
-
*
|
|
4413
|
+
* Metadata for UpdateSchema LRO.
|
|
3240
4414
|
*/
|
|
3241
|
-
export interface Schema$
|
|
3242
|
-
/**
|
|
3243
|
-
* The JSON representation of the schema.
|
|
3244
|
-
*/
|
|
3245
|
-
jsonSchema?: string | null;
|
|
4415
|
+
export interface Schema$GoogleCloudDiscoveryengineV1UpdateSchemaMetadata {
|
|
3246
4416
|
/**
|
|
3247
|
-
*
|
|
4417
|
+
* Operation create time.
|
|
3248
4418
|
*/
|
|
3249
|
-
|
|
4419
|
+
createTime?: string | null;
|
|
3250
4420
|
/**
|
|
3251
|
-
*
|
|
4421
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3252
4422
|
*/
|
|
3253
|
-
|
|
3254
|
-
[key: string]: any;
|
|
3255
|
-
} | null;
|
|
4423
|
+
updateTime?: string | null;
|
|
3256
4424
|
}
|
|
3257
4425
|
/**
|
|
3258
|
-
* Metadata
|
|
4426
|
+
* Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3259
4427
|
*/
|
|
3260
|
-
export interface Schema$
|
|
4428
|
+
export interface Schema$GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata {
|
|
3261
4429
|
/**
|
|
3262
4430
|
* Operation create time.
|
|
3263
4431
|
*/
|
|
@@ -3479,7 +4647,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3479
4647
|
}
|
|
3480
4648
|
export interface Params$Resource$Projects$Locations$Estimatedatasize extends StandardParameters {
|
|
3481
4649
|
/**
|
|
3482
|
-
* Required. Full resource name of the
|
|
4650
|
+
* Required. Full resource name of the location, such as `projects/{project\}/locations/{location\}`.
|
|
3483
4651
|
*/
|
|
3484
4652
|
location?: string;
|
|
3485
4653
|
/**
|
|
@@ -3565,6 +4733,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3565
4733
|
schemas: Resource$Projects$Locations$Collections$Datastores$Schemas;
|
|
3566
4734
|
servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs;
|
|
3567
4735
|
siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine;
|
|
4736
|
+
suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries;
|
|
3568
4737
|
userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
|
|
3569
4738
|
constructor(context: APIRequestContext);
|
|
3570
4739
|
/**
|
|
@@ -3722,7 +4891,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3722
4891
|
*/
|
|
3723
4892
|
query?: string;
|
|
3724
4893
|
/**
|
|
3725
|
-
*
|
|
4894
|
+
* Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
3726
4895
|
*/
|
|
3727
4896
|
queryModel?: string;
|
|
3728
4897
|
/**
|
|
@@ -3786,7 +4955,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3786
4955
|
*/
|
|
3787
4956
|
pageToken?: string;
|
|
3788
4957
|
/**
|
|
3789
|
-
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list
|
|
4958
|
+
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
|
|
3790
4959
|
*/
|
|
3791
4960
|
parent?: string;
|
|
3792
4961
|
}
|
|
@@ -3816,11 +4985,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3816
4985
|
}
|
|
3817
4986
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig extends StandardParameters {
|
|
3818
4987
|
/**
|
|
3819
|
-
*
|
|
4988
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
3820
4989
|
*/
|
|
3821
4990
|
name?: string;
|
|
3822
4991
|
/**
|
|
3823
|
-
* Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.
|
|
4992
|
+
* Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated.
|
|
3824
4993
|
*/
|
|
3825
4994
|
updateMask?: string;
|
|
3826
4995
|
/**
|
|
@@ -4214,7 +5383,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4214
5383
|
*/
|
|
4215
5384
|
name?: string;
|
|
4216
5385
|
/**
|
|
4217
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
5386
|
+
* Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.
|
|
4218
5387
|
*/
|
|
4219
5388
|
updateMask?: string;
|
|
4220
5389
|
/**
|
|
@@ -4527,6 +5696,48 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4527
5696
|
export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs {
|
|
4528
5697
|
context: APIRequestContext;
|
|
4529
5698
|
constructor(context: APIRequestContext);
|
|
5699
|
+
/**
|
|
5700
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
5701
|
+
*
|
|
5702
|
+
* @param params - Parameters for request
|
|
5703
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5704
|
+
* @param callback - Optional callback that handles the response.
|
|
5705
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5706
|
+
*/
|
|
5707
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5708
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
5709
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5710
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
5711
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
5712
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
5713
|
+
/**
|
|
5714
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
5715
|
+
*
|
|
5716
|
+
* @param params - Parameters for request
|
|
5717
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5718
|
+
* @param callback - Optional callback that handles the response.
|
|
5719
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5720
|
+
*/
|
|
5721
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5722
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
|
|
5723
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5724
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
5725
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
5726
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
5727
|
+
/**
|
|
5728
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
5729
|
+
*
|
|
5730
|
+
* @param params - Parameters for request
|
|
5731
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5732
|
+
* @param callback - Optional callback that handles the response.
|
|
5733
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5734
|
+
*/
|
|
5735
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5736
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
5737
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5738
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
5739
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
5740
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
4530
5741
|
/**
|
|
4531
5742
|
* Makes a recommendation, which requires a contextual user event.
|
|
4532
5743
|
*
|
|
@@ -4556,9 +5767,43 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4556
5767
|
search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
4557
5768
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
4558
5769
|
}
|
|
5770
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
5771
|
+
/**
|
|
5772
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
5773
|
+
*/
|
|
5774
|
+
name?: string;
|
|
5775
|
+
}
|
|
5776
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List extends StandardParameters {
|
|
5777
|
+
/**
|
|
5778
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
5779
|
+
*/
|
|
5780
|
+
pageSize?: number;
|
|
5781
|
+
/**
|
|
5782
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
5783
|
+
*/
|
|
5784
|
+
pageToken?: string;
|
|
5785
|
+
/**
|
|
5786
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
5787
|
+
*/
|
|
5788
|
+
parent?: string;
|
|
5789
|
+
}
|
|
5790
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
5791
|
+
/**
|
|
5792
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
5793
|
+
*/
|
|
5794
|
+
name?: string;
|
|
5795
|
+
/**
|
|
5796
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
5797
|
+
*/
|
|
5798
|
+
updateMask?: string;
|
|
5799
|
+
/**
|
|
5800
|
+
* Request body metadata
|
|
5801
|
+
*/
|
|
5802
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
|
|
5803
|
+
}
|
|
4559
5804
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
4560
5805
|
/**
|
|
4561
|
-
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
|
|
5806
|
+
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.
|
|
4562
5807
|
*/
|
|
4563
5808
|
servingConfig?: string;
|
|
4564
5809
|
/**
|
|
@@ -4963,6 +6208,58 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4963
6208
|
*/
|
|
4964
6209
|
pageToken?: string;
|
|
4965
6210
|
}
|
|
6211
|
+
export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries {
|
|
6212
|
+
context: APIRequestContext;
|
|
6213
|
+
constructor(context: APIRequestContext);
|
|
6214
|
+
/**
|
|
6215
|
+
* Imports all SuggestionDenyListEntry for a DataStore.
|
|
6216
|
+
*
|
|
6217
|
+
* @param params - Parameters for request
|
|
6218
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6219
|
+
* @param callback - Optional callback that handles the response.
|
|
6220
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6221
|
+
*/
|
|
6222
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6223
|
+
import(params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6224
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6225
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6226
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6227
|
+
import(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6228
|
+
/**
|
|
6229
|
+
* Permanently deletes all SuggestionDenyListEntry for a DataStore.
|
|
6230
|
+
*
|
|
6231
|
+
* @param params - Parameters for request
|
|
6232
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6233
|
+
* @param callback - Optional callback that handles the response.
|
|
6234
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6235
|
+
*/
|
|
6236
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6237
|
+
purge(params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6238
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6239
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6240
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6241
|
+
purge(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6242
|
+
}
|
|
6243
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import extends StandardParameters {
|
|
6244
|
+
/**
|
|
6245
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
6246
|
+
*/
|
|
6247
|
+
parent?: string;
|
|
6248
|
+
/**
|
|
6249
|
+
* Request body metadata
|
|
6250
|
+
*/
|
|
6251
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest;
|
|
6252
|
+
}
|
|
6253
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge extends StandardParameters {
|
|
6254
|
+
/**
|
|
6255
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
6256
|
+
*/
|
|
6257
|
+
parent?: string;
|
|
6258
|
+
/**
|
|
6259
|
+
* Request body metadata
|
|
6260
|
+
*/
|
|
6261
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest;
|
|
6262
|
+
}
|
|
4966
6263
|
export class Resource$Projects$Locations$Collections$Datastores$Userevents {
|
|
4967
6264
|
context: APIRequestContext;
|
|
4968
6265
|
constructor(context: APIRequestContext);
|
|
@@ -5148,7 +6445,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5148
6445
|
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
5149
6446
|
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
5150
6447
|
/**
|
|
5151
|
-
* Pauses the training of an existing engine. Only applicable if
|
|
6448
|
+
* Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
5152
6449
|
*
|
|
5153
6450
|
* @param params - Parameters for request
|
|
5154
6451
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5162,7 +6459,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5162
6459
|
pause(params: Params$Resource$Projects$Locations$Collections$Engines$Pause, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
5163
6460
|
pause(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
5164
6461
|
/**
|
|
5165
|
-
* Resumes the training of an existing engine. Only applicable if
|
|
6462
|
+
* Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
5166
6463
|
*
|
|
5167
6464
|
* @param params - Parameters for request
|
|
5168
6465
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5176,7 +6473,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5176
6473
|
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Resume, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
5177
6474
|
resume(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
5178
6475
|
/**
|
|
5179
|
-
* Tunes an existing engine. Only applicable if
|
|
6476
|
+
* Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
5180
6477
|
*
|
|
5181
6478
|
* @param params - Parameters for request
|
|
5182
6479
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5426,7 +6723,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5426
6723
|
*/
|
|
5427
6724
|
name?: string;
|
|
5428
6725
|
/**
|
|
5429
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
6726
|
+
* Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.
|
|
5430
6727
|
*/
|
|
5431
6728
|
updateMask?: string;
|
|
5432
6729
|
/**
|
|
@@ -5493,6 +6790,48 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5493
6790
|
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
5494
6791
|
context: APIRequestContext;
|
|
5495
6792
|
constructor(context: APIRequestContext);
|
|
6793
|
+
/**
|
|
6794
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
6795
|
+
*
|
|
6796
|
+
* @param params - Parameters for request
|
|
6797
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6798
|
+
* @param callback - Optional callback that handles the response.
|
|
6799
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6800
|
+
*/
|
|
6801
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6802
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
6803
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6804
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
6805
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
6806
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
6807
|
+
/**
|
|
6808
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
6809
|
+
*
|
|
6810
|
+
* @param params - Parameters for request
|
|
6811
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6812
|
+
* @param callback - Optional callback that handles the response.
|
|
6813
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6814
|
+
*/
|
|
6815
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6816
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
|
|
6817
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6818
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
6819
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
6820
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
6821
|
+
/**
|
|
6822
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
6823
|
+
*
|
|
6824
|
+
* @param params - Parameters for request
|
|
6825
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6826
|
+
* @param callback - Optional callback that handles the response.
|
|
6827
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6828
|
+
*/
|
|
6829
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6830
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
6831
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6832
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
6833
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
6834
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
5496
6835
|
/**
|
|
5497
6836
|
* Makes a recommendation, which requires a contextual user event.
|
|
5498
6837
|
*
|
|
@@ -5522,9 +6861,43 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5522
6861
|
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
5523
6862
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
5524
6863
|
}
|
|
6864
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
|
|
6865
|
+
/**
|
|
6866
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
6867
|
+
*/
|
|
6868
|
+
name?: string;
|
|
6869
|
+
}
|
|
6870
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List extends StandardParameters {
|
|
6871
|
+
/**
|
|
6872
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
6873
|
+
*/
|
|
6874
|
+
pageSize?: number;
|
|
6875
|
+
/**
|
|
6876
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
6877
|
+
*/
|
|
6878
|
+
pageToken?: string;
|
|
6879
|
+
/**
|
|
6880
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
6881
|
+
*/
|
|
6882
|
+
parent?: string;
|
|
6883
|
+
}
|
|
6884
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters {
|
|
6885
|
+
/**
|
|
6886
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
6887
|
+
*/
|
|
6888
|
+
name?: string;
|
|
6889
|
+
/**
|
|
6890
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
6891
|
+
*/
|
|
6892
|
+
updateMask?: string;
|
|
6893
|
+
/**
|
|
6894
|
+
* Request body metadata
|
|
6895
|
+
*/
|
|
6896
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
|
|
6897
|
+
}
|
|
5525
6898
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
|
|
5526
6899
|
/**
|
|
5527
|
-
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
|
|
6900
|
+
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.
|
|
5528
6901
|
*/
|
|
5529
6902
|
servingConfig?: string;
|
|
5530
6903
|
/**
|
|
@@ -5607,6 +6980,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5607
6980
|
schemas: Resource$Projects$Locations$Datastores$Schemas;
|
|
5608
6981
|
servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs;
|
|
5609
6982
|
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
6983
|
+
suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries;
|
|
5610
6984
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
5611
6985
|
constructor(context: APIRequestContext);
|
|
5612
6986
|
/**
|
|
@@ -5750,7 +7124,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5750
7124
|
*/
|
|
5751
7125
|
query?: string;
|
|
5752
7126
|
/**
|
|
5753
|
-
*
|
|
7127
|
+
* Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
5754
7128
|
*/
|
|
5755
7129
|
queryModel?: string;
|
|
5756
7130
|
/**
|
|
@@ -5814,7 +7188,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5814
7188
|
*/
|
|
5815
7189
|
pageToken?: string;
|
|
5816
7190
|
/**
|
|
5817
|
-
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list
|
|
7191
|
+
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
|
|
5818
7192
|
*/
|
|
5819
7193
|
parent?: string;
|
|
5820
7194
|
}
|
|
@@ -5834,11 +7208,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5834
7208
|
}
|
|
5835
7209
|
export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig extends StandardParameters {
|
|
5836
7210
|
/**
|
|
5837
|
-
*
|
|
7211
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
5838
7212
|
*/
|
|
5839
7213
|
name?: string;
|
|
5840
7214
|
/**
|
|
5841
|
-
* Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.
|
|
7215
|
+
* Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated.
|
|
5842
7216
|
*/
|
|
5843
7217
|
updateMask?: string;
|
|
5844
7218
|
/**
|
|
@@ -6232,7 +7606,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6232
7606
|
*/
|
|
6233
7607
|
name?: string;
|
|
6234
7608
|
/**
|
|
6235
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
7609
|
+
* Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.
|
|
6236
7610
|
*/
|
|
6237
7611
|
updateMask?: string;
|
|
6238
7612
|
/**
|
|
@@ -6488,6 +7862,48 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6488
7862
|
export class Resource$Projects$Locations$Datastores$Servingconfigs {
|
|
6489
7863
|
context: APIRequestContext;
|
|
6490
7864
|
constructor(context: APIRequestContext);
|
|
7865
|
+
/**
|
|
7866
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
7867
|
+
*
|
|
7868
|
+
* @param params - Parameters for request
|
|
7869
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7870
|
+
* @param callback - Optional callback that handles the response.
|
|
7871
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7872
|
+
*/
|
|
7873
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7874
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
7875
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7876
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
7877
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
7878
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
7879
|
+
/**
|
|
7880
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
7881
|
+
*
|
|
7882
|
+
* @param params - Parameters for request
|
|
7883
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7884
|
+
* @param callback - Optional callback that handles the response.
|
|
7885
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7886
|
+
*/
|
|
7887
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7888
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
|
|
7889
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7890
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
7891
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
7892
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
7893
|
+
/**
|
|
7894
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
7895
|
+
*
|
|
7896
|
+
* @param params - Parameters for request
|
|
7897
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7898
|
+
* @param callback - Optional callback that handles the response.
|
|
7899
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7900
|
+
*/
|
|
7901
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7902
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
7903
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7904
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
7905
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
7906
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
6491
7907
|
/**
|
|
6492
7908
|
* Makes a recommendation, which requires a contextual user event.
|
|
6493
7909
|
*
|
|
@@ -6517,9 +7933,43 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6517
7933
|
search(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
6518
7934
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
6519
7935
|
}
|
|
7936
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
7937
|
+
/**
|
|
7938
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
7939
|
+
*/
|
|
7940
|
+
name?: string;
|
|
7941
|
+
}
|
|
7942
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List extends StandardParameters {
|
|
7943
|
+
/**
|
|
7944
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
7945
|
+
*/
|
|
7946
|
+
pageSize?: number;
|
|
7947
|
+
/**
|
|
7948
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
7949
|
+
*/
|
|
7950
|
+
pageToken?: string;
|
|
7951
|
+
/**
|
|
7952
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
7953
|
+
*/
|
|
7954
|
+
parent?: string;
|
|
7955
|
+
}
|
|
7956
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
7957
|
+
/**
|
|
7958
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
7959
|
+
*/
|
|
7960
|
+
name?: string;
|
|
7961
|
+
/**
|
|
7962
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
7963
|
+
*/
|
|
7964
|
+
updateMask?: string;
|
|
7965
|
+
/**
|
|
7966
|
+
* Request body metadata
|
|
7967
|
+
*/
|
|
7968
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
|
|
7969
|
+
}
|
|
6520
7970
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
6521
7971
|
/**
|
|
6522
|
-
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
|
|
7972
|
+
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.
|
|
6523
7973
|
*/
|
|
6524
7974
|
servingConfig?: string;
|
|
6525
7975
|
/**
|
|
@@ -6758,6 +8208,58 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6758
8208
|
*/
|
|
6759
8209
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite;
|
|
6760
8210
|
}
|
|
8211
|
+
export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries {
|
|
8212
|
+
context: APIRequestContext;
|
|
8213
|
+
constructor(context: APIRequestContext);
|
|
8214
|
+
/**
|
|
8215
|
+
* Imports all SuggestionDenyListEntry for a DataStore.
|
|
8216
|
+
*
|
|
8217
|
+
* @param params - Parameters for request
|
|
8218
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8219
|
+
* @param callback - Optional callback that handles the response.
|
|
8220
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
8221
|
+
*/
|
|
8222
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8223
|
+
import(params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
8224
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8225
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
8226
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
8227
|
+
import(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
8228
|
+
/**
|
|
8229
|
+
* Permanently deletes all SuggestionDenyListEntry for a DataStore.
|
|
8230
|
+
*
|
|
8231
|
+
* @param params - Parameters for request
|
|
8232
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8233
|
+
* @param callback - Optional callback that handles the response.
|
|
8234
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
8235
|
+
*/
|
|
8236
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8237
|
+
purge(params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
8238
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8239
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
8240
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
8241
|
+
purge(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
8242
|
+
}
|
|
8243
|
+
export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import extends StandardParameters {
|
|
8244
|
+
/**
|
|
8245
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
8246
|
+
*/
|
|
8247
|
+
parent?: string;
|
|
8248
|
+
/**
|
|
8249
|
+
* Request body metadata
|
|
8250
|
+
*/
|
|
8251
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest;
|
|
8252
|
+
}
|
|
8253
|
+
export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge extends StandardParameters {
|
|
8254
|
+
/**
|
|
8255
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
8256
|
+
*/
|
|
8257
|
+
parent?: string;
|
|
8258
|
+
/**
|
|
8259
|
+
* Request body metadata
|
|
8260
|
+
*/
|
|
8261
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest;
|
|
8262
|
+
}
|
|
6761
8263
|
export class Resource$Projects$Locations$Datastores$Userevents {
|
|
6762
8264
|
context: APIRequestContext;
|
|
6763
8265
|
constructor(context: APIRequestContext);
|