REST Resource: projects.locations.collections.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,
  "federatedSearchConfig": {
    object (FederatedSearchConfig)
  },
  "configurableBillingApproach": enum (ConfigurableBillingApproach),
  "configurableBillingApproachUpdateTime": string,
  "dataProtectionPolicy": {
    object (DataProtectionPolicy)
  },
  "iconUri": string
}
欄位
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)

選用。進階站內搜尋的設定。
languageInfo

object (LanguageInfo)

DataStore 的語言資訊。
naturalLanguageQueryUnderstandingConfig

object (NaturalLanguageQueryUnderstandingConfig)

選用。自然語言查詢理解設定。
kmsKeyName

string

僅供輸入。建立這個資料儲存庫時，用來保護資料儲存庫的 KMS 金鑰。

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

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

object (CmekConfig)

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

object (IdpConfig)

僅供輸出。資料儲存庫層級的識別資訊提供者設定。
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

選用。如果設定，這個資料儲存庫就是 Infobot 常見問題資料儲存庫。
federatedSearchConfig

object (FederatedSearchConfig)

選用。如果已設定，這個 DataStore 就是聯邦搜尋 DataStore。
configurableBillingApproach

enum (ConfigurableBillingApproach)

選用。可設定帳單方式的設定。請參閱
configurableBillingApproachUpdateTime

string (Timestamp format)

僅供輸出。上次更新可設定的計費方式的時間戳記。

使用 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"。
dataProtectionPolicy

object (DataProtectionPolicy)

選用。指定資料儲存庫的資料保護政策。
iconUri

string

僅供輸出。如果這是以連接器為基礎的資料儲存庫，則提供資料儲存庫連接器來源的圖示 URI。如果資料儲存庫沒有相關聯的連接器來源，則為空白。

在 DataStoreService.ListDataStores 和 DataStoreService.GetDataStore 中，只有透過 ListDataStoresRequest.view 或 GetDataStoreRequest.view 要求 DataStoreView.DATA_STORE_VIEW_FULL 時，才會填入這個欄位。

AdvancedSiteSearchConfig

進階站內搜尋的設定資料。

JSON 表示法 
{
  "disableInitialIndex": boolean,
  "disableAutomaticRefresh": boolean
}
欄位
disableInitialIndex

boolean

如果設為 true，系統會停用 DataStore 的初始索引。
disableAutomaticRefresh

boolean

如果設為 true，系統會停用 DataStore 的自動重新整理功能。

LanguageInfo

DataStore 的語言資訊。

JSON 表示法 
{
  "languageCode": string,
  "normalizedLanguageCode": string,
  "language": string,
  "region": string
}
欄位
languageCode

string

DataStore 的語言代碼。
normalizedLanguageCode

string

僅供輸出。這是 languageCode 的正規化形式。例如：en-GB、en_GB、en-UK 或 en-gb 的 languageCode 會具有 en-GB 的 normalizedLanguageCode。
language

string

僅供輸出。normalizedLanguageCode 的語言部分。E.g.: en-US -> en、zh-Hans-HK -> zh、en -> en。
region

string

僅供輸出。標準化 LanguageCode 的區域部分 (如有)。E.g.: en-US -> US、zh-Hans-HK -> HK、en -> ``。

NaturalLanguageQueryUnderstandingConfig

自然語言查詢理解設定。

JSON 表示法 
{
  "mode": enum (Mode)
}
欄位
mode

enum (Mode)

自然語言查詢理解模式。如果未設定這個欄位，預設行為會是 NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED。

模式

自然語言查詢理解模式。如果 NaturalLanguageQueryUnderstandingConfig.Mode 為 ENABLED，且 SearchRequest 中的 NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition 為 ENABLED，系統就會為搜尋要求啟用自然語言理解功能。

列舉
MODE_UNSPECIFIED 預設值。
DISABLED 自然語言查詢理解功能已停用。
ENABLED 已啟用自然語言查詢理解功能。

BillingEstimation

預估每個資料儲存空間的資料大小。

JSON 表示法 
{
  "structuredDataSize": string,
  "unstructuredDataSize": string,
  "websiteDataSize": string,
  "structuredDataUpdateTime": string,
  "unstructuredDataUpdateTime": string,
  "websiteDataUpdateTime": string
}
欄位
structuredDataSize

string (int64 format)

