Method: projects.locations.collections.dataObjects.batchSearch

Pesquisa em lote objetos de dados.

Solicitação HTTP

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso da coleção a ser pesquisada. Formato: projects/{project}/locations/{location}/collections/{collection}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "searches": [
    {
      object (Search)
    }
  ],
  "combine": {
    object (CombineResultsOptions)
  }
}
Campos
searches[]

object (Search)

Obrigatório. Uma lista de solicitações de pesquisa a serem executadas em paralelo.
combine

object (CombineResultsOptions)

Opcional. Opções para combinar os resultados das operações de pesquisa em lote.

Corpo da resposta

Uma resposta de uma operação de pesquisa em lote.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "results": [
    {
      object (SearchDataObjectsResponse)
    }
  ]
}
Campos
results[]

object (SearchDataObjectsResponse)

Apenas saída. Uma lista de respostas de pesquisa, uma para cada solicitação no lote. Se um classificador for usado, uma única lista classificada de resultados será retornada.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • vectorsearch.dataObjects.search

Para mais informações, consulte a documentação do IAM.

CombineResultsOptions

Opções para combinar os resultados das operações de pesquisa em lote.

Representação JSON 
{
  "ranker": {
    object (Ranker)
  },
  "outputFields": {
    object (OutputFields)
  },
  "topK": integer
}
Campos
ranker

object (Ranker)

Obrigatório. O classificador a ser usado para combinar os resultados.
outputFields

object (OutputFields)

Opcional. Máscara que especifica os campos a serem retornados.
topK

integer

Opcional. O número de resultados a serem mostrados. Se não for definido, um valor padrão será usado.

Ranker

Define um classificador para combinar resultados de várias pesquisas.

Representação JSON 
{

  // Union field ranker can be only one of the following:
  "rrf": {
    object (ReciprocalRankFusion)
  },
  "vertex": {
    object (VertexRanker)
  }
  // End of list of possible types for union field ranker.
}
Campos
Campo de união ranker. O método de classificação a ser usado. ranker pode ser apenas de um dos tipos a seguir:
rrf

object (ReciprocalRankFusion)

Classificação de fusão de classificação recíproca.
vertex

object (VertexRanker)

Ranking da Vertex AI.

ReciprocalRankFusion

Define o algoritmo de Fusão de classificação recíproca (RRF) para a classificação de resultados.

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

number

Obrigatório. Os pesos a serem aplicados a cada conjunto de resultados da pesquisa durante a fusão.

VertexRanker

Define um classificador usando o serviço de classificação da Vertex AI. Consulte https://cloud.google.com/generative-ai-app-builder/docs/ranking para mais detalhes.

Representação JSON 
{
  "query": string,
  "titleTemplate": string,
  "contentTemplate": string,
  "model": string
}
Campos
query

string

Obrigatório. A consulta em relação à qual os registros são classificados e pontuados.
titleTemplate

string

Opcional. O modelo usado para gerar o título do registro.
contentTemplate

string

Opcional. O modelo usado para gerar o conteúdo do registro.
model

string

Obrigatório. O modelo usado para classificar documentos. Se nenhum modelo for especificado, semantic-ranker-default@latest será usado.