SearchResult

Representa os resultados da pesquisa.

Representação JSON 
{
  "id": string,
  "document": {
    object (Document)
  },
  "chunk": {
    object (Chunk)
  },
  "modelScores": {
    string: {
      object (DoubleList)
    },
    ...
  },
  "rankSignals": {
    object (RankSignals)
  }
}
Campos
id

string

Document.id do Document pesquisado.
document

object (Document)

O snippet de dados do documento na resposta da pesquisa. Somente os campos marcados como retrievable são preenchidos.
chunk

object (Chunk)

Os dados de bloco na resposta da pesquisa se SearchRequest.ContentSearchSpec.search_result_mode estiver definido como CHUNKS.
modelScores

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

Apenas saída. O Google forneceu as pontuações disponíveis.
rankSignals

object (RankSignals)

Opcional. Um conjunto de indicadores de classificação associados ao resultado.

Chunk

O bloco captura todas as informações de metadados brutos dos itens a serem recomendados ou pesquisados no modo de bloco.

Representação 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
}
Campos
name

string

O nome completo do recurso do fragmento. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}/chunks/{chunk_id}.

Este campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
id

string

ID exclusivo do bloco atual.
content

string

O conteúdo é uma string de um documento (conteúdo analisado).
documentMetadata

object (DocumentMetadata)

Metadados do documento do bloco atual.
derivedStructData

object (Struct format)

Apenas saída. Este campo é OUTPUT_ONLY. Ele contém dados derivados que não estão no documento de entrada original.
pageSpan

object (PageSpan)

Intervalo de páginas do trecho.
chunkMetadata

object (ChunkMetadata)

Apenas saída. Metadados do bloco atual.
dataUrls[]

string

Apenas saída. URLs de dados de imagem se o bloco atual contiver imagens. Os URLs de dados são compostos de quatro partes: um prefixo (data:), um tipo MIME que indica o tipo de dados, um token base64 opcional se não for textual e os dados em si: data:[][;base64],
annotationContents[]

string

Apenas saída. Conteúdo da anotação se o bloco atual contiver anotações.
annotationMetadata[]

object (AnnotationMetadata)

Apenas saída. Os metadados da anotação incluem conteúdo estruturado no trecho atual.
relevanceScore

number

Apenas saída. Representa a pontuação de relevância com base na similaridade. Uma pontuação mais alta indica maior relevância do trecho. A pontuação está no intervalo [-1.0, 1.0]. Preenchido apenas em SearchResponse.

DocumentMetadata

Os metadados do documento contêm as informações do documento do bloco atual.

Representação JSON 
{
  "uri": string,
  "title": string,
  "mimeType": string,
  "structData": {
    object
  }
}
Campos
uri

string

URI do documento.
title

string

Título do documento.
mimeType

string

O tipo MIME do documento. https://www.iana.org/assignments/media-types/media-types.xhtml.
structData

object (Struct format)

Representação de dados. Os dados JSON estruturados do documento. Ele precisa estar de acordo com o Schema registrado ou um erro INVALID_ARGUMENT será gerado.

PageSpan

Intervalo de páginas do trecho.

Representação JSON 
{
  "pageStart": integer,
  "pageEnd": integer
}
Campos
pageStart

integer

A página inicial do bloco.
pageEnd

integer

A página final do trecho.

ChunkMetadata

Metadados do bloco atual. Esse campo é preenchido apenas na API SearchService.Search.

Representação JSON 
{
  "previousChunks": [
    {
      object (Chunk)
    }
  ],
  "nextChunks": [
    {
      object (Chunk)
    }
  ]
}
Campos
previousChunks[]

object (Chunk)

Os trechos anteriores do trecho atual. O número é controlado por SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. Esse campo é preenchido apenas na API SearchService.Search.
nextChunks[]

object (Chunk)

Os próximos trechos do trecho atual. O número é controlado por SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. Esse campo é preenchido apenas na API SearchService.Search.

AnnotationMetadata

Os metadados da anotação incluem conteúdo estruturado no trecho atual.

Representação JSON 
{
  "structuredContent": {
    object (StructuredContent)
  },
  "imageId": string
}
Campos
structuredContent

object (StructuredContent)

Apenas saída. As informações de conteúdo estruturado.
imageId

string

Apenas saída. O ID da imagem é fornecido se o conteúdo estruturado for baseado em uma imagem.

StructuredContent

As informações de conteúdo estruturado.

Representação JSON 
{
  "structureType": enum (StructureType),
  "content": string
}
Campos
structureType

enum (StructureType)

Apenas saída. O tipo de estrutura do conteúdo estruturado.
content

string

Apenas saída. O conteúdo do conteúdo estruturado.

StructureType

Define os tipos de conteúdo estruturado que podem ser extraídos.

Tipos enumerados
STRUCTURE_TYPE_UNSPECIFIED Valor padrão.
SHAREHOLDER_STRUCTURE Estrutura de acionistas.
SIGNATURE_STRUCTURE estrutura de assinatura.
CHECKBOX_STRUCTURE Estrutura da caixa de seleção.

DoubleList

Lista dupla.

Representação JSON 
{
  "values": [
    number
  ]
}
Campos
values[]

number

Valores duplos.

RankSignals

Um conjunto de indicadores de classificação.

Representação JSON 
{
  "defaultRank": number,
  "customSignals": [
    {
      object (CustomSignal)
    }
  ],
  "keywordSimilarityScore": number,
  "relevanceScore": number,
  "semanticSimilarityScore": number,
  "pctrRank": number,
  "topicalityRank": number,
  "documentAge": number,
  "boostingFactor": number
}
Campos
defaultRank

number

Opcional. A classificação padrão do resultado.
customSignals[]

object (CustomSignal)

Opcional. Uma lista de indicadores personalizados de caixa transparente.
keywordSimilarityScore

number

Opcional. Ajuste de correspondência de palavra-chave.
relevanceScore

number

Opcional. Ajuste de relevância semântica.
semanticSimilarityScore

number

Opcional. Ajuste de similaridade semântica.
pctrRank

number

Opcional. Ajuste da taxa de conversão prevista como uma classificação.
topicalityRank

number

Opcional. Ajuste de relevância como uma classificação.
documentAge

number

Opcional. Idade do documento em horas.
boostingFactor

number

Opcional. Aumentos personalizados combinados para um documento.

CustomSignal

Indicador clearbox personalizado representado por um par nome-valor.

Representação JSON 
{
  "name": string,
  "value": number
}
Campos
name

string

Opcional. Nome do indicador.
value

number

Opcional. Valor de ponto flutuante que representa o indicador de classificação (por exemplo, 1,25 para BM25).