data_stores

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

Overview

Name	data_stores
Type	Resource
Id	google.discoveryengine.data_stores

Fields

Name	Datatype	Description
name	string	Immutable. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
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	Output only. Timestamp the DataStore was created at.
defaultSchemaId	string	Output only. The id of the default Schema asscociated 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	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.
industryVertical	string	Immutable. The industry vertical that the data store registers.
servingConfigDataStore	object	Stores information regarding the serving configurations at DataStore level.
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	Defines the structure and layout of a type of document data.
workspaceConfig	object	Config to store data store type configuration for workspace data

Methods

Name	Accessible by	Required Params	Description
projects_locations_collections_data_stores_get	SELECT	collectionsId, dataStoresId, locationsId, projectsId	Gets a DataStore.
projects_locations_collections_data_stores_list	SELECT	collectionsId, locationsId, projectsId	Lists all the DataStores associated with the project.
projects_locations_data_stores_get	SELECT	dataStoresId, locationsId, projectsId	Gets a DataStore.
projects_locations_data_stores_list	SELECT	locationsId, projectsId	Lists all the DataStores associated with the project.
projects_locations_collections_data_stores_create	INSERT	collectionsId, locationsId, projectsId	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	locationsId, projectsId	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_delete	DELETE	collectionsId, dataStoresId, locationsId, projectsId	Deletes a DataStore.
projects_locations_data_stores_delete	DELETE	dataStoresId, locationsId, projectsId	Deletes a DataStore.
projects_locations_collections_data_stores_patch	UPDATE	collectionsId, dataStoresId, locationsId, projectsId	Updates a DataStore
projects_locations_data_stores_patch	UPDATE	dataStoresId, locationsId, projectsId	Updates a DataStore
projects_locations_collections_data_stores_complete_query	EXEC	collectionsId, dataStoresId, locationsId, projectsId	Completes the specified user input with keyword suggestions.
projects_locations_collections_data_stores_train_custom_model	EXEC	collectionsId, dataStoresId, locationsId, projectsId	Trains a custom model.
projects_locations_data_stores_complete_query	EXEC	dataStoresId, locationsId, projectsId	Completes the specified user input with keyword suggestions.

SELECT examples

Lists all the DataStores associated with the project.

SELECT
name,
contentConfig,
createTime,
defaultSchemaId,
displayName,
documentProcessingConfig,
industryVertical,
servingConfigDataStore,
solutionTypes,
startingSchema,
workspaceConfig
FROM google.discoveryengine.data_stores
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new data_stores resource.

All Properties

/*+ create */
INSERT INTO google.discoveryengine.data_stores (
locationsId,
projectsId,
name,
displayName,
industryVertical,
solutionTypes,
contentConfig,
workspaceConfig,
documentProcessingConfig,
startingSchema,
servingConfigDataStore
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ industryVertical }}',
'{{ solutionTypes }}',
'{{ contentConfig }}',
'{{ workspaceConfig }}',
'{{ documentProcessingConfig }}',
'{{ startingSchema }}',
'{{ servingConfigDataStore }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: industryVertical
      value: string
    - name: solutionTypes
      value:
        - string
    - name: defaultSchemaId
      value: string
    - name: contentConfig
      value: string
    - name: createTime
      value: string
    - name: workspaceConfig
      value:
        - name: type
          value: string
        - name: dasherCustomerId
          value: string
    - name: documentProcessingConfig
      value:
        - name: name
          value: string
        - name: chunkingConfig
          value:
            - name: layoutBasedChunkingConfig
              value:
                - name: chunkSize
                  value: integer
                - name: includeAncestorHeadings
                  value: boolean
        - name: defaultParsingConfig
          value:
            - name: digitalParsingConfig
              value: []
            - name: ocrParsingConfig
              value:
                - name: enhancedDocumentElements
                  value:
                    - string
                - name: useNativeText
                  value: boolean
            - name: layoutParsingConfig
              value: []
        - name: parsingConfigOverrides
          value: object
    - name: startingSchema
      value:
        - name: structSchema
          value: object
        - name: jsonSchema
          value: string
        - name: name
          value: string
    - name: servingConfigDataStore
      value:
        - name: disabledForServing
          value: boolean

UPDATE example

Updates a data_stores resource.

/*+ update */
UPDATE google.discoveryengine.data_stores
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
industryVertical = '{{ industryVertical }}',
solutionTypes = '{{ solutionTypes }}',
contentConfig = '{{ contentConfig }}',
workspaceConfig = '{{ workspaceConfig }}',
documentProcessingConfig = '{{ documentProcessingConfig }}',
startingSchema = '{{ startingSchema }}',
servingConfigDataStore = '{{ servingConfigDataStore }}'
WHERE 
dataStoresId = '{{ dataStoresId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified data_stores resource.

/*+ delete */
DELETE FROM google.discoveryengine.data_stores
WHERE dataStoresId = '{{ dataStoresId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';