data_stores

Creates, updates, deletes, gets or lists a data_stores resource.

Overview

Name	data_stores
Type	Resource
Id	google.discoveryengine.data_stores

Fields

The following fields are returned by SELECT queries:

projects_locations_collections_data_stores_get

Successful response

Name	Datatype	Description
name	string	Immutable. Identifier. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
aclEnabled	boolean	Immutable. Whether data in the DataStore has ACL information. If set to true, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in GENERIC industry vertical with non-PUBLIC_WEBSITE content config.
advancedSiteSearchConfig	object	Optional. Configuration for advanced site search. (id: GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig)
billingEstimation	object	Output only. Data size estimation for billing. (id: GoogleCloudDiscoveryengineV1DataStoreBillingEstimation)
cmekConfig	object	Configurations used to enable CMEK data encryption with Cloud KMS keys. (id: GoogleCloudDiscoveryengineV1CmekConfig)
contentConfig	string	Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
createTime	string (google-datetime)	Output only. Timestamp the DataStore was created at.
defaultSchemaId	string	Output only. The id of the default Schema associated to this data store.
displayName	string	Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
documentProcessingConfig	object	Configuration for Document understanding and enrichment. (id: GoogleCloudDiscoveryengineV1DocumentProcessingConfig)
healthcareFhirConfig	object	Optional. Configuration for HEALTHCARE_FHIR vertical. (id: GoogleCloudDiscoveryengineV1HealthcareFhirConfig)
identityMappingStore	string	Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with THIRD_PARTY or GSUITE IdP. Format: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.
industryVertical	string	Immutable. The industry vertical that the data store registers.
isInfobotFaqDataStore	boolean	Optional. If set, this DataStore is an Infobot FAQ DataStore.
kmsKeyName	string	Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.
servingConfigDataStore	object	Optional. Stores serving config at DataStore level. (id: GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore)
solutionTypes	array	The solutions that the data store enrolls. Available solutions for each industry_vertical: * MEDIA: SOLUTION_TYPE_RECOMMENDATION and SOLUTION_TYPE_SEARCH. * SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled.
startingSchema	object	The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from this doc. (id: GoogleCloudDiscoveryengineV1Schema)
workspaceConfig	object	Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. (id: GoogleCloudDiscoveryengineV1WorkspaceConfig)

projects_locations_collections_data_stores_list

Successful response

Name	Datatype	Description
name	string	Immutable. Identifier. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
aclEnabled	boolean	Immutable. Whether data in the DataStore has ACL information. If set to true, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in GENERIC industry vertical with non-PUBLIC_WEBSITE content config.
advancedSiteSearchConfig	object	Optional. Configuration for advanced site search. (id: GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig)
billingEstimation	object	Output only. Data size estimation for billing. (id: GoogleCloudDiscoveryengineV1DataStoreBillingEstimation)
cmekConfig	object	Configurations used to enable CMEK data encryption with Cloud KMS keys. (id: GoogleCloudDiscoveryengineV1CmekConfig)
contentConfig	string	Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
createTime	string (google-datetime)	Output only. Timestamp the DataStore was created at.
defaultSchemaId	string	Output only. The id of the default Schema associated to this data store.
displayName	string	Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
documentProcessingConfig	object	Configuration for Document understanding and enrichment. (id: GoogleCloudDiscoveryengineV1DocumentProcessingConfig)
healthcareFhirConfig	object	Optional. Configuration for HEALTHCARE_FHIR vertical. (id: GoogleCloudDiscoveryengineV1HealthcareFhirConfig)
identityMappingStore	string	Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with THIRD_PARTY or GSUITE IdP. Format: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.
industryVertical	string	Immutable. The industry vertical that the data store registers.
isInfobotFaqDataStore	boolean	Optional. If set, this DataStore is an Infobot FAQ DataStore.
kmsKeyName	string	Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.
servingConfigDataStore	object	Optional. Stores serving config at DataStore level. (id: GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore)
solutionTypes	array	The solutions that the data store enrolls. Available solutions for each industry_vertical: * MEDIA: SOLUTION_TYPE_RECOMMENDATION and SOLUTION_TYPE_SEARCH. * SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled.
startingSchema	object	The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from this doc. (id: GoogleCloudDiscoveryengineV1Schema)
workspaceConfig	object	Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. (id: GoogleCloudDiscoveryengineV1WorkspaceConfig)

projects_locations_data_stores_get

Successful response

