@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240213 → 0.0.20240227
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/index.d.ts +213 -3
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240227
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -82,6 +82,12 @@ declare namespace gapi.client {
|
|
|
82
82
|
/** Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. */
|
|
83
83
|
functionName?: string;
|
|
84
84
|
}
|
|
85
|
+
interface GoogleCloudDiscoveryengineV1alphaAclConfig {
|
|
86
|
+
/** Identity provider config. */
|
|
87
|
+
idpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
88
|
+
/** 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. */
|
|
89
|
+
name?: string;
|
|
90
|
+
}
|
|
85
91
|
interface GoogleCloudDiscoveryengineV1alphaAdditionalParams {
|
|
86
92
|
/** Token that used for non-human user check. */
|
|
87
93
|
token?: string;
|
|
@@ -174,6 +180,8 @@ declare namespace gapi.client {
|
|
|
174
180
|
userInput?: GoogleCloudDiscoveryengineV1alphaTextInput;
|
|
175
181
|
}
|
|
176
182
|
interface GoogleCloudDiscoveryengineV1alphaConverseConversationRequest {
|
|
183
|
+
/** 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) */
|
|
184
|
+
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
177
185
|
/** 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. */
|
|
178
186
|
conversation?: GoogleCloudDiscoveryengineV1alphaConversation;
|
|
179
187
|
/** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
@@ -242,6 +250,8 @@ declare namespace gapi.client {
|
|
|
242
250
|
enableSearchAdaptor?: boolean;
|
|
243
251
|
}
|
|
244
252
|
interface GoogleCloudDiscoveryengineV1alphaDataStore {
|
|
253
|
+
/** 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. */
|
|
254
|
+
aclEnabled?: boolean;
|
|
245
255
|
/** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
|
|
246
256
|
contentConfig?: string;
|
|
247
257
|
/** Output only. Timestamp the DataStore was created at. */
|
|
@@ -250,12 +260,18 @@ declare namespace gapi.client {
|
|
|
250
260
|
defaultSchemaId?: string;
|
|
251
261
|
/** 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. */
|
|
252
262
|
displayName?: string;
|
|
263
|
+
/** Configuration for Document understanding and enrichment. */
|
|
264
|
+
documentProcessingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
|
|
265
|
+
/** Output only. Data store level identity provider config. */
|
|
266
|
+
idpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
253
267
|
/** Immutable. The industry vertical that the data store registers. */
|
|
254
268
|
industryVertical?: string;
|
|
255
269
|
/** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
256
270
|
name?: string;
|
|
257
271
|
/** 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. */
|
|
258
272
|
solutionTypes?: string[];
|
|
273
|
+
/** 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). */
|
|
274
|
+
startingSchema?: GoogleCloudDiscoveryengineV1alphaSchema;
|
|
259
275
|
}
|
|
260
276
|
interface GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata {
|
|
261
277
|
/** Operation create time. */
|
|
@@ -291,12 +307,16 @@ declare namespace gapi.client {
|
|
|
291
307
|
interface GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest {}
|
|
292
308
|
interface GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse {}
|
|
293
309
|
interface GoogleCloudDiscoveryengineV1alphaDocument {
|
|
310
|
+
/** Access control information for the document. */
|
|
311
|
+
aclInfo?: GoogleCloudDiscoveryengineV1alphaDocumentAclInfo;
|
|
294
312
|
/** The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. */
|
|
295
313
|
content?: GoogleCloudDiscoveryengineV1alphaDocumentContent;
|
|
296
314
|
/** Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */
|
|
297
315
|
derivedStructData?: {[P in string]: any};
|
|
298
316
|
/** 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. */
|
|
299
317
|
id?: string;
|
|
318
|
+
/** 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. */
|
|
319
|
+
indexTime?: string;
|
|
300
320
|
/** The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
|
|
301
321
|
jsonData?: string;
|
|
302
322
|
/** 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. */
|
|
@@ -308,6 +328,13 @@ declare namespace gapi.client {
|
|
|
308
328
|
/** The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
|
|
309
329
|
structData?: {[P in string]: any};
|
|
310
330
|
}
|
|
331
|
+
interface GoogleCloudDiscoveryengineV1alphaDocumentAclInfo {
|
|
332
|
+
readers?: GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction[];
|
|
333
|
+
}
|
|
334
|
+
interface GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction {
|
|
335
|
+
/** List of principals. */
|
|
336
|
+
principals?: GoogleCloudDiscoveryengineV1alphaPrincipal[];
|
|
337
|
+
}
|
|
311
338
|
interface GoogleCloudDiscoveryengineV1alphaDocumentContent {
|
|
312
339
|
/** The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. */
|
|
313
340
|
mimeType?: string;
|
|
@@ -335,7 +362,7 @@ declare namespace gapi.client {
|
|
|
335
362
|
name?: string;
|
|
336
363
|
/** [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs. */
|
|
337
364
|
ocrConfig?: GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
338
|
-
/** 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. */
|
|
365
|
+
/** 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. */
|
|
339
366
|
parsingConfigOverrides?: {
|
|
340
367
|
[P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
341
368
|
};
|
|
@@ -365,6 +392,8 @@ declare namespace gapi.client {
|
|
|
365
392
|
interface GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest {}
|
|
366
393
|
interface GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse {}
|
|
367
394
|
interface GoogleCloudDiscoveryengineV1alphaEngine {
|
|
395
|
+
/** Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field. */
|
|
396
|
+
allowMultipleDataStoresSearchEngine?: boolean;
|
|
368
397
|
/** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
369
398
|
chatEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig;
|
|
370
399
|
/** Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
@@ -527,6 +556,16 @@ declare namespace gapi.client {
|
|
|
527
556
|
/** Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3. */
|
|
528
557
|
maxRelatedQuestions?: number;
|
|
529
558
|
}
|
|
559
|
+
interface GoogleCloudDiscoveryengineV1alphaIdpConfig {
|
|
560
|
+
/** External Identity provider config. */
|
|
561
|
+
externalIdpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig;
|
|
562
|
+
/** Identity provider type configured. */
|
|
563
|
+
idpType?: string;
|
|
564
|
+
}
|
|
565
|
+
interface GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig {
|
|
566
|
+
/** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */
|
|
567
|
+
workforcePoolName?: string;
|
|
568
|
+
}
|
|
530
569
|
interface GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata {
|
|
531
570
|
/** Operation create time. */
|
|
532
571
|
createTime?: string;
|
|
@@ -729,21 +768,33 @@ declare namespace gapi.client {
|
|
|
729
768
|
totalPanels?: number;
|
|
730
769
|
}
|
|
731
770
|
interface GoogleCloudDiscoveryengineV1alphaPauseEngineRequest {}
|
|
771
|
+
interface GoogleCloudDiscoveryengineV1alphaPrincipal {
|
|
772
|
+
/** 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. */
|
|
773
|
+
groupId?: string;
|
|
774
|
+
/** 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. */
|
|
775
|
+
userId?: string;
|
|
776
|
+
}
|
|
732
777
|
interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata {
|
|
733
778
|
/** Operation create time. */
|
|
734
779
|
createTime?: string;
|
|
735
780
|
/** Count of entries that encountered errors while processing. */
|
|
736
781
|
failureCount?: string;
|
|
782
|
+
/** Count of entries that were ignored as entries were not found. */
|
|
783
|
+
ignoredCount?: string;
|
|
737
784
|
/** Count of entries that were deleted successfully. */
|
|
738
785
|
successCount?: string;
|
|
739
786
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
740
787
|
updateTime?: string;
|
|
741
788
|
}
|
|
742
789
|
interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest {
|
|
790
|
+
/** The desired location of errors incurred during the purge. */
|
|
791
|
+
errorConfig?: GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig;
|
|
743
792
|
/** Required. Filter matching documents to purge. Only currently supported value is `*` (all items). */
|
|
744
793
|
filter?: string;
|
|
745
794
|
/** Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. */
|
|
746
795
|
force?: boolean;
|
|
796
|
+
/** Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line. */
|
|
797
|
+
gcsSource?: GoogleCloudDiscoveryengineV1alphaGcsSource;
|
|
747
798
|
}
|
|
748
799
|
interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse {
|
|
749
800
|
/** The total count of documents purged as a result of the operation. */
|
|
@@ -751,6 +802,10 @@ declare namespace gapi.client {
|
|
|
751
802
|
/** A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. */
|
|
752
803
|
purgeSample?: string[];
|
|
753
804
|
}
|
|
805
|
+
interface GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig {
|
|
806
|
+
/** 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. */
|
|
807
|
+
gcsPrefix?: string;
|
|
808
|
+
}
|
|
754
809
|
interface GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata {
|
|
755
810
|
/** Operation create time. */
|
|
756
811
|
createTime?: string;
|
|
@@ -900,6 +955,8 @@ declare namespace gapi.client {
|
|
|
900
955
|
canonicalFilter?: string;
|
|
901
956
|
/** A specification for configuring the behavior of content search. */
|
|
902
957
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
958
|
+
/** Custom fine tuning configs. */
|
|
959
|
+
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
903
960
|
/** 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. */
|
|
904
961
|
embeddingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
|
|
905
962
|
/** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
@@ -944,7 +1001,7 @@ declare namespace gapi.client {
|
|
|
944
1001
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec {
|
|
945
1002
|
/** 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. */
|
|
946
1003
|
boost?: number;
|
|
947
|
-
/** 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": * (
|
|
1004
|
+
/** 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")) */
|
|
948
1005
|
condition?: string;
|
|
949
1006
|
}
|
|
950
1007
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec {
|
|
@@ -1437,6 +1494,8 @@ declare namespace gapi.client {
|
|
|
1437
1494
|
enableSnippetResultSummary?: boolean;
|
|
1438
1495
|
/** Turn on or off summarization for the search response. */
|
|
1439
1496
|
enableSummarization?: boolean;
|
|
1497
|
+
/** Whether to enable standalone web app. */
|
|
1498
|
+
enableWebApp?: boolean;
|
|
1440
1499
|
/** The configuration and appearance of facets in the end user view. */
|
|
1441
1500
|
facetField?: GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
|
|
1442
1501
|
/** 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. */
|
|
@@ -1557,12 +1616,16 @@ declare namespace gapi.client {
|
|
|
1557
1616
|
defaultSchemaId?: string;
|
|
1558
1617
|
/** 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. */
|
|
1559
1618
|
displayName?: string;
|
|
1619
|
+
/** Configuration for Document understanding and enrichment. */
|
|
1620
|
+
documentProcessingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig;
|
|
1560
1621
|
/** Immutable. The industry vertical that the data store registers. */
|
|
1561
1622
|
industryVertical?: string;
|
|
1562
1623
|
/** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
1563
1624
|
name?: string;
|
|
1564
1625
|
/** 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. */
|
|
1565
1626
|
solutionTypes?: string[];
|
|
1627
|
+
/** 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). */
|
|
1628
|
+
startingSchema?: GoogleCloudDiscoveryengineV1betaSchema;
|
|
1566
1629
|
}
|
|
1567
1630
|
interface GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
|
|
1568
1631
|
/** Operation create time. */
|
|
@@ -1588,6 +1651,7 @@ declare namespace gapi.client {
|
|
|
1588
1651
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1589
1652
|
updateTime?: string;
|
|
1590
1653
|
}
|
|
1654
|
+
interface GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {}
|
|
1591
1655
|
interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata {
|
|
1592
1656
|
/** Operation create time. */
|
|
1593
1657
|
createTime?: string;
|
|
@@ -1595,6 +1659,22 @@ declare namespace gapi.client {
|
|
|
1595
1659
|
updateTime?: string;
|
|
1596
1660
|
}
|
|
1597
1661
|
interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {}
|
|
1662
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
|
|
1663
|
+
/** 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. */
|
|
1664
|
+
defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1665
|
+
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
1666
|
+
name?: string;
|
|
1667
|
+
/** 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. */
|
|
1668
|
+
parsingConfigOverrides?: {
|
|
1669
|
+
[P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1670
|
+
};
|
|
1671
|
+
}
|
|
1672
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
|
|
1673
|
+
/** Configurations applied to digital parser. */
|
|
1674
|
+
digitalParsingConfig?: any;
|
|
1675
|
+
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
1676
|
+
ocrParsingConfig?: GoogleCloudDiscoveryengineV1betaOcrParsingConfig;
|
|
1677
|
+
}
|
|
1598
1678
|
interface GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata {
|
|
1599
1679
|
/** Operation create time. */
|
|
1600
1680
|
createTime?: string;
|
|
@@ -1710,11 +1790,19 @@ declare namespace gapi.client {
|
|
|
1710
1790
|
/** Count of user events imported, but with Document information not found in the existing Branch. */
|
|
1711
1791
|
unjoinedEventsCount?: string;
|
|
1712
1792
|
}
|
|
1793
|
+
interface GoogleCloudDiscoveryengineV1betaOcrParsingConfig {
|
|
1794
|
+
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
1795
|
+
enhancedDocumentElements?: string[];
|
|
1796
|
+
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
1797
|
+
useNativeText?: boolean;
|
|
1798
|
+
}
|
|
1713
1799
|
interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
|
|
1714
1800
|
/** Operation create time. */
|
|
1715
1801
|
createTime?: string;
|
|
1716
1802
|
/** Count of entries that encountered errors while processing. */
|
|
1717
1803
|
failureCount?: string;
|
|
1804
|
+
/** Count of entries that were ignored as entries were not found. */
|
|
1805
|
+
ignoredCount?: string;
|
|
1718
1806
|
/** Count of entries that were deleted successfully. */
|
|
1719
1807
|
successCount?: string;
|
|
1720
1808
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
@@ -1825,12 +1913,16 @@ declare namespace gapi.client {
|
|
|
1825
1913
|
defaultSchemaId?: string;
|
|
1826
1914
|
/** 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. */
|
|
1827
1915
|
displayName?: string;
|
|
1916
|
+
/** Configuration for Document understanding and enrichment. */
|
|
1917
|
+
documentProcessingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfig;
|
|
1828
1918
|
/** Immutable. The industry vertical that the data store registers. */
|
|
1829
1919
|
industryVertical?: string;
|
|
1830
1920
|
/** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
1831
1921
|
name?: string;
|
|
1832
1922
|
/** 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. */
|
|
1833
1923
|
solutionTypes?: string[];
|
|
1924
|
+
/** 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). */
|
|
1925
|
+
startingSchema?: GoogleCloudDiscoveryengineV1Schema;
|
|
1834
1926
|
}
|
|
1835
1927
|
interface GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
|
|
1836
1928
|
/** Operation create time. */
|
|
@@ -1856,6 +1948,7 @@ declare namespace gapi.client {
|
|
|
1856
1948
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1857
1949
|
updateTime?: string;
|
|
1858
1950
|
}
|
|
1951
|
+
interface GoogleCloudDiscoveryengineV1DigitalParsingConfig {}
|
|
1859
1952
|
interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata {
|
|
1860
1953
|
/** Operation create time. */
|
|
1861
1954
|
createTime?: string;
|
|
@@ -1863,6 +1956,22 @@ declare namespace gapi.client {
|
|
|
1863
1956
|
updateTime?: string;
|
|
1864
1957
|
}
|
|
1865
1958
|
interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {}
|
|
1959
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
|
|
1960
|
+
/** 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. */
|
|
1961
|
+
defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
1962
|
+
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
1963
|
+
name?: string;
|
|
1964
|
+
/** 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. */
|
|
1965
|
+
parsingConfigOverrides?: {
|
|
1966
|
+
[P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
1967
|
+
};
|
|
1968
|
+
}
|
|
1969
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
|
|
1970
|
+
/** Configurations applied to digital parser. */
|
|
1971
|
+
digitalParsingConfig?: any;
|
|
1972
|
+
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
1973
|
+
ocrParsingConfig?: GoogleCloudDiscoveryengineV1OcrParsingConfig;
|
|
1974
|
+
}
|
|
1866
1975
|
interface GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
|
|
1867
1976
|
/** Operation create time. */
|
|
1868
1977
|
createTime?: string;
|
|
@@ -1978,11 +2087,19 @@ declare namespace gapi.client {
|
|
|
1978
2087
|
/** Count of user events imported, but with Document information not found in the existing Branch. */
|
|
1979
2088
|
unjoinedEventsCount?: string;
|
|
1980
2089
|
}
|
|
2090
|
+
interface GoogleCloudDiscoveryengineV1OcrParsingConfig {
|
|
2091
|
+
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
2092
|
+
enhancedDocumentElements?: string[];
|
|
2093
|
+
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
2094
|
+
useNativeText?: boolean;
|
|
2095
|
+
}
|
|
1981
2096
|
interface GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata {
|
|
1982
2097
|
/** Operation create time. */
|
|
1983
2098
|
createTime?: string;
|
|
1984
2099
|
/** Count of entries that encountered errors while processing. */
|
|
1985
2100
|
failureCount?: string;
|
|
2101
|
+
/** Count of entries that were ignored as entries were not found. */
|
|
2102
|
+
ignoredCount?: string;
|
|
1986
2103
|
/** Count of entries that were deleted successfully. */
|
|
1987
2104
|
successCount?: string;
|
|
1988
2105
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
@@ -2624,6 +2741,8 @@ declare namespace gapi.client {
|
|
|
2624
2741
|
prettyPrint?: boolean;
|
|
2625
2742
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2626
2743
|
quotaUser?: string;
|
|
2744
|
+
/** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
|
|
2745
|
+
updateMask?: string;
|
|
2627
2746
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2628
2747
|
upload_protocol?: string;
|
|
2629
2748
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -2655,6 +2774,8 @@ declare namespace gapi.client {
|
|
|
2655
2774
|
prettyPrint?: boolean;
|
|
2656
2775
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2657
2776
|
quotaUser?: string;
|
|
2777
|
+
/** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
|
|
2778
|
+
updateMask?: string;
|
|
2658
2779
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2659
2780
|
upload_protocol?: string;
|
|
2660
2781
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -6367,6 +6488,8 @@ declare namespace gapi.client {
|
|
|
6367
6488
|
prettyPrint?: boolean;
|
|
6368
6489
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
6369
6490
|
quotaUser?: string;
|
|
6491
|
+
/** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
|
|
6492
|
+
updateMask?: string;
|
|
6370
6493
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6371
6494
|
upload_protocol?: string;
|
|
6372
6495
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -6398,6 +6521,8 @@ declare namespace gapi.client {
|
|
|
6398
6521
|
prettyPrint?: boolean;
|
|
6399
6522
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
6400
6523
|
quotaUser?: string;
|
|
6524
|
+
/** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
|
|
6525
|
+
updateMask?: string;
|
|
6401
6526
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6402
6527
|
upload_protocol?: string;
|
|
6403
6528
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -8638,6 +8763,91 @@ declare namespace gapi.client {
|
|
|
8638
8763
|
},
|
|
8639
8764
|
body: GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest
|
|
8640
8765
|
): Request<GoogleLongrunningOperation>;
|
|
8766
|
+
/** Gets the AclConfig. */
|
|
8767
|
+
getAclConfig(request?: {
|
|
8768
|
+
/** V1 error format. */
|
|
8769
|
+
'$.xgafv'?: string;
|
|
8770
|
+
/** OAuth access token. */
|
|
8771
|
+
access_token?: string;
|
|
8772
|
+
/** Data format for response. */
|
|
8773
|
+
alt?: string;
|
|
8774
|
+
/** JSONP */
|
|
8775
|
+
callback?: string;
|
|
8776
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8777
|
+
fields?: string;
|
|
8778
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
8779
|
+
key?: string;
|
|
8780
|
+
/** Required. Resource name of AclConfig, such as `projects/*/locations/*/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. */
|
|
8781
|
+
name: string;
|
|
8782
|
+
/** OAuth 2.0 token for the current user. */
|
|
8783
|
+
oauth_token?: string;
|
|
8784
|
+
/** Returns response with indentations and line breaks. */
|
|
8785
|
+
prettyPrint?: boolean;
|
|
8786
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
8787
|
+
quotaUser?: string;
|
|
8788
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8789
|
+
upload_protocol?: string;
|
|
8790
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8791
|
+
uploadType?: string;
|
|
8792
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaAclConfig>;
|
|
8793
|
+
/** 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. */
|
|
8794
|
+
updateAclConfig(request: {
|
|
8795
|
+
/** V1 error format. */
|
|
8796
|
+
'$.xgafv'?: string;
|
|
8797
|
+
/** OAuth access token. */
|
|
8798
|
+
access_token?: string;
|
|
8799
|
+
/** Data format for response. */
|
|
8800
|
+
alt?: string;
|
|
8801
|
+
/** JSONP */
|
|
8802
|
+
callback?: string;
|
|
8803
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8804
|
+
fields?: string;
|
|
8805
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
8806
|
+
key?: string;
|
|
8807
|
+
/** 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. */
|
|
8808
|
+
name: string;
|
|
8809
|
+
/** OAuth 2.0 token for the current user. */
|
|
8810
|
+
oauth_token?: string;
|
|
8811
|
+
/** Returns response with indentations and line breaks. */
|
|
8812
|
+
prettyPrint?: boolean;
|
|
8813
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
8814
|
+
quotaUser?: string;
|
|
8815
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8816
|
+
upload_protocol?: string;
|
|
8817
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8818
|
+
uploadType?: string;
|
|
8819
|
+
/** Request body */
|
|
8820
|
+
resource: GoogleCloudDiscoveryengineV1alphaAclConfig;
|
|
8821
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaAclConfig>;
|
|
8822
|
+
updateAclConfig(
|
|
8823
|
+
request: {
|
|
8824
|
+
/** V1 error format. */
|
|
8825
|
+
'$.xgafv'?: string;
|
|
8826
|
+
/** OAuth access token. */
|
|
8827
|
+
access_token?: string;
|
|
8828
|
+
/** Data format for response. */
|
|
8829
|
+
alt?: string;
|
|
8830
|
+
/** JSONP */
|
|
8831
|
+
callback?: string;
|
|
8832
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8833
|
+
fields?: string;
|
|
8834
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
8835
|
+
key?: string;
|
|
8836
|
+
/** 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. */
|
|
8837
|
+
name: string;
|
|
8838
|
+
/** OAuth 2.0 token for the current user. */
|
|
8839
|
+
oauth_token?: string;
|
|
8840
|
+
/** Returns response with indentations and line breaks. */
|
|
8841
|
+
prettyPrint?: boolean;
|
|
8842
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
8843
|
+
quotaUser?: string;
|
|
8844
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8845
|
+
upload_protocol?: string;
|
|
8846
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8847
|
+
uploadType?: string;
|
|
8848
|
+
},
|
|
8849
|
+
body: GoogleCloudDiscoveryengineV1alphaAclConfig
|
|
8850
|
+
): Request<GoogleCloudDiscoveryengineV1alphaAclConfig>;
|
|
8641
8851
|
collections: CollectionsResource;
|
|
8642
8852
|
dataStores: DataStoresResource;
|
|
8643
8853
|
operations: OperationsResource;
|