Partager via

Documents - Search Post

Service:
Search Service
Version d'API:
2025-09-01

Recherche de documents dans l’index.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2025-09-01

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
 path True

string

URL du point de terminaison du service de recherche.
indexName
 path True

string

Nom de l’index.
api-version
 query True

string

Version de l’API cliente.

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-request-id

string (uuid)

ID de suivi envoyé avec la demande pour aider au débogage.

Corps de la demande

Nom Type Description
answers

QueryAnswerType

Valeur qui spécifie si les réponses doivent être renvoyées dans le cadre de la réponse de recherche.
captions

QueryCaptionType

Valeur qui spécifie si les sous-titres doivent être renvoyés dans le cadre de la réponse de recherche.
count

boolean

Valeur qui spécifie s’il faut extraire le nombre total de résultats. La valeur par défaut est false. La définition de cette valeur sur true peut avoir un impact sur les performances. Notez que le décompte renvoyé est une approximation.
debug

QueryDebugMode

Active un outil de débogage qui peut être utilisé pour explorer davantage vos résultats reclassés.
facets

string[]

Liste des expressions de facette à appliquer à la requête de recherche. Chaque expression de facette contient un nom de champ, éventuellement suivi d’une liste de paires nom :valeur séparées par des virgules.
filter

string

Expression $filter OData à appliquer à la requête de recherche.
highlight

string

Liste des noms de champs séparés par des virgules à utiliser pour les surbrillances des accès. Seuls les champs pouvant faire l’objet d’une recherche peuvent être utilisés pour la mise en évidence des occurrences.
highlightPostTag

string

Une balise de chaîne qui est ajoutée aux points forts des hits. Doit être défini avec highlightPreTag. La valeur par défaut est </em>.
highlightPreTag

string

Une balise de chaîne qui est ajoutée pour frapper les points forts. Doit être défini avec highlightPostTag. La valeur par défaut est <em>.
minimumCoverage

number (double)

Nombre compris entre 0 et 100 indiquant le pourcentage de l’index qui doit être couvert par une requête de recherche pour que celle-ci soit signalée comme réussie. Ce paramètre peut être utile pour garantir la disponibilité de la recherche, même pour les services ne comportant qu’un seul réplica. La valeur par défaut est 100.
orderby

string

Liste des expressions OData $orderby séparées par des virgules permettant de trier les résultats. Chaque expression peut être soit un nom de champ, soit un appel aux fonctions geo.distance() ou search.score(). Chaque expression peut être suivie de asc pour indiquer l’ascendant, ou de desc pour indiquer la descendance. La valeur par défaut est l’ordre croissant. Les égalités seront brisées par les scores de match des documents. Si aucun $orderby n’est spécifié, l’ordre de tri par défaut est décroissant en fonction du score de correspondance du document. Il peut y avoir au plus 32 clauses $orderby.
queryType

QueryType

Valeur qui spécifie la syntaxe de la requête de recherche. La valeur par défaut est 'simple'. Utilisez 'full' si votre requête utilise la syntaxe de requête Lucene.
scoringParameters

string[]

Liste des valeurs de paramètre à utiliser dans les fonctions de scoring (par exemple, referencePointParameter) à l’aide du format name-values. Par exemple, si le profil de scoring définit une fonction avec un paramètre appelé 'mylocation', la chaîne de paramètre sera « mylocation--122.2,44.8 » (sans les guillemets).
scoringProfile

string

Nom d’un profil de notation permettant d’évaluer les scores de correspondance des documents correspondants afin de trier les résultats.
scoringStatistics

ScoringStatistics

Valeur qui spécifie si nous voulons calculer les statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence plus faible. La valeur par défaut est 'local'. Utilisez « global » pour agréger les statistiques de score globales avant de marquer. L’utilisation de statistiques de score globales peut augmenter la latence des requêtes de recherche.
search

string

Une expression de requête de recherche en texte intégral ; Utilisez « * » ou omettez ce paramètre pour correspondre à tous les documents.
searchFields

string

Liste des noms de champs séparés par des virgules auxquels la recherche en texte intégral doit être portée. Lors de l’utilisation de la recherche par champs (fieldName :searchExpression) dans une requête Lucene complète, les noms de champ de chaque expression de recherche par champ sont prioritaires sur les noms de champ répertoriés dans ce paramètre.
searchMode

SearchMode

Valeur qui spécifie si l’un ou l’ensemble des termes de recherche doivent être mis en correspondance pour que le document soit considéré comme une correspondance.
select

string

Liste des champs à récupérer, séparés par des virgules. S’ils ne sont pas spécifiés, tous les champs marqués comme récupérables dans le schéma sont inclus.
semanticConfiguration

string

Nom d’une configuration sémantique qui sera utilisée lors du traitement des documents pour les requêtes de type sémantique.
semanticErrorHandling

