@googleapis/discoveryengine 6.0.0 → 7.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 +20 -0
- package/build/v1alpha.d.ts +713 -2
- package/build/v1alpha.js +350 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +570 -2
- package/build/v1beta.js +288 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1alpha.ts +2073 -447
- package/v1beta.ts +1350 -30
package/build/v1beta.d.ts
CHANGED
|
@@ -192,6 +192,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
192
192
|
*/
|
|
193
193
|
functionName?: string | null;
|
|
194
194
|
}
|
|
195
|
+
/**
|
|
196
|
+
* Access Control Configuration.
|
|
197
|
+
*/
|
|
198
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAclConfig {
|
|
199
|
+
/**
|
|
200
|
+
* Identity provider config.
|
|
201
|
+
*/
|
|
202
|
+
idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
203
|
+
/**
|
|
204
|
+
* Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
205
|
+
*/
|
|
206
|
+
name?: string | null;
|
|
207
|
+
}
|
|
195
208
|
/**
|
|
196
209
|
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
197
210
|
*/
|
|
@@ -270,6 +283,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
270
283
|
* DataStore captures global settings and configs at the DataStore level.
|
|
271
284
|
*/
|
|
272
285
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDataStore {
|
|
286
|
+
/**
|
|
287
|
+
* Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.
|
|
288
|
+
*/
|
|
289
|
+
aclEnabled?: boolean | null;
|
|
273
290
|
/**
|
|
274
291
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
275
292
|
*/
|
|
@@ -286,6 +303,14 @@ export declare namespace discoveryengine_v1beta {
|
|
|
286
303
|
* 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.
|
|
287
304
|
*/
|
|
288
305
|
displayName?: string | null;
|
|
306
|
+
/**
|
|
307
|
+
* Configuration for Document understanding and enrichment.
|
|
308
|
+
*/
|
|
309
|
+
documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
|
|
310
|
+
/**
|
|
311
|
+
* Output only. Data store level identity provider config.
|
|
312
|
+
*/
|
|
313
|
+
idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
289
314
|
/**
|
|
290
315
|
* Immutable. The industry vertical that the data store registers.
|
|
291
316
|
*/
|
|
@@ -298,6 +323,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
298
323
|
* 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.
|
|
299
324
|
*/
|
|
300
325
|
solutionTypes?: string[] | null;
|
|
326
|
+
/**
|
|
327
|
+
* The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
|
|
328
|
+
*/
|
|
329
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1alphaSchema;
|
|
301
330
|
}
|
|
302
331
|
/**
|
|
303
332
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -391,7 +420,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
391
420
|
*/
|
|
392
421
|
ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
393
422
|
/**
|
|
394
|
-
* 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.
|
|
423
|
+
* 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. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
|
|
395
424
|
*/
|
|
396
425
|
parsingConfigOverrides?: {
|
|
397
426
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
@@ -436,6 +465,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
436
465
|
* Metadata that describes the training and serving parameters of an Engine.
|
|
437
466
|
*/
|
|
438
467
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine {
|
|
468
|
+
/**
|
|
469
|
+
* Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field.
|
|
470
|
+
*/
|
|
471
|
+
allowMultipleDataStoresSearchEngine?: boolean | null;
|
|
439
472
|
/**
|
|
440
473
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
441
474
|
*/
|
|
@@ -681,6 +714,28 @@ export declare namespace discoveryengine_v1beta {
|
|
|
681
714
|
*/
|
|
682
715
|
searchableOption?: string | null;
|
|
683
716
|
}
|
|
717
|
+
/**
|
|
718
|
+
* Identity Provider Config.
|
|
719
|
+
*/
|
|
720
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig {
|
|
721
|
+
/**
|
|
722
|
+
* External Identity provider config.
|
|
723
|
+
*/
|
|
724
|
+
externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig;
|
|
725
|
+
/**
|
|
726
|
+
* Identity provider type configured.
|
|
727
|
+
*/
|
|
728
|
+
idpType?: string | null;
|
|
729
|
+
}
|
|
730
|
+
/**
|
|
731
|
+
* Third party IDP Config.
|
|
732
|
+
*/
|
|
733
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig {
|
|
734
|
+
/**
|
|
735
|
+
* Workforce pool name. Example: "locations/global/workforcePools/pool_id"
|
|
736
|
+
*/
|
|
737
|
+
workforcePoolName?: string | null;
|
|
738
|
+
}
|
|
684
739
|
/**
|
|
685
740
|
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
686
741
|
*/
|
|
@@ -843,6 +898,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
843
898
|
* Count of entries that encountered errors while processing.
|
|
844
899
|
*/
|
|
845
900
|
failureCount?: string | null;
|
|
901
|
+
/**
|
|
902
|
+
* Count of entries that were ignored as entries were not found.
|
|
903
|
+
*/
|
|
904
|
+
ignoredCount?: string | null;
|
|
846
905
|
/**
|
|
847
906
|
* Count of entries that were deleted successfully.
|
|
848
907
|
*/
|
|
@@ -1079,6 +1138,9 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1079
1138
|
*/
|
|
1080
1139
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
1081
1140
|
}
|
|
1141
|
+
/**
|
|
1142
|
+
* Failed due to insufficient quota.
|
|
1143
|
+
*/
|
|
1082
1144
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
1083
1145
|
/**
|
|
1084
1146
|
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
@@ -1344,6 +1406,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1344
1406
|
* Request message for ConversationalSearchService.ConverseConversation method.
|
|
1345
1407
|
*/
|
|
1346
1408
|
export interface Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest {
|
|
1409
|
+
/**
|
|
1410
|
+
* Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
|
|
1411
|
+
*/
|
|
1412
|
+
boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
1347
1413
|
/**
|
|
1348
1414
|
* The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
|
|
1349
1415
|
*/
|
|
@@ -1494,6 +1560,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1494
1560
|
* 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.
|
|
1495
1561
|
*/
|
|
1496
1562
|
displayName?: string | null;
|
|
1563
|
+
/**
|
|
1564
|
+
* Configuration for Document understanding and enrichment.
|
|
1565
|
+
*/
|
|
1566
|
+
documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig;
|
|
1497
1567
|
/**
|
|
1498
1568
|
* Immutable. The industry vertical that the data store registers.
|
|
1499
1569
|
*/
|
|
@@ -1506,6 +1576,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1506
1576
|
* 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.
|
|
1507
1577
|
*/
|
|
1508
1578
|
solutionTypes?: string[] | null;
|
|
1579
|
+
/**
|
|
1580
|
+
* The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
|
|
1581
|
+
*/
|
|
1582
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema;
|
|
1509
1583
|
}
|
|
1510
1584
|
/**
|
|
1511
1585
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -1559,6 +1633,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1559
1633
|
*/
|
|
1560
1634
|
updateTime?: string | null;
|
|
1561
1635
|
}
|
|
1636
|
+
/**
|
|
1637
|
+
* The digital parsing configurations for documents.
|
|
1638
|
+
*/
|
|
1639
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {
|
|
1640
|
+
}
|
|
1562
1641
|
/**
|
|
1563
1642
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1564
1643
|
*/
|
|
@@ -1600,6 +1679,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1600
1679
|
* Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
|
|
1601
1680
|
*/
|
|
1602
1681
|
id?: string | null;
|
|
1682
|
+
/**
|
|
1683
|
+
* Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.
|
|
1684
|
+
*/
|
|
1685
|
+
indexTime?: string | null;
|
|
1603
1686
|
/**
|
|
1604
1687
|
* The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
|
|
1605
1688
|
*/
|
|
@@ -1665,6 +1748,38 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1665
1748
|
*/
|
|
1666
1749
|
uri?: string | null;
|
|
1667
1750
|
}
|
|
1751
|
+
/**
|
|
1752
|
+
* A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.
|
|
1753
|
+
*/
|
|
1754
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
|
|
1755
|
+
/**
|
|
1756
|
+
* 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.
|
|
1757
|
+
*/
|
|
1758
|
+
defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1759
|
+
/**
|
|
1760
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
1761
|
+
*/
|
|
1762
|
+
name?: string | null;
|
|
1763
|
+
/**
|
|
1764
|
+
* 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. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
|
|
1765
|
+
*/
|
|
1766
|
+
parsingConfigOverrides?: {
|
|
1767
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1768
|
+
} | null;
|
|
1769
|
+
}
|
|
1770
|
+
/**
|
|
1771
|
+
* Related configurations applied to a specific type of document parser.
|
|
1772
|
+
*/
|
|
1773
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
|
|
1774
|
+
/**
|
|
1775
|
+
* Configurations applied to digital parser.
|
|
1776
|
+
*/
|
|
1777
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig;
|
|
1778
|
+
/**
|
|
1779
|
+
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
1780
|
+
*/
|
|
1781
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig;
|
|
1782
|
+
}
|
|
1668
1783
|
/**
|
|
1669
1784
|
* Double list.
|
|
1670
1785
|
*/
|
|
@@ -1674,6 +1789,15 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1674
1789
|
*/
|
|
1675
1790
|
values?: number[] | null;
|
|
1676
1791
|
}
|
|
1792
|
+
/**
|
|
1793
|
+
* Defines embedding config, used for bring your own embeddings feature.
|
|
1794
|
+
*/
|
|
1795
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig {
|
|
1796
|
+
/**
|
|
1797
|
+
* Full field path in the schema mapped as embedding field.
|
|
1798
|
+
*/
|
|
1799
|
+
fieldPath?: string | null;
|
|
1800
|
+
}
|
|
1677
1801
|
/**
|
|
1678
1802
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1679
1803
|
*/
|
|
@@ -2136,6 +2260,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2136
2260
|
*/
|
|
2137
2261
|
schemas?: Schema$GoogleCloudDiscoveryengineV1betaSchema[];
|
|
2138
2262
|
}
|
|
2263
|
+
/**
|
|
2264
|
+
* Response for ListServingConfigs method.
|
|
2265
|
+
*/
|
|
2266
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse {
|
|
2267
|
+
/**
|
|
2268
|
+
* Pagination token, if not returned indicates the last page.
|
|
2269
|
+
*/
|
|
2270
|
+
nextPageToken?: string | null;
|
|
2271
|
+
/**
|
|
2272
|
+
* All the ServingConfigs for a given dataStore.
|
|
2273
|
+
*/
|
|
2274
|
+
servingConfigs?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig[];
|
|
2275
|
+
}
|
|
2139
2276
|
/**
|
|
2140
2277
|
* Response message for SiteSearchEngineService.ListTargetSites method.
|
|
2141
2278
|
*/
|
|
@@ -2166,6 +2303,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2166
2303
|
*/
|
|
2167
2304
|
mediaProgressPercentage?: number | null;
|
|
2168
2305
|
}
|
|
2306
|
+
/**
|
|
2307
|
+
* The OCR parsing configurations for documents.
|
|
2308
|
+
*/
|
|
2309
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig {
|
|
2310
|
+
/**
|
|
2311
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
2312
|
+
*/
|
|
2313
|
+
enhancedDocumentElements?: string[] | null;
|
|
2314
|
+
/**
|
|
2315
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
2316
|
+
*/
|
|
2317
|
+
useNativeText?: boolean | null;
|
|
2318
|
+
}
|
|
2169
2319
|
/**
|
|
2170
2320
|
* Detailed page information.
|
|
2171
2321
|
*/
|
|
@@ -2220,6 +2370,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2220
2370
|
* Count of entries that encountered errors while processing.
|
|
2221
2371
|
*/
|
|
2222
2372
|
failureCount?: string | null;
|
|
2373
|
+
/**
|
|
2374
|
+
* Count of entries that were ignored as entries were not found.
|
|
2375
|
+
*/
|
|
2376
|
+
ignoredCount?: string | null;
|
|
2223
2377
|
/**
|
|
2224
2378
|
* Count of entries that were deleted successfully.
|
|
2225
2379
|
*/
|
|
@@ -2553,7 +2707,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2553
2707
|
*/
|
|
2554
2708
|
boost?: number | null;
|
|
2555
2709
|
/**
|
|
2556
|
-
* An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (
|
|
2710
|
+
* An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))
|
|
2557
2711
|
*/
|
|
2558
2712
|
condition?: string | null;
|
|
2559
2713
|
}
|
|
@@ -2941,6 +3095,9 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2941
3095
|
* The summary content.
|
|
2942
3096
|
*/
|
|
2943
3097
|
summaryText?: string | null;
|
|
3098
|
+
/**
|
|
3099
|
+
* Summary with metadata information.
|
|
3100
|
+
*/
|
|
2944
3101
|
summaryWithMetadata?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata;
|
|
2945
3102
|
}
|
|
2946
3103
|
/**
|
|
@@ -3025,6 +3182,121 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3025
3182
|
*/
|
|
3026
3183
|
summary?: string | null;
|
|
3027
3184
|
}
|
|
3185
|
+
/**
|
|
3186
|
+
* Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.
|
|
3187
|
+
*/
|
|
3188
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfig {
|
|
3189
|
+
/**
|
|
3190
|
+
* Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.
|
|
3191
|
+
*/
|
|
3192
|
+
boostControlIds?: string[] | null;
|
|
3193
|
+
/**
|
|
3194
|
+
* Output only. ServingConfig created timestamp.
|
|
3195
|
+
*/
|
|
3196
|
+
createTime?: string | null;
|
|
3197
|
+
/**
|
|
3198
|
+
* Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3199
|
+
*/
|
|
3200
|
+
displayName?: string | null;
|
|
3201
|
+
/**
|
|
3202
|
+
* Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
3203
|
+
*/
|
|
3204
|
+
dissociateControlIds?: string[] | null;
|
|
3205
|
+
/**
|
|
3206
|
+
* How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
3207
|
+
*/
|
|
3208
|
+
diversityLevel?: string | null;
|
|
3209
|
+
/**
|
|
3210
|
+
* Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config.
|
|
3211
|
+
*/
|
|
3212
|
+
embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig;
|
|
3213
|
+
/**
|
|
3214
|
+
* Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.
|
|
3215
|
+
*/
|
|
3216
|
+
filterControlIds?: string[] | null;
|
|
3217
|
+
/**
|
|
3218
|
+
* The GenericConfig of the serving configuration.
|
|
3219
|
+
*/
|
|
3220
|
+
genericConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig;
|
|
3221
|
+
/**
|
|
3222
|
+
* Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.
|
|
3223
|
+
*/
|
|
3224
|
+
ignoreControlIds?: string[] | null;
|
|
3225
|
+
/**
|
|
3226
|
+
* The MediaConfig of the serving configuration.
|
|
3227
|
+
*/
|
|
3228
|
+
mediaConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig;
|
|
3229
|
+
/**
|
|
3230
|
+
* The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
3231
|
+
*/
|
|
3232
|
+
modelId?: string | null;
|
|
3233
|
+
/**
|
|
3234
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
3235
|
+
*/
|
|
3236
|
+
name?: string | null;
|
|
3237
|
+
/**
|
|
3238
|
+
* Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
3239
|
+
*/
|
|
3240
|
+
onewaySynonymsControlIds?: string[] | null;
|
|
3241
|
+
/**
|
|
3242
|
+
* The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).
|
|
3243
|
+
*/
|
|
3244
|
+
rankingExpression?: string | null;
|
|
3245
|
+
/**
|
|
3246
|
+
* IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
3247
|
+
*/
|
|
3248
|
+
redirectControlIds?: string[] | null;
|
|
3249
|
+
/**
|
|
3250
|
+
* Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
3251
|
+
*/
|
|
3252
|
+
replacementControlIds?: string[] | null;
|
|
3253
|
+
/**
|
|
3254
|
+
* Required. Immutable. Specifies the solution type that a serving config can be associated with.
|
|
3255
|
+
*/
|
|
3256
|
+
solutionType?: string | null;
|
|
3257
|
+
/**
|
|
3258
|
+
* Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
3259
|
+
*/
|
|
3260
|
+
synonymsControlIds?: string[] | null;
|
|
3261
|
+
/**
|
|
3262
|
+
* Output only. ServingConfig updated timestamp.
|
|
3263
|
+
*/
|
|
3264
|
+
updateTime?: string | null;
|
|
3265
|
+
}
|
|
3266
|
+
/**
|
|
3267
|
+
* Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.
|
|
3268
|
+
*/
|
|
3269
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig {
|
|
3270
|
+
/**
|
|
3271
|
+
* Specifies the expected behavior of content search. Only valid for content-search enabled data store.
|
|
3272
|
+
*/
|
|
3273
|
+
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
3274
|
+
}
|
|
3275
|
+
/**
|
|
3276
|
+
* Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
3277
|
+
*/
|
|
3278
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig {
|
|
3279
|
+
/**
|
|
3280
|
+
* Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
|
|
3281
|
+
*/
|
|
3282
|
+
contentFreshnessCutoffDays?: number | null;
|
|
3283
|
+
/**
|
|
3284
|
+
* Specifies the content watched minutes threshold for demotion.
|
|
3285
|
+
*/
|
|
3286
|
+
contentWatchedMinutesThreshold?: number | null;
|
|
3287
|
+
/**
|
|
3288
|
+
* Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
|
|
3289
|
+
*/
|
|
3290
|
+
contentWatchedPercentageThreshold?: number | null;
|
|
3291
|
+
/**
|
|
3292
|
+
* Specifies the content watched minutes threshold for demotion.
|
|
3293
|
+
*/
|
|
3294
|
+
contentWatchedSecondsThreshold?: number | null;
|
|
3295
|
+
/**
|
|
3296
|
+
* Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.
|
|
3297
|
+
*/
|
|
3298
|
+
demotionEventType?: string | null;
|
|
3299
|
+
}
|
|
3028
3300
|
/**
|
|
3029
3301
|
* SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
|
|
3030
3302
|
*/
|
|
@@ -3110,6 +3382,9 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3110
3382
|
*/
|
|
3111
3383
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure;
|
|
3112
3384
|
}
|
|
3385
|
+
/**
|
|
3386
|
+
* Failed due to insufficient quota.
|
|
3387
|
+
*/
|
|
3113
3388
|
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure {
|
|
3114
3389
|
/**
|
|
3115
3390
|
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
@@ -3348,6 +3623,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3348
3623
|
* 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.
|
|
3349
3624
|
*/
|
|
3350
3625
|
displayName?: string | null;
|
|
3626
|
+
/**
|
|
3627
|
+
* Configuration for Document understanding and enrichment.
|
|
3628
|
+
*/
|
|
3629
|
+
documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig;
|
|
3351
3630
|
/**
|
|
3352
3631
|
* Immutable. The industry vertical that the data store registers.
|
|
3353
3632
|
*/
|
|
@@ -3360,6 +3639,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3360
3639
|
* 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.
|
|
3361
3640
|
*/
|
|
3362
3641
|
solutionTypes?: string[] | null;
|
|
3642
|
+
/**
|
|
3643
|
+
* The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
|
|
3644
|
+
*/
|
|
3645
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema;
|
|
3363
3646
|
}
|
|
3364
3647
|
/**
|
|
3365
3648
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -3413,6 +3696,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3413
3696
|
*/
|
|
3414
3697
|
updateTime?: string | null;
|
|
3415
3698
|
}
|
|
3699
|
+
/**
|
|
3700
|
+
* The digital parsing configurations for documents.
|
|
3701
|
+
*/
|
|
3702
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig {
|
|
3703
|
+
}
|
|
3416
3704
|
/**
|
|
3417
3705
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3418
3706
|
*/
|
|
@@ -3431,6 +3719,38 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3431
3719
|
*/
|
|
3432
3720
|
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {
|
|
3433
3721
|
}
|
|
3722
|
+
/**
|
|
3723
|
+
* A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.
|
|
3724
|
+
*/
|
|
3725
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
|
|
3726
|
+
/**
|
|
3727
|
+
* 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.
|
|
3728
|
+
*/
|
|
3729
|
+
defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
3730
|
+
/**
|
|
3731
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
3732
|
+
*/
|
|
3733
|
+
name?: string | null;
|
|
3734
|
+
/**
|
|
3735
|
+
* 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. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
|
|
3736
|
+
*/
|
|
3737
|
+
parsingConfigOverrides?: {
|
|
3738
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
3739
|
+
} | null;
|
|
3740
|
+
}
|
|
3741
|
+
/**
|
|
3742
|
+
* Related configurations applied to a specific type of document parser.
|
|
3743
|
+
*/
|
|
3744
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
|
|
3745
|
+
/**
|
|
3746
|
+
* Configurations applied to digital parser.
|
|
3747
|
+
*/
|
|
3748
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig;
|
|
3749
|
+
/**
|
|
3750
|
+
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
3751
|
+
*/
|
|
3752
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig;
|
|
3753
|
+
}
|
|
3434
3754
|
/**
|
|
3435
3755
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3436
3756
|
*/
|
|
@@ -3678,6 +3998,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3678
3998
|
*/
|
|
3679
3999
|
unjoinedEventsCount?: string | null;
|
|
3680
4000
|
}
|
|
4001
|
+
/**
|
|
4002
|
+
* The OCR parsing configurations for documents.
|
|
4003
|
+
*/
|
|
4004
|
+
export interface Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig {
|
|
4005
|
+
/**
|
|
4006
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
4007
|
+
*/
|
|
4008
|
+
enhancedDocumentElements?: string[] | null;
|
|
4009
|
+
/**
|
|
4010
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
4011
|
+
*/
|
|
4012
|
+
useNativeText?: boolean | null;
|
|
4013
|
+
}
|
|
3681
4014
|
/**
|
|
3682
4015
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3683
4016
|
*/
|
|
@@ -3690,6 +4023,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3690
4023
|
* Count of entries that encountered errors while processing.
|
|
3691
4024
|
*/
|
|
3692
4025
|
failureCount?: string | null;
|
|
4026
|
+
/**
|
|
4027
|
+
* Count of entries that were ignored as entries were not found.
|
|
4028
|
+
*/
|
|
4029
|
+
ignoredCount?: string | null;
|
|
3693
4030
|
/**
|
|
3694
4031
|
* Count of entries that were deleted successfully.
|
|
3695
4032
|
*/
|
|
@@ -3820,6 +4157,9 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3820
4157
|
*/
|
|
3821
4158
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure;
|
|
3822
4159
|
}
|
|
4160
|
+
/**
|
|
4161
|
+
* Failed due to insufficient quota.
|
|
4162
|
+
*/
|
|
3823
4163
|
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure {
|
|
3824
4164
|
/**
|
|
3825
4165
|
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
@@ -4917,6 +5257,48 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4917
5257
|
export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs {
|
|
4918
5258
|
context: APIRequestContext;
|
|
4919
5259
|
constructor(context: APIRequestContext);
|
|
5260
|
+
/**
|
|
5261
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
5262
|
+
*
|
|
5263
|
+
* @param params - Parameters for request
|
|
5264
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5265
|
+
* @param callback - Optional callback that handles the response.
|
|
5266
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5267
|
+
*/
|
|
5268
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5269
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
5270
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5271
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5272
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5273
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5274
|
+
/**
|
|
5275
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
5276
|
+
*
|
|
5277
|
+
* @param params - Parameters for request
|
|
5278
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5279
|
+
* @param callback - Optional callback that handles the response.
|
|
5280
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5281
|
+
*/
|
|
5282
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5283
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>;
|
|
5284
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5285
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
5286
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
5287
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
5288
|
+
/**
|
|
5289
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
5290
|
+
*
|
|
5291
|
+
* @param params - Parameters for request
|
|
5292
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5293
|
+
* @param callback - Optional callback that handles the response.
|
|
5294
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5295
|
+
*/
|
|
5296
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5297
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
5298
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5299
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5300
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5301
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
4920
5302
|
/**
|
|
4921
5303
|
* Makes a recommendation, which requires a contextual user event.
|
|
4922
5304
|
*
|
|
@@ -4946,6 +5328,40 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4946
5328
|
search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
4947
5329
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
4948
5330
|
}
|
|
5331
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
5332
|
+
/**
|
|
5333
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
5334
|
+
*/
|
|
5335
|
+
name?: string;
|
|
5336
|
+
}
|
|
5337
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List extends StandardParameters {
|
|
5338
|
+
/**
|
|
5339
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
5340
|
+
*/
|
|
5341
|
+
pageSize?: number;
|
|
5342
|
+
/**
|
|
5343
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
5344
|
+
*/
|
|
5345
|
+
pageToken?: string;
|
|
5346
|
+
/**
|
|
5347
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
5348
|
+
*/
|
|
5349
|
+
parent?: string;
|
|
5350
|
+
}
|
|
5351
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
5352
|
+
/**
|
|
5353
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
5354
|
+
*/
|
|
5355
|
+
name?: string;
|
|
5356
|
+
/**
|
|
5357
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
5358
|
+
*/
|
|
5359
|
+
updateMask?: string;
|
|
5360
|
+
/**
|
|
5361
|
+
* Request body metadata
|
|
5362
|
+
*/
|
|
5363
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
5364
|
+
}
|
|
4949
5365
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
4950
5366
|
/**
|
|
4951
5367
|
* 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.
|
|
@@ -5839,6 +6255,48 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5839
6255
|
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
5840
6256
|
context: APIRequestContext;
|
|
5841
6257
|
constructor(context: APIRequestContext);
|
|
6258
|
+
/**
|
|
6259
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
6260
|
+
*
|
|
6261
|
+
* @param params - Parameters for request
|
|
6262
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6263
|
+
* @param callback - Optional callback that handles the response.
|
|
6264
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6265
|
+
*/
|
|
6266
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6267
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
6268
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6269
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6270
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6271
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6272
|
+
/**
|
|
6273
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
6274
|
+
*
|
|
6275
|
+
* @param params - Parameters for request
|
|
6276
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6277
|
+
* @param callback - Optional callback that handles the response.
|
|
6278
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6279
|
+
*/
|
|
6280
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6281
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>;
|
|
6282
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6283
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
6284
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
6285
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
6286
|
+
/**
|
|
6287
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
6288
|
+
*
|
|
6289
|
+
* @param params - Parameters for request
|
|
6290
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6291
|
+
* @param callback - Optional callback that handles the response.
|
|
6292
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6293
|
+
*/
|
|
6294
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6295
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
6296
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6297
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6298
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6299
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5842
6300
|
/**
|
|
5843
6301
|
* Makes a recommendation, which requires a contextual user event.
|
|
5844
6302
|
*
|
|
@@ -5868,6 +6326,40 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5868
6326
|
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
5869
6327
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
5870
6328
|
}
|
|
6329
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
|
|
6330
|
+
/**
|
|
6331
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
6332
|
+
*/
|
|
6333
|
+
name?: string;
|
|
6334
|
+
}
|
|
6335
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List extends StandardParameters {
|
|
6336
|
+
/**
|
|
6337
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
6338
|
+
*/
|
|
6339
|
+
pageSize?: number;
|
|
6340
|
+
/**
|
|
6341
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
6342
|
+
*/
|
|
6343
|
+
pageToken?: string;
|
|
6344
|
+
/**
|
|
6345
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
6346
|
+
*/
|
|
6347
|
+
parent?: string;
|
|
6348
|
+
}
|
|
6349
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters {
|
|
6350
|
+
/**
|
|
6351
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
6352
|
+
*/
|
|
6353
|
+
name?: string;
|
|
6354
|
+
/**
|
|
6355
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
6356
|
+
*/
|
|
6357
|
+
updateMask?: string;
|
|
6358
|
+
/**
|
|
6359
|
+
* Request body metadata
|
|
6360
|
+
*/
|
|
6361
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
6362
|
+
}
|
|
5871
6363
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
|
|
5872
6364
|
/**
|
|
5873
6365
|
* 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.
|
|
@@ -6787,6 +7279,48 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6787
7279
|
export class Resource$Projects$Locations$Datastores$Servingconfigs {
|
|
6788
7280
|
context: APIRequestContext;
|
|
6789
7281
|
constructor(context: APIRequestContext);
|
|
7282
|
+
/**
|
|
7283
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
7284
|
+
*
|
|
7285
|
+
* @param params - Parameters for request
|
|
7286
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7287
|
+
* @param callback - Optional callback that handles the response.
|
|
7288
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7289
|
+
*/
|
|
7290
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7291
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
7292
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7293
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
7294
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
7295
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
7296
|
+
/**
|
|
7297
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
7298
|
+
*
|
|
7299
|
+
* @param params - Parameters for request
|
|
7300
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7301
|
+
* @param callback - Optional callback that handles the response.
|
|
7302
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7303
|
+
*/
|
|
7304
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7305
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>;
|
|
7306
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7307
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
7308
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
7309
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
7310
|
+
/**
|
|
7311
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
7312
|
+
*
|
|
7313
|
+
* @param params - Parameters for request
|
|
7314
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7315
|
+
* @param callback - Optional callback that handles the response.
|
|
7316
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7317
|
+
*/
|
|
7318
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7319
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
7320
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7321
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
7322
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
7323
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6790
7324
|
/**
|
|
6791
7325
|
* Makes a recommendation, which requires a contextual user event.
|
|
6792
7326
|
*
|
|
@@ -6816,6 +7350,40 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6816
7350
|
search(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
6817
7351
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
6818
7352
|
}
|
|
7353
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
7354
|
+
/**
|
|
7355
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
7356
|
+
*/
|
|
7357
|
+
name?: string;
|
|
7358
|
+
}
|
|
7359
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List extends StandardParameters {
|
|
7360
|
+
/**
|
|
7361
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
7362
|
+
*/
|
|
7363
|
+
pageSize?: number;
|
|
7364
|
+
/**
|
|
7365
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
7366
|
+
*/
|
|
7367
|
+
pageToken?: string;
|
|
7368
|
+
/**
|
|
7369
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
7370
|
+
*/
|
|
7371
|
+
parent?: string;
|
|
7372
|
+
}
|
|
7373
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
7374
|
+
/**
|
|
7375
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
7376
|
+
*/
|
|
7377
|
+
name?: string;
|
|
7378
|
+
/**
|
|
7379
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
7380
|
+
*/
|
|
7381
|
+
updateMask?: string;
|
|
7382
|
+
/**
|
|
7383
|
+
* Request body metadata
|
|
7384
|
+
*/
|
|
7385
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
7386
|
+
}
|
|
6819
7387
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
6820
7388
|
/**
|
|
6821
7389
|
* 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.
|