REST Resource: projects.locations.dataStores

资源：数据存储区

DataStore 会在数据存储区级别捕获全局设置和配置。

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "industryVertical": enum (IndustryVertical),
  "solutionTypes": [
    enum (SolutionType)
  ],
  "defaultSchemaId": string,
  "contentConfig": enum (ContentConfig),
  "createTime": string,
  "advancedSiteSearchConfig": {
    object (AdvancedSiteSearchConfig)
  },
  "kmsKeyName": string,
  "cmekConfig": {
    object (CmekConfig)
  },
  "billingEstimation": {
    object (BillingEstimation)
  },
  "aclEnabled": boolean,
  "workspaceConfig": {
    object (WorkspaceConfig)
  },
  "documentProcessingConfig": {
    object (DocumentProcessingConfig)
  },
  "startingSchema": {
    object (Schema)
  },
  "healthcareFhirConfig": {
    object (HealthcareFhirConfig)
  },
  "servingConfigDataStore": {
    object (ServingConfigDataStore)
  },
  "identityMappingStore": string,
  "isInfobotFaqDataStore": boolean,
  "configurableBillingApproach": enum (ConfigurableBillingApproach)
}
字段
name

string

不可变。标识符。数据存储区的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}。

此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
displayName

string

必需。数据存储区的显示名称。

此字段必须是采用 UTF-8 编码的字符串，长度上限为 128 个字符。否则，系统会返回 INVALID_ARGUMENT 错误。
industryVertical

enum (IndustryVertical)

不可变。数据存储区所注册的垂直行业。
solutionTypes[]

enum (SolutionType)

数据存储区所注册的解决方案。每种 industryVertical 的可用解决方案：

  • MEDIA：SOLUTION_TYPE_RECOMMENDATION 和 SOLUTION_TYPE_SEARCH。
  • SITE_SEARCH：系统会自动注册 SOLUTION_TYPE_SEARCH；无法注册其他解决方案。
defaultSchemaId

string

仅限输出。与相应数据存储区关联的默认 Schema 的 ID。
contentConfig

enum (ContentConfig)

不可变。数据存储区的内容配置。如果未设置此字段，服务器行为将默认为 ContentConfig.NO_CONTENT。
createTime

string (Timestamp format)

仅限输出。创建 DataStore 时的时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"
advancedSiteSearchConfig

object (AdvancedSiteSearchConfig)

可选。高级网站搜索的配置。
kmsKeyName

string

仅限输入。创建相应数据存储区时设置的用于保护该数据存储区的 KMS 密钥。

必须针对需要遵守 CMEK 组织政策保护的请求进行设置。

如果此字段已成功设置并处理，则数据存储区将受 cmekConfig 字段中指定的 KMS 密钥保护。
cmekConfig

object (CmekConfig)

仅限输出。数据存储区的 CMEK 相关信息。
billingEstimation

object (BillingEstimation)

仅限输出。用于结算用途的数据大小估算值。
aclEnabled

boolean

不可变。指示 DataStore 中的数据是否包含 ACL 信息。如果设置为 true，则源数据必须包含 ACL。当通过 DocumentService.ImportDocuments 方法提取数据时，ACL 会一并提取。

如果为 DataStore 启用了 ACL，则无法通过调用 DocumentService.GetDocument 或 DocumentService.ListDocuments 来访问 Document。

目前，ACL 仅在 GENERIC 垂直行业受支持，且内容配置需要为非 PUBLIC_WEBSITE。
workspaceConfig

object (WorkspaceConfig)

用于存储工作区数据的数据存储区类型配置的配置。当 DataStore.content_config 设置为 DataStore.ContentConfig.GOOGLE_WORKSPACE 时，必须设置此字段。
documentProcessingConfig

object (DocumentProcessingConfig)

文档理解和丰富化功能的配置。
startingSchema

object (Schema)

在预配相应 DataStore 时要使用的初始模式。如果未设置，系统将使用相应垂直领域默认的专用模式。

此字段仅供 dataStores.create API 使用，在其他 API 中使用时将被忽略。在所有 API 响应中（包括 dataStores.create API 的响应），此字段都将被省略。如要检索 DataStore 的模式，请改用 SchemaService.GetSchema API。

系统会根据有关模式的某些规则验证所提供的模式。如需了解详情，请参阅此文档。
healthcareFhirConfig

object (HealthcareFhirConfig)

可选。HEALTHCARE_FHIR 垂直领域的配置。
servingConfigDataStore

object (ServingConfigDataStore)

可选。在数据存储区级存储服务配置。
identityMappingStore

string

不可变。所关联 IdentityMappingStore 的完全限定资源名称。此字段只能针对具有 THIRD_PARTY 或 GSUITE IdP 的 aclEnabled 数据存储区进行设置。格式：projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}。
isInfobotFaqDataStore

boolean

可选。如果设置，则此数据存储区是一个 Infobot FAQ 数据存储区。
configurableBillingApproach

enum (ConfigurableBillingApproach)

可选。可配置结算方式的配置。请参阅

方法

completeQuery

 使用“建议的关键字”功能补全指定用户输入。

create

 创建 DataStore。

delete

 删除一个 DataStore。

get

 获取 DataStore。

getSiteSearchEngine

 获取 SiteSearchEngine。

list

 列出与项目关联的所有 DataStore。

patch

 更新一个 DataStore