REST Resource: projects.locations.dataStores

Resource: DataStore

DataStore captures global settings and configs at the DataStore level.

JSON representation 
{
  "name": string,
  "displayName": string,
  "industryVertical": enum (IndustryVertical),
  "solutionTypes": [
    enum (SolutionType)
  ],
  "defaultSchemaId": string,
  "contentConfig": enum (ContentConfig),
  "createTime": string,
  "advancedSiteSearchConfig": {
    object (AdvancedSiteSearchConfig)
  },
  "languageInfo": {
    object (LanguageInfo)
  },
  "naturalLanguageQueryUnderstandingConfig": {
    object (NaturalLanguageQueryUnderstandingConfig)
  },
  "kmsKeyName": string,
  "cmekConfig": {
    object (CmekConfig)
  },
  "idpConfig": {
    object (IdpConfig)
  },
  "billingEstimation": {
    object (BillingEstimation)
  },
  "aclEnabled": boolean,
  "workspaceConfig": {
    object (WorkspaceConfig)
  },
  "documentProcessingConfig": {
    object (DocumentProcessingConfig)
  },
  "startingSchema": {
    object (Schema)
  },
  "servingConfigDataStore": {
    object (ServingConfigDataStore)
  }
}
Fields
name

string

Immutable. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.
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.
industryVertical

enum (IndustryVertical)

Immutable. The industry vertical that the data store registers.
solutionTypes[]

enum (SolutionType)

The solutions that the data store enrolls. Available solutions for each industryVertical:

  • MEDIA: SOLUTION_TYPE_RECOMMENDATION and SOLUTION_TYPE_SEARCH.
  • SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled.
defaultSchemaId

string

Output only. The id of the default Schema asscociated to this data store.
contentConfig

enum (ContentConfig)

Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
createTime

string (Timestamp format)

Output only. Timestamp the DataStore was created at.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
advancedSiteSearchConfig

object (AdvancedSiteSearchConfig)

Optional. Configuration for advanced site search.
languageInfo

object (LanguageInfo)

Language info for DataStore.
naturalLanguageQueryUnderstandingConfig

object (NaturalLanguageQueryUnderstandingConfig)

Optional. Configuration for Natural Language Query Understanding.
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 cmekConfig field.
cmekConfig

object (CmekConfig)

Output only. CMEK-related information for the DataStore.
idpConfig

object (IdpConfig)

Output only. Data store level identity provider config.
billingEstimation

object (BillingEstimation)

Output only. data size estimation for billing.
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.
workspaceConfig

object (WorkspaceConfig)

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.
documentProcessingConfig

object (DocumentProcessingConfig)

Configuration for Document understanding and enrichment.
startingSchema

object (Schema)

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 dataStores.create API, and will be ignored if used in other APIs. This field will be omitted from all API responses including dataStores.create 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.
servingConfigDataStore

object (ServingConfigDataStore)

Optional. Stores serving config at DataStore level.

Methods

completeQuery

 Completes the specified user input with keyword suggestions.

create

 Creates a DataStore.

delete

 Deletes a DataStore.

get

 Gets a DataStore.

getCompletionConfig

 Gets a CompletionConfig

getDocumentProcessingConfig

 Gets a DocumentProcessingConfig.

getSiteSearchEngine

 Gets the SiteSearchEngine.

list

 Lists all the DataStores associated with the project.

patch

 Updates a DataStore

updateCompletionConfig

 Updates the CompletionConfigs.

updateDocumentProcessingConfig

 Updates the DocumentProcessingConfig.