SearchSpec

Es la especificación de la búsqueda.

Representación JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "searchParams": {
    object (SearchParams)
  },
  "searchResultList": {
    object (SearchResultList)
  }
  // End of mutually exclusive fields.
}
Campos
Parámetros de búsqueda para controlar el comportamiento de la búsqueda. O bien, proporciona una lista de resultados de la búsqueda para generar la respuesta. A continuación, se incluye una lista de campos mutuamente excluyentes. En una respuesta, se establecerá, como máximo, uno de los siguientes campos:
searchParams

object (SearchParams)

Son los parámetros de búsqueda.
searchResultList

object (SearchResultList)

Lista de resultados de la búsqueda.
Fin de los campos mutuamente exclusivos.

SearchParams

Son los parámetros de búsqueda.

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

integer

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

string

La sintaxis del filtro consta de un lenguaje de expresión para construir un predicado a partir de uno o más campos de los documentos que se filtran. La expresión del filtro distingue mayúsculas de minúsculas. Esto se utilizará para filtrar los resultados de búsqueda que puedan afectar la respuesta de Answer.

Si este campo no se puede reconocer, se devuelve un INVALID_ARGUMENT.

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

Para obtener más información sobre los filtros, incluidos los operadores y la sintaxis de filtros, consulta Filtro.
boostSpec

object (BoostSpec)

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

string

Es el orden en el que se devuelven los documentos. Los documentos se pueden ordenar por un campo en un objeto Document. Déjalo sin configurar si se ordena por relevancia. La expresión orderBy distingue mayúsculas de minúsculas. Para obtener más información sobre el ordenamiento, consulta Ordenamiento.

Si este campo no se puede reconocer, se devuelve un INVALID_ARGUMENT.
searchResultMode

enum (SearchResultMode)

Especifica el modo de resultado de la búsqueda. Si no se especifica, el modo de resultado de la búsqueda se establece de forma predeterminada como DOCUMENTS. Consulta cómo analizar y fragmentar documentos
dataStoreSpecs[]

object (DataStoreSpec)

Son especificaciones que definen los almacenes de datos para filtrar en una llamada de búsqueda y las configuraciones de esos almacenes de datos. Esto solo se considera para los motores con casos de uso de varios almacenes de datos. En el caso de un solo DataStore dentro de un motor, se deben usar las especificaciones de nivel superior.
naturalLanguageQueryUnderstandingSpec

object (NaturalLanguageQueryUnderstandingSpec)

Es opcional. Es una especificación para habilitar las capacidades de comprensión del lenguaje natural para las solicitudes de búsqueda.

SearchResultList

Lista de resultados de la búsqueda.

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

object (SearchResult)

Resultados de la búsqueda.

SearchResult

Es un resultado de la búsqueda.

Representación JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  }
  // End of mutually exclusive fields.
}
Campos
Contenido del resultado de la búsqueda. A continuación, se incluye una lista de campos mutuamente excluyentes. En una respuesta, se establecerá, como máximo, uno de los siguientes campos:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Es información de documentos no estructurados.
chunkInfo

object (ChunkInfo)

Es información sobre el fragmento.
Fin de los campos mutuamente exclusivos.

UnstructuredDocumentInfo

Es información de documentos no estructurados.

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

string

Nombre del recurso del documento.
uri

string

Es el URI del documento.
title

string

y "title".
documentContexts[]

object (DocumentContext)

Es la lista de contextos del documento. El contenido se usará para la generación de respuestas. Se supone que este es el 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. Es la lista de respuestas extractivas.

DocumentContext

Es el contexto del documento.

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

string

Es el identificador de la página.
content

string

El contenido del documento se utilizará para generar la respuesta.

ExtractiveSegment

Es un segmento extractivo. La guía de generación de respuestas solo se usará si documentContexts está vacío. Se supone que son fragmentos más cortos.

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

string

Es el identificador de la página.
content

string

Es el contenido del segmento extractivo.

ExtractiveAnswer

Respuesta extractiva. Guía

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

string

Es el identificador de la página.
content

string

Es el contenido de la respuesta extractiva.

ChunkInfo

Es información sobre el fragmento.

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

string

Nombre del recurso de fragmento.
content

string

Fragmenta el contenido textual.
documentMetadata

object (DocumentMetadata)

Son los 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

Es el URI del documento.
title

string

Es el título del documento.