SemanticErrorMode

Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement (comportement par défaut / actuel) ou renvoyer des résultats partiels.
semanticMaxWaitInMilliseconds

integer (int32)

minimum: 700

Permet à l’utilisateur de définir une limite supérieure sur le temps nécessaire à l’enrichissement sémantique pour terminer le traitement avant l’échec de la demande.
semanticQuery

string

Permet de définir une requête de recherche distincte qui sera utilisée uniquement pour le reclassement sémantique, les légendes sémantiques et les réponses sémantiques. Est utile pour les scénarios où il est nécessaire d’utiliser des requêtes différentes entre la phase d’extraction de base et de classement, et la phase sémantique L2.
sessionId

string

Valeur à utiliser pour créer une session post-it, ce qui peut aider à obtenir des résultats plus cohérents. Tant que le même sessionId est utilisé, une tentative de ciblage du même jeu de réplicas est effectuée. N’oubliez pas que la réutilisation répétée des mêmes valeurs sessionID peut interférer avec l’équilibrage de charge des demandes entre les réplicas et nuire aux performances du service de recherche. La valeur utilisée comme sessionId ne peut pas commencer par un caractère '_'.
skip

integer (int32)

Le nombre de résultats de recherche à ignorer. Cette valeur ne peut pas être supérieure à 100 000. Si vous devez numériser des documents dans l’ordre, mais que vous ne pouvez pas utiliser skip en raison de cette limitation, envisagez d’utiliser orderby sur une clé totalement ordonnée et filtrez avec une requête de plage à la place.
top

integer (int32)

Le nombre de résultats de recherche à récupérer. Cela peut être utilisé conjointement avec $skip pour implémenter la pagination côté client des résultats de recherche. Si les résultats sont tronqués en raison de la pagination côté serveur, la réponse inclut un jeton de continuation qui peut être utilisé pour émettre une autre demande de recherche pour la page de résultats suivante.
vectorFilterMode

VectorFilterMode

Détermine si des filtres sont appliqués avant ou après l’exécution de la recherche vectorielle. La valeur par défaut est 'preFilter' pour les nouveaux index.
vectorQueries VectorQuery[]:

Paramètres de requête pour les requêtes de recherche vectorielle et hybride.

Réponses

Nom Type Description
200 OK

SearchDocumentsResult

Réponse contenant des documents qui correspondent aux critères de recherche.
Other Status Codes

SearchDocumentsResult

Réponse contenant des documents partiels qui correspondent aux critères de recherche.
Other Status Codes

ErrorResponse

Réponse d’erreur.

Exemples

SearchIndexSearchDocumentsPost
SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Exemple de requête

POST https://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.search?api-version=2025-09-01


{
  "count": true,
  "facets": [
    "ownerId"
  ],
  "filter": "category eq 'purple' or category eq 'pink'",
  "highlight": "category",
  "highlightPostTag": "</em>",
  "highlightPreTag": "</em>",
  "minimumCoverage": 100,
  "queryType": "semantic",
  "scoringStatistics": "global",
  "sessionId": "mysessionid",
  "scoringParameters": [
    "categoryTag:desiredCategoryValue"
  ],
  "scoringProfile": "stringFieldBoost",
  "debug": "vector",
  "search": "purple",
  "searchFields": "id,name,description,category,ownerId",
  "searchMode": "any",
  "select": "id,name,description,category,ownerId",
  "skip": 0,
  "top": 10,
  "semanticConfiguration": "testconfig",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 5000,
  "semanticQuery": "find all purple",
  "answers": "extractive",
  "captions": "extractive",
  "vectorQueries": [
    {
      "vector": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9
      ],
      "kind": "vector",
      "k": 50,
      "fields": "vector22, vector1b",
      "exhaustive": true,
      "weight": 1
    }
  ],
  "vectorFilterMode": "preFilter"
}

Exemple de réponse