結構化資料的大小 (以位元組為單位)。
unstructuredDataSize

string (int64 format)

非結構化資料的大小 (以位元組為單位)。
websiteDataSize

string (int64 format)

網站的資料大小 (以位元組為單位)。
structuredDataUpdateTime

string (Timestamp format)

結構化資料的上次更新時間戳記。

使用 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"。
unstructuredDataUpdateTime

string (Timestamp format)

非結構化資料的上次更新時間戳記。

使用 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"。
websiteDataUpdateTime

string (Timestamp format)

網站的上次更新時間戳記。

使用 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"。

WorkspaceConfig

設定，用於儲存工作區資料的資料儲存庫類型設定

JSON 表示法 
{
  "type": enum (Type),
  "dasherCustomerId": string,
  "superAdminServiceAccount": string,
  "superAdminEmailAddress": string
}
欄位
type

enum (Type)

Google Workspace 資料來源。
dasherCustomerId

string

僅供輸出。經過模糊處理的 Dasher 客戶 ID。伺服器會在建立資料儲存庫時，從專案的 GCP 機構衍生這個值；系統會忽略要求酬載中提供的任何值。
superAdminServiceAccount

string

選用。用於產生存取權權杖的工作區超級管理員服務帳戶。目前我們只會將其用於原生 Google 雲端硬碟連接器資料擷取。
superAdminEmailAddress

string

選用。用於產生存取權杖的工作區超級管理員電子郵件地址。目前我們只會將其用於原生 Google 雲端硬碟連接器資料擷取。

DocumentProcessingConfig

DataStore 的單例資源。如果建立 DataStore 時為空白，且 DataStore 設為 DataStore.ContentConfig.CONTENT_REQUIRED，預設剖析器會預設為數位剖析器。

JSON 表示法 
{
  "name": string,
  "chunkingConfig": {
    object (ChunkingConfig)
  },
  "defaultParsingConfig": {
    object (ParsingConfig)
  },
  "parsingConfigOverrides": {
    string: {
      object (ParsingConfig)
    },
    ...
  }
}
欄位
name

string

文件處理設定的完整資源名稱。格式：projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig。
chunkingConfig

object (ChunkingConfig)

是否啟用分塊模式。
defaultParsingConfig

object (ParsingConfig)

預設文件剖析器的設定。如未指定，系統會將其設為預設的 DigitalParsingConfig，並將預設的剖析設定套用至文件剖析的所有檔案類型。
parsingConfigOverrides

map (key: string, value: object (ParsingConfig))

從檔案類型對應，根據檔案類型覆寫預設的剖析設定。支援的索引鍵：

  • pdf：覆寫 PDF 檔案的剖析設定，支援數位剖析、OCR 剖析或版面配置剖析。
  • html：覆寫 HTML 檔案的剖析設定，僅支援數位剖析和版面配置剖析。
  • docx：覆寫 DOCX 檔案的剖析設定，僅支援數位剖析和版面配置剖析。
  • pptx：覆寫 PPTX 檔案的剖析設定，僅支援數位剖析和版面配置剖析。
  • xlsm：覆寫 XLSM 檔案的剖析設定，僅支援數位剖析和版面配置剖析。
  • xlsx：覆寫 XLSX 檔案的剖析設定，僅支援數位剖析和版面配置剖析。

ChunkingConfig

區塊設定的設定。

JSON 表示法 
{

  // Union field chunk_mode can be only one of the following:
  "layoutBasedChunkingConfig": {
    object (LayoutBasedChunkingConfig)
  }
  // End of list of possible types for union field chunk_mode.
}
欄位
聯集欄位 chunk_mode。定義分塊行為的其他設定。chunk_mode 只能是下列其中一個設定：
layoutBasedChunkingConfig

object (LayoutBasedChunkingConfig)

根據版面配置分塊的設定。

LayoutBasedChunkingConfig

根據版面配置分塊的設定。

JSON 表示法 
{
  "chunkSize": integer,
  "includeAncestorHeadings": boolean
}
欄位
chunkSize

integer

每個區塊的權杖大小上限。

支援的值：100 到 500 (含)。預設值為 500。
includeAncestorHeadings

boolean

是否要在文件中間的分塊中附加不同層級的標題，以免遺失脈絡。

預設值為 False。

ParsingConfig

套用至特定類型文件剖析器的相關設定。

