@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20240213 → 0.0.20240227

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta
-// Revision: 20240213
+// Revision: 20240227
 
 /// <reference types="gapi.client" />
 
@@ -82,6 +82,12 @@ declare namespace gapi.client {
       /** Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. */
       functionName?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaAclConfig {
+      /** Identity provider config. */
+      idpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfig;
+      /** 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. */
+      name?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -117,6 +123,8 @@ declare namespace gapi.client {
       updateTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaDataStore {
+      /** 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. */
+      aclEnabled?: boolean;
       /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
       contentConfig?: string;
       /** Output only. Timestamp the DataStore was created at. */
@@ -125,12 +133,18 @@ declare namespace gapi.client {
       defaultSchemaId?: string;
       /** 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. */
       displayName?: string;
+      /** Configuration for Document understanding and enrichment. */
+      documentProcessingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
+      /** Output only. Data store level identity provider config. */
+      idpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfig;
       /** Immutable. The industry vertical that the data store registers. */
       industryVertical?: string;
       /** 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. */
       name?: string;
       /** 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. */
       solutionTypes?: string[];
+      /** 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). */
+      startingSchema?: GoogleCloudDiscoveryengineV1alphaSchema;
     }
     interface GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata {
       /** Operation create time. */
@@ -171,7 +185,7 @@ declare namespace gapi.client {
       name?: string;
       /** [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. */
       ocrConfig?: GoogleCloudDiscoveryengineV1alphaOcrConfig;
-      /** 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. */
+      /** 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. */
       parsingConfigOverrides?: {
         [P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
       };
@@ -192,6 +206,8 @@ declare namespace gapi.client {
     }
     interface GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse {}
     interface GoogleCloudDiscoveryengineV1alphaEngine {
+      /** 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. */
+      allowMultipleDataStoresSearchEngine?: boolean;
       /** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
       chatEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig;
       /** Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
@@ -308,6 +324,16 @@ declare namespace gapi.client {
       /** If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. */
       searchableOption?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaIdpConfig {
+      /** External Identity provider config. */
+      externalIdpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig;
+      /** Identity provider type configured. */
+      idpType?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig {
+      /** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */
+      workforcePoolName?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -382,6 +408,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** Count of entries that encountered errors while processing. */
       failureCount?: string;
+      /** Count of entries that were ignored as entries were not found. */
+      ignoredCount?: string;
       /** Count of entries that were deleted successfully. */
       successCount?: string;
       /** Operation last update time. If the operation is done, this is also the finish time. */
@@ -614,6 +642,8 @@ declare namespace gapi.client {
       userInput?: GoogleCloudDiscoveryengineV1betaTextInput;
     }
     interface GoogleCloudDiscoveryengineV1betaConverseConversationRequest {
+      /** 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) */
+      boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
       /** 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. */
       conversation?: GoogleCloudDiscoveryengineV1betaConversation;
       /** 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) */
@@ -684,12 +714,16 @@ declare namespace gapi.client {
       defaultSchemaId?: string;
       /** 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. */
       displayName?: string;
+      /** Configuration for Document understanding and enrichment. */
+      documentProcessingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig;
       /** Immutable. The industry vertical that the data store registers. */
       industryVertical?: string;
       /** 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. */
       name?: string;
       /** 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. */
       solutionTypes?: string[];
+      /** 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). */
+      startingSchema?: GoogleCloudDiscoveryengineV1betaSchema;
     }
     interface GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
       /** Operation create time. */
@@ -715,6 +749,7 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {}
     interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -730,6 +765,8 @@ declare namespace gapi.client {
       derivedStructData?: {[P in string]: any};
       /** 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. */
       id?: string;
+      /** 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. */
+      indexTime?: string;
       /** The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
       jsonData?: string;
       /** 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. */
@@ -761,6 +798,22 @@ declare namespace gapi.client {
       /** The Document URI - only allowed for website data stores. */
       uri?: string;
     }
+    interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
+      /** 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. */
+      defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
+      /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
+      name?: string;
+      /** 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. */
+      parsingConfigOverrides?: {
+        [P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
+      };
+    }
+    interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
+      /** Configurations applied to digital parser. */
+      digitalParsingConfig?: any;
+      /** Configurations applied to OCR parser. Currently it only applies to PDFs. */
+      ocrParsingConfig?: GoogleCloudDiscoveryengineV1betaOcrParsingConfig;
+    }
     interface GoogleCloudDiscoveryengineV1betaDoubleList {
       /** Double values. */
       values?: number[];
@@ -1003,6 +1056,12 @@ declare namespace gapi.client {
       /** Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset. */
       mediaProgressPercentage?: number;
     }
+    interface GoogleCloudDiscoveryengineV1betaOcrParsingConfig {
+      /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
+      enhancedDocumentElements?: string[];
+      /** If true, will use native text instead of OCR text on pages containing native text. */
+      useNativeText?: boolean;
+    }
     interface GoogleCloudDiscoveryengineV1betaPageInfo {
       /** The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, please replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. */
       pageCategory?: string;
@@ -1028,6 +1087,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** Count of entries that encountered errors while processing. */
       failureCount?: string;
+      /** Count of entries that were ignored as entries were not found. */
+      ignoredCount?: string;
       /** Count of entries that were deleted successfully. */
       successCount?: string;
       /** Operation last update time. If the operation is done, this is also the finish time. */
@@ -1179,7 +1240,7 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec {
       /** 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. */
       boost?: number;
-      /** 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": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) */
+      /** 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")) */
       condition?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec {
@@ -1614,12 +1675,16 @@ declare namespace gapi.client {
       defaultSchemaId?: string;
       /** 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. */
       displayName?: string;
+      /** Configuration for Document understanding and enrichment. */
+      documentProcessingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfig;
       /** Immutable. The industry vertical that the data store registers. */
       industryVertical?: string;
       /** 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. */
       name?: string;
       /** 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. */
       solutionTypes?: string[];
+      /** 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). */
+      startingSchema?: GoogleCloudDiscoveryengineV1Schema;
     }
     interface GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
       /** Operation create time. */
@@ -1645,6 +1710,7 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1DigitalParsingConfig {}
     interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -1652,6 +1718,22 @@ declare namespace gapi.client {
       updateTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {}
+    interface GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
+      /** 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. */
+      defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
+      /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
+      name?: string;
+      /** 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. */
+      parsingConfigOverrides?: {
+        [P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
+      };
+    }
+    interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
+      /** Configurations applied to digital parser. */
+      digitalParsingConfig?: any;
+      /** Configurations applied to OCR parser. Currently it only applies to PDFs. */
+      ocrParsingConfig?: GoogleCloudDiscoveryengineV1OcrParsingConfig;
+    }
     interface GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -1767,11 +1849,19 @@ declare namespace gapi.client {
       /** Count of user events imported, but with Document information not found in the existing Branch. */
       unjoinedEventsCount?: string;
     }
+    interface GoogleCloudDiscoveryengineV1OcrParsingConfig {
+      /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
+      enhancedDocumentElements?: string[];
+      /** If true, will use native text instead of OCR text on pages containing native text. */
+      useNativeText?: boolean;
+    }
     interface GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
       /** Count of entries that encountered errors while processing. */
       failureCount?: string;
+      /** Count of entries that were ignored as entries were not found. */
+      ignoredCount?: string;
       /** Count of entries that were deleted successfully. */
       successCount?: string;
       /** Operation last update time. If the operation is done, this is also the finish time. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.discoveryengine-v1beta",
-  "version": "0.0.20240213",
+  "version": "0.0.20240227",
   "description": "TypeScript typings for Discovery Engine API v1beta",
   "repository": {
     "type": "git",