Recherche dans les documents d'un seul datastore.
Renvoie des segments de sous-documents classés, chacun renvoyant au document d'origine et contenant la provenance nécessaire pour le citer.
Requête HTTP
POST https://vectorsearch.googleapis.com/v1beta/{parent}/documents:search
Paramètres de chemin d'accès
| Paramètres | |
|---|---|
parent |
Obligatoire. Le datastore dans lequel effectuer la recherche. Format : |
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
| Représentation JSON |
|---|
{ "topK": integer, "documentIds": [ string ], "rankingSpec": { object ( |
| Champs | |
|---|---|
topK |
Facultatif. Nombre de résultats à renvoyer. Valeur par défaut : 10 Les valeurs supérieures à 100 sont réduites à 100. |
documentIds[] |
Facultatif. Limitez la recherche à ces ID de document. 100 max. Si ce champ est vide, l'intégralité du datastore est recherchée. |
rankingSpec |
Facultatif. Contrôle le classement des résultats. |
filter |
Facultatif. Limite la recherche aux segments correspondant à ce filtre, un objet JSON sur les chemins d'accès aux champs d'un
Comparaisons : {"$and": [{"metadata.year": {"$gte": 2025}}, {"unstructured_details.page_range.start_page": {"$lte": 20}}]} |
outputFields |
Facultatif. Champs à renvoyer pour chaque résultat. |
| Obligatoire. Requête à rechercher. Vous devez définir un seul type de requête. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : | |
textQuery |
Une requête textuelle. |
| Fin des champs mutuellement exclusifs. | |
Corps de la réponse
Message de réponse pour DocumentSearchService.SearchDocuments.
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 ( |
| Champs | |
|---|---|
results[] |
Uniquement en sortie. Segments de document correspondant aux critères de recherche, classés par pertinence. |
warnings[] |
Uniquement en sortie. Avertissements ou erreurs non fatales survenus lors de l'exécution. |
Niveaux d'accès des autorisations
Nécessite l'un des niveaux d'accès OAuth suivants :
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/vectorsearchhttps://www.googleapis.com/auth/vectorsearch.readonly
Pour plus d'informations, consultez la Authentication Overview.
TextQuery
Une requête textuelle.
| Représentation JSON |
|---|
{ "text": string } |
| Champs | |
|---|---|
text |
Obligatoire. Texte à rechercher. |
RankingSpec
Contrôle le classement des résultats.
| Représentation JSON |
|---|
{
"rerankingSpec": {
object ( |
| Champs | |
|---|---|
rerankingSpec |
Facultatif. Contrôle l'étape de reclassement. |
RerankingSpec
Configuration du reclassement sémantique appliqué aux résultats candidats après la récupération hybride et la fusion de classement réciproque (RRF).
| Représentation JSON |
|---|
{ "enabled": boolean, "rankOversamplingFactor": integer } |
| Champs | |
|---|---|
enabled |
Facultatif. Indique si les résultats fusionnés doivent être reclassés. La valeur par défaut est "false" : les résultats sont renvoyés dans l'ordre de fusion RRF, sauf si l'appelant active l'option. Lorsqu'il est activé, le reclassement utilise Non compatible avec un datastore |
rankOversamplingFactor |
Facultatif. Facteur de suréchantillonnage des candidats avant le reclassement. Le nombre total de candidats récupérés pour le reclassement est de Ignoré, sauf si Pour reclasser sans suréchantillonnage, définissez ce champ sur 1. |
OutputFields
Champs à renvoyer pour chaque DocumentSearchResult, en plus de ceux que chaque résultat comporte.
| Représentation JSON |
|---|
{ "metadata": [ string ] } |
| Champs | |
|---|---|
metadata[] |
Facultatif. Propriétés de métadonnées à renvoyer dans |
DocumentSearchResult
Un seul segment correspondant d'un document.
| Représentation JSON |
|---|
{ "document": { object ( |
| Champs | |
|---|---|
document |
Uniquement en sortie. Le document d'où provient ce segment, y compris son nom de ressource et l'emplacement Cloud Storage d'où il a été ingéré. Notez que tous les champs du document ne sont pas renseignés. Pour obtenir le document complet, appelez documents.get sur le nom du document renvoyé. |
Détails de l'emplacement du segment dans son document. Le champ défini suit le document_type du DataStore parent. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : |
|
videoDetails |
Définissez ce paramètre lorsque le |
unstructuredDetails |
Définissez ce paramètre lorsque le |
| Fin des champs mutuellement exclusifs. | |
VideoSegmentDetails
Localise un segment dans un document vidéo.
| Représentation JSON |
|---|
{ "startOffset": string, "endOffset": string } |
| Champs | |
|---|---|
startOffset |
Uniquement en sortie. Début de ce segment par rapport au début de la vidéo source. Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par " |
endOffset |
Uniquement en sortie. Fin de ce segment, par rapport au début de la vidéo source. Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par " |
UnstructuredSegmentDetails
Localise un segment dans un document non structuré et contient son texte.
| Représentation JSON |
|---|
{
"contentSnippet": string,
"pageRange": {
object ( |
| Champs | |
|---|---|
contentSnippet |
Uniquement en sortie. Contenu textuel du segment. |
pageRange |
Uniquement en sortie. Emplacement du segment dans le document source. Définissez cette option pour les fichiers PDF, PowerPoint et Excel, où une page correspond à une page PDF, une diapositive ou une feuille. Pour les fichiers HTML, en texte brut, Markdown, JSON, XML et Word, définissez cette option uniquement lorsque le fichier est divisé en pages ( |
PageRange
Une plage de pages dans le document source. Les pages sont basées sur 1 et la plage est inclusive. Une seule page est représentée par startPage == endPage.
| Représentation JSON |
|---|
{ "startPage": string, "endPage": string } |
| Champs | |
|---|---|
startPage |
Uniquement en sortie. Première page de la plage. |
endPage |
Uniquement en sortie. Dernière page de la plage. |