Method: projects.locations.dataStores.branches.documents.import

複数の Document の一括インポート。リクエスト処理は同期される場合があります。存在しないアイテムが作成されます。

注: Document のサブセットが正常に更新される場合があります。

HTTP リクエスト

POST https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents:import

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。親ブランチのリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch} など）。作成/更新権限が必要です。

リクエストの本文

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

JSON 表現 
{
  "errorConfig": {
    object (ImportErrorConfig)
  },
  "reconciliationMode": enum (ReconciliationMode),
  "updateMask": string,
  "autoGenerateIds": boolean,
  "idField": string,
  "forceRefreshContent": boolean,

  // Union field source can be only one of the following:
  "inlineSource": {
    object (InlineSource)
  },
  "gcsSource": {
    object (GcsSource)
  },
  "bigquerySource": {
    object (BigQuerySource)
  },
  "fhirStoreSource": {
    object (FhirStoreSource)
  },
  "spannerSource": {
    object (SpannerSource)
  },
  "cloudSqlSource": {
    object (CloudSqlSource)
  },
  "firestoreSource": {
    object (FirestoreSource)
  },
  "alloyDbSource": {
    object (AlloyDbSource)
  },
  "bigtableSource": {
    object (BigtableSource)
  }
  // End of list of possible types for union field source.
}
フィールド
errorConfig

object (ImportErrorConfig)

インポート中に発生したエラーを記録する目的の場所。
reconciliationMode

enum (ReconciliationMode)

既存のドキュメントとインポートするドキュメント間の調整モード。デフォルトは ReconciliationMode.INCREMENTAL です。
updateMask

string (FieldMask format)

指定されたインポート済みドキュメントで更新するフィールドを示します。設定しない場合、デフォルトではすべてのフィールドが更新されます。

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。
autoGenerateIds

boolean

ドキュメントに ID がない場合に自動的に生成するかどうか。

true に設定すると、ペイロードのハッシュに基づいて Document.id が自動的に生成されます。複数のインポートで ID の整合性が維持されない場合があります。この場合、コンテンツの重複を避けるために ReconciliationMode.FULL を強くおすすめします。未設定の場合、または false に設定されている場合、idField を使用して Document.id を指定する必要があります。指定しないと、ID のないドキュメントをインポートできません。

サポートされているデータソース:
idField

string

このフィールドは、ドキュメントの一意の ID として使用される ID フィールドまたは列を示します。

GcsSource の場合は、JSON フィールドのキーです。たとえば、JSON {"my_id": "some_uuid"} の場合は my_id です。それ以外の場合は、一意の ID が保存されているテーブルの列名になります。

JSON フィールドまたはテーブル列の値は Document.id として使用されます。JSON フィールドまたはテーブル列は文字列型である必要があります。値は、1 ～ 63 文字の RFC-1034 に準拠した有効な文字列として設定する必要があります。そうしないと、有効な ID のないドキュメントはインポートされません。

このフィールドは、autoGenerateIds が未設定であるか、false に設定されている場合にのみ設定します。それ以外の場合は、INVALID_ARGUMENT エラーがスローされます。

設定されていない場合、許可されたデータソースからインポートするときにデフォルト値 Id が使用されます。

サポートされているデータソース:
forceRefreshContent

boolean

省略可。ドキュメントの非構造化コンテンツを強制的に更新するかどうか。

true に設定すると、参照コンテンツの更新ステータスに関係なく、ドキュメントのコンテンツ部分が更新されます。
共用体フィールド source。必須。入力のソース。source は次のいずれかになります。
inlineSource

object (InlineSource)

ドキュメントの入力コンテンツのインライン ソース。
gcsSource

object (GcsSource)

入力コンテンツの Cloud Storage のロケーション。
bigquerySource

object (BigQuerySource)

BigQuery 入力ソース。
fhirStoreSource

object (FhirStoreSource)

FhirStore 入力ソース。
spannerSource

object (SpannerSource)

Spanner 入力ソース。
cloudSqlSource

object (CloudSqlSource)

Cloud SQL 入力ソース。
firestoreSource

object (FirestoreSource)

Firestore 入力ソース。
alloyDbSource

object (AlloyDbSource)

AlloyDB 入力ソース。
bigtableSource

object (BigtableSource)

Cloud Bigtable 入力ソース。

レスポンスの本文

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

認可スコープ

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

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

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • discoveryengine.documents.import

詳細については、IAM のドキュメントをご覧ください。