JSON 表示法 
{

  // Union field type_dedicated_config can be only one of the following:
  "digitalParsingConfig": {
    object (DigitalParsingConfig)
  },
  "ocrParsingConfig": {
    object (OcrParsingConfig)
  },
  "layoutParsingConfig": {
    object (LayoutParsingConfig)
  }
  // End of list of possible types for union field type_dedicated_config.
}
欄位
聯集欄位 type_dedicated_config。文件處理類型設定。type_dedicated_config 只能是下列其中一個設定：
digitalParsingConfig

object (DigitalParsingConfig)

套用至數位剖析器的設定。
ocrParsingConfig

object (OcrParsingConfig)

已套用至 OCR 剖析器的設定。目前僅適用於 PDF 檔案。
layoutParsingConfig

object (LayoutParsingConfig)

套用至版面配置剖析器的設定。

DigitalParsingConfig

這個類型沒有任何欄位。

文件的數位剖析設定。

OcrParsingConfig

文件的 OCR 剖析設定。

JSON 表示法 
{
  "enhancedDocumentElements": [
    string
  ],
  "useNativeText": boolean
}
欄位
enhancedDocumentElements[]
(deprecated)

string

[已淘汰] 這個欄位已淘汰，如要使用額外的強化文件元素處理功能，請切換至 layoutParsingConfig。
useNativeText

boolean

如果設為 true，系統會使用原生文字，而不是含有原生文字的網頁上的 OCR 文字。

LayoutParsingConfig

文件的版面配置剖析設定。

JSON 表示法 
{
  "enableTableAnnotation": boolean,
  "enableImageAnnotation": boolean,
  "enableLlmLayoutParsing": boolean,
  "structuredContentTypes": [
    string
  ],
  "excludeHtmlElements": [
    string
  ],
  "excludeHtmlClasses": [
    string
  ],
  "excludeHtmlIds": [
    string
  ],
  "enableGetProcessedDocument": boolean
}
欄位
enableTableAnnotation

boolean

選用。如果設為 true，系統會在剖析期間，將 LLM 註解加到表格。
enableImageAnnotation

boolean

選用。如果設為 true，系統會在剖析期間，將 LLM 註解加到圖片。
enableLlmLayoutParsing

boolean

選用。如為 true，系統會使用 LLM 調整 PDF 版面配置。
structuredContentTypes[]

string

選用。包含要從文件中擷取的必要結構類型。支援的值：

  • shareholder-structure
excludeHtmlElements[]

string

選用。要從剖析內容中排除的 HTML 元素清單。
excludeHtmlClasses[]

string

選用。要從剖析內容中排除的 HTML 類別清單。
excludeHtmlIds[]

string

選用。要從剖析內容中排除的 HTML ID 清單。
enableGetProcessedDocument

boolean

選用。如為 true，處理過的文件會提供給 GetProcessedDocument API。

ServingConfigDataStore

儲存服務設定相關資訊 (位於 DataStore 層級)。

JSON 表示法 
{
  "disabledForServing": boolean
}
欄位
disabledForServing

boolean

選用。如果設為 true，DataStore 就無法處理搜尋要求。

FederatedSearchConfig

儲存用於聯合搜尋的資訊。

JSON 表示法 
{

  // Union field data_source_config can be only one of the following:
  "alloyDbConfig": {
    object (AlloyDbConfig)
  },
  "thirdPartyOauthConfig": {
    object (ThirdPartyOauthConfig)
  },
  "notebooklmConfig": {
    object (NotebooklmConfig)
  }
  // End of list of possible types for union field data_source_config.
}
欄位
聯集欄位 data_source_config。這個資料儲存庫連結的資料來源設定。data_source_config 只能是下列其中一個設定：
alloyDbConfig

object (AlloyDbConfig)

AlloyDB 設定。如果已設定，這個資料儲存庫會連線至 AlloyDB。
thirdPartyOauthConfig

object (ThirdPartyOauthConfig)

第三方 OAuth 設定。如果已設定，這個資料儲存庫會連結至第三方應用程式。
notebooklmConfig

object (NotebooklmConfig)

NotebookLM 設定。如果已設定，這個資料儲存區會連結至 NotebookLM Enterprise。

AlloyDbConfig

儲存連線至 AlloyDB 的相關資訊。

