SearchResult

검색 결과를 나타냅니다.

JSON 표현 
{
  "id": string,
  "document": {
    object (Document)
  },
  "chunk": {
    object (Chunk)
  },
  "modelScores": {
    string: {
      object (DoubleList)
    },
    ...
  },
  "rankSignals": {
    object (RankSignals)
  }
}
필드
id

string

검색된 Document의 Document.id입니다.
document

object (Document)

검색 대답의 문서 데이터 스니펫입니다. retrievable로 표시된 필드만 채워집니다.
chunk

object (Chunk)

SearchRequest.ContentSearchSpec.search_result_mode가 CHUNKS로 설정된 경우 검색 대답의 청크 데이터입니다.
modelScores

map (key: string, value: object (DoubleList))

출력 전용입니다. Google에서 사용 가능한 점수를 제공했습니다.
rankSignals

object (RankSignals)

선택사항. 결과와 연결된 순위 결정 신호 집합입니다.

Chunk

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

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 체크박스 구조입니다.

DoubleList

이중 목록입니다.

JSON 표현 
{
  "values": [
    number
  ]
}
필드
values[]

number

이중 값입니다.

RankSignals

순위 결정 신호 집합입니다.

JSON 표현 
{
  "defaultRank": number,
  "customSignals": [
    {
      object (CustomSignal)
    }
  ],
  "keywordSimilarityScore": number,
  "relevanceScore": number,
  "semanticSimilarityScore": number,
  "pctrRank": number,
  "topicalityRank": number,
  "documentAge": number,
  "boostingFactor": number
}
필드
defaultRank

number

선택사항. 결과 기본 순위입니다.
customSignals[]

object (CustomSignal)

선택사항. 커스텀 clearbox 신호 목록입니다.
keywordSimilarityScore

number

선택사항. 키워드 검색 유형 조정입니다.
relevanceScore

number

선택사항. 시맨틱 관련성 조정입니다.
semanticSimilarityScore

number

선택사항. 시맨틱 유사도 조정입니다.
pctrRank

number

선택사항. 예상 전환율 조정을 순위로 나타냅니다.
topicalityRank

number

선택사항. 순위로 표시되는 주제성 조정입니다.
documentAge

number

선택사항. 문서 기간(시간)입니다.
boostingFactor

number

선택사항. 문서의 커스텀 부스트가 결합되었습니다.

CustomSignal

이름과 값 쌍으로 표현되는 커스텀 clearbox 신호입니다.

JSON 표현 
{
  "name": string,
  "value": number
}
필드
name

string

선택사항. 신호 이름입니다.
value

number

선택사항. 순위 결정 신호를 나타내는 부동 소수점 값입니다(예: BM25의 경우 1.25).