Method: projects.locations.collections.dataObjects.batchSearch

Recherche par lot des objets de données.

Requête HTTP

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

Paramètres de chemin

Paramètres
parent

string

Obligatoire. Nom de ressource de la collection dans laquelle effectuer la recherche. Format : projects/{project}/locations/{location}/collections/{collection}

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "searches": [
    {
      object (Search)
    }
  ],
  "combine": {
    object (CombineResultsOptions)
  }
}
Champs
searches[]

object (Search)

Obligatoire. Liste des requêtes de recherche à exécuter en parallèle.
combine

object (CombineResultsOptions)

Facultatif. Options permettant de combiner les résultats des opérations de recherche par lot.

Corps de la réponse

Réponse à une opération de recherche par lot.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "results": [
    {
      object (SearchDataObjectsResponse)
    }
  ]
}
Champs
results[]

object (SearchDataObjectsResponse)

Uniquement en sortie. Liste des réponses de recherche, une pour chaque requête du lot. Si un classificateur est utilisé, une seule liste classée de résultats est renvoyée.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • vectorsearch.dataObjects.search

Pour en savoir plus, consultez la documentation IAM.

CombineResultsOptions

Options permettant de combiner les résultats des opérations de recherche par lot.

Représentation JSON 
{
  "ranker": {
    object (Ranker)
  },
  "outputFields": {
    object (OutputFields)
  },
  "topK": integer
}
Champs
ranker

object (Ranker)

Obligatoire. Classeur à utiliser pour combiner les résultats.
outputFields

object (OutputFields)

Facultatif. Masque spécifiant les champs à renvoyer.
topK

integer

Facultatif. Nombre de résultats à renvoyer. Si aucune valeur n'est définie, une valeur par défaut sera utilisée.

Ranker

Définit un classificateur pour combiner les résultats de plusieurs recherches.

Représentation 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.
}
Champs
Champ d'union ranker. Méthode de classement à utiliser. ranker ne peut être qu'un des éléments suivants :
rrf

object (ReciprocalRankFusion)

Classement par fusion de classement réciproque.
Champ d'union reranker. Reranker à utiliser pour le classement final des résultats combinés par le ranker. reranker ne peut être qu'un des éléments suivants :
vertexRanker

object (VertexRanker)

Facultatif. Vertex AI Ranking

ReciprocalRankFusion

Définit l'algorithme de fusion de classement réciproque (RRF) pour le classement des résultats.

Représentation JSON 
{
  "weights": [
    number
  ]
}
Champs
weights[]

number

Obligatoire. Pondérations à appliquer à chaque ensemble de résultats de recherche lors de la fusion.

VertexRanker

Définit un classificateur à l'aide du service de classement Vertex AI. Pour en savoir plus, consultez https://cloud.google.com/generative-ai-app-builder/docs/ranking.

Représentation 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.
}
Champs
model

string

Obligatoire. Modèle utilisé pour classer les documents. La liste des modèles disponibles est décrite sur la page https://docs.cloud.google.com/generative-ai-app-builder/docs/ranking#models. Pour le moment, seul le format semantic-ranker-fast@latest est compatible.
topN

integer

Obligatoire. Nombre de documents à traiter pour le classement.
Champ d'union record_spec. Spécification d'enregistrement pour le classement. Vous devez définir au moins une spécification d'enregistrement. record_spec ne peut être qu'un des éléments suivants :
textRecordSpec

object (TextRecordSpec)

Spécification de l'enregistrement pour la recherche de texte.

TextRecordSpec

Spécification de l'enregistrement pour la recherche de texte.

Représentation JSON 
{
  "query": string,
  "titleTemplate": string,
  "contentTemplate": string
}
Champs
query

string

Obligatoire. Requête par rapport à laquelle les enregistrements sont classés et notés.
titleTemplate

string

Facultatif. Modèle utilisé pour générer le titre de l'enregistrement.
contentTemplate

string

Facultatif. Modèle utilisé pour générer le contenu de l'enregistrement.