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 fragmento de dados do documento na resposta de pesquisa. Apenas os campos marcados como retrievable são preenchidos.
chunk

object (Chunk)

Os dados de blocos na resposta de pesquisa se o valor de SearchRequest.ContentSearchSpec.search_result_mode for CHUNKS.
modelScores

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

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

object (RankSignals)

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

Chunk

O modo de fragmentação captura todas as informações de metadados não processados de itens a serem recomendados ou pesquisados no modo de fragmentação.

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 de recurso completo do fragmento. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}/chunks/{chunk_id}.

Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
id

string

ID exclusivo do fragmento atual.
content

string

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

object (DocumentMetadata)

Metadados do documento do fragmento atual.
derivedStructData

object (Struct format)

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

object (PageSpan)

Intervalo de páginas do fragmento.
chunkMetadata

object (ChunkMetadata)

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

string

Apenas saída. URLs de dados de imagens se o fragmento atual contiver imagens. Os URLs de dados são compostos por 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 próprios dados: data:[][;base64],
annotationContents[]

string

Apenas saída. Conteúdos das anotações, se o fragmento atual contiver anotações.
annotationMetadata[]

object (AnnotationMetadata)

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

number

Apenas saída. Representa a pontuação de relevância com base na semelhança. Uma pontuação mais elevada indica uma maior relevância do fragmento. A pontuação está no intervalo [-1,0, 1,0]. Preenchido apenas no SearchResponse.

DocumentMetadata

Os metadados do documento contêm as informações do documento do fragmento 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 para o documento. Deve estar em conformidade com o Schema registado ou é gerado um erro INVALID_ARGUMENT.

PageSpan

Intervalo de páginas do fragmento.

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

integer

A página inicial do fragmento.
pageEnd

integer

A página final do fragmento.

ChunkMetadata

Metadados do fragmento atual. Este campo só é preenchido na API SearchService.Search.

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

object (Chunk)

Os fragmentos anteriores do fragmento atual. O número é controlado por SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. Este campo só é preenchido na API SearchService.Search.
nextChunks[]

object (Chunk)

Os próximos fragmentos do fragmento atual. O número é controlado por SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. Este campo só é preenchido na API SearchService.Search.

AnnotationMetadata

Os metadados de anotação incluem conteúdo estruturado no fragmento 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 se basear numa 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.

Enumerações
STRUCTURE_TYPE_UNSPECIFIED Valor predefinido.
SHAREHOLDER_STRUCTURE Estrutura acionista.
SIGNATURE_STRUCTURE estrutura da assinatura.
CHECKBOX_STRUCTURE Estrutura da caixa de verificação.

DoubleList

Lista dupla.

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

number

Valores duplos.

RankSignals

Um conjunto de sinais 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 predefinida do resultado.
customSignals[]

object (CustomSignal)

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

number

Opcional. Ajuste da correspondência de palavras-chave.
relevanceScore

number

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

number

Opcional. Ajuste de semelhança semântica.
pctrRank

number

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

number

Opcional. Ajuste de topicalidade como classificação.
documentAge

number

Opcional. Idade do documento em horas.
boostingFactor

number

Opcional. Potenciações personalizadas combinadas para um documento.

CustomSignal

Sinal de caixa transparente personalizado representado por um par de nome e valor.

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

string

Opcional. Nome do sinal.
value

number

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