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

여러 Document를 일괄 가져옵니다. 요청 처리는 동기식일 수 있습니다. 존재하지 않는 항목이 생성됩니다.

참고: Document의 하위 집합이 성공적으로 업데이트될 수 있습니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
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로 설정하면 여러 가져오기에서 ID가 일관되지 않을 수 있는 페이로드의 해시에 따라 Document.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 문서를 참조하세요.