Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

Method: projects.locations.dataStores.importDocuments

長時間実行オペレーションを開始して、ドキュメントを DataStore にインポートします。

すでに正常にインポートされたファイルは、Cloud Storage オブジェクトが上書きされた場合や、SOURCE_FORMAT_DOCUMENT_JSON のメタデータが変更された場合を除き、スキップされます。以前のインポートで失敗したファイルは再度処理されます。インポートできない個々のファイルは、インポート全体を失敗させるのではなく、エラーレポート（ImportOutputConfig.error_gcs_prefix を参照）に報告されます。

dataStores.importDocuments、dataStores.purgeDocuments、dataStores.patch は、DataStore ごとに 1 つずつ実行されます。1 つのオペレーションが実行されている間、もう 1 つのオペレーションは待機できます。それ以上のリクエストは、実行中のオペレーションが完了するまで ABORTED で失敗します。多数のファイルをインポートするには、並列リクエストを送信するのではなく、1 つのリクエストの inputUris にすべてのファイルをリストします。

HTTP リクエスト

POST https://vectorsearch.googleapis.com/v1beta/{name}:importDocuments

パスパラメータ

パラメータ

パラメータ
`name`	`string` 必須。ドキュメントのインポート先となる DataStore のリソース名。形式: `projects/{project}/locations/{location}/dataStores/{dataStore}`。

name

string

必須。ドキュメントのインポート先となる DataStore のリソース名。形式: projects/{project}/locations/{location}/dataStores/{dataStore}。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現

JSON 表現
{ "importOutputConfig": { object (`ImportOutputConfig`) }, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "gcsSource": { object (`GcsSource`) } // End of mutually exclusive fields. }

{
  "importOutputConfig": {
    object (ImportOutputConfig)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsSource": {
    object (GcsSource)
  }
  // End of mutually exclusive fields.
}

フィールド
`importOutputConfig`	`object (ImportOutputConfig)` 省略可。インポートドキュメント出力の宛先の構成: インポートのエラーレポートを書き込む場所。
必須。入力のソース。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
`gcsSource`	`object (GcsSource)` Cloud Storage 上で、入力コンテンツの配置先とする場所。デフォルトの `sourceFormat` を使用すると、URI は `gs://my-bucket/folder/*` などのパターンになります。これは `folder` 内のオブジェクトと直接一致しますが、サブフォルダ内のオブジェクトとは一致しません。1 回のインポートに含めることができるファイルは、`UNSTRUCTURED` DataStore の場合は最大 100,000 個、`VIDEO` DataStore の場合は最大 100 個です。
相互に排他的なフィールドの終了。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/vectorsearch

詳細については、Authentication Overview をご覧ください。

ImportOutputConfig

インポートドキュメント関連の出力の宛先の構成。

JSON 表現
{ "errorGcsPrefix": string }

フィールド

フィールド
`errorGcsPrefix`	`string` 省略可。インポート中に発生したエラーを書き込む Cloud Storage のロケーションの URI 接頭辞。接頭辞にオブジェクトを含めることはできません。エラーは、この接頭辞の下のシャーディングされたファイルに 1 行に 1 つずつ、JSON エンコードされた `google.rpc.Status` メッセージとして書き込まれます。このフィールドが空の場合、エラーレポートは書き込まれません。

errorGcsPrefix