Name	Datatype	Description
name	string	Immutable. Identifier. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
aclEnabled	boolean	Immutable. Whether data in the DataStore has ACL information. If set to true, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in GENERIC industry vertical with non-PUBLIC_WEBSITE content config.
advancedSiteSearchConfig	object	Optional. Configuration for advanced site search. (id: GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig)
billingEstimation	object	Output only. Data size estimation for billing. (id: GoogleCloudDiscoveryengineV1DataStoreBillingEstimation)
cmekConfig	object	Configurations used to enable CMEK data encryption with Cloud KMS keys. (id: GoogleCloudDiscoveryengineV1CmekConfig)
contentConfig	string	Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
createTime	string (google-datetime)	Output only. Timestamp the DataStore was created at.
defaultSchemaId	string	Output only. The id of the default Schema associated to this data store.
displayName	string	Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
documentProcessingConfig	object	Configuration for Document understanding and enrichment. (id: GoogleCloudDiscoveryengineV1DocumentProcessingConfig)
healthcareFhirConfig	object	Optional. Configuration for HEALTHCARE_FHIR vertical. (id: GoogleCloudDiscoveryengineV1HealthcareFhirConfig)
identityMappingStore	string	Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with THIRD_PARTY or GSUITE IdP. Format: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.
industryVertical	string	Immutable. The industry vertical that the data store registers.
isInfobotFaqDataStore	boolean	Optional. If set, this DataStore is an Infobot FAQ DataStore.
kmsKeyName	string	Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.
servingConfigDataStore	object	Optional. Stores serving config at DataStore level. (id: GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore)
solutionTypes	array	The solutions that the data store enrolls. Available solutions for each industry_vertical: * MEDIA: SOLUTION_TYPE_RECOMMENDATION and SOLUTION_TYPE_SEARCH. * SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled.
startingSchema	object	The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from this doc. (id: GoogleCloudDiscoveryengineV1Schema)
workspaceConfig	object	Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. (id: GoogleCloudDiscoveryengineV1WorkspaceConfig)

projects_locations_data_stores_list

Successful response

Name	Datatype	Description
name	string	Immutable. Identifier. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
aclEnabled	boolean	Immutable. Whether data in the DataStore has ACL information. If set to true, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in GENERIC industry vertical with non-PUBLIC_WEBSITE content config.
advancedSiteSearchConfig	object	Optional. Configuration for advanced site search. (id: GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig)
billingEstimation	object	Output only. Data size estimation for billing. (id: GoogleCloudDiscoveryengineV1DataStoreBillingEstimation)
cmekConfig	object	Configurations used to enable CMEK data encryption with Cloud KMS keys. (id: GoogleCloudDiscoveryengineV1CmekConfig)
contentConfig	string	Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
createTime	string (google-datetime)	Output only. Timestamp the DataStore was created at.
defaultSchemaId	string	Output only. The id of the default Schema associated to this data store.
displayName	string	Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
documentProcessingConfig	object	Configuration for Document understanding and enrichment. (id: GoogleCloudDiscoveryengineV1DocumentProcessingConfig)
healthcareFhirConfig	object	Optional. Configuration for HEALTHCARE_FHIR vertical. (id: GoogleCloudDiscoveryengineV1HealthcareFhirConfig)
identityMappingStore	string	Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with THIRD_PARTY or GSUITE IdP. Format: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.
industryVertical	string	Immutable. The industry vertical that the data store registers.
isInfobotFaqDataStore	boolean	Optional. If set, this DataStore is an Infobot FAQ DataStore.
kmsKeyName	string	Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.
servingConfigDataStore	object	Optional. Stores serving config at DataStore level. (id: GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore)
solutionTypes	array	The solutions that the data store enrolls. Available solutions for each industry_vertical: * MEDIA: SOLUTION_TYPE_RECOMMENDATION and SOLUTION_TYPE_SEARCH. * SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled.
startingSchema	object	The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from this doc. (id: GoogleCloudDiscoveryengineV1Schema)
workspaceConfig	object	Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. (id: GoogleCloudDiscoveryengineV1WorkspaceConfig)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_collections_data_stores_get	select	projectsId, locationsId, collectionsId, dataStoresId		Gets a DataStore.
projects_locations_collections_data_stores_list	select	projectsId, locationsId, collectionsId	pageSize, pageToken, filter	Lists all the DataStores associated with the project.
projects_locations_data_stores_get	select	projectsId, locationsId, dataStoresId		Gets a DataStore.
projects_locations_data_stores_list	select	projectsId, locationsId	pageSize, pageToken, filter	Lists all the DataStores associated with the project.
projects_locations_collections_data_stores_create	insert	projectsId, locationsId, collectionsId	cmekConfigName, disableCmek, dataStoreId, createAdvancedSiteSearch, skipDefaultSchemaCreation	Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
projects_locations_data_stores_create	insert	projectsId, locationsId	cmekConfigName, disableCmek, dataStoreId, createAdvancedSiteSearch, skipDefaultSchemaCreation	Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
projects_locations_collections_data_stores_patch	update	projectsId, locationsId, collectionsId, dataStoresId	updateMask	Updates a DataStore
projects_locations_data_stores_patch	update	projectsId, locationsId, dataStoresId	updateMask	Updates a DataStore
projects_locations_collections_data_stores_delete	delete	projectsId, locationsId, collectionsId, dataStoresId		Deletes a DataStore.
projects_locations_data_stores_delete	delete	projectsId, locationsId, dataStoresId		Deletes a DataStore.
projects_locations_collections_data_stores_complete_query	exec	projectsId, locationsId, collectionsId, dataStoresId	query, queryModel, userPseudoId, includeTailSuggestions	Completes the specified user input with keyword suggestions.
projects_locations_collections_data_stores_train_custom_model	exec	projectsId, locationsId, collectionsId, dataStoresId		Trains a custom model.
projects_locations_data_stores_complete_query	exec	projectsId, locationsId, dataStoresId	query, queryModel, userPseudoId, includeTailSuggestions	Completes the specified user input with keyword suggestions.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
collectionsId	string
dataStoresId	string
locationsId	string
projectsId	string
cmekConfigName	string
createAdvancedSiteSearch	boolean
dataStoreId	string
disableCmek	boolean
filter	string
includeTailSuggestions	boolean
pageSize	integer (int32)
pageToken	string
query	string
queryModel	string
skipDefaultSchemaCreation	boolean
updateMask	string (google-fieldmask)
userPseudoId	string

