SearchResult

Menampilkan hasil penelusuran.

Representasi JSON 
{
  "id": string,
  "document": {
    object (Document)
  },
  "chunk": {
    object (Chunk)
  },
  "modelScores": {
    string: {
      object (DoubleList)
    },
    ...
  },
  "rankSignals": {
    object (RankSignals)
  }
}
Kolom
id

string

Document.id dari Document yang ditelusuri.
document

object (Document)

Cuplikan data dokumen dalam respons penelusuran. Hanya kolom yang ditandai sebagai retrievable yang diisi.
chunk

object (Chunk)

Data potongan dalam respons penelusuran jika SearchRequest.ContentSearchSpec.search_result_mode disetel ke CHUNKS.
modelScores

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

Hanya output. Google menyediakan skor yang tersedia.
rankSignals

object (RankSignals)

Opsional. Kumpulan sinyal peringkat yang terkait dengan hasil.

Chunk

Chunk mencatat semua informasi metadata mentah item yang akan direkomendasikan atau dicari dalam mode chunk.

Representasi 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
}
Kolom
name

string

Nama lengkap resource potongan. Format projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}/chunks/{chunk_id}.

Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.
id

string

ID potongan unik dari potongan saat ini.
content

string

Content adalah string dari dokumen (konten yang diuraikan).
documentMetadata

object (DocumentMetadata)

Metadata dokumen dari chunk saat ini.
derivedStructData

object (Struct format)

Hanya output. Kolom ini bersifat OUTPUT_ONLY. Objek ini berisi data turunan yang tidak ada dalam dokumen input asli.
pageSpan

object (PageSpan)

Rentang halaman potongan.
chunkMetadata

object (ChunkMetadata)

Hanya output. Metadata potongan saat ini.
dataUrls[]

string

Hanya output. URL Data Gambar jika chunk saat ini berisi gambar. URL data terdiri dari empat bagian: awalan (data:), jenis MIME yang menunjukkan jenis data, token base64 opsional jika non-tekstual, dan data itu sendiri: data:[][;base64],
annotationContents[]

string

Hanya output. Isi anotasi jika chunk saat ini berisi anotasi.
annotationMetadata[]

object (AnnotationMetadata)

Hanya output. Metadata anotasi mencakup konten terstruktur dalam potongan saat ini.
relevanceScore

number

Hanya output. Mewakili skor relevansi berdasarkan kemiripan. Skor yang lebih tinggi menunjukkan relevansi potongan yang lebih tinggi. Skor berada dalam rentang [-1.0, 1.0]. Hanya diisi di SearchResponse.

DocumentMetadata

Metadata dokumen berisi informasi dokumen potongan saat ini.

Representasi JSON 
{
  "uri": string,
  "title": string,
  "mimeType": string,
  "structData": {
    object
  }
}
Kolom
uri

string

URI dokumen.
title

string

Judul dokumen.
mimeType

string

Jenis MIME dokumen. https://www.iana.org/assignments/media-types/media-types.xhtml.
structData

object (Struct format)

Representasi data. Data JSON terstruktur untuk dokumen. Harus sesuai dengan Schema yang terdaftar atau error INVALID_ARGUMENT akan ditampilkan.

PageSpan

Rentang halaman potongan.

Representasi JSON 
{
  "pageStart": integer,
  "pageEnd": integer
}
Kolom
pageStart

integer

Halaman awal chunk.
pageEnd

integer

Halaman akhir potongan.

ChunkMetadata

Metadata potongan saat ini. Kolom ini hanya diisi di API SearchService.Search.

Representasi JSON 
{
  "previousChunks": [
    {
      object (Chunk)
    }
  ],
  "nextChunks": [
    {
      object (Chunk)
    }
  ]
}
Kolom
previousChunks[]

object (Chunk)

Chunk sebelumnya dari chunk saat ini. Nomor tersebut dikontrol oleh SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. Kolom ini hanya diisi di API SearchService.Search.
nextChunks[]

object (Chunk)

Chunk berikutnya dari chunk saat ini. Nomor tersebut dikontrol oleh SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. Kolom ini hanya diisi di API SearchService.Search.

AnnotationMetadata

Metadata anotasi mencakup konten terstruktur dalam potongan saat ini.

Representasi JSON 
{
  "structuredContent": {
    object (StructuredContent)
  },
  "imageId": string
}
Kolom
structuredContent

object (StructuredContent)

Hanya output. Informasi konten terstruktur.
imageId

string

Hanya output. ID gambar diberikan jika konten terstruktur didasarkan pada gambar.

StructuredContent

Informasi konten terstruktur.

Representasi JSON 
{
  "structureType": enum (StructureType),
  "content": string
}
Kolom
structureType

enum (StructureType)

Hanya output. Jenis struktur konten terstruktur.
content

string

Hanya output. Konten konten terstruktur.

StructureType

Mendefinisikan jenis konten terstruktur yang dapat diekstrak.

Enum
STRUCTURE_TYPE_UNSPECIFIED Nilai default.
SHAREHOLDER_STRUCTURE Struktur pemegang saham.
SIGNATURE_STRUCTURE struktur tanda tangan.
CHECKBOX_STRUCTURE Struktur kotak centang.

DoubleList

Daftar ganda.

Representasi JSON 
{
  "values": [
    number
  ]
}
Kolom
values[]

number

Nilai ganda.

RankSignals

Kumpulan sinyal penentu peringkat.

Representasi JSON 
{
  "defaultRank": number,
  "customSignals": [
    {
      object (CustomSignal)
    }
  ],
  "keywordSimilarityScore": number,
  "relevanceScore": number,
  "semanticSimilarityScore": number,
  "pctrRank": number,
  "topicalityRank": number,
  "documentAge": number,
  "boostingFactor": number
}
Kolom
defaultRank

number

Opsional. Peringkat default hasil.
customSignals[]

object (CustomSignal)

Opsional. Daftar sinyal clearbox kustom.
keywordSimilarityScore

number

Opsional. Penyesuaian pencocokan kata kunci.
relevanceScore

number

Opsional. Penyesuaian relevansi semantik.
semanticSimilarityScore

number

Opsional. Penyesuaian kemiripan semantik.
pctrRank

number

Opsional. Penyesuaian prediksi rasio konversi sebagai peringkat.
topicalityRank

number

Opsional. Penyesuaian topikalitas sebagai peringkat.
documentAge

number

Opsional. Usia dokumen dalam jam.
boostingFactor

number

Opsional. Menggabungkan peningkatan kustom untuk dokumen.

CustomSignal

Sinyal clearbox kustom yang diwakili oleh pasangan nama dan nilai.

Representasi JSON 
{
  "name": string,
  "value": number
}
Kolom
name

string

Opsional. Nama sinyal.
value

number

Opsional. Nilai mengambang yang merepresentasikan sinyal peringkat (misalnya, 1,25 untuk BM25).