SearchResult

Representa los resultados de la búsqueda.

Representación JSON 
{
  "id": string,
  "document": {
    object (Document)
  },
  "chunk": {
    object (Chunk)
  },
  "modelScores": {
    string: {
      object (DoubleList)
    },
    ...
  },
  "rankSignals": {
    object (RankSignals)
  }
}
Campos
id

string

Document.id de la Document buscada.
document

object (Document)

Es el fragmento de datos del documento en la respuesta de búsqueda. Solo se propagan los campos marcados como retrievable.
chunk

object (Chunk)

Son los datos de fragmentos en la respuesta de búsqueda si SearchRequest.ContentSearchSpec.search_result_mode se establece en CHUNKS.
modelScores

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

Solo salida. Google proporcionó las puntuaciones disponibles.
rankSignals

object (RankSignals)

Opcional. Es un conjunto de indicadores de clasificación asociados con el resultado.

Fragmento

El fragmento captura toda la información de metadatos sin procesar de los elementos que se recomendarán o buscarán en el modo de fragmento.

Representación 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

Es el nombre completo del recurso del fragmento. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}/chunks/{chunk_id}.

Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.
id

string

Es el ID único del fragmento actual.
content

string

El contenido es una cadena de un documento (contenido analizado).
documentMetadata

object (DocumentMetadata)

Son los metadatos del documento del fragmento actual.
derivedStructData

object (Struct format)

Solo salida. Este campo es OUTPUT_ONLY. Contiene datos derivados que no se encuentran en el documento de entrada original.
pageSpan

object (PageSpan)

Es el intervalo de páginas del fragmento.
chunkMetadata

object (ChunkMetadata)

Solo salida. Son los metadatos del fragmento actual.
dataUrls[]

string

Solo salida. Son las URLs de los datos de la imagen si el fragmento actual contiene imágenes. Las URLs de datos se componen de cuatro partes: un prefijo (data:), un tipo de MIME que indica el tipo de datos, un token base64 opcional si no es textual y los datos en sí: data:[][;base64],
annotationContents[]

string

Solo salida. Contenido de la anotación si el fragmento actual contiene anotaciones.
annotationMetadata[]

object (AnnotationMetadata)

Solo salida. Los metadatos de la anotación incluyen contenido estructurado en el fragmento actual.
relevanceScore

number

Solo salida. Representa la puntuación de relevancia basada en la similitud. Una puntuación más alta indica una mayor relevancia del fragmento. La puntuación está en el rango [-1.0, 1.0]. Solo se propaga en SearchResponse.

DocumentMetadata

Los metadatos del documento contienen la información del documento del fragmento actual.

Representación JSON 
{
  "uri": string,
  "title": string,
  "mimeType": string,
  "structData": {
    object
  }
}
Campos
uri

string

Es el URI del documento.
title

string

Es el título del documento.
mimeType

string

Es el tipo MIME del documento. https://www.iana.org/assignments/media-types/media-types.xhtml.
structData

object (Struct format)

Representación de datos Son los datos estructurados en formato JSON del documento. Debe cumplir con el Schema registrado o se arroja un error INVALID_ARGUMENT.

PageSpan

Es el intervalo de páginas del fragmento.

Representación JSON 
{
  "pageStart": integer,
  "pageEnd": integer
}
Campos
pageStart

integer

Es la página de inicio del fragmento.
pageEnd

integer

Es la página final del fragmento.

ChunkMetadata

Son los metadatos del fragmento actual. Este campo solo se completa en la API de SearchService.Search.

Representación JSON 
{
  "previousChunks": [
    {
      object (Chunk)
    }
  ],
  "nextChunks": [
    {
      object (Chunk)
    }
  ]
}
Campos
previousChunks[]

object (Chunk)

Son los fragmentos anteriores del fragmento actual. SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks controla el número. Este campo solo se completa en la API de SearchService.Search.
nextChunks[]

object (Chunk)

Son los próximos fragmentos del fragmento actual. SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks controla el número. Este campo solo se completa en la API de SearchService.Search.

AnnotationMetadata

Los metadatos de la anotación incluyen contenido estructurado en el fragmento actual.

Representación JSON 
{
  "structuredContent": {
    object (StructuredContent)
  },
  "imageId": string
}
Campos
structuredContent

object (StructuredContent)

Solo salida. Es la información del contenido estructurado.
imageId

string

Solo salida. Se proporciona el ID de la imagen si el contenido estructurado se basa en una imagen.

StructuredContent

Es la información del contenido estructurado.

Representación JSON 
{
  "structureType": enum (StructureType),
  "content": string
}
Campos
structureType

enum (StructureType)

Solo salida. Es el tipo de estructura del contenido estructurado.
content

string

Solo salida. Es el contenido del contenido estructurado.

StructureType

Define los tipos de contenido estructurado que se pueden extraer.

Enums
STRUCTURE_TYPE_UNSPECIFIED Valor predeterminado.
SHAREHOLDER_STRUCTURE Estructura de accionistas
SIGNATURE_STRUCTURE estructura de firma.
CHECKBOX_STRUCTURE Estructura de la casilla de verificación.

DoubleList

Lista doble.

Representación JSON 
{
  "values": [
    number
  ]
}
Campos
values[]

number

Valores dobles

RankSignals

Es un conjunto de indicadores de clasificación.

Representación JSON 
{
  "defaultRank": number,
  "customSignals": [
    {
      object (CustomSignal)
    }
  ],
  "keywordSimilarityScore": number,
  "relevanceScore": number,
  "semanticSimilarityScore": number,
  "pctrRank": number,
  "topicalityRank": number,
  "documentAge": number,
  "boostingFactor": number
}
Campos
defaultRank

number

Opcional. Es el rango predeterminado del resultado.
customSignals[]

object (CustomSignal)

Opcional. Es una lista de indicadores de Clearbox personalizados.
keywordSimilarityScore

number

Opcional. Ajuste de la concordancia de palabras clave.
relevanceScore

number

Opcional. Ajuste de relevancia semántica.
semanticSimilarityScore

number

Opcional. Ajuste de similitud semántica.
pctrRank

number

Opcional. Ajuste del porcentaje de conversiones previsto como un ranking.
topicalityRank

number

Opcional. Ajuste de la relevancia del tema como un ranking.
documentAge

number

Opcional. Es la antigüedad del documento en horas.
boostingFactor

number

Opcional. Es la combinación de los aumentos personalizados para un documento.

CustomSignal

Es un indicador de Clearbox personalizado representado por un par de nombre y valor.

Representación JSON 
{
  "name": string,
  "value": number
}
Campos
name

string

Opcional. Es el nombre del indicador.
value

number

Opcional. Es un valor de número de punto flotante que representa el indicador de clasificación (p.ej., 1.25 para BM25).