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)
  },
  "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 関連情報。
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)

省略可。構成可能な課金アプローチの構成。見る

ContentConfig

データストアのコンテンツ構成。

列挙型
CONTENT_CONFIG_UNSPECIFIED デフォルト値。
NO_CONTENT Document.content のないドキュメントのみが含まれます。
CONTENT_REQUIRED Document.content を含むドキュメントのみが含まれます。
PUBLIC_WEBSITE データストアは、一般公開ウェブサイトの検索に使用されます。
GOOGLE_WORKSPACE データストアはワークスペース検索に使用されます。ワークスペース データストアの詳細は、WorkspaceConfig で指定します。

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 は、normalizedLanguageCode が en-GB になります。
language

string

出力専用。normalizedLanguageCode の言語部分。文例: en-US -> en、zh-Hans-HK -> zh、en -> en。
region

string

出力専用。正規化された言語コードのリージョン部分（存在する場合）。文例: 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。
superAdminServiceAccount

string

省略可。アクセス トークンの生成に使用されるワークスペースの特権管理者サービス アカウント。現時点では、ネイティブの Google ドライブ コネクタのデータ取り込みにのみ使用されます。
superAdminEmailAddress

string

省略可。アクセス トークンの生成に使用されるワークスペースの特権管理者メールアドレス。現時点では、ネイティブの Google ドライブ コネクタのデータ取り込みにのみ使用されます。

タイプ

この DataStore でサポートされている Workspace アプリのタイプを指定します

列挙型
TYPE_UNSPECIFIED デフォルトは、指定されていない Workspace タイプです。
GOOGLE_DRIVE Workspace データストアにドライブのデータが含まれている
GOOGLE_MAIL Workspace データストアにメールデータが含まれている
GOOGLE_SITES Workspace データストアに Google サイトのデータが含まれている
GOOGLE_CALENDAR Workspace データストアにカレンダー データが含まれている
GOOGLE_CHAT Workspace データストアに Chat データが含まれている
GOOGLE_GROUPS Workspace データストアにグループのデータが含まれている
GOOGLE_KEEP Workspace データストアに Keep データが含まれている
GOOGLE_PEOPLE Workspace データストアにユーザーデータが含まれている

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.
}
Fields
共用体フィールド 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.
}
Fields
共用体フィールド 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,
  "structuredContentTypes": [
    string
  ],
  "excludeHtmlElements": [
    string
  ],
  "excludeHtmlClasses": [
    string
  ],
  "excludeHtmlIds": [
    string
  ],
  "enableGetProcessedDocument": boolean
}
フィールド
enableTableAnnotation

boolean

省略可。true の場合、解析中に LLM ベースのアノテーションが表に追加されます。
enableImageAnnotation

boolean

省略可。true の場合、解析中に LLM ベースのアノテーションが画像に追加されます。
structuredContentTypes[]

string

省略可。ドキュメントから抽出する必要な構造タイプが含まれています。サポートされる値:

  • shareholder-structure
excludeHtmlElements[]

string

省略可。解析されたコンテンツから除外する HTML 要素のリスト。
excludeHtmlClasses[]

string

省略可。解析されたコンテンツから除外する HTML クラスのリスト。
excludeHtmlIds[]

string

省略可。解析されたコンテンツから除外する HTML ID のリスト。
enableGetProcessedDocument

boolean

省略可。true の場合、処理されたドキュメントは GetProcessedDocument API で使用できるようになります。

HealthcareFhirConfig

HEALTHCARE_FHIR 業種のデータストアの構成。

JSON 表現 
{
  "enableConfigurableSchema": boolean,
  "enableStaticIndexingForBatchIngestion": boolean
}
フィールド
enableConfigurableSchema

boolean

HEALTHCARE_FHIR 業種で構成可能なスキーマを有効にするかどうか。

true に設定すると、事前定義された医療用 FHIR スキーマを拡張して、よりカスタマイズされた検索とフィルタリングを行うことができます。
enableStaticIndexingForBatchIngestion

boolean

HEALTHCARE_FHIR バッチ取り込みで静的インデックス登録を有効にするかどうか。

true に設定すると、バッチ取り込みは静的インデックス モードで処理されます。このモードは処理速度は遅いものの、大量のデータを処理できます。

ServingConfigDataStore

DataStore レベルでサービング構成に関する情報を保存します。

JSON 表現 
{
  "disabledForServing": boolean
}
フィールド
disabledForServing

boolean

省略可。true に設定すると、DataStore は検索リクエストの処理に使用できなくなります。

ConfigurableBillingApproach

構成可能な課金アプローチの構成。

列挙型
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED デフォルト値。Spark と非 Spark の構成不可の課金アプローチの場合。
CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE エンベディング以外のストレージのインデックス コアには、サブスクリプションの基本料金 + 超過料金の請求を使用します。
CONFIGURABLE_CONSUMPTION_EMBEDDING ストレージ アドオンの埋め込みには、従量課金制の課金を使用します。

メソッド

completeQuery

 指定されたユーザー入力をキーワード候補で補完します。

create

 DataStore を作成します。

delete

 DataStore を削除します。

get

 DataStore を取得します。

getSiteSearchEngine

 SiteSearchEngine を取得します。

list

 プロジェクトに関連付けられているすべての DataStore を一覧表示します。

patch

 DataStore を更新します

trainCustomModel

 カスタムモデルをトレーニングします。