JSON 表示法 
{
  "alloydbConnectionConfig": {
    object (AlloyDbConnectionConfig)
  },
  "alloydbAiNlConfig": {
    object (AlloyDbAiNaturalLanguageConfig)
  },
  "returnedFields": [
    string
  ]
}
欄位
alloydbConnectionConfig

object (AlloyDbConnectionConfig)

這是必要旗標，連線至 AlloyDB 的設定。
alloydbAiNlConfig

object (AlloyDbAiNaturalLanguageConfig)

選用。Magic 的設定。
returnedFields[]

string

選用。搜尋結果中要傳回的欄位。如果留空，會傳回所有欄位。

AlloyDbConnectionConfig

連線至 AlloyDB 的設定。

JSON 表示法 
{
  "instance": string,
  "database": string,
  "user": string,
  "password": string,
  "authMode": enum (AuthMode),
  "enablePsvs": boolean
}
欄位
instance

string

這是必要旗標，要連線的 AlloyDB 執行個體。
database

string

這是必要旗標，要連線的 AlloyDB 資料庫。
user

string

這是必要旗標，資料庫使用者。

如果 authMode = END_USER_ACCOUNT，則可以取消設定。在這種情況下，AlloyDB 會根據已驗證的使用者推斷使用者。
password

string

這是必要旗標，資料庫密碼。

如果 authMode = END_USER_ACCOUNT，則可以取消設定。在這種情況下，AlloyDB 端會根據已驗證的使用者推斷密碼。
authMode

enum (AuthMode)

選用。驗證模式。
enablePsvs

boolean

選用。如為 true，則啟用 AlloyDB 的 PSVS。

AuthMode

驗證模式。

列舉
AUTH_MODE_UNSPECIFIED
AUTH_MODE_SERVICE_ACCOUNT VAIS 與 AlloyDB 通訊時會使用 P4SA。
AUTH_MODE_END_USER_ACCOUNT VAIS 與 AlloyDB 通訊時會使用 EUC。

AlloyDbAiNaturalLanguageConfig

AlloyDB AI Natural Language 的設定。

JSON 表示法 
{
  "nlConfigId": string
}
欄位
nlConfigId

string

選用。AlloyDb AI NL 設定 ID，也就是用於呼叫 SELECT alloydb_ai_nl.g_create_configuration(...) 的值。可為空白。

ThirdPartyOauthConfig

儲存第三方應用程式 OAuth 的資訊。

JSON 表示法 
{
  "appName": string,
  "instanceName": string
}
欄位
appName

string

選用。應用程式類型。例如：「jira」、「box」等。
instanceName

string

選用。識別第三方應用程式的執行個體名稱，例如「vaissptbots-my」。這與 instanceUri 不同，instanceUri 是第三方應用程式的完整網址，例如「https://vaissptbots-my.sharepoint.com」。

NotebooklmConfig

用於連結至 NotebookLM Enterprise 的設定。

JSON 表示法 
{
  "searchConfig": string
}
欄位
searchConfig

string

這是必要旗標，搜尋設定名稱。

格式：projects/*/locations/global/notebookLmSearchConfigs/*

ConfigurableBillingApproach

可設定的帳單方式設定。

列舉
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED 預設值。適用於 Spark 和非 Spark 無法設定的計費方式。
CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE 針對非嵌入式儲存空間的索引核心，使用訂閱方案基本費用 + 超額費用計費。
CONFIGURABLE_CONSUMPTION_EMBEDDING 使用即付即用計費方式，為嵌入式儲存空間外掛程式支付費用。

方法

addPatientFilter

 將一組病患 ID 新增為資料儲存庫的病患篩選器。

completeQuery

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

create

 建立 DataStore。

delete

 刪除 DataStore。

deletePatientFilter

 刪除資料儲存庫的整個病患篩選器。

get

 取得 DataStore。

getCompletionConfig

 取得 CompletionConfig

getDocumentProcessingConfig

 取得 DocumentProcessingConfig。

getSiteSearchEngine

 取得 SiteSearchEngine。

list

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

patch

 更新 DataStore

removePatientFilter

 從資料儲存庫的病患篩選器中移除一組病患 ID。

replacePatientFilter

 取代資料儲存庫的病患篩選器。

trainCustomModel

 訓練自訂模型。

updateCompletionConfig

 更新 CompletionConfig。

updateDocumentProcessingConfig

 更新 DocumentProcessingConfig。