SearchSpec

Especificación de búsqueda.

Representación JSON 
{

  // Union field input can be only one of the following:
  "searchParams": {
    object (SearchParams)
  },
  "searchResultList": {
    object (SearchResultList)
  }
  // End of list of possible types for union field input.
}
Campos
Campo de unión input. Parámetros de búsqueda para controlar el comportamiento de la búsqueda. También puedes proporcionar una lista de resultados de búsqueda para generar una respuesta. input solo puede ser una de estas dos opciones:
searchParams

object (SearchParams)

Parámetros de búsqueda.
searchResultList

object (SearchResultList)

Lista de resultados de búsqueda.

SearchParams

Parámetros de búsqueda.

Representación JSON 
{
  "maxReturnResults": integer,
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  },
  "orderBy": string,
  "searchResultMode": enum (SearchResultMode),
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ]
}
Campos
maxReturnResults

integer

Número de resultados de búsqueda que se devolverán. El valor predeterminado es 10.
filter

string

La sintaxis del filtro consta de un lenguaje de expresiones para crear un predicado a partir de uno o varios campos de los documentos que se van a filtrar. La expresión de filtro distingue entre mayúsculas y minúsculas. Se usará para filtrar los resultados de búsqueda, lo que puede afectar a la respuesta.

Si este campo no se reconoce, se devuelve un INVALID_ARGUMENT.

El filtrado en Vertex AI Search se realiza asignando la clave de filtro del lado izquierdo a una propiedad de clave definida en el backend de Vertex AI Search. El cliente define esta asignación en su esquema. Por ejemplo, los clientes de medios pueden tener un campo "nombre" en su esquema. En este caso, el filtro sería el siguiente: filter --> name:'ANY("king kong")'

Para obtener más información sobre el filtrado, incluida la sintaxis y los operadores de filtro, consulta Filtrar.
boostSpec

object (BoostSpec)

Especificación de impulso para impulsar determinados documentos en los resultados de búsqueda, lo que puede afectar a la respuesta de la consulta. Para obtener más información sobre el aumento, consulta Aumento.
orderBy

string

El orden en el que se devuelven los documentos. Los documentos se pueden ordenar por un campo de un objeto Document. Déjalo sin definir si los resultados se ordenan por relevancia. La expresión orderBy distingue entre mayúsculas y minúsculas. Para obtener más información sobre los pedidos, consulta la sección Pedidos.

Si este campo no se reconoce, se devuelve un INVALID_ARGUMENT.
searchResultMode

enum (SearchResultMode)

Especifica el modo de resultados de búsqueda. Si no se especifica, el modo de resultado de búsqueda predeterminado es DOCUMENTS. Consulta Analizar y dividir documentos en fragmentos.
dataStoreSpecs[]

object (DataStoreSpec)

Especificaciones que definen los almacenes de datos que se van a filtrar en una llamada de búsqueda y las configuraciones de esos almacenes de datos. Esto solo se tiene en cuenta en el caso práctico de los motores con varios almacenes de datos. Si solo hay un almacén de datos en un motor, deben usar las especificaciones de nivel superior.

SearchResultList

Lista de resultados de búsqueda.

Representación JSON 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Campos
searchResults[]

object (SearchResult)

Resultados de búsqueda.

SearchResult

Resultado de búsqueda.

Representación JSON 
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  }
  // End of list of possible types for union field content.
}
Campos
Campo de unión content. Contenido de los resultados de búsqueda. content solo puede ser una de estas dos opciones:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Información de documentos no estructurada.
chunkInfo

object (ChunkInfo)

Información de los fragmentos.

UnstructuredDocumentInfo

Información de documentos no estructurada.

Representación JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "documentContexts": [
    {
      object (DocumentContext)
    }
  ],
  "extractiveSegments": [
    {
      object (ExtractiveSegment)
    }
  ],
  "extractiveAnswers": [
    {
      object (ExtractiveAnswer)
    }
  ]
}
Campos
document

string

Nombre de recurso del documento.
uri

string

URI del documento.
title

string

Título.
documentContexts[]

object (DocumentContext)

Lista de contextos de documentos. El contenido se usará para generar respuestas. Se trata del contenido principal del documento, que puede ser largo y completo.
extractiveSegments[]

object (ExtractiveSegment)

Lista de segmentos extractivos.
extractiveAnswers[]
(deprecated)

object (ExtractiveAnswer)

Obsoleto: este campo está obsoleto y no tendrá ningún efecto en la generación de respuestas. Usa los campos documentContexts y extractiveSegments. Lista de respuestas extractivas.

DocumentContext

Contexto del documento.

Representación JSON 
{
  "pageIdentifier": string,
  "content": string
}
Campos
pageIdentifier

string

Identificador de la página.
content

string

Contenido del documento que se usará para generar respuestas.

ExtractiveSegment

Segmento extractivo. Guía: La generación de respuestas solo lo usará si documentContexts está vacío. Se supone que deben ser fragmentos más cortos.

Representación JSON 
{
  "pageIdentifier": string,
  "content": string
}
Campos
pageIdentifier

string

Identificador de la página.
content

string

Contenido de segmentos extractivos.

ExtractiveAnswer

Respuesta extractiva. Guía

Representación JSON 
{
  "pageIdentifier": string,
  "content": string
}
Campos
pageIdentifier

string

Identificador de la página.
content

string

Contenido de la respuesta extractiva.

ChunkInfo

Información de los fragmentos.

Representación JSON 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
Campos
chunk

string

Nombre de recurso del fragmento.
content

string

Divide el contenido textual en fragmentos.
documentMetadata

object (DocumentMetadata)

Metadatos del documento del fragmento actual.

DocumentMetadata

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

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

string

URI del documento.
title

string

Título del documento.