diff --git a/discovery/discoveryengine-v1.json b/discovery/discoveryengine-v1.json index 5e85a48742..1c0968db0b 100644 --- a/discovery/discoveryengine-v1.json +++ b/discovery/discoveryengine-v1.json @@ -789,7 +789,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -883,7 +883,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -2594,7 +2594,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2688,7 +2688,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3928,7 +3928,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4022,7 +4022,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5550,7 +5550,7 @@ } } }, - "revision": "20240526", + "revision": "20240530", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5699,6 +5699,37 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1AlloyDbSource": { + "description": "AlloyDB source import data from.", + "id": "GoogleCloudDiscoveryengineV1AlloyDbSource", + "properties": { + "clusterId": { + "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "databaseId": { + "description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "gcsStagingDir": { + "description": "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.", + "type": "string" + }, + "locationId": { + "description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "projectId": { + "description": "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.", + "type": "string" + }, + "tableId": { + "description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1Answer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1Answer", @@ -5866,6 +5897,13 @@ "description": "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.", "type": "string" }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "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.", + "type": "object" + }, "userPseudoId": { "description": "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.", "type": "string" @@ -7658,6 +7696,10 @@ "description": "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.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "description": "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." @@ -7676,6 +7718,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", @@ -7684,6 +7753,10 @@ "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -7697,6 +7770,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", @@ -8086,6 +8165,10 @@ "description": "Request message for Import methods.", "id": "GoogleCloudDiscoveryengineV1ImportDocumentsRequest", "properties": { + "alloyDbSource": { + "$ref": "GoogleCloudDiscoveryengineV1AlloyDbSource", + "description": "AlloyDB input source." + }, "autoGenerateIds": { "description": "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.", "type": "boolean" @@ -13176,6 +13259,10 @@ "description": "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.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", "description": "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." @@ -13194,6 +13281,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", @@ -13202,6 +13316,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -13215,6 +13333,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index 0dd86b6aff..235fa573be 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -1134,7 +1134,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1228,7 +1228,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -3175,7 +3175,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3269,7 +3269,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -4785,7 +4785,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4879,7 +4879,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -6568,7 +6568,7 @@ } } }, - "revision": "20240526", + "revision": "20240530", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -7192,6 +7192,10 @@ "description": "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.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "description": "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." @@ -7210,6 +7214,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", @@ -7218,6 +7249,10 @@ "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -7231,6 +7266,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", @@ -7979,6 +8020,37 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAlloyDbSource": { + "description": "AlloyDB source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", + "properties": { + "clusterId": { + "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "databaseId": { + "description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "gcsStagingDir": { + "description": "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.", + "type": "string" + }, + "locationId": { + "description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "projectId": { + "description": "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.", + "type": "string" + }, + "tableId": { + "description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAnswer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1alphaAnswer", @@ -8146,6 +8218,13 @@ "description": "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.", "type": "string" }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "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.", + "type": "object" + }, "userPseudoId": { "description": "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.", "type": "string" @@ -11090,6 +11169,10 @@ "description": "Request message for Import methods.", "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest", "properties": { + "alloyDbSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", + "description": "AlloyDB input source." + }, "autoGenerateIds": { "description": "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.", "type": "boolean" @@ -12619,7 +12702,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { - "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", + "description": "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`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -14597,6 +14680,10 @@ "description": "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.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", "description": "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." @@ -14615,6 +14702,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", @@ -14623,6 +14737,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -14636,6 +14754,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", diff --git a/discovery/discoveryengine-v1beta.json b/discovery/discoveryengine-v1beta.json index 086dadd826..4107fa971c 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -817,7 +817,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -911,7 +911,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -2830,7 +2830,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2924,7 +2924,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -4259,7 +4259,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4353,7 +4353,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "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}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5948,7 +5948,7 @@ } } }, - "revision": "20240526", + "revision": "20240530", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6572,6 +6572,10 @@ "description": "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.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "description": "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." @@ -6590,6 +6594,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", @@ -6598,6 +6629,10 @@ "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -6611,6 +6646,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", @@ -9787,6 +9828,37 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaAlloyDbSource": { + "description": "AlloyDB source import data from.", + "id": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", + "properties": { + "clusterId": { + "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "databaseId": { + "description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "gcsStagingDir": { + "description": "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.", + "type": "string" + }, + "locationId": { + "description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "projectId": { + "description": "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.", + "type": "string" + }, + "tableId": { + "description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaAnswer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1betaAnswer", @@ -9954,6 +10026,13 @@ "description": "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.", "type": "string" }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "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.", + "type": "object" + }, "userPseudoId": { "description": "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.", "type": "string" @@ -11808,6 +11887,10 @@ "description": "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.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", "description": "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." @@ -11826,6 +11909,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", @@ -11834,6 +11944,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -11847,6 +11961,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", @@ -12262,6 +12382,10 @@ "description": "Request message for Import methods.", "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsRequest", "properties": { + "alloyDbSource": { + "$ref": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", + "description": "AlloyDB input source." + }, "autoGenerateIds": { "description": "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.", "type": "boolean" diff --git a/src/apis/discoveryengine/v1.ts b/src/apis/discoveryengine/v1.ts index dc66b7d9c1..6f3069c45e 100644 --- a/src/apis/discoveryengine/v1.ts +++ b/src/apis/discoveryengine/v1.ts @@ -239,6 +239,35 @@ export namespace discoveryengine_v1 { */ functionName?: string | null; } + /** + * AlloyDB source import data from. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AlloyDbSource { + /** + * Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. + */ + clusterId?: string | null; + /** + * Required. The AlloyDB database to copy the data from with a length limit of 256 characters. + */ + databaseId?: string | null; + /** + * 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 | null; + /** + * Required. The AlloyDB location to copy the data from with a length limit of 256 characters. + */ + locationId?: string | null; + /** + * 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 | null; + /** + * Required. The AlloyDB table to copy the data from with a length limit of 256 characters. + */ + tableId?: string | null; + } /** * Access Control Configuration. */ @@ -1971,6 +2000,10 @@ export namespace discoveryengine_v1 { * 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 | null; + /** + * 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?: {[key: string]: string} | null; /** * 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. */ @@ -2841,6 +2874,10 @@ export namespace discoveryengine_v1 { * 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. */ export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig { + /** + * Whether chunking mode is enabled. + */ + chunkingConfig?: Schema$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. */ @@ -2858,6 +2895,28 @@ export namespace discoveryengine_v1 { ]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; } | null; } + /** + * Configuration for chunking config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig { + /** + * Configuration for the layout based chunking. + */ + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + } + /** + * Configuration for the layout based chunking. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + /** + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + */ + chunkSize?: number | null; + /** + * 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 | null; + } /** * Related configurations applied to a specific type of document parser. */ @@ -2866,6 +2925,10 @@ export namespace discoveryengine_v1 { * Configurations applied to digital parser. */ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig; + /** + * Configurations applied to layout parser. + */ + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig; /** * Configurations applied to OCR parser. Currently it only applies to PDFs. */ @@ -2875,6 +2938,10 @@ export namespace discoveryengine_v1 { * The digital parsing configurations for documents. */ export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The layout parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} /** * The OCR parsing configurations for documents. */ @@ -4206,6 +4273,10 @@ export namespace discoveryengine_v1 { * 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. */ export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig { + /** + * Whether chunking mode is enabled. + */ + chunkingConfig?: Schema$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. */ @@ -4223,6 +4294,28 @@ export namespace discoveryengine_v1 { ]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; } | null; } + /** + * Configuration for chunking config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig { + /** + * Configuration for the layout based chunking. + */ + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + } + /** + * Configuration for the layout based chunking. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + /** + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + */ + chunkSize?: number | null; + /** + * 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 | null; + } /** * Related configurations applied to a specific type of document parser. */ @@ -4231,6 +4324,10 @@ export namespace discoveryengine_v1 { * Configurations applied to digital parser. */ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig; + /** + * Configurations applied to layout parser. + */ + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig; /** * Configurations applied to OCR parser. Currently it only applies to PDFs. */ @@ -4240,6 +4337,10 @@ export namespace discoveryengine_v1 { * The digital parsing configurations for documents. */ export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The layout parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {} /** * The OCR parsing configurations for documents. */ @@ -4515,6 +4616,10 @@ export namespace discoveryengine_v1 { * Request message for Import methods. */ export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsRequest { + /** + * AlloyDB input source. + */ + alloyDbSource?: Schema$GoogleCloudDiscoveryengineV1AlloyDbSource; /** * 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. */ @@ -9056,7 +9161,7 @@ export namespace discoveryengine_v1 { */ controlId?: 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; @@ -9094,7 +9199,7 @@ export namespace discoveryengine_v1 { */ 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; } @@ -15352,7 +15457,7 @@ export namespace discoveryengine_v1 { */ controlId?: 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; @@ -15390,7 +15495,7 @@ export namespace discoveryengine_v1 { */ 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; } @@ -19973,7 +20078,7 @@ export namespace discoveryengine_v1 { */ controlId?: 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; @@ -20011,7 +20116,7 @@ export namespace discoveryengine_v1 { */ 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; } diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index 6181ac398f..1c3f3005ed 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -252,6 +252,35 @@ export namespace discoveryengine_v1alpha { */ name?: string | null; } + /** + * AlloyDB source import data from. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAlloyDbSource { + /** + * Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. + */ + clusterId?: string | null; + /** + * Required. The AlloyDB database to copy the data from with a length limit of 256 characters. + */ + databaseId?: string | null; + /** + * 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 | null; + /** + * Required. The AlloyDB location to copy the data from with a length limit of 256 characters. + */ + locationId?: string | null; + /** + * 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 | null; + /** + * Required. The AlloyDB table to copy the data from with a length limit of 256 characters. + */ + tableId?: string | null; + } /** * Defines an answer. */ @@ -363,6 +392,10 @@ export namespace discoveryengine_v1alpha { * 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 | null; + /** + * 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?: {[key: string]: string} | null; /** * 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. */ @@ -2415,6 +2448,10 @@ export namespace discoveryengine_v1alpha { * Request message for Import methods. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest { + /** + * AlloyDB input source. + */ + alloyDbSource?: Schema$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. */ @@ -3567,7 +3604,7 @@ export namespace discoveryengine_v1alpha { */ extractiveContentSpec?: Schema$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 | null; /** @@ -5004,6 +5041,10 @@ export namespace discoveryengine_v1alpha { * 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. */ export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig { + /** + * Whether chunking mode is enabled. + */ + chunkingConfig?: Schema$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. */ @@ -5021,6 +5062,28 @@ export namespace discoveryengine_v1alpha { ]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; } | null; } + /** + * Configuration for chunking config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig { + /** + * Configuration for the layout based chunking. + */ + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + } + /** + * Configuration for the layout based chunking. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + /** + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + */ + chunkSize?: number | null; + /** + * 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 | null; + } /** * Related configurations applied to a specific type of document parser. */ @@ -5029,6 +5092,10 @@ export namespace discoveryengine_v1alpha { * Configurations applied to digital parser. */ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig; + /** + * Configurations applied to layout parser. + */ + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig; /** * Configurations applied to OCR parser. Currently it only applies to PDFs. */ @@ -5038,6 +5105,10 @@ export namespace discoveryengine_v1alpha { * The digital parsing configurations for documents. */ export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The layout parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} /** * The OCR parsing configurations for documents. */ @@ -5894,6 +5965,10 @@ export namespace discoveryengine_v1alpha { * 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. */ export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig { + /** + * Whether chunking mode is enabled. + */ + chunkingConfig?: Schema$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. */ @@ -5911,6 +5986,28 @@ export namespace discoveryengine_v1alpha { ]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; } | null; } + /** + * Configuration for chunking config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig { + /** + * Configuration for the layout based chunking. + */ + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + } + /** + * Configuration for the layout based chunking. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + /** + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + */ + chunkSize?: number | null; + /** + * 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 | null; + } /** * Related configurations applied to a specific type of document parser. */ @@ -5919,6 +6016,10 @@ export namespace discoveryengine_v1alpha { * Configurations applied to digital parser. */ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig; + /** + * Configurations applied to layout parser. + */ + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig; /** * Configurations applied to OCR parser. Currently it only applies to PDFs. */ @@ -5928,6 +6029,10 @@ export namespace discoveryengine_v1alpha { * The digital parsing configurations for documents. */ export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The layout parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {} /** * The OCR parsing configurations for documents. */ @@ -10581,7 +10686,7 @@ export namespace discoveryengine_v1alpha { */ controlId?: 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; @@ -10619,7 +10724,7 @@ export namespace discoveryengine_v1alpha { */ 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; } @@ -17759,7 +17864,7 @@ export namespace discoveryengine_v1alpha { */ controlId?: 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; @@ -17797,7 +17902,7 @@ export namespace discoveryengine_v1alpha { */ 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; } @@ -23271,7 +23376,7 @@ export namespace discoveryengine_v1alpha { */ controlId?: 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; @@ -23309,7 +23414,7 @@ export namespace discoveryengine_v1alpha { */ 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; } diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index ebe30eb507..7af37f64d9 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -1882,6 +1882,35 @@ export namespace discoveryengine_v1beta { */ targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[]; } + /** + * AlloyDB source import data from. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAlloyDbSource { + /** + * Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. + */ + clusterId?: string | null; + /** + * Required. The AlloyDB database to copy the data from with a length limit of 256 characters. + */ + databaseId?: string | null; + /** + * 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 | null; + /** + * Required. The AlloyDB location to copy the data from with a length limit of 256 characters. + */ + locationId?: string | null; + /** + * 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 | null; + /** + * Required. The AlloyDB table to copy the data from with a length limit of 256 characters. + */ + tableId?: string | null; + } /** * Defines an answer. */ @@ -1993,6 +2022,10 @@ export namespace discoveryengine_v1beta { * 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 | null; + /** + * 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?: {[key: string]: string} | null; /** * 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. */ @@ -3324,6 +3357,10 @@ export namespace discoveryengine_v1beta { * 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. */ export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig { + /** + * Whether chunking mode is enabled. + */ + chunkingConfig?: Schema$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. */ @@ -3341,6 +3378,28 @@ export namespace discoveryengine_v1beta { ]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; } | null; } + /** + * Configuration for chunking config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig { + /** + * Configuration for the layout based chunking. + */ + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + } + /** + * Configuration for the layout based chunking. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + /** + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + */ + chunkSize?: number | null; + /** + * 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 | null; + } /** * Related configurations applied to a specific type of document parser. */ @@ -3349,6 +3408,10 @@ export namespace discoveryengine_v1beta { * Configurations applied to digital parser. */ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig; + /** + * Configurations applied to layout parser. + */ + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig; /** * Configurations applied to OCR parser. Currently it only applies to PDFs. */ @@ -3358,6 +3421,10 @@ export namespace discoveryengine_v1beta { * The digital parsing configurations for documents. */ export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The layout parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} /** * The OCR parsing configurations for documents. */ @@ -3651,6 +3718,10 @@ export namespace discoveryengine_v1beta { * Request message for Import methods. */ export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequest { + /** + * AlloyDB input source. + */ + alloyDbSource?: Schema$GoogleCloudDiscoveryengineV1betaAlloyDbSource; /** * 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. */ @@ -5936,6 +6007,10 @@ export namespace discoveryengine_v1beta { * 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. */ export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig { + /** + * Whether chunking mode is enabled. + */ + chunkingConfig?: Schema$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. */ @@ -5953,6 +6028,28 @@ export namespace discoveryengine_v1beta { ]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; } | null; } + /** + * Configuration for chunking config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig { + /** + * Configuration for the layout based chunking. + */ + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + } + /** + * Configuration for the layout based chunking. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + /** + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + */ + chunkSize?: number | null; + /** + * 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 | null; + } /** * Related configurations applied to a specific type of document parser. */ @@ -5961,6 +6058,10 @@ export namespace discoveryengine_v1beta { * Configurations applied to digital parser. */ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig; + /** + * Configurations applied to layout parser. + */ + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig; /** * Configurations applied to OCR parser. Currently it only applies to PDFs. */ @@ -5970,6 +6071,10 @@ export namespace discoveryengine_v1beta { * The digital parsing configurations for documents. */ export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The layout parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {} /** * The OCR parsing configurations for documents. */ @@ -9528,7 +9633,7 @@ export namespace discoveryengine_v1beta { */ controlId?: 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; @@ -9566,7 +9671,7 @@ export namespace discoveryengine_v1beta { */ 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; } @@ -16598,7 +16703,7 @@ export namespace discoveryengine_v1beta { */ controlId?: 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; @@ -16636,7 +16741,7 @@ export namespace discoveryengine_v1beta { */ 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; } @@ -21551,7 +21656,7 @@ export namespace discoveryengine_v1beta { */ controlId?: 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; @@ -21589,7 +21694,7 @@ export namespace discoveryengine_v1beta { */ 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; }