Code d’état:
200 
{
  "@odata.count": 42,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 26,
        "value": "sam"
      },
      {
        "count": 12,
        "value": "ryan"
      },
      {
        "count": 4,
        "value": "benny"
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.04419642686843872,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.3862943649291992
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00011109876504633576,
                  "vectorSimilarity": 94.86833055544514
                },
                "vector1b": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                }
              }
            ]
          }
        }
      },
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.012820512987673283,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.0779930353164673
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011627906933426857,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0431547611951828,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00017358097829855978,
                  "vectorSimilarity": 75.89466323761327
                },
                "vector1b": {
                  "searchScore": 0.0005099439295008779,
                  "vectorSimilarity": 44.27188622909418
                }
              }
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04460374265909195,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00020656888955272734,
                  "vectorSimilarity": 69.5701087211589
                },
                "vector1b": {
                  "searchScore": 0.0006939625018276274,
                  "vectorSimilarity": 37.947332584023194
                }
              }
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.042533937841653824,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00015997439913917333,
                  "vectorSimilarity": 79.0569427290381
                },
                "vector1b": {
                  "searchScore": 0.0004442470089998096,
                  "vectorSimilarity": 47.43416449302081
                }
              }
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04651741310954094,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.9616584777832031
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00013715539535041898,
                  "vectorSimilarity": 85.38149735825786
                },
                "vector1b": {
                  "searchScore": 0.00034590106224641204,
                  "vectorSimilarity": 53.758721003860366
                }
              }
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04703196510672569,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.0779930353164673
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                },
                "vector1b": {
                  "searchScore": 0.0009990009712055326,
                  "vectorSimilarity": 31.622777042048124
                }
              }
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.043300654739141464,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.1507283449172974
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00012753476039506495,
                  "vectorSimilarity": 88.5437719937623
                },
                "vector1b": {
                  "searchScore": 0.0003085467324126512,
                  "vectorSimilarity": 56.92099902893652
                }
              }
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04082724079489708,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "test11 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00010404744534753263,
                  "vectorSimilarity": 98.03060760075451
                },
                "vector1b": {
                  "searchScore": 0.00022670596081297845,
                  "vectorSimilarity": 66.40783109116562
                }
              }
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}
Code d’état:
206 
{
  "@odata.count": 42,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 26,
        "value": "sam"
      },
      {
        "count": 12,
        "value": "ryan"
      },
      {
        "count": 4,
        "value": "benny"
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.04419642686843872,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.3862943649291992
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00011109876504633576,
                  "vectorSimilarity": 94.86833055544514
                },
                "vector1b": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                }
              }
            ]
          }
        }
      },
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.012820512987673283,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.0779930353164673
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011627906933426857,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0431547611951828,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00017358097829855978,
                  "vectorSimilarity": 75.89466323761327
                },
                "vector1b": {
                  "searchScore": 0.0005099439295008779,
                  "vectorSimilarity": 44.27188622909418
                }
              }
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04460374265909195,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00020656888955272734,
                  "vectorSimilarity": 69.5701087211589
                },
                "vector1b": {
                  "searchScore": 0.0006939625018276274,
                  "vectorSimilarity": 37.947332584023194
                }
              }
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.042533937841653824,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00015997439913917333,
                  "vectorSimilarity": 79.0569427290381
                },
                "vector1b": {
                  "searchScore": 0.0004442470089998096,
                  "vectorSimilarity": 47.43416449302081
                }
              }
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04651741310954094,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.9616584777832031
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00013715539535041898,
                  "vectorSimilarity": 85.38149735825786
                },
                "vector1b": {
                  "searchScore": 0.00034590106224641204,
                  "vectorSimilarity": 53.758721003860366
                }
              }
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04703196510672569,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.0779930353164673
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                },
                "vector1b": {
                  "searchScore": 0.0009990009712055326,
                  "vectorSimilarity": 31.622777042048124
                }
              }
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.043300654739141464,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.1507283449172974
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00012753476039506495,
                  "vectorSimilarity": 88.5437719937623
                },
                "vector1b": {
                  "searchScore": 0.0003085467324126512,
                  "vectorSimilarity": 56.92099902893652
                }
              }
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04082724079489708,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "test11 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00010404744534753263,
                  "vectorSimilarity": 98.03060760075451
                },
                "vector1b": {
                  "searchScore": 0.00022670596081297845,
                  "vectorSimilarity": 66.40783109116562
                }
              }
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

SearchIndexSearchDocumentsSemanticPost

Exemple de requête

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-09-01

{
  "count": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "queryType": "semantic",
  "search": "how do clouds form",
  "semanticConfiguration": "my-semantic-config",
  "answers": "extractive|count-3",
  "captions": "extractive|highlight-true",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 780
}

Exemple de réponse

Code d’état:
200 
{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-07-01"
}
Code d’état:
206 
{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-07-01"
}

Définitions

Nom Description
AnswerResult

Une réponse est un passage de texte extrait du contenu des documents les plus pertinents qui correspondaient à la requête. Les réponses sont extraites des premiers résultats de recherche. Les candidats sont notés et les meilleures réponses sont sélectionnées.
CaptionResult

Les légendes sont les passages les plus représentatifs du document par rapport à la requête de recherche. Ils sont souvent utilisés comme résumé de document. Les légendes ne sont renvoyées que pour les requêtes de type semantic.
DocumentDebugInfo

Contient des informations de débogage qui peuvent être utilisées pour explorer davantage vos résultats de recherche.
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
QueryAnswerType

Valeur qui spécifie si les réponses doivent être renvoyées dans le cadre de la réponse de recherche.
QueryCaptionType

Valeur qui spécifie si les sous-titres doivent être renvoyés dans le cadre de la réponse de recherche.
QueryDebugMode

