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)
  },
  "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

不可變動。ID。資料儲存庫的完整資源名稱。格式：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 標準化，並使用 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

僅限輸入。建立這個 DataStore 時，用來保護資料的 KMS 金鑰。

如果要求必須遵守 CMEK 機構政策保護措施，則必須設定這項參數。

如果這個欄位已設定並順利處理，DataStore 就會受到 KMS 金鑰保護，如 cmekConfig 欄位所示。
cmekConfig

object (CmekConfig)

僅供輸出。DataStore 的 CMEK 相關資訊。
billingEstimation

object (BillingEstimation)

僅供輸出。預估帳單的資料量。
aclEnabled

boolean

不可變動。DataStore 中的資料是否含有 ACL 資訊。如果設為 true，來源資料必須有存取控制清單。當資料由 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 的完整資源名稱。這個欄位只能為 aclEnabled DataStore 設定 THIRD_PARTY 或 GSUITE IdP。格式：projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}。
isInfobotFaqDataStore

boolean

(選用步驟) 如果設定，這個 DataStore 就是 Infobot 常見問題 DataStore。
configurableBillingApproach

enum (ConfigurableBillingApproach)

(選用步驟) 可設定的帳單方式設定。請參閱

方法

completeQuery

 以建議的關鍵字完成指定的使用者輸入內容。

create

 建立 DataStore。

delete

 刪除 DataStore。

get

 取得 DataStore。

getSiteSearchEngine

 取得 SiteSearchEngine。

list

 列出與專案相關聯的所有 DataStore。

patch

 更新 DataStore