SELECT examples

projects_locations_collections_data_stores_get

Gets a DataStore.

SELECT
name,
aclEnabled,
advancedSiteSearchConfig,
billingEstimation,
cmekConfig,
contentConfig,
createTime,
defaultSchemaId,
displayName,
documentProcessingConfig,
healthcareFhirConfig,
identityMappingStore,
industryVertical,
isInfobotFaqDataStore,
kmsKeyName,
servingConfigDataStore,
solutionTypes,
startingSchema,
workspaceConfig
FROM google.discoveryengine.data_stores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required;

projects_locations_collections_data_stores_list

Lists all the DataStores associated with the project.

SELECT
name,
aclEnabled,
advancedSiteSearchConfig,
billingEstimation,
cmekConfig,
contentConfig,
createTime,
defaultSchemaId,
displayName,
documentProcessingConfig,
healthcareFhirConfig,
identityMappingStore,
industryVertical,
isInfobotFaqDataStore,
kmsKeyName,
servingConfigDataStore,
solutionTypes,
startingSchema,
workspaceConfig
FROM google.discoveryengine.data_stores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

projects_locations_data_stores_get

Gets a DataStore.

SELECT
name,
aclEnabled,
advancedSiteSearchConfig,
billingEstimation,
cmekConfig,
contentConfig,
createTime,
defaultSchemaId,
displayName,
documentProcessingConfig,
healthcareFhirConfig,
identityMappingStore,
industryVertical,
isInfobotFaqDataStore,
kmsKeyName,
servingConfigDataStore,
solutionTypes,
startingSchema,
workspaceConfig
FROM google.discoveryengine.data_stores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required;

projects_locations_data_stores_list

Lists all the DataStores associated with the project.

SELECT
name,
aclEnabled,
advancedSiteSearchConfig,
billingEstimation,
cmekConfig,
contentConfig,
createTime,
defaultSchemaId,
displayName,
documentProcessingConfig,
healthcareFhirConfig,
identityMappingStore,
industryVertical,
isInfobotFaqDataStore,
kmsKeyName,
servingConfigDataStore,
solutionTypes,
startingSchema,
workspaceConfig
FROM google.discoveryengine.data_stores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

INSERT examples

projects_locations_collections_data_stores_create

Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.

