@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/v1alpha.ts
CHANGED
|
@@ -241,6 +241,19 @@ export namespace discoveryengine_v1alpha {
|
|
|
241
241
|
*/
|
|
242
242
|
functionName?: string | null;
|
|
243
243
|
}
|
|
244
|
+
/**
|
|
245
|
+
* Access Control Configuration.
|
|
246
|
+
*/
|
|
247
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAclConfig {
|
|
248
|
+
/**
|
|
249
|
+
* Identity provider config.
|
|
250
|
+
*/
|
|
251
|
+
idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
252
|
+
/**
|
|
253
|
+
* Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
254
|
+
*/
|
|
255
|
+
name?: string | null;
|
|
256
|
+
}
|
|
244
257
|
/**
|
|
245
258
|
* AdditionalParams message for WidgetService methods for security and privacy enhancement.
|
|
246
259
|
*/
|
|
@@ -314,6 +327,44 @@ export namespace discoveryengine_v1alpha {
|
|
|
314
327
|
*/
|
|
315
328
|
tableId?: string | null;
|
|
316
329
|
}
|
|
330
|
+
/**
|
|
331
|
+
* Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.
|
|
332
|
+
*/
|
|
333
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaChunk {
|
|
334
|
+
/**
|
|
335
|
+
* Content is a string from a document (parsed content).
|
|
336
|
+
*/
|
|
337
|
+
content?: string | null;
|
|
338
|
+
/**
|
|
339
|
+
* Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
|
|
340
|
+
*/
|
|
341
|
+
derivedStructData?: {[key: string]: any} | null;
|
|
342
|
+
/**
|
|
343
|
+
* Metadata of the document from the current chunk.
|
|
344
|
+
*/
|
|
345
|
+
documentMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata;
|
|
346
|
+
/**
|
|
347
|
+
* Unique chunk id of the current chunk.
|
|
348
|
+
*/
|
|
349
|
+
id?: string | null;
|
|
350
|
+
/**
|
|
351
|
+
* 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.
|
|
352
|
+
*/
|
|
353
|
+
name?: string | null;
|
|
354
|
+
}
|
|
355
|
+
/**
|
|
356
|
+
* Document metadata contains the information of the document of the current chunk.
|
|
357
|
+
*/
|
|
358
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata {
|
|
359
|
+
/**
|
|
360
|
+
* Title of the document.
|
|
361
|
+
*/
|
|
362
|
+
title?: string | null;
|
|
363
|
+
/**
|
|
364
|
+
* Uri of the document.
|
|
365
|
+
*/
|
|
366
|
+
uri?: string | null;
|
|
367
|
+
}
|
|
317
368
|
/**
|
|
318
369
|
* Request message for CompletionService.CompleteQuery method.
|
|
319
370
|
*/
|
|
@@ -441,6 +492,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
441
492
|
* Request message for ConversationalSearchService.ConverseConversation method.
|
|
442
493
|
*/
|
|
443
494
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest {
|
|
495
|
+
/**
|
|
496
|
+
* 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)
|
|
497
|
+
*/
|
|
498
|
+
boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
444
499
|
/**
|
|
445
500
|
* The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
|
|
446
501
|
*/
|
|
@@ -586,6 +641,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
586
641
|
* DataStore captures global settings and configs at the DataStore level.
|
|
587
642
|
*/
|
|
588
643
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDataStore {
|
|
644
|
+
/**
|
|
645
|
+
* 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.
|
|
646
|
+
*/
|
|
647
|
+
aclEnabled?: boolean | null;
|
|
589
648
|
/**
|
|
590
649
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
591
650
|
*/
|
|
@@ -602,6 +661,14 @@ export namespace discoveryengine_v1alpha {
|
|
|
602
661
|
* Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
603
662
|
*/
|
|
604
663
|
displayName?: string | null;
|
|
664
|
+
/**
|
|
665
|
+
* Configuration for Document understanding and enrichment.
|
|
666
|
+
*/
|
|
667
|
+
documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
|
|
668
|
+
/**
|
|
669
|
+
* Output only. Data store level identity provider config.
|
|
670
|
+
*/
|
|
671
|
+
idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
605
672
|
/**
|
|
606
673
|
* Immutable. The industry vertical that the data store registers.
|
|
607
674
|
*/
|
|
@@ -614,6 +681,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
614
681
|
* The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
|
|
615
682
|
*/
|
|
616
683
|
solutionTypes?: string[] | null;
|
|
684
|
+
/**
|
|
685
|
+
* 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).
|
|
686
|
+
*/
|
|
687
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1alphaSchema;
|
|
617
688
|
}
|
|
618
689
|
/**
|
|
619
690
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -667,10 +738,6 @@ export namespace discoveryengine_v1alpha {
|
|
|
667
738
|
*/
|
|
668
739
|
updateTime?: string | null;
|
|
669
740
|
}
|
|
670
|
-
/**
|
|
671
|
-
* The digital parsing configurations for documents.
|
|
672
|
-
*/
|
|
673
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {}
|
|
674
741
|
/**
|
|
675
742
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
676
743
|
*/
|
|
@@ -696,6 +763,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
696
763
|
* Document captures all raw metadata information of items to be recommended or searched.
|
|
697
764
|
*/
|
|
698
765
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocument {
|
|
766
|
+
/**
|
|
767
|
+
* Access control information for the document.
|
|
768
|
+
*/
|
|
769
|
+
aclInfo?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfo;
|
|
699
770
|
/**
|
|
700
771
|
* The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
|
|
701
772
|
*/
|
|
@@ -708,6 +779,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
708
779
|
* Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
|
|
709
780
|
*/
|
|
710
781
|
id?: string | null;
|
|
782
|
+
/**
|
|
783
|
+
* 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.
|
|
784
|
+
*/
|
|
785
|
+
indexTime?: string | null;
|
|
711
786
|
/**
|
|
712
787
|
* The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
|
|
713
788
|
*/
|
|
@@ -729,6 +804,24 @@ export namespace discoveryengine_v1alpha {
|
|
|
729
804
|
*/
|
|
730
805
|
structData?: {[key: string]: any} | null;
|
|
731
806
|
}
|
|
807
|
+
/**
|
|
808
|
+
* ACL Information of the Document.
|
|
809
|
+
*/
|
|
810
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfo {
|
|
811
|
+
/**
|
|
812
|
+
* Readers of the document.
|
|
813
|
+
*/
|
|
814
|
+
readers?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction[];
|
|
815
|
+
}
|
|
816
|
+
/**
|
|
817
|
+
* 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" \} ], \} ] \} \}
|
|
818
|
+
*/
|
|
819
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction {
|
|
820
|
+
/**
|
|
821
|
+
* List of principals.
|
|
822
|
+
*/
|
|
823
|
+
principals?: Schema$GoogleCloudDiscoveryengineV1alphaPrincipal[];
|
|
824
|
+
}
|
|
732
825
|
/**
|
|
733
826
|
* Unstructured data linked to this document.
|
|
734
827
|
*/
|
|
@@ -775,6 +868,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
775
868
|
* 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.
|
|
776
869
|
*/
|
|
777
870
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
|
|
871
|
+
/**
|
|
872
|
+
* Whether chunking mode is enabled.
|
|
873
|
+
*/
|
|
874
|
+
chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig;
|
|
778
875
|
/**
|
|
779
876
|
* 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.
|
|
780
877
|
*/
|
|
@@ -784,11 +881,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
784
881
|
*/
|
|
785
882
|
name?: string | null;
|
|
786
883
|
/**
|
|
787
|
-
*
|
|
788
|
-
*/
|
|
789
|
-
ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
790
|
-
/**
|
|
791
|
-
* Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported.
|
|
884
|
+
* Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
|
|
792
885
|
*/
|
|
793
886
|
parsingConfigOverrides?: {
|
|
794
887
|
[
|
|
@@ -796,6 +889,28 @@ export namespace discoveryengine_v1alpha {
|
|
|
796
889
|
]: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
797
890
|
} | null;
|
|
798
891
|
}
|
|
892
|
+
/**
|
|
893
|
+
* Configuration for chunking config.
|
|
894
|
+
*/
|
|
895
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig {
|
|
896
|
+
/**
|
|
897
|
+
* Configuration for the layout based chunking.
|
|
898
|
+
*/
|
|
899
|
+
layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
|
|
900
|
+
}
|
|
901
|
+
/**
|
|
902
|
+
* Configuration for the layout based chunking.
|
|
903
|
+
*/
|
|
904
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
|
|
905
|
+
/**
|
|
906
|
+
* The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
|
|
907
|
+
*/
|
|
908
|
+
chunkSize?: number | null;
|
|
909
|
+
/**
|
|
910
|
+
* Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
|
|
911
|
+
*/
|
|
912
|
+
includeAncestorHeadings?: boolean | null;
|
|
913
|
+
}
|
|
799
914
|
/**
|
|
800
915
|
* Related configurations applied to a specific type of document parser.
|
|
801
916
|
*/
|
|
@@ -803,15 +918,36 @@ export namespace discoveryengine_v1alpha {
|
|
|
803
918
|
/**
|
|
804
919
|
* Configurations applied to digital parser.
|
|
805
920
|
*/
|
|
806
|
-
digitalParsingConfig?: Schema$
|
|
921
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig;
|
|
807
922
|
/**
|
|
808
923
|
* Configurations applied to layout parser.
|
|
809
924
|
*/
|
|
810
|
-
layoutParsingConfig?: Schema$
|
|
925
|
+
layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig;
|
|
811
926
|
/**
|
|
812
927
|
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
813
928
|
*/
|
|
814
|
-
ocrParsingConfig?: Schema$
|
|
929
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
930
|
+
}
|
|
931
|
+
/**
|
|
932
|
+
* The digital parsing configurations for documents.
|
|
933
|
+
*/
|
|
934
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
935
|
+
/**
|
|
936
|
+
* The layout parsing configurations for documents.
|
|
937
|
+
*/
|
|
938
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
|
|
939
|
+
/**
|
|
940
|
+
* The OCR parsing configurations for documents.
|
|
941
|
+
*/
|
|
942
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
943
|
+
/**
|
|
944
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
945
|
+
*/
|
|
946
|
+
enhancedDocumentElements?: string[] | null;
|
|
947
|
+
/**
|
|
948
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
949
|
+
*/
|
|
950
|
+
useNativeText?: boolean | null;
|
|
815
951
|
}
|
|
816
952
|
/**
|
|
817
953
|
* Double list.
|
|
@@ -1199,6 +1335,28 @@ export namespace discoveryengine_v1alpha {
|
|
|
1199
1335
|
*/
|
|
1200
1336
|
maxRelatedQuestions?: number | null;
|
|
1201
1337
|
}
|
|
1338
|
+
/**
|
|
1339
|
+
* Identity Provider Config.
|
|
1340
|
+
*/
|
|
1341
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig {
|
|
1342
|
+
/**
|
|
1343
|
+
* External Identity provider config.
|
|
1344
|
+
*/
|
|
1345
|
+
externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig;
|
|
1346
|
+
/**
|
|
1347
|
+
* Identity provider type configured.
|
|
1348
|
+
*/
|
|
1349
|
+
idpType?: string | null;
|
|
1350
|
+
}
|
|
1351
|
+
/**
|
|
1352
|
+
* Third party IDP Config.
|
|
1353
|
+
*/
|
|
1354
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig {
|
|
1355
|
+
/**
|
|
1356
|
+
* Workforce pool name. Example: "locations/global/workforcePools/pool_id"
|
|
1357
|
+
*/
|
|
1358
|
+
workforcePoolName?: string | null;
|
|
1359
|
+
}
|
|
1202
1360
|
/**
|
|
1203
1361
|
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1204
1362
|
*/
|
|
@@ -1430,9 +1588,18 @@ export namespace discoveryengine_v1alpha {
|
|
|
1430
1588
|
minimum?: number | null;
|
|
1431
1589
|
}
|
|
1432
1590
|
/**
|
|
1433
|
-
*
|
|
1591
|
+
* Response message for ChunkService.ListChunks method.
|
|
1434
1592
|
*/
|
|
1435
|
-
export interface Schema$
|
|
1593
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse {
|
|
1594
|
+
/**
|
|
1595
|
+
* The Chunks.
|
|
1596
|
+
*/
|
|
1597
|
+
chunks?: Schema$GoogleCloudDiscoveryengineV1alphaChunk[];
|
|
1598
|
+
/**
|
|
1599
|
+
* 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.
|
|
1600
|
+
*/
|
|
1601
|
+
nextPageToken?: string | null;
|
|
1602
|
+
}
|
|
1436
1603
|
/**
|
|
1437
1604
|
* Response for ListConversations method.
|
|
1438
1605
|
*/
|
|
@@ -1559,36 +1726,6 @@ export namespace discoveryengine_v1alpha {
|
|
|
1559
1726
|
*/
|
|
1560
1727
|
mediaProgressPercentage?: number | null;
|
|
1561
1728
|
}
|
|
1562
|
-
/**
|
|
1563
|
-
* The OCR options for parsing documents.
|
|
1564
|
-
*/
|
|
1565
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig {
|
|
1566
|
-
/**
|
|
1567
|
-
* 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.
|
|
1568
|
-
*/
|
|
1569
|
-
enabled?: boolean | null;
|
|
1570
|
-
/**
|
|
1571
|
-
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
1572
|
-
*/
|
|
1573
|
-
enhancedDocumentElements?: string[] | null;
|
|
1574
|
-
/**
|
|
1575
|
-
* If true, will use native text instead of OCR text on pages containing native text.
|
|
1576
|
-
*/
|
|
1577
|
-
useNativeText?: boolean | null;
|
|
1578
|
-
}
|
|
1579
|
-
/**
|
|
1580
|
-
* The OCR parsing configurations for documents.
|
|
1581
|
-
*/
|
|
1582
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig {
|
|
1583
|
-
/**
|
|
1584
|
-
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
1585
|
-
*/
|
|
1586
|
-
enhancedDocumentElements?: string[] | null;
|
|
1587
|
-
/**
|
|
1588
|
-
* If true, will use native text instead of OCR text on pages containing native text.
|
|
1589
|
-
*/
|
|
1590
|
-
useNativeText?: boolean | null;
|
|
1591
|
-
}
|
|
1592
1729
|
/**
|
|
1593
1730
|
* Detailed page information.
|
|
1594
1731
|
*/
|
|
@@ -1635,6 +1772,32 @@ export namespace discoveryengine_v1alpha {
|
|
|
1635
1772
|
* Request for pausing training of an engine.
|
|
1636
1773
|
*/
|
|
1637
1774
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaPauseEngineRequest {}
|
|
1775
|
+
/**
|
|
1776
|
+
* Principal identifier of a user or a group.
|
|
1777
|
+
*/
|
|
1778
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPrincipal {
|
|
1779
|
+
/**
|
|
1780
|
+
* 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.
|
|
1781
|
+
*/
|
|
1782
|
+
groupId?: string | null;
|
|
1783
|
+
/**
|
|
1784
|
+
* 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.
|
|
1785
|
+
*/
|
|
1786
|
+
userId?: string | null;
|
|
1787
|
+
}
|
|
1788
|
+
/**
|
|
1789
|
+
* Document captures all raw metadata information of items to be recommended or searched.
|
|
1790
|
+
*/
|
|
1791
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument {
|
|
1792
|
+
/**
|
|
1793
|
+
* Required. Full resource name of the referenced document, in the format `projects/x/locations/x/collections/x/dataStores/x/branches/x/documents/x`.
|
|
1794
|
+
*/
|
|
1795
|
+
document?: string | null;
|
|
1796
|
+
/**
|
|
1797
|
+
* The JSON string representation of the processed document.
|
|
1798
|
+
*/
|
|
1799
|
+
jsonData?: string | null;
|
|
1800
|
+
}
|
|
1638
1801
|
/**
|
|
1639
1802
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1640
1803
|
*/
|
|
@@ -1647,6 +1810,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
1647
1810
|
* Count of entries that encountered errors while processing.
|
|
1648
1811
|
*/
|
|
1649
1812
|
failureCount?: string | null;
|
|
1813
|
+
/**
|
|
1814
|
+
* Count of entries that were ignored as entries were not found.
|
|
1815
|
+
*/
|
|
1816
|
+
ignoredCount?: string | null;
|
|
1650
1817
|
/**
|
|
1651
1818
|
* Count of entries that were deleted successfully.
|
|
1652
1819
|
*/
|
|
@@ -1660,6 +1827,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
1660
1827
|
* Request message for DocumentService.PurgeDocuments method.
|
|
1661
1828
|
*/
|
|
1662
1829
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest {
|
|
1830
|
+
/**
|
|
1831
|
+
* The desired location of errors incurred during the purge.
|
|
1832
|
+
*/
|
|
1833
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig;
|
|
1663
1834
|
/**
|
|
1664
1835
|
* Required. Filter matching documents to purge. Only currently supported value is `*` (all items).
|
|
1665
1836
|
*/
|
|
@@ -1668,6 +1839,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
1668
1839
|
* Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.
|
|
1669
1840
|
*/
|
|
1670
1841
|
force?: boolean | null;
|
|
1842
|
+
/**
|
|
1843
|
+
* Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line.
|
|
1844
|
+
*/
|
|
1845
|
+
gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource;
|
|
1671
1846
|
}
|
|
1672
1847
|
/**
|
|
1673
1848
|
* Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
|
|
@@ -1682,6 +1857,15 @@ export namespace discoveryengine_v1alpha {
|
|
|
1682
1857
|
*/
|
|
1683
1858
|
purgeSample?: string[] | null;
|
|
1684
1859
|
}
|
|
1860
|
+
/**
|
|
1861
|
+
* Configuration of destination for Purge related errors.
|
|
1862
|
+
*/
|
|
1863
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig {
|
|
1864
|
+
/**
|
|
1865
|
+
* 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.
|
|
1866
|
+
*/
|
|
1867
|
+
gcsPrefix?: string | null;
|
|
1868
|
+
}
|
|
1685
1869
|
/**
|
|
1686
1870
|
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1687
1871
|
*/
|
|
@@ -2003,6 +2187,14 @@ export namespace discoveryengine_v1alpha {
|
|
|
2003
2187
|
* A specification for configuring the behavior of content search.
|
|
2004
2188
|
*/
|
|
2005
2189
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
2190
|
+
/**
|
|
2191
|
+
* Custom fine tuning configs.
|
|
2192
|
+
*/
|
|
2193
|
+
customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
2194
|
+
/**
|
|
2195
|
+
* A list of data store specs to apply on a search call.
|
|
2196
|
+
*/
|
|
2197
|
+
dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
2006
2198
|
/**
|
|
2007
2199
|
* Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
|
|
2008
2200
|
*/
|
|
@@ -2090,11 +2282,11 @@ export namespace discoveryengine_v1alpha {
|
|
|
2090
2282
|
*/
|
|
2091
2283
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec {
|
|
2092
2284
|
/**
|
|
2093
|
-
* 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.
|
|
2285
|
+
* 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.
|
|
2094
2286
|
*/
|
|
2095
2287
|
boost?: number | null;
|
|
2096
2288
|
/**
|
|
2097
|
-
* An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue":
|
|
2289
|
+
* An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
|
|
2098
2290
|
*/
|
|
2099
2291
|
condition?: string | null;
|
|
2100
2292
|
}
|
|
@@ -2106,6 +2298,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
2106
2298
|
* If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
|
|
2107
2299
|
*/
|
|
2108
2300
|
extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
2301
|
+
/**
|
|
2302
|
+
* 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`.
|
|
2303
|
+
*/
|
|
2304
|
+
searchResultMode?: string | null;
|
|
2109
2305
|
/**
|
|
2110
2306
|
* If `snippetSpec` is not specified, snippets are not included in the search response.
|
|
2111
2307
|
*/
|
|
@@ -2135,6 +2331,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
2135
2331
|
* Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
|
|
2136
2332
|
*/
|
|
2137
2333
|
numPreviousSegments?: number | null;
|
|
2334
|
+
/**
|
|
2335
|
+
* 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`.
|
|
2336
|
+
*/
|
|
2337
|
+
returnExtractiveSegmentScore?: boolean | null;
|
|
2138
2338
|
}
|
|
2139
2339
|
/**
|
|
2140
2340
|
* A specification for configuring snippets in a search response.
|
|
@@ -2182,9 +2382,13 @@ export namespace discoveryengine_v1alpha {
|
|
|
2182
2382
|
*/
|
|
2183
2383
|
modelSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec;
|
|
2184
2384
|
/**
|
|
2185
|
-
* 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
|
|
2385
|
+
* 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.
|
|
2186
2386
|
*/
|
|
2187
2387
|
summaryResultCount?: number | null;
|
|
2388
|
+
/**
|
|
2389
|
+
* 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.
|
|
2390
|
+
*/
|
|
2391
|
+
useSemanticChunks?: boolean | null;
|
|
2188
2392
|
}
|
|
2189
2393
|
/**
|
|
2190
2394
|
* Specification of the prompt to use with the model.
|
|
@@ -2200,10 +2404,19 @@ export namespace discoveryengine_v1alpha {
|
|
|
2200
2404
|
*/
|
|
2201
2405
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
2202
2406
|
/**
|
|
2203
|
-
* The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned
|
|
2407
|
+
* 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).
|
|
2204
2408
|
*/
|
|
2205
2409
|
version?: string | null;
|
|
2206
2410
|
}
|
|
2411
|
+
/**
|
|
2412
|
+
* A struct to define data stores to filter on in a search call.
|
|
2413
|
+
*/
|
|
2414
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
|
|
2415
|
+
/**
|
|
2416
|
+
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`.
|
|
2417
|
+
*/
|
|
2418
|
+
dataStore?: string | null;
|
|
2419
|
+
}
|
|
2207
2420
|
/**
|
|
2208
2421
|
* The specification that uses customized query embedding vector to do semantic document retrieval.
|
|
2209
2422
|
*/
|
|
@@ -2451,6 +2664,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
2451
2664
|
* Represents the search results.
|
|
2452
2665
|
*/
|
|
2453
2666
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult {
|
|
2667
|
+
/**
|
|
2668
|
+
* The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
|
|
2669
|
+
*/
|
|
2670
|
+
chunk?: Schema$GoogleCloudDiscoveryengineV1alphaChunk;
|
|
2454
2671
|
/**
|
|
2455
2672
|
* The document data snippet in the search response. Only fields that are marked as retrievable are populated.
|
|
2456
2673
|
*/
|
|
@@ -2482,6 +2699,9 @@ export namespace discoveryengine_v1alpha {
|
|
|
2482
2699
|
* The summary content.
|
|
2483
2700
|
*/
|
|
2484
2701
|
summaryText?: string | null;
|
|
2702
|
+
/**
|
|
2703
|
+
* Summary with metadata information.
|
|
2704
|
+
*/
|
|
2485
2705
|
summaryWithMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata;
|
|
2486
2706
|
}
|
|
2487
2707
|
/**
|
|
@@ -2623,13 +2843,16 @@ export namespace discoveryengine_v1alpha {
|
|
|
2623
2843
|
*/
|
|
2624
2844
|
modelId?: string | null;
|
|
2625
2845
|
/**
|
|
2626
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/
|
|
2846
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
2627
2847
|
*/
|
|
2628
2848
|
name?: string | null;
|
|
2629
2849
|
/**
|
|
2630
2850
|
* Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
2631
2851
|
*/
|
|
2632
2852
|
onewaySynonymsControlIds?: string[] | null;
|
|
2853
|
+
/**
|
|
2854
|
+
* 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).
|
|
2855
|
+
*/
|
|
2633
2856
|
rankingExpression?: string | null;
|
|
2634
2857
|
/**
|
|
2635
2858
|
* 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.
|
|
@@ -2669,10 +2892,6 @@ export namespace discoveryengine_v1alpha {
|
|
|
2669
2892
|
* Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
|
|
2670
2893
|
*/
|
|
2671
2894
|
contentFreshnessCutoffDays?: number | null;
|
|
2672
|
-
/**
|
|
2673
|
-
* Specifies the content watched minutes threshold for demotion.
|
|
2674
|
-
*/
|
|
2675
|
-
contentWatchedMinutesThreshold?: number | null;
|
|
2676
2895
|
/**
|
|
2677
2896
|
* Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
|
|
2678
2897
|
*/
|
|
@@ -2771,6 +2990,9 @@ export namespace discoveryengine_v1alpha {
|
|
|
2771
2990
|
*/
|
|
2772
2991
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
2773
2992
|
}
|
|
2993
|
+
/**
|
|
2994
|
+
* Failed due to insufficient quota.
|
|
2995
|
+
*/
|
|
2774
2996
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
2775
2997
|
/**
|
|
2776
2998
|
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
@@ -2825,11 +3047,11 @@ export namespace discoveryengine_v1alpha {
|
|
|
2825
3047
|
*/
|
|
2826
3048
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput {
|
|
2827
3049
|
/**
|
|
2828
|
-
* The Cloud Storage corpus data which could be associated in train data. The data path format is gs
|
|
3050
|
+
* 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"\}`
|
|
2829
3051
|
*/
|
|
2830
3052
|
corpusDataPath?: string | null;
|
|
2831
3053
|
/**
|
|
2832
|
-
* The gcs query data which could be associated in train data. The data path format is gs
|
|
3054
|
+
* 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"\}
|
|
2833
3055
|
*/
|
|
2834
3056
|
queryDataPath?: string | null;
|
|
2835
3057
|
/**
|
|
@@ -2837,7 +3059,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
2837
3059
|
*/
|
|
2838
3060
|
testDataPath?: string | null;
|
|
2839
3061
|
/**
|
|
2840
|
-
* Cloud Storage training data path whose format should be gs
|
|
3062
|
+
* 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`
|
|
2841
3063
|
*/
|
|
2842
3064
|
trainDataPath?: string | null;
|
|
2843
3065
|
}
|
|
@@ -3073,6 +3295,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
3073
3295
|
* 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.
|
|
3074
3296
|
*/
|
|
3075
3297
|
allowPublicAccess?: boolean | null;
|
|
3298
|
+
/**
|
|
3299
|
+
* 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.
|
|
3300
|
+
*/
|
|
3301
|
+
collectionComponents?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent[];
|
|
3076
3302
|
/**
|
|
3077
3303
|
* Output only. Unique obfuscated identifier of a WidgetConfig.
|
|
3078
3304
|
*/
|
|
@@ -3089,6 +3315,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
3089
3315
|
* Output only. The type of the parent data store.
|
|
3090
3316
|
*/
|
|
3091
3317
|
dataStoreType?: string | null;
|
|
3318
|
+
/**
|
|
3319
|
+
* Configurable UI configurations per data store.
|
|
3320
|
+
*/
|
|
3321
|
+
dataStoreUiConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig[];
|
|
3092
3322
|
/**
|
|
3093
3323
|
* 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.
|
|
3094
3324
|
*/
|
|
@@ -3121,6 +3351,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
3121
3351
|
* Turn on or off summarization for the search response.
|
|
3122
3352
|
*/
|
|
3123
3353
|
enableSummarization?: boolean | null;
|
|
3354
|
+
/**
|
|
3355
|
+
* Whether to enable standalone web app.
|
|
3356
|
+
*/
|
|
3357
|
+
enableWebApp?: boolean | null;
|
|
3124
3358
|
/**
|
|
3125
3359
|
* The configuration and appearance of facets in the end user view.
|
|
3126
3360
|
*/
|
|
@@ -3162,6 +3396,69 @@ export namespace discoveryengine_v1alpha {
|
|
|
3162
3396
|
*/
|
|
3163
3397
|
updateTime?: string | null;
|
|
3164
3398
|
}
|
|
3399
|
+
/**
|
|
3400
|
+
* Read-only collection component that contains data store collections fields that may be used for filtering
|
|
3401
|
+
*/
|
|
3402
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent {
|
|
3403
|
+
/**
|
|
3404
|
+
* For the data store collection, list of the children data stores.
|
|
3405
|
+
*/
|
|
3406
|
+
dataStoreComponents?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent[];
|
|
3407
|
+
/**
|
|
3408
|
+
* The display name of the collection.
|
|
3409
|
+
*/
|
|
3410
|
+
displayName?: string | null;
|
|
3411
|
+
/**
|
|
3412
|
+
* 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.
|
|
3413
|
+
*/
|
|
3414
|
+
id?: string | null;
|
|
3415
|
+
/**
|
|
3416
|
+
* 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.
|
|
3417
|
+
*/
|
|
3418
|
+
name?: string | null;
|
|
3419
|
+
}
|
|
3420
|
+
/**
|
|
3421
|
+
* Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.
|
|
3422
|
+
*/
|
|
3423
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent {
|
|
3424
|
+
/**
|
|
3425
|
+
* The display name of the data store.
|
|
3426
|
+
*/
|
|
3427
|
+
displayName?: string | null;
|
|
3428
|
+
/**
|
|
3429
|
+
* 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.
|
|
3430
|
+
*/
|
|
3431
|
+
id?: string | null;
|
|
3432
|
+
/**
|
|
3433
|
+
* 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.
|
|
3434
|
+
*/
|
|
3435
|
+
name?: string | null;
|
|
3436
|
+
}
|
|
3437
|
+
/**
|
|
3438
|
+
* UI component configuration for data store.
|
|
3439
|
+
*/
|
|
3440
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig {
|
|
3441
|
+
/**
|
|
3442
|
+
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
3443
|
+
*/
|
|
3444
|
+
facetField?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
|
|
3445
|
+
/**
|
|
3446
|
+
* 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.
|
|
3447
|
+
*/
|
|
3448
|
+
fieldsUiComponentsMap?: {
|
|
3449
|
+
[
|
|
3450
|
+
key: string
|
|
3451
|
+
]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
3452
|
+
} | null;
|
|
3453
|
+
/**
|
|
3454
|
+
* 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.
|
|
3455
|
+
*/
|
|
3456
|
+
id?: string | null;
|
|
3457
|
+
/**
|
|
3458
|
+
* 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.
|
|
3459
|
+
*/
|
|
3460
|
+
name?: string | null;
|
|
3461
|
+
}
|
|
3165
3462
|
/**
|
|
3166
3463
|
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
3167
3464
|
*/
|
|
@@ -3376,6 +3673,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
3376
3673
|
* Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3377
3674
|
*/
|
|
3378
3675
|
displayName?: string | null;
|
|
3676
|
+
/**
|
|
3677
|
+
* Configuration for Document understanding and enrichment.
|
|
3678
|
+
*/
|
|
3679
|
+
documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig;
|
|
3379
3680
|
/**
|
|
3380
3681
|
* Immutable. The industry vertical that the data store registers.
|
|
3381
3682
|
*/
|
|
@@ -3388,7 +3689,11 @@ export namespace discoveryengine_v1alpha {
|
|
|
3388
3689
|
* The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
|
|
3389
3690
|
*/
|
|
3390
3691
|
solutionTypes?: string[] | null;
|
|
3391
|
-
|
|
3692
|
+
/**
|
|
3693
|
+
* 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).
|
|
3694
|
+
*/
|
|
3695
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema;
|
|
3696
|
+
}
|
|
3392
3697
|
/**
|
|
3393
3698
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3394
3699
|
*/
|
|
@@ -3458,6 +3763,57 @@ export namespace discoveryengine_v1alpha {
|
|
|
3458
3763
|
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
3459
3764
|
*/
|
|
3460
3765
|
export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {}
|
|
3766
|
+
/**
|
|
3767
|
+
* 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.
|
|
3768
|
+
*/
|
|
3769
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
|
|
3770
|
+
/**
|
|
3771
|
+
* 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.
|
|
3772
|
+
*/
|
|
3773
|
+
defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
3774
|
+
/**
|
|
3775
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
3776
|
+
*/
|
|
3777
|
+
name?: string | null;
|
|
3778
|
+
/**
|
|
3779
|
+
* 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.
|
|
3780
|
+
*/
|
|
3781
|
+
parsingConfigOverrides?: {
|
|
3782
|
+
[
|
|
3783
|
+
key: string
|
|
3784
|
+
]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
3785
|
+
} | null;
|
|
3786
|
+
}
|
|
3787
|
+
/**
|
|
3788
|
+
* Related configurations applied to a specific type of document parser.
|
|
3789
|
+
*/
|
|
3790
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
|
|
3791
|
+
/**
|
|
3792
|
+
* Configurations applied to digital parser.
|
|
3793
|
+
*/
|
|
3794
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig;
|
|
3795
|
+
/**
|
|
3796
|
+
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
3797
|
+
*/
|
|
3798
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
3799
|
+
}
|
|
3800
|
+
/**
|
|
3801
|
+
* The digital parsing configurations for documents.
|
|
3802
|
+
*/
|
|
3803
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
3804
|
+
/**
|
|
3805
|
+
* The OCR parsing configurations for documents.
|
|
3806
|
+
*/
|
|
3807
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
3808
|
+
/**
|
|
3809
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
3810
|
+
*/
|
|
3811
|
+
enhancedDocumentElements?: string[] | null;
|
|
3812
|
+
/**
|
|
3813
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
3814
|
+
*/
|
|
3815
|
+
useNativeText?: boolean | null;
|
|
3816
|
+
}
|
|
3461
3817
|
/**
|
|
3462
3818
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3463
3819
|
*/
|
|
@@ -3716,6 +4072,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
3716
4072
|
* Count of entries that encountered errors while processing.
|
|
3717
4073
|
*/
|
|
3718
4074
|
failureCount?: string | null;
|
|
4075
|
+
/**
|
|
4076
|
+
* Count of entries that were ignored as entries were not found.
|
|
4077
|
+
*/
|
|
4078
|
+
ignoredCount?: string | null;
|
|
3719
4079
|
/**
|
|
3720
4080
|
* Count of entries that were deleted successfully.
|
|
3721
4081
|
*/
|
|
@@ -3844,12 +4204,45 @@ export namespace discoveryengine_v1alpha {
|
|
|
3844
4204
|
*/
|
|
3845
4205
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure;
|
|
3846
4206
|
}
|
|
4207
|
+
/**
|
|
4208
|
+
* Failed due to insufficient quota.
|
|
4209
|
+
*/
|
|
3847
4210
|
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure {
|
|
3848
4211
|
/**
|
|
3849
4212
|
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
3850
4213
|
*/
|
|
3851
4214
|
totalRequiredQuota?: string | null;
|
|
3852
4215
|
}
|
|
4216
|
+
/**
|
|
4217
|
+
* Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
4218
|
+
*/
|
|
4219
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata {
|
|
4220
|
+
/**
|
|
4221
|
+
* Operation create time.
|
|
4222
|
+
*/
|
|
4223
|
+
createTime?: string | null;
|
|
4224
|
+
/**
|
|
4225
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4226
|
+
*/
|
|
4227
|
+
updateTime?: string | null;
|
|
4228
|
+
}
|
|
4229
|
+
/**
|
|
4230
|
+
* Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.
|
|
4231
|
+
*/
|
|
4232
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse {
|
|
4233
|
+
/**
|
|
4234
|
+
* Echoes the destination for the complete errors in the request if set.
|
|
4235
|
+
*/
|
|
4236
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
4237
|
+
/**
|
|
4238
|
+
* A sample of errors encountered while processing the data.
|
|
4239
|
+
*/
|
|
4240
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4241
|
+
/**
|
|
4242
|
+
* 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.
|
|
4243
|
+
*/
|
|
4244
|
+
modelStatus?: string | null;
|
|
4245
|
+
}
|
|
3853
4246
|
/**
|
|
3854
4247
|
* Metadata for UpdateSchema LRO.
|
|
3855
4248
|
*/
|
|
@@ -3948,6 +4341,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
3948
4341
|
* Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3949
4342
|
*/
|
|
3950
4343
|
displayName?: string | null;
|
|
4344
|
+
/**
|
|
4345
|
+
* Configuration for Document understanding and enrichment.
|
|
4346
|
+
*/
|
|
4347
|
+
documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig;
|
|
3951
4348
|
/**
|
|
3952
4349
|
* Immutable. The industry vertical that the data store registers.
|
|
3953
4350
|
*/
|
|
@@ -3960,6 +4357,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
3960
4357
|
* The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
|
|
3961
4358
|
*/
|
|
3962
4359
|
solutionTypes?: string[] | null;
|
|
4360
|
+
/**
|
|
4361
|
+
* 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).
|
|
4362
|
+
*/
|
|
4363
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema;
|
|
3963
4364
|
}
|
|
3964
4365
|
/**
|
|
3965
4366
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -4030,6 +4431,57 @@ export namespace discoveryengine_v1alpha {
|
|
|
4030
4431
|
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
4031
4432
|
*/
|
|
4032
4433
|
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {}
|
|
4434
|
+
/**
|
|
4435
|
+
* 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.
|
|
4436
|
+
*/
|
|
4437
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
|
|
4438
|
+
/**
|
|
4439
|
+
* 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.
|
|
4440
|
+
*/
|
|
4441
|
+
defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
4442
|
+
/**
|
|
4443
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
4444
|
+
*/
|
|
4445
|
+
name?: string | null;
|
|
4446
|
+
/**
|
|
4447
|
+
* 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.
|
|
4448
|
+
*/
|
|
4449
|
+
parsingConfigOverrides?: {
|
|
4450
|
+
[
|
|
4451
|
+
key: string
|
|
4452
|
+
]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
4453
|
+
} | null;
|
|
4454
|
+
}
|
|
4455
|
+
/**
|
|
4456
|
+
* Related configurations applied to a specific type of document parser.
|
|
4457
|
+
*/
|
|
4458
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
|
|
4459
|
+
/**
|
|
4460
|
+
* Configurations applied to digital parser.
|
|
4461
|
+
*/
|
|
4462
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig;
|
|
4463
|
+
/**
|
|
4464
|
+
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
4465
|
+
*/
|
|
4466
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
4467
|
+
}
|
|
4468
|
+
/**
|
|
4469
|
+
* The digital parsing configurations for documents.
|
|
4470
|
+
*/
|
|
4471
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
4472
|
+
/**
|
|
4473
|
+
* The OCR parsing configurations for documents.
|
|
4474
|
+
*/
|
|
4475
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
4476
|
+
/**
|
|
4477
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
4478
|
+
*/
|
|
4479
|
+
enhancedDocumentElements?: string[] | null;
|
|
4480
|
+
/**
|
|
4481
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
4482
|
+
*/
|
|
4483
|
+
useNativeText?: boolean | null;
|
|
4484
|
+
}
|
|
4033
4485
|
/**
|
|
4034
4486
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4035
4487
|
*/
|
|
@@ -4288,6 +4740,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
4288
4740
|
* Count of entries that encountered errors while processing.
|
|
4289
4741
|
*/
|
|
4290
4742
|
failureCount?: string | null;
|
|
4743
|
+
/**
|
|
4744
|
+
* Count of entries that were ignored as entries were not found.
|
|
4745
|
+
*/
|
|
4746
|
+
ignoredCount?: string | null;
|
|
4291
4747
|
/**
|
|
4292
4748
|
* Count of entries that were deleted successfully.
|
|
4293
4749
|
*/
|
|
@@ -4416,6 +4872,9 @@ export namespace discoveryengine_v1alpha {
|
|
|
4416
4872
|
*/
|
|
4417
4873
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure;
|
|
4418
4874
|
}
|
|
4875
|
+
/**
|
|
4876
|
+
* Failed due to insufficient quota.
|
|
4877
|
+
*/
|
|
4419
4878
|
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure {
|
|
4420
4879
|
/**
|
|
4421
4880
|
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
@@ -5091,121 +5550,66 @@ export namespace discoveryengine_v1alpha {
|
|
|
5091
5550
|
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
5092
5551
|
}
|
|
5093
5552
|
}
|
|
5094
|
-
}
|
|
5095
|
-
|
|
5096
|
-
export interface Params$Resource$Projects$Locations$Estimatedatasize
|
|
5097
|
-
extends StandardParameters {
|
|
5098
|
-
/**
|
|
5099
|
-
* Required. Full resource name of the location, such as `projects/{project\}/locations/{location\}`.
|
|
5100
|
-
*/
|
|
5101
|
-
location?: string;
|
|
5102
|
-
|
|
5103
|
-
/**
|
|
5104
|
-
* Request body metadata
|
|
5105
|
-
*/
|
|
5106
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest;
|
|
5107
|
-
}
|
|
5108
|
-
|
|
5109
|
-
export class Resource$Projects$Locations$Collections {
|
|
5110
|
-
context: APIRequestContext;
|
|
5111
|
-
dataConnector: Resource$Projects$Locations$Collections$Dataconnector;
|
|
5112
|
-
dataStores: Resource$Projects$Locations$Collections$Datastores;
|
|
5113
|
-
engines: Resource$Projects$Locations$Collections$Engines;
|
|
5114
|
-
operations: Resource$Projects$Locations$Collections$Operations;
|
|
5115
|
-
constructor(context: APIRequestContext) {
|
|
5116
|
-
this.context = context;
|
|
5117
|
-
this.dataConnector =
|
|
5118
|
-
new Resource$Projects$Locations$Collections$Dataconnector(this.context);
|
|
5119
|
-
this.dataStores = new Resource$Projects$Locations$Collections$Datastores(
|
|
5120
|
-
this.context
|
|
5121
|
-
);
|
|
5122
|
-
this.engines = new Resource$Projects$Locations$Collections$Engines(
|
|
5123
|
-
this.context
|
|
5124
|
-
);
|
|
5125
|
-
this.operations = new Resource$Projects$Locations$Collections$Operations(
|
|
5126
|
-
this.context
|
|
5127
|
-
);
|
|
5128
|
-
}
|
|
5129
|
-
}
|
|
5130
|
-
|
|
5131
|
-
export class Resource$Projects$Locations$Collections$Dataconnector {
|
|
5132
|
-
context: APIRequestContext;
|
|
5133
|
-
operations: Resource$Projects$Locations$Collections$Dataconnector$Operations;
|
|
5134
|
-
constructor(context: APIRequestContext) {
|
|
5135
|
-
this.context = context;
|
|
5136
|
-
this.operations =
|
|
5137
|
-
new Resource$Projects$Locations$Collections$Dataconnector$Operations(
|
|
5138
|
-
this.context
|
|
5139
|
-
);
|
|
5140
|
-
}
|
|
5141
|
-
}
|
|
5142
|
-
|
|
5143
|
-
export class Resource$Projects$Locations$Collections$Dataconnector$Operations {
|
|
5144
|
-
context: APIRequestContext;
|
|
5145
|
-
constructor(context: APIRequestContext) {
|
|
5146
|
-
this.context = context;
|
|
5147
|
-
}
|
|
5148
5553
|
|
|
5149
5554
|
/**
|
|
5150
|
-
* Gets the
|
|
5555
|
+
* Gets the AclConfig.
|
|
5151
5556
|
*
|
|
5152
5557
|
* @param params - Parameters for request
|
|
5153
5558
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5154
5559
|
* @param callback - Optional callback that handles the response.
|
|
5155
5560
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5156
5561
|
*/
|
|
5157
|
-
|
|
5158
|
-
params: Params$Resource$Projects$Locations$
|
|
5562
|
+
getAclConfig(
|
|
5563
|
+
params: Params$Resource$Projects$Locations$Getaclconfig,
|
|
5159
5564
|
options: StreamMethodOptions
|
|
5160
5565
|
): GaxiosPromise<Readable>;
|
|
5161
|
-
|
|
5162
|
-
params?: Params$Resource$Projects$Locations$
|
|
5566
|
+
getAclConfig(
|
|
5567
|
+
params?: Params$Resource$Projects$Locations$Getaclconfig,
|
|
5163
5568
|
options?: MethodOptions
|
|
5164
|
-
): GaxiosPromise<Schema$
|
|
5165
|
-
|
|
5166
|
-
params: Params$Resource$Projects$Locations$
|
|
5569
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>;
|
|
5570
|
+
getAclConfig(
|
|
5571
|
+
params: Params$Resource$Projects$Locations$Getaclconfig,
|
|
5167
5572
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5168
5573
|
callback: BodyResponseCallback<Readable>
|
|
5169
5574
|
): void;
|
|
5170
|
-
|
|
5171
|
-
params: Params$Resource$Projects$Locations$
|
|
5575
|
+
getAclConfig(
|
|
5576
|
+
params: Params$Resource$Projects$Locations$Getaclconfig,
|
|
5172
5577
|
options:
|
|
5173
5578
|
| MethodOptions
|
|
5174
|
-
| BodyResponseCallback<Schema$
|
|
5175
|
-
callback: BodyResponseCallback<Schema$
|
|
5579
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>,
|
|
5580
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5176
5581
|
): void;
|
|
5177
|
-
|
|
5178
|
-
params: Params$Resource$Projects$Locations$
|
|
5179
|
-
callback: BodyResponseCallback<Schema$
|
|
5582
|
+
getAclConfig(
|
|
5583
|
+
params: Params$Resource$Projects$Locations$Getaclconfig,
|
|
5584
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5180
5585
|
): void;
|
|
5181
|
-
|
|
5182
|
-
callback: BodyResponseCallback<Schema$
|
|
5586
|
+
getAclConfig(
|
|
5587
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5183
5588
|
): void;
|
|
5184
|
-
|
|
5589
|
+
getAclConfig(
|
|
5185
5590
|
paramsOrCallback?:
|
|
5186
|
-
| Params$Resource$Projects$Locations$
|
|
5187
|
-
| BodyResponseCallback<Schema$
|
|
5591
|
+
| Params$Resource$Projects$Locations$Getaclconfig
|
|
5592
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5188
5593
|
| BodyResponseCallback<Readable>,
|
|
5189
5594
|
optionsOrCallback?:
|
|
5190
5595
|
| MethodOptions
|
|
5191
5596
|
| StreamMethodOptions
|
|
5192
|
-
| BodyResponseCallback<Schema$
|
|
5597
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5193
5598
|
| BodyResponseCallback<Readable>,
|
|
5194
5599
|
callback?:
|
|
5195
|
-
| BodyResponseCallback<Schema$
|
|
5600
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5196
5601
|
| BodyResponseCallback<Readable>
|
|
5197
5602
|
):
|
|
5198
5603
|
| void
|
|
5199
|
-
| GaxiosPromise<Schema$
|
|
5604
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5200
5605
|
| GaxiosPromise<Readable> {
|
|
5201
5606
|
let params = (paramsOrCallback ||
|
|
5202
|
-
{}) as Params$Resource$Projects$Locations$
|
|
5607
|
+
{}) as Params$Resource$Projects$Locations$Getaclconfig;
|
|
5203
5608
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5204
5609
|
|
|
5205
5610
|
if (typeof paramsOrCallback === 'function') {
|
|
5206
5611
|
callback = paramsOrCallback;
|
|
5207
|
-
params =
|
|
5208
|
-
{} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get;
|
|
5612
|
+
params = {} as Params$Resource$Projects$Locations$Getaclconfig;
|
|
5209
5613
|
options = {};
|
|
5210
5614
|
}
|
|
5211
5615
|
|
|
@@ -5230,75 +5634,76 @@ export namespace discoveryengine_v1alpha {
|
|
|
5230
5634
|
context: this.context,
|
|
5231
5635
|
};
|
|
5232
5636
|
if (callback) {
|
|
5233
|
-
createAPIRequest<Schema$
|
|
5637
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>(
|
|
5234
5638
|
parameters,
|
|
5235
5639
|
callback as BodyResponseCallback<unknown>
|
|
5236
5640
|
);
|
|
5237
5641
|
} else {
|
|
5238
|
-
return createAPIRequest<Schema$
|
|
5642
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>(
|
|
5643
|
+
parameters
|
|
5644
|
+
);
|
|
5239
5645
|
}
|
|
5240
5646
|
}
|
|
5241
5647
|
|
|
5242
5648
|
/**
|
|
5243
|
-
*
|
|
5649
|
+
* 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.
|
|
5244
5650
|
*
|
|
5245
5651
|
* @param params - Parameters for request
|
|
5246
5652
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5247
5653
|
* @param callback - Optional callback that handles the response.
|
|
5248
5654
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5249
5655
|
*/
|
|
5250
|
-
|
|
5251
|
-
params: Params$Resource$Projects$Locations$
|
|
5656
|
+
updateAclConfig(
|
|
5657
|
+
params: Params$Resource$Projects$Locations$Updateaclconfig,
|
|
5252
5658
|
options: StreamMethodOptions
|
|
5253
5659
|
): GaxiosPromise<Readable>;
|
|
5254
|
-
|
|
5255
|
-
params?: Params$Resource$Projects$Locations$
|
|
5660
|
+
updateAclConfig(
|
|
5661
|
+
params?: Params$Resource$Projects$Locations$Updateaclconfig,
|
|
5256
5662
|
options?: MethodOptions
|
|
5257
|
-
): GaxiosPromise<Schema$
|
|
5258
|
-
|
|
5259
|
-
params: Params$Resource$Projects$Locations$
|
|
5663
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>;
|
|
5664
|
+
updateAclConfig(
|
|
5665
|
+
params: Params$Resource$Projects$Locations$Updateaclconfig,
|
|
5260
5666
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5261
5667
|
callback: BodyResponseCallback<Readable>
|
|
5262
5668
|
): void;
|
|
5263
|
-
|
|
5264
|
-
params: Params$Resource$Projects$Locations$
|
|
5669
|
+
updateAclConfig(
|
|
5670
|
+
params: Params$Resource$Projects$Locations$Updateaclconfig,
|
|
5265
5671
|
options:
|
|
5266
5672
|
| MethodOptions
|
|
5267
|
-
| BodyResponseCallback<Schema$
|
|
5268
|
-
callback: BodyResponseCallback<Schema$
|
|
5673
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>,
|
|
5674
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5269
5675
|
): void;
|
|
5270
|
-
|
|
5271
|
-
params: Params$Resource$Projects$Locations$
|
|
5272
|
-
callback: BodyResponseCallback<Schema$
|
|
5676
|
+
updateAclConfig(
|
|
5677
|
+
params: Params$Resource$Projects$Locations$Updateaclconfig,
|
|
5678
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5273
5679
|
): void;
|
|
5274
|
-
|
|
5275
|
-
callback: BodyResponseCallback<Schema$
|
|
5680
|
+
updateAclConfig(
|
|
5681
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5276
5682
|
): void;
|
|
5277
|
-
|
|
5683
|
+
updateAclConfig(
|
|
5278
5684
|
paramsOrCallback?:
|
|
5279
|
-
| Params$Resource$Projects$Locations$
|
|
5280
|
-
| BodyResponseCallback<Schema$
|
|
5685
|
+
| Params$Resource$Projects$Locations$Updateaclconfig
|
|
5686
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5281
5687
|
| BodyResponseCallback<Readable>,
|
|
5282
5688
|
optionsOrCallback?:
|
|
5283
5689
|
| MethodOptions
|
|
5284
5690
|
| StreamMethodOptions
|
|
5285
|
-
| BodyResponseCallback<Schema$
|
|
5691
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5286
5692
|
| BodyResponseCallback<Readable>,
|
|
5287
5693
|
callback?:
|
|
5288
|
-
| BodyResponseCallback<Schema$
|
|
5694
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5289
5695
|
| BodyResponseCallback<Readable>
|
|
5290
5696
|
):
|
|
5291
5697
|
| void
|
|
5292
|
-
| GaxiosPromise<Schema$
|
|
5698
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
|
|
5293
5699
|
| GaxiosPromise<Readable> {
|
|
5294
5700
|
let params = (paramsOrCallback ||
|
|
5295
|
-
{}) as Params$Resource$Projects$Locations$
|
|
5701
|
+
{}) as Params$Resource$Projects$Locations$Updateaclconfig;
|
|
5296
5702
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5297
5703
|
|
|
5298
5704
|
if (typeof paramsOrCallback === 'function') {
|
|
5299
5705
|
callback = paramsOrCallback;
|
|
5300
|
-
params =
|
|
5301
|
-
{} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List;
|
|
5706
|
+
params = {} as Params$Resource$Projects$Locations$Updateaclconfig;
|
|
5302
5707
|
options = {};
|
|
5303
5708
|
}
|
|
5304
5709
|
|
|
@@ -5312,11 +5717,8 @@ export namespace discoveryengine_v1alpha {
|
|
|
5312
5717
|
const parameters = {
|
|
5313
5718
|
options: Object.assign(
|
|
5314
5719
|
{
|
|
5315
|
-
url: (rootUrl + '/v1alpha/{+name}
|
|
5316
|
-
|
|
5317
|
-
'$1'
|
|
5318
|
-
),
|
|
5319
|
-
method: 'GET',
|
|
5720
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
5721
|
+
method: 'PATCH',
|
|
5320
5722
|
},
|
|
5321
5723
|
options
|
|
5322
5724
|
),
|
|
@@ -5326,156 +5728,150 @@ export namespace discoveryengine_v1alpha {
|
|
|
5326
5728
|
context: this.context,
|
|
5327
5729
|
};
|
|
5328
5730
|
if (callback) {
|
|
5329
|
-
createAPIRequest<Schema$
|
|
5731
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>(
|
|
5330
5732
|
parameters,
|
|
5331
5733
|
callback as BodyResponseCallback<unknown>
|
|
5332
5734
|
);
|
|
5333
5735
|
} else {
|
|
5334
|
-
return createAPIRequest<Schema$
|
|
5736
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>(
|
|
5335
5737
|
parameters
|
|
5336
5738
|
);
|
|
5337
5739
|
}
|
|
5338
5740
|
}
|
|
5339
5741
|
}
|
|
5340
5742
|
|
|
5341
|
-
export interface Params$Resource$Projects$Locations$
|
|
5743
|
+
export interface Params$Resource$Projects$Locations$Estimatedatasize
|
|
5342
5744
|
extends StandardParameters {
|
|
5343
5745
|
/**
|
|
5344
|
-
*
|
|
5746
|
+
* Required. Full resource name of the location, such as `projects/{project\}/locations/{location\}`.
|
|
5345
5747
|
*/
|
|
5346
|
-
|
|
5347
|
-
|
|
5348
|
-
export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List
|
|
5349
|
-
extends StandardParameters {
|
|
5748
|
+
location?: string;
|
|
5749
|
+
|
|
5350
5750
|
/**
|
|
5351
|
-
*
|
|
5751
|
+
* Request body metadata
|
|
5352
5752
|
*/
|
|
5353
|
-
|
|
5753
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest;
|
|
5754
|
+
}
|
|
5755
|
+
export interface Params$Resource$Projects$Locations$Getaclconfig
|
|
5756
|
+
extends StandardParameters {
|
|
5354
5757
|
/**
|
|
5355
|
-
*
|
|
5758
|
+
* 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.
|
|
5356
5759
|
*/
|
|
5357
5760
|
name?: string;
|
|
5761
|
+
}
|
|
5762
|
+
export interface Params$Resource$Projects$Locations$Updateaclconfig
|
|
5763
|
+
extends StandardParameters {
|
|
5358
5764
|
/**
|
|
5359
|
-
* The
|
|
5765
|
+
* 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.
|
|
5360
5766
|
*/
|
|
5361
|
-
|
|
5767
|
+
name?: string;
|
|
5768
|
+
|
|
5362
5769
|
/**
|
|
5363
|
-
*
|
|
5770
|
+
* Request body metadata
|
|
5364
5771
|
*/
|
|
5365
|
-
|
|
5772
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAclConfig;
|
|
5366
5773
|
}
|
|
5367
5774
|
|
|
5368
|
-
export class Resource$Projects$Locations$Collections
|
|
5775
|
+
export class Resource$Projects$Locations$Collections {
|
|
5369
5776
|
context: APIRequestContext;
|
|
5370
|
-
|
|
5371
|
-
|
|
5372
|
-
|
|
5373
|
-
operations: Resource$Projects$Locations$Collections$
|
|
5374
|
-
|
|
5375
|
-
|
|
5376
|
-
|
|
5377
|
-
|
|
5378
|
-
|
|
5777
|
+
dataConnector: Resource$Projects$Locations$Collections$Dataconnector;
|
|
5778
|
+
dataStores: Resource$Projects$Locations$Collections$Datastores;
|
|
5779
|
+
engines: Resource$Projects$Locations$Collections$Engines;
|
|
5780
|
+
operations: Resource$Projects$Locations$Collections$Operations;
|
|
5781
|
+
constructor(context: APIRequestContext) {
|
|
5782
|
+
this.context = context;
|
|
5783
|
+
this.dataConnector =
|
|
5784
|
+
new Resource$Projects$Locations$Collections$Dataconnector(this.context);
|
|
5785
|
+
this.dataStores = new Resource$Projects$Locations$Collections$Datastores(
|
|
5786
|
+
this.context
|
|
5787
|
+
);
|
|
5788
|
+
this.engines = new Resource$Projects$Locations$Collections$Engines(
|
|
5789
|
+
this.context
|
|
5790
|
+
);
|
|
5791
|
+
this.operations = new Resource$Projects$Locations$Collections$Operations(
|
|
5792
|
+
this.context
|
|
5793
|
+
);
|
|
5794
|
+
}
|
|
5795
|
+
}
|
|
5796
|
+
|
|
5797
|
+
export class Resource$Projects$Locations$Collections$Dataconnector {
|
|
5798
|
+
context: APIRequestContext;
|
|
5799
|
+
operations: Resource$Projects$Locations$Collections$Dataconnector$Operations;
|
|
5379
5800
|
constructor(context: APIRequestContext) {
|
|
5380
5801
|
this.context = context;
|
|
5381
|
-
this.branches =
|
|
5382
|
-
new Resource$Projects$Locations$Collections$Datastores$Branches(
|
|
5383
|
-
this.context
|
|
5384
|
-
);
|
|
5385
|
-
this.conversations =
|
|
5386
|
-
new Resource$Projects$Locations$Collections$Datastores$Conversations(
|
|
5387
|
-
this.context
|
|
5388
|
-
);
|
|
5389
|
-
this.models =
|
|
5390
|
-
new Resource$Projects$Locations$Collections$Datastores$Models(
|
|
5391
|
-
this.context
|
|
5392
|
-
);
|
|
5393
5802
|
this.operations =
|
|
5394
|
-
new Resource$Projects$Locations$Collections$
|
|
5395
|
-
this.context
|
|
5396
|
-
);
|
|
5397
|
-
this.schemas =
|
|
5398
|
-
new Resource$Projects$Locations$Collections$Datastores$Schemas(
|
|
5399
|
-
this.context
|
|
5400
|
-
);
|
|
5401
|
-
this.servingConfigs =
|
|
5402
|
-
new Resource$Projects$Locations$Collections$Datastores$Servingconfigs(
|
|
5403
|
-
this.context
|
|
5404
|
-
);
|
|
5405
|
-
this.siteSearchEngine =
|
|
5406
|
-
new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine(
|
|
5407
|
-
this.context
|
|
5408
|
-
);
|
|
5409
|
-
this.suggestionDenyListEntries =
|
|
5410
|
-
new Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries(
|
|
5411
|
-
this.context
|
|
5412
|
-
);
|
|
5413
|
-
this.userEvents =
|
|
5414
|
-
new Resource$Projects$Locations$Collections$Datastores$Userevents(
|
|
5803
|
+
new Resource$Projects$Locations$Collections$Dataconnector$Operations(
|
|
5415
5804
|
this.context
|
|
5416
5805
|
);
|
|
5417
5806
|
}
|
|
5807
|
+
}
|
|
5808
|
+
|
|
5809
|
+
export class Resource$Projects$Locations$Collections$Dataconnector$Operations {
|
|
5810
|
+
context: APIRequestContext;
|
|
5811
|
+
constructor(context: APIRequestContext) {
|
|
5812
|
+
this.context = context;
|
|
5813
|
+
}
|
|
5418
5814
|
|
|
5419
5815
|
/**
|
|
5420
|
-
*
|
|
5816
|
+
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
5421
5817
|
*
|
|
5422
5818
|
* @param params - Parameters for request
|
|
5423
5819
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5424
5820
|
* @param callback - Optional callback that handles the response.
|
|
5425
5821
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5426
5822
|
*/
|
|
5427
|
-
|
|
5428
|
-
params: Params$Resource$Projects$Locations$Collections$
|
|
5823
|
+
get(
|
|
5824
|
+
params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get,
|
|
5429
5825
|
options: StreamMethodOptions
|
|
5430
5826
|
): GaxiosPromise<Readable>;
|
|
5431
|
-
|
|
5432
|
-
params?: Params$Resource$Projects$Locations$Collections$
|
|
5827
|
+
get(
|
|
5828
|
+
params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get,
|
|
5433
5829
|
options?: MethodOptions
|
|
5434
|
-
): GaxiosPromise<Schema$
|
|
5435
|
-
|
|
5436
|
-
params: Params$Resource$Projects$Locations$Collections$
|
|
5830
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5831
|
+
get(
|
|
5832
|
+
params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get,
|
|
5437
5833
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5438
5834
|
callback: BodyResponseCallback<Readable>
|
|
5439
5835
|
): void;
|
|
5440
|
-
|
|
5441
|
-
params: Params$Resource$Projects$Locations$Collections$
|
|
5836
|
+
get(
|
|
5837
|
+
params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get,
|
|
5442
5838
|
options:
|
|
5443
5839
|
| MethodOptions
|
|
5444
|
-
| BodyResponseCallback<Schema$
|
|
5445
|
-
callback: BodyResponseCallback<Schema$
|
|
5840
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
5841
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5446
5842
|
): void;
|
|
5447
|
-
|
|
5448
|
-
params: Params$Resource$Projects$Locations$Collections$
|
|
5449
|
-
callback: BodyResponseCallback<Schema$
|
|
5843
|
+
get(
|
|
5844
|
+
params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get,
|
|
5845
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5450
5846
|
): void;
|
|
5451
|
-
|
|
5452
|
-
callback: BodyResponseCallback<Schema$
|
|
5847
|
+
get(
|
|
5848
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5453
5849
|
): void;
|
|
5454
|
-
|
|
5850
|
+
get(
|
|
5455
5851
|
paramsOrCallback?:
|
|
5456
|
-
| Params$Resource$Projects$Locations$Collections$
|
|
5457
|
-
| BodyResponseCallback<Schema$
|
|
5852
|
+
| Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get
|
|
5853
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5458
5854
|
| BodyResponseCallback<Readable>,
|
|
5459
5855
|
optionsOrCallback?:
|
|
5460
5856
|
| MethodOptions
|
|
5461
5857
|
| StreamMethodOptions
|
|
5462
|
-
| BodyResponseCallback<Schema$
|
|
5858
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5463
5859
|
| BodyResponseCallback<Readable>,
|
|
5464
5860
|
callback?:
|
|
5465
|
-
| BodyResponseCallback<Schema$
|
|
5861
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5466
5862
|
| BodyResponseCallback<Readable>
|
|
5467
5863
|
):
|
|
5468
5864
|
| void
|
|
5469
|
-
| GaxiosPromise<Schema$
|
|
5865
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
5470
5866
|
| GaxiosPromise<Readable> {
|
|
5471
5867
|
let params = (paramsOrCallback ||
|
|
5472
|
-
{}) as Params$Resource$Projects$Locations$Collections$
|
|
5868
|
+
{}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get;
|
|
5473
5869
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5474
5870
|
|
|
5475
5871
|
if (typeof paramsOrCallback === 'function') {
|
|
5476
5872
|
callback = paramsOrCallback;
|
|
5477
5873
|
params =
|
|
5478
|
-
{} as Params$Resource$Projects$Locations$Collections$
|
|
5874
|
+
{} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get;
|
|
5479
5875
|
options = {};
|
|
5480
5876
|
}
|
|
5481
5877
|
|
|
@@ -5489,91 +5885,86 @@ export namespace discoveryengine_v1alpha {
|
|
|
5489
5885
|
const parameters = {
|
|
5490
5886
|
options: Object.assign(
|
|
5491
5887
|
{
|
|
5492
|
-
url: (rootUrl + '/v1alpha/{+
|
|
5493
|
-
/([^:]\/)\/+/g,
|
|
5494
|
-
'$1'
|
|
5495
|
-
),
|
|
5888
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
5496
5889
|
method: 'GET',
|
|
5497
5890
|
},
|
|
5498
5891
|
options
|
|
5499
5892
|
),
|
|
5500
5893
|
params,
|
|
5501
|
-
requiredParams: ['
|
|
5502
|
-
pathParams: ['
|
|
5894
|
+
requiredParams: ['name'],
|
|
5895
|
+
pathParams: ['name'],
|
|
5503
5896
|
context: this.context,
|
|
5504
5897
|
};
|
|
5505
5898
|
if (callback) {
|
|
5506
|
-
createAPIRequest<Schema$
|
|
5899
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
5507
5900
|
parameters,
|
|
5508
5901
|
callback as BodyResponseCallback<unknown>
|
|
5509
5902
|
);
|
|
5510
5903
|
} else {
|
|
5511
|
-
return createAPIRequest<Schema$
|
|
5512
|
-
parameters
|
|
5513
|
-
);
|
|
5904
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
5514
5905
|
}
|
|
5515
5906
|
}
|
|
5516
5907
|
|
|
5517
5908
|
/**
|
|
5518
|
-
*
|
|
5909
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
5519
5910
|
*
|
|
5520
5911
|
* @param params - Parameters for request
|
|
5521
5912
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5522
5913
|
* @param callback - Optional callback that handles the response.
|
|
5523
5914
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5524
5915
|
*/
|
|
5525
|
-
|
|
5526
|
-
params: Params$Resource$Projects$Locations$Collections$
|
|
5916
|
+
list(
|
|
5917
|
+
params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List,
|
|
5527
5918
|
options: StreamMethodOptions
|
|
5528
5919
|
): GaxiosPromise<Readable>;
|
|
5529
|
-
|
|
5530
|
-
params?: Params$Resource$Projects$Locations$Collections$
|
|
5920
|
+
list(
|
|
5921
|
+
params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List,
|
|
5531
5922
|
options?: MethodOptions
|
|
5532
|
-
): GaxiosPromise<Schema$
|
|
5533
|
-
|
|
5534
|
-
params: Params$Resource$Projects$Locations$Collections$
|
|
5923
|
+
): GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>;
|
|
5924
|
+
list(
|
|
5925
|
+
params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List,
|
|
5535
5926
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5536
5927
|
callback: BodyResponseCallback<Readable>
|
|
5537
5928
|
): void;
|
|
5538
|
-
|
|
5539
|
-
params: Params$Resource$Projects$Locations$Collections$
|
|
5929
|
+
list(
|
|
5930
|
+
params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List,
|
|
5540
5931
|
options:
|
|
5541
5932
|
| MethodOptions
|
|
5542
|
-
| BodyResponseCallback<Schema$
|
|
5543
|
-
callback: BodyResponseCallback<Schema$
|
|
5933
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>,
|
|
5934
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
5544
5935
|
): void;
|
|
5545
|
-
|
|
5546
|
-
params: Params$Resource$Projects$Locations$Collections$
|
|
5547
|
-
callback: BodyResponseCallback<Schema$
|
|
5936
|
+
list(
|
|
5937
|
+
params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List,
|
|
5938
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
5548
5939
|
): void;
|
|
5549
|
-
|
|
5550
|
-
callback: BodyResponseCallback<Schema$
|
|
5940
|
+
list(
|
|
5941
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
5551
5942
|
): void;
|
|
5552
|
-
|
|
5943
|
+
list(
|
|
5553
5944
|
paramsOrCallback?:
|
|
5554
|
-
| Params$Resource$Projects$Locations$Collections$
|
|
5555
|
-
| BodyResponseCallback<Schema$
|
|
5945
|
+
| Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List
|
|
5946
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
5556
5947
|
| BodyResponseCallback<Readable>,
|
|
5557
5948
|
optionsOrCallback?:
|
|
5558
5949
|
| MethodOptions
|
|
5559
5950
|
| StreamMethodOptions
|
|
5560
|
-
| BodyResponseCallback<Schema$
|
|
5951
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
5561
5952
|
| BodyResponseCallback<Readable>,
|
|
5562
5953
|
callback?:
|
|
5563
|
-
| BodyResponseCallback<Schema$
|
|
5954
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
5564
5955
|
| BodyResponseCallback<Readable>
|
|
5565
5956
|
):
|
|
5566
5957
|
| void
|
|
5567
|
-
| GaxiosPromise<Schema$
|
|
5958
|
+
| GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>
|
|
5568
5959
|
| GaxiosPromise<Readable> {
|
|
5569
5960
|
let params = (paramsOrCallback ||
|
|
5570
|
-
{}) as Params$Resource$Projects$Locations$Collections$
|
|
5961
|
+
{}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List;
|
|
5571
5962
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5572
5963
|
|
|
5573
5964
|
if (typeof paramsOrCallback === 'function') {
|
|
5574
5965
|
callback = paramsOrCallback;
|
|
5575
5966
|
params =
|
|
5576
|
-
{} as Params$Resource$Projects$Locations$Collections$
|
|
5967
|
+
{} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List;
|
|
5577
5968
|
options = {};
|
|
5578
5969
|
}
|
|
5579
5970
|
|
|
@@ -5587,89 +5978,170 @@ export namespace discoveryengine_v1alpha {
|
|
|
5587
5978
|
const parameters = {
|
|
5588
5979
|
options: Object.assign(
|
|
5589
5980
|
{
|
|
5590
|
-
url: (rootUrl + '/v1alpha/{+
|
|
5981
|
+
url: (rootUrl + '/v1alpha/{+name}/operations').replace(
|
|
5591
5982
|
/([^:]\/)\/+/g,
|
|
5592
5983
|
'$1'
|
|
5593
5984
|
),
|
|
5594
|
-
method: '
|
|
5985
|
+
method: 'GET',
|
|
5595
5986
|
},
|
|
5596
5987
|
options
|
|
5597
5988
|
),
|
|
5598
5989
|
params,
|
|
5599
|
-
requiredParams: ['
|
|
5600
|
-
pathParams: ['
|
|
5990
|
+
requiredParams: ['name'],
|
|
5991
|
+
pathParams: ['name'],
|
|
5601
5992
|
context: this.context,
|
|
5602
5993
|
};
|
|
5603
5994
|
if (callback) {
|
|
5604
|
-
createAPIRequest<Schema$
|
|
5995
|
+
createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
|
|
5605
5996
|
parameters,
|
|
5606
5997
|
callback as BodyResponseCallback<unknown>
|
|
5607
5998
|
);
|
|
5608
5999
|
} else {
|
|
5609
|
-
return createAPIRequest<Schema$
|
|
6000
|
+
return createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
|
|
6001
|
+
parameters
|
|
6002
|
+
);
|
|
5610
6003
|
}
|
|
5611
6004
|
}
|
|
6005
|
+
}
|
|
5612
6006
|
|
|
6007
|
+
export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get
|
|
6008
|
+
extends StandardParameters {
|
|
5613
6009
|
/**
|
|
5614
|
-
*
|
|
5615
|
-
*
|
|
5616
|
-
* @param params - Parameters for request
|
|
5617
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5618
|
-
* @param callback - Optional callback that handles the response.
|
|
5619
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6010
|
+
* The name of the operation resource.
|
|
5620
6011
|
*/
|
|
5621
|
-
|
|
5622
|
-
|
|
5623
|
-
|
|
5624
|
-
|
|
5625
|
-
|
|
5626
|
-
|
|
5627
|
-
|
|
5628
|
-
|
|
5629
|
-
|
|
5630
|
-
|
|
5631
|
-
|
|
5632
|
-
|
|
5633
|
-
|
|
5634
|
-
|
|
5635
|
-
|
|
5636
|
-
|
|
5637
|
-
|
|
5638
|
-
|
|
5639
|
-
|
|
5640
|
-
|
|
5641
|
-
|
|
5642
|
-
|
|
5643
|
-
|
|
5644
|
-
|
|
5645
|
-
|
|
5646
|
-
|
|
6012
|
+
name?: string;
|
|
6013
|
+
}
|
|
6014
|
+
export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List
|
|
6015
|
+
extends StandardParameters {
|
|
6016
|
+
/**
|
|
6017
|
+
* The standard list filter.
|
|
6018
|
+
*/
|
|
6019
|
+
filter?: string;
|
|
6020
|
+
/**
|
|
6021
|
+
* The name of the operation's parent resource.
|
|
6022
|
+
*/
|
|
6023
|
+
name?: string;
|
|
6024
|
+
/**
|
|
6025
|
+
* The standard list page size.
|
|
6026
|
+
*/
|
|
6027
|
+
pageSize?: number;
|
|
6028
|
+
/**
|
|
6029
|
+
* The standard list page token.
|
|
6030
|
+
*/
|
|
6031
|
+
pageToken?: string;
|
|
6032
|
+
}
|
|
6033
|
+
|
|
6034
|
+
export class Resource$Projects$Locations$Collections$Datastores {
|
|
6035
|
+
context: APIRequestContext;
|
|
6036
|
+
branches: Resource$Projects$Locations$Collections$Datastores$Branches;
|
|
6037
|
+
conversations: Resource$Projects$Locations$Collections$Datastores$Conversations;
|
|
6038
|
+
models: Resource$Projects$Locations$Collections$Datastores$Models;
|
|
6039
|
+
operations: Resource$Projects$Locations$Collections$Datastores$Operations;
|
|
6040
|
+
schemas: Resource$Projects$Locations$Collections$Datastores$Schemas;
|
|
6041
|
+
servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs;
|
|
6042
|
+
siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine;
|
|
6043
|
+
suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries;
|
|
6044
|
+
userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
|
|
6045
|
+
constructor(context: APIRequestContext) {
|
|
6046
|
+
this.context = context;
|
|
6047
|
+
this.branches =
|
|
6048
|
+
new Resource$Projects$Locations$Collections$Datastores$Branches(
|
|
6049
|
+
this.context
|
|
6050
|
+
);
|
|
6051
|
+
this.conversations =
|
|
6052
|
+
new Resource$Projects$Locations$Collections$Datastores$Conversations(
|
|
6053
|
+
this.context
|
|
6054
|
+
);
|
|
6055
|
+
this.models =
|
|
6056
|
+
new Resource$Projects$Locations$Collections$Datastores$Models(
|
|
6057
|
+
this.context
|
|
6058
|
+
);
|
|
6059
|
+
this.operations =
|
|
6060
|
+
new Resource$Projects$Locations$Collections$Datastores$Operations(
|
|
6061
|
+
this.context
|
|
6062
|
+
);
|
|
6063
|
+
this.schemas =
|
|
6064
|
+
new Resource$Projects$Locations$Collections$Datastores$Schemas(
|
|
6065
|
+
this.context
|
|
6066
|
+
);
|
|
6067
|
+
this.servingConfigs =
|
|
6068
|
+
new Resource$Projects$Locations$Collections$Datastores$Servingconfigs(
|
|
6069
|
+
this.context
|
|
6070
|
+
);
|
|
6071
|
+
this.siteSearchEngine =
|
|
6072
|
+
new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine(
|
|
6073
|
+
this.context
|
|
6074
|
+
);
|
|
6075
|
+
this.suggestionDenyListEntries =
|
|
6076
|
+
new Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries(
|
|
6077
|
+
this.context
|
|
6078
|
+
);
|
|
6079
|
+
this.userEvents =
|
|
6080
|
+
new Resource$Projects$Locations$Collections$Datastores$Userevents(
|
|
6081
|
+
this.context
|
|
6082
|
+
);
|
|
6083
|
+
}
|
|
6084
|
+
|
|
6085
|
+
/**
|
|
6086
|
+
* Completes the specified user input with keyword suggestions.
|
|
6087
|
+
*
|
|
6088
|
+
* @param params - Parameters for request
|
|
6089
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6090
|
+
* @param callback - Optional callback that handles the response.
|
|
6091
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6092
|
+
*/
|
|
6093
|
+
completeQuery(
|
|
6094
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery,
|
|
6095
|
+
options: StreamMethodOptions
|
|
6096
|
+
): GaxiosPromise<Readable>;
|
|
6097
|
+
completeQuery(
|
|
6098
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery,
|
|
6099
|
+
options?: MethodOptions
|
|
6100
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>;
|
|
6101
|
+
completeQuery(
|
|
6102
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery,
|
|
6103
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6104
|
+
callback: BodyResponseCallback<Readable>
|
|
5647
6105
|
): void;
|
|
5648
|
-
|
|
6106
|
+
completeQuery(
|
|
6107
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery,
|
|
6108
|
+
options:
|
|
6109
|
+
| MethodOptions
|
|
6110
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>,
|
|
6111
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
|
|
6112
|
+
): void;
|
|
6113
|
+
completeQuery(
|
|
6114
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery,
|
|
6115
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
|
|
6116
|
+
): void;
|
|
6117
|
+
completeQuery(
|
|
6118
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
|
|
6119
|
+
): void;
|
|
6120
|
+
completeQuery(
|
|
5649
6121
|
paramsOrCallback?:
|
|
5650
|
-
| Params$Resource$Projects$Locations$Collections$Datastores$
|
|
5651
|
-
| BodyResponseCallback<Schema$
|
|
6122
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Completequery
|
|
6123
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
|
|
5652
6124
|
| BodyResponseCallback<Readable>,
|
|
5653
6125
|
optionsOrCallback?:
|
|
5654
6126
|
| MethodOptions
|
|
5655
6127
|
| StreamMethodOptions
|
|
5656
|
-
| BodyResponseCallback<Schema$
|
|
6128
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
|
|
5657
6129
|
| BodyResponseCallback<Readable>,
|
|
5658
6130
|
callback?:
|
|
5659
|
-
| BodyResponseCallback<Schema$
|
|
6131
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
|
|
5660
6132
|
| BodyResponseCallback<Readable>
|
|
5661
6133
|
):
|
|
5662
6134
|
| void
|
|
5663
|
-
| GaxiosPromise<Schema$
|
|
6135
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
|
|
5664
6136
|
| GaxiosPromise<Readable> {
|
|
5665
6137
|
let params = (paramsOrCallback ||
|
|
5666
|
-
{}) as Params$Resource$Projects$Locations$Collections$Datastores$
|
|
6138
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Completequery;
|
|
5667
6139
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5668
6140
|
|
|
5669
6141
|
if (typeof paramsOrCallback === 'function') {
|
|
5670
6142
|
callback = paramsOrCallback;
|
|
5671
6143
|
params =
|
|
5672
|
-
{} as Params$Resource$Projects$Locations$Collections$Datastores$
|
|
6144
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Completequery;
|
|
5673
6145
|
options = {};
|
|
5674
6146
|
}
|
|
5675
6147
|
|
|
@@ -5683,86 +6155,91 @@ export namespace discoveryengine_v1alpha {
|
|
|
5683
6155
|
const parameters = {
|
|
5684
6156
|
options: Object.assign(
|
|
5685
6157
|
{
|
|
5686
|
-
url: (rootUrl + '/v1alpha/{+
|
|
5687
|
-
|
|
6158
|
+
url: (rootUrl + '/v1alpha/{+dataStore}:completeQuery').replace(
|
|
6159
|
+
/([^:]\/)\/+/g,
|
|
6160
|
+
'$1'
|
|
6161
|
+
),
|
|
6162
|
+
method: 'GET',
|
|
5688
6163
|
},
|
|
5689
6164
|
options
|
|
5690
6165
|
),
|
|
5691
6166
|
params,
|
|
5692
|
-
requiredParams: ['
|
|
5693
|
-
pathParams: ['
|
|
6167
|
+
requiredParams: ['dataStore'],
|
|
6168
|
+
pathParams: ['dataStore'],
|
|
5694
6169
|
context: this.context,
|
|
5695
6170
|
};
|
|
5696
6171
|
if (callback) {
|
|
5697
|
-
createAPIRequest<Schema$
|
|
6172
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>(
|
|
5698
6173
|
parameters,
|
|
5699
6174
|
callback as BodyResponseCallback<unknown>
|
|
5700
6175
|
);
|
|
5701
6176
|
} else {
|
|
5702
|
-
return createAPIRequest<Schema$
|
|
6177
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>(
|
|
6178
|
+
parameters
|
|
6179
|
+
);
|
|
5703
6180
|
}
|
|
5704
6181
|
}
|
|
5705
6182
|
|
|
5706
6183
|
/**
|
|
5707
|
-
*
|
|
6184
|
+
* Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
|
|
5708
6185
|
*
|
|
5709
6186
|
* @param params - Parameters for request
|
|
5710
6187
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5711
6188
|
* @param callback - Optional callback that handles the response.
|
|
5712
6189
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5713
6190
|
*/
|
|
5714
|
-
|
|
5715
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
6191
|
+
create(
|
|
6192
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Create,
|
|
5716
6193
|
options: StreamMethodOptions
|
|
5717
6194
|
): GaxiosPromise<Readable>;
|
|
5718
|
-
|
|
5719
|
-
params?: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
6195
|
+
create(
|
|
6196
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Create,
|
|
5720
6197
|
options?: MethodOptions
|
|
5721
|
-
): GaxiosPromise<Schema$
|
|
5722
|
-
|
|
5723
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
6198
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6199
|
+
create(
|
|
6200
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Create,
|
|
5724
6201
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5725
6202
|
callback: BodyResponseCallback<Readable>
|
|
5726
6203
|
): void;
|
|
5727
|
-
|
|
5728
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
6204
|
+
create(
|
|
6205
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Create,
|
|
5729
6206
|
options:
|
|
5730
6207
|
| MethodOptions
|
|
5731
|
-
| BodyResponseCallback<Schema$
|
|
5732
|
-
callback: BodyResponseCallback<Schema$
|
|
6208
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
6209
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5733
6210
|
): void;
|
|
5734
|
-
|
|
5735
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
5736
|
-
callback: BodyResponseCallback<Schema$
|
|
6211
|
+
create(
|
|
6212
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Create,
|
|
6213
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5737
6214
|
): void;
|
|
5738
|
-
|
|
5739
|
-
callback: BodyResponseCallback<Schema$
|
|
6215
|
+
create(
|
|
6216
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5740
6217
|
): void;
|
|
5741
|
-
|
|
6218
|
+
create(
|
|
5742
6219
|
paramsOrCallback?:
|
|
5743
|
-
| Params$Resource$Projects$Locations$Collections$Datastores$
|
|
5744
|
-
| BodyResponseCallback<Schema$
|
|
6220
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Create
|
|
6221
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5745
6222
|
| BodyResponseCallback<Readable>,
|
|
5746
6223
|
optionsOrCallback?:
|
|
5747
6224
|
| MethodOptions
|
|
5748
6225
|
| StreamMethodOptions
|
|
5749
|
-
| BodyResponseCallback<Schema$
|
|
6226
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5750
6227
|
| BodyResponseCallback<Readable>,
|
|
5751
6228
|
callback?:
|
|
5752
|
-
| BodyResponseCallback<Schema$
|
|
6229
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5753
6230
|
| BodyResponseCallback<Readable>
|
|
5754
6231
|
):
|
|
5755
6232
|
| void
|
|
5756
|
-
| GaxiosPromise<Schema$
|
|
6233
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
5757
6234
|
| GaxiosPromise<Readable> {
|
|
5758
6235
|
let params = (paramsOrCallback ||
|
|
5759
|
-
{}) as Params$Resource$Projects$Locations$Collections$Datastores$
|
|
6236
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Create;
|
|
5760
6237
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5761
6238
|
|
|
5762
6239
|
if (typeof paramsOrCallback === 'function') {
|
|
5763
6240
|
callback = paramsOrCallback;
|
|
5764
6241
|
params =
|
|
5765
|
-
{} as Params$Resource$Projects$Locations$Collections$Datastores$
|
|
6242
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Create;
|
|
5766
6243
|
options = {};
|
|
5767
6244
|
}
|
|
5768
6245
|
|
|
@@ -5776,88 +6253,277 @@ export namespace discoveryengine_v1alpha {
|
|
|
5776
6253
|
const parameters = {
|
|
5777
6254
|
options: Object.assign(
|
|
5778
6255
|
{
|
|
5779
|
-
url: (rootUrl + '/v1alpha/{+
|
|
5780
|
-
|
|
6256
|
+
url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace(
|
|
6257
|
+
/([^:]\/)\/+/g,
|
|
6258
|
+
'$1'
|
|
6259
|
+
),
|
|
6260
|
+
method: 'POST',
|
|
5781
6261
|
},
|
|
5782
6262
|
options
|
|
5783
6263
|
),
|
|
5784
6264
|
params,
|
|
5785
|
-
requiredParams: ['
|
|
5786
|
-
pathParams: ['
|
|
6265
|
+
requiredParams: ['parent'],
|
|
6266
|
+
pathParams: ['parent'],
|
|
5787
6267
|
context: this.context,
|
|
5788
6268
|
};
|
|
5789
6269
|
if (callback) {
|
|
5790
|
-
createAPIRequest<Schema$
|
|
6270
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
5791
6271
|
parameters,
|
|
5792
6272
|
callback as BodyResponseCallback<unknown>
|
|
5793
6273
|
);
|
|
5794
6274
|
} else {
|
|
5795
|
-
return createAPIRequest<Schema$
|
|
5796
|
-
parameters
|
|
5797
|
-
);
|
|
6275
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
5798
6276
|
}
|
|
5799
6277
|
}
|
|
5800
6278
|
|
|
5801
6279
|
/**
|
|
5802
|
-
*
|
|
6280
|
+
* Deletes a DataStore.
|
|
5803
6281
|
*
|
|
5804
6282
|
* @param params - Parameters for request
|
|
5805
6283
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5806
6284
|
* @param callback - Optional callback that handles the response.
|
|
5807
6285
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5808
6286
|
*/
|
|
5809
|
-
|
|
5810
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
6287
|
+
delete(
|
|
6288
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Delete,
|
|
5811
6289
|
options: StreamMethodOptions
|
|
5812
6290
|
): GaxiosPromise<Readable>;
|
|
5813
|
-
|
|
5814
|
-
params?: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
6291
|
+
delete(
|
|
6292
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Delete,
|
|
5815
6293
|
options?: MethodOptions
|
|
5816
|
-
): GaxiosPromise<Schema$
|
|
5817
|
-
|
|
5818
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
6294
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6295
|
+
delete(
|
|
6296
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Delete,
|
|
5819
6297
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5820
6298
|
callback: BodyResponseCallback<Readable>
|
|
5821
6299
|
): void;
|
|
5822
|
-
|
|
5823
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
6300
|
+
delete(
|
|
6301
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Delete,
|
|
5824
6302
|
options:
|
|
5825
6303
|
| MethodOptions
|
|
5826
|
-
| BodyResponseCallback<Schema$
|
|
5827
|
-
callback: BodyResponseCallback<Schema$
|
|
6304
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
6305
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5828
6306
|
): void;
|
|
5829
|
-
|
|
5830
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
5831
|
-
callback: BodyResponseCallback<Schema$
|
|
6307
|
+
delete(
|
|
6308
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Delete,
|
|
6309
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5832
6310
|
): void;
|
|
5833
|
-
|
|
5834
|
-
callback: BodyResponseCallback<Schema$
|
|
6311
|
+
delete(
|
|
6312
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5835
6313
|
): void;
|
|
5836
|
-
|
|
6314
|
+
delete(
|
|
5837
6315
|
paramsOrCallback?:
|
|
5838
|
-
| Params$Resource$Projects$Locations$Collections$Datastores$
|
|
5839
|
-
| BodyResponseCallback<Schema$
|
|
6316
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Delete
|
|
6317
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5840
6318
|
| BodyResponseCallback<Readable>,
|
|
5841
6319
|
optionsOrCallback?:
|
|
5842
6320
|
| MethodOptions
|
|
5843
6321
|
| StreamMethodOptions
|
|
5844
|
-
| BodyResponseCallback<Schema$
|
|
6322
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5845
6323
|
| BodyResponseCallback<Readable>,
|
|
5846
6324
|
callback?:
|
|
5847
|
-
| BodyResponseCallback<Schema$
|
|
6325
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
5848
6326
|
| BodyResponseCallback<Readable>
|
|
5849
6327
|
):
|
|
5850
6328
|
| void
|
|
5851
|
-
| GaxiosPromise<Schema$
|
|
6329
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
5852
6330
|
| GaxiosPromise<Readable> {
|
|
5853
6331
|
let params = (paramsOrCallback ||
|
|
5854
|
-
{}) as Params$Resource$Projects$Locations$Collections$Datastores$
|
|
6332
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Delete;
|
|
5855
6333
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5856
6334
|
|
|
5857
6335
|
if (typeof paramsOrCallback === 'function') {
|
|
5858
6336
|
callback = paramsOrCallback;
|
|
5859
6337
|
params =
|
|
5860
|
-
{} as Params$Resource$Projects$Locations$Collections$Datastores$
|
|
6338
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Delete;
|
|
6339
|
+
options = {};
|
|
6340
|
+
}
|
|
6341
|
+
|
|
6342
|
+
if (typeof optionsOrCallback === 'function') {
|
|
6343
|
+
callback = optionsOrCallback;
|
|
6344
|
+
options = {};
|
|
6345
|
+
}
|
|
6346
|
+
|
|
6347
|
+
const rootUrl =
|
|
6348
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
6349
|
+
const parameters = {
|
|
6350
|
+
options: Object.assign(
|
|
6351
|
+
{
|
|
6352
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
6353
|
+
method: 'DELETE',
|
|
6354
|
+
},
|
|
6355
|
+
options
|
|
6356
|
+
),
|
|
6357
|
+
params,
|
|
6358
|
+
requiredParams: ['name'],
|
|
6359
|
+
pathParams: ['name'],
|
|
6360
|
+
context: this.context,
|
|
6361
|
+
};
|
|
6362
|
+
if (callback) {
|
|
6363
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
6364
|
+
parameters,
|
|
6365
|
+
callback as BodyResponseCallback<unknown>
|
|
6366
|
+
);
|
|
6367
|
+
} else {
|
|
6368
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
6369
|
+
}
|
|
6370
|
+
}
|
|
6371
|
+
|
|
6372
|
+
/**
|
|
6373
|
+
* Gets a DataStore.
|
|
6374
|
+
*
|
|
6375
|
+
* @param params - Parameters for request
|
|
6376
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6377
|
+
* @param callback - Optional callback that handles the response.
|
|
6378
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6379
|
+
*/
|
|
6380
|
+
get(
|
|
6381
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Get,
|
|
6382
|
+
options: StreamMethodOptions
|
|
6383
|
+
): GaxiosPromise<Readable>;
|
|
6384
|
+
get(
|
|
6385
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Get,
|
|
6386
|
+
options?: MethodOptions
|
|
6387
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>;
|
|
6388
|
+
get(
|
|
6389
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Get,
|
|
6390
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6391
|
+
callback: BodyResponseCallback<Readable>
|
|
6392
|
+
): void;
|
|
6393
|
+
get(
|
|
6394
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Get,
|
|
6395
|
+
options:
|
|
6396
|
+
| MethodOptions
|
|
6397
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>,
|
|
6398
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>
|
|
6399
|
+
): void;
|
|
6400
|
+
get(
|
|
6401
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Get,
|
|
6402
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>
|
|
6403
|
+
): void;
|
|
6404
|
+
get(
|
|
6405
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>
|
|
6406
|
+
): void;
|
|
6407
|
+
get(
|
|
6408
|
+
paramsOrCallback?:
|
|
6409
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Get
|
|
6410
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>
|
|
6411
|
+
| BodyResponseCallback<Readable>,
|
|
6412
|
+
optionsOrCallback?:
|
|
6413
|
+
| MethodOptions
|
|
6414
|
+
| StreamMethodOptions
|
|
6415
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>
|
|
6416
|
+
| BodyResponseCallback<Readable>,
|
|
6417
|
+
callback?:
|
|
6418
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>
|
|
6419
|
+
| BodyResponseCallback<Readable>
|
|
6420
|
+
):
|
|
6421
|
+
| void
|
|
6422
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>
|
|
6423
|
+
| GaxiosPromise<Readable> {
|
|
6424
|
+
let params = (paramsOrCallback ||
|
|
6425
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Get;
|
|
6426
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
6427
|
+
|
|
6428
|
+
if (typeof paramsOrCallback === 'function') {
|
|
6429
|
+
callback = paramsOrCallback;
|
|
6430
|
+
params =
|
|
6431
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Get;
|
|
6432
|
+
options = {};
|
|
6433
|
+
}
|
|
6434
|
+
|
|
6435
|
+
if (typeof optionsOrCallback === 'function') {
|
|
6436
|
+
callback = optionsOrCallback;
|
|
6437
|
+
options = {};
|
|
6438
|
+
}
|
|
6439
|
+
|
|
6440
|
+
const rootUrl =
|
|
6441
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
6442
|
+
const parameters = {
|
|
6443
|
+
options: Object.assign(
|
|
6444
|
+
{
|
|
6445
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
6446
|
+
method: 'GET',
|
|
6447
|
+
},
|
|
6448
|
+
options
|
|
6449
|
+
),
|
|
6450
|
+
params,
|
|
6451
|
+
requiredParams: ['name'],
|
|
6452
|
+
pathParams: ['name'],
|
|
6453
|
+
context: this.context,
|
|
6454
|
+
};
|
|
6455
|
+
if (callback) {
|
|
6456
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>(
|
|
6457
|
+
parameters,
|
|
6458
|
+
callback as BodyResponseCallback<unknown>
|
|
6459
|
+
);
|
|
6460
|
+
} else {
|
|
6461
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>(
|
|
6462
|
+
parameters
|
|
6463
|
+
);
|
|
6464
|
+
}
|
|
6465
|
+
}
|
|
6466
|
+
|
|
6467
|
+
/**
|
|
6468
|
+
* Gets a DocumentProcessingConfig.
|
|
6469
|
+
*
|
|
6470
|
+
* @param params - Parameters for request
|
|
6471
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6472
|
+
* @param callback - Optional callback that handles the response.
|
|
6473
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6474
|
+
*/
|
|
6475
|
+
getDocumentProcessingConfig(
|
|
6476
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig,
|
|
6477
|
+
options: StreamMethodOptions
|
|
6478
|
+
): GaxiosPromise<Readable>;
|
|
6479
|
+
getDocumentProcessingConfig(
|
|
6480
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig,
|
|
6481
|
+
options?: MethodOptions
|
|
6482
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
|
|
6483
|
+
getDocumentProcessingConfig(
|
|
6484
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig,
|
|
6485
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6486
|
+
callback: BodyResponseCallback<Readable>
|
|
6487
|
+
): void;
|
|
6488
|
+
getDocumentProcessingConfig(
|
|
6489
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig,
|
|
6490
|
+
options:
|
|
6491
|
+
| MethodOptions
|
|
6492
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>,
|
|
6493
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>
|
|
6494
|
+
): void;
|
|
6495
|
+
getDocumentProcessingConfig(
|
|
6496
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig,
|
|
6497
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>
|
|
6498
|
+
): void;
|
|
6499
|
+
getDocumentProcessingConfig(
|
|
6500
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>
|
|
6501
|
+
): void;
|
|
6502
|
+
getDocumentProcessingConfig(
|
|
6503
|
+
paramsOrCallback?:
|
|
6504
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig
|
|
6505
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>
|
|
6506
|
+
| BodyResponseCallback<Readable>,
|
|
6507
|
+
optionsOrCallback?:
|
|
6508
|
+
| MethodOptions
|
|
6509
|
+
| StreamMethodOptions
|
|
6510
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>
|
|
6511
|
+
| BodyResponseCallback<Readable>,
|
|
6512
|
+
callback?:
|
|
6513
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>
|
|
6514
|
+
| BodyResponseCallback<Readable>
|
|
6515
|
+
):
|
|
6516
|
+
| void
|
|
6517
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>
|
|
6518
|
+
| GaxiosPromise<Readable> {
|
|
6519
|
+
let params = (paramsOrCallback ||
|
|
6520
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig;
|
|
6521
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
6522
|
+
|
|
6523
|
+
if (typeof paramsOrCallback === 'function') {
|
|
6524
|
+
callback = paramsOrCallback;
|
|
6525
|
+
params =
|
|
6526
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig;
|
|
5861
6527
|
options = {};
|
|
5862
6528
|
}
|
|
5863
6529
|
|
|
@@ -6527,8 +7193,13 @@ export namespace discoveryengine_v1alpha {
|
|
|
6527
7193
|
|
|
6528
7194
|
export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents {
|
|
6529
7195
|
context: APIRequestContext;
|
|
7196
|
+
chunks: Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks;
|
|
6530
7197
|
constructor(context: APIRequestContext) {
|
|
6531
7198
|
this.context = context;
|
|
7199
|
+
this.chunks =
|
|
7200
|
+
new Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks(
|
|
7201
|
+
this.context
|
|
7202
|
+
);
|
|
6532
7203
|
}
|
|
6533
7204
|
|
|
6534
7205
|
/**
|
|
@@ -6684,7 +7355,389 @@ export namespace discoveryengine_v1alpha {
|
|
|
6684
7355
|
if (typeof paramsOrCallback === 'function') {
|
|
6685
7356
|
callback = paramsOrCallback;
|
|
6686
7357
|
params =
|
|
6687
|
-
{} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete;
|
|
7358
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete;
|
|
7359
|
+
options = {};
|
|
7360
|
+
}
|
|
7361
|
+
|
|
7362
|
+
if (typeof optionsOrCallback === 'function') {
|
|
7363
|
+
callback = optionsOrCallback;
|
|
7364
|
+
options = {};
|
|
7365
|
+
}
|
|
7366
|
+
|
|
7367
|
+
const rootUrl =
|
|
7368
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
7369
|
+
const parameters = {
|
|
7370
|
+
options: Object.assign(
|
|
7371
|
+
{
|
|
7372
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
7373
|
+
method: 'DELETE',
|
|
7374
|
+
},
|
|
7375
|
+
options
|
|
7376
|
+
),
|
|
7377
|
+
params,
|
|
7378
|
+
requiredParams: ['name'],
|
|
7379
|
+
pathParams: ['name'],
|
|
7380
|
+
context: this.context,
|
|
7381
|
+
};
|
|
7382
|
+
if (callback) {
|
|
7383
|
+
createAPIRequest<Schema$GoogleProtobufEmpty>(
|
|
7384
|
+
parameters,
|
|
7385
|
+
callback as BodyResponseCallback<unknown>
|
|
7386
|
+
);
|
|
7387
|
+
} else {
|
|
7388
|
+
return createAPIRequest<Schema$GoogleProtobufEmpty>(parameters);
|
|
7389
|
+
}
|
|
7390
|
+
}
|
|
7391
|
+
|
|
7392
|
+
/**
|
|
7393
|
+
* Gets a Document.
|
|
7394
|
+
*
|
|
7395
|
+
* @param params - Parameters for request
|
|
7396
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7397
|
+
* @param callback - Optional callback that handles the response.
|
|
7398
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7399
|
+
*/
|
|
7400
|
+
get(
|
|
7401
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get,
|
|
7402
|
+
options: StreamMethodOptions
|
|
7403
|
+
): GaxiosPromise<Readable>;
|
|
7404
|
+
get(
|
|
7405
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get,
|
|
7406
|
+
options?: MethodOptions
|
|
7407
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDocument>;
|
|
7408
|
+
get(
|
|
7409
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get,
|
|
7410
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
7411
|
+
callback: BodyResponseCallback<Readable>
|
|
7412
|
+
): void;
|
|
7413
|
+
get(
|
|
7414
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get,
|
|
7415
|
+
options:
|
|
7416
|
+
| MethodOptions
|
|
7417
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>,
|
|
7418
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
7419
|
+
): void;
|
|
7420
|
+
get(
|
|
7421
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get,
|
|
7422
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
7423
|
+
): void;
|
|
7424
|
+
get(
|
|
7425
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
7426
|
+
): void;
|
|
7427
|
+
get(
|
|
7428
|
+
paramsOrCallback?:
|
|
7429
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get
|
|
7430
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
7431
|
+
| BodyResponseCallback<Readable>,
|
|
7432
|
+
optionsOrCallback?:
|
|
7433
|
+
| MethodOptions
|
|
7434
|
+
| StreamMethodOptions
|
|
7435
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
7436
|
+
| BodyResponseCallback<Readable>,
|
|
7437
|
+
callback?:
|
|
7438
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
7439
|
+
| BodyResponseCallback<Readable>
|
|
7440
|
+
):
|
|
7441
|
+
| void
|
|
7442
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
7443
|
+
| GaxiosPromise<Readable> {
|
|
7444
|
+
let params = (paramsOrCallback ||
|
|
7445
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get;
|
|
7446
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
7447
|
+
|
|
7448
|
+
if (typeof paramsOrCallback === 'function') {
|
|
7449
|
+
callback = paramsOrCallback;
|
|
7450
|
+
params =
|
|
7451
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get;
|
|
7452
|
+
options = {};
|
|
7453
|
+
}
|
|
7454
|
+
|
|
7455
|
+
if (typeof optionsOrCallback === 'function') {
|
|
7456
|
+
callback = optionsOrCallback;
|
|
7457
|
+
options = {};
|
|
7458
|
+
}
|
|
7459
|
+
|
|
7460
|
+
const rootUrl =
|
|
7461
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
7462
|
+
const parameters = {
|
|
7463
|
+
options: Object.assign(
|
|
7464
|
+
{
|
|
7465
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
7466
|
+
method: 'GET',
|
|
7467
|
+
},
|
|
7468
|
+
options
|
|
7469
|
+
),
|
|
7470
|
+
params,
|
|
7471
|
+
requiredParams: ['name'],
|
|
7472
|
+
pathParams: ['name'],
|
|
7473
|
+
context: this.context,
|
|
7474
|
+
};
|
|
7475
|
+
if (callback) {
|
|
7476
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaDocument>(
|
|
7477
|
+
parameters,
|
|
7478
|
+
callback as BodyResponseCallback<unknown>
|
|
7479
|
+
);
|
|
7480
|
+
} else {
|
|
7481
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaDocument>(
|
|
7482
|
+
parameters
|
|
7483
|
+
);
|
|
7484
|
+
}
|
|
7485
|
+
}
|
|
7486
|
+
|
|
7487
|
+
/**
|
|
7488
|
+
* Gets the parsed layout information for a Document.
|
|
7489
|
+
*
|
|
7490
|
+
* @param params - Parameters for request
|
|
7491
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7492
|
+
* @param callback - Optional callback that handles the response.
|
|
7493
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7494
|
+
*/
|
|
7495
|
+
getProcessedDocument(
|
|
7496
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument,
|
|
7497
|
+
options: StreamMethodOptions
|
|
7498
|
+
): GaxiosPromise<Readable>;
|
|
7499
|
+
getProcessedDocument(
|
|
7500
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument,
|
|
7501
|
+
options?: MethodOptions
|
|
7502
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>;
|
|
7503
|
+
getProcessedDocument(
|
|
7504
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument,
|
|
7505
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
7506
|
+
callback: BodyResponseCallback<Readable>
|
|
7507
|
+
): void;
|
|
7508
|
+
getProcessedDocument(
|
|
7509
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument,
|
|
7510
|
+
options:
|
|
7511
|
+
| MethodOptions
|
|
7512
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>,
|
|
7513
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>
|
|
7514
|
+
): void;
|
|
7515
|
+
getProcessedDocument(
|
|
7516
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument,
|
|
7517
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>
|
|
7518
|
+
): void;
|
|
7519
|
+
getProcessedDocument(
|
|
7520
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>
|
|
7521
|
+
): void;
|
|
7522
|
+
getProcessedDocument(
|
|
7523
|
+
paramsOrCallback?:
|
|
7524
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument
|
|
7525
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>
|
|
7526
|
+
| BodyResponseCallback<Readable>,
|
|
7527
|
+
optionsOrCallback?:
|
|
7528
|
+
| MethodOptions
|
|
7529
|
+
| StreamMethodOptions
|
|
7530
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>
|
|
7531
|
+
| BodyResponseCallback<Readable>,
|
|
7532
|
+
callback?:
|
|
7533
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>
|
|
7534
|
+
| BodyResponseCallback<Readable>
|
|
7535
|
+
):
|
|
7536
|
+
| void
|
|
7537
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>
|
|
7538
|
+
| GaxiosPromise<Readable> {
|
|
7539
|
+
let params = (paramsOrCallback ||
|
|
7540
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument;
|
|
7541
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
7542
|
+
|
|
7543
|
+
if (typeof paramsOrCallback === 'function') {
|
|
7544
|
+
callback = paramsOrCallback;
|
|
7545
|
+
params =
|
|
7546
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument;
|
|
7547
|
+
options = {};
|
|
7548
|
+
}
|
|
7549
|
+
|
|
7550
|
+
if (typeof optionsOrCallback === 'function') {
|
|
7551
|
+
callback = optionsOrCallback;
|
|
7552
|
+
options = {};
|
|
7553
|
+
}
|
|
7554
|
+
|
|
7555
|
+
const rootUrl =
|
|
7556
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
7557
|
+
const parameters = {
|
|
7558
|
+
options: Object.assign(
|
|
7559
|
+
{
|
|
7560
|
+
url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace(
|
|
7561
|
+
/([^:]\/)\/+/g,
|
|
7562
|
+
'$1'
|
|
7563
|
+
),
|
|
7564
|
+
method: 'GET',
|
|
7565
|
+
},
|
|
7566
|
+
options
|
|
7567
|
+
),
|
|
7568
|
+
params,
|
|
7569
|
+
requiredParams: ['name'],
|
|
7570
|
+
pathParams: ['name'],
|
|
7571
|
+
context: this.context,
|
|
7572
|
+
};
|
|
7573
|
+
if (callback) {
|
|
7574
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>(
|
|
7575
|
+
parameters,
|
|
7576
|
+
callback as BodyResponseCallback<unknown>
|
|
7577
|
+
);
|
|
7578
|
+
} else {
|
|
7579
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>(
|
|
7580
|
+
parameters
|
|
7581
|
+
);
|
|
7582
|
+
}
|
|
7583
|
+
}
|
|
7584
|
+
|
|
7585
|
+
/**
|
|
7586
|
+
* 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.
|
|
7587
|
+
*
|
|
7588
|
+
* @param params - Parameters for request
|
|
7589
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7590
|
+
* @param callback - Optional callback that handles the response.
|
|
7591
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7592
|
+
*/
|
|
7593
|
+
import(
|
|
7594
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import,
|
|
7595
|
+
options: StreamMethodOptions
|
|
7596
|
+
): GaxiosPromise<Readable>;
|
|
7597
|
+
import(
|
|
7598
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import,
|
|
7599
|
+
options?: MethodOptions
|
|
7600
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7601
|
+
import(
|
|
7602
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import,
|
|
7603
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
7604
|
+
callback: BodyResponseCallback<Readable>
|
|
7605
|
+
): void;
|
|
7606
|
+
import(
|
|
7607
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import,
|
|
7608
|
+
options:
|
|
7609
|
+
| MethodOptions
|
|
7610
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
7611
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7612
|
+
): void;
|
|
7613
|
+
import(
|
|
7614
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import,
|
|
7615
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7616
|
+
): void;
|
|
7617
|
+
import(
|
|
7618
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7619
|
+
): void;
|
|
7620
|
+
import(
|
|
7621
|
+
paramsOrCallback?:
|
|
7622
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import
|
|
7623
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7624
|
+
| BodyResponseCallback<Readable>,
|
|
7625
|
+
optionsOrCallback?:
|
|
7626
|
+
| MethodOptions
|
|
7627
|
+
| StreamMethodOptions
|
|
7628
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7629
|
+
| BodyResponseCallback<Readable>,
|
|
7630
|
+
callback?:
|
|
7631
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7632
|
+
| BodyResponseCallback<Readable>
|
|
7633
|
+
):
|
|
7634
|
+
| void
|
|
7635
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
7636
|
+
| GaxiosPromise<Readable> {
|
|
7637
|
+
let params = (paramsOrCallback ||
|
|
7638
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import;
|
|
7639
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
7640
|
+
|
|
7641
|
+
if (typeof paramsOrCallback === 'function') {
|
|
7642
|
+
callback = paramsOrCallback;
|
|
7643
|
+
params =
|
|
7644
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import;
|
|
7645
|
+
options = {};
|
|
7646
|
+
}
|
|
7647
|
+
|
|
7648
|
+
if (typeof optionsOrCallback === 'function') {
|
|
7649
|
+
callback = optionsOrCallback;
|
|
7650
|
+
options = {};
|
|
7651
|
+
}
|
|
7652
|
+
|
|
7653
|
+
const rootUrl =
|
|
7654
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
7655
|
+
const parameters = {
|
|
7656
|
+
options: Object.assign(
|
|
7657
|
+
{
|
|
7658
|
+
url: (rootUrl + '/v1alpha/{+parent}/documents:import').replace(
|
|
7659
|
+
/([^:]\/)\/+/g,
|
|
7660
|
+
'$1'
|
|
7661
|
+
),
|
|
7662
|
+
method: 'POST',
|
|
7663
|
+
},
|
|
7664
|
+
options
|
|
7665
|
+
),
|
|
7666
|
+
params,
|
|
7667
|
+
requiredParams: ['parent'],
|
|
7668
|
+
pathParams: ['parent'],
|
|
7669
|
+
context: this.context,
|
|
7670
|
+
};
|
|
7671
|
+
if (callback) {
|
|
7672
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
7673
|
+
parameters,
|
|
7674
|
+
callback as BodyResponseCallback<unknown>
|
|
7675
|
+
);
|
|
7676
|
+
} else {
|
|
7677
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
7678
|
+
}
|
|
7679
|
+
}
|
|
7680
|
+
|
|
7681
|
+
/**
|
|
7682
|
+
* Gets a list of Documents.
|
|
7683
|
+
*
|
|
7684
|
+
* @param params - Parameters for request
|
|
7685
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7686
|
+
* @param callback - Optional callback that handles the response.
|
|
7687
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7688
|
+
*/
|
|
7689
|
+
list(
|
|
7690
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List,
|
|
7691
|
+
options: StreamMethodOptions
|
|
7692
|
+
): GaxiosPromise<Readable>;
|
|
7693
|
+
list(
|
|
7694
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List,
|
|
7695
|
+
options?: MethodOptions
|
|
7696
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>;
|
|
7697
|
+
list(
|
|
7698
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List,
|
|
7699
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
7700
|
+
callback: BodyResponseCallback<Readable>
|
|
7701
|
+
): void;
|
|
7702
|
+
list(
|
|
7703
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List,
|
|
7704
|
+
options:
|
|
7705
|
+
| MethodOptions
|
|
7706
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>,
|
|
7707
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>
|
|
7708
|
+
): void;
|
|
7709
|
+
list(
|
|
7710
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List,
|
|
7711
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>
|
|
7712
|
+
): void;
|
|
7713
|
+
list(
|
|
7714
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>
|
|
7715
|
+
): void;
|
|
7716
|
+
list(
|
|
7717
|
+
paramsOrCallback?:
|
|
7718
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List
|
|
7719
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>
|
|
7720
|
+
| BodyResponseCallback<Readable>,
|
|
7721
|
+
optionsOrCallback?:
|
|
7722
|
+
| MethodOptions
|
|
7723
|
+
| StreamMethodOptions
|
|
7724
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>
|
|
7725
|
+
| BodyResponseCallback<Readable>,
|
|
7726
|
+
callback?:
|
|
7727
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>
|
|
7728
|
+
| BodyResponseCallback<Readable>
|
|
7729
|
+
):
|
|
7730
|
+
| void
|
|
7731
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>
|
|
7732
|
+
| GaxiosPromise<Readable> {
|
|
7733
|
+
let params = (paramsOrCallback ||
|
|
7734
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List;
|
|
7735
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
7736
|
+
|
|
7737
|
+
if (typeof paramsOrCallback === 'function') {
|
|
7738
|
+
callback = paramsOrCallback;
|
|
7739
|
+
params =
|
|
7740
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List;
|
|
6688
7741
|
options = {};
|
|
6689
7742
|
}
|
|
6690
7743
|
|
|
@@ -6698,64 +7751,69 @@ export namespace discoveryengine_v1alpha {
|
|
|
6698
7751
|
const parameters = {
|
|
6699
7752
|
options: Object.assign(
|
|
6700
7753
|
{
|
|
6701
|
-
url: (rootUrl + '/v1alpha/{+
|
|
6702
|
-
|
|
7754
|
+
url: (rootUrl + '/v1alpha/{+parent}/documents').replace(
|
|
7755
|
+
/([^:]\/)\/+/g,
|
|
7756
|
+
'$1'
|
|
7757
|
+
),
|
|
7758
|
+
method: 'GET',
|
|
6703
7759
|
},
|
|
6704
7760
|
options
|
|
6705
7761
|
),
|
|
6706
7762
|
params,
|
|
6707
|
-
requiredParams: ['
|
|
6708
|
-
pathParams: ['
|
|
7763
|
+
requiredParams: ['parent'],
|
|
7764
|
+
pathParams: ['parent'],
|
|
6709
7765
|
context: this.context,
|
|
6710
7766
|
};
|
|
6711
7767
|
if (callback) {
|
|
6712
|
-
createAPIRequest<Schema$
|
|
7768
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>(
|
|
6713
7769
|
parameters,
|
|
6714
7770
|
callback as BodyResponseCallback<unknown>
|
|
6715
7771
|
);
|
|
6716
7772
|
} else {
|
|
6717
|
-
return createAPIRequest<Schema$
|
|
7773
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>(
|
|
7774
|
+
parameters
|
|
7775
|
+
);
|
|
6718
7776
|
}
|
|
6719
7777
|
}
|
|
6720
7778
|
|
|
6721
7779
|
/**
|
|
6722
|
-
*
|
|
7780
|
+
* Updates a Document.
|
|
6723
7781
|
*
|
|
6724
7782
|
* @param params - Parameters for request
|
|
6725
7783
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6726
7784
|
* @param callback - Optional callback that handles the response.
|
|
6727
7785
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6728
7786
|
*/
|
|
6729
|
-
|
|
6730
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7787
|
+
patch(
|
|
7788
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch,
|
|
6731
7789
|
options: StreamMethodOptions
|
|
6732
7790
|
): GaxiosPromise<Readable>;
|
|
6733
|
-
|
|
6734
|
-
params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7791
|
+
patch(
|
|
7792
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch,
|
|
6735
7793
|
options?: MethodOptions
|
|
6736
7794
|
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDocument>;
|
|
6737
|
-
|
|
6738
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7795
|
+
patch(
|
|
7796
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch,
|
|
6739
7797
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6740
7798
|
callback: BodyResponseCallback<Readable>
|
|
6741
7799
|
): void;
|
|
6742
|
-
|
|
6743
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7800
|
+
patch(
|
|
7801
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch,
|
|
6744
7802
|
options:
|
|
6745
7803
|
| MethodOptions
|
|
6746
7804
|
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>,
|
|
6747
7805
|
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
6748
7806
|
): void;
|
|
6749
|
-
|
|
6750
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7807
|
+
patch(
|
|
7808
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch,
|
|
6751
7809
|
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
6752
7810
|
): void;
|
|
6753
|
-
|
|
7811
|
+
patch(
|
|
6754
7812
|
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
6755
7813
|
): void;
|
|
6756
|
-
|
|
7814
|
+
patch(
|
|
6757
7815
|
paramsOrCallback?:
|
|
6758
|
-
| Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7816
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch
|
|
6759
7817
|
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
6760
7818
|
| BodyResponseCallback<Readable>,
|
|
6761
7819
|
optionsOrCallback?:
|
|
@@ -6771,13 +7829,13 @@ export namespace discoveryengine_v1alpha {
|
|
|
6771
7829
|
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
6772
7830
|
| GaxiosPromise<Readable> {
|
|
6773
7831
|
let params = (paramsOrCallback ||
|
|
6774
|
-
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7832
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch;
|
|
6775
7833
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
6776
7834
|
|
|
6777
7835
|
if (typeof paramsOrCallback === 'function') {
|
|
6778
7836
|
callback = paramsOrCallback;
|
|
6779
7837
|
params =
|
|
6780
|
-
{} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7838
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch;
|
|
6781
7839
|
options = {};
|
|
6782
7840
|
}
|
|
6783
7841
|
|
|
@@ -6792,7 +7850,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
6792
7850
|
options: Object.assign(
|
|
6793
7851
|
{
|
|
6794
7852
|
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
6795
|
-
method: '
|
|
7853
|
+
method: 'PATCH',
|
|
6796
7854
|
},
|
|
6797
7855
|
options
|
|
6798
7856
|
),
|
|
@@ -6814,43 +7872,43 @@ export namespace discoveryengine_v1alpha {
|
|
|
6814
7872
|
}
|
|
6815
7873
|
|
|
6816
7874
|
/**
|
|
6817
|
-
*
|
|
7875
|
+
* Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false.
|
|
6818
7876
|
*
|
|
6819
7877
|
* @param params - Parameters for request
|
|
6820
7878
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6821
7879
|
* @param callback - Optional callback that handles the response.
|
|
6822
7880
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6823
7881
|
*/
|
|
6824
|
-
|
|
6825
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7882
|
+
purge(
|
|
7883
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge,
|
|
6826
7884
|
options: StreamMethodOptions
|
|
6827
7885
|
): GaxiosPromise<Readable>;
|
|
6828
|
-
|
|
6829
|
-
params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7886
|
+
purge(
|
|
7887
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge,
|
|
6830
7888
|
options?: MethodOptions
|
|
6831
7889
|
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6832
|
-
|
|
6833
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7890
|
+
purge(
|
|
7891
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge,
|
|
6834
7892
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6835
7893
|
callback: BodyResponseCallback<Readable>
|
|
6836
7894
|
): void;
|
|
6837
|
-
|
|
6838
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7895
|
+
purge(
|
|
7896
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge,
|
|
6839
7897
|
options:
|
|
6840
7898
|
| MethodOptions
|
|
6841
7899
|
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
6842
7900
|
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6843
7901
|
): void;
|
|
6844
|
-
|
|
6845
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7902
|
+
purge(
|
|
7903
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge,
|
|
6846
7904
|
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6847
7905
|
): void;
|
|
6848
|
-
|
|
7906
|
+
purge(
|
|
6849
7907
|
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6850
7908
|
): void;
|
|
6851
|
-
|
|
7909
|
+
purge(
|
|
6852
7910
|
paramsOrCallback?:
|
|
6853
|
-
| Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7911
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge
|
|
6854
7912
|
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6855
7913
|
| BodyResponseCallback<Readable>,
|
|
6856
7914
|
optionsOrCallback?:
|
|
@@ -6866,13 +7924,13 @@ export namespace discoveryengine_v1alpha {
|
|
|
6866
7924
|
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
6867
7925
|
| GaxiosPromise<Readable> {
|
|
6868
7926
|
let params = (paramsOrCallback ||
|
|
6869
|
-
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7927
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge;
|
|
6870
7928
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
6871
7929
|
|
|
6872
7930
|
if (typeof paramsOrCallback === 'function') {
|
|
6873
7931
|
callback = paramsOrCallback;
|
|
6874
7932
|
params =
|
|
6875
|
-
{} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7933
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge;
|
|
6876
7934
|
options = {};
|
|
6877
7935
|
}
|
|
6878
7936
|
|
|
@@ -6886,7 +7944,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
6886
7944
|
const parameters = {
|
|
6887
7945
|
options: Object.assign(
|
|
6888
7946
|
{
|
|
6889
|
-
url: (rootUrl + '/v1alpha/{+parent}/documents:
|
|
7947
|
+
url: (rootUrl + '/v1alpha/{+parent}/documents:purge').replace(
|
|
6890
7948
|
/([^:]\/)\/+/g,
|
|
6891
7949
|
'$1'
|
|
6892
7950
|
),
|
|
@@ -6908,165 +7966,179 @@ export namespace discoveryengine_v1alpha {
|
|
|
6908
7966
|
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
6909
7967
|
}
|
|
6910
7968
|
}
|
|
7969
|
+
}
|
|
6911
7970
|
|
|
7971
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create
|
|
7972
|
+
extends StandardParameters {
|
|
6912
7973
|
/**
|
|
6913
|
-
*
|
|
6914
|
-
*
|
|
6915
|
-
* @param params - Parameters for request
|
|
6916
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6917
|
-
* @param callback - Optional callback that handles the response.
|
|
6918
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7974
|
+
* Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
6919
7975
|
*/
|
|
6920
|
-
|
|
6921
|
-
|
|
6922
|
-
|
|
6923
|
-
|
|
6924
|
-
|
|
6925
|
-
params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List,
|
|
6926
|
-
options?: MethodOptions
|
|
6927
|
-
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>;
|
|
6928
|
-
list(
|
|
6929
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List,
|
|
6930
|
-
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6931
|
-
callback: BodyResponseCallback<Readable>
|
|
6932
|
-
): void;
|
|
6933
|
-
list(
|
|
6934
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List,
|
|
6935
|
-
options:
|
|
6936
|
-
| MethodOptions
|
|
6937
|
-
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>,
|
|
6938
|
-
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>
|
|
6939
|
-
): void;
|
|
6940
|
-
list(
|
|
6941
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List,
|
|
6942
|
-
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>
|
|
6943
|
-
): void;
|
|
6944
|
-
list(
|
|
6945
|
-
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>
|
|
6946
|
-
): void;
|
|
6947
|
-
list(
|
|
6948
|
-
paramsOrCallback?:
|
|
6949
|
-
| Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List
|
|
6950
|
-
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>
|
|
6951
|
-
| BodyResponseCallback<Readable>,
|
|
6952
|
-
optionsOrCallback?:
|
|
6953
|
-
| MethodOptions
|
|
6954
|
-
| StreamMethodOptions
|
|
6955
|
-
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>
|
|
6956
|
-
| BodyResponseCallback<Readable>,
|
|
6957
|
-
callback?:
|
|
6958
|
-
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>
|
|
6959
|
-
| BodyResponseCallback<Readable>
|
|
6960
|
-
):
|
|
6961
|
-
| void
|
|
6962
|
-
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>
|
|
6963
|
-
| GaxiosPromise<Readable> {
|
|
6964
|
-
let params = (paramsOrCallback ||
|
|
6965
|
-
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List;
|
|
6966
|
-
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
7976
|
+
documentId?: string;
|
|
7977
|
+
/**
|
|
7978
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`.
|
|
7979
|
+
*/
|
|
7980
|
+
parent?: string;
|
|
6967
7981
|
|
|
6968
|
-
|
|
6969
|
-
|
|
6970
|
-
|
|
6971
|
-
|
|
6972
|
-
|
|
6973
|
-
|
|
7982
|
+
/**
|
|
7983
|
+
* Request body metadata
|
|
7984
|
+
*/
|
|
7985
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument;
|
|
7986
|
+
}
|
|
7987
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete
|
|
7988
|
+
extends StandardParameters {
|
|
7989
|
+
/**
|
|
7990
|
+
* 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 delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.
|
|
7991
|
+
*/
|
|
7992
|
+
name?: string;
|
|
7993
|
+
}
|
|
7994
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get
|
|
7995
|
+
extends StandardParameters {
|
|
7996
|
+
/**
|
|
7997
|
+
* 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.
|
|
7998
|
+
*/
|
|
7999
|
+
name?: string;
|
|
8000
|
+
}
|
|
8001
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument
|
|
8002
|
+
extends StandardParameters {
|
|
8003
|
+
/**
|
|
8004
|
+
* 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.
|
|
8005
|
+
*/
|
|
8006
|
+
name?: string;
|
|
8007
|
+
/**
|
|
8008
|
+
* What format output should be. If unspecified, defaults to JSON.
|
|
8009
|
+
*/
|
|
8010
|
+
processedDocumentFormat?: string;
|
|
8011
|
+
/**
|
|
8012
|
+
* Required. What type of processing to return.
|
|
8013
|
+
*/
|
|
8014
|
+
processedDocumentType?: string;
|
|
8015
|
+
}
|
|
8016
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import
|
|
8017
|
+
extends StandardParameters {
|
|
8018
|
+
/**
|
|
8019
|
+
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission.
|
|
8020
|
+
*/
|
|
8021
|
+
parent?: string;
|
|
6974
8022
|
|
|
6975
|
-
|
|
6976
|
-
|
|
6977
|
-
|
|
6978
|
-
|
|
8023
|
+
/**
|
|
8024
|
+
* Request body metadata
|
|
8025
|
+
*/
|
|
8026
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest;
|
|
8027
|
+
}
|
|
8028
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List
|
|
8029
|
+
extends StandardParameters {
|
|
8030
|
+
/**
|
|
8031
|
+
* Maximum number of Documents 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.
|
|
8032
|
+
*/
|
|
8033
|
+
pageSize?: number;
|
|
8034
|
+
/**
|
|
8035
|
+
* A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
8036
|
+
*/
|
|
8037
|
+
pageToken?: string;
|
|
8038
|
+
/**
|
|
8039
|
+
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.
|
|
8040
|
+
*/
|
|
8041
|
+
parent?: string;
|
|
8042
|
+
}
|
|
8043
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch
|
|
8044
|
+
extends StandardParameters {
|
|
8045
|
+
/**
|
|
8046
|
+
* If set to true, and the Document is not found, a new Document will be created.
|
|
8047
|
+
*/
|
|
8048
|
+
allowMissing?: boolean;
|
|
8049
|
+
/**
|
|
8050
|
+
* 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.
|
|
8051
|
+
*/
|
|
8052
|
+
name?: string;
|
|
8053
|
+
/**
|
|
8054
|
+
* Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
|
|
8055
|
+
*/
|
|
8056
|
+
updateMask?: string;
|
|
6979
8057
|
|
|
6980
|
-
|
|
6981
|
-
|
|
6982
|
-
|
|
6983
|
-
|
|
6984
|
-
|
|
6985
|
-
|
|
6986
|
-
|
|
6987
|
-
|
|
6988
|
-
|
|
6989
|
-
|
|
6990
|
-
|
|
6991
|
-
|
|
6992
|
-
|
|
6993
|
-
|
|
6994
|
-
|
|
6995
|
-
|
|
6996
|
-
|
|
6997
|
-
|
|
6998
|
-
|
|
6999
|
-
|
|
7000
|
-
|
|
7001
|
-
|
|
7002
|
-
);
|
|
7003
|
-
} else {
|
|
7004
|
-
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>(
|
|
7005
|
-
parameters
|
|
7006
|
-
);
|
|
7007
|
-
}
|
|
8058
|
+
/**
|
|
8059
|
+
* Request body metadata
|
|
8060
|
+
*/
|
|
8061
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument;
|
|
8062
|
+
}
|
|
8063
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge
|
|
8064
|
+
extends StandardParameters {
|
|
8065
|
+
/**
|
|
8066
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`.
|
|
8067
|
+
*/
|
|
8068
|
+
parent?: string;
|
|
8069
|
+
|
|
8070
|
+
/**
|
|
8071
|
+
* Request body metadata
|
|
8072
|
+
*/
|
|
8073
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest;
|
|
8074
|
+
}
|
|
8075
|
+
|
|
8076
|
+
export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks {
|
|
8077
|
+
context: APIRequestContext;
|
|
8078
|
+
constructor(context: APIRequestContext) {
|
|
8079
|
+
this.context = context;
|
|
7008
8080
|
}
|
|
7009
8081
|
|
|
7010
8082
|
/**
|
|
7011
|
-
*
|
|
8083
|
+
* Gets a Document.
|
|
7012
8084
|
*
|
|
7013
8085
|
* @param params - Parameters for request
|
|
7014
8086
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7015
8087
|
* @param callback - Optional callback that handles the response.
|
|
7016
8088
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7017
8089
|
*/
|
|
7018
|
-
|
|
7019
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
8090
|
+
get(
|
|
8091
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get,
|
|
7020
8092
|
options: StreamMethodOptions
|
|
7021
8093
|
): GaxiosPromise<Readable>;
|
|
7022
|
-
|
|
7023
|
-
params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
8094
|
+
get(
|
|
8095
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get,
|
|
7024
8096
|
options?: MethodOptions
|
|
7025
|
-
): GaxiosPromise<Schema$
|
|
7026
|
-
|
|
7027
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
8097
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaChunk>;
|
|
8098
|
+
get(
|
|
8099
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get,
|
|
7028
8100
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
7029
8101
|
callback: BodyResponseCallback<Readable>
|
|
7030
8102
|
): void;
|
|
7031
|
-
|
|
7032
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
8103
|
+
get(
|
|
8104
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get,
|
|
7033
8105
|
options:
|
|
7034
8106
|
| MethodOptions
|
|
7035
|
-
| BodyResponseCallback<Schema$
|
|
7036
|
-
callback: BodyResponseCallback<Schema$
|
|
8107
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>,
|
|
8108
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>
|
|
7037
8109
|
): void;
|
|
7038
|
-
|
|
7039
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7040
|
-
callback: BodyResponseCallback<Schema$
|
|
8110
|
+
get(
|
|
8111
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get,
|
|
8112
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>
|
|
7041
8113
|
): void;
|
|
7042
|
-
|
|
7043
|
-
callback: BodyResponseCallback<Schema$
|
|
8114
|
+
get(
|
|
8115
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>
|
|
7044
8116
|
): void;
|
|
7045
|
-
|
|
8117
|
+
get(
|
|
7046
8118
|
paramsOrCallback?:
|
|
7047
|
-
| Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7048
|
-
| BodyResponseCallback<Schema$
|
|
8119
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get
|
|
8120
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>
|
|
7049
8121
|
| BodyResponseCallback<Readable>,
|
|
7050
8122
|
optionsOrCallback?:
|
|
7051
8123
|
| MethodOptions
|
|
7052
8124
|
| StreamMethodOptions
|
|
7053
|
-
| BodyResponseCallback<Schema$
|
|
8125
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>
|
|
7054
8126
|
| BodyResponseCallback<Readable>,
|
|
7055
8127
|
callback?:
|
|
7056
|
-
| BodyResponseCallback<Schema$
|
|
8128
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>
|
|
7057
8129
|
| BodyResponseCallback<Readable>
|
|
7058
8130
|
):
|
|
7059
8131
|
| void
|
|
7060
|
-
| GaxiosPromise<Schema$
|
|
8132
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaChunk>
|
|
7061
8133
|
| GaxiosPromise<Readable> {
|
|
7062
8134
|
let params = (paramsOrCallback ||
|
|
7063
|
-
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
8135
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get;
|
|
7064
8136
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
7065
8137
|
|
|
7066
8138
|
if (typeof paramsOrCallback === 'function') {
|
|
7067
8139
|
callback = paramsOrCallback;
|
|
7068
8140
|
params =
|
|
7069
|
-
{} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
8141
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get;
|
|
7070
8142
|
options = {};
|
|
7071
8143
|
}
|
|
7072
8144
|
|
|
@@ -7081,7 +8153,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
7081
8153
|
options: Object.assign(
|
|
7082
8154
|
{
|
|
7083
8155
|
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
7084
|
-
method: '
|
|
8156
|
+
method: 'GET',
|
|
7085
8157
|
},
|
|
7086
8158
|
options
|
|
7087
8159
|
),
|
|
@@ -7091,77 +8163,77 @@ export namespace discoveryengine_v1alpha {
|
|
|
7091
8163
|
context: this.context,
|
|
7092
8164
|
};
|
|
7093
8165
|
if (callback) {
|
|
7094
|
-
createAPIRequest<Schema$
|
|
8166
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaChunk>(
|
|
7095
8167
|
parameters,
|
|
7096
8168
|
callback as BodyResponseCallback<unknown>
|
|
7097
8169
|
);
|
|
7098
8170
|
} else {
|
|
7099
|
-
return createAPIRequest<Schema$
|
|
8171
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaChunk>(
|
|
7100
8172
|
parameters
|
|
7101
8173
|
);
|
|
7102
8174
|
}
|
|
7103
8175
|
}
|
|
7104
8176
|
|
|
7105
8177
|
/**
|
|
7106
|
-
*
|
|
8178
|
+
* Gets a list of Chunks.
|
|
7107
8179
|
*
|
|
7108
8180
|
* @param params - Parameters for request
|
|
7109
8181
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7110
8182
|
* @param callback - Optional callback that handles the response.
|
|
7111
8183
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7112
8184
|
*/
|
|
7113
|
-
|
|
7114
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
8185
|
+
list(
|
|
8186
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List,
|
|
7115
8187
|
options: StreamMethodOptions
|
|
7116
8188
|
): GaxiosPromise<Readable>;
|
|
7117
|
-
|
|
7118
|
-
params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
8189
|
+
list(
|
|
8190
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List,
|
|
7119
8191
|
options?: MethodOptions
|
|
7120
|
-
): GaxiosPromise<Schema$
|
|
7121
|
-
|
|
7122
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
8192
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>;
|
|
8193
|
+
list(
|
|
8194
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List,
|
|
7123
8195
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
7124
8196
|
callback: BodyResponseCallback<Readable>
|
|
7125
8197
|
): void;
|
|
7126
|
-
|
|
7127
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
8198
|
+
list(
|
|
8199
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List,
|
|
7128
8200
|
options:
|
|
7129
8201
|
| MethodOptions
|
|
7130
|
-
| BodyResponseCallback<Schema$
|
|
7131
|
-
callback: BodyResponseCallback<Schema$
|
|
8202
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>,
|
|
8203
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>
|
|
7132
8204
|
): void;
|
|
7133
|
-
|
|
7134
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7135
|
-
callback: BodyResponseCallback<Schema$
|
|
8205
|
+
list(
|
|
8206
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List,
|
|
8207
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>
|
|
7136
8208
|
): void;
|
|
7137
|
-
|
|
7138
|
-
callback: BodyResponseCallback<Schema$
|
|
8209
|
+
list(
|
|
8210
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>
|
|
7139
8211
|
): void;
|
|
7140
|
-
|
|
8212
|
+
list(
|
|
7141
8213
|
paramsOrCallback?:
|
|
7142
|
-
| Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7143
|
-
| BodyResponseCallback<Schema$
|
|
8214
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List
|
|
8215
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>
|
|
7144
8216
|
| BodyResponseCallback<Readable>,
|
|
7145
8217
|
optionsOrCallback?:
|
|
7146
8218
|
| MethodOptions
|
|
7147
8219
|
| StreamMethodOptions
|
|
7148
|
-
| BodyResponseCallback<Schema$
|
|
8220
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>
|
|
7149
8221
|
| BodyResponseCallback<Readable>,
|
|
7150
8222
|
callback?:
|
|
7151
|
-
| BodyResponseCallback<Schema$
|
|
8223
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>
|
|
7152
8224
|
| BodyResponseCallback<Readable>
|
|
7153
8225
|
):
|
|
7154
8226
|
| void
|
|
7155
|
-
| GaxiosPromise<Schema$
|
|
8227
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>
|
|
7156
8228
|
| GaxiosPromise<Readable> {
|
|
7157
8229
|
let params = (paramsOrCallback ||
|
|
7158
|
-
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
8230
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List;
|
|
7159
8231
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
7160
8232
|
|
|
7161
8233
|
if (typeof paramsOrCallback === 'function') {
|
|
7162
8234
|
callback = paramsOrCallback;
|
|
7163
8235
|
params =
|
|
7164
|
-
{} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
8236
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List;
|
|
7165
8237
|
options = {};
|
|
7166
8238
|
}
|
|
7167
8239
|
|
|
@@ -7175,11 +8247,11 @@ export namespace discoveryengine_v1alpha {
|
|
|
7175
8247
|
const parameters = {
|
|
7176
8248
|
options: Object.assign(
|
|
7177
8249
|
{
|
|
7178
|
-
url: (rootUrl + '/v1alpha/{+parent}/
|
|
8250
|
+
url: (rootUrl + '/v1alpha/{+parent}/chunks').replace(
|
|
7179
8251
|
/([^:]\/)\/+/g,
|
|
7180
8252
|
'$1'
|
|
7181
8253
|
),
|
|
7182
|
-
method: '
|
|
8254
|
+
method: 'GET',
|
|
7183
8255
|
},
|
|
7184
8256
|
options
|
|
7185
8257
|
),
|
|
@@ -7189,100 +8261,39 @@ export namespace discoveryengine_v1alpha {
|
|
|
7189
8261
|
context: this.context,
|
|
7190
8262
|
};
|
|
7191
8263
|
if (callback) {
|
|
7192
|
-
createAPIRequest<Schema$
|
|
8264
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>(
|
|
7193
8265
|
parameters,
|
|
7194
8266
|
callback as BodyResponseCallback<unknown>
|
|
7195
8267
|
);
|
|
7196
8268
|
} else {
|
|
7197
|
-
return createAPIRequest<Schema$
|
|
8269
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>(
|
|
8270
|
+
parameters
|
|
8271
|
+
);
|
|
7198
8272
|
}
|
|
7199
8273
|
}
|
|
7200
8274
|
}
|
|
7201
8275
|
|
|
7202
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7203
|
-
extends StandardParameters {
|
|
7204
|
-
/**
|
|
7205
|
-
* Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
7206
|
-
*/
|
|
7207
|
-
documentId?: string;
|
|
7208
|
-
/**
|
|
7209
|
-
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`.
|
|
7210
|
-
*/
|
|
7211
|
-
parent?: string;
|
|
7212
|
-
|
|
7213
|
-
/**
|
|
7214
|
-
* Request body metadata
|
|
7215
|
-
*/
|
|
7216
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument;
|
|
7217
|
-
}
|
|
7218
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete
|
|
7219
|
-
extends StandardParameters {
|
|
7220
|
-
/**
|
|
7221
|
-
* 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 delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.
|
|
7222
|
-
*/
|
|
7223
|
-
name?: string;
|
|
7224
|
-
}
|
|
7225
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get
|
|
8276
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get
|
|
7226
8277
|
extends StandardParameters {
|
|
7227
8278
|
/**
|
|
7228
|
-
* Required. Full resource name of
|
|
8279
|
+
* 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.
|
|
7229
8280
|
*/
|
|
7230
8281
|
name?: string;
|
|
7231
8282
|
}
|
|
7232
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
7233
|
-
extends StandardParameters {
|
|
7234
|
-
/**
|
|
7235
|
-
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission.
|
|
7236
|
-
*/
|
|
7237
|
-
parent?: string;
|
|
7238
|
-
|
|
7239
|
-
/**
|
|
7240
|
-
* Request body metadata
|
|
7241
|
-
*/
|
|
7242
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest;
|
|
7243
|
-
}
|
|
7244
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List
|
|
8283
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List
|
|
7245
8284
|
extends StandardParameters {
|
|
7246
8285
|
/**
|
|
7247
|
-
* Maximum number of
|
|
8286
|
+
* 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.
|
|
7248
8287
|
*/
|
|
7249
8288
|
pageSize?: number;
|
|
7250
8289
|
/**
|
|
7251
|
-
* A page token
|
|
8290
|
+
* 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.
|
|
7252
8291
|
*/
|
|
7253
8292
|
pageToken?: string;
|
|
7254
8293
|
/**
|
|
7255
|
-
* Required. The parent
|
|
7256
|
-
*/
|
|
7257
|
-
parent?: string;
|
|
7258
|
-
}
|
|
7259
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch
|
|
7260
|
-
extends StandardParameters {
|
|
7261
|
-
/**
|
|
7262
|
-
* If set to true, and the Document is not found, a new Document will be created.
|
|
7263
|
-
*/
|
|
7264
|
-
allowMissing?: boolean;
|
|
7265
|
-
/**
|
|
7266
|
-
* Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
7267
|
-
*/
|
|
7268
|
-
name?: string;
|
|
7269
|
-
|
|
7270
|
-
/**
|
|
7271
|
-
* Request body metadata
|
|
7272
|
-
*/
|
|
7273
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument;
|
|
7274
|
-
}
|
|
7275
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge
|
|
7276
|
-
extends StandardParameters {
|
|
7277
|
-
/**
|
|
7278
|
-
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`.
|
|
8294
|
+
* 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.
|
|
7279
8295
|
*/
|
|
7280
8296
|
parent?: string;
|
|
7281
|
-
|
|
7282
|
-
/**
|
|
7283
|
-
* Request body metadata
|
|
7284
|
-
*/
|
|
7285
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest;
|
|
7286
8297
|
}
|
|
7287
8298
|
|
|
7288
8299
|
export class Resource$Projects$Locations$Collections$Datastores$Branches$Operations {
|
|
@@ -9898,7 +10909,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
9898
10909
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get
|
|
9899
10910
|
extends StandardParameters {
|
|
9900
10911
|
/**
|
|
9901
|
-
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/
|
|
10912
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
9902
10913
|
*/
|
|
9903
10914
|
name?: string;
|
|
9904
10915
|
}
|
|
@@ -9913,14 +10924,14 @@ export namespace discoveryengine_v1alpha {
|
|
|
9913
10924
|
*/
|
|
9914
10925
|
pageToken?: string;
|
|
9915
10926
|
/**
|
|
9916
|
-
* Required.
|
|
10927
|
+
* Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
9917
10928
|
*/
|
|
9918
10929
|
parent?: string;
|
|
9919
10930
|
}
|
|
9920
10931
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch
|
|
9921
10932
|
extends StandardParameters {
|
|
9922
10933
|
/**
|
|
9923
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/
|
|
10934
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
9924
10935
|
*/
|
|
9925
10936
|
name?: string;
|
|
9926
10937
|
/**
|
|
@@ -14553,7 +15564,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
14553
15564
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get
|
|
14554
15565
|
extends StandardParameters {
|
|
14555
15566
|
/**
|
|
14556
|
-
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/
|
|
15567
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
14557
15568
|
*/
|
|
14558
15569
|
name?: string;
|
|
14559
15570
|
}
|
|
@@ -14568,14 +15579,14 @@ export namespace discoveryengine_v1alpha {
|
|
|
14568
15579
|
*/
|
|
14569
15580
|
pageToken?: string;
|
|
14570
15581
|
/**
|
|
14571
|
-
* Required.
|
|
15582
|
+
* Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
14572
15583
|
*/
|
|
14573
15584
|
parent?: string;
|
|
14574
15585
|
}
|
|
14575
15586
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch
|
|
14576
15587
|
extends StandardParameters {
|
|
14577
15588
|
/**
|
|
14578
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/
|
|
15589
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
14579
15590
|
*/
|
|
14580
15591
|
name?: string;
|
|
14581
15592
|
/**
|
|
@@ -15878,8 +16889,13 @@ export namespace discoveryengine_v1alpha {
|
|
|
15878
16889
|
|
|
15879
16890
|
export class Resource$Projects$Locations$Datastores$Branches$Documents {
|
|
15880
16891
|
context: APIRequestContext;
|
|
16892
|
+
chunks: Resource$Projects$Locations$Datastores$Branches$Documents$Chunks;
|
|
15881
16893
|
constructor(context: APIRequestContext) {
|
|
15882
16894
|
this.context = context;
|
|
16895
|
+
this.chunks =
|
|
16896
|
+
new Resource$Projects$Locations$Datastores$Branches$Documents$Chunks(
|
|
16897
|
+
this.context
|
|
16898
|
+
);
|
|
15883
16899
|
}
|
|
15884
16900
|
|
|
15885
16901
|
/**
|
|
@@ -16006,36 +17022,129 @@ export namespace discoveryengine_v1alpha {
|
|
|
16006
17022
|
options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>,
|
|
16007
17023
|
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
16008
17024
|
): void;
|
|
16009
|
-
delete(
|
|
16010
|
-
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete,
|
|
16011
|
-
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
17025
|
+
delete(
|
|
17026
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete,
|
|
17027
|
+
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
17028
|
+
): void;
|
|
17029
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
17030
|
+
delete(
|
|
17031
|
+
paramsOrCallback?:
|
|
17032
|
+
| Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete
|
|
17033
|
+
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
17034
|
+
| BodyResponseCallback<Readable>,
|
|
17035
|
+
optionsOrCallback?:
|
|
17036
|
+
| MethodOptions
|
|
17037
|
+
| StreamMethodOptions
|
|
17038
|
+
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
17039
|
+
| BodyResponseCallback<Readable>,
|
|
17040
|
+
callback?:
|
|
17041
|
+
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
17042
|
+
| BodyResponseCallback<Readable>
|
|
17043
|
+
):
|
|
17044
|
+
| void
|
|
17045
|
+
| GaxiosPromise<Schema$GoogleProtobufEmpty>
|
|
17046
|
+
| GaxiosPromise<Readable> {
|
|
17047
|
+
let params = (paramsOrCallback ||
|
|
17048
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete;
|
|
17049
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
17050
|
+
|
|
17051
|
+
if (typeof paramsOrCallback === 'function') {
|
|
17052
|
+
callback = paramsOrCallback;
|
|
17053
|
+
params =
|
|
17054
|
+
{} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete;
|
|
17055
|
+
options = {};
|
|
17056
|
+
}
|
|
17057
|
+
|
|
17058
|
+
if (typeof optionsOrCallback === 'function') {
|
|
17059
|
+
callback = optionsOrCallback;
|
|
17060
|
+
options = {};
|
|
17061
|
+
}
|
|
17062
|
+
|
|
17063
|
+
const rootUrl =
|
|
17064
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
17065
|
+
const parameters = {
|
|
17066
|
+
options: Object.assign(
|
|
17067
|
+
{
|
|
17068
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
17069
|
+
method: 'DELETE',
|
|
17070
|
+
},
|
|
17071
|
+
options
|
|
17072
|
+
),
|
|
17073
|
+
params,
|
|
17074
|
+
requiredParams: ['name'],
|
|
17075
|
+
pathParams: ['name'],
|
|
17076
|
+
context: this.context,
|
|
17077
|
+
};
|
|
17078
|
+
if (callback) {
|
|
17079
|
+
createAPIRequest<Schema$GoogleProtobufEmpty>(
|
|
17080
|
+
parameters,
|
|
17081
|
+
callback as BodyResponseCallback<unknown>
|
|
17082
|
+
);
|
|
17083
|
+
} else {
|
|
17084
|
+
return createAPIRequest<Schema$GoogleProtobufEmpty>(parameters);
|
|
17085
|
+
}
|
|
17086
|
+
}
|
|
17087
|
+
|
|
17088
|
+
/**
|
|
17089
|
+
* Gets a Document.
|
|
17090
|
+
*
|
|
17091
|
+
* @param params - Parameters for request
|
|
17092
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
17093
|
+
* @param callback - Optional callback that handles the response.
|
|
17094
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
17095
|
+
*/
|
|
17096
|
+
get(
|
|
17097
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get,
|
|
17098
|
+
options: StreamMethodOptions
|
|
17099
|
+
): GaxiosPromise<Readable>;
|
|
17100
|
+
get(
|
|
17101
|
+
params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get,
|
|
17102
|
+
options?: MethodOptions
|
|
17103
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDocument>;
|
|
17104
|
+
get(
|
|
17105
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get,
|
|
17106
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
17107
|
+
callback: BodyResponseCallback<Readable>
|
|
17108
|
+
): void;
|
|
17109
|
+
get(
|
|
17110
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get,
|
|
17111
|
+
options:
|
|
17112
|
+
| MethodOptions
|
|
17113
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>,
|
|
17114
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
17115
|
+
): void;
|
|
17116
|
+
get(
|
|
17117
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get,
|
|
17118
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
16012
17119
|
): void;
|
|
16013
|
-
|
|
16014
|
-
|
|
17120
|
+
get(
|
|
17121
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
17122
|
+
): void;
|
|
17123
|
+
get(
|
|
16015
17124
|
paramsOrCallback?:
|
|
16016
|
-
| Params$Resource$Projects$Locations$Datastores$Branches$Documents$
|
|
16017
|
-
| BodyResponseCallback<Schema$
|
|
17125
|
+
| Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get
|
|
17126
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
16018
17127
|
| BodyResponseCallback<Readable>,
|
|
16019
17128
|
optionsOrCallback?:
|
|
16020
17129
|
| MethodOptions
|
|
16021
17130
|
| StreamMethodOptions
|
|
16022
|
-
| BodyResponseCallback<Schema$
|
|
17131
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
16023
17132
|
| BodyResponseCallback<Readable>,
|
|
16024
17133
|
callback?:
|
|
16025
|
-
| BodyResponseCallback<Schema$
|
|
17134
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
16026
17135
|
| BodyResponseCallback<Readable>
|
|
16027
17136
|
):
|
|
16028
17137
|
| void
|
|
16029
|
-
| GaxiosPromise<Schema$
|
|
17138
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDocument>
|
|
16030
17139
|
| GaxiosPromise<Readable> {
|
|
16031
17140
|
let params = (paramsOrCallback ||
|
|
16032
|
-
{}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$
|
|
17141
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get;
|
|
16033
17142
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
16034
17143
|
|
|
16035
17144
|
if (typeof paramsOrCallback === 'function') {
|
|
16036
17145
|
callback = paramsOrCallback;
|
|
16037
17146
|
params =
|
|
16038
|
-
{} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$
|
|
17147
|
+
{} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get;
|
|
16039
17148
|
options = {};
|
|
16040
17149
|
}
|
|
16041
17150
|
|
|
@@ -16050,7 +17159,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
16050
17159
|
options: Object.assign(
|
|
16051
17160
|
{
|
|
16052
17161
|
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
16053
|
-
method: '
|
|
17162
|
+
method: 'GET',
|
|
16054
17163
|
},
|
|
16055
17164
|
options
|
|
16056
17165
|
),
|
|
@@ -16060,75 +17169,77 @@ export namespace discoveryengine_v1alpha {
|
|
|
16060
17169
|
context: this.context,
|
|
16061
17170
|
};
|
|
16062
17171
|
if (callback) {
|
|
16063
|
-
createAPIRequest<Schema$
|
|
17172
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaDocument>(
|
|
16064
17173
|
parameters,
|
|
16065
17174
|
callback as BodyResponseCallback<unknown>
|
|
16066
17175
|
);
|
|
16067
17176
|
} else {
|
|
16068
|
-
return createAPIRequest<Schema$
|
|
17177
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaDocument>(
|
|
17178
|
+
parameters
|
|
17179
|
+
);
|
|
16069
17180
|
}
|
|
16070
17181
|
}
|
|
16071
17182
|
|
|
16072
17183
|
/**
|
|
16073
|
-
* Gets a Document.
|
|
17184
|
+
* Gets the parsed layout information for a Document.
|
|
16074
17185
|
*
|
|
16075
17186
|
* @param params - Parameters for request
|
|
16076
17187
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
16077
17188
|
* @param callback - Optional callback that handles the response.
|
|
16078
17189
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
16079
17190
|
*/
|
|
16080
|
-
|
|
16081
|
-
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$
|
|
17191
|
+
getProcessedDocument(
|
|
17192
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument,
|
|
16082
17193
|
options: StreamMethodOptions
|
|
16083
17194
|
): GaxiosPromise<Readable>;
|
|
16084
|
-
|
|
16085
|
-
params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$
|
|
17195
|
+
getProcessedDocument(
|
|
17196
|
+
params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument,
|
|
16086
17197
|
options?: MethodOptions
|
|
16087
|
-
): GaxiosPromise<Schema$
|
|
16088
|
-
|
|
16089
|
-
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$
|
|
17198
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>;
|
|
17199
|
+
getProcessedDocument(
|
|
17200
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument,
|
|
16090
17201
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
16091
17202
|
callback: BodyResponseCallback<Readable>
|
|
16092
17203
|
): void;
|
|
16093
|
-
|
|
16094
|
-
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$
|
|
17204
|
+
getProcessedDocument(
|
|
17205
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument,
|
|
16095
17206
|
options:
|
|
16096
17207
|
| MethodOptions
|
|
16097
|
-
| BodyResponseCallback<Schema$
|
|
16098
|
-
callback: BodyResponseCallback<Schema$
|
|
17208
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>,
|
|
17209
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>
|
|
16099
17210
|
): void;
|
|
16100
|
-
|
|
16101
|
-
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$
|
|
16102
|
-
callback: BodyResponseCallback<Schema$
|
|
17211
|
+
getProcessedDocument(
|
|
17212
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument,
|
|
17213
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>
|
|
16103
17214
|
): void;
|
|
16104
|
-
|
|
16105
|
-
callback: BodyResponseCallback<Schema$
|
|
17215
|
+
getProcessedDocument(
|
|
17216
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>
|
|
16106
17217
|
): void;
|
|
16107
|
-
|
|
17218
|
+
getProcessedDocument(
|
|
16108
17219
|
paramsOrCallback?:
|
|
16109
|
-
| Params$Resource$Projects$Locations$Datastores$Branches$Documents$
|
|
16110
|
-
| BodyResponseCallback<Schema$
|
|
17220
|
+
| Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument
|
|
17221
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>
|
|
16111
17222
|
| BodyResponseCallback<Readable>,
|
|
16112
17223
|
optionsOrCallback?:
|
|
16113
17224
|
| MethodOptions
|
|
16114
17225
|
| StreamMethodOptions
|
|
16115
|
-
| BodyResponseCallback<Schema$
|
|
17226
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>
|
|
16116
17227
|
| BodyResponseCallback<Readable>,
|
|
16117
17228
|
callback?:
|
|
16118
|
-
| BodyResponseCallback<Schema$
|
|
17229
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>
|
|
16119
17230
|
| BodyResponseCallback<Readable>
|
|
16120
17231
|
):
|
|
16121
17232
|
| void
|
|
16122
|
-
| GaxiosPromise<Schema$
|
|
17233
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>
|
|
16123
17234
|
| GaxiosPromise<Readable> {
|
|
16124
17235
|
let params = (paramsOrCallback ||
|
|
16125
|
-
{}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$
|
|
17236
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument;
|
|
16126
17237
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
16127
17238
|
|
|
16128
17239
|
if (typeof paramsOrCallback === 'function') {
|
|
16129
17240
|
callback = paramsOrCallback;
|
|
16130
17241
|
params =
|
|
16131
|
-
{} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$
|
|
17242
|
+
{} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument;
|
|
16132
17243
|
options = {};
|
|
16133
17244
|
}
|
|
16134
17245
|
|
|
@@ -16142,7 +17253,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
16142
17253
|
const parameters = {
|
|
16143
17254
|
options: Object.assign(
|
|
16144
17255
|
{
|
|
16145
|
-
url: (rootUrl + '/v1alpha/{+name}').replace(
|
|
17256
|
+
url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace(
|
|
17257
|
+
/([^:]\/)\/+/g,
|
|
17258
|
+
'$1'
|
|
17259
|
+
),
|
|
16146
17260
|
method: 'GET',
|
|
16147
17261
|
},
|
|
16148
17262
|
options
|
|
@@ -16153,12 +17267,12 @@ export namespace discoveryengine_v1alpha {
|
|
|
16153
17267
|
context: this.context,
|
|
16154
17268
|
};
|
|
16155
17269
|
if (callback) {
|
|
16156
|
-
createAPIRequest<Schema$
|
|
17270
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>(
|
|
16157
17271
|
parameters,
|
|
16158
17272
|
callback as BodyResponseCallback<unknown>
|
|
16159
17273
|
);
|
|
16160
17274
|
} else {
|
|
16161
|
-
return createAPIRequest<Schema$
|
|
17275
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>(
|
|
16162
17276
|
parameters
|
|
16163
17277
|
);
|
|
16164
17278
|
}
|
|
@@ -16580,6 +17694,21 @@ export namespace discoveryengine_v1alpha {
|
|
|
16580
17694
|
*/
|
|
16581
17695
|
name?: string;
|
|
16582
17696
|
}
|
|
17697
|
+
export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument
|
|
17698
|
+
extends StandardParameters {
|
|
17699
|
+
/**
|
|
17700
|
+
* 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.
|
|
17701
|
+
*/
|
|
17702
|
+
name?: string;
|
|
17703
|
+
/**
|
|
17704
|
+
* What format output should be. If unspecified, defaults to JSON.
|
|
17705
|
+
*/
|
|
17706
|
+
processedDocumentFormat?: string;
|
|
17707
|
+
/**
|
|
17708
|
+
* Required. What type of processing to return.
|
|
17709
|
+
*/
|
|
17710
|
+
processedDocumentType?: string;
|
|
17711
|
+
}
|
|
16583
17712
|
export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import
|
|
16584
17713
|
extends StandardParameters {
|
|
16585
17714
|
/**
|
|
@@ -16617,6 +17746,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
16617
17746
|
* Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
16618
17747
|
*/
|
|
16619
17748
|
name?: string;
|
|
17749
|
+
/**
|
|
17750
|
+
* Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
|
|
17751
|
+
*/
|
|
17752
|
+
updateMask?: string;
|
|
16620
17753
|
|
|
16621
17754
|
/**
|
|
16622
17755
|
* Request body metadata
|
|
@@ -16636,6 +17769,229 @@ export namespace discoveryengine_v1alpha {
|
|
|
16636
17769
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest;
|
|
16637
17770
|
}
|
|
16638
17771
|
|
|
17772
|
+
export class Resource$Projects$Locations$Datastores$Branches$Documents$Chunks {
|
|
17773
|
+
context: APIRequestContext;
|
|
17774
|
+
constructor(context: APIRequestContext) {
|
|
17775
|
+
this.context = context;
|
|
17776
|
+
}
|
|
17777
|
+
|
|
17778
|
+
/**
|
|
17779
|
+
* Gets a Document.
|
|
17780
|
+
*
|
|
17781
|
+
* @param params - Parameters for request
|
|
17782
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
17783
|
+
* @param callback - Optional callback that handles the response.
|
|
17784
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
17785
|
+
*/
|
|
17786
|
+
get(
|
|
17787
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get,
|
|
17788
|
+
options: StreamMethodOptions
|
|
17789
|
+
): GaxiosPromise<Readable>;
|
|
17790
|
+
get(
|
|
17791
|
+
params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get,
|
|
17792
|
+
options?: MethodOptions
|
|
17793
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaChunk>;
|
|
17794
|
+
get(
|
|
17795
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get,
|
|
17796
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
17797
|
+
callback: BodyResponseCallback<Readable>
|
|
17798
|
+
): void;
|
|
17799
|
+
get(
|
|
17800
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get,
|
|
17801
|
+
options:
|
|
17802
|
+
| MethodOptions
|
|
17803
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>,
|
|
17804
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>
|
|
17805
|
+
): void;
|
|
17806
|
+
get(
|
|
17807
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get,
|
|
17808
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>
|
|
17809
|
+
): void;
|
|
17810
|
+
get(
|
|
17811
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>
|
|
17812
|
+
): void;
|
|
17813
|
+
get(
|
|
17814
|
+
paramsOrCallback?:
|
|
17815
|
+
| Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get
|
|
17816
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>
|
|
17817
|
+
| BodyResponseCallback<Readable>,
|
|
17818
|
+
optionsOrCallback?:
|
|
17819
|
+
| MethodOptions
|
|
17820
|
+
| StreamMethodOptions
|
|
17821
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>
|
|
17822
|
+
| BodyResponseCallback<Readable>,
|
|
17823
|
+
callback?:
|
|
17824
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>
|
|
17825
|
+
| BodyResponseCallback<Readable>
|
|
17826
|
+
):
|
|
17827
|
+
| void
|
|
17828
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaChunk>
|
|
17829
|
+
| GaxiosPromise<Readable> {
|
|
17830
|
+
let params = (paramsOrCallback ||
|
|
17831
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get;
|
|
17832
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
17833
|
+
|
|
17834
|
+
if (typeof paramsOrCallback === 'function') {
|
|
17835
|
+
callback = paramsOrCallback;
|
|
17836
|
+
params =
|
|
17837
|
+
{} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get;
|
|
17838
|
+
options = {};
|
|
17839
|
+
}
|
|
17840
|
+
|
|
17841
|
+
if (typeof optionsOrCallback === 'function') {
|
|
17842
|
+
callback = optionsOrCallback;
|
|
17843
|
+
options = {};
|
|
17844
|
+
}
|
|
17845
|
+
|
|
17846
|
+
const rootUrl =
|
|
17847
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
17848
|
+
const parameters = {
|
|
17849
|
+
options: Object.assign(
|
|
17850
|
+
{
|
|
17851
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
17852
|
+
method: 'GET',
|
|
17853
|
+
},
|
|
17854
|
+
options
|
|
17855
|
+
),
|
|
17856
|
+
params,
|
|
17857
|
+
requiredParams: ['name'],
|
|
17858
|
+
pathParams: ['name'],
|
|
17859
|
+
context: this.context,
|
|
17860
|
+
};
|
|
17861
|
+
if (callback) {
|
|
17862
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaChunk>(
|
|
17863
|
+
parameters,
|
|
17864
|
+
callback as BodyResponseCallback<unknown>
|
|
17865
|
+
);
|
|
17866
|
+
} else {
|
|
17867
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaChunk>(
|
|
17868
|
+
parameters
|
|
17869
|
+
);
|
|
17870
|
+
}
|
|
17871
|
+
}
|
|
17872
|
+
|
|
17873
|
+
/**
|
|
17874
|
+
* Gets a list of Chunks.
|
|
17875
|
+
*
|
|
17876
|
+
* @param params - Parameters for request
|
|
17877
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
17878
|
+
* @param callback - Optional callback that handles the response.
|
|
17879
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
17880
|
+
*/
|
|
17881
|
+
list(
|
|
17882
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List,
|
|
17883
|
+
options: StreamMethodOptions
|
|
17884
|
+
): GaxiosPromise<Readable>;
|
|
17885
|
+
list(
|
|
17886
|
+
params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List,
|
|
17887
|
+
options?: MethodOptions
|
|
17888
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>;
|
|
17889
|
+
list(
|
|
17890
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List,
|
|
17891
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
17892
|
+
callback: BodyResponseCallback<Readable>
|
|
17893
|
+
): void;
|
|
17894
|
+
list(
|
|
17895
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List,
|
|
17896
|
+
options:
|
|
17897
|
+
| MethodOptions
|
|
17898
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>,
|
|
17899
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>
|
|
17900
|
+
): void;
|
|
17901
|
+
list(
|
|
17902
|
+
params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List,
|
|
17903
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>
|
|
17904
|
+
): void;
|
|
17905
|
+
list(
|
|
17906
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>
|
|
17907
|
+
): void;
|
|
17908
|
+
list(
|
|
17909
|
+
paramsOrCallback?:
|
|
17910
|
+
| Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List
|
|
17911
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>
|
|
17912
|
+
| BodyResponseCallback<Readable>,
|
|
17913
|
+
optionsOrCallback?:
|
|
17914
|
+
| MethodOptions
|
|
17915
|
+
| StreamMethodOptions
|
|
17916
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>
|
|
17917
|
+
| BodyResponseCallback<Readable>,
|
|
17918
|
+
callback?:
|
|
17919
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>
|
|
17920
|
+
| BodyResponseCallback<Readable>
|
|
17921
|
+
):
|
|
17922
|
+
| void
|
|
17923
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>
|
|
17924
|
+
| GaxiosPromise<Readable> {
|
|
17925
|
+
let params = (paramsOrCallback ||
|
|
17926
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List;
|
|
17927
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
17928
|
+
|
|
17929
|
+
if (typeof paramsOrCallback === 'function') {
|
|
17930
|
+
callback = paramsOrCallback;
|
|
17931
|
+
params =
|
|
17932
|
+
{} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List;
|
|
17933
|
+
options = {};
|
|
17934
|
+
}
|
|
17935
|
+
|
|
17936
|
+
if (typeof optionsOrCallback === 'function') {
|
|
17937
|
+
callback = optionsOrCallback;
|
|
17938
|
+
options = {};
|
|
17939
|
+
}
|
|
17940
|
+
|
|
17941
|
+
const rootUrl =
|
|
17942
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
17943
|
+
const parameters = {
|
|
17944
|
+
options: Object.assign(
|
|
17945
|
+
{
|
|
17946
|
+
url: (rootUrl + '/v1alpha/{+parent}/chunks').replace(
|
|
17947
|
+
/([^:]\/)\/+/g,
|
|
17948
|
+
'$1'
|
|
17949
|
+
),
|
|
17950
|
+
method: 'GET',
|
|
17951
|
+
},
|
|
17952
|
+
options
|
|
17953
|
+
),
|
|
17954
|
+
params,
|
|
17955
|
+
requiredParams: ['parent'],
|
|
17956
|
+
pathParams: ['parent'],
|
|
17957
|
+
context: this.context,
|
|
17958
|
+
};
|
|
17959
|
+
if (callback) {
|
|
17960
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>(
|
|
17961
|
+
parameters,
|
|
17962
|
+
callback as BodyResponseCallback<unknown>
|
|
17963
|
+
);
|
|
17964
|
+
} else {
|
|
17965
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>(
|
|
17966
|
+
parameters
|
|
17967
|
+
);
|
|
17968
|
+
}
|
|
17969
|
+
}
|
|
17970
|
+
}
|
|
17971
|
+
|
|
17972
|
+
export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get
|
|
17973
|
+
extends StandardParameters {
|
|
17974
|
+
/**
|
|
17975
|
+
* 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.
|
|
17976
|
+
*/
|
|
17977
|
+
name?: string;
|
|
17978
|
+
}
|
|
17979
|
+
export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List
|
|
17980
|
+
extends StandardParameters {
|
|
17981
|
+
/**
|
|
17982
|
+
* 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.
|
|
17983
|
+
*/
|
|
17984
|
+
pageSize?: number;
|
|
17985
|
+
/**
|
|
17986
|
+
* 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.
|
|
17987
|
+
*/
|
|
17988
|
+
pageToken?: string;
|
|
17989
|
+
/**
|
|
17990
|
+
* 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.
|
|
17991
|
+
*/
|
|
17992
|
+
parent?: string;
|
|
17993
|
+
}
|
|
17994
|
+
|
|
16639
17995
|
export class Resource$Projects$Locations$Datastores$Branches$Operations {
|
|
16640
17996
|
context: APIRequestContext;
|
|
16641
17997
|
constructor(context: APIRequestContext) {
|
|
@@ -19019,7 +20375,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
19019
20375
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get
|
|
19020
20376
|
extends StandardParameters {
|
|
19021
20377
|
/**
|
|
19022
|
-
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/
|
|
20378
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
19023
20379
|
*/
|
|
19024
20380
|
name?: string;
|
|
19025
20381
|
}
|
|
@@ -19034,14 +20390,14 @@ export namespace discoveryengine_v1alpha {
|
|
|
19034
20390
|
*/
|
|
19035
20391
|
pageToken?: string;
|
|
19036
20392
|
/**
|
|
19037
|
-
* Required.
|
|
20393
|
+
* Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
19038
20394
|
*/
|
|
19039
20395
|
parent?: string;
|
|
19040
20396
|
}
|
|
19041
20397
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch
|
|
19042
20398
|
extends StandardParameters {
|
|
19043
20399
|
/**
|
|
19044
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/
|
|
20400
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
19045
20401
|
*/
|
|
19046
20402
|
name?: string;
|
|
19047
20403
|
/**
|