Active un outil de débogage qui peut être utilisé pour explorer davantage vos résultats de recherche.
QueryResultDocumentSubscores

Répartition des sous-scores entre les composants de requête textuelle et vectorielle de la requête de recherche pour ce document. Chaque requête vectorielle est affichée en tant qu’objet distinct dans le même ordre qu’elle a été reçue.
QueryType

Spécifie la syntaxe de la requête de recherche. La valeur par défaut est 'simple'. Utilisez 'full' si votre requête utilise la syntaxe de requête Lucene.
RawVectorQuery

Paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur vectorielle brute est fournie.
ScoringStatistics

Valeur qui spécifie si nous voulons calculer les statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence plus faible. La valeur par défaut est 'local'. Utilisez « global » pour agréger les statistiques de score globales avant de marquer. L’utilisation de statistiques de score globales peut augmenter la latence des requêtes de recherche.
SearchDocumentsResult

Réponse contenant les résultats de recherche d’un index.
SearchMode

Spécifie si l’un ou l’ensemble des termes de recherche doivent être mis en correspondance pour que le document soit considéré comme une correspondance.
SearchRequest

Paramètres de filtrage, de tri, de facettage, de pagination et d’autres comportements de requête de recherche.
SearchResult

Contient un document trouvé par une requête de recherche, ainsi que les métadonnées associées.
SemanticErrorMode

Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement (comportement par défaut / actuel) ou renvoyer des résultats partiels.
SemanticErrorReason

Raison pour laquelle une réponse partielle a été renvoyée pour une demande de classement sémantique.
SemanticSearchResultsType

Type de réponse partielle renvoyée pour une demande de classement sémantique.
SingleVectorFieldResult

Un seul résultat de champ vectoriel. Les valeurs @search.score de similarité vectorielle et les valeurs de similarité vectorielle sont renvoyées. La similarité vectorielle est liée à @search.score une équation.
TextResult

Le score BM25 ou Classic pour la partie texte de la requête.
VectorFilterMode

Détermine si des filtres sont appliqués avant ou après l’exécution de la recherche vectorielle.
VectorizableTextQuery

Paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur de texte qui doit être vectorisée est fournie.
VectorQueryKind

Type de requête vectorielle en cours d’exécution.
VectorsDebugInfo

AnswerResult

Object

Une réponse est un passage de texte extrait du contenu des documents les plus pertinents qui correspondaient à la requête. Les réponses sont extraites des premiers résultats de recherche. Les candidats sont notés et les meilleures réponses sont sélectionnées.

Nom Type Description
highlights

string

Même passage de texte que dans la propriété Text avec les expressions de texte en surbrillance les plus pertinentes pour la requête.
key

string

La clé du document d’où la réponse a été extraite.
score

number (double)

La valeur de score représente la pertinence de la réponse par rapport à la requête par rapport aux autres réponses renvoyées pour la requête.
text

string

Le passage de texte extrait du contenu du document comme réponse.

CaptionResult

Object

Les légendes sont les passages les plus représentatifs du document par rapport à la requête de recherche. Ils sont souvent utilisés comme résumé de document. Les légendes ne sont renvoyées que pour les requêtes de type semantic.

Nom Type Description
highlights

string

Même passage de texte que dans la propriété Text avec les expressions en surbrillance les plus pertinentes pour la requête.
text

string

Passage de texte représentatif extrait du document le plus pertinent pour la requête de recherche.

DocumentDebugInfo

Object

Contient des informations de débogage qui peuvent être utilisées pour explorer davantage vos résultats de recherche.

Nom Type Description
vectors

VectorsDebugInfo

Contient des informations de débogage spécifiques à la recherche vectorielle et hybride.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.
type

string

Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d’erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

QueryAnswerType

Énumération

Valeur qui spécifie si les réponses doivent être renvoyées dans le cadre de la réponse de recherche.

Valeur Description
none

Ne renvoyez pas de réponses à la requête.
extractive

Extraits de réponses des candidats à partir du contenu des documents renvoyés en réponse à une requête exprimée sous forme de question en langage naturel.

QueryCaptionType

Énumération

Valeur qui spécifie si les sous-titres doivent être renvoyés dans le cadre de la réponse de recherche.

Valeur Description
none

Ne renvoyez pas de sous-titres pour la requête.
extractive

Extrait les légendes des documents correspondants qui contiennent des passages pertinents pour la requête de recherche.

QueryDebugMode

Énumération

Active un outil de débogage qui peut être utilisé pour explorer davantage vos résultats de recherche.

Valeur Description
disabled

Aucune information de débogage de requête n’est renvoyée.
vector

Permet à l’utilisateur d’explorer davantage les résultats de ses requêtes hybrides et vectorielles.

QueryResultDocumentSubscores

Object

