@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240526 → 0.0.20240530

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=v1alpha
-// Revision: 20240526
+// Revision: 20240530
 
 /// <reference types="gapi.client" />
 
@@ -88,6 +88,20 @@ declare namespace gapi.client {
       /** 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 GoogleCloudDiscoveryengineV1alphaAlloyDbSource {
+      /** Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. */
+      clusterId?: string;
+      /** Required. The AlloyDB database to copy the data from with a length limit of 256 characters. */
+      databaseId?: string;
+      /** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
+      gcsStagingDir?: string;
+      /** Required. The AlloyDB location to copy the data from with a length limit of 256 characters. */
+      locationId?: string;
+      /** The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
+      projectId?: string;
+      /** Required. The AlloyDB table to copy the data from with a length limit of 256 characters. */
+      tableId?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaAnswer {
       /** Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
       answerSkippedReasons?: string[];
@@ -141,6 +155,8 @@ declare namespace gapi.client {
       searchSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec;
       /** The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. */
       session?: string;
+      /** The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */
+      userLabels?: {[P in string]: string};
       /** A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
       userPseudoId?: string;
     }
@@ -1101,6 +1117,8 @@ declare namespace gapi.client {
       updateTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest {
+      /** AlloyDB input source. */
+      alloyDbSource?: GoogleCloudDiscoveryengineV1alphaAlloyDbSource;
       /** Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. */
       autoGenerateIds?: boolean;
       /** BigQuery input source. */
@@ -1641,7 +1659,7 @@ declare namespace gapi.client {
       chunkSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec;
       /** If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */
       extractiveContentSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
-      /** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
+      /** 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`. */
       searchResultMode?: string;
       /** If `snippetSpec` is not specified, snippets are not included in the search response. */
       snippetSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec;
@@ -2321,6 +2339,8 @@ declare namespace gapi.client {
     }
     interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {}
     interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
+      /** Whether chunking mode is enabled. */
+      chunkingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig;
       /** 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`. */
@@ -2330,13 +2350,26 @@ declare namespace gapi.client {
         [P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
       };
     }
+    interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig {
+      /** Configuration for the layout based chunking. */
+      layoutBasedChunkingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
+    }
+    interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
+      /** The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */
+      chunkSize?: number;
+      /** Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */
+      includeAncestorHeadings?: boolean;
+    }
     interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
       /** Configurations applied to digital parser. */
       digitalParsingConfig?: any;
+      /** Configurations applied to layout parser. */
+      layoutParsingConfig?: any;
       /** Configurations applied to OCR parser. Currently it only applies to PDFs. */
       ocrParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
     }
     interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
+    interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
     interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
       /** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
       enhancedDocumentElements?: string[];
@@ -2736,6 +2769,8 @@ declare namespace gapi.client {
     }
     interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {}
     interface GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
+      /** Whether chunking mode is enabled. */
+      chunkingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig;
       /** 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`. */
@@ -2745,13 +2780,26 @@ declare namespace gapi.client {
         [P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
       };
     }
+    interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig {
+      /** Configuration for the layout based chunking. */
+      layoutBasedChunkingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
+    }
+    interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
+      /** The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */
+      chunkSize?: number;
+      /** Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */
+      includeAncestorHeadings?: boolean;
+    }
     interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
       /** Configurations applied to digital parser. */
       digitalParsingConfig?: any;
+      /** Configurations applied to layout parser. */
+      layoutParsingConfig?: any;
       /** Configurations applied to OCR parser. Currently it only applies to PDFs. */
       ocrParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
     }
     interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
+    interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {}
     interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
       /** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
       enhancedDocumentElements?: string[];
@@ -3653,7 +3701,7 @@ declare namespace gapi.client {
         key?: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
-        /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
+        /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;
@@ -3684,7 +3732,7 @@ declare namespace gapi.client {
           key?: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
-          /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
+          /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
           parent: string;
           /** Returns response with indentations and line breaks. */
           prettyPrint?: boolean;
@@ -3773,7 +3821,7 @@ declare namespace gapi.client {
         pageSize?: number;
         /** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
         pageToken?: string;
-        /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
+        /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;
@@ -6524,7 +6572,7 @@ declare namespace gapi.client {
         key?: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
-        /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
+        /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;
@@ -6555,7 +6603,7 @@ declare namespace gapi.client {
           key?: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
-          /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
+          /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
           parent: string;
           /** Returns response with indentations and line breaks. */
           prettyPrint?: boolean;
@@ -6644,7 +6692,7 @@ declare namespace gapi.client {
         pageSize?: number;
         /** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
         pageToken?: string;
-        /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
+        /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;
@@ -8612,7 +8660,7 @@ declare namespace gapi.client {
         key?: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
-        /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
+        /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;
@@ -8643,7 +8691,7 @@ declare namespace gapi.client {
           key?: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
-          /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
+          /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
           parent: string;
           /** Returns response with indentations and line breaks. */
           prettyPrint?: boolean;
@@ -8732,7 +8780,7 @@ declare namespace gapi.client {
         pageSize?: number;
         /** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
         pageToken?: string;
-        /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
+        /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;

package/package.json

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