Method: projects.locations.collections.dataObjects.batchSearch

Le ricerche batch cercano oggetti di dati.

Richiesta HTTP

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

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa della raccolta in cui eseguire la ricerca. Formato: projects/{project}/locations/{location}/collections/{collection}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "searches": [
    {
      object (Search)
    }
  ],
  "combine": {
    object (CombineResultsOptions)
  }
}
Campi
searches[]

object (Search)

Obbligatorio. Un elenco di richieste di ricerca da eseguire in parallelo.

combine

object (CombineResultsOptions)

Facoltativo. Opzioni per combinare i risultati delle operazioni di ricerca batch.

Corpo della risposta

Una risposta da un'operazione di ricerca batch.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "results": [
    {
      object (SearchDataObjectsResponse)
    }
  ]
}
Campi
results[]

object (SearchDataObjectsResponse)

Solo output. Un elenco di risposte di ricerca, una per ogni richiesta nel batch. Se viene utilizzato un sistema di classificazione, viene restituito un singolo elenco classificato di risultati.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • vectorsearch.dataObjects.search

Per saperne di più, consulta la documentazione di IAM.

CombineResultsOptions

Opzioni per combinare i risultati delle operazioni di ricerca batch.

Rappresentazione JSON
{
  "ranker": {
    object (Ranker)
  },
  "outputFields": {
    object (OutputFields)
  },
  "topK": integer
}
Campi
ranker

object (Ranker)

Obbligatorio. Il ranker da utilizzare per combinare i risultati.

outputFields

object (OutputFields)

Facoltativo. Maschera che specifica i campi da restituire.

topK

integer

Facoltativo. Il numero di risultati da restituire. Se non viene impostato, verrà utilizzato un valore predefinito.

Ranker

Definisce un ranker per combinare i risultati di più ricerche.

Rappresentazione 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.
}
Campi
Campo unione ranker. Il metodo di classificazione da utilizzare. ranker può essere solo uno dei seguenti tipi:
rrf

object (ReciprocalRankFusion)

Classifica Reciprocal Rank Fusion.

vertex

object (VertexRanker)

Classifica Vertex AI.

ReciprocalRankFusion

Definisce l'algoritmo Reciprocal Rank Fusion (RRF) per il ranking dei risultati.

Rappresentazione JSON
{
  "weights": [
    number
  ]
}
Campi
weights[]

number

Obbligatorio. I pesi da applicare a ogni insieme di risultati di ricerca durante la fusione.

VertexRanker

Definisce un ranker utilizzando il servizio di ranking Vertex AI. Per maggiori dettagli, vedi https://cloud.google.com/generative-ai-app-builder/docs/ranking.

Rappresentazione JSON
{
  "query": string,
  "titleTemplate": string,
  "contentTemplate": string,
  "model": string
}
Campi
query

string

Obbligatorio. La query in base alla quale i record vengono classificati e valutati.

titleTemplate

string

Facoltativo. Il modello utilizzato per generare il titolo del record.

contentTemplate

string

Facoltativo. Il modello utilizzato per generare i contenuti del record.

model

string

Obbligatorio. Il modello utilizzato per classificare i documenti. Se non viene specificato alcun modello, viene utilizzato semantic-ranker-default@latest.