INSERT INTO google.discoveryengine.data_stores (
data__name,
data__displayName,
data__industryVertical,
data__solutionTypes,
data__contentConfig,
data__advancedSiteSearchConfig,
data__kmsKeyName,
data__aclEnabled,
data__workspaceConfig,
data__documentProcessingConfig,
data__startingSchema,
data__healthcareFhirConfig,
data__servingConfigDataStore,
data__identityMappingStore,
data__isInfobotFaqDataStore,
projectsId,
locationsId,
collectionsId,
cmekConfigName,
disableCmek,
dataStoreId,
createAdvancedSiteSearch,
skipDefaultSchemaCreation
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ industryVertical }}',
'{{ solutionTypes }}',
'{{ contentConfig }}',
'{{ advancedSiteSearchConfig }}',
'{{ kmsKeyName }}',
{{ aclEnabled }},
'{{ workspaceConfig }}',
'{{ documentProcessingConfig }}',
'{{ startingSchema }}',
'{{ healthcareFhirConfig }}',
'{{ servingConfigDataStore }}',
'{{ identityMappingStore }}',
{{ isInfobotFaqDataStore }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ collectionsId }}',
'{{ cmekConfigName }}',
'{{ disableCmek }}',
'{{ dataStoreId }}',
'{{ createAdvancedSiteSearch }}',
'{{ skipDefaultSchemaCreation }}'
RETURNING
name,
done,
error,
metadata,
response
;

projects_locations_data_stores_create

Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.

INSERT INTO google.discoveryengine.data_stores (
data__name,
data__displayName,
data__industryVertical,
data__solutionTypes,
data__contentConfig,
data__advancedSiteSearchConfig,
data__kmsKeyName,
data__aclEnabled,
data__workspaceConfig,
data__documentProcessingConfig,
data__startingSchema,
data__healthcareFhirConfig,
data__servingConfigDataStore,
data__identityMappingStore,
data__isInfobotFaqDataStore,
projectsId,
locationsId,
cmekConfigName,
disableCmek,
dataStoreId,
createAdvancedSiteSearch,
skipDefaultSchemaCreation
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ industryVertical }}',
'{{ solutionTypes }}',
'{{ contentConfig }}',
'{{ advancedSiteSearchConfig }}',
'{{ kmsKeyName }}',
{{ aclEnabled }},
'{{ workspaceConfig }}',
'{{ documentProcessingConfig }}',
'{{ startingSchema }}',
'{{ healthcareFhirConfig }}',
'{{ servingConfigDataStore }}',
'{{ identityMappingStore }}',
{{ isInfobotFaqDataStore }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ cmekConfigName }}',
'{{ disableCmek }}',
'{{ dataStoreId }}',
'{{ createAdvancedSiteSearch }}',
'{{ skipDefaultSchemaCreation }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: data_stores
  props:
    - name: projectsId
      value: string
      description: Required parameter for the data_stores resource.
    - name: locationsId
      value: string
      description: Required parameter for the data_stores resource.
    - name: collectionsId
      value: string
      description: Required parameter for the data_stores resource.
    - name: name
      value: string
      description: >
        Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
        
    - name: displayName
      value: string
      description: >
        Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
        
    - name: industryVertical
      value: string
      description: >
        Immutable. The industry vertical that the data store registers.
        
      valid_values: ['INDUSTRY_VERTICAL_UNSPECIFIED', 'GENERIC', 'MEDIA', 'HEALTHCARE_FHIR']
    - name: solutionTypes
      value: array
      description: >
        The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
        
    - name: contentConfig
      value: string
      description: >
        Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
        
      valid_values: ['CONTENT_CONFIG_UNSPECIFIED', 'NO_CONTENT', 'CONTENT_REQUIRED', 'PUBLIC_WEBSITE', 'GOOGLE_WORKSPACE']
    - name: advancedSiteSearchConfig
      value: object
      description: >
        Optional. Configuration for advanced site search.
        
    - name: kmsKeyName
      value: string
      description: >
        Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.
        
    - name: aclEnabled
      value: boolean
      description: >
        Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.
        
    - name: workspaceConfig
      value: object
      description: >
        Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
        
    - name: documentProcessingConfig
      value: object
      description: >
        Configuration for Document understanding and enrichment.
        
    - name: startingSchema
      value: object
      description: >
        The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
        
    - name: healthcareFhirConfig
      value: object
      description: >
        Optional. Configuration for `HEALTHCARE_FHIR` vertical.
        
    - name: servingConfigDataStore
      value: object
      description: >
        Optional. Stores serving config at DataStore level.
        
    - name: identityMappingStore
      value: string
      description: >
        Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
        
    - name: isInfobotFaqDataStore
      value: boolean
      description: >
        Optional. If set, this DataStore is an Infobot FAQ DataStore.
        
    - name: cmekConfigName
      value: string
    - name: disableCmek
      value: boolean
    - name: dataStoreId
      value: string
    - name: createAdvancedSiteSearch
      value: boolean
    - name: skipDefaultSchemaCreation
      value: boolean

