REST Resource: projects.locations.dataStores

资源：DataStore

DataStore 在 DataStore 级别捕获全局设置和配置。

JSON 表示法 
{
  "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)
  },
  "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)

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

object (LanguageInfo)

DataStore 的语言信息。
naturalLanguageQueryUnderstandingConfig

object (NaturalLanguageQueryUnderstandingConfig)

可选。自然语言查询理解的配置。
kmsKeyName

string

仅限输入。创建时用于保护此 DataStore 的 KMS 密钥。

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

如果此字段已设置并成功处理，则 DataStore 将受 cmekConfig 字段中指示的 KMS 密钥保护。
cmekConfig

object (CmekConfig)

仅限输出。DataStore 的 CMEK 相关信息。
idpConfig

object (IdpConfig)

仅限输出。数据存储区级身份提供方配置。
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)

可选。在 DataStore 级层存储投放配置。
identityMappingStore

string

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

boolean

可选。如果设置，则此 DataStore 为 Infobot FAQ DataStore。
configurableBillingApproach

enum (ConfigurableBillingApproach)

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

方法

completeQuery

 使用关键字建议补全指定的用户输入内容。

create

 创建 DataStore。

delete

 删除 DataStore。

get

 获取 DataStore。

getCompletionConfig

 获取 CompletionConfig

getDocumentProcessingConfig

 获取 DocumentProcessingConfig。

getSiteSearchEngine

 获取 SiteSearchEngine。

list

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

patch

 更新 DataStore

updateCompletionConfig

 更新 CompletionConfig。

updateDocumentProcessingConfig

 更新 DocumentProcessingConfig。