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

変更不可。ID。データストアの完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}。

このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
displayName

string

必須。データストアの表示名。

このフィールドは、長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、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

入力専用。作成時にこの DataStore の保護に使用される KMS 鍵。

CMEK 組織のポリシーの保護に準拠する必要があるリクエストに設定する必要があります。

このフィールドが設定され、正常に処理されると、cmekConfig フィールドで示されているように、DataStore は KMS 鍵で保護されます。
cmekConfig

object (CmekConfig)

出力専用。DataStore の CMEK 関連情報。
idpConfig

object (IdpConfig)

出力専用。データストア レベルの ID プロバイダ構成。
billingEstimation

object (BillingEstimation)

出力専用。お支払いのためのデータサイズの見積もり。
aclEnabled

boolean

変更不可。DataStore のデータに ACL 情報があるかどうか。true に設定した場合、ソースデータに ACL が必要です。ACL は、DocumentService.ImportDocuments メソッドでデータが取り込まれるときに取り込まれます。

DataStore で ACL が有効になっている場合、DocumentService.GetDocument または DocumentService.ListDocuments を呼び出しても Document にアクセスできません。

現在、ACL は PUBLIC_WEBSITE 以外のコンテンツ構成の GENERIC 業界のみでサポートされています。
workspaceConfig

object (WorkspaceConfig)

ワークスペース データのデータストア タイプ構成を保存する構成。DataStore.content_config が DataStore.ContentConfig.GOOGLE_WORKSPACE に設定されている場合は、この値を設定する必要があります。
documentProcessingConfig

object (DocumentProcessingConfig)

ドキュメントの理解と拡充の構成。
startingSchema

object (Schema)

この DataStore のプロビジョニング時に使用する開始スキーマ。設定されていない場合、デフォルトの業種別スキーマが使用されます。

このフィールドは dataStores.create API でのみ使用され、他の API で使用された場合は無視されます。このフィールドは、dataStores.create API を含むすべての 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 を更新します。