@googleapis/discoveryengine 6.1.0 → 8.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 +35 -0
- package/build/v1alpha.d.ts +737 -66
- package/build/v1alpha.js +270 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +382 -66
- package/build/v1beta.js +32 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1alpha.ts +2064 -708
- package/v1beta.ts +466 -64
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
|
*/
|
|
@@ -267,6 +280,46 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
267
280
|
*/
|
|
268
281
|
tableId?: string | null;
|
|
269
282
|
}
|
|
283
|
+
/**
|
|
284
|
+
* Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.
|
|
285
|
+
*/
|
|
286
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaChunk {
|
|
287
|
+
/**
|
|
288
|
+
* Content is a string from a document (parsed content).
|
|
289
|
+
*/
|
|
290
|
+
content?: string | null;
|
|
291
|
+
/**
|
|
292
|
+
* Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
|
|
293
|
+
*/
|
|
294
|
+
derivedStructData?: {
|
|
295
|
+
[key: string]: any;
|
|
296
|
+
} | null;
|
|
297
|
+
/**
|
|
298
|
+
* Metadata of the document from the current chunk.
|
|
299
|
+
*/
|
|
300
|
+
documentMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata;
|
|
301
|
+
/**
|
|
302
|
+
* Unique chunk id of the current chunk.
|
|
303
|
+
*/
|
|
304
|
+
id?: string | null;
|
|
305
|
+
/**
|
|
306
|
+
* The full resource name of the chunk. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}/chunks/{chunk_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
307
|
+
*/
|
|
308
|
+
name?: string | null;
|
|
309
|
+
}
|
|
310
|
+
/**
|
|
311
|
+
* Document metadata contains the information of the document of the current chunk.
|
|
312
|
+
*/
|
|
313
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata {
|
|
314
|
+
/**
|
|
315
|
+
* Title of the document.
|
|
316
|
+
*/
|
|
317
|
+
title?: string | null;
|
|
318
|
+
/**
|
|
319
|
+
* Uri of the document.
|
|
320
|
+
*/
|
|
321
|
+
uri?: string | null;
|
|
322
|
+
}
|
|
270
323
|
/**
|
|
271
324
|
* Request message for CompletionService.CompleteQuery method.
|
|
272
325
|
*/
|
|
@@ -394,6 +447,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
394
447
|
* Request message for ConversationalSearchService.ConverseConversation method.
|
|
395
448
|
*/
|
|
396
449
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest {
|
|
450
|
+
/**
|
|
451
|
+
* 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)
|
|
452
|
+
*/
|
|
453
|
+
boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
397
454
|
/**
|
|
398
455
|
* 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
456
|
*/
|
|
@@ -541,6 +598,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
541
598
|
* DataStore captures global settings and configs at the DataStore level.
|
|
542
599
|
*/
|
|
543
600
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDataStore {
|
|
601
|
+
/**
|
|
602
|
+
* 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.
|
|
603
|
+
*/
|
|
604
|
+
aclEnabled?: boolean | null;
|
|
544
605
|
/**
|
|
545
606
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
546
607
|
*/
|
|
@@ -557,6 +618,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
557
618
|
* 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.
|
|
558
619
|
*/
|
|
559
620
|
displayName?: string | null;
|
|
621
|
+
/**
|
|
622
|
+
* Configuration for Document understanding and enrichment.
|
|
623
|
+
*/
|
|
624
|
+
documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
|
|
625
|
+
/**
|
|
626
|
+
* Output only. Data store level identity provider config.
|
|
627
|
+
*/
|
|
628
|
+
idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
560
629
|
/**
|
|
561
630
|
* Immutable. The industry vertical that the data store registers.
|
|
562
631
|
*/
|
|
@@ -569,6 +638,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
569
638
|
* 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.
|
|
570
639
|
*/
|
|
571
640
|
solutionTypes?: string[] | null;
|
|
641
|
+
/**
|
|
642
|
+
* 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).
|
|
643
|
+
*/
|
|
644
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1alphaSchema;
|
|
572
645
|
}
|
|
573
646
|
/**
|
|
574
647
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -622,11 +695,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
622
695
|
*/
|
|
623
696
|
updateTime?: string | null;
|
|
624
697
|
}
|
|
625
|
-
/**
|
|
626
|
-
* The digital parsing configurations for documents.
|
|
627
|
-
*/
|
|
628
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {
|
|
629
|
-
}
|
|
630
698
|
/**
|
|
631
699
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
632
700
|
*/
|
|
@@ -654,6 +722,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
654
722
|
* Document captures all raw metadata information of items to be recommended or searched.
|
|
655
723
|
*/
|
|
656
724
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocument {
|
|
725
|
+
/**
|
|
726
|
+
* Access control information for the document.
|
|
727
|
+
*/
|
|
728
|
+
aclInfo?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfo;
|
|
657
729
|
/**
|
|
658
730
|
* The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
|
|
659
731
|
*/
|
|
@@ -668,6 +740,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
668
740
|
* 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.
|
|
669
741
|
*/
|
|
670
742
|
id?: string | null;
|
|
743
|
+
/**
|
|
744
|
+
* 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.
|
|
745
|
+
*/
|
|
746
|
+
indexTime?: string | null;
|
|
671
747
|
/**
|
|
672
748
|
* The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
|
|
673
749
|
*/
|
|
@@ -691,6 +767,24 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
691
767
|
[key: string]: any;
|
|
692
768
|
} | null;
|
|
693
769
|
}
|
|
770
|
+
/**
|
|
771
|
+
* ACL Information of the Document.
|
|
772
|
+
*/
|
|
773
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfo {
|
|
774
|
+
/**
|
|
775
|
+
* Readers of the document.
|
|
776
|
+
*/
|
|
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
|
+
}
|
|
694
788
|
/**
|
|
695
789
|
* Unstructured data linked to this document.
|
|
696
790
|
*/
|
|
@@ -737,6 +831,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
737
831
|
* 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.
|
|
738
832
|
*/
|
|
739
833
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
|
|
834
|
+
/**
|
|
835
|
+
* Whether chunking mode is enabled.
|
|
836
|
+
*/
|
|
837
|
+
chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig;
|
|
740
838
|
/**
|
|
741
839
|
* Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing.
|
|
742
840
|
*/
|
|
@@ -746,16 +844,34 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
746
844
|
*/
|
|
747
845
|
name?: string | null;
|
|
748
846
|
/**
|
|
749
|
-
*
|
|
750
|
-
*/
|
|
751
|
-
ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
752
|
-
/**
|
|
753
|
-
* Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported.
|
|
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.
|
|
754
848
|
*/
|
|
755
849
|
parsingConfigOverrides?: {
|
|
756
850
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
757
851
|
} | null;
|
|
758
852
|
}
|
|
853
|
+
/**
|
|
854
|
+
* Configuration for chunking config.
|
|
855
|
+
*/
|
|
856
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig {
|
|
857
|
+
/**
|
|
858
|
+
* Configuration for the layout based chunking.
|
|
859
|
+
*/
|
|
860
|
+
layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
|
|
861
|
+
}
|
|
862
|
+
/**
|
|
863
|
+
* Configuration for the layout based chunking.
|
|
864
|
+
*/
|
|
865
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
|
|
866
|
+
/**
|
|
867
|
+
* The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
|
|
868
|
+
*/
|
|
869
|
+
chunkSize?: number | null;
|
|
870
|
+
/**
|
|
871
|
+
* Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
|
|
872
|
+
*/
|
|
873
|
+
includeAncestorHeadings?: boolean | null;
|
|
874
|
+
}
|
|
759
875
|
/**
|
|
760
876
|
* Related configurations applied to a specific type of document parser.
|
|
761
877
|
*/
|
|
@@ -763,15 +879,38 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
763
879
|
/**
|
|
764
880
|
* Configurations applied to digital parser.
|
|
765
881
|
*/
|
|
766
|
-
digitalParsingConfig?: Schema$
|
|
882
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig;
|
|
767
883
|
/**
|
|
768
884
|
* Configurations applied to layout parser.
|
|
769
885
|
*/
|
|
770
|
-
layoutParsingConfig?: Schema$
|
|
886
|
+
layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig;
|
|
771
887
|
/**
|
|
772
888
|
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
773
889
|
*/
|
|
774
|
-
ocrParsingConfig?: Schema$
|
|
890
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
891
|
+
}
|
|
892
|
+
/**
|
|
893
|
+
* The digital parsing configurations for documents.
|
|
894
|
+
*/
|
|
895
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {
|
|
896
|
+
}
|
|
897
|
+
/**
|
|
898
|
+
* The layout parsing configurations for documents.
|
|
899
|
+
*/
|
|
900
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {
|
|
901
|
+
}
|
|
902
|
+
/**
|
|
903
|
+
* The OCR parsing configurations for documents.
|
|
904
|
+
*/
|
|
905
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
906
|
+
/**
|
|
907
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
908
|
+
*/
|
|
909
|
+
enhancedDocumentElements?: string[] | null;
|
|
910
|
+
/**
|
|
911
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
912
|
+
*/
|
|
913
|
+
useNativeText?: boolean | null;
|
|
775
914
|
}
|
|
776
915
|
/**
|
|
777
916
|
* Double list.
|
|
@@ -1162,6 +1301,28 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1162
1301
|
*/
|
|
1163
1302
|
maxRelatedQuestions?: number | null;
|
|
1164
1303
|
}
|
|
1304
|
+
/**
|
|
1305
|
+
* Identity Provider Config.
|
|
1306
|
+
*/
|
|
1307
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig {
|
|
1308
|
+
/**
|
|
1309
|
+
* External Identity provider config.
|
|
1310
|
+
*/
|
|
1311
|
+
externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig;
|
|
1312
|
+
/**
|
|
1313
|
+
* Identity provider type configured.
|
|
1314
|
+
*/
|
|
1315
|
+
idpType?: string | null;
|
|
1316
|
+
}
|
|
1317
|
+
/**
|
|
1318
|
+
* Third party IDP Config.
|
|
1319
|
+
*/
|
|
1320
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig {
|
|
1321
|
+
/**
|
|
1322
|
+
* Workforce pool name. Example: "locations/global/workforcePools/pool_id"
|
|
1323
|
+
*/
|
|
1324
|
+
workforcePoolName?: string | null;
|
|
1325
|
+
}
|
|
1165
1326
|
/**
|
|
1166
1327
|
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1167
1328
|
*/
|
|
@@ -1393,9 +1554,17 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1393
1554
|
minimum?: number | null;
|
|
1394
1555
|
}
|
|
1395
1556
|
/**
|
|
1396
|
-
*
|
|
1557
|
+
* Response message for ChunkService.ListChunks method.
|
|
1397
1558
|
*/
|
|
1398
|
-
export interface Schema$
|
|
1559
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse {
|
|
1560
|
+
/**
|
|
1561
|
+
* The Chunks.
|
|
1562
|
+
*/
|
|
1563
|
+
chunks?: Schema$GoogleCloudDiscoveryengineV1alphaChunk[];
|
|
1564
|
+
/**
|
|
1565
|
+
* A token that can be sent as ListChunksRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
1566
|
+
*/
|
|
1567
|
+
nextPageToken?: string | null;
|
|
1399
1568
|
}
|
|
1400
1569
|
/**
|
|
1401
1570
|
* Response for ListConversations method.
|
|
@@ -1523,36 +1692,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1523
1692
|
*/
|
|
1524
1693
|
mediaProgressPercentage?: number | null;
|
|
1525
1694
|
}
|
|
1526
|
-
/**
|
|
1527
|
-
* The OCR options for parsing documents.
|
|
1528
|
-
*/
|
|
1529
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig {
|
|
1530
|
-
/**
|
|
1531
|
-
* Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files.
|
|
1532
|
-
*/
|
|
1533
|
-
enabled?: boolean | null;
|
|
1534
|
-
/**
|
|
1535
|
-
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
1536
|
-
*/
|
|
1537
|
-
enhancedDocumentElements?: string[] | null;
|
|
1538
|
-
/**
|
|
1539
|
-
* If true, will use native text instead of OCR text on pages containing native text.
|
|
1540
|
-
*/
|
|
1541
|
-
useNativeText?: boolean | null;
|
|
1542
|
-
}
|
|
1543
|
-
/**
|
|
1544
|
-
* The OCR parsing configurations for documents.
|
|
1545
|
-
*/
|
|
1546
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig {
|
|
1547
|
-
/**
|
|
1548
|
-
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
1549
|
-
*/
|
|
1550
|
-
enhancedDocumentElements?: string[] | null;
|
|
1551
|
-
/**
|
|
1552
|
-
* If true, will use native text instead of OCR text on pages containing native text.
|
|
1553
|
-
*/
|
|
1554
|
-
useNativeText?: boolean | null;
|
|
1555
|
-
}
|
|
1556
1695
|
/**
|
|
1557
1696
|
* Detailed page information.
|
|
1558
1697
|
*/
|
|
@@ -1600,6 +1739,32 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1600
1739
|
*/
|
|
1601
1740
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaPauseEngineRequest {
|
|
1602
1741
|
}
|
|
1742
|
+
/**
|
|
1743
|
+
* Principal identifier of a user or a group.
|
|
1744
|
+
*/
|
|
1745
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPrincipal {
|
|
1746
|
+
/**
|
|
1747
|
+
* 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.
|
|
1748
|
+
*/
|
|
1749
|
+
groupId?: string | null;
|
|
1750
|
+
/**
|
|
1751
|
+
* 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.
|
|
1752
|
+
*/
|
|
1753
|
+
userId?: string | null;
|
|
1754
|
+
}
|
|
1755
|
+
/**
|
|
1756
|
+
* Document captures all raw metadata information of items to be recommended or searched.
|
|
1757
|
+
*/
|
|
1758
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument {
|
|
1759
|
+
/**
|
|
1760
|
+
* Required. Full resource name of the referenced document, in the format `projects/x/locations/x/collections/x/dataStores/x/branches/x/documents/x`.
|
|
1761
|
+
*/
|
|
1762
|
+
document?: string | null;
|
|
1763
|
+
/**
|
|
1764
|
+
* The JSON string representation of the processed document.
|
|
1765
|
+
*/
|
|
1766
|
+
jsonData?: string | null;
|
|
1767
|
+
}
|
|
1603
1768
|
/**
|
|
1604
1769
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1605
1770
|
*/
|
|
@@ -1612,6 +1777,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1612
1777
|
* Count of entries that encountered errors while processing.
|
|
1613
1778
|
*/
|
|
1614
1779
|
failureCount?: string | null;
|
|
1780
|
+
/**
|
|
1781
|
+
* Count of entries that were ignored as entries were not found.
|
|
1782
|
+
*/
|
|
1783
|
+
ignoredCount?: string | null;
|
|
1615
1784
|
/**
|
|
1616
1785
|
* Count of entries that were deleted successfully.
|
|
1617
1786
|
*/
|
|
@@ -1625,6 +1794,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1625
1794
|
* Request message for DocumentService.PurgeDocuments method.
|
|
1626
1795
|
*/
|
|
1627
1796
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest {
|
|
1797
|
+
/**
|
|
1798
|
+
* The desired location of errors incurred during the purge.
|
|
1799
|
+
*/
|
|
1800
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig;
|
|
1628
1801
|
/**
|
|
1629
1802
|
* Required. Filter matching documents to purge. Only currently supported value is `*` (all items).
|
|
1630
1803
|
*/
|
|
@@ -1633,6 +1806,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1633
1806
|
* Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.
|
|
1634
1807
|
*/
|
|
1635
1808
|
force?: boolean | null;
|
|
1809
|
+
/**
|
|
1810
|
+
* Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line.
|
|
1811
|
+
*/
|
|
1812
|
+
gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource;
|
|
1636
1813
|
}
|
|
1637
1814
|
/**
|
|
1638
1815
|
* 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.
|
|
@@ -1647,6 +1824,15 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1647
1824
|
*/
|
|
1648
1825
|
purgeSample?: string[] | null;
|
|
1649
1826
|
}
|
|
1827
|
+
/**
|
|
1828
|
+
* Configuration of destination for Purge related errors.
|
|
1829
|
+
*/
|
|
1830
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig {
|
|
1831
|
+
/**
|
|
1832
|
+
* 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.
|
|
1833
|
+
*/
|
|
1834
|
+
gcsPrefix?: string | null;
|
|
1835
|
+
}
|
|
1650
1836
|
/**
|
|
1651
1837
|
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1652
1838
|
*/
|
|
@@ -1978,6 +2164,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1978
2164
|
* A specification for configuring the behavior of content search.
|
|
1979
2165
|
*/
|
|
1980
2166
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
2167
|
+
/**
|
|
2168
|
+
* Custom fine tuning configs.
|
|
2169
|
+
*/
|
|
2170
|
+
customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
2171
|
+
/**
|
|
2172
|
+
* A list of data store specs to apply on a search call.
|
|
2173
|
+
*/
|
|
2174
|
+
dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
1981
2175
|
/**
|
|
1982
2176
|
* 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.
|
|
1983
2177
|
*/
|
|
@@ -2069,11 +2263,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2069
2263
|
*/
|
|
2070
2264
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec {
|
|
2071
2265
|
/**
|
|
2072
|
-
* Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
|
|
2266
|
+
* Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
|
|
2073
2267
|
*/
|
|
2074
2268
|
boost?: number | null;
|
|
2075
2269
|
/**
|
|
2076
|
-
* 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":
|
|
2270
|
+
* 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"))`
|
|
2077
2271
|
*/
|
|
2078
2272
|
condition?: string | null;
|
|
2079
2273
|
}
|
|
@@ -2085,6 +2279,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2085
2279
|
* If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
|
|
2086
2280
|
*/
|
|
2087
2281
|
extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
2282
|
+
/**
|
|
2283
|
+
* Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.
|
|
2284
|
+
*/
|
|
2285
|
+
searchResultMode?: string | null;
|
|
2088
2286
|
/**
|
|
2089
2287
|
* If `snippetSpec` is not specified, snippets are not included in the search response.
|
|
2090
2288
|
*/
|
|
@@ -2114,6 +2312,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2114
2312
|
* Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
|
|
2115
2313
|
*/
|
|
2116
2314
|
numPreviousSegments?: number | null;
|
|
2315
|
+
/**
|
|
2316
|
+
* Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, please contact your Customer Engineer. The default value is `false`.
|
|
2317
|
+
*/
|
|
2318
|
+
returnExtractiveSegmentScore?: boolean | null;
|
|
2117
2319
|
}
|
|
2118
2320
|
/**
|
|
2119
2321
|
* A specification for configuring snippets in a search response.
|
|
@@ -2161,9 +2363,13 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2161
2363
|
*/
|
|
2162
2364
|
modelSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec;
|
|
2163
2365
|
/**
|
|
2164
|
-
* The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most
|
|
2366
|
+
* The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results can be used to generate a summary.
|
|
2165
2367
|
*/
|
|
2166
2368
|
summaryResultCount?: number | null;
|
|
2369
|
+
/**
|
|
2370
|
+
* If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Please note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
|
|
2371
|
+
*/
|
|
2372
|
+
useSemanticChunks?: boolean | null;
|
|
2167
2373
|
}
|
|
2168
2374
|
/**
|
|
2169
2375
|
* Specification of the prompt to use with the model.
|
|
@@ -2179,10 +2385,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2179
2385
|
*/
|
|
2180
2386
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
2181
2387
|
/**
|
|
2182
|
-
* The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned
|
|
2388
|
+
* 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 model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
|
|
2183
2389
|
*/
|
|
2184
2390
|
version?: string | null;
|
|
2185
2391
|
}
|
|
2392
|
+
/**
|
|
2393
|
+
* A struct to define data stores to filter on in a search call.
|
|
2394
|
+
*/
|
|
2395
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
|
|
2396
|
+
/**
|
|
2397
|
+
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`.
|
|
2398
|
+
*/
|
|
2399
|
+
dataStore?: string | null;
|
|
2400
|
+
}
|
|
2186
2401
|
/**
|
|
2187
2402
|
* The specification that uses customized query embedding vector to do semantic document retrieval.
|
|
2188
2403
|
*/
|
|
@@ -2430,6 +2645,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2430
2645
|
* Represents the search results.
|
|
2431
2646
|
*/
|
|
2432
2647
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult {
|
|
2648
|
+
/**
|
|
2649
|
+
* The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
|
|
2650
|
+
*/
|
|
2651
|
+
chunk?: Schema$GoogleCloudDiscoveryengineV1alphaChunk;
|
|
2433
2652
|
/**
|
|
2434
2653
|
* The document data snippet in the search response. Only fields that are marked as retrievable are populated.
|
|
2435
2654
|
*/
|
|
@@ -2461,6 +2680,9 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2461
2680
|
* The summary content.
|
|
2462
2681
|
*/
|
|
2463
2682
|
summaryText?: string | null;
|
|
2683
|
+
/**
|
|
2684
|
+
* Summary with metadata information.
|
|
2685
|
+
*/
|
|
2464
2686
|
summaryWithMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata;
|
|
2465
2687
|
}
|
|
2466
2688
|
/**
|
|
@@ -2602,13 +2824,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2602
2824
|
*/
|
|
2603
2825
|
modelId?: string | null;
|
|
2604
2826
|
/**
|
|
2605
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/
|
|
2827
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
2606
2828
|
*/
|
|
2607
2829
|
name?: string | null;
|
|
2608
2830
|
/**
|
|
2609
2831
|
* Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
2610
2832
|
*/
|
|
2611
2833
|
onewaySynonymsControlIds?: string[] | null;
|
|
2834
|
+
/**
|
|
2835
|
+
* 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).
|
|
2836
|
+
*/
|
|
2612
2837
|
rankingExpression?: string | null;
|
|
2613
2838
|
/**
|
|
2614
2839
|
* 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.
|
|
@@ -2648,10 +2873,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2648
2873
|
* Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
|
|
2649
2874
|
*/
|
|
2650
2875
|
contentFreshnessCutoffDays?: number | null;
|
|
2651
|
-
/**
|
|
2652
|
-
* Specifies the content watched minutes threshold for demotion.
|
|
2653
|
-
*/
|
|
2654
|
-
contentWatchedMinutesThreshold?: number | null;
|
|
2655
2876
|
/**
|
|
2656
2877
|
* Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
|
|
2657
2878
|
*/
|
|
@@ -2750,6 +2971,9 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2750
2971
|
*/
|
|
2751
2972
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
2752
2973
|
}
|
|
2974
|
+
/**
|
|
2975
|
+
* Failed due to insufficient quota.
|
|
2976
|
+
*/
|
|
2753
2977
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
2754
2978
|
/**
|
|
2755
2979
|
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
@@ -2804,11 +3028,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2804
3028
|
*/
|
|
2805
3029
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput {
|
|
2806
3030
|
/**
|
|
2807
|
-
* The Cloud Storage corpus data which could be associated in train data. The data path format is gs
|
|
3031
|
+
* The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"\}`
|
|
2808
3032
|
*/
|
|
2809
3033
|
corpusDataPath?: string | null;
|
|
2810
3034
|
/**
|
|
2811
|
-
* The gcs query data which could be associated in train data. The data path format is gs
|
|
3035
|
+
* The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"\}
|
|
2812
3036
|
*/
|
|
2813
3037
|
queryDataPath?: string | null;
|
|
2814
3038
|
/**
|
|
@@ -2816,7 +3040,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2816
3040
|
*/
|
|
2817
3041
|
testDataPath?: string | null;
|
|
2818
3042
|
/**
|
|
2819
|
-
* Cloud Storage training data path whose format should be gs
|
|
3043
|
+
* Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * `query1\tdoc1\t1`
|
|
2820
3044
|
*/
|
|
2821
3045
|
trainDataPath?: string | null;
|
|
2822
3046
|
}
|
|
@@ -3054,6 +3278,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3054
3278
|
* Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.
|
|
3055
3279
|
*/
|
|
3056
3280
|
allowPublicAccess?: boolean | null;
|
|
3281
|
+
/**
|
|
3282
|
+
* Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.
|
|
3283
|
+
*/
|
|
3284
|
+
collectionComponents?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent[];
|
|
3057
3285
|
/**
|
|
3058
3286
|
* Output only. Unique obfuscated identifier of a WidgetConfig.
|
|
3059
3287
|
*/
|
|
@@ -3070,6 +3298,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3070
3298
|
* Output only. The type of the parent data store.
|
|
3071
3299
|
*/
|
|
3072
3300
|
dataStoreType?: string | null;
|
|
3301
|
+
/**
|
|
3302
|
+
* Configurable UI configurations per data store.
|
|
3303
|
+
*/
|
|
3304
|
+
dataStoreUiConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig[];
|
|
3073
3305
|
/**
|
|
3074
3306
|
* Required. The human readable widget 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.
|
|
3075
3307
|
*/
|
|
@@ -3102,6 +3334,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3102
3334
|
* Turn on or off summarization for the search response.
|
|
3103
3335
|
*/
|
|
3104
3336
|
enableSummarization?: boolean | null;
|
|
3337
|
+
/**
|
|
3338
|
+
* Whether to enable standalone web app.
|
|
3339
|
+
*/
|
|
3340
|
+
enableWebApp?: boolean | null;
|
|
3105
3341
|
/**
|
|
3106
3342
|
* The configuration and appearance of facets in the end user view.
|
|
3107
3343
|
*/
|
|
@@ -3141,6 +3377,67 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3141
3377
|
*/
|
|
3142
3378
|
updateTime?: string | null;
|
|
3143
3379
|
}
|
|
3380
|
+
/**
|
|
3381
|
+
* Read-only collection component that contains data store collections fields that may be used for filtering
|
|
3382
|
+
*/
|
|
3383
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent {
|
|
3384
|
+
/**
|
|
3385
|
+
* For the data store collection, list of the children data stores.
|
|
3386
|
+
*/
|
|
3387
|
+
dataStoreComponents?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent[];
|
|
3388
|
+
/**
|
|
3389
|
+
* The display name of the collection.
|
|
3390
|
+
*/
|
|
3391
|
+
displayName?: string | null;
|
|
3392
|
+
/**
|
|
3393
|
+
* Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.
|
|
3394
|
+
*/
|
|
3395
|
+
id?: string | null;
|
|
3396
|
+
/**
|
|
3397
|
+
* The name of the collection. It should be collection resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection_id\}`. For widget service usage, such look up widget config, returned name should be skipped.
|
|
3398
|
+
*/
|
|
3399
|
+
name?: string | null;
|
|
3400
|
+
}
|
|
3401
|
+
/**
|
|
3402
|
+
* Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.
|
|
3403
|
+
*/
|
|
3404
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent {
|
|
3405
|
+
/**
|
|
3406
|
+
* The display name of the data store.
|
|
3407
|
+
*/
|
|
3408
|
+
displayName?: string | null;
|
|
3409
|
+
/**
|
|
3410
|
+
* Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
|
|
3411
|
+
*/
|
|
3412
|
+
id?: string | null;
|
|
3413
|
+
/**
|
|
3414
|
+
* The name of the data store. It should be data store resource name Format: `projects/{project_number\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For widget service usage, such look up widget config, returned name should be skipped.
|
|
3415
|
+
*/
|
|
3416
|
+
name?: string | null;
|
|
3417
|
+
}
|
|
3418
|
+
/**
|
|
3419
|
+
* UI component configuration for data store.
|
|
3420
|
+
*/
|
|
3421
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig {
|
|
3422
|
+
/**
|
|
3423
|
+
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
3424
|
+
*/
|
|
3425
|
+
facetField?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
|
|
3426
|
+
/**
|
|
3427
|
+
* The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
|
|
3428
|
+
*/
|
|
3429
|
+
fieldsUiComponentsMap?: {
|
|
3430
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
3431
|
+
} | null;
|
|
3432
|
+
/**
|
|
3433
|
+
* Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
|
|
3434
|
+
*/
|
|
3435
|
+
id?: string | null;
|
|
3436
|
+
/**
|
|
3437
|
+
* The name of the data store. It should be data store resource name Format: `projects/{project_number\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For widget service usage, such look up widget config, returned name should be skipped.
|
|
3438
|
+
*/
|
|
3439
|
+
name?: string | null;
|
|
3440
|
+
}
|
|
3144
3441
|
/**
|
|
3145
3442
|
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
3146
3443
|
*/
|
|
@@ -3355,6 +3652,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3355
3652
|
* 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.
|
|
3356
3653
|
*/
|
|
3357
3654
|
displayName?: string | null;
|
|
3655
|
+
/**
|
|
3656
|
+
* Configuration for Document understanding and enrichment.
|
|
3657
|
+
*/
|
|
3658
|
+
documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig;
|
|
3358
3659
|
/**
|
|
3359
3660
|
* Immutable. The industry vertical that the data store registers.
|
|
3360
3661
|
*/
|
|
@@ -3367,6 +3668,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3367
3668
|
* The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
|
|
3368
3669
|
*/
|
|
3369
3670
|
solutionTypes?: string[] | null;
|
|
3671
|
+
/**
|
|
3672
|
+
* 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).
|
|
3673
|
+
*/
|
|
3674
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema;
|
|
3370
3675
|
}
|
|
3371
3676
|
/**
|
|
3372
3677
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -3438,6 +3743,56 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3438
3743
|
*/
|
|
3439
3744
|
export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {
|
|
3440
3745
|
}
|
|
3746
|
+
/**
|
|
3747
|
+
* 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.
|
|
3748
|
+
*/
|
|
3749
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
|
|
3750
|
+
/**
|
|
3751
|
+
* 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.
|
|
3752
|
+
*/
|
|
3753
|
+
defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
3754
|
+
/**
|
|
3755
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
3756
|
+
*/
|
|
3757
|
+
name?: string | null;
|
|
3758
|
+
/**
|
|
3759
|
+
* 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.
|
|
3760
|
+
*/
|
|
3761
|
+
parsingConfigOverrides?: {
|
|
3762
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
3763
|
+
} | null;
|
|
3764
|
+
}
|
|
3765
|
+
/**
|
|
3766
|
+
* Related configurations applied to a specific type of document parser.
|
|
3767
|
+
*/
|
|
3768
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
|
|
3769
|
+
/**
|
|
3770
|
+
* Configurations applied to digital parser.
|
|
3771
|
+
*/
|
|
3772
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig;
|
|
3773
|
+
/**
|
|
3774
|
+
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
3775
|
+
*/
|
|
3776
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
3777
|
+
}
|
|
3778
|
+
/**
|
|
3779
|
+
* The digital parsing configurations for documents.
|
|
3780
|
+
*/
|
|
3781
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {
|
|
3782
|
+
}
|
|
3783
|
+
/**
|
|
3784
|
+
* The OCR parsing configurations for documents.
|
|
3785
|
+
*/
|
|
3786
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
3787
|
+
/**
|
|
3788
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
3789
|
+
*/
|
|
3790
|
+
enhancedDocumentElements?: string[] | null;
|
|
3791
|
+
/**
|
|
3792
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
3793
|
+
*/
|
|
3794
|
+
useNativeText?: boolean | null;
|
|
3795
|
+
}
|
|
3441
3796
|
/**
|
|
3442
3797
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3443
3798
|
*/
|
|
@@ -3697,6 +4052,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3697
4052
|
* Count of entries that encountered errors while processing.
|
|
3698
4053
|
*/
|
|
3699
4054
|
failureCount?: string | null;
|
|
4055
|
+
/**
|
|
4056
|
+
* Count of entries that were ignored as entries were not found.
|
|
4057
|
+
*/
|
|
4058
|
+
ignoredCount?: string | null;
|
|
3700
4059
|
/**
|
|
3701
4060
|
* Count of entries that were deleted successfully.
|
|
3702
4061
|
*/
|
|
@@ -3827,12 +4186,45 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3827
4186
|
*/
|
|
3828
4187
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure;
|
|
3829
4188
|
}
|
|
4189
|
+
/**
|
|
4190
|
+
* Failed due to insufficient quota.
|
|
4191
|
+
*/
|
|
3830
4192
|
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure {
|
|
3831
4193
|
/**
|
|
3832
4194
|
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
3833
4195
|
*/
|
|
3834
4196
|
totalRequiredQuota?: string | null;
|
|
3835
4197
|
}
|
|
4198
|
+
/**
|
|
4199
|
+
* Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
4200
|
+
*/
|
|
4201
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata {
|
|
4202
|
+
/**
|
|
4203
|
+
* Operation create time.
|
|
4204
|
+
*/
|
|
4205
|
+
createTime?: string | null;
|
|
4206
|
+
/**
|
|
4207
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4208
|
+
*/
|
|
4209
|
+
updateTime?: string | null;
|
|
4210
|
+
}
|
|
4211
|
+
/**
|
|
4212
|
+
* Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.
|
|
4213
|
+
*/
|
|
4214
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse {
|
|
4215
|
+
/**
|
|
4216
|
+
* Echoes the destination for the complete errors in the request if set.
|
|
4217
|
+
*/
|
|
4218
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
4219
|
+
/**
|
|
4220
|
+
* A sample of errors encountered while processing the data.
|
|
4221
|
+
*/
|
|
4222
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4223
|
+
/**
|
|
4224
|
+
* The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving.
|
|
4225
|
+
*/
|
|
4226
|
+
modelStatus?: string | null;
|
|
4227
|
+
}
|
|
3836
4228
|
/**
|
|
3837
4229
|
* Metadata for UpdateSchema LRO.
|
|
3838
4230
|
*/
|
|
@@ -3931,6 +4323,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3931
4323
|
* Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3932
4324
|
*/
|
|
3933
4325
|
displayName?: string | null;
|
|
4326
|
+
/**
|
|
4327
|
+
* Configuration for Document understanding and enrichment.
|
|
4328
|
+
*/
|
|
4329
|
+
documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig;
|
|
3934
4330
|
/**
|
|
3935
4331
|
* Immutable. The industry vertical that the data store registers.
|
|
3936
4332
|
*/
|
|
@@ -3943,6 +4339,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3943
4339
|
* The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
|
|
3944
4340
|
*/
|
|
3945
4341
|
solutionTypes?: string[] | null;
|
|
4342
|
+
/**
|
|
4343
|
+
* 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).
|
|
4344
|
+
*/
|
|
4345
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema;
|
|
3946
4346
|
}
|
|
3947
4347
|
/**
|
|
3948
4348
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -4014,6 +4414,56 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4014
4414
|
*/
|
|
4015
4415
|
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {
|
|
4016
4416
|
}
|
|
4417
|
+
/**
|
|
4418
|
+
* 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.
|
|
4419
|
+
*/
|
|
4420
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
|
|
4421
|
+
/**
|
|
4422
|
+
* 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.
|
|
4423
|
+
*/
|
|
4424
|
+
defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
4425
|
+
/**
|
|
4426
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
4427
|
+
*/
|
|
4428
|
+
name?: string | null;
|
|
4429
|
+
/**
|
|
4430
|
+
* 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.
|
|
4431
|
+
*/
|
|
4432
|
+
parsingConfigOverrides?: {
|
|
4433
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
4434
|
+
} | null;
|
|
4435
|
+
}
|
|
4436
|
+
/**
|
|
4437
|
+
* Related configurations applied to a specific type of document parser.
|
|
4438
|
+
*/
|
|
4439
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
|
|
4440
|
+
/**
|
|
4441
|
+
* Configurations applied to digital parser.
|
|
4442
|
+
*/
|
|
4443
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig;
|
|
4444
|
+
/**
|
|
4445
|
+
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
4446
|
+
*/
|
|
4447
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
4448
|
+
}
|
|
4449
|
+
/**
|
|
4450
|
+
* The digital parsing configurations for documents.
|
|
4451
|
+
*/
|
|
4452
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {
|
|
4453
|
+
}
|
|
4454
|
+
/**
|
|
4455
|
+
* The OCR parsing configurations for documents.
|
|
4456
|
+
*/
|
|
4457
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
4458
|
+
/**
|
|
4459
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
4460
|
+
*/
|
|
4461
|
+
enhancedDocumentElements?: string[] | null;
|
|
4462
|
+
/**
|
|
4463
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
4464
|
+
*/
|
|
4465
|
+
useNativeText?: boolean | null;
|
|
4466
|
+
}
|
|
4017
4467
|
/**
|
|
4018
4468
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4019
4469
|
*/
|
|
@@ -4273,6 +4723,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4273
4723
|
* Count of entries that encountered errors while processing.
|
|
4274
4724
|
*/
|
|
4275
4725
|
failureCount?: string | null;
|
|
4726
|
+
/**
|
|
4727
|
+
* Count of entries that were ignored as entries were not found.
|
|
4728
|
+
*/
|
|
4729
|
+
ignoredCount?: string | null;
|
|
4276
4730
|
/**
|
|
4277
4731
|
* Count of entries that were deleted successfully.
|
|
4278
4732
|
*/
|
|
@@ -4403,6 +4857,9 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4403
4857
|
*/
|
|
4404
4858
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure;
|
|
4405
4859
|
}
|
|
4860
|
+
/**
|
|
4861
|
+
* Failed due to insufficient quota.
|
|
4862
|
+
*/
|
|
4406
4863
|
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure {
|
|
4407
4864
|
/**
|
|
4408
4865
|
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
@@ -4644,6 +5101,34 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4644
5101
|
estimateDataSize(params: Params$Resource$Projects$Locations$Estimatedatasize, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4645
5102
|
estimateDataSize(params: Params$Resource$Projects$Locations$Estimatedatasize, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4646
5103
|
estimateDataSize(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5104
|
+
/**
|
|
5105
|
+
* Gets the AclConfig.
|
|
5106
|
+
*
|
|
5107
|
+
* @param params - Parameters for request
|
|
5108
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5109
|
+
* @param callback - Optional callback that handles the response.
|
|
5110
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5111
|
+
*/
|
|
5112
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5113
|
+
getAclConfig(params?: Params$Resource$Projects$Locations$Getaclconfig, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>;
|
|
5114
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5115
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>): void;
|
|
5116
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>): void;
|
|
5117
|
+
getAclConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>): void;
|
|
5118
|
+
/**
|
|
5119
|
+
* 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.
|
|
5120
|
+
*
|
|
5121
|
+
* @param params - Parameters for request
|
|
5122
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5123
|
+
* @param callback - Optional callback that handles the response.
|
|
5124
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5125
|
+
*/
|
|
5126
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5127
|
+
updateAclConfig(params?: Params$Resource$Projects$Locations$Updateaclconfig, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>;
|
|
5128
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5129
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>): void;
|
|
5130
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>): void;
|
|
5131
|
+
updateAclConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>): void;
|
|
4647
5132
|
}
|
|
4648
5133
|
export interface Params$Resource$Projects$Locations$Estimatedatasize extends StandardParameters {
|
|
4649
5134
|
/**
|
|
@@ -4655,6 +5140,22 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4655
5140
|
*/
|
|
4656
5141
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest;
|
|
4657
5142
|
}
|
|
5143
|
+
export interface Params$Resource$Projects$Locations$Getaclconfig extends StandardParameters {
|
|
5144
|
+
/**
|
|
5145
|
+
* 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.
|
|
5146
|
+
*/
|
|
5147
|
+
name?: string;
|
|
5148
|
+
}
|
|
5149
|
+
export interface Params$Resource$Projects$Locations$Updateaclconfig extends StandardParameters {
|
|
5150
|
+
/**
|
|
5151
|
+
* 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.
|
|
5152
|
+
*/
|
|
5153
|
+
name?: string;
|
|
5154
|
+
/**
|
|
5155
|
+
* Request body metadata
|
|
5156
|
+
*/
|
|
5157
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAclConfig;
|
|
5158
|
+
}
|
|
4658
5159
|
export class Resource$Projects$Locations$Collections {
|
|
4659
5160
|
context: APIRequestContext;
|
|
4660
5161
|
dataConnector: Resource$Projects$Locations$Collections$Dataconnector;
|
|
@@ -5005,6 +5506,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5005
5506
|
}
|
|
5006
5507
|
export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents {
|
|
5007
5508
|
context: APIRequestContext;
|
|
5509
|
+
chunks: Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks;
|
|
5008
5510
|
constructor(context: APIRequestContext);
|
|
5009
5511
|
/**
|
|
5010
5512
|
* Creates a Document.
|
|
@@ -5048,6 +5550,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5048
5550
|
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>): void;
|
|
5049
5551
|
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>): void;
|
|
5050
5552
|
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>): void;
|
|
5553
|
+
/**
|
|
5554
|
+
* Gets the parsed layout information for a Document.
|
|
5555
|
+
*
|
|
5556
|
+
* @param params - Parameters for request
|
|
5557
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5558
|
+
* @param callback - Optional callback that handles the response.
|
|
5559
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5560
|
+
*/
|
|
5561
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5562
|
+
getProcessedDocument(params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>;
|
|
5563
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5564
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>): void;
|
|
5565
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>): void;
|
|
5566
|
+
getProcessedDocument(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>): void;
|
|
5051
5567
|
/**
|
|
5052
5568
|
* Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
|
|
5053
5569
|
*
|
|
@@ -5131,6 +5647,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5131
5647
|
*/
|
|
5132
5648
|
name?: string;
|
|
5133
5649
|
}
|
|
5650
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument extends StandardParameters {
|
|
5651
|
+
/**
|
|
5652
|
+
* Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.
|
|
5653
|
+
*/
|
|
5654
|
+
name?: string;
|
|
5655
|
+
/**
|
|
5656
|
+
* What format output should be. If unspecified, defaults to JSON.
|
|
5657
|
+
*/
|
|
5658
|
+
processedDocumentFormat?: string;
|
|
5659
|
+
/**
|
|
5660
|
+
* Required. What type of processing to return.
|
|
5661
|
+
*/
|
|
5662
|
+
processedDocumentType?: string;
|
|
5663
|
+
}
|
|
5134
5664
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import extends StandardParameters {
|
|
5135
5665
|
/**
|
|
5136
5666
|
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission.
|
|
@@ -5164,6 +5694,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5164
5694
|
* 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.
|
|
5165
5695
|
*/
|
|
5166
5696
|
name?: string;
|
|
5697
|
+
/**
|
|
5698
|
+
* Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
|
|
5699
|
+
*/
|
|
5700
|
+
updateMask?: string;
|
|
5167
5701
|
/**
|
|
5168
5702
|
* Request body metadata
|
|
5169
5703
|
*/
|
|
@@ -5179,6 +5713,58 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5179
5713
|
*/
|
|
5180
5714
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest;
|
|
5181
5715
|
}
|
|
5716
|
+
export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks {
|
|
5717
|
+
context: APIRequestContext;
|
|
5718
|
+
constructor(context: APIRequestContext);
|
|
5719
|
+
/**
|
|
5720
|
+
* Gets a Document.
|
|
5721
|
+
*
|
|
5722
|
+
* @param params - Parameters for request
|
|
5723
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5724
|
+
* @param callback - Optional callback that handles the response.
|
|
5725
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5726
|
+
*/
|
|
5727
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5728
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaChunk>;
|
|
5729
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5730
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>): void;
|
|
5731
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>): void;
|
|
5732
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>): void;
|
|
5733
|
+
/**
|
|
5734
|
+
* Gets a list of Chunks.
|
|
5735
|
+
*
|
|
5736
|
+
* @param params - Parameters for request
|
|
5737
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5738
|
+
* @param callback - Optional callback that handles the response.
|
|
5739
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5740
|
+
*/
|
|
5741
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5742
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>;
|
|
5743
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5744
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>): void;
|
|
5745
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>): void;
|
|
5746
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>): void;
|
|
5747
|
+
}
|
|
5748
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get extends StandardParameters {
|
|
5749
|
+
/**
|
|
5750
|
+
* Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned.
|
|
5751
|
+
*/
|
|
5752
|
+
name?: string;
|
|
5753
|
+
}
|
|
5754
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List extends StandardParameters {
|
|
5755
|
+
/**
|
|
5756
|
+
* Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
|
5757
|
+
*/
|
|
5758
|
+
pageSize?: number;
|
|
5759
|
+
/**
|
|
5760
|
+
* A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
5761
|
+
*/
|
|
5762
|
+
pageToken?: string;
|
|
5763
|
+
/**
|
|
5764
|
+
* Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned.
|
|
5765
|
+
*/
|
|
5766
|
+
parent?: string;
|
|
5767
|
+
}
|
|
5182
5768
|
export class Resource$Projects$Locations$Collections$Datastores$Branches$Operations {
|
|
5183
5769
|
context: APIRequestContext;
|
|
5184
5770
|
constructor(context: APIRequestContext);
|
|
@@ -5769,7 +6355,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5769
6355
|
}
|
|
5770
6356
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
5771
6357
|
/**
|
|
5772
|
-
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/
|
|
6358
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
5773
6359
|
*/
|
|
5774
6360
|
name?: string;
|
|
5775
6361
|
}
|
|
@@ -5783,13 +6369,13 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5783
6369
|
*/
|
|
5784
6370
|
pageToken?: string;
|
|
5785
6371
|
/**
|
|
5786
|
-
* Required.
|
|
6372
|
+
* Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
5787
6373
|
*/
|
|
5788
6374
|
parent?: string;
|
|
5789
6375
|
}
|
|
5790
6376
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
5791
6377
|
/**
|
|
5792
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/
|
|
6378
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
5793
6379
|
*/
|
|
5794
6380
|
name?: string;
|
|
5795
6381
|
/**
|
|
@@ -6863,7 +7449,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6863
7449
|
}
|
|
6864
7450
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
|
|
6865
7451
|
/**
|
|
6866
|
-
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/
|
|
7452
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
6867
7453
|
*/
|
|
6868
7454
|
name?: string;
|
|
6869
7455
|
}
|
|
@@ -6877,13 +7463,13 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6877
7463
|
*/
|
|
6878
7464
|
pageToken?: string;
|
|
6879
7465
|
/**
|
|
6880
|
-
* Required.
|
|
7466
|
+
* Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
6881
7467
|
*/
|
|
6882
7468
|
parent?: string;
|
|
6883
7469
|
}
|
|
6884
7470
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters {
|
|
6885
7471
|
/**
|
|
6886
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/
|
|
7472
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
6887
7473
|
*/
|
|
6888
7474
|
name?: string;
|
|
6889
7475
|
/**
|
|
@@ -7228,6 +7814,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7228
7814
|
}
|
|
7229
7815
|
export class Resource$Projects$Locations$Datastores$Branches$Documents {
|
|
7230
7816
|
context: APIRequestContext;
|
|
7817
|
+
chunks: Resource$Projects$Locations$Datastores$Branches$Documents$Chunks;
|
|
7231
7818
|
constructor(context: APIRequestContext);
|
|
7232
7819
|
/**
|
|
7233
7820
|
* Creates a Document.
|
|
@@ -7271,6 +7858,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7271
7858
|
get(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>): void;
|
|
7272
7859
|
get(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>): void;
|
|
7273
7860
|
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>): void;
|
|
7861
|
+
/**
|
|
7862
|
+
* Gets the parsed layout information for a Document.
|
|
7863
|
+
*
|
|
7864
|
+
* @param params - Parameters for request
|
|
7865
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7866
|
+
* @param callback - Optional callback that handles the response.
|
|
7867
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7868
|
+
*/
|
|
7869
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7870
|
+
getProcessedDocument(params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>;
|
|
7871
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7872
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>): void;
|
|
7873
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>): void;
|
|
7874
|
+
getProcessedDocument(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>): void;
|
|
7274
7875
|
/**
|
|
7275
7876
|
* Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
|
|
7276
7877
|
*
|
|
@@ -7354,6 +7955,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7354
7955
|
*/
|
|
7355
7956
|
name?: string;
|
|
7356
7957
|
}
|
|
7958
|
+
export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument extends StandardParameters {
|
|
7959
|
+
/**
|
|
7960
|
+
* Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.
|
|
7961
|
+
*/
|
|
7962
|
+
name?: string;
|
|
7963
|
+
/**
|
|
7964
|
+
* What format output should be. If unspecified, defaults to JSON.
|
|
7965
|
+
*/
|
|
7966
|
+
processedDocumentFormat?: string;
|
|
7967
|
+
/**
|
|
7968
|
+
* Required. What type of processing to return.
|
|
7969
|
+
*/
|
|
7970
|
+
processedDocumentType?: string;
|
|
7971
|
+
}
|
|
7357
7972
|
export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import extends StandardParameters {
|
|
7358
7973
|
/**
|
|
7359
7974
|
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission.
|
|
@@ -7387,6 +8002,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7387
8002
|
* 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.
|
|
7388
8003
|
*/
|
|
7389
8004
|
name?: string;
|
|
8005
|
+
/**
|
|
8006
|
+
* Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
|
|
8007
|
+
*/
|
|
8008
|
+
updateMask?: string;
|
|
7390
8009
|
/**
|
|
7391
8010
|
* Request body metadata
|
|
7392
8011
|
*/
|
|
@@ -7402,6 +8021,58 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7402
8021
|
*/
|
|
7403
8022
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest;
|
|
7404
8023
|
}
|
|
8024
|
+
export class Resource$Projects$Locations$Datastores$Branches$Documents$Chunks {
|
|
8025
|
+
context: APIRequestContext;
|
|
8026
|
+
constructor(context: APIRequestContext);
|
|
8027
|
+
/**
|
|
8028
|
+
* Gets a Document.
|
|
8029
|
+
*
|
|
8030
|
+
* @param params - Parameters for request
|
|
8031
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8032
|
+
* @param callback - Optional callback that handles the response.
|
|
8033
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
8034
|
+
*/
|
|
8035
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8036
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaChunk>;
|
|
8037
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8038
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>): void;
|
|
8039
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>): void;
|
|
8040
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>): void;
|
|
8041
|
+
/**
|
|
8042
|
+
* Gets a list of Chunks.
|
|
8043
|
+
*
|
|
8044
|
+
* @param params - Parameters for request
|
|
8045
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8046
|
+
* @param callback - Optional callback that handles the response.
|
|
8047
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
8048
|
+
*/
|
|
8049
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8050
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>;
|
|
8051
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8052
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>): void;
|
|
8053
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>): void;
|
|
8054
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>): void;
|
|
8055
|
+
}
|
|
8056
|
+
export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get extends StandardParameters {
|
|
8057
|
+
/**
|
|
8058
|
+
* Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned.
|
|
8059
|
+
*/
|
|
8060
|
+
name?: string;
|
|
8061
|
+
}
|
|
8062
|
+
export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List extends StandardParameters {
|
|
8063
|
+
/**
|
|
8064
|
+
* Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
|
8065
|
+
*/
|
|
8066
|
+
pageSize?: number;
|
|
8067
|
+
/**
|
|
8068
|
+
* A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
8069
|
+
*/
|
|
8070
|
+
pageToken?: string;
|
|
8071
|
+
/**
|
|
8072
|
+
* Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned.
|
|
8073
|
+
*/
|
|
8074
|
+
parent?: string;
|
|
8075
|
+
}
|
|
7405
8076
|
export class Resource$Projects$Locations$Datastores$Branches$Operations {
|
|
7406
8077
|
context: APIRequestContext;
|
|
7407
8078
|
constructor(context: APIRequestContext);
|
|
@@ -7935,7 +8606,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7935
8606
|
}
|
|
7936
8607
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
7937
8608
|
/**
|
|
7938
|
-
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/
|
|
8609
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
7939
8610
|
*/
|
|
7940
8611
|
name?: string;
|
|
7941
8612
|
}
|
|
@@ -7949,13 +8620,13 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7949
8620
|
*/
|
|
7950
8621
|
pageToken?: string;
|
|
7951
8622
|
/**
|
|
7952
|
-
* Required.
|
|
8623
|
+
* Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
7953
8624
|
*/
|
|
7954
8625
|
parent?: string;
|
|
7955
8626
|
}
|
|
7956
8627
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
7957
8628
|
/**
|
|
7958
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/
|
|
8629
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
7959
8630
|
*/
|
|
7960
8631
|
name?: string;
|
|
7961
8632
|
/**
|