Method: projects.locations.collections.dataObjects.batchSearch

Realiza búsquedas por lotes de objetos de datos.

Solicitud HTTP

POST https://vectorsearch.googleapis.com/v1beta/{parent}/dataObjects:batchSearch

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Nombre del recurso de la colección en la que se realizará la búsqueda. Formato: projects/{project}/locations/{location}/collections/{collection}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "searches": [
    {
      object (Search)
    }
  ],
  "combine": {
    object (CombineResultsOptions)
  }
}
Campos
searches[]

object (Search)

Obligatorio. Es una lista de solicitudes de búsqueda que se ejecutarán en paralelo.
combine

object (CombineResultsOptions)

Es opcional. Son las opciones para combinar los resultados de las operaciones de búsqueda por lotes.

Cuerpo de la respuesta

Es la respuesta de una operación de búsqueda por lotes.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "results": [
    {
      object (SearchDataObjectsResponse)
    }
  ]
}
Campos
results[]

object (SearchDataObjectsResponse)

Solo salida. Es una lista de respuestas de búsqueda, una para cada solicitud del lote. Si se usa un clasificador, se devuelve una sola lista de resultados clasificados.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • vectorsearch.dataObjects.search

Para obtener más información, consulta la documentación de IAM.

CombineResultsOptions

Son las opciones para combinar los resultados de las operaciones de búsqueda por lotes.

Representación JSON 
{
  "ranker": {
    object (Ranker)
  },
  "outputFields": {
    object (OutputFields)
  },
  "topK": integer
}
Campos
ranker

object (Ranker)

Obligatorio. Es el clasificador que se usará para combinar los resultados.
outputFields

object (OutputFields)

Es opcional. Máscara que especifica qué campos se deben devolver.
topK

integer

Es opcional. Es la cantidad de resultados que se devolverán. Si no se establece, se usará un valor predeterminado.

Ranker

Define un clasificador para combinar los resultados de varias búsquedas.

Representación JSON 
{

  // Union field ranker can be only one of the following:
  "rrf": {
    object (ReciprocalRankFusion)
  }
  // End of list of possible types for union field ranker.

  // Union field reranker can be only one of the following:
  "vertexRanker": {
    object (VertexRanker)
  }
  // End of list of possible types for union field reranker.
}
Campos
Campo de unión ranker. Es el método de clasificación que se usará. ranker puede ser solo uno de los parámetros siguientes:
rrf

object (ReciprocalRankFusion)

Es la clasificación de fusión de clasificación recíproca.
Campo de unión reranker. Es el reranqueador que se usará para la clasificación final de los resultados combinados por el clasificador. reranker puede ser solo uno de los parámetros siguientes:
vertexRanker

object (VertexRanker)

Es opcional. Es el ranking de Vertex AI.

ReciprocalRankFusion

Define el algoritmo de fusión de clasificación recíproca (RRF) para la clasificación de resultados.

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

number

Obligatorio. Son los pesos que se aplicarán a cada conjunto de resultados de la búsqueda durante la fusión.

VertexRanker

Define un clasificador con el servicio de clasificación de Vertex AI. Consulta https://cloud.google.com/generative-ai-app-builder/docs/ranking para obtener más detalles.

Representación JSON 
{
  "model": string,
  "topN": integer,

  // Union field record_spec can be only one of the following:
  "textRecordSpec": {
    object (TextRecordSpec)
  }
  // End of list of possible types for union field record_spec.
}
Campos
model

string

Obligatorio. Es el modelo que se usa para clasificar documentos. La lista de modelos disponibles se describe en https://docs.cloud.google.com/generative-ai-app-builder/docs/ranking#models. Por el momento, solo se admite semantic-ranker-fast@latest.
topN

integer

Obligatorio. Es la cantidad de documentos que se procesarán para la clasificación.
Campo de unión record_spec. Es la especificación del registro para la clasificación. Se debe establecer al menos un objeto RecordSpec. record_spec puede ser solo uno de los parámetros siguientes:
textRecordSpec

object (TextRecordSpec)

Es la especificación del registro para la búsqueda de texto.

TextRecordSpec

Es la especificación del registro para la búsqueda de texto.

Representación JSON 
{
  "query": string,
  "titleTemplate": string,
  "contentTemplate": string
}
Campos
query

string

Obligatorio. Es la búsqueda con la que se clasifican y puntúan los registros.
titleTemplate

string

Es opcional. Es la plantilla que se usa para generar el título del registro.
contentTemplate

string

Es opcional. Es la plantilla que se usó para generar el contenido del registro.