@googleapis/discoveryengine 5.0.0 → 6.0.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 +11 -0
- package/build/v1alpha.d.ts +1233 -127
- package/build/v1alpha.js +144 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +2284 -149
- package/build/v1beta.js +1558 -218
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1alpha.ts +1662 -212
- package/v1beta.ts +8829 -3274
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
|
/**
|
|
@@ -613,6 +613,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
613
613
|
*/
|
|
614
614
|
updateTime?: string | null;
|
|
615
615
|
}
|
|
616
|
+
/**
|
|
617
|
+
* The digital parsing configurations for documents.
|
|
618
|
+
*/
|
|
619
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {
|
|
620
|
+
}
|
|
616
621
|
/**
|
|
617
622
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
618
623
|
*/
|
|
@@ -690,7 +695,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
690
695
|
*/
|
|
691
696
|
rawBytes?: string | null;
|
|
692
697
|
/**
|
|
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.
|
|
698
|
+
* 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
699
|
*/
|
|
695
700
|
uri?: string | null;
|
|
696
701
|
}
|
|
@@ -724,13 +729,40 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
724
729
|
*/
|
|
725
730
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
|
|
726
731
|
/**
|
|
727
|
-
*
|
|
732
|
+
* 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.
|
|
733
|
+
*/
|
|
734
|
+
defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
735
|
+
/**
|
|
736
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
728
737
|
*/
|
|
729
738
|
name?: string | null;
|
|
730
739
|
/**
|
|
731
|
-
* The OCR config. Currently it only applies to PDFs.
|
|
740
|
+
* [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
741
|
*/
|
|
733
742
|
ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
743
|
+
/**
|
|
744
|
+
* 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.
|
|
745
|
+
*/
|
|
746
|
+
parsingConfigOverrides?: {
|
|
747
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
748
|
+
} | null;
|
|
749
|
+
}
|
|
750
|
+
/**
|
|
751
|
+
* Related configurations applied to a specific type of document parser.
|
|
752
|
+
*/
|
|
753
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig {
|
|
754
|
+
/**
|
|
755
|
+
* Configurations applied to digital parser.
|
|
756
|
+
*/
|
|
757
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig;
|
|
758
|
+
/**
|
|
759
|
+
* Configurations applied to layout parser.
|
|
760
|
+
*/
|
|
761
|
+
layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig;
|
|
762
|
+
/**
|
|
763
|
+
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
764
|
+
*/
|
|
765
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig;
|
|
734
766
|
}
|
|
735
767
|
/**
|
|
736
768
|
* Double list.
|
|
@@ -785,7 +817,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
785
817
|
*/
|
|
786
818
|
createTime?: string | null;
|
|
787
819
|
/**
|
|
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
|
|
820
|
+
* 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
821
|
*/
|
|
790
822
|
dataStoreIds?: string[] | null;
|
|
791
823
|
/**
|
|
@@ -834,7 +866,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
834
866
|
*/
|
|
835
867
|
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
|
|
836
868
|
/**
|
|
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
|
|
869
|
+
* 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
870
|
*/
|
|
839
871
|
dialogflowAgentToLink?: string | null;
|
|
840
872
|
}
|
|
@@ -850,6 +882,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
850
882
|
* 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
883
|
*/
|
|
852
884
|
defaultLanguageCode?: string | null;
|
|
885
|
+
/**
|
|
886
|
+
* 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.
|
|
887
|
+
*/
|
|
888
|
+
location?: string | null;
|
|
853
889
|
/**
|
|
854
890
|
* 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
891
|
*/
|
|
@@ -869,7 +905,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
869
905
|
*/
|
|
870
906
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineCommonConfig {
|
|
871
907
|
/**
|
|
872
|
-
* The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
908
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
873
909
|
*/
|
|
874
910
|
companyName?: string | null;
|
|
875
911
|
}
|
|
@@ -878,7 +914,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
878
914
|
*/
|
|
879
915
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
|
|
880
916
|
/**
|
|
881
|
-
* The optimization objective e.g
|
|
917
|
+
* 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
918
|
*/
|
|
883
919
|
optimizationObjective?: string | null;
|
|
884
920
|
/**
|
|
@@ -890,7 +926,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
890
926
|
*/
|
|
891
927
|
trainingState?: string | null;
|
|
892
928
|
/**
|
|
893
|
-
* Required. The type of engine e.g
|
|
929
|
+
* 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
930
|
*/
|
|
895
931
|
type?: string | null;
|
|
896
932
|
}
|
|
@@ -969,7 +1005,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
969
1005
|
websiteDataSource?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource;
|
|
970
1006
|
}
|
|
971
1007
|
/**
|
|
972
|
-
* Data source contains files either in
|
|
1008
|
+
* Data source contains files either in Cloud Storage or BigQuery.
|
|
973
1009
|
*/
|
|
974
1010
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource {
|
|
975
1011
|
/**
|
|
@@ -1176,6 +1212,58 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1176
1212
|
*/
|
|
1177
1213
|
gcsPrefix?: string | null;
|
|
1178
1214
|
}
|
|
1215
|
+
/**
|
|
1216
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1217
|
+
*/
|
|
1218
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata {
|
|
1219
|
+
/**
|
|
1220
|
+
* Operation create time.
|
|
1221
|
+
*/
|
|
1222
|
+
createTime?: string | null;
|
|
1223
|
+
/**
|
|
1224
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1225
|
+
*/
|
|
1226
|
+
updateTime?: string | null;
|
|
1227
|
+
}
|
|
1228
|
+
/**
|
|
1229
|
+
* Request message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
1230
|
+
*/
|
|
1231
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest {
|
|
1232
|
+
/**
|
|
1233
|
+
* 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.
|
|
1234
|
+
*/
|
|
1235
|
+
gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource;
|
|
1236
|
+
/**
|
|
1237
|
+
* The Inline source for the input content for suggestion deny list entries.
|
|
1238
|
+
*/
|
|
1239
|
+
inlineSource?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource;
|
|
1240
|
+
}
|
|
1241
|
+
/**
|
|
1242
|
+
* The inline source for SuggestionDenyListEntry.
|
|
1243
|
+
*/
|
|
1244
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource {
|
|
1245
|
+
/**
|
|
1246
|
+
* Required. A list of all denylist entries to import. Max of 1000 items.
|
|
1247
|
+
*/
|
|
1248
|
+
entries?: Schema$GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry[];
|
|
1249
|
+
}
|
|
1250
|
+
/**
|
|
1251
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
1252
|
+
*/
|
|
1253
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse {
|
|
1254
|
+
/**
|
|
1255
|
+
* A sample of errors encountered while processing the request.
|
|
1256
|
+
*/
|
|
1257
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
1258
|
+
/**
|
|
1259
|
+
* Count of deny list entries that failed to be imported.
|
|
1260
|
+
*/
|
|
1261
|
+
failedEntriesCount?: string | null;
|
|
1262
|
+
/**
|
|
1263
|
+
* Count of deny list entries successfully imported.
|
|
1264
|
+
*/
|
|
1265
|
+
importedEntriesCount?: string | null;
|
|
1266
|
+
}
|
|
1179
1267
|
/**
|
|
1180
1268
|
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1181
1269
|
*/
|
|
@@ -1269,6 +1357,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1269
1357
|
*/
|
|
1270
1358
|
minimum?: number | null;
|
|
1271
1359
|
}
|
|
1360
|
+
/**
|
|
1361
|
+
* The layout parsing configurations for documents.
|
|
1362
|
+
*/
|
|
1363
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig {
|
|
1364
|
+
}
|
|
1272
1365
|
/**
|
|
1273
1366
|
* Response for ListConversations method.
|
|
1274
1367
|
*/
|
|
@@ -1387,7 +1480,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1387
1480
|
*/
|
|
1388
1481
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig {
|
|
1389
1482
|
/**
|
|
1390
|
-
* Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply.
|
|
1483
|
+
* 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
1484
|
*/
|
|
1392
1485
|
enabled?: boolean | null;
|
|
1393
1486
|
/**
|
|
@@ -1399,6 +1492,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1399
1492
|
*/
|
|
1400
1493
|
useNativeText?: boolean | null;
|
|
1401
1494
|
}
|
|
1495
|
+
/**
|
|
1496
|
+
* The OCR parsing configurations for documents.
|
|
1497
|
+
*/
|
|
1498
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig {
|
|
1499
|
+
/**
|
|
1500
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
1501
|
+
*/
|
|
1502
|
+
enhancedDocumentElements?: string[] | null;
|
|
1503
|
+
/**
|
|
1504
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
1505
|
+
*/
|
|
1506
|
+
useNativeText?: boolean | null;
|
|
1507
|
+
}
|
|
1402
1508
|
/**
|
|
1403
1509
|
* Detailed page information.
|
|
1404
1510
|
*/
|
|
@@ -1493,6 +1599,37 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1493
1599
|
*/
|
|
1494
1600
|
purgeSample?: string[] | null;
|
|
1495
1601
|
}
|
|
1602
|
+
/**
|
|
1603
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1604
|
+
*/
|
|
1605
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata {
|
|
1606
|
+
/**
|
|
1607
|
+
* Operation create time.
|
|
1608
|
+
*/
|
|
1609
|
+
createTime?: string | null;
|
|
1610
|
+
/**
|
|
1611
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1612
|
+
*/
|
|
1613
|
+
updateTime?: string | null;
|
|
1614
|
+
}
|
|
1615
|
+
/**
|
|
1616
|
+
* Request message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
1617
|
+
*/
|
|
1618
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest {
|
|
1619
|
+
}
|
|
1620
|
+
/**
|
|
1621
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
1622
|
+
*/
|
|
1623
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse {
|
|
1624
|
+
/**
|
|
1625
|
+
* A sample of errors encountered while processing the request.
|
|
1626
|
+
*/
|
|
1627
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
1628
|
+
/**
|
|
1629
|
+
* Number of suggestion deny list entries purged.
|
|
1630
|
+
*/
|
|
1631
|
+
purgeCount?: string | null;
|
|
1632
|
+
}
|
|
1496
1633
|
/**
|
|
1497
1634
|
* Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1498
1635
|
*/
|
|
@@ -1678,7 +1815,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1678
1815
|
uri?: string | null;
|
|
1679
1816
|
}
|
|
1680
1817
|
/**
|
|
1681
|
-
* Details about why crawling failed for a particular CorpusType, e.g
|
|
1818
|
+
* Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.
|
|
1682
1819
|
*/
|
|
1683
1820
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason {
|
|
1684
1821
|
/**
|
|
@@ -1794,7 +1931,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1794
1931
|
*/
|
|
1795
1932
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
1796
1933
|
/**
|
|
1797
|
-
* Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.
|
|
1934
|
+
* 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
1935
|
*/
|
|
1799
1936
|
embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
|
|
1800
1937
|
/**
|
|
@@ -1914,7 +2051,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1914
2051
|
*/
|
|
1915
2052
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec {
|
|
1916
2053
|
/**
|
|
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
|
|
2054
|
+
* 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
2055
|
*/
|
|
1919
2056
|
maxExtractiveAnswerCount?: number | null;
|
|
1920
2057
|
/**
|
|
@@ -1994,7 +2131,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1994
2131
|
*/
|
|
1995
2132
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
1996
2133
|
/**
|
|
1997
|
-
* The string
|
|
2134
|
+
* 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. * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English.
|
|
1998
2135
|
*/
|
|
1999
2136
|
version?: string | null;
|
|
2000
2137
|
}
|
|
@@ -2326,7 +2463,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2326
2463
|
*/
|
|
2327
2464
|
title?: string | null;
|
|
2328
2465
|
/**
|
|
2329
|
-
*
|
|
2466
|
+
* Cloud Storage or HTTP uri for the document.
|
|
2330
2467
|
*/
|
|
2331
2468
|
uri?: string | null;
|
|
2332
2469
|
}
|
|
@@ -2382,6 +2519,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2382
2519
|
*/
|
|
2383
2520
|
verifyTime?: string | null;
|
|
2384
2521
|
}
|
|
2522
|
+
/**
|
|
2523
|
+
* Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
|
|
2524
|
+
*/
|
|
2525
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry {
|
|
2526
|
+
/**
|
|
2527
|
+
* Required. Phrase to block from suggestions served. Can be maximum 125 characters.
|
|
2528
|
+
*/
|
|
2529
|
+
blockPhrase?: string | null;
|
|
2530
|
+
/**
|
|
2531
|
+
* Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase.
|
|
2532
|
+
*/
|
|
2533
|
+
matchOperator?: string | null;
|
|
2534
|
+
}
|
|
2385
2535
|
/**
|
|
2386
2536
|
* A target site for the SiteSearchEngine.
|
|
2387
2537
|
*/
|
|
@@ -2415,7 +2565,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2415
2565
|
*/
|
|
2416
2566
|
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo;
|
|
2417
2567
|
/**
|
|
2418
|
-
* The type of the target site, e.g
|
|
2568
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
2419
2569
|
*/
|
|
2420
2570
|
type?: string | null;
|
|
2421
2571
|
/**
|
|
@@ -2433,6 +2583,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2433
2583
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
2434
2584
|
}
|
|
2435
2585
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
2586
|
+
/**
|
|
2587
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
2588
|
+
*/
|
|
2589
|
+
totalRequiredQuota?: string | null;
|
|
2436
2590
|
}
|
|
2437
2591
|
/**
|
|
2438
2592
|
* Defines text input.
|
|
@@ -2469,7 +2623,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2469
2623
|
*/
|
|
2470
2624
|
errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
|
|
2471
2625
|
/**
|
|
2472
|
-
*
|
|
2626
|
+
* Cloud Storage training input.
|
|
2473
2627
|
*/
|
|
2474
2628
|
gcsTrainingInput?: Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput;
|
|
2475
2629
|
/**
|
|
@@ -2478,23 +2632,23 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2478
2632
|
modelType?: string | null;
|
|
2479
2633
|
}
|
|
2480
2634
|
/**
|
|
2481
|
-
*
|
|
2635
|
+
* Cloud Storage training data input.
|
|
2482
2636
|
*/
|
|
2483
2637
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput {
|
|
2484
2638
|
/**
|
|
2485
|
-
* The
|
|
2639
|
+
* 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
2640
|
*/
|
|
2487
2641
|
corpusDataPath?: string | null;
|
|
2488
2642
|
/**
|
|
2489
|
-
* The gcs query data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file.
|
|
2643
|
+
* 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
2644
|
*/
|
|
2491
2645
|
queryDataPath?: string | null;
|
|
2492
2646
|
/**
|
|
2493
|
-
*
|
|
2647
|
+
* 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
2648
|
*/
|
|
2495
2649
|
testDataPath?: string | null;
|
|
2496
2650
|
/**
|
|
2497
|
-
*
|
|
2651
|
+
* 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
2652
|
*/
|
|
2499
2653
|
trainDataPath?: string | null;
|
|
2500
2654
|
}
|
|
@@ -2624,7 +2778,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2624
2778
|
*/
|
|
2625
2779
|
eventType?: string | null;
|
|
2626
2780
|
/**
|
|
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
|
|
2781
|
+
* 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
2782
|
*/
|
|
2629
2783
|
filter?: string | null;
|
|
2630
2784
|
/**
|
|
@@ -2790,6 +2944,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2790
2944
|
fieldsUiComponentsMap?: {
|
|
2791
2945
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
2792
2946
|
} | null;
|
|
2947
|
+
/**
|
|
2948
|
+
* Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
|
|
2949
|
+
*/
|
|
2950
|
+
industryVertical?: string | null;
|
|
2793
2951
|
/**
|
|
2794
2952
|
* Output only. Whether LLM is enabled in the corresponding data store.
|
|
2795
2953
|
*/
|
|
@@ -2914,9 +3072,9 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2914
3072
|
uToken?: string | null;
|
|
2915
3073
|
}
|
|
2916
3074
|
/**
|
|
2917
|
-
* Metadata
|
|
3075
|
+
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
2918
3076
|
*/
|
|
2919
|
-
export interface Schema$
|
|
3077
|
+
export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
|
|
2920
3078
|
/**
|
|
2921
3079
|
* Operation create time.
|
|
2922
3080
|
*/
|
|
@@ -2927,9 +3085,18 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2927
3085
|
updateTime?: string | null;
|
|
2928
3086
|
}
|
|
2929
3087
|
/**
|
|
2930
|
-
*
|
|
3088
|
+
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
2931
3089
|
*/
|
|
2932
|
-
export interface Schema$
|
|
3090
|
+
export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse {
|
|
3091
|
+
/**
|
|
3092
|
+
* TargetSites created.
|
|
3093
|
+
*/
|
|
3094
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[];
|
|
3095
|
+
}
|
|
3096
|
+
/**
|
|
3097
|
+
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3098
|
+
*/
|
|
3099
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata {
|
|
2933
3100
|
/**
|
|
2934
3101
|
* Operation create time.
|
|
2935
3102
|
*/
|
|
@@ -2940,181 +3107,876 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2940
3107
|
updateTime?: string | null;
|
|
2941
3108
|
}
|
|
2942
3109
|
/**
|
|
2943
|
-
*
|
|
3110
|
+
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
2944
3111
|
*/
|
|
2945
|
-
export interface Schema$
|
|
3112
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse {
|
|
3113
|
+
/**
|
|
3114
|
+
* TargetSites created.
|
|
3115
|
+
*/
|
|
3116
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[];
|
|
3117
|
+
}
|
|
3118
|
+
/**
|
|
3119
|
+
* Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3120
|
+
*/
|
|
3121
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata {
|
|
2946
3122
|
/**
|
|
2947
3123
|
* Operation create time.
|
|
2948
3124
|
*/
|
|
2949
3125
|
createTime?: string | null;
|
|
2950
3126
|
/**
|
|
2951
|
-
*
|
|
3127
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
2952
3128
|
*/
|
|
2953
|
-
|
|
3129
|
+
updateTime?: string | null;
|
|
3130
|
+
}
|
|
3131
|
+
/**
|
|
3132
|
+
* Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3133
|
+
*/
|
|
3134
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEngineMetadata {
|
|
2954
3135
|
/**
|
|
2955
|
-
*
|
|
3136
|
+
* Operation create time.
|
|
2956
3137
|
*/
|
|
2957
|
-
|
|
3138
|
+
createTime?: string | null;
|
|
2958
3139
|
/**
|
|
2959
3140
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
2960
3141
|
*/
|
|
2961
3142
|
updateTime?: string | null;
|
|
2962
3143
|
}
|
|
2963
3144
|
/**
|
|
2964
|
-
*
|
|
3145
|
+
* Metadata for Create Schema LRO.
|
|
2965
3146
|
*/
|
|
2966
|
-
export interface Schema$
|
|
3147
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata {
|
|
2967
3148
|
/**
|
|
2968
|
-
*
|
|
3149
|
+
* Operation create time.
|
|
2969
3150
|
*/
|
|
2970
|
-
|
|
3151
|
+
createTime?: string | null;
|
|
2971
3152
|
/**
|
|
2972
|
-
*
|
|
3153
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
2973
3154
|
*/
|
|
2974
|
-
|
|
3155
|
+
updateTime?: string | null;
|
|
2975
3156
|
}
|
|
2976
3157
|
/**
|
|
2977
|
-
*
|
|
3158
|
+
* Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
2978
3159
|
*/
|
|
2979
|
-
export interface Schema$
|
|
3160
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata {
|
|
2980
3161
|
/**
|
|
2981
|
-
*
|
|
3162
|
+
* Operation create time.
|
|
2982
3163
|
*/
|
|
2983
|
-
|
|
3164
|
+
createTime?: string | null;
|
|
3165
|
+
/**
|
|
3166
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3167
|
+
*/
|
|
3168
|
+
updateTime?: string | null;
|
|
2984
3169
|
}
|
|
2985
3170
|
/**
|
|
2986
|
-
*
|
|
3171
|
+
* DataStore captures global settings and configs at the DataStore level.
|
|
2987
3172
|
*/
|
|
2988
|
-
export interface Schema$
|
|
3173
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore {
|
|
3174
|
+
/**
|
|
3175
|
+
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
3176
|
+
*/
|
|
3177
|
+
contentConfig?: string | null;
|
|
3178
|
+
/**
|
|
3179
|
+
* Output only. Timestamp the DataStore was created at.
|
|
3180
|
+
*/
|
|
3181
|
+
createTime?: string | null;
|
|
3182
|
+
/**
|
|
3183
|
+
* Output only. The id of the default Schema asscociated to this data store.
|
|
3184
|
+
*/
|
|
3185
|
+
defaultSchemaId?: string | null;
|
|
3186
|
+
/**
|
|
3187
|
+
* 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.
|
|
3188
|
+
*/
|
|
3189
|
+
displayName?: string | null;
|
|
3190
|
+
/**
|
|
3191
|
+
* Immutable. The industry vertical that the data store registers.
|
|
3192
|
+
*/
|
|
3193
|
+
industryVertical?: string | null;
|
|
3194
|
+
/**
|
|
3195
|
+
* 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.
|
|
3196
|
+
*/
|
|
3197
|
+
name?: string | null;
|
|
3198
|
+
/**
|
|
3199
|
+
* 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.
|
|
3200
|
+
*/
|
|
3201
|
+
solutionTypes?: string[] | null;
|
|
3202
|
+
}
|
|
3203
|
+
/**
|
|
3204
|
+
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3205
|
+
*/
|
|
3206
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
|
|
2989
3207
|
/**
|
|
2990
3208
|
* Operation create time.
|
|
2991
3209
|
*/
|
|
2992
3210
|
createTime?: string | null;
|
|
2993
3211
|
/**
|
|
2994
|
-
*
|
|
3212
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
2995
3213
|
*/
|
|
2996
|
-
|
|
3214
|
+
updateTime?: string | null;
|
|
3215
|
+
}
|
|
3216
|
+
/**
|
|
3217
|
+
* Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3218
|
+
*/
|
|
3219
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata {
|
|
2997
3220
|
/**
|
|
2998
|
-
*
|
|
3221
|
+
* Operation create time.
|
|
2999
3222
|
*/
|
|
3000
|
-
|
|
3223
|
+
createTime?: string | null;
|
|
3001
3224
|
/**
|
|
3002
3225
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3003
3226
|
*/
|
|
3004
3227
|
updateTime?: string | null;
|
|
3005
3228
|
}
|
|
3006
3229
|
/**
|
|
3007
|
-
*
|
|
3230
|
+
* Metadata for DeleteSchema LRO.
|
|
3008
3231
|
*/
|
|
3009
|
-
export interface Schema$
|
|
3232
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata {
|
|
3010
3233
|
/**
|
|
3011
|
-
*
|
|
3234
|
+
* Operation create time.
|
|
3012
3235
|
*/
|
|
3013
|
-
|
|
3236
|
+
createTime?: string | null;
|
|
3014
3237
|
/**
|
|
3015
|
-
*
|
|
3238
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3016
3239
|
*/
|
|
3017
|
-
|
|
3240
|
+
updateTime?: string | null;
|
|
3241
|
+
}
|
|
3242
|
+
/**
|
|
3243
|
+
* Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3244
|
+
*/
|
|
3245
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata {
|
|
3018
3246
|
/**
|
|
3019
|
-
*
|
|
3247
|
+
* Operation create time.
|
|
3020
3248
|
*/
|
|
3021
|
-
|
|
3249
|
+
createTime?: string | null;
|
|
3022
3250
|
/**
|
|
3023
|
-
*
|
|
3251
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3024
3252
|
*/
|
|
3025
|
-
|
|
3253
|
+
updateTime?: string | null;
|
|
3026
3254
|
}
|
|
3027
3255
|
/**
|
|
3028
|
-
* Metadata related to the progress of the
|
|
3256
|
+
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3029
3257
|
*/
|
|
3030
|
-
export interface Schema$
|
|
3258
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata {
|
|
3259
|
+
/**
|
|
3260
|
+
* Operation create time.
|
|
3261
|
+
*/
|
|
3262
|
+
createTime?: string | null;
|
|
3263
|
+
/**
|
|
3264
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3265
|
+
*/
|
|
3266
|
+
updateTime?: string | null;
|
|
3267
|
+
}
|
|
3268
|
+
/**
|
|
3269
|
+
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
3270
|
+
*/
|
|
3271
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {
|
|
3272
|
+
}
|
|
3273
|
+
/**
|
|
3274
|
+
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3275
|
+
*/
|
|
3276
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata {
|
|
3277
|
+
/**
|
|
3278
|
+
* Operation create time.
|
|
3279
|
+
*/
|
|
3280
|
+
createTime?: string | null;
|
|
3281
|
+
/**
|
|
3282
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3283
|
+
*/
|
|
3284
|
+
updateTime?: string | null;
|
|
3285
|
+
}
|
|
3286
|
+
/**
|
|
3287
|
+
* Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
|
3288
|
+
*/
|
|
3289
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse {
|
|
3290
|
+
}
|
|
3291
|
+
/**
|
|
3292
|
+
* Metadata that describes the training and serving parameters of an Engine.
|
|
3293
|
+
*/
|
|
3294
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngine {
|
|
3295
|
+
/**
|
|
3296
|
+
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3297
|
+
*/
|
|
3298
|
+
chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig;
|
|
3299
|
+
/**
|
|
3300
|
+
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3301
|
+
*/
|
|
3302
|
+
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata;
|
|
3303
|
+
/**
|
|
3304
|
+
* Common config spec that specifies the metadata of the engine.
|
|
3305
|
+
*/
|
|
3306
|
+
commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig;
|
|
3307
|
+
/**
|
|
3308
|
+
* Output only. Timestamp the Recommendation Engine was created at.
|
|
3309
|
+
*/
|
|
3310
|
+
createTime?: string | null;
|
|
3311
|
+
/**
|
|
3312
|
+
* 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.
|
|
3313
|
+
*/
|
|
3314
|
+
dataStoreIds?: string[] | null;
|
|
3315
|
+
/**
|
|
3316
|
+
* Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
|
|
3317
|
+
*/
|
|
3318
|
+
displayName?: string | null;
|
|
3319
|
+
/**
|
|
3320
|
+
* 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.
|
|
3321
|
+
*/
|
|
3322
|
+
industryVertical?: string | null;
|
|
3323
|
+
/**
|
|
3324
|
+
* 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.
|
|
3325
|
+
*/
|
|
3326
|
+
name?: string | null;
|
|
3327
|
+
/**
|
|
3328
|
+
* Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
3329
|
+
*/
|
|
3330
|
+
searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
|
|
3331
|
+
/**
|
|
3332
|
+
* Required. The solutions of the engine.
|
|
3333
|
+
*/
|
|
3334
|
+
solutionType?: string | null;
|
|
3335
|
+
/**
|
|
3336
|
+
* Output only. Timestamp the Recommendation Engine was last updated.
|
|
3337
|
+
*/
|
|
3338
|
+
updateTime?: string | null;
|
|
3339
|
+
}
|
|
3340
|
+
/**
|
|
3341
|
+
* Configurations for a Chat Engine.
|
|
3342
|
+
*/
|
|
3343
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig {
|
|
3344
|
+
/**
|
|
3345
|
+
* 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.
|
|
3346
|
+
*/
|
|
3347
|
+
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
|
|
3348
|
+
/**
|
|
3349
|
+
* 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.
|
|
3350
|
+
*/
|
|
3351
|
+
dialogflowAgentToLink?: string | null;
|
|
3352
|
+
}
|
|
3353
|
+
/**
|
|
3354
|
+
* 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.
|
|
3355
|
+
*/
|
|
3356
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig {
|
|
3357
|
+
/**
|
|
3358
|
+
* Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
|
|
3359
|
+
*/
|
|
3360
|
+
business?: string | null;
|
|
3361
|
+
/**
|
|
3362
|
+
* 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.
|
|
3363
|
+
*/
|
|
3364
|
+
defaultLanguageCode?: string | null;
|
|
3365
|
+
/**
|
|
3366
|
+
* 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.
|
|
3367
|
+
*/
|
|
3368
|
+
location?: string | null;
|
|
3369
|
+
/**
|
|
3370
|
+
* 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.
|
|
3371
|
+
*/
|
|
3372
|
+
timeZone?: string | null;
|
|
3373
|
+
}
|
|
3374
|
+
/**
|
|
3375
|
+
* Additional information of a Chat Engine. Fields in this message are output only.
|
|
3376
|
+
*/
|
|
3377
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata {
|
|
3378
|
+
/**
|
|
3379
|
+
* The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
|
|
3380
|
+
*/
|
|
3381
|
+
dialogflowAgent?: string | null;
|
|
3382
|
+
}
|
|
3383
|
+
/**
|
|
3384
|
+
* Common configurations for an Engine.
|
|
3385
|
+
*/
|
|
3386
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig {
|
|
3387
|
+
/**
|
|
3388
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
3389
|
+
*/
|
|
3390
|
+
companyName?: string | null;
|
|
3391
|
+
}
|
|
3392
|
+
/**
|
|
3393
|
+
* Configurations for a Search Engine.
|
|
3394
|
+
*/
|
|
3395
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
3396
|
+
/**
|
|
3397
|
+
* The add-on that this search engine enables.
|
|
3398
|
+
*/
|
|
3399
|
+
searchAddOns?: string[] | null;
|
|
3400
|
+
/**
|
|
3401
|
+
* 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.
|
|
3402
|
+
*/
|
|
3403
|
+
searchTier?: string | null;
|
|
3404
|
+
}
|
|
3405
|
+
/**
|
|
3406
|
+
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3407
|
+
*/
|
|
3408
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
|
|
3409
|
+
/**
|
|
3410
|
+
* Operation create time.
|
|
3411
|
+
*/
|
|
3412
|
+
createTime?: string | null;
|
|
3413
|
+
/**
|
|
3414
|
+
* Count of entries that encountered errors while processing.
|
|
3415
|
+
*/
|
|
3416
|
+
failureCount?: string | null;
|
|
3417
|
+
/**
|
|
3418
|
+
* Count of entries that were processed successfully.
|
|
3419
|
+
*/
|
|
3420
|
+
successCount?: string | null;
|
|
3421
|
+
/**
|
|
3422
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3423
|
+
*/
|
|
3424
|
+
updateTime?: string | null;
|
|
3425
|
+
}
|
|
3426
|
+
/**
|
|
3427
|
+
* 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.
|
|
3428
|
+
*/
|
|
3429
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsResponse {
|
|
3430
|
+
/**
|
|
3431
|
+
* Echoes the destination for the complete errors in the request if set.
|
|
3432
|
+
*/
|
|
3433
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
3434
|
+
/**
|
|
3435
|
+
* A sample of errors encountered while processing the request.
|
|
3436
|
+
*/
|
|
3437
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3438
|
+
}
|
|
3439
|
+
/**
|
|
3440
|
+
* Configuration of destination for Import related errors.
|
|
3441
|
+
*/
|
|
3442
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig {
|
|
3443
|
+
/**
|
|
3444
|
+
* 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.
|
|
3445
|
+
*/
|
|
3446
|
+
gcsPrefix?: string | null;
|
|
3447
|
+
}
|
|
3448
|
+
/**
|
|
3449
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3450
|
+
*/
|
|
3451
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata {
|
|
3452
|
+
/**
|
|
3453
|
+
* Operation create time.
|
|
3454
|
+
*/
|
|
3455
|
+
createTime?: string | null;
|
|
3456
|
+
/**
|
|
3457
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3458
|
+
*/
|
|
3459
|
+
updateTime?: string | null;
|
|
3460
|
+
}
|
|
3461
|
+
/**
|
|
3462
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
3463
|
+
*/
|
|
3464
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse {
|
|
3465
|
+
/**
|
|
3466
|
+
* A sample of errors encountered while processing the request.
|
|
3467
|
+
*/
|
|
3468
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3469
|
+
/**
|
|
3470
|
+
* Count of deny list entries that failed to be imported.
|
|
3471
|
+
*/
|
|
3472
|
+
failedEntriesCount?: string | null;
|
|
3473
|
+
/**
|
|
3474
|
+
* Count of deny list entries successfully imported.
|
|
3475
|
+
*/
|
|
3476
|
+
importedEntriesCount?: string | null;
|
|
3477
|
+
}
|
|
3478
|
+
/**
|
|
3479
|
+
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3480
|
+
*/
|
|
3481
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata {
|
|
3482
|
+
/**
|
|
3483
|
+
* Operation create time.
|
|
3484
|
+
*/
|
|
3485
|
+
createTime?: string | null;
|
|
3486
|
+
/**
|
|
3487
|
+
* Count of entries that encountered errors while processing.
|
|
3488
|
+
*/
|
|
3489
|
+
failureCount?: string | null;
|
|
3490
|
+
/**
|
|
3491
|
+
* Count of entries that were processed successfully.
|
|
3492
|
+
*/
|
|
3493
|
+
successCount?: string | null;
|
|
3494
|
+
/**
|
|
3495
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3496
|
+
*/
|
|
3497
|
+
updateTime?: string | null;
|
|
3498
|
+
}
|
|
3499
|
+
/**
|
|
3500
|
+
* 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.
|
|
3501
|
+
*/
|
|
3502
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsResponse {
|
|
3503
|
+
/**
|
|
3504
|
+
* Echoes the destination for the complete errors if this field was set in the request.
|
|
3505
|
+
*/
|
|
3506
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
3507
|
+
/**
|
|
3508
|
+
* A sample of errors encountered while processing the request.
|
|
3509
|
+
*/
|
|
3510
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3511
|
+
/**
|
|
3512
|
+
* Count of user events imported with complete existing Documents.
|
|
3513
|
+
*/
|
|
3514
|
+
joinedEventsCount?: string | null;
|
|
3515
|
+
/**
|
|
3516
|
+
* Count of user events imported, but with Document information not found in the existing Branch.
|
|
3517
|
+
*/
|
|
3518
|
+
unjoinedEventsCount?: string | null;
|
|
3519
|
+
}
|
|
3520
|
+
/**
|
|
3521
|
+
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3522
|
+
*/
|
|
3523
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
|
|
3524
|
+
/**
|
|
3525
|
+
* Operation create time.
|
|
3526
|
+
*/
|
|
3527
|
+
createTime?: string | null;
|
|
3528
|
+
/**
|
|
3529
|
+
* Count of entries that encountered errors while processing.
|
|
3530
|
+
*/
|
|
3531
|
+
failureCount?: string | null;
|
|
3532
|
+
/**
|
|
3533
|
+
* Count of entries that were deleted successfully.
|
|
3534
|
+
*/
|
|
3535
|
+
successCount?: string | null;
|
|
3536
|
+
/**
|
|
3537
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3538
|
+
*/
|
|
3539
|
+
updateTime?: string | null;
|
|
3540
|
+
}
|
|
3541
|
+
/**
|
|
3542
|
+
* 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.
|
|
3543
|
+
*/
|
|
3544
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse {
|
|
3545
|
+
/**
|
|
3546
|
+
* The total count of documents purged as a result of the operation.
|
|
3547
|
+
*/
|
|
3548
|
+
purgeCount?: string | null;
|
|
3549
|
+
/**
|
|
3550
|
+
* 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.
|
|
3551
|
+
*/
|
|
3552
|
+
purgeSample?: string[] | null;
|
|
3553
|
+
}
|
|
3554
|
+
/**
|
|
3555
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3556
|
+
*/
|
|
3557
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata {
|
|
3558
|
+
/**
|
|
3559
|
+
* Operation create time.
|
|
3560
|
+
*/
|
|
3561
|
+
createTime?: string | null;
|
|
3562
|
+
/**
|
|
3563
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3564
|
+
*/
|
|
3565
|
+
updateTime?: string | null;
|
|
3566
|
+
}
|
|
3567
|
+
/**
|
|
3568
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
3569
|
+
*/
|
|
3570
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse {
|
|
3571
|
+
/**
|
|
3572
|
+
* A sample of errors encountered while processing the request.
|
|
3573
|
+
*/
|
|
3574
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3575
|
+
/**
|
|
3576
|
+
* Number of suggestion deny list entries purged.
|
|
3577
|
+
*/
|
|
3578
|
+
purgeCount?: string | null;
|
|
3579
|
+
}
|
|
3580
|
+
/**
|
|
3581
|
+
* Defines the structure and layout of a type of document data.
|
|
3582
|
+
*/
|
|
3583
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSchema {
|
|
3584
|
+
/**
|
|
3585
|
+
* The JSON representation of the schema.
|
|
3586
|
+
*/
|
|
3587
|
+
jsonSchema?: string | null;
|
|
3588
|
+
/**
|
|
3589
|
+
* 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.
|
|
3590
|
+
*/
|
|
3591
|
+
name?: string | null;
|
|
3592
|
+
/**
|
|
3593
|
+
* The structured representation of the schema.
|
|
3594
|
+
*/
|
|
3595
|
+
structSchema?: {
|
|
3596
|
+
[key: string]: any;
|
|
3597
|
+
} | null;
|
|
3598
|
+
}
|
|
3599
|
+
/**
|
|
3600
|
+
* Verification information for target sites in advanced site search.
|
|
3601
|
+
*/
|
|
3602
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo {
|
|
3603
|
+
/**
|
|
3604
|
+
* Site verification state indicating the ownership and validity.
|
|
3605
|
+
*/
|
|
3606
|
+
siteVerificationState?: string | null;
|
|
3607
|
+
/**
|
|
3608
|
+
* Latest site verification time.
|
|
3609
|
+
*/
|
|
3610
|
+
verifyTime?: string | null;
|
|
3611
|
+
}
|
|
3612
|
+
/**
|
|
3613
|
+
* A target site for the SiteSearchEngine.
|
|
3614
|
+
*/
|
|
3615
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSite {
|
|
3616
|
+
/**
|
|
3617
|
+
* 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.
|
|
3618
|
+
*/
|
|
3619
|
+
exactMatch?: boolean | null;
|
|
3620
|
+
/**
|
|
3621
|
+
* Output only. Failure reason.
|
|
3622
|
+
*/
|
|
3623
|
+
failureReason?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason;
|
|
3624
|
+
/**
|
|
3625
|
+
* Output only. This is system-generated based on the provided_uri_pattern.
|
|
3626
|
+
*/
|
|
3627
|
+
generatedUriPattern?: string | null;
|
|
3628
|
+
/**
|
|
3629
|
+
* Output only. Indexing status.
|
|
3630
|
+
*/
|
|
3631
|
+
indexingStatus?: string | null;
|
|
3632
|
+
/**
|
|
3633
|
+
* 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.
|
|
3634
|
+
*/
|
|
3635
|
+
name?: string | null;
|
|
3636
|
+
/**
|
|
3637
|
+
* Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
|
|
3638
|
+
*/
|
|
3639
|
+
providedUriPattern?: string | null;
|
|
3640
|
+
/**
|
|
3641
|
+
* Output only. Site ownership and validity verification status.
|
|
3642
|
+
*/
|
|
3643
|
+
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo;
|
|
3644
|
+
/**
|
|
3645
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
3646
|
+
*/
|
|
3647
|
+
type?: string | null;
|
|
3648
|
+
/**
|
|
3649
|
+
* Output only. The target site's last updated time.
|
|
3650
|
+
*/
|
|
3651
|
+
updateTime?: string | null;
|
|
3652
|
+
}
|
|
3653
|
+
/**
|
|
3654
|
+
* Site search indexing failure reasons.
|
|
3655
|
+
*/
|
|
3656
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason {
|
|
3657
|
+
/**
|
|
3658
|
+
* Failed due to insufficient quota.
|
|
3659
|
+
*/
|
|
3660
|
+
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure;
|
|
3661
|
+
}
|
|
3662
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure {
|
|
3663
|
+
/**
|
|
3664
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
3665
|
+
*/
|
|
3666
|
+
totalRequiredQuota?: string | null;
|
|
3667
|
+
}
|
|
3668
|
+
/**
|
|
3669
|
+
* Metadata for UpdateSchema LRO.
|
|
3670
|
+
*/
|
|
3671
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
|
|
3672
|
+
/**
|
|
3673
|
+
* Operation create time.
|
|
3674
|
+
*/
|
|
3675
|
+
createTime?: string | null;
|
|
3676
|
+
/**
|
|
3677
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3678
|
+
*/
|
|
3679
|
+
updateTime?: string | null;
|
|
3680
|
+
}
|
|
3681
|
+
/**
|
|
3682
|
+
* Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3683
|
+
*/
|
|
3684
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata {
|
|
3685
|
+
/**
|
|
3686
|
+
* Operation create time.
|
|
3687
|
+
*/
|
|
3688
|
+
createTime?: string | null;
|
|
3689
|
+
/**
|
|
3690
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3691
|
+
*/
|
|
3692
|
+
updateTime?: string | null;
|
|
3693
|
+
}
|
|
3694
|
+
/**
|
|
3695
|
+
* Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3696
|
+
*/
|
|
3697
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateDataStoreMetadata {
|
|
3698
|
+
/**
|
|
3699
|
+
* Operation create time.
|
|
3700
|
+
*/
|
|
3701
|
+
createTime?: string | null;
|
|
3702
|
+
/**
|
|
3703
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3704
|
+
*/
|
|
3705
|
+
updateTime?: string | null;
|
|
3706
|
+
}
|
|
3707
|
+
/**
|
|
3708
|
+
* Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3709
|
+
*/
|
|
3710
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateEngineMetadata {
|
|
3711
|
+
/**
|
|
3712
|
+
* Operation create time.
|
|
3713
|
+
*/
|
|
3714
|
+
createTime?: string | null;
|
|
3715
|
+
/**
|
|
3716
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3717
|
+
*/
|
|
3718
|
+
updateTime?: string | null;
|
|
3719
|
+
}
|
|
3720
|
+
/**
|
|
3721
|
+
* Metadata for Create Schema LRO.
|
|
3722
|
+
*/
|
|
3723
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateSchemaMetadata {
|
|
3724
|
+
/**
|
|
3725
|
+
* Operation create time.
|
|
3726
|
+
*/
|
|
3727
|
+
createTime?: string | null;
|
|
3728
|
+
/**
|
|
3729
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3730
|
+
*/
|
|
3731
|
+
updateTime?: string | null;
|
|
3732
|
+
}
|
|
3733
|
+
/**
|
|
3734
|
+
* Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3735
|
+
*/
|
|
3736
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata {
|
|
3737
|
+
/**
|
|
3738
|
+
* Operation create time.
|
|
3739
|
+
*/
|
|
3740
|
+
createTime?: string | null;
|
|
3741
|
+
/**
|
|
3742
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3743
|
+
*/
|
|
3744
|
+
updateTime?: string | null;
|
|
3745
|
+
}
|
|
3746
|
+
/**
|
|
3747
|
+
* DataStore captures global settings and configs at the DataStore level.
|
|
3748
|
+
*/
|
|
3749
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataStore {
|
|
3750
|
+
/**
|
|
3751
|
+
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
3752
|
+
*/
|
|
3753
|
+
contentConfig?: string | null;
|
|
3754
|
+
/**
|
|
3755
|
+
* Output only. Timestamp the DataStore was created at.
|
|
3756
|
+
*/
|
|
3757
|
+
createTime?: string | null;
|
|
3758
|
+
/**
|
|
3759
|
+
* Output only. The id of the default Schema asscociated to this data store.
|
|
3760
|
+
*/
|
|
3761
|
+
defaultSchemaId?: string | null;
|
|
3762
|
+
/**
|
|
3763
|
+
* 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.
|
|
3764
|
+
*/
|
|
3765
|
+
displayName?: string | null;
|
|
3766
|
+
/**
|
|
3767
|
+
* Immutable. The industry vertical that the data store registers.
|
|
3768
|
+
*/
|
|
3769
|
+
industryVertical?: string | null;
|
|
3770
|
+
/**
|
|
3771
|
+
* 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.
|
|
3772
|
+
*/
|
|
3773
|
+
name?: string | null;
|
|
3774
|
+
/**
|
|
3775
|
+
* 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.
|
|
3776
|
+
*/
|
|
3777
|
+
solutionTypes?: string[] | null;
|
|
3778
|
+
}
|
|
3779
|
+
/**
|
|
3780
|
+
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3781
|
+
*/
|
|
3782
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
|
|
3783
|
+
/**
|
|
3784
|
+
* Operation create time.
|
|
3785
|
+
*/
|
|
3786
|
+
createTime?: string | null;
|
|
3787
|
+
/**
|
|
3788
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3789
|
+
*/
|
|
3790
|
+
updateTime?: string | null;
|
|
3791
|
+
}
|
|
3792
|
+
/**
|
|
3793
|
+
* Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3794
|
+
*/
|
|
3795
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteEngineMetadata {
|
|
3796
|
+
/**
|
|
3797
|
+
* Operation create time.
|
|
3798
|
+
*/
|
|
3799
|
+
createTime?: string | null;
|
|
3800
|
+
/**
|
|
3801
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3802
|
+
*/
|
|
3803
|
+
updateTime?: string | null;
|
|
3804
|
+
}
|
|
3805
|
+
/**
|
|
3806
|
+
* Metadata for DeleteSchema LRO.
|
|
3807
|
+
*/
|
|
3808
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteSchemaMetadata {
|
|
3809
|
+
/**
|
|
3810
|
+
* Operation create time.
|
|
3811
|
+
*/
|
|
3812
|
+
createTime?: string | null;
|
|
3813
|
+
/**
|
|
3814
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3815
|
+
*/
|
|
3816
|
+
updateTime?: string | null;
|
|
3817
|
+
}
|
|
3818
|
+
/**
|
|
3819
|
+
* Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3820
|
+
*/
|
|
3821
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata {
|
|
3822
|
+
/**
|
|
3823
|
+
* Operation create time.
|
|
3824
|
+
*/
|
|
3825
|
+
createTime?: string | null;
|
|
3826
|
+
/**
|
|
3827
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3828
|
+
*/
|
|
3829
|
+
updateTime?: string | null;
|
|
3830
|
+
}
|
|
3831
|
+
/**
|
|
3832
|
+
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3833
|
+
*/
|
|
3834
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata {
|
|
3835
|
+
/**
|
|
3836
|
+
* Operation create time.
|
|
3837
|
+
*/
|
|
3838
|
+
createTime?: string | null;
|
|
3839
|
+
/**
|
|
3840
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3841
|
+
*/
|
|
3842
|
+
updateTime?: string | null;
|
|
3843
|
+
}
|
|
3844
|
+
/**
|
|
3845
|
+
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
3846
|
+
*/
|
|
3847
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {
|
|
3848
|
+
}
|
|
3849
|
+
/**
|
|
3850
|
+
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3851
|
+
*/
|
|
3852
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
|
|
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
|
+
* Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
|
3864
|
+
*/
|
|
3865
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {
|
|
3866
|
+
}
|
|
3867
|
+
/**
|
|
3868
|
+
* Metadata that describes the training and serving parameters of an Engine.
|
|
3869
|
+
*/
|
|
3870
|
+
export interface Schema$GoogleCloudDiscoveryengineV1Engine {
|
|
3871
|
+
/**
|
|
3872
|
+
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3873
|
+
*/
|
|
3874
|
+
chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig;
|
|
3875
|
+
/**
|
|
3876
|
+
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3877
|
+
*/
|
|
3878
|
+
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata;
|
|
3879
|
+
/**
|
|
3880
|
+
* Common config spec that specifies the metadata of the engine.
|
|
3881
|
+
*/
|
|
3882
|
+
commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig;
|
|
3883
|
+
/**
|
|
3884
|
+
* Output only. Timestamp the Recommendation Engine was created at.
|
|
3885
|
+
*/
|
|
3886
|
+
createTime?: string | null;
|
|
3887
|
+
/**
|
|
3888
|
+
* 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.
|
|
3889
|
+
*/
|
|
3890
|
+
dataStoreIds?: string[] | null;
|
|
3891
|
+
/**
|
|
3892
|
+
* Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
|
|
3893
|
+
*/
|
|
3894
|
+
displayName?: string | null;
|
|
3895
|
+
/**
|
|
3896
|
+
* 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.
|
|
3897
|
+
*/
|
|
3898
|
+
industryVertical?: string | null;
|
|
3031
3899
|
/**
|
|
3032
|
-
*
|
|
3900
|
+
* 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.
|
|
3033
3901
|
*/
|
|
3034
|
-
|
|
3902
|
+
name?: string | null;
|
|
3035
3903
|
/**
|
|
3036
|
-
*
|
|
3904
|
+
* Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
3037
3905
|
*/
|
|
3038
|
-
|
|
3906
|
+
searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
|
|
3039
3907
|
/**
|
|
3040
|
-
*
|
|
3908
|
+
* Required. The solutions of the engine.
|
|
3041
3909
|
*/
|
|
3042
|
-
|
|
3910
|
+
solutionType?: string | null;
|
|
3043
3911
|
/**
|
|
3044
|
-
*
|
|
3912
|
+
* Output only. Timestamp the Recommendation Engine was last updated.
|
|
3045
3913
|
*/
|
|
3046
3914
|
updateTime?: string | null;
|
|
3047
3915
|
}
|
|
3048
3916
|
/**
|
|
3049
|
-
*
|
|
3917
|
+
* Configurations for a Chat Engine.
|
|
3050
3918
|
*/
|
|
3051
|
-
export interface Schema$
|
|
3919
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig {
|
|
3052
3920
|
/**
|
|
3053
|
-
* The
|
|
3921
|
+
* 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.
|
|
3054
3922
|
*/
|
|
3055
|
-
|
|
3923
|
+
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
|
|
3056
3924
|
/**
|
|
3057
|
-
*
|
|
3925
|
+
* 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.
|
|
3058
3926
|
*/
|
|
3059
|
-
|
|
3927
|
+
dialogflowAgentToLink?: string | null;
|
|
3060
3928
|
}
|
|
3061
3929
|
/**
|
|
3062
|
-
*
|
|
3930
|
+
* 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.
|
|
3063
3931
|
*/
|
|
3064
|
-
export interface Schema$
|
|
3932
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig {
|
|
3065
3933
|
/**
|
|
3066
|
-
*
|
|
3934
|
+
* Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
|
|
3067
3935
|
*/
|
|
3068
|
-
|
|
3936
|
+
business?: string | null;
|
|
3069
3937
|
/**
|
|
3070
|
-
*
|
|
3938
|
+
* 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.
|
|
3071
3939
|
*/
|
|
3072
|
-
|
|
3940
|
+
defaultLanguageCode?: string | null;
|
|
3073
3941
|
/**
|
|
3074
|
-
*
|
|
3942
|
+
* 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.
|
|
3075
3943
|
*/
|
|
3076
|
-
|
|
3077
|
-
|
|
3078
|
-
|
|
3944
|
+
location?: string | null;
|
|
3945
|
+
/**
|
|
3946
|
+
* 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.
|
|
3947
|
+
*/
|
|
3948
|
+
timeZone?: string | null;
|
|
3079
3949
|
}
|
|
3080
3950
|
/**
|
|
3081
|
-
*
|
|
3951
|
+
* Additional information of a Chat Engine. Fields in this message are output only.
|
|
3082
3952
|
*/
|
|
3083
|
-
export interface Schema$
|
|
3084
|
-
/**
|
|
3085
|
-
* Operation create time.
|
|
3086
|
-
*/
|
|
3087
|
-
createTime?: string | null;
|
|
3953
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata {
|
|
3088
3954
|
/**
|
|
3089
|
-
*
|
|
3955
|
+
* The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
|
|
3090
3956
|
*/
|
|
3091
|
-
|
|
3957
|
+
dialogflowAgent?: string | null;
|
|
3092
3958
|
}
|
|
3093
3959
|
/**
|
|
3094
|
-
*
|
|
3960
|
+
* Common configurations for an Engine.
|
|
3095
3961
|
*/
|
|
3096
|
-
export interface Schema$
|
|
3097
|
-
/**
|
|
3098
|
-
* Operation create time.
|
|
3099
|
-
*/
|
|
3100
|
-
createTime?: string | null;
|
|
3962
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig {
|
|
3101
3963
|
/**
|
|
3102
|
-
*
|
|
3964
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
3103
3965
|
*/
|
|
3104
|
-
|
|
3966
|
+
companyName?: string | null;
|
|
3105
3967
|
}
|
|
3106
3968
|
/**
|
|
3107
|
-
*
|
|
3969
|
+
* Configurations for a Search Engine.
|
|
3108
3970
|
*/
|
|
3109
|
-
export interface Schema$
|
|
3971
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
3110
3972
|
/**
|
|
3111
|
-
*
|
|
3973
|
+
* The add-on that this search engine enables.
|
|
3112
3974
|
*/
|
|
3113
|
-
|
|
3975
|
+
searchAddOns?: string[] | null;
|
|
3114
3976
|
/**
|
|
3115
|
-
*
|
|
3977
|
+
* 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.
|
|
3116
3978
|
*/
|
|
3117
|
-
|
|
3979
|
+
searchTier?: string | null;
|
|
3118
3980
|
}
|
|
3119
3981
|
/**
|
|
3120
3982
|
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
@@ -3159,6 +4021,36 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3159
4021
|
*/
|
|
3160
4022
|
gcsPrefix?: string | null;
|
|
3161
4023
|
}
|
|
4024
|
+
/**
|
|
4025
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
4026
|
+
*/
|
|
4027
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata {
|
|
4028
|
+
/**
|
|
4029
|
+
* Operation create time.
|
|
4030
|
+
*/
|
|
4031
|
+
createTime?: string | null;
|
|
4032
|
+
/**
|
|
4033
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4034
|
+
*/
|
|
4035
|
+
updateTime?: string | null;
|
|
4036
|
+
}
|
|
4037
|
+
/**
|
|
4038
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
4039
|
+
*/
|
|
4040
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse {
|
|
4041
|
+
/**
|
|
4042
|
+
* A sample of errors encountered while processing the request.
|
|
4043
|
+
*/
|
|
4044
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4045
|
+
/**
|
|
4046
|
+
* Count of deny list entries that failed to be imported.
|
|
4047
|
+
*/
|
|
4048
|
+
failedEntriesCount?: string | null;
|
|
4049
|
+
/**
|
|
4050
|
+
* Count of deny list entries successfully imported.
|
|
4051
|
+
*/
|
|
4052
|
+
importedEntriesCount?: string | null;
|
|
4053
|
+
}
|
|
3162
4054
|
/**
|
|
3163
4055
|
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3164
4056
|
*/
|
|
@@ -3235,6 +4127,32 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3235
4127
|
*/
|
|
3236
4128
|
purgeSample?: string[] | null;
|
|
3237
4129
|
}
|
|
4130
|
+
/**
|
|
4131
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
4132
|
+
*/
|
|
4133
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata {
|
|
4134
|
+
/**
|
|
4135
|
+
* Operation create time.
|
|
4136
|
+
*/
|
|
4137
|
+
createTime?: string | null;
|
|
4138
|
+
/**
|
|
4139
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4140
|
+
*/
|
|
4141
|
+
updateTime?: string | null;
|
|
4142
|
+
}
|
|
4143
|
+
/**
|
|
4144
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
4145
|
+
*/
|
|
4146
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse {
|
|
4147
|
+
/**
|
|
4148
|
+
* A sample of errors encountered while processing the request.
|
|
4149
|
+
*/
|
|
4150
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4151
|
+
/**
|
|
4152
|
+
* Number of suggestion deny list entries purged.
|
|
4153
|
+
*/
|
|
4154
|
+
purgeCount?: string | null;
|
|
4155
|
+
}
|
|
3238
4156
|
/**
|
|
3239
4157
|
* Defines the structure and layout of a type of document data.
|
|
3240
4158
|
*/
|
|
@@ -3254,6 +4172,75 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3254
4172
|
[key: string]: any;
|
|
3255
4173
|
} | null;
|
|
3256
4174
|
}
|
|
4175
|
+
/**
|
|
4176
|
+
* Verification information for target sites in advanced site search.
|
|
4177
|
+
*/
|
|
4178
|
+
export interface Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo {
|
|
4179
|
+
/**
|
|
4180
|
+
* Site verification state indicating the ownership and validity.
|
|
4181
|
+
*/
|
|
4182
|
+
siteVerificationState?: string | null;
|
|
4183
|
+
/**
|
|
4184
|
+
* Latest site verification time.
|
|
4185
|
+
*/
|
|
4186
|
+
verifyTime?: string | null;
|
|
4187
|
+
}
|
|
4188
|
+
/**
|
|
4189
|
+
* A target site for the SiteSearchEngine.
|
|
4190
|
+
*/
|
|
4191
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSite {
|
|
4192
|
+
/**
|
|
4193
|
+
* 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.
|
|
4194
|
+
*/
|
|
4195
|
+
exactMatch?: boolean | null;
|
|
4196
|
+
/**
|
|
4197
|
+
* Output only. Failure reason.
|
|
4198
|
+
*/
|
|
4199
|
+
failureReason?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason;
|
|
4200
|
+
/**
|
|
4201
|
+
* Output only. This is system-generated based on the provided_uri_pattern.
|
|
4202
|
+
*/
|
|
4203
|
+
generatedUriPattern?: string | null;
|
|
4204
|
+
/**
|
|
4205
|
+
* Output only. Indexing status.
|
|
4206
|
+
*/
|
|
4207
|
+
indexingStatus?: string | null;
|
|
4208
|
+
/**
|
|
4209
|
+
* 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.
|
|
4210
|
+
*/
|
|
4211
|
+
name?: string | null;
|
|
4212
|
+
/**
|
|
4213
|
+
* Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
|
|
4214
|
+
*/
|
|
4215
|
+
providedUriPattern?: string | null;
|
|
4216
|
+
/**
|
|
4217
|
+
* Output only. Site ownership and validity verification status.
|
|
4218
|
+
*/
|
|
4219
|
+
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo;
|
|
4220
|
+
/**
|
|
4221
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
4222
|
+
*/
|
|
4223
|
+
type?: string | null;
|
|
4224
|
+
/**
|
|
4225
|
+
* Output only. The target site's last updated time.
|
|
4226
|
+
*/
|
|
4227
|
+
updateTime?: string | null;
|
|
4228
|
+
}
|
|
4229
|
+
/**
|
|
4230
|
+
* Site search indexing failure reasons.
|
|
4231
|
+
*/
|
|
4232
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason {
|
|
4233
|
+
/**
|
|
4234
|
+
* Failed due to insufficient quota.
|
|
4235
|
+
*/
|
|
4236
|
+
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure;
|
|
4237
|
+
}
|
|
4238
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure {
|
|
4239
|
+
/**
|
|
4240
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
4241
|
+
*/
|
|
4242
|
+
totalRequiredQuota?: string | null;
|
|
4243
|
+
}
|
|
3257
4244
|
/**
|
|
3258
4245
|
* Metadata for UpdateSchema LRO.
|
|
3259
4246
|
*/
|
|
@@ -3267,6 +4254,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3267
4254
|
*/
|
|
3268
4255
|
updateTime?: string | null;
|
|
3269
4256
|
}
|
|
4257
|
+
/**
|
|
4258
|
+
* Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4259
|
+
*/
|
|
4260
|
+
export interface Schema$GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata {
|
|
4261
|
+
/**
|
|
4262
|
+
* Operation create time.
|
|
4263
|
+
*/
|
|
4264
|
+
createTime?: string | null;
|
|
4265
|
+
/**
|
|
4266
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4267
|
+
*/
|
|
4268
|
+
updateTime?: string | null;
|
|
4269
|
+
}
|
|
3270
4270
|
/**
|
|
3271
4271
|
* The response message for Operations.ListOperations.
|
|
3272
4272
|
*/
|
|
@@ -3479,7 +4479,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3479
4479
|
}
|
|
3480
4480
|
export interface Params$Resource$Projects$Locations$Estimatedatasize extends StandardParameters {
|
|
3481
4481
|
/**
|
|
3482
|
-
* Required. Full resource name of the
|
|
4482
|
+
* Required. Full resource name of the location, such as `projects/{project\}/locations/{location\}`.
|
|
3483
4483
|
*/
|
|
3484
4484
|
location?: string;
|
|
3485
4485
|
/**
|
|
@@ -3565,6 +4565,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3565
4565
|
schemas: Resource$Projects$Locations$Collections$Datastores$Schemas;
|
|
3566
4566
|
servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs;
|
|
3567
4567
|
siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine;
|
|
4568
|
+
suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries;
|
|
3568
4569
|
userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
|
|
3569
4570
|
constructor(context: APIRequestContext);
|
|
3570
4571
|
/**
|
|
@@ -3722,7 +4723,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3722
4723
|
*/
|
|
3723
4724
|
query?: string;
|
|
3724
4725
|
/**
|
|
3725
|
-
*
|
|
4726
|
+
* 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
4727
|
*/
|
|
3727
4728
|
queryModel?: string;
|
|
3728
4729
|
/**
|
|
@@ -3786,7 +4787,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3786
4787
|
*/
|
|
3787
4788
|
pageToken?: string;
|
|
3788
4789
|
/**
|
|
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
|
|
4790
|
+
* 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
4791
|
*/
|
|
3791
4792
|
parent?: string;
|
|
3792
4793
|
}
|
|
@@ -3816,11 +4817,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3816
4817
|
}
|
|
3817
4818
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig extends StandardParameters {
|
|
3818
4819
|
/**
|
|
3819
|
-
*
|
|
4820
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
3820
4821
|
*/
|
|
3821
4822
|
name?: string;
|
|
3822
4823
|
/**
|
|
3823
|
-
* Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.
|
|
4824
|
+
* 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
4825
|
*/
|
|
3825
4826
|
updateMask?: string;
|
|
3826
4827
|
/**
|
|
@@ -4214,7 +5215,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4214
5215
|
*/
|
|
4215
5216
|
name?: string;
|
|
4216
5217
|
/**
|
|
4217
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
5218
|
+
* 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
5219
|
*/
|
|
4219
5220
|
updateMask?: string;
|
|
4220
5221
|
/**
|
|
@@ -4558,7 +5559,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4558
5559
|
}
|
|
4559
5560
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
4560
5561
|
/**
|
|
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.
|
|
5562
|
+
* 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
5563
|
*/
|
|
4563
5564
|
servingConfig?: string;
|
|
4564
5565
|
/**
|
|
@@ -4963,6 +5964,58 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4963
5964
|
*/
|
|
4964
5965
|
pageToken?: string;
|
|
4965
5966
|
}
|
|
5967
|
+
export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries {
|
|
5968
|
+
context: APIRequestContext;
|
|
5969
|
+
constructor(context: APIRequestContext);
|
|
5970
|
+
/**
|
|
5971
|
+
* Imports all SuggestionDenyListEntry for a DataStore.
|
|
5972
|
+
*
|
|
5973
|
+
* @param params - Parameters for request
|
|
5974
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5975
|
+
* @param callback - Optional callback that handles the response.
|
|
5976
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5977
|
+
*/
|
|
5978
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5979
|
+
import(params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5980
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5981
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5982
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5983
|
+
import(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5984
|
+
/**
|
|
5985
|
+
* Permanently deletes all SuggestionDenyListEntry for a DataStore.
|
|
5986
|
+
*
|
|
5987
|
+
* @param params - Parameters for request
|
|
5988
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5989
|
+
* @param callback - Optional callback that handles the response.
|
|
5990
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5991
|
+
*/
|
|
5992
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5993
|
+
purge(params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5994
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5995
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5996
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5997
|
+
purge(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5998
|
+
}
|
|
5999
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import extends StandardParameters {
|
|
6000
|
+
/**
|
|
6001
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
6002
|
+
*/
|
|
6003
|
+
parent?: string;
|
|
6004
|
+
/**
|
|
6005
|
+
* Request body metadata
|
|
6006
|
+
*/
|
|
6007
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest;
|
|
6008
|
+
}
|
|
6009
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge extends StandardParameters {
|
|
6010
|
+
/**
|
|
6011
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
6012
|
+
*/
|
|
6013
|
+
parent?: string;
|
|
6014
|
+
/**
|
|
6015
|
+
* Request body metadata
|
|
6016
|
+
*/
|
|
6017
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest;
|
|
6018
|
+
}
|
|
4966
6019
|
export class Resource$Projects$Locations$Collections$Datastores$Userevents {
|
|
4967
6020
|
context: APIRequestContext;
|
|
4968
6021
|
constructor(context: APIRequestContext);
|
|
@@ -5148,7 +6201,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5148
6201
|
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
5149
6202
|
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
5150
6203
|
/**
|
|
5151
|
-
* Pauses the training of an existing engine. Only applicable if
|
|
6204
|
+
* Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
5152
6205
|
*
|
|
5153
6206
|
* @param params - Parameters for request
|
|
5154
6207
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5162,7 +6215,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5162
6215
|
pause(params: Params$Resource$Projects$Locations$Collections$Engines$Pause, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
5163
6216
|
pause(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
5164
6217
|
/**
|
|
5165
|
-
* Resumes the training of an existing engine. Only applicable if
|
|
6218
|
+
* Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
5166
6219
|
*
|
|
5167
6220
|
* @param params - Parameters for request
|
|
5168
6221
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5176,7 +6229,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5176
6229
|
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Resume, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
5177
6230
|
resume(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
5178
6231
|
/**
|
|
5179
|
-
* Tunes an existing engine. Only applicable if
|
|
6232
|
+
* Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
5180
6233
|
*
|
|
5181
6234
|
* @param params - Parameters for request
|
|
5182
6235
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5426,7 +6479,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5426
6479
|
*/
|
|
5427
6480
|
name?: string;
|
|
5428
6481
|
/**
|
|
5429
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
6482
|
+
* 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
6483
|
*/
|
|
5431
6484
|
updateMask?: string;
|
|
5432
6485
|
/**
|
|
@@ -5524,7 +6577,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5524
6577
|
}
|
|
5525
6578
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
|
|
5526
6579
|
/**
|
|
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.
|
|
6580
|
+
* 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
6581
|
*/
|
|
5529
6582
|
servingConfig?: string;
|
|
5530
6583
|
/**
|
|
@@ -5607,6 +6660,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5607
6660
|
schemas: Resource$Projects$Locations$Datastores$Schemas;
|
|
5608
6661
|
servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs;
|
|
5609
6662
|
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
6663
|
+
suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries;
|
|
5610
6664
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
5611
6665
|
constructor(context: APIRequestContext);
|
|
5612
6666
|
/**
|
|
@@ -5750,7 +6804,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5750
6804
|
*/
|
|
5751
6805
|
query?: string;
|
|
5752
6806
|
/**
|
|
5753
|
-
*
|
|
6807
|
+
* 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
6808
|
*/
|
|
5755
6809
|
queryModel?: string;
|
|
5756
6810
|
/**
|
|
@@ -5814,7 +6868,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5814
6868
|
*/
|
|
5815
6869
|
pageToken?: string;
|
|
5816
6870
|
/**
|
|
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
|
|
6871
|
+
* 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
6872
|
*/
|
|
5819
6873
|
parent?: string;
|
|
5820
6874
|
}
|
|
@@ -5834,11 +6888,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5834
6888
|
}
|
|
5835
6889
|
export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig extends StandardParameters {
|
|
5836
6890
|
/**
|
|
5837
|
-
*
|
|
6891
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
5838
6892
|
*/
|
|
5839
6893
|
name?: string;
|
|
5840
6894
|
/**
|
|
5841
|
-
* Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.
|
|
6895
|
+
* 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
6896
|
*/
|
|
5843
6897
|
updateMask?: string;
|
|
5844
6898
|
/**
|
|
@@ -6232,7 +7286,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6232
7286
|
*/
|
|
6233
7287
|
name?: string;
|
|
6234
7288
|
/**
|
|
6235
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
7289
|
+
* 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
7290
|
*/
|
|
6237
7291
|
updateMask?: string;
|
|
6238
7292
|
/**
|
|
@@ -6519,7 +7573,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6519
7573
|
}
|
|
6520
7574
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
6521
7575
|
/**
|
|
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.
|
|
7576
|
+
* 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
7577
|
*/
|
|
6524
7578
|
servingConfig?: string;
|
|
6525
7579
|
/**
|
|
@@ -6758,6 +7812,58 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6758
7812
|
*/
|
|
6759
7813
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite;
|
|
6760
7814
|
}
|
|
7815
|
+
export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries {
|
|
7816
|
+
context: APIRequestContext;
|
|
7817
|
+
constructor(context: APIRequestContext);
|
|
7818
|
+
/**
|
|
7819
|
+
* Imports all SuggestionDenyListEntry for a DataStore.
|
|
7820
|
+
*
|
|
7821
|
+
* @param params - Parameters for request
|
|
7822
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7823
|
+
* @param callback - Optional callback that handles the response.
|
|
7824
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7825
|
+
*/
|
|
7826
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7827
|
+
import(params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7828
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7829
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7830
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7831
|
+
import(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7832
|
+
/**
|
|
7833
|
+
* Permanently deletes all SuggestionDenyListEntry for a DataStore.
|
|
7834
|
+
*
|
|
7835
|
+
* @param params - Parameters for request
|
|
7836
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7837
|
+
* @param callback - Optional callback that handles the response.
|
|
7838
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7839
|
+
*/
|
|
7840
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7841
|
+
purge(params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7842
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7843
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7844
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7845
|
+
purge(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7846
|
+
}
|
|
7847
|
+
export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import extends StandardParameters {
|
|
7848
|
+
/**
|
|
7849
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
7850
|
+
*/
|
|
7851
|
+
parent?: string;
|
|
7852
|
+
/**
|
|
7853
|
+
* Request body metadata
|
|
7854
|
+
*/
|
|
7855
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest;
|
|
7856
|
+
}
|
|
7857
|
+
export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge extends StandardParameters {
|
|
7858
|
+
/**
|
|
7859
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
7860
|
+
*/
|
|
7861
|
+
parent?: string;
|
|
7862
|
+
/**
|
|
7863
|
+
* Request body metadata
|
|
7864
|
+
*/
|
|
7865
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest;
|
|
7866
|
+
}
|
|
6761
7867
|
export class Resource$Projects$Locations$Datastores$Userevents {
|
|
6762
7868
|
context: APIRequestContext;
|
|
6763
7869
|
constructor(context: APIRequestContext);
|