@googleapis/discoveryengine 6.1.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 +13 -0
- package/build/v1alpha.d.ts +318 -3
- package/build/v1alpha.js +62 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +209 -3
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1alpha.ts +483 -3
- package/v1beta.ts +211 -3
package/v1alpha.ts
CHANGED
|
@@ -241,6 +241,19 @@ export namespace discoveryengine_v1alpha {
|
|
|
241
241
|
*/
|
|
242
242
|
functionName?: string | null;
|
|
243
243
|
}
|
|
244
|
+
/**
|
|
245
|
+
* Access Control Configuration.
|
|
246
|
+
*/
|
|
247
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAclConfig {
|
|
248
|
+
/**
|
|
249
|
+
* Identity provider config.
|
|
250
|
+
*/
|
|
251
|
+
idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
252
|
+
/**
|
|
253
|
+
* 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.
|
|
254
|
+
*/
|
|
255
|
+
name?: string | null;
|
|
256
|
+
}
|
|
244
257
|
/**
|
|
245
258
|
* AdditionalParams message for WidgetService methods for security and privacy enhancement.
|
|
246
259
|
*/
|
|
@@ -441,6 +454,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
441
454
|
* Request message for ConversationalSearchService.ConverseConversation method.
|
|
442
455
|
*/
|
|
443
456
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest {
|
|
457
|
+
/**
|
|
458
|
+
* 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)
|
|
459
|
+
*/
|
|
460
|
+
boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
444
461
|
/**
|
|
445
462
|
* 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.
|
|
446
463
|
*/
|
|
@@ -586,6 +603,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
586
603
|
* DataStore captures global settings and configs at the DataStore level.
|
|
587
604
|
*/
|
|
588
605
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDataStore {
|
|
606
|
+
/**
|
|
607
|
+
* 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.
|
|
608
|
+
*/
|
|
609
|
+
aclEnabled?: boolean | null;
|
|
589
610
|
/**
|
|
590
611
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
591
612
|
*/
|
|
@@ -602,6 +623,14 @@ export namespace discoveryengine_v1alpha {
|
|
|
602
623
|
* 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.
|
|
603
624
|
*/
|
|
604
625
|
displayName?: string | null;
|
|
626
|
+
/**
|
|
627
|
+
* Configuration for Document understanding and enrichment.
|
|
628
|
+
*/
|
|
629
|
+
documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
|
|
630
|
+
/**
|
|
631
|
+
* Output only. Data store level identity provider config.
|
|
632
|
+
*/
|
|
633
|
+
idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
605
634
|
/**
|
|
606
635
|
* Immutable. The industry vertical that the data store registers.
|
|
607
636
|
*/
|
|
@@ -614,6 +643,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
614
643
|
* 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.
|
|
615
644
|
*/
|
|
616
645
|
solutionTypes?: string[] | null;
|
|
646
|
+
/**
|
|
647
|
+
* 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).
|
|
648
|
+
*/
|
|
649
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1alphaSchema;
|
|
617
650
|
}
|
|
618
651
|
/**
|
|
619
652
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -696,6 +729,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
696
729
|
* Document captures all raw metadata information of items to be recommended or searched.
|
|
697
730
|
*/
|
|
698
731
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocument {
|
|
732
|
+
/**
|
|
733
|
+
* Access control information for the document.
|
|
734
|
+
*/
|
|
735
|
+
aclInfo?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfo;
|
|
699
736
|
/**
|
|
700
737
|
* The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
|
|
701
738
|
*/
|
|
@@ -708,6 +745,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
708
745
|
* 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.
|
|
709
746
|
*/
|
|
710
747
|
id?: string | null;
|
|
748
|
+
/**
|
|
749
|
+
* 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.
|
|
750
|
+
*/
|
|
751
|
+
indexTime?: string | null;
|
|
711
752
|
/**
|
|
712
753
|
* The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
|
|
713
754
|
*/
|
|
@@ -729,6 +770,21 @@ export namespace discoveryengine_v1alpha {
|
|
|
729
770
|
*/
|
|
730
771
|
structData?: {[key: string]: any} | null;
|
|
731
772
|
}
|
|
773
|
+
/**
|
|
774
|
+
* ACL Information of the Document.
|
|
775
|
+
*/
|
|
776
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfo {
|
|
777
|
+
readers?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction[];
|
|
778
|
+
}
|
|
779
|
+
/**
|
|
780
|
+
* 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" \} ], \} ] \} \}
|
|
781
|
+
*/
|
|
782
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction {
|
|
783
|
+
/**
|
|
784
|
+
* List of principals.
|
|
785
|
+
*/
|
|
786
|
+
principals?: Schema$GoogleCloudDiscoveryengineV1alphaPrincipal[];
|
|
787
|
+
}
|
|
732
788
|
/**
|
|
733
789
|
* Unstructured data linked to this document.
|
|
734
790
|
*/
|
|
@@ -788,7 +844,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
788
844
|
*/
|
|
789
845
|
ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
790
846
|
/**
|
|
791
|
-
* 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.
|
|
847
|
+
* 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.
|
|
792
848
|
*/
|
|
793
849
|
parsingConfigOverrides?: {
|
|
794
850
|
[
|
|
@@ -856,6 +912,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
856
912
|
* Metadata that describes the training and serving parameters of an Engine.
|
|
857
913
|
*/
|
|
858
914
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine {
|
|
915
|
+
/**
|
|
916
|
+
* 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.
|
|
917
|
+
*/
|
|
918
|
+
allowMultipleDataStoresSearchEngine?: boolean | null;
|
|
859
919
|
/**
|
|
860
920
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
861
921
|
*/
|
|
@@ -1199,6 +1259,28 @@ export namespace discoveryengine_v1alpha {
|
|
|
1199
1259
|
*/
|
|
1200
1260
|
maxRelatedQuestions?: number | null;
|
|
1201
1261
|
}
|
|
1262
|
+
/**
|
|
1263
|
+
* Identity Provider Config.
|
|
1264
|
+
*/
|
|
1265
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig {
|
|
1266
|
+
/**
|
|
1267
|
+
* External Identity provider config.
|
|
1268
|
+
*/
|
|
1269
|
+
externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig;
|
|
1270
|
+
/**
|
|
1271
|
+
* Identity provider type configured.
|
|
1272
|
+
*/
|
|
1273
|
+
idpType?: string | null;
|
|
1274
|
+
}
|
|
1275
|
+
/**
|
|
1276
|
+
* Third party IDP Config.
|
|
1277
|
+
*/
|
|
1278
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig {
|
|
1279
|
+
/**
|
|
1280
|
+
* Workforce pool name. Example: "locations/global/workforcePools/pool_id"
|
|
1281
|
+
*/
|
|
1282
|
+
workforcePoolName?: string | null;
|
|
1283
|
+
}
|
|
1202
1284
|
/**
|
|
1203
1285
|
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1204
1286
|
*/
|
|
@@ -1635,6 +1717,19 @@ export namespace discoveryengine_v1alpha {
|
|
|
1635
1717
|
* Request for pausing training of an engine.
|
|
1636
1718
|
*/
|
|
1637
1719
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaPauseEngineRequest {}
|
|
1720
|
+
/**
|
|
1721
|
+
* Principal identifier of a user or a group.
|
|
1722
|
+
*/
|
|
1723
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPrincipal {
|
|
1724
|
+
/**
|
|
1725
|
+
* 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.
|
|
1726
|
+
*/
|
|
1727
|
+
groupId?: string | null;
|
|
1728
|
+
/**
|
|
1729
|
+
* 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.
|
|
1730
|
+
*/
|
|
1731
|
+
userId?: string | null;
|
|
1732
|
+
}
|
|
1638
1733
|
/**
|
|
1639
1734
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1640
1735
|
*/
|
|
@@ -1647,6 +1742,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
1647
1742
|
* Count of entries that encountered errors while processing.
|
|
1648
1743
|
*/
|
|
1649
1744
|
failureCount?: string | null;
|
|
1745
|
+
/**
|
|
1746
|
+
* Count of entries that were ignored as entries were not found.
|
|
1747
|
+
*/
|
|
1748
|
+
ignoredCount?: string | null;
|
|
1650
1749
|
/**
|
|
1651
1750
|
* Count of entries that were deleted successfully.
|
|
1652
1751
|
*/
|
|
@@ -1660,6 +1759,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
1660
1759
|
* Request message for DocumentService.PurgeDocuments method.
|
|
1661
1760
|
*/
|
|
1662
1761
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest {
|
|
1762
|
+
/**
|
|
1763
|
+
* The desired location of errors incurred during the purge.
|
|
1764
|
+
*/
|
|
1765
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig;
|
|
1663
1766
|
/**
|
|
1664
1767
|
* Required. Filter matching documents to purge. Only currently supported value is `*` (all items).
|
|
1665
1768
|
*/
|
|
@@ -1668,6 +1771,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
1668
1771
|
* Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.
|
|
1669
1772
|
*/
|
|
1670
1773
|
force?: boolean | null;
|
|
1774
|
+
/**
|
|
1775
|
+
* Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line.
|
|
1776
|
+
*/
|
|
1777
|
+
gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource;
|
|
1671
1778
|
}
|
|
1672
1779
|
/**
|
|
1673
1780
|
* 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.
|
|
@@ -1682,6 +1789,15 @@ export namespace discoveryengine_v1alpha {
|
|
|
1682
1789
|
*/
|
|
1683
1790
|
purgeSample?: string[] | null;
|
|
1684
1791
|
}
|
|
1792
|
+
/**
|
|
1793
|
+
* Configuration of destination for Purge related errors.
|
|
1794
|
+
*/
|
|
1795
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig {
|
|
1796
|
+
/**
|
|
1797
|
+
* 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.
|
|
1798
|
+
*/
|
|
1799
|
+
gcsPrefix?: string | null;
|
|
1800
|
+
}
|
|
1685
1801
|
/**
|
|
1686
1802
|
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1687
1803
|
*/
|
|
@@ -2003,6 +2119,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
2003
2119
|
* A specification for configuring the behavior of content search.
|
|
2004
2120
|
*/
|
|
2005
2121
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
2122
|
+
/**
|
|
2123
|
+
* Custom fine tuning configs.
|
|
2124
|
+
*/
|
|
2125
|
+
customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
2006
2126
|
/**
|
|
2007
2127
|
* 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.
|
|
2008
2128
|
*/
|
|
@@ -2094,7 +2214,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
2094
2214
|
*/
|
|
2095
2215
|
boost?: number | null;
|
|
2096
2216
|
/**
|
|
2097
|
-
* 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": * (
|
|
2217
|
+
* 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"))
|
|
2098
2218
|
*/
|
|
2099
2219
|
condition?: string | null;
|
|
2100
2220
|
}
|
|
@@ -2200,7 +2320,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
2200
2320
|
*/
|
|
2201
2321
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
2202
2322
|
/**
|
|
2203
|
-
* The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model.
|
|
2323
|
+
* The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English.
|
|
2204
2324
|
*/
|
|
2205
2325
|
version?: string | null;
|
|
2206
2326
|
}
|
|
@@ -2482,6 +2602,9 @@ export namespace discoveryengine_v1alpha {
|
|
|
2482
2602
|
* The summary content.
|
|
2483
2603
|
*/
|
|
2484
2604
|
summaryText?: string | null;
|
|
2605
|
+
/**
|
|
2606
|
+
* Summary with metadata information.
|
|
2607
|
+
*/
|
|
2485
2608
|
summaryWithMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata;
|
|
2486
2609
|
}
|
|
2487
2610
|
/**
|
|
@@ -2630,6 +2753,9 @@ export namespace discoveryengine_v1alpha {
|
|
|
2630
2753
|
* 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.
|
|
2631
2754
|
*/
|
|
2632
2755
|
onewaySynonymsControlIds?: string[] | null;
|
|
2756
|
+
/**
|
|
2757
|
+
* 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).
|
|
2758
|
+
*/
|
|
2633
2759
|
rankingExpression?: string | null;
|
|
2634
2760
|
/**
|
|
2635
2761
|
* 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.
|
|
@@ -2771,6 +2897,9 @@ export namespace discoveryengine_v1alpha {
|
|
|
2771
2897
|
*/
|
|
2772
2898
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
2773
2899
|
}
|
|
2900
|
+
/**
|
|
2901
|
+
* Failed due to insufficient quota.
|
|
2902
|
+
*/
|
|
2774
2903
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
2775
2904
|
/**
|
|
2776
2905
|
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
@@ -3121,6 +3250,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
3121
3250
|
* Turn on or off summarization for the search response.
|
|
3122
3251
|
*/
|
|
3123
3252
|
enableSummarization?: boolean | null;
|
|
3253
|
+
/**
|
|
3254
|
+
* Whether to enable standalone web app.
|
|
3255
|
+
*/
|
|
3256
|
+
enableWebApp?: boolean | null;
|
|
3124
3257
|
/**
|
|
3125
3258
|
* The configuration and appearance of facets in the end user view.
|
|
3126
3259
|
*/
|
|
@@ -3376,6 +3509,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
3376
3509
|
* 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.
|
|
3377
3510
|
*/
|
|
3378
3511
|
displayName?: string | null;
|
|
3512
|
+
/**
|
|
3513
|
+
* Configuration for Document understanding and enrichment.
|
|
3514
|
+
*/
|
|
3515
|
+
documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig;
|
|
3379
3516
|
/**
|
|
3380
3517
|
* Immutable. The industry vertical that the data store registers.
|
|
3381
3518
|
*/
|
|
@@ -3388,6 +3525,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
3388
3525
|
* 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.
|
|
3389
3526
|
*/
|
|
3390
3527
|
solutionTypes?: string[] | null;
|
|
3528
|
+
/**
|
|
3529
|
+
* 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).
|
|
3530
|
+
*/
|
|
3531
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema;
|
|
3391
3532
|
}
|
|
3392
3533
|
/**
|
|
3393
3534
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -3441,6 +3582,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
3441
3582
|
*/
|
|
3442
3583
|
updateTime?: string | null;
|
|
3443
3584
|
}
|
|
3585
|
+
/**
|
|
3586
|
+
* The digital parsing configurations for documents.
|
|
3587
|
+
*/
|
|
3588
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {}
|
|
3444
3589
|
/**
|
|
3445
3590
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3446
3591
|
*/
|
|
@@ -3458,6 +3603,40 @@ export namespace discoveryengine_v1alpha {
|
|
|
3458
3603
|
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
3459
3604
|
*/
|
|
3460
3605
|
export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {}
|
|
3606
|
+
/**
|
|
3607
|
+
* 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.
|
|
3608
|
+
*/
|
|
3609
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
|
|
3610
|
+
/**
|
|
3611
|
+
* 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.
|
|
3612
|
+
*/
|
|
3613
|
+
defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
3614
|
+
/**
|
|
3615
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
3616
|
+
*/
|
|
3617
|
+
name?: string | null;
|
|
3618
|
+
/**
|
|
3619
|
+
* 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.
|
|
3620
|
+
*/
|
|
3621
|
+
parsingConfigOverrides?: {
|
|
3622
|
+
[
|
|
3623
|
+
key: string
|
|
3624
|
+
]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
3625
|
+
} | null;
|
|
3626
|
+
}
|
|
3627
|
+
/**
|
|
3628
|
+
* Related configurations applied to a specific type of document parser.
|
|
3629
|
+
*/
|
|
3630
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
|
|
3631
|
+
/**
|
|
3632
|
+
* Configurations applied to digital parser.
|
|
3633
|
+
*/
|
|
3634
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig;
|
|
3635
|
+
/**
|
|
3636
|
+
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
3637
|
+
*/
|
|
3638
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig;
|
|
3639
|
+
}
|
|
3461
3640
|
/**
|
|
3462
3641
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3463
3642
|
*/
|
|
@@ -3704,6 +3883,19 @@ export namespace discoveryengine_v1alpha {
|
|
|
3704
3883
|
*/
|
|
3705
3884
|
unjoinedEventsCount?: string | null;
|
|
3706
3885
|
}
|
|
3886
|
+
/**
|
|
3887
|
+
* The OCR parsing configurations for documents.
|
|
3888
|
+
*/
|
|
3889
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig {
|
|
3890
|
+
/**
|
|
3891
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
3892
|
+
*/
|
|
3893
|
+
enhancedDocumentElements?: string[] | null;
|
|
3894
|
+
/**
|
|
3895
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
3896
|
+
*/
|
|
3897
|
+
useNativeText?: boolean | null;
|
|
3898
|
+
}
|
|
3707
3899
|
/**
|
|
3708
3900
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3709
3901
|
*/
|
|
@@ -3716,6 +3908,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
3716
3908
|
* Count of entries that encountered errors while processing.
|
|
3717
3909
|
*/
|
|
3718
3910
|
failureCount?: string | null;
|
|
3911
|
+
/**
|
|
3912
|
+
* Count of entries that were ignored as entries were not found.
|
|
3913
|
+
*/
|
|
3914
|
+
ignoredCount?: string | null;
|
|
3719
3915
|
/**
|
|
3720
3916
|
* Count of entries that were deleted successfully.
|
|
3721
3917
|
*/
|
|
@@ -3844,6 +4040,9 @@ export namespace discoveryengine_v1alpha {
|
|
|
3844
4040
|
*/
|
|
3845
4041
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure;
|
|
3846
4042
|
}
|
|
4043
|
+
/**
|
|
4044
|
+
* Failed due to insufficient quota.
|
|
4045
|
+
*/
|
|
3847
4046
|
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure {
|
|
3848
4047
|
/**
|
|
3849
4048
|
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
@@ -3948,6 +4147,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
3948
4147
|
* 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.
|
|
3949
4148
|
*/
|
|
3950
4149
|
displayName?: string | null;
|
|
4150
|
+
/**
|
|
4151
|
+
* Configuration for Document understanding and enrichment.
|
|
4152
|
+
*/
|
|
4153
|
+
documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig;
|
|
3951
4154
|
/**
|
|
3952
4155
|
* Immutable. The industry vertical that the data store registers.
|
|
3953
4156
|
*/
|
|
@@ -3960,6 +4163,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
3960
4163
|
* 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.
|
|
3961
4164
|
*/
|
|
3962
4165
|
solutionTypes?: string[] | null;
|
|
4166
|
+
/**
|
|
4167
|
+
* 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).
|
|
4168
|
+
*/
|
|
4169
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema;
|
|
3963
4170
|
}
|
|
3964
4171
|
/**
|
|
3965
4172
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -4013,6 +4220,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
4013
4220
|
*/
|
|
4014
4221
|
updateTime?: string | null;
|
|
4015
4222
|
}
|
|
4223
|
+
/**
|
|
4224
|
+
* The digital parsing configurations for documents.
|
|
4225
|
+
*/
|
|
4226
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig {}
|
|
4016
4227
|
/**
|
|
4017
4228
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4018
4229
|
*/
|
|
@@ -4030,6 +4241,40 @@ export namespace discoveryengine_v1alpha {
|
|
|
4030
4241
|
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
4031
4242
|
*/
|
|
4032
4243
|
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {}
|
|
4244
|
+
/**
|
|
4245
|
+
* 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.
|
|
4246
|
+
*/
|
|
4247
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
|
|
4248
|
+
/**
|
|
4249
|
+
* 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.
|
|
4250
|
+
*/
|
|
4251
|
+
defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
4252
|
+
/**
|
|
4253
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
4254
|
+
*/
|
|
4255
|
+
name?: string | null;
|
|
4256
|
+
/**
|
|
4257
|
+
* 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.
|
|
4258
|
+
*/
|
|
4259
|
+
parsingConfigOverrides?: {
|
|
4260
|
+
[
|
|
4261
|
+
key: string
|
|
4262
|
+
]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
4263
|
+
} | null;
|
|
4264
|
+
}
|
|
4265
|
+
/**
|
|
4266
|
+
* Related configurations applied to a specific type of document parser.
|
|
4267
|
+
*/
|
|
4268
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
|
|
4269
|
+
/**
|
|
4270
|
+
* Configurations applied to digital parser.
|
|
4271
|
+
*/
|
|
4272
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig;
|
|
4273
|
+
/**
|
|
4274
|
+
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
4275
|
+
*/
|
|
4276
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig;
|
|
4277
|
+
}
|
|
4033
4278
|
/**
|
|
4034
4279
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4035
4280
|
*/
|
|
@@ -4276,6 +4521,19 @@ export namespace discoveryengine_v1alpha {
|
|
|
4276
4521
|
*/
|
|
4277
4522
|
unjoinedEventsCount?: string | null;
|
|
4278
4523
|
}
|
|
4524
|
+
/**
|
|
4525
|
+
* The OCR parsing configurations for documents.
|
|
4526
|
+
*/
|
|
4527
|
+
export interface Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig {
|
|
4528
|
+
/**
|
|
4529
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
4530
|
+
*/
|
|
4531
|
+
enhancedDocumentElements?: string[] | null;
|
|
4532
|
+
/**
|
|
4533
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
4534
|
+
*/
|
|
4535
|
+
useNativeText?: boolean | null;
|
|
4536
|
+
}
|
|
4279
4537
|
/**
|
|
4280
4538
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4281
4539
|
*/
|
|
@@ -4288,6 +4546,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
4288
4546
|
* Count of entries that encountered errors while processing.
|
|
4289
4547
|
*/
|
|
4290
4548
|
failureCount?: string | null;
|
|
4549
|
+
/**
|
|
4550
|
+
* Count of entries that were ignored as entries were not found.
|
|
4551
|
+
*/
|
|
4552
|
+
ignoredCount?: string | null;
|
|
4291
4553
|
/**
|
|
4292
4554
|
* Count of entries that were deleted successfully.
|
|
4293
4555
|
*/
|
|
@@ -4416,6 +4678,9 @@ export namespace discoveryengine_v1alpha {
|
|
|
4416
4678
|
*/
|
|
4417
4679
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure;
|
|
4418
4680
|
}
|
|
4681
|
+
/**
|
|
4682
|
+
* Failed due to insufficient quota.
|
|
4683
|
+
*/
|
|
4419
4684
|
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure {
|
|
4420
4685
|
/**
|
|
4421
4686
|
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
@@ -5091,6 +5356,194 @@ export namespace discoveryengine_v1alpha {
|
|
|
5091
5356
|
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
5092
5357
|
}
|
|
5093
5358
|
}
|
|
5359
|
+
|
|
5360
|
+
/**
|
|
5361
|
+
* Gets the AclConfig.
|
|
5362
|
+
*
|
|
5363
|
+
* @param params - Parameters for request
|
|
5364
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5365
|
+
* @param callback - Optional callback that handles the response.
|
|
5366
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5367
|
+
*/
|
|
5368
|
+
getAclConfig(
|
|
5369
|
+
params: Params$Resource$Projects$Locations$Getaclconfig,
|
|
5370
|
+
options: StreamMethodOptions
|
|
5371
|
+
): GaxiosPromise<Readable>;
|
|
5372
|
+
getAclConfig(
|
|
5373
|
+
params?: Params$Resource$Projects$Locations$Getaclconfig,
|
|
5374
|
+
options?: MethodOptions
|
|
5375
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>;
|
|
5376
|
+
getAclConfig(
|
|
5377
|
+
params: Params$Resource$Projects$Locations$Getaclconfig,
|
|
5378
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5379
|
+
callback: BodyResponseCallback<Readable>
|
|
5380
|
+
): void;
|
|
5381
|
+
getAclConfig(
|
|
5382
|
+
params: Params$Resource$Projects$Locations$Getaclconfig,
|
|
5383
|
+
options:
|
|
5384
|
+
| MethodOptions
|
|
5385
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>,
|
|
5386
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5387
|
+
): void;
|
|
5388
|
+
getAclConfig(
|
|
5389
|
+
params: Params$Resource$Projects$Locations$Getaclconfig,
|
|
5390
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5391
|
+
): void;
|
|
5392
|
+
getAclConfig(
|
|
5393
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5394
|
+
): void;
|
|
5395
|
+
getAclConfig(
|
|
5396
|
+
paramsOrCallback?:
|
|
5397
|
+
| Params$Resource$Projects$Locations$Getaclconfig
|
|
5398
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5399
|
+
| BodyResponseCallback<Readable>,
|
|
5400
|
+
optionsOrCallback?:
|
|
5401
|
+
| MethodOptions
|
|
5402
|
+
| StreamMethodOptions
|
|
5403
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5404
|
+
| BodyResponseCallback<Readable>,
|
|
5405
|
+
callback?:
|
|
5406
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5407
|
+
| BodyResponseCallback<Readable>
|
|
5408
|
+
):
|
|
5409
|
+
| void
|
|
5410
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5411
|
+
| GaxiosPromise<Readable> {
|
|
5412
|
+
let params = (paramsOrCallback ||
|
|
5413
|
+
{}) as Params$Resource$Projects$Locations$Getaclconfig;
|
|
5414
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5415
|
+
|
|
5416
|
+
if (typeof paramsOrCallback === 'function') {
|
|
5417
|
+
callback = paramsOrCallback;
|
|
5418
|
+
params = {} as Params$Resource$Projects$Locations$Getaclconfig;
|
|
5419
|
+
options = {};
|
|
5420
|
+
}
|
|
5421
|
+
|
|
5422
|
+
if (typeof optionsOrCallback === 'function') {
|
|
5423
|
+
callback = optionsOrCallback;
|
|
5424
|
+
options = {};
|
|
5425
|
+
}
|
|
5426
|
+
|
|
5427
|
+
const rootUrl =
|
|
5428
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
5429
|
+
const parameters = {
|
|
5430
|
+
options: Object.assign(
|
|
5431
|
+
{
|
|
5432
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
5433
|
+
method: 'GET',
|
|
5434
|
+
},
|
|
5435
|
+
options
|
|
5436
|
+
),
|
|
5437
|
+
params,
|
|
5438
|
+
requiredParams: ['name'],
|
|
5439
|
+
pathParams: ['name'],
|
|
5440
|
+
context: this.context,
|
|
5441
|
+
};
|
|
5442
|
+
if (callback) {
|
|
5443
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>(
|
|
5444
|
+
parameters,
|
|
5445
|
+
callback as BodyResponseCallback<unknown>
|
|
5446
|
+
);
|
|
5447
|
+
} else {
|
|
5448
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>(
|
|
5449
|
+
parameters
|
|
5450
|
+
);
|
|
5451
|
+
}
|
|
5452
|
+
}
|
|
5453
|
+
|
|
5454
|
+
/**
|
|
5455
|
+
* 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.
|
|
5456
|
+
*
|
|
5457
|
+
* @param params - Parameters for request
|
|
5458
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5459
|
+
* @param callback - Optional callback that handles the response.
|
|
5460
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5461
|
+
*/
|
|
5462
|
+
updateAclConfig(
|
|
5463
|
+
params: Params$Resource$Projects$Locations$Updateaclconfig,
|
|
5464
|
+
options: StreamMethodOptions
|
|
5465
|
+
): GaxiosPromise<Readable>;
|
|
5466
|
+
updateAclConfig(
|
|
5467
|
+
params?: Params$Resource$Projects$Locations$Updateaclconfig,
|
|
5468
|
+
options?: MethodOptions
|
|
5469
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>;
|
|
5470
|
+
updateAclConfig(
|
|
5471
|
+
params: Params$Resource$Projects$Locations$Updateaclconfig,
|
|
5472
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5473
|
+
callback: BodyResponseCallback<Readable>
|
|
5474
|
+
): void;
|
|
5475
|
+
updateAclConfig(
|
|
5476
|
+
params: Params$Resource$Projects$Locations$Updateaclconfig,
|
|
5477
|
+
options:
|
|
5478
|
+
| MethodOptions
|
|
5479
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>,
|
|
5480
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5481
|
+
): void;
|
|
5482
|
+
updateAclConfig(
|
|
5483
|
+
params: Params$Resource$Projects$Locations$Updateaclconfig,
|
|
5484
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5485
|
+
): void;
|
|
5486
|
+
updateAclConfig(
|
|
5487
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5488
|
+
): void;
|
|
5489
|
+
updateAclConfig(
|
|
5490
|
+
paramsOrCallback?:
|
|
5491
|
+
| Params$Resource$Projects$Locations$Updateaclconfig
|
|
5492
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5493
|
+
| BodyResponseCallback<Readable>,
|
|
5494
|
+
optionsOrCallback?:
|
|
5495
|
+
| MethodOptions
|
|
5496
|
+
| StreamMethodOptions
|
|
5497
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5498
|
+
| BodyResponseCallback<Readable>,
|
|
5499
|
+
callback?:
|
|
5500
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5501
|
+
| BodyResponseCallback<Readable>
|
|
5502
|
+
):
|
|
5503
|
+
| void
|
|
5504
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5505
|
+
| GaxiosPromise<Readable> {
|
|
5506
|
+
let params = (paramsOrCallback ||
|
|
5507
|
+
{}) as Params$Resource$Projects$Locations$Updateaclconfig;
|
|
5508
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5509
|
+
|
|
5510
|
+
if (typeof paramsOrCallback === 'function') {
|
|
5511
|
+
callback = paramsOrCallback;
|
|
5512
|
+
params = {} as Params$Resource$Projects$Locations$Updateaclconfig;
|
|
5513
|
+
options = {};
|
|
5514
|
+
}
|
|
5515
|
+
|
|
5516
|
+
if (typeof optionsOrCallback === 'function') {
|
|
5517
|
+
callback = optionsOrCallback;
|
|
5518
|
+
options = {};
|
|
5519
|
+
}
|
|
5520
|
+
|
|
5521
|
+
const rootUrl =
|
|
5522
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
5523
|
+
const parameters = {
|
|
5524
|
+
options: Object.assign(
|
|
5525
|
+
{
|
|
5526
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
5527
|
+
method: 'PATCH',
|
|
5528
|
+
},
|
|
5529
|
+
options
|
|
5530
|
+
),
|
|
5531
|
+
params,
|
|
5532
|
+
requiredParams: ['name'],
|
|
5533
|
+
pathParams: ['name'],
|
|
5534
|
+
context: this.context,
|
|
5535
|
+
};
|
|
5536
|
+
if (callback) {
|
|
5537
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>(
|
|
5538
|
+
parameters,
|
|
5539
|
+
callback as BodyResponseCallback<unknown>
|
|
5540
|
+
);
|
|
5541
|
+
} else {
|
|
5542
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>(
|
|
5543
|
+
parameters
|
|
5544
|
+
);
|
|
5545
|
+
}
|
|
5546
|
+
}
|
|
5094
5547
|
}
|
|
5095
5548
|
|
|
5096
5549
|
export interface Params$Resource$Projects$Locations$Estimatedatasize
|
|
@@ -5105,6 +5558,25 @@ export namespace discoveryengine_v1alpha {
|
|
|
5105
5558
|
*/
|
|
5106
5559
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest;
|
|
5107
5560
|
}
|
|
5561
|
+
export interface Params$Resource$Projects$Locations$Getaclconfig
|
|
5562
|
+
extends StandardParameters {
|
|
5563
|
+
/**
|
|
5564
|
+
* 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.
|
|
5565
|
+
*/
|
|
5566
|
+
name?: string;
|
|
5567
|
+
}
|
|
5568
|
+
export interface Params$Resource$Projects$Locations$Updateaclconfig
|
|
5569
|
+
extends StandardParameters {
|
|
5570
|
+
/**
|
|
5571
|
+
* 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.
|
|
5572
|
+
*/
|
|
5573
|
+
name?: string;
|
|
5574
|
+
|
|
5575
|
+
/**
|
|
5576
|
+
* Request body metadata
|
|
5577
|
+
*/
|
|
5578
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAclConfig;
|
|
5579
|
+
}
|
|
5108
5580
|
|
|
5109
5581
|
export class Resource$Projects$Locations$Collections {
|
|
5110
5582
|
context: APIRequestContext;
|
|
@@ -7266,6 +7738,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
7266
7738
|
* 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.
|
|
7267
7739
|
*/
|
|
7268
7740
|
name?: string;
|
|
7741
|
+
/**
|
|
7742
|
+
* Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
|
|
7743
|
+
*/
|
|
7744
|
+
updateMask?: string;
|
|
7269
7745
|
|
|
7270
7746
|
/**
|
|
7271
7747
|
* Request body metadata
|
|
@@ -16617,6 +17093,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
16617
17093
|
* 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.
|
|
16618
17094
|
*/
|
|
16619
17095
|
name?: string;
|
|
17096
|
+
/**
|
|
17097
|
+
* Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
|
|
17098
|
+
*/
|
|
17099
|
+
updateMask?: string;
|
|
16620
17100
|
|
|
16621
17101
|
/**
|
|
16622
17102
|
* Request body metadata
|