REST Resource: projects.locations.dataStores.documents

리소스: Document

문서는 데이터 스토어로 처리되는 단일 콘텐츠 단위입니다. DataStore의 하위 리소스입니다. 수집 중에 문서가 파싱되고 하나 이상의 세그먼트로 청크됩니다.

JSON 표현
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "content": {
    object (Content)
  },
  "etag": string,
  "metadata": {
    object (DocumentMetadata)
  }
}
필드
name

string

식별자. 문서의 정규화된 리소스 이름입니다.

형식: projects/{project}/locations/{location}/dataStores/{dataStoreId}/documents/{documentId} documentId는 1~63자(영문 기준)여야 하며 RFC1035를 준수해야 합니다.

ImportDocuments가 파일을 직접 가져오는 경우 (기본 소스 형식) 서비스는 파일의 Cloud Storage URI에서 documentId를 가져옵니다. 동일한 URI를 다시 가져오면 동일한 문서가 업데이트되고 이름이 변경되거나 이동된 파일은 새 문서가 됩니다. SOURCE_FORMAT_DOCUMENT_JSON를 사용하면 입력 파일에 제공된 name에서 documentId를 가져옵니다.

createTime

string (Timestamp format)

출력 전용입니다. 문서가 생성된 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.

updateTime

string (Timestamp format)

출력 전용입니다. 문서가 마지막으로 업데이트된 시각의 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.

content

object (Content)

(선택사항) 이 문서에 연결된 비정형 데이터: 가져온 Cloud Storage 파일입니다. SOURCE_FORMAT_DOCUMENT_JSON 입력 파일의 각 줄에 필요합니다.

etag

string

(선택사항) 문서의 ETag입니다.

metadata

object (DocumentMetadata)

(선택사항) 이 문서의 사용자 정의 메타데이터입니다. 메타데이터 값은 상위 DataStore에 정의된 documentMetadataSchema를 준수해야 합니다.

콘텐츠

이 문서에 연결된 비정형 데이터입니다.

JSON 표현
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsUri": string
  // End of mutually exclusive fields.
}
필드
비정형 문서의 콘텐츠입니다. 다음은 상호 배타적인 필드 목록입니다. 응답에서 최대 하나의 필드가 설정됩니다.
gcsUri

string

콘텐츠의 Cloud Storage URI입니다. Cloud Storage URI(예: gs://bucket-name/path/to/file)만 지원됩니다.

상호 배타적인 필드의 끝입니다.

DocumentMetadata

문서와 연결된 사용자 정의 메타데이터입니다.

JSON 표현
{
  "value": {
    object
  }
}
필드
value

object (Struct format)

(선택사항) 메타데이터 값(JSON 객체)입니다. 값은 상위 DataStore에 정의된 documentMetadataSchema를 준수해야 합니다.

메서드

get

문서를 가져옵니다.

list

DataStore의 문서를 나열합니다.
단일 DataStore의 문서를 검색합니다.