UPDATE examples

projects_locations_collections_data_stores_patch

Updates a DataStore

UPDATE google.discoveryengine.data_stores
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__industryVertical = '{{ industryVertical }}',
data__solutionTypes = '{{ solutionTypes }}',
data__contentConfig = '{{ contentConfig }}',
data__advancedSiteSearchConfig = '{{ advancedSiteSearchConfig }}',
data__kmsKeyName = '{{ kmsKeyName }}',
data__aclEnabled = {{ aclEnabled }},
data__workspaceConfig = '{{ workspaceConfig }}',
data__documentProcessingConfig = '{{ documentProcessingConfig }}',
data__startingSchema = '{{ startingSchema }}',
data__healthcareFhirConfig = '{{ healthcareFhirConfig }}',
data__servingConfigDataStore = '{{ servingConfigDataStore }}',
data__identityMappingStore = '{{ identityMappingStore }}',
data__isInfobotFaqDataStore = {{ isInfobotFaqDataStore }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
aclEnabled,
advancedSiteSearchConfig,
billingEstimation,
cmekConfig,
contentConfig,
createTime,
defaultSchemaId,
displayName,
documentProcessingConfig,
healthcareFhirConfig,
identityMappingStore,
industryVertical,
isInfobotFaqDataStore,
kmsKeyName,
servingConfigDataStore,
solutionTypes,
startingSchema,
workspaceConfig;

projects_locations_data_stores_patch

Updates a DataStore

UPDATE google.discoveryengine.data_stores
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__industryVertical = '{{ industryVertical }}',
data__solutionTypes = '{{ solutionTypes }}',
data__contentConfig = '{{ contentConfig }}',
data__advancedSiteSearchConfig = '{{ advancedSiteSearchConfig }}',
data__kmsKeyName = '{{ kmsKeyName }}',
data__aclEnabled = {{ aclEnabled }},
data__workspaceConfig = '{{ workspaceConfig }}',
data__documentProcessingConfig = '{{ documentProcessingConfig }}',
data__startingSchema = '{{ startingSchema }}',
data__healthcareFhirConfig = '{{ healthcareFhirConfig }}',
data__servingConfigDataStore = '{{ servingConfigDataStore }}',
data__identityMappingStore = '{{ identityMappingStore }}',
data__isInfobotFaqDataStore = {{ isInfobotFaqDataStore }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
aclEnabled,
advancedSiteSearchConfig,
billingEstimation,
cmekConfig,
contentConfig,
createTime,
defaultSchemaId,
displayName,
documentProcessingConfig,
healthcareFhirConfig,
identityMappingStore,
industryVertical,
isInfobotFaqDataStore,
kmsKeyName,
servingConfigDataStore,
solutionTypes,
startingSchema,
workspaceConfig;

DELETE examples

projects_locations_collections_data_stores_delete

Deletes a DataStore.

DELETE FROM google.discoveryengine.data_stores
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required;

projects_locations_data_stores_delete

Deletes a DataStore.

DELETE FROM google.discoveryengine.data_stores
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required;

Lifecycle Methods

projects_locations_collections_data_stores_complete_query

Completes the specified user input with keyword suggestions.

EXEC google.discoveryengine.data_stores.projects_locations_collections_data_stores_complete_query 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@query='{{ query }}', 
@queryModel='{{ queryModel }}', 
@userPseudoId='{{ userPseudoId }}', 
@includeTailSuggestions={{ includeTailSuggestions }};

projects_locations_collections_data_stores_train_custom_model

Trains a custom model.

EXEC google.discoveryengine.data_stores.projects_locations_collections_data_stores_train_custom_model 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required 
@@json=
'{
"gcsTrainingInput": "{{ gcsTrainingInput }}", 
"modelType": "{{ modelType }}", 
"errorConfig": "{{ errorConfig }}", 
"modelId": "{{ modelId }}"
}';

projects_locations_data_stores_complete_query

Completes the specified user input with keyword suggestions.

EXEC google.discoveryengine.data_stores.projects_locations_data_stores_complete_query 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@query='{{ query }}', 
@queryModel='{{ queryModel }}', 
@userPseudoId='{{ userPseudoId }}', 
@includeTailSuggestions={{ includeTailSuggestions }};