Répartition des sous-scores entre les composants de requête textuelle et vectorielle de la requête de recherche pour ce document. Chaque requête vectorielle est affichée en tant qu’objet distinct dans le même ordre qu’elle a été reçue.

Nom Type Description
documentBoost

number (double)

Le score BM25 ou Classic pour la partie texte de la requête.
text

TextResult

Le score BM25 ou Classic pour la partie texte de la requête.
vectors

<string,  SingleVectorFieldResult>

La similarité vectorielle et @search.score les valeurs de chaque requête vectorielle.

QueryType

Énumération

Spécifie la syntaxe de la requête de recherche. La valeur par défaut est 'simple'. Utilisez 'full' si votre requête utilise la syntaxe de requête Lucene.

Valeur Description
simple

Utilise la syntaxe de requête simple pour les recherches. Le texte de recherche est interprété à l’aide d’un langage de requête simple qui autorise l’utilisation de symboles tels que +, * et «  ». Par défaut, les requêtes sont évaluées dans tous les champs pouvant faire l’objet d’une recherche, sauf si le paramètre searchFields est spécifié.
full

Utilise la syntaxe de requête Lucene complète pour les recherches. Le texte de recherche est interprété à l’aide du langage de requête Lucene qui permet des recherches spécifiques aux champs et pondérées, ainsi que d’autres fonctionnalités avancées.
semantic

Idéal pour les requêtes exprimées en langage naturel plutôt que pour les mots-clés. Améliore la précision des résultats de recherche en reclassant les premiers résultats de recherche à l’aide d’un modèle de classement entraîné sur le corpus Web.

RawVectorQuery

Object

Paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur vectorielle brute est fournie.

Nom Type Description
exhaustive

boolean

Lorsque la valeur est true, déclenche une recherche exhaustive des k plus proches voisins sur tous les vecteurs de l’index vectoriel. Utile pour les scénarios où des correspondances exactes sont essentielles, comme la détermination de valeurs de vérité terrain.
fields

string

Champs vectoriels de type Collection(Edm.Single) à inclure dans le vecteur recherché.
k

integer (int32)

Nombre de voisins les plus proches à renvoyer en tant que premiers résultats.
kind string:

vector

Type de requête vectorielle en cours d’exécution.
oversampling

number (double)

Facteur de suréchantillonnage. La valeur minimale est 1. Il remplace le paramètre 'defaultOversampling' configuré dans la définition de l’index. Il ne peut être défini que lorsque 'rerankWithOriginalVectors' est vrai. Ce paramètre n’est autorisé que lorsqu’une méthode de compression est utilisée sur le champ vectoriel sous-jacent.
vector

number[] (float)

Représentation vectorielle d’une requête de recherche.
weight

number (float)

Poids relatif de la requête vectorielle par rapport à d’autres requêtes vectorielles et/ou à la requête textuelle au sein de la même requête de recherche. Cette valeur est utilisée lors de la combinaison des résultats de plusieurs listes de classement produites par les différentes requêtes vectorielles et/ou des résultats récupérés par le biais de la requête textuelle. Plus le poids est élevé, plus les documents qui correspondent à cette requête seront élevés dans le classement final. La valeur par défaut est 1.0 et la valeur doit être un nombre positif supérieur à zéro.

ScoringStatistics

Énumération

Valeur qui spécifie si nous voulons calculer les statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence plus faible. La valeur par défaut est 'local'. Utilisez « global » pour agréger les statistiques de score globales avant de marquer. L’utilisation de statistiques de score globales peut augmenter la latence des requêtes de recherche.

Valeur Description
local

Les statistiques de score seront calculées localement pour réduire la latence.
global

Les statistiques de pointage seront calculées globalement pour un score plus cohérent.

SearchDocumentsResult

Object

Réponse contenant les résultats de recherche d’un index.

Nom Type Description
@odata.count

integer (int64)

Nombre total de résultats trouvés par l’opération de recherche, ou null si le nombre n’a pas été demandé. S’il y en a, le nombre peut être supérieur au nombre de résultats dans cette réponse. Cela peut se produire si vous utilisez les paramètres $top ou $skip, ou si la requête ne peut pas renvoyer tous les documents demandés en une seule réponse.
@odata.nextLink

string

URL de continuation renvoyée lorsque la requête ne peut pas retourner tous les résultats demandés dans une seule réponse. Vous pouvez utiliser cette URL pour formuler une autre requête de recherche GET ou POST afin d’obtenir la partie suivante de la réponse de recherche. Assurez-vous d’utiliser le même verbe (GET ou POST) que la requête qui a produit cette réponse.
@search.answers

AnswerResult[]

Les résultats de la requête de réponses pour l’opération de recherche ; null si le paramètre de requête Answers n’a pas été spécifié ou défini sur 'None'.
@search.coverage

number (double)

Valeur indiquant le pourcentage de l’index inclus dans la requête, ou null si minimumCoverage n’a pas été spécifié dans la demande.
@search.facets

object

Résultats de la recherche à facettes pour l’opération de recherche, organisés sous la forme d’une collection de compartiments pour chaque champ à facettes ; null si la requête n’incluait aucune expression de facette.
@search.nextPageParameters

SearchRequest

Charge utile JSON de continuation renvoyée lorsque la requête ne peut pas retourner tous les résultats demandés dans une seule réponse. Vous pouvez utiliser ce JSON avec @odata.nextLink pour formuler une autre requête de recherche POST afin d’obtenir la partie suivante de la réponse de recherche.
@search.semanticPartialResponseReason

SemanticErrorReason

Raison pour laquelle une réponse partielle a été renvoyée pour une demande de classement sémantique.
@search.semanticPartialResponseType

SemanticSearchResultsType

Type de réponse partielle renvoyée pour une demande de classement sémantique.
value

SearchResult[]

Séquence des résultats renvoyés par la requête.

SearchMode

Énumération

Spécifie si l’un ou l’ensemble des termes de recherche doivent être mis en correspondance pour que le document soit considéré comme une correspondance.

Valeur Description
any

Tous les termes de recherche doivent correspondre pour que le document soit considéré comme une correspondance.
all

Tous les termes de recherche doivent correspondre pour que le document soit considéré comme une correspondance.

SearchRequest

Object

Paramètres de filtrage, de tri, de facettage, de pagination et d’autres comportements de requête de recherche.

Nom Type Description
answers

QueryAnswerType

Valeur qui spécifie si les réponses doivent être renvoyées dans le cadre de la réponse de recherche.
captions

QueryCaptionType

Valeur qui spécifie si les sous-titres doivent être renvoyés dans le cadre de la réponse de recherche.
count

boolean

Valeur qui spécifie s’il faut extraire le nombre total de résultats. La valeur par défaut est false. La définition de cette valeur sur true peut avoir un impact sur les performances. Notez que le décompte renvoyé est une approximation.
debug

QueryDebugMode

Active un outil de débogage qui peut être utilisé pour explorer davantage vos résultats reclassés.
facets

string[]

Liste des expressions de facette à appliquer à la requête de recherche. Chaque expression de facette contient un nom de champ, éventuellement suivi d’une liste de paires nom :valeur séparées par des virgules.
filter

string

Expression $filter OData à appliquer à la requête de recherche.
highlight

string

Liste des noms de champs séparés par des virgules à utiliser pour les surbrillances des accès. Seuls les champs pouvant faire l’objet d’une recherche peuvent être utilisés pour la mise en évidence des occurrences.
highlightPostTag

string

Une balise de chaîne qui est ajoutée aux points forts des hits. Doit être défini avec highlightPreTag. La valeur par défaut est </em>.
highlightPreTag

string

Une balise de chaîne qui est ajoutée pour frapper les points forts. Doit être défini avec highlightPostTag. La valeur par défaut est <em>.
minimumCoverage

number (double)

Nombre compris entre 0 et 100 indiquant le pourcentage de l’index qui doit être couvert par une requête de recherche pour que celle-ci soit signalée comme réussie. Ce paramètre peut être utile pour garantir la disponibilité de la recherche, même pour les services ne comportant qu’un seul réplica. La valeur par défaut est 100.
orderby

string

Liste des expressions OData $orderby séparées par des virgules permettant de trier les résultats. Chaque expression peut être soit un nom de champ, soit un appel aux fonctions geo.distance() ou search.score(). Chaque expression peut être suivie de asc pour indiquer l’ascendant, ou de desc pour indiquer la descendance. La valeur par défaut est l’ordre croissant. Les égalités seront brisées par les scores de match des documents. Si aucun $orderby n’est spécifié, l’ordre de tri par défaut est décroissant en fonction du score de correspondance du document. Il peut y avoir au plus 32 clauses $orderby.
queryType

QueryType

Valeur qui spécifie la syntaxe de la requête de recherche. La valeur par défaut est 'simple'. Utilisez 'full' si votre requête utilise la syntaxe de requête Lucene.
scoringParameters

string[]

Liste des valeurs de paramètre à utiliser dans les fonctions de scoring (par exemple, referencePointParameter) à l’aide du format name-values. Par exemple, si le profil de scoring définit une fonction avec un paramètre appelé 'mylocation', la chaîne de paramètre sera « mylocation--122.2,44.8 » (sans les guillemets).
scoringProfile

string

Nom d’un profil de notation permettant d’évaluer les scores de correspondance des documents correspondants afin de trier les résultats.
scoringStatistics

ScoringStatistics

Valeur qui spécifie si nous voulons calculer les statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence plus faible. La valeur par défaut est 'local'. Utilisez « global » pour agréger les statistiques de score globales avant de marquer. L’utilisation de statistiques de score globales peut augmenter la latence des requêtes de recherche.
search

string

Une expression de requête de recherche en texte intégral ; Utilisez « * » ou omettez ce paramètre pour correspondre à tous les documents.
searchFields

string

Liste des noms de champs séparés par des virgules auxquels la recherche en texte intégral doit être portée. Lors de l’utilisation de la recherche par champs (fieldName :searchExpression) dans une requête Lucene complète, les noms de champ de chaque expression de recherche par champ sont prioritaires sur les noms de champ répertoriés dans ce paramètre.
searchMode

SearchMode

Valeur qui spécifie si l’un ou l’ensemble des termes de recherche doivent être mis en correspondance pour que le document soit considéré comme une correspondance.
select

string

Liste des champs à récupérer, séparés par des virgules. S’ils ne sont pas spécifiés, tous les champs marqués comme récupérables dans le schéma sont inclus.
semanticConfiguration

string

Nom d’une configuration sémantique qui sera utilisée lors du traitement des documents pour les requêtes de type sémantique.
semanticErrorHandling

SemanticErrorMode

Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement (comportement par défaut / actuel) ou renvoyer des résultats partiels.
semanticMaxWaitInMilliseconds

integer (int32)

minimum: 700

Permet à l’utilisateur de définir une limite supérieure sur le temps nécessaire à l’enrichissement sémantique pour terminer le traitement avant l’échec de la demande.
semanticQuery

string

Permet de définir une requête de recherche distincte qui sera utilisée uniquement pour le reclassement sémantique, les légendes sémantiques et les réponses sémantiques. Est utile pour les scénarios où il est nécessaire d’utiliser des requêtes différentes entre la phase d’extraction de base et de classement, et la phase sémantique L2.
sessionId

string

Valeur à utiliser pour créer une session post-it, ce qui peut aider à obtenir des résultats plus cohérents. Tant que le même sessionId est utilisé, une tentative de ciblage du même jeu de réplicas est effectuée. N’oubliez pas que la réutilisation répétée des mêmes valeurs sessionID peut interférer avec l’équilibrage de charge des demandes entre les réplicas et nuire aux performances du service de recherche. La valeur utilisée comme sessionId ne peut pas commencer par un caractère '_'.
skip

integer (int32)

Le nombre de résultats de recherche à ignorer. Cette valeur ne peut pas être supérieure à 100 000. Si vous devez numériser des documents dans l’ordre, mais que vous ne pouvez pas utiliser skip en raison de cette limitation, envisagez d’utiliser orderby sur une clé totalement ordonnée et filtrez avec une requête de plage à la place.
top

integer (int32)

Le nombre de résultats de recherche à récupérer. Cela peut être utilisé conjointement avec $skip pour implémenter la pagination côté client des résultats de recherche. Si les résultats sont tronqués en raison de la pagination côté serveur, la réponse inclut un jeton de continuation qui peut être utilisé pour émettre une autre demande de recherche pour la page de résultats suivante.
vectorFilterMode

VectorFilterMode

Détermine si des filtres sont appliqués avant ou après l’exécution de la recherche vectorielle. La valeur par défaut est 'preFilter' pour les nouveaux index.
vectorQueries VectorQuery[]:

Paramètres de requête pour les requêtes de recherche vectorielle et hybride.

SearchResult

Object

Contient un document trouvé par une requête de recherche, ainsi que les métadonnées associées.

Nom Type Description
@search.captions

CaptionResult[]

Les légendes sont les passages les plus représentatifs du document par rapport à la requête de recherche. Ils sont souvent utilisés comme résumé de document. Les légendes ne sont renvoyées que pour les requêtes de type 'semantic'.
@search.documentDebugInfo

DocumentDebugInfo

Contient des informations de débogage qui peuvent être utilisées pour explorer davantage vos résultats de recherche.
@search.highlights

object

Fragments de texte du document indiquant les termes de recherche correspondants, organisés par chaque champ applicable ; null si la mise en surbrillance de l’accès n’a pas été activée pour la requête.
@search.rerankerBoostedScore

number (double)

Le score de pertinence calculé en augmentant le score Reranker. Les résultats de recherche sont triés en fonction de RerankerScore/RerankerBoostedScore en fonction de useScoringProfileBoostedRanking dans la configuration sémantique. RerankerBoostedScore n’est renvoyé que pour les requêtes de type 'semantic'
@search.rerankerScore

number (double)

Le score de pertinence calculé par le classeur sémantique pour les premiers résultats de recherche. Les résultats de recherche sont triés en fonction du RerankerScore d’abord, puis du Score. RerankerScore n’est renvoyé que pour les requêtes de type 'semantic'.
@search.score

number (double)

Le score de pertinence du document par rapport aux autres documents renvoyés par la requête.

SemanticErrorMode

Énumération

Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement (comportement par défaut / actuel) ou renvoyer des résultats partiels.

Valeur Description
partial

Si le traitement sémantique échoue, des résultats partiels sont toujours renvoyés. La définition des résultats partiels dépend de l’étape sémantique qui a échoué et de la raison de l’échec.
fail

S’il y a une exception lors de l’étape de traitement sémantique, la requête échoue et renvoie le code HTTP approprié en fonction de l’erreur.

SemanticErrorReason

Énumération

Raison pour laquelle une réponse partielle a été renvoyée pour une demande de classement sémantique.

Valeur Description
maxWaitExceeded

If semanticMaxWaitInMilliseconds était défini et que la durée du traitement sémantique dépassait cette valeur. Seuls les résultats de base ont été renvoyés.
capacityOverloaded

La demande a été étouffée. Seuls les résultats de base ont été renvoyés.
transient

Au moins une étape du processus sémantique a échoué.

SemanticSearchResultsType

Énumération

Type de réponse partielle renvoyée pour une demande de classement sémantique.

Valeur Description
baseResults

Résultats sans aucun enrichissement sémantique ni reclassement.
rerankedResults

Les résultats ont été reclassés avec le modèle de reclassement et incluront des légendes sémantiques. Ils n’incluront pas de réponses, de points forts de réponses ou de légendes.

SingleVectorFieldResult

Object

Un seul résultat de champ vectoriel. Les valeurs @search.score de similarité vectorielle et les valeurs de similarité vectorielle sont renvoyées. La similarité vectorielle est liée à @search.score une équation.

Nom Type Description
searchScore

number (double)

Valeur @search.score calculée à partir du score de similarité vectorielle. Il s’agit du score visible dans une requête à vecteur unique à champ unique.
vectorSimilarity

number (double)

Le score de similarité vectorielle pour ce document. Notez qu’il s’agit de la définition canonique de la métrique de similarité, et non de la version « distance ». Par exemple, similarité cosinusoïdale au lieu de distance cosinus.

TextResult

Object

Le score BM25 ou Classic pour la partie texte de la requête.

Nom Type Description
searchScore

number (double)

Le score BM25 ou Classic pour la partie texte de la requête.

VectorFilterMode

Énumération

Détermine si des filtres sont appliqués avant ou après l’exécution de la recherche vectorielle.

Valeur Description
postFilter

Le filtre sera appliqué une fois que l’ensemble candidat de résultats vectoriels sera renvoyé. En fonction de la sélectivité du filtre, cela peut donner moins de résultats que ce qui est demandé par le paramètre 'k'.
preFilter

Le filtre sera appliqué avant la requête de recherche.

VectorizableTextQuery

Object

Paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur de texte qui doit être vectorisée est fournie.

Nom Type Description
exhaustive

boolean

Lorsque la valeur est true, déclenche une recherche exhaustive des k plus proches voisins sur tous les vecteurs de l’index vectoriel. Utile pour les scénarios où des correspondances exactes sont essentielles, comme la détermination de valeurs de vérité terrain.
fields

string

Champs vectoriels de type Collection(Edm.Single) à inclure dans le vecteur recherché.
k

integer (int32)

Nombre de voisins les plus proches à renvoyer en tant que premiers résultats.
kind string:

text

Type de requête vectorielle en cours d’exécution.
oversampling

number (double)

Facteur de suréchantillonnage. La valeur minimale est 1. Il remplace le paramètre 'defaultOversampling' configuré dans la définition de l’index. Il ne peut être défini que lorsque 'rerankWithOriginalVectors' est vrai. Ce paramètre n’est autorisé que lorsqu’une méthode de compression est utilisée sur le champ vectoriel sous-jacent.
text

string

Texte à vectoriser pour effectuer une requête de recherche vectorielle.
weight

number (float)

Poids relatif de la requête vectorielle par rapport à d’autres requêtes vectorielles et/ou à la requête textuelle au sein de la même requête de recherche. Cette valeur est utilisée lors de la combinaison des résultats de plusieurs listes de classement produites par les différentes requêtes vectorielles et/ou des résultats récupérés par le biais de la requête textuelle. Plus le poids est élevé, plus les documents qui correspondent à cette requête seront élevés dans le classement final. La valeur par défaut est 1.0 et la valeur doit être un nombre positif supérieur à zéro.

VectorQueryKind

Énumération

Type de requête vectorielle en cours d’exécution.

Valeur Description
vector

Requête vectorielle dans laquelle une valeur vectorielle brute est fournie.
text

Requête vectorielle dans laquelle une valeur de texte qui doit être vectorisée est fournie.

VectorsDebugInfo

Object
Nom Type Description
subscores

QueryResultDocumentSubscores

La répartition des sous-scores du document avant la méthode de fusion/combinaison d’ensemble de résultats choisie, telle que RRF.