REST Resource: projects.locations.collections.dataStores.branches.documents.chunks

리소스: 청크

청크는 청크 모드에서 추천하거나 검색할 항목의 모든 원시 메타데이터 정보를 캡처합니다.

JSON 표현 
{
  "name": string,
  "id": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "derivedStructData": {
    object
  },
  "pageSpan": {
    object (PageSpan)
  },
  "chunkMetadata": {
    object (ChunkMetadata)
  },
  "dataUrls": [
    string
  ],
  "annotationContents": [
    string
  ],
  "annotationMetadata": [
    {
      object (AnnotationMetadata)
    }
  ],
  "relevanceScore": number
}
필드
name

string

청크의 전체 리소스 이름입니다. 형식은 projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}/chunks/{chunk_id}입니다.

이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1,024자(영문 기준)입니다.
id

string

현재 청크의 고유 청크 ID입니다.
content

string

콘텐츠는 문서의 문자열입니다 (파싱된 콘텐츠).
documentMetadata

object (DocumentMetadata)

현재 청크의 문서 메타데이터입니다.
derivedStructData

object (Struct format)

출력 전용입니다. 이 필드는 OUTPUT_ONLY입니다. 원래 입력 문서에 없는 파생 데이터가 포함되어 있습니다.
pageSpan

object (PageSpan)

청크의 페이지 범위입니다.
chunkMetadata

object (ChunkMetadata)

출력 전용입니다. 현재 청크의 메타데이터입니다.
dataUrls[]

string

출력 전용입니다. 현재 청크에 이미지가 포함된 경우 이미지 데이터 URL입니다. 데이터 URL은 접두사 (data:), 데이터 유형을 나타내는 MIME 유형, 텍스트가 아닌 경우 선택적 base64 토큰, 데이터 자체의 네 부분으로 구성됩니다. data:[][;base64],
annotationContents[]

string

출력 전용입니다. 현재 청크에 주석이 포함된 경우 주석 콘텐츠입니다.
annotationMetadata[]

object (AnnotationMetadata)

출력 전용입니다. 주석 메타데이터에는 현재 청크의 구조화된 콘텐츠가 포함됩니다.
relevanceScore

number

출력 전용입니다. 유사성을 기반으로 한 관련성 점수를 나타냅니다. 점수가 높을수록 청크 관련성이 높습니다. 점수는 [-1.0, 1.0] 범위에 속합니다. SearchResponse에서만 채워집니다.

DocumentMetadata

문서 메타데이터에는 현재 청크의 문서 정보가 포함됩니다.

JSON 표현 
{
  "uri": string,
  "title": string,
  "mimeType": string,
  "structData": {
    object
  }
}
필드
uri

string

문서의 URI입니다.
title

string

문서 제목입니다.
mimeType

string

문서의 MIME 유형입니다. https://www.iana.org/assignments/media-types/media-types.xhtml
structData

object (Struct format)

데이터 표현 문서의 구조화된 JSON 데이터입니다. 등록된 Schema를 준수해야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 발생합니다.

PageSpan

청크의 페이지 범위입니다.

JSON 표현 
{
  "pageStart": integer,
  "pageEnd": integer
}
필드
pageStart

integer

청크의 시작 페이지입니다.
pageEnd

integer

청크의 종료 페이지입니다.

ChunkMetadata

현재 청크의 메타데이터입니다. 이 필드는 SearchService.Search API에서만 채워집니다.

JSON 표현 
{
  "previousChunks": [
    {
      object (Chunk)
    }
  ],
  "nextChunks": [
    {
      object (Chunk)
    }
  ]
}
필드
previousChunks[]

object (Chunk)

현재 청크의 이전 청크입니다. 이 숫자는 SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks에 의해 제어됩니다. 이 필드는 SearchService.Search API에서만 채워집니다.
nextChunks[]

object (Chunk)

현재 청크의 다음 청크입니다. 이 숫자는 SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks에 의해 제어됩니다. 이 필드는 SearchService.Search API에서만 채워집니다.

AnnotationMetadata

주석 메타데이터에는 현재 청크의 구조화된 콘텐츠가 포함됩니다.

JSON 표현 
{
  "structuredContent": {
    object (StructuredContent)
  },
  "imageId": string
}
필드
structuredContent

object (StructuredContent)

출력 전용입니다. 구조화된 콘텐츠 정보입니다.
imageId

string

출력 전용입니다. 구조화된 콘텐츠가 이미지를 기반으로 하는 경우 이미지 ID가 제공됩니다.

StructuredContent

구조화된 콘텐츠 정보입니다.

JSON 표현 
{
  "structureType": enum (StructureType),
  "content": string
}
필드
structureType

enum (StructureType)

출력 전용입니다. 구조화된 콘텐츠의 구조 유형입니다.
content

string

출력 전용입니다. 구조화된 콘텐츠의 콘텐츠입니다.

StructureType

추출할 수 있는 구조화된 콘텐츠의 유형을 정의합니다.

열거형
STRUCTURE_TYPE_UNSPECIFIED 기본값
SHAREHOLDER_STRUCTURE 주주 구조입니다.
SIGNATURE_STRUCTURE 서명 구조를 사용합니다.
CHECKBOX_STRUCTURE 체크박스 구조입니다.

메서드

get

 Document을 가져옵니다.

list

 Chunk 목록을 가져옵니다.