@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/v1alpha.d.ts
CHANGED
|
@@ -193,6 +193,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
193
193
|
*/
|
|
194
194
|
functionName?: string | null;
|
|
195
195
|
}
|
|
196
|
+
/**
|
|
197
|
+
* Access Control Configuration.
|
|
198
|
+
*/
|
|
199
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAclConfig {
|
|
200
|
+
/**
|
|
201
|
+
* Identity provider config.
|
|
202
|
+
*/
|
|
203
|
+
idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
204
|
+
/**
|
|
205
|
+
* 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.
|
|
206
|
+
*/
|
|
207
|
+
name?: string | null;
|
|
208
|
+
}
|
|
196
209
|
/**
|
|
197
210
|
* AdditionalParams message for WidgetService methods for security and privacy enhancement.
|
|
198
211
|
*/
|
|
@@ -394,6 +407,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
394
407
|
* Request message for ConversationalSearchService.ConverseConversation method.
|
|
395
408
|
*/
|
|
396
409
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest {
|
|
410
|
+
/**
|
|
411
|
+
* 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)
|
|
412
|
+
*/
|
|
413
|
+
boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
397
414
|
/**
|
|
398
415
|
* 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.
|
|
399
416
|
*/
|
|
@@ -528,10 +545,23 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
528
545
|
*/
|
|
529
546
|
text?: string[] | null;
|
|
530
547
|
}
|
|
548
|
+
/**
|
|
549
|
+
* Defines custom fine tuning spec.
|
|
550
|
+
*/
|
|
551
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec {
|
|
552
|
+
/**
|
|
553
|
+
* Whether or not to enable and include custom fine tuned search adaptor model.
|
|
554
|
+
*/
|
|
555
|
+
enableSearchAdaptor?: boolean | null;
|
|
556
|
+
}
|
|
531
557
|
/**
|
|
532
558
|
* DataStore captures global settings and configs at the DataStore level.
|
|
533
559
|
*/
|
|
534
560
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDataStore {
|
|
561
|
+
/**
|
|
562
|
+
* 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.
|
|
563
|
+
*/
|
|
564
|
+
aclEnabled?: boolean | null;
|
|
535
565
|
/**
|
|
536
566
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
537
567
|
*/
|
|
@@ -548,6 +578,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
548
578
|
* 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.
|
|
549
579
|
*/
|
|
550
580
|
displayName?: string | null;
|
|
581
|
+
/**
|
|
582
|
+
* Configuration for Document understanding and enrichment.
|
|
583
|
+
*/
|
|
584
|
+
documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
|
|
585
|
+
/**
|
|
586
|
+
* Output only. Data store level identity provider config.
|
|
587
|
+
*/
|
|
588
|
+
idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
551
589
|
/**
|
|
552
590
|
* Immutable. The industry vertical that the data store registers.
|
|
553
591
|
*/
|
|
@@ -560,6 +598,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
560
598
|
* 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.
|
|
561
599
|
*/
|
|
562
600
|
solutionTypes?: string[] | null;
|
|
601
|
+
/**
|
|
602
|
+
* 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).
|
|
603
|
+
*/
|
|
604
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1alphaSchema;
|
|
563
605
|
}
|
|
564
606
|
/**
|
|
565
607
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -645,6 +687,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
645
687
|
* Document captures all raw metadata information of items to be recommended or searched.
|
|
646
688
|
*/
|
|
647
689
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocument {
|
|
690
|
+
/**
|
|
691
|
+
* Access control information for the document.
|
|
692
|
+
*/
|
|
693
|
+
aclInfo?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfo;
|
|
648
694
|
/**
|
|
649
695
|
* The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
|
|
650
696
|
*/
|
|
@@ -659,6 +705,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
659
705
|
* 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.
|
|
660
706
|
*/
|
|
661
707
|
id?: string | null;
|
|
708
|
+
/**
|
|
709
|
+
* 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.
|
|
710
|
+
*/
|
|
711
|
+
indexTime?: string | null;
|
|
662
712
|
/**
|
|
663
713
|
* The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
|
|
664
714
|
*/
|
|
@@ -682,6 +732,21 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
682
732
|
[key: string]: any;
|
|
683
733
|
} | null;
|
|
684
734
|
}
|
|
735
|
+
/**
|
|
736
|
+
* ACL Information of the Document.
|
|
737
|
+
*/
|
|
738
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfo {
|
|
739
|
+
readers?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction[];
|
|
740
|
+
}
|
|
741
|
+
/**
|
|
742
|
+
* AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --\> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" \}, { "user_id": "user_1" \} ] \} ] \} \} Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" \}, { "group_id": "group_3" \}, { "user_id": "user_2" \} ], \}, { "principals": [ { "group_id": "group_1" \}, { "user_id": "user_1" \} ], \} ] \} \}
|
|
743
|
+
*/
|
|
744
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction {
|
|
745
|
+
/**
|
|
746
|
+
* List of principals.
|
|
747
|
+
*/
|
|
748
|
+
principals?: Schema$GoogleCloudDiscoveryengineV1alphaPrincipal[];
|
|
749
|
+
}
|
|
685
750
|
/**
|
|
686
751
|
* Unstructured data linked to this document.
|
|
687
752
|
*/
|
|
@@ -741,7 +806,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
741
806
|
*/
|
|
742
807
|
ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
743
808
|
/**
|
|
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.
|
|
809
|
+
* 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.
|
|
745
810
|
*/
|
|
746
811
|
parsingConfigOverrides?: {
|
|
747
812
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
@@ -773,6 +838,15 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
773
838
|
*/
|
|
774
839
|
values?: number[] | null;
|
|
775
840
|
}
|
|
841
|
+
/**
|
|
842
|
+
* Defines embedding config, used for bring your own embeddings feature.
|
|
843
|
+
*/
|
|
844
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEmbeddingConfig {
|
|
845
|
+
/**
|
|
846
|
+
* Full field path in the schema mapped as embedding field.
|
|
847
|
+
*/
|
|
848
|
+
fieldPath?: string | null;
|
|
849
|
+
}
|
|
776
850
|
/**
|
|
777
851
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
778
852
|
*/
|
|
@@ -800,6 +874,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
800
874
|
* Metadata that describes the training and serving parameters of an Engine.
|
|
801
875
|
*/
|
|
802
876
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine {
|
|
877
|
+
/**
|
|
878
|
+
* 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.
|
|
879
|
+
*/
|
|
880
|
+
allowMultipleDataStoresSearchEngine?: boolean | null;
|
|
803
881
|
/**
|
|
804
882
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
805
883
|
*/
|
|
@@ -1127,6 +1205,45 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1127
1205
|
*/
|
|
1128
1206
|
inputUris?: string[] | null;
|
|
1129
1207
|
}
|
|
1208
|
+
/**
|
|
1209
|
+
* Defines guided search spec.
|
|
1210
|
+
*/
|
|
1211
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec {
|
|
1212
|
+
/**
|
|
1213
|
+
* Whether or not to enable and include refinement attributes in gudied search result.
|
|
1214
|
+
*/
|
|
1215
|
+
enableRefinementAttributes?: boolean | null;
|
|
1216
|
+
/**
|
|
1217
|
+
* Whether or not to enable and include related questions in search response.
|
|
1218
|
+
*/
|
|
1219
|
+
enableRelatedQuestions?: boolean | null;
|
|
1220
|
+
/**
|
|
1221
|
+
* Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3.
|
|
1222
|
+
*/
|
|
1223
|
+
maxRelatedQuestions?: number | null;
|
|
1224
|
+
}
|
|
1225
|
+
/**
|
|
1226
|
+
* Identity Provider Config.
|
|
1227
|
+
*/
|
|
1228
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig {
|
|
1229
|
+
/**
|
|
1230
|
+
* External Identity provider config.
|
|
1231
|
+
*/
|
|
1232
|
+
externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig;
|
|
1233
|
+
/**
|
|
1234
|
+
* Identity provider type configured.
|
|
1235
|
+
*/
|
|
1236
|
+
idpType?: string | null;
|
|
1237
|
+
}
|
|
1238
|
+
/**
|
|
1239
|
+
* Third party IDP Config.
|
|
1240
|
+
*/
|
|
1241
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig {
|
|
1242
|
+
/**
|
|
1243
|
+
* Workforce pool name. Example: "locations/global/workforcePools/pool_id"
|
|
1244
|
+
*/
|
|
1245
|
+
workforcePoolName?: string | null;
|
|
1246
|
+
}
|
|
1130
1247
|
/**
|
|
1131
1248
|
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1132
1249
|
*/
|
|
@@ -1427,6 +1544,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1427
1544
|
*/
|
|
1428
1545
|
schemas?: Schema$GoogleCloudDiscoveryengineV1alphaSchema[];
|
|
1429
1546
|
}
|
|
1547
|
+
/**
|
|
1548
|
+
* Response for ListServingConfigs method.
|
|
1549
|
+
*/
|
|
1550
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse {
|
|
1551
|
+
/**
|
|
1552
|
+
* Pagination token, if not returned indicates the last page.
|
|
1553
|
+
*/
|
|
1554
|
+
nextPageToken?: string | null;
|
|
1555
|
+
/**
|
|
1556
|
+
* All the ServingConfigs for a given dataStore.
|
|
1557
|
+
*/
|
|
1558
|
+
servingConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig[];
|
|
1559
|
+
}
|
|
1430
1560
|
/**
|
|
1431
1561
|
* Response message for SiteSearchEngineService.ListTargetSites method.
|
|
1432
1562
|
*/
|
|
@@ -1552,6 +1682,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1552
1682
|
*/
|
|
1553
1683
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaPauseEngineRequest {
|
|
1554
1684
|
}
|
|
1685
|
+
/**
|
|
1686
|
+
* Principal identifier of a user or a group.
|
|
1687
|
+
*/
|
|
1688
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPrincipal {
|
|
1689
|
+
/**
|
|
1690
|
+
* Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.
|
|
1691
|
+
*/
|
|
1692
|
+
groupId?: string | null;
|
|
1693
|
+
/**
|
|
1694
|
+
* User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.
|
|
1695
|
+
*/
|
|
1696
|
+
userId?: string | null;
|
|
1697
|
+
}
|
|
1555
1698
|
/**
|
|
1556
1699
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1557
1700
|
*/
|
|
@@ -1564,6 +1707,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1564
1707
|
* Count of entries that encountered errors while processing.
|
|
1565
1708
|
*/
|
|
1566
1709
|
failureCount?: string | null;
|
|
1710
|
+
/**
|
|
1711
|
+
* Count of entries that were ignored as entries were not found.
|
|
1712
|
+
*/
|
|
1713
|
+
ignoredCount?: string | null;
|
|
1567
1714
|
/**
|
|
1568
1715
|
* Count of entries that were deleted successfully.
|
|
1569
1716
|
*/
|
|
@@ -1577,6 +1724,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1577
1724
|
* Request message for DocumentService.PurgeDocuments method.
|
|
1578
1725
|
*/
|
|
1579
1726
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest {
|
|
1727
|
+
/**
|
|
1728
|
+
* The desired location of errors incurred during the purge.
|
|
1729
|
+
*/
|
|
1730
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig;
|
|
1580
1731
|
/**
|
|
1581
1732
|
* Required. Filter matching documents to purge. Only currently supported value is `*` (all items).
|
|
1582
1733
|
*/
|
|
@@ -1585,6 +1736,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1585
1736
|
* Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.
|
|
1586
1737
|
*/
|
|
1587
1738
|
force?: boolean | null;
|
|
1739
|
+
/**
|
|
1740
|
+
* Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line.
|
|
1741
|
+
*/
|
|
1742
|
+
gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource;
|
|
1588
1743
|
}
|
|
1589
1744
|
/**
|
|
1590
1745
|
* 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.
|
|
@@ -1599,6 +1754,15 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1599
1754
|
*/
|
|
1600
1755
|
purgeSample?: string[] | null;
|
|
1601
1756
|
}
|
|
1757
|
+
/**
|
|
1758
|
+
* Configuration of destination for Purge related errors.
|
|
1759
|
+
*/
|
|
1760
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig {
|
|
1761
|
+
/**
|
|
1762
|
+
* Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
|
|
1763
|
+
*/
|
|
1764
|
+
gcsPrefix?: string | null;
|
|
1765
|
+
}
|
|
1602
1766
|
/**
|
|
1603
1767
|
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1604
1768
|
*/
|
|
@@ -1930,6 +2094,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1930
2094
|
* A specification for configuring the behavior of content search.
|
|
1931
2095
|
*/
|
|
1932
2096
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
2097
|
+
/**
|
|
2098
|
+
* Custom fine tuning configs.
|
|
2099
|
+
*/
|
|
2100
|
+
customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
1933
2101
|
/**
|
|
1934
2102
|
* 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.
|
|
1935
2103
|
*/
|
|
@@ -2025,7 +2193,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2025
2193
|
*/
|
|
2026
2194
|
boost?: number | null;
|
|
2027
2195
|
/**
|
|
2028
|
-
* 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": * (
|
|
2196
|
+
* 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"))
|
|
2029
2197
|
*/
|
|
2030
2198
|
condition?: string | null;
|
|
2031
2199
|
}
|
|
@@ -2413,6 +2581,9 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2413
2581
|
* The summary content.
|
|
2414
2582
|
*/
|
|
2415
2583
|
summaryText?: string | null;
|
|
2584
|
+
/**
|
|
2585
|
+
* Summary with metadata information.
|
|
2586
|
+
*/
|
|
2416
2587
|
summaryWithMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata;
|
|
2417
2588
|
}
|
|
2418
2589
|
/**
|
|
@@ -2497,6 +2668,129 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2497
2668
|
*/
|
|
2498
2669
|
summary?: string | null;
|
|
2499
2670
|
}
|
|
2671
|
+
/**
|
|
2672
|
+
* 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.
|
|
2673
|
+
*/
|
|
2674
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfig {
|
|
2675
|
+
/**
|
|
2676
|
+
* 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.
|
|
2677
|
+
*/
|
|
2678
|
+
boostControlIds?: string[] | null;
|
|
2679
|
+
/**
|
|
2680
|
+
* Output only. ServingConfig created timestamp.
|
|
2681
|
+
*/
|
|
2682
|
+
createTime?: string | null;
|
|
2683
|
+
/**
|
|
2684
|
+
* Custom fine tuning configs.
|
|
2685
|
+
*/
|
|
2686
|
+
customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
2687
|
+
/**
|
|
2688
|
+
* 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.
|
|
2689
|
+
*/
|
|
2690
|
+
displayName?: string | null;
|
|
2691
|
+
/**
|
|
2692
|
+
* 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.
|
|
2693
|
+
*/
|
|
2694
|
+
dissociateControlIds?: string[] | null;
|
|
2695
|
+
/**
|
|
2696
|
+
* 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.
|
|
2697
|
+
*/
|
|
2698
|
+
diversityLevel?: string | null;
|
|
2699
|
+
/**
|
|
2700
|
+
* 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.
|
|
2701
|
+
*/
|
|
2702
|
+
embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEmbeddingConfig;
|
|
2703
|
+
/**
|
|
2704
|
+
* 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.
|
|
2705
|
+
*/
|
|
2706
|
+
filterControlIds?: string[] | null;
|
|
2707
|
+
/**
|
|
2708
|
+
* The GenericConfig of the serving configuration.
|
|
2709
|
+
*/
|
|
2710
|
+
genericConfig?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig;
|
|
2711
|
+
/**
|
|
2712
|
+
* Guided search configs.
|
|
2713
|
+
*/
|
|
2714
|
+
guidedSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec;
|
|
2715
|
+
/**
|
|
2716
|
+
* 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.
|
|
2717
|
+
*/
|
|
2718
|
+
ignoreControlIds?: string[] | null;
|
|
2719
|
+
/**
|
|
2720
|
+
* The MediaConfig of the serving configuration.
|
|
2721
|
+
*/
|
|
2722
|
+
mediaConfig?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig;
|
|
2723
|
+
/**
|
|
2724
|
+
* 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.
|
|
2725
|
+
*/
|
|
2726
|
+
modelId?: string | null;
|
|
2727
|
+
/**
|
|
2728
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
2729
|
+
*/
|
|
2730
|
+
name?: string | null;
|
|
2731
|
+
/**
|
|
2732
|
+
* 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.
|
|
2733
|
+
*/
|
|
2734
|
+
onewaySynonymsControlIds?: string[] | null;
|
|
2735
|
+
/**
|
|
2736
|
+
* 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).
|
|
2737
|
+
*/
|
|
2738
|
+
rankingExpression?: string | null;
|
|
2739
|
+
/**
|
|
2740
|
+
* 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.
|
|
2741
|
+
*/
|
|
2742
|
+
redirectControlIds?: string[] | null;
|
|
2743
|
+
/**
|
|
2744
|
+
* 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.
|
|
2745
|
+
*/
|
|
2746
|
+
replacementControlIds?: string[] | null;
|
|
2747
|
+
/**
|
|
2748
|
+
* Required. Immutable. Specifies the solution type that a serving config can be associated with.
|
|
2749
|
+
*/
|
|
2750
|
+
solutionType?: string | null;
|
|
2751
|
+
/**
|
|
2752
|
+
* 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.
|
|
2753
|
+
*/
|
|
2754
|
+
synonymsControlIds?: string[] | null;
|
|
2755
|
+
/**
|
|
2756
|
+
* Output only. ServingConfig updated timestamp.
|
|
2757
|
+
*/
|
|
2758
|
+
updateTime?: string | null;
|
|
2759
|
+
}
|
|
2760
|
+
/**
|
|
2761
|
+
* Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.
|
|
2762
|
+
*/
|
|
2763
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig {
|
|
2764
|
+
/**
|
|
2765
|
+
* Specifies the expected behavior of content search. Only valid for content-search enabled data store.
|
|
2766
|
+
*/
|
|
2767
|
+
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
2768
|
+
}
|
|
2769
|
+
/**
|
|
2770
|
+
* 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.
|
|
2771
|
+
*/
|
|
2772
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig {
|
|
2773
|
+
/**
|
|
2774
|
+
* Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
|
|
2775
|
+
*/
|
|
2776
|
+
contentFreshnessCutoffDays?: number | null;
|
|
2777
|
+
/**
|
|
2778
|
+
* Specifies the content watched minutes threshold for demotion.
|
|
2779
|
+
*/
|
|
2780
|
+
contentWatchedMinutesThreshold?: number | null;
|
|
2781
|
+
/**
|
|
2782
|
+
* Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
|
|
2783
|
+
*/
|
|
2784
|
+
contentWatchedPercentageThreshold?: number | null;
|
|
2785
|
+
/**
|
|
2786
|
+
* Specifies the content watched minutes threshold for demotion.
|
|
2787
|
+
*/
|
|
2788
|
+
contentWatchedSecondsThreshold?: number | null;
|
|
2789
|
+
/**
|
|
2790
|
+
* 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.
|
|
2791
|
+
*/
|
|
2792
|
+
demotionEventType?: string | null;
|
|
2793
|
+
}
|
|
2500
2794
|
/**
|
|
2501
2795
|
* SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
|
|
2502
2796
|
*/
|
|
@@ -2582,6 +2876,9 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2582
2876
|
*/
|
|
2583
2877
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
2584
2878
|
}
|
|
2879
|
+
/**
|
|
2880
|
+
* Failed due to insufficient quota.
|
|
2881
|
+
*/
|
|
2585
2882
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
2586
2883
|
/**
|
|
2587
2884
|
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
@@ -2934,6 +3231,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2934
3231
|
* Turn on or off summarization for the search response.
|
|
2935
3232
|
*/
|
|
2936
3233
|
enableSummarization?: boolean | null;
|
|
3234
|
+
/**
|
|
3235
|
+
* Whether to enable standalone web app.
|
|
3236
|
+
*/
|
|
3237
|
+
enableWebApp?: boolean | null;
|
|
2937
3238
|
/**
|
|
2938
3239
|
* The configuration and appearance of facets in the end user view.
|
|
2939
3240
|
*/
|
|
@@ -3187,6 +3488,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3187
3488
|
* 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
3489
|
*/
|
|
3189
3490
|
displayName?: string | null;
|
|
3491
|
+
/**
|
|
3492
|
+
* Configuration for Document understanding and enrichment.
|
|
3493
|
+
*/
|
|
3494
|
+
documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig;
|
|
3190
3495
|
/**
|
|
3191
3496
|
* Immutable. The industry vertical that the data store registers.
|
|
3192
3497
|
*/
|
|
@@ -3199,6 +3504,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3199
3504
|
* 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
3505
|
*/
|
|
3201
3506
|
solutionTypes?: string[] | null;
|
|
3507
|
+
/**
|
|
3508
|
+
* 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).
|
|
3509
|
+
*/
|
|
3510
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema;
|
|
3202
3511
|
}
|
|
3203
3512
|
/**
|
|
3204
3513
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -3252,6 +3561,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3252
3561
|
*/
|
|
3253
3562
|
updateTime?: string | null;
|
|
3254
3563
|
}
|
|
3564
|
+
/**
|
|
3565
|
+
* The digital parsing configurations for documents.
|
|
3566
|
+
*/
|
|
3567
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {
|
|
3568
|
+
}
|
|
3255
3569
|
/**
|
|
3256
3570
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3257
3571
|
*/
|
|
@@ -3270,6 +3584,38 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3270
3584
|
*/
|
|
3271
3585
|
export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {
|
|
3272
3586
|
}
|
|
3587
|
+
/**
|
|
3588
|
+
* 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.
|
|
3589
|
+
*/
|
|
3590
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
|
|
3591
|
+
/**
|
|
3592
|
+
* 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.
|
|
3593
|
+
*/
|
|
3594
|
+
defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
3595
|
+
/**
|
|
3596
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
3597
|
+
*/
|
|
3598
|
+
name?: string | null;
|
|
3599
|
+
/**
|
|
3600
|
+
* 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.
|
|
3601
|
+
*/
|
|
3602
|
+
parsingConfigOverrides?: {
|
|
3603
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
3604
|
+
} | null;
|
|
3605
|
+
}
|
|
3606
|
+
/**
|
|
3607
|
+
* Related configurations applied to a specific type of document parser.
|
|
3608
|
+
*/
|
|
3609
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
|
|
3610
|
+
/**
|
|
3611
|
+
* Configurations applied to digital parser.
|
|
3612
|
+
*/
|
|
3613
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig;
|
|
3614
|
+
/**
|
|
3615
|
+
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
3616
|
+
*/
|
|
3617
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig;
|
|
3618
|
+
}
|
|
3273
3619
|
/**
|
|
3274
3620
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3275
3621
|
*/
|
|
@@ -3517,6 +3863,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3517
3863
|
*/
|
|
3518
3864
|
unjoinedEventsCount?: string | null;
|
|
3519
3865
|
}
|
|
3866
|
+
/**
|
|
3867
|
+
* The OCR parsing configurations for documents.
|
|
3868
|
+
*/
|
|
3869
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig {
|
|
3870
|
+
/**
|
|
3871
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
3872
|
+
*/
|
|
3873
|
+
enhancedDocumentElements?: string[] | null;
|
|
3874
|
+
/**
|
|
3875
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
3876
|
+
*/
|
|
3877
|
+
useNativeText?: boolean | null;
|
|
3878
|
+
}
|
|
3520
3879
|
/**
|
|
3521
3880
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3522
3881
|
*/
|
|
@@ -3529,6 +3888,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3529
3888
|
* Count of entries that encountered errors while processing.
|
|
3530
3889
|
*/
|
|
3531
3890
|
failureCount?: string | null;
|
|
3891
|
+
/**
|
|
3892
|
+
* Count of entries that were ignored as entries were not found.
|
|
3893
|
+
*/
|
|
3894
|
+
ignoredCount?: string | null;
|
|
3532
3895
|
/**
|
|
3533
3896
|
* Count of entries that were deleted successfully.
|
|
3534
3897
|
*/
|
|
@@ -3659,6 +4022,9 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3659
4022
|
*/
|
|
3660
4023
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure;
|
|
3661
4024
|
}
|
|
4025
|
+
/**
|
|
4026
|
+
* Failed due to insufficient quota.
|
|
4027
|
+
*/
|
|
3662
4028
|
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure {
|
|
3663
4029
|
/**
|
|
3664
4030
|
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
@@ -3763,6 +4129,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3763
4129
|
* 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
4130
|
*/
|
|
3765
4131
|
displayName?: string | null;
|
|
4132
|
+
/**
|
|
4133
|
+
* Configuration for Document understanding and enrichment.
|
|
4134
|
+
*/
|
|
4135
|
+
documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig;
|
|
3766
4136
|
/**
|
|
3767
4137
|
* Immutable. The industry vertical that the data store registers.
|
|
3768
4138
|
*/
|
|
@@ -3775,6 +4145,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3775
4145
|
* 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
4146
|
*/
|
|
3777
4147
|
solutionTypes?: string[] | null;
|
|
4148
|
+
/**
|
|
4149
|
+
* 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).
|
|
4150
|
+
*/
|
|
4151
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema;
|
|
3778
4152
|
}
|
|
3779
4153
|
/**
|
|
3780
4154
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -3828,6 +4202,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3828
4202
|
*/
|
|
3829
4203
|
updateTime?: string | null;
|
|
3830
4204
|
}
|
|
4205
|
+
/**
|
|
4206
|
+
* The digital parsing configurations for documents.
|
|
4207
|
+
*/
|
|
4208
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig {
|
|
4209
|
+
}
|
|
3831
4210
|
/**
|
|
3832
4211
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3833
4212
|
*/
|
|
@@ -3846,6 +4225,38 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3846
4225
|
*/
|
|
3847
4226
|
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {
|
|
3848
4227
|
}
|
|
4228
|
+
/**
|
|
4229
|
+
* 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.
|
|
4230
|
+
*/
|
|
4231
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
|
|
4232
|
+
/**
|
|
4233
|
+
* 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.
|
|
4234
|
+
*/
|
|
4235
|
+
defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
4236
|
+
/**
|
|
4237
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
4238
|
+
*/
|
|
4239
|
+
name?: string | null;
|
|
4240
|
+
/**
|
|
4241
|
+
* 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.
|
|
4242
|
+
*/
|
|
4243
|
+
parsingConfigOverrides?: {
|
|
4244
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
4245
|
+
} | null;
|
|
4246
|
+
}
|
|
4247
|
+
/**
|
|
4248
|
+
* Related configurations applied to a specific type of document parser.
|
|
4249
|
+
*/
|
|
4250
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
|
|
4251
|
+
/**
|
|
4252
|
+
* Configurations applied to digital parser.
|
|
4253
|
+
*/
|
|
4254
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig;
|
|
4255
|
+
/**
|
|
4256
|
+
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
4257
|
+
*/
|
|
4258
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig;
|
|
4259
|
+
}
|
|
3849
4260
|
/**
|
|
3850
4261
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3851
4262
|
*/
|
|
@@ -4093,6 +4504,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4093
4504
|
*/
|
|
4094
4505
|
unjoinedEventsCount?: string | null;
|
|
4095
4506
|
}
|
|
4507
|
+
/**
|
|
4508
|
+
* The OCR parsing configurations for documents.
|
|
4509
|
+
*/
|
|
4510
|
+
export interface Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig {
|
|
4511
|
+
/**
|
|
4512
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
4513
|
+
*/
|
|
4514
|
+
enhancedDocumentElements?: string[] | null;
|
|
4515
|
+
/**
|
|
4516
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
4517
|
+
*/
|
|
4518
|
+
useNativeText?: boolean | null;
|
|
4519
|
+
}
|
|
4096
4520
|
/**
|
|
4097
4521
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4098
4522
|
*/
|
|
@@ -4105,6 +4529,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4105
4529
|
* Count of entries that encountered errors while processing.
|
|
4106
4530
|
*/
|
|
4107
4531
|
failureCount?: string | null;
|
|
4532
|
+
/**
|
|
4533
|
+
* Count of entries that were ignored as entries were not found.
|
|
4534
|
+
*/
|
|
4535
|
+
ignoredCount?: string | null;
|
|
4108
4536
|
/**
|
|
4109
4537
|
* Count of entries that were deleted successfully.
|
|
4110
4538
|
*/
|
|
@@ -4235,6 +4663,9 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4235
4663
|
*/
|
|
4236
4664
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure;
|
|
4237
4665
|
}
|
|
4666
|
+
/**
|
|
4667
|
+
* Failed due to insufficient quota.
|
|
4668
|
+
*/
|
|
4238
4669
|
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure {
|
|
4239
4670
|
/**
|
|
4240
4671
|
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
@@ -4476,6 +4907,34 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4476
4907
|
estimateDataSize(params: Params$Resource$Projects$Locations$Estimatedatasize, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4477
4908
|
estimateDataSize(params: Params$Resource$Projects$Locations$Estimatedatasize, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4478
4909
|
estimateDataSize(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4910
|
+
/**
|
|
4911
|
+
* Gets the AclConfig.
|
|
4912
|
+
*
|
|
4913
|
+
* @param params - Parameters for request
|
|
4914
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4915
|
+
* @param callback - Optional callback that handles the response.
|
|
4916
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4917
|
+
*/
|
|
4918
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4919
|
+
getAclConfig(params?: Params$Resource$Projects$Locations$Getaclconfig, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>;
|
|
4920
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4921
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>): void;
|
|
4922
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>): void;
|
|
4923
|
+
getAclConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>): void;
|
|
4924
|
+
/**
|
|
4925
|
+
* Default Acl Configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.
|
|
4926
|
+
*
|
|
4927
|
+
* @param params - Parameters for request
|
|
4928
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4929
|
+
* @param callback - Optional callback that handles the response.
|
|
4930
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4931
|
+
*/
|
|
4932
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4933
|
+
updateAclConfig(params?: Params$Resource$Projects$Locations$Updateaclconfig, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>;
|
|
4934
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4935
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>): void;
|
|
4936
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>): void;
|
|
4937
|
+
updateAclConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>): void;
|
|
4479
4938
|
}
|
|
4480
4939
|
export interface Params$Resource$Projects$Locations$Estimatedatasize extends StandardParameters {
|
|
4481
4940
|
/**
|
|
@@ -4487,6 +4946,22 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4487
4946
|
*/
|
|
4488
4947
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest;
|
|
4489
4948
|
}
|
|
4949
|
+
export interface Params$Resource$Projects$Locations$Getaclconfig extends StandardParameters {
|
|
4950
|
+
/**
|
|
4951
|
+
* Required. Resource name of AclConfig, such as `projects/x/locations/x/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
4952
|
+
*/
|
|
4953
|
+
name?: string;
|
|
4954
|
+
}
|
|
4955
|
+
export interface Params$Resource$Projects$Locations$Updateaclconfig extends StandardParameters {
|
|
4956
|
+
/**
|
|
4957
|
+
* 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.
|
|
4958
|
+
*/
|
|
4959
|
+
name?: string;
|
|
4960
|
+
/**
|
|
4961
|
+
* Request body metadata
|
|
4962
|
+
*/
|
|
4963
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAclConfig;
|
|
4964
|
+
}
|
|
4490
4965
|
export class Resource$Projects$Locations$Collections {
|
|
4491
4966
|
context: APIRequestContext;
|
|
4492
4967
|
dataConnector: Resource$Projects$Locations$Collections$Dataconnector;
|
|
@@ -4996,6 +5471,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4996
5471
|
* Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
4997
5472
|
*/
|
|
4998
5473
|
name?: string;
|
|
5474
|
+
/**
|
|
5475
|
+
* Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
|
|
5476
|
+
*/
|
|
5477
|
+
updateMask?: string;
|
|
4999
5478
|
/**
|
|
5000
5479
|
* Request body metadata
|
|
5001
5480
|
*/
|
|
@@ -5528,6 +6007,48 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5528
6007
|
export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs {
|
|
5529
6008
|
context: APIRequestContext;
|
|
5530
6009
|
constructor(context: APIRequestContext);
|
|
6010
|
+
/**
|
|
6011
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
6012
|
+
*
|
|
6013
|
+
* @param params - Parameters for request
|
|
6014
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6015
|
+
* @param callback - Optional callback that handles the response.
|
|
6016
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6017
|
+
*/
|
|
6018
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6019
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
6020
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6021
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
6022
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
6023
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
6024
|
+
/**
|
|
6025
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
6026
|
+
*
|
|
6027
|
+
* @param params - Parameters for request
|
|
6028
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6029
|
+
* @param callback - Optional callback that handles the response.
|
|
6030
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6031
|
+
*/
|
|
6032
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6033
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
|
|
6034
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6035
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
6036
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
6037
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
6038
|
+
/**
|
|
6039
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
6040
|
+
*
|
|
6041
|
+
* @param params - Parameters for request
|
|
6042
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6043
|
+
* @param callback - Optional callback that handles the response.
|
|
6044
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6045
|
+
*/
|
|
6046
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6047
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
6048
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6049
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
6050
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
6051
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
5531
6052
|
/**
|
|
5532
6053
|
* Makes a recommendation, which requires a contextual user event.
|
|
5533
6054
|
*
|
|
@@ -5557,6 +6078,40 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5557
6078
|
search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
5558
6079
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
5559
6080
|
}
|
|
6081
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
6082
|
+
/**
|
|
6083
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
6084
|
+
*/
|
|
6085
|
+
name?: string;
|
|
6086
|
+
}
|
|
6087
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List extends StandardParameters {
|
|
6088
|
+
/**
|
|
6089
|
+
* 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.
|
|
6090
|
+
*/
|
|
6091
|
+
pageSize?: number;
|
|
6092
|
+
/**
|
|
6093
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
6094
|
+
*/
|
|
6095
|
+
pageToken?: string;
|
|
6096
|
+
/**
|
|
6097
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
6098
|
+
*/
|
|
6099
|
+
parent?: string;
|
|
6100
|
+
}
|
|
6101
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
6102
|
+
/**
|
|
6103
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
6104
|
+
*/
|
|
6105
|
+
name?: string;
|
|
6106
|
+
/**
|
|
6107
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
6108
|
+
*/
|
|
6109
|
+
updateMask?: string;
|
|
6110
|
+
/**
|
|
6111
|
+
* Request body metadata
|
|
6112
|
+
*/
|
|
6113
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
|
|
6114
|
+
}
|
|
5560
6115
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
5561
6116
|
/**
|
|
5562
6117
|
* 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.
|
|
@@ -6546,6 +7101,48 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6546
7101
|
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
6547
7102
|
context: APIRequestContext;
|
|
6548
7103
|
constructor(context: APIRequestContext);
|
|
7104
|
+
/**
|
|
7105
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
7106
|
+
*
|
|
7107
|
+
* @param params - Parameters for request
|
|
7108
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7109
|
+
* @param callback - Optional callback that handles the response.
|
|
7110
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7111
|
+
*/
|
|
7112
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7113
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
7114
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7115
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
7116
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
7117
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
7118
|
+
/**
|
|
7119
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
7120
|
+
*
|
|
7121
|
+
* @param params - Parameters for request
|
|
7122
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7123
|
+
* @param callback - Optional callback that handles the response.
|
|
7124
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7125
|
+
*/
|
|
7126
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7127
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
|
|
7128
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7129
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
7130
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
7131
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
7132
|
+
/**
|
|
7133
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
7134
|
+
*
|
|
7135
|
+
* @param params - Parameters for request
|
|
7136
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7137
|
+
* @param callback - Optional callback that handles the response.
|
|
7138
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7139
|
+
*/
|
|
7140
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7141
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
7142
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7143
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
7144
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
7145
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
6549
7146
|
/**
|
|
6550
7147
|
* Makes a recommendation, which requires a contextual user event.
|
|
6551
7148
|
*
|
|
@@ -6575,6 +7172,40 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6575
7172
|
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
6576
7173
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
6577
7174
|
}
|
|
7175
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
|
|
7176
|
+
/**
|
|
7177
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
7178
|
+
*/
|
|
7179
|
+
name?: string;
|
|
7180
|
+
}
|
|
7181
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List extends StandardParameters {
|
|
7182
|
+
/**
|
|
7183
|
+
* 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.
|
|
7184
|
+
*/
|
|
7185
|
+
pageSize?: number;
|
|
7186
|
+
/**
|
|
7187
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
7188
|
+
*/
|
|
7189
|
+
pageToken?: string;
|
|
7190
|
+
/**
|
|
7191
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
7192
|
+
*/
|
|
7193
|
+
parent?: string;
|
|
7194
|
+
}
|
|
7195
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters {
|
|
7196
|
+
/**
|
|
7197
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
7198
|
+
*/
|
|
7199
|
+
name?: string;
|
|
7200
|
+
/**
|
|
7201
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
7202
|
+
*/
|
|
7203
|
+
updateMask?: string;
|
|
7204
|
+
/**
|
|
7205
|
+
* Request body metadata
|
|
7206
|
+
*/
|
|
7207
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
|
|
7208
|
+
}
|
|
6578
7209
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
|
|
6579
7210
|
/**
|
|
6580
7211
|
* 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.
|
|
@@ -7067,6 +7698,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7067
7698
|
* Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
7068
7699
|
*/
|
|
7069
7700
|
name?: string;
|
|
7701
|
+
/**
|
|
7702
|
+
* Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
|
|
7703
|
+
*/
|
|
7704
|
+
updateMask?: string;
|
|
7070
7705
|
/**
|
|
7071
7706
|
* Request body metadata
|
|
7072
7707
|
*/
|
|
@@ -7542,6 +8177,48 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7542
8177
|
export class Resource$Projects$Locations$Datastores$Servingconfigs {
|
|
7543
8178
|
context: APIRequestContext;
|
|
7544
8179
|
constructor(context: APIRequestContext);
|
|
8180
|
+
/**
|
|
8181
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
8182
|
+
*
|
|
8183
|
+
* @param params - Parameters for request
|
|
8184
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8185
|
+
* @param callback - Optional callback that handles the response.
|
|
8186
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
8187
|
+
*/
|
|
8188
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8189
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
8190
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8191
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
8192
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
8193
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
8194
|
+
/**
|
|
8195
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
8196
|
+
*
|
|
8197
|
+
* @param params - Parameters for request
|
|
8198
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8199
|
+
* @param callback - Optional callback that handles the response.
|
|
8200
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
8201
|
+
*/
|
|
8202
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8203
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
|
|
8204
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8205
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
8206
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
8207
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
8208
|
+
/**
|
|
8209
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
8210
|
+
*
|
|
8211
|
+
* @param params - Parameters for request
|
|
8212
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8213
|
+
* @param callback - Optional callback that handles the response.
|
|
8214
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
8215
|
+
*/
|
|
8216
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8217
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
8218
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8219
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
8220
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
8221
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
7545
8222
|
/**
|
|
7546
8223
|
* Makes a recommendation, which requires a contextual user event.
|
|
7547
8224
|
*
|
|
@@ -7571,6 +8248,40 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7571
8248
|
search(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
7572
8249
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
7573
8250
|
}
|
|
8251
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
8252
|
+
/**
|
|
8253
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
8254
|
+
*/
|
|
8255
|
+
name?: string;
|
|
8256
|
+
}
|
|
8257
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List extends StandardParameters {
|
|
8258
|
+
/**
|
|
8259
|
+
* 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.
|
|
8260
|
+
*/
|
|
8261
|
+
pageSize?: number;
|
|
8262
|
+
/**
|
|
8263
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
8264
|
+
*/
|
|
8265
|
+
pageToken?: string;
|
|
8266
|
+
/**
|
|
8267
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
8268
|
+
*/
|
|
8269
|
+
parent?: string;
|
|
8270
|
+
}
|
|
8271
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
8272
|
+
/**
|
|
8273
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
8274
|
+
*/
|
|
8275
|
+
name?: string;
|
|
8276
|
+
/**
|
|
8277
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
8278
|
+
*/
|
|
8279
|
+
updateMask?: string;
|
|
8280
|
+
/**
|
|
8281
|
+
* Request body metadata
|
|
8282
|
+
*/
|
|
8283
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
|
|
8284
|
+
}
|
|
7574
8285
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
7575
8286
|
/**
|
|
7576
8287
|
* 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.
|