Documents - Search Post

Service:: Search Service

Version d'API:: 2023-10-01-Preview

Recherche des documents dans l’index.

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

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 faciliter le débogage.

Corps de la demande

Nom	Type	Description
answers	QueryAnswerType	Valeur qui spécifie si les réponses doivent être retournées dans le cadre de la réponse de recherche.
captions	QueryCaptionType	Valeur qui spécifie si les légendes doivent être retournées 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 nombre retourné 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 séparée par des virgules de paires name :value.
filter	string	L’expression OData $filter à appliquer à la requête de recherche.
highlight	string	Liste séparée par des virgules des noms de champs à utiliser pour les surbrillances d’accès. Seuls les champs pouvant faire l’objet d’une recherche peuvent être utilisés pour la mise en surbrillance des accès.
highlightPostTag	string	Balise de chaîne ajoutée aux surbrillances d’accès. Doit être défini avec highlightPreTag. La valeur par défaut est </em>.
highlightPreTag	string	Balise de chaîne qui est précédée de mises en surbrillance. 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 afin que la requête soit signalée comme une réussite. Ce paramètre peut être utile pour garantir la disponibilité de la recherche même pour les services avec un seul réplica. La valeur par défaut est 100.
orderby	string	Liste séparée par des virgules d’OData $orderby expressions par lesquelles trier les résultats. Chaque expression peut être un nom de champ ou un appel aux fonctions geo.distance() ou search.score(). Chaque expression peut être suivie d’asc pour indiquer l’ordre croissant ou desc pour indiquer l’ordre décroissant. La valeur par défaut est l’ordre croissant. Les liens seront rompus par les scores de correspondance des documents. Si aucune $orderby n’est spécifiée, l’ordre de tri par défaut descend par score de correspondance de document. Il peut y avoir au maximum 32 clauses $orderby.
queryLanguage	QueryLanguage	Valeur qui spécifie la langue de la requête de recherche.
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 des valeurs de nom de format. Par exemple, si le profil de scoring définit une fonction avec un paramètre appelé « mylocation », la chaîne de paramètre est « mylocation--122.2,44.8 » (sans les guillemets).
scoringProfile	string	Nom d’un profil de scoring pour évaluer les scores de correspondance pour les documents correspondants afin de trier les résultats.
scoringStatistics	ScoringStatistics	Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence inférieure. La valeur par défaut est « local ». Utilisez « global » pour agréger les statistiques de scoring globalement avant le scoring. L’utilisation des statistiques de scoring globales peut augmenter la latence des requêtes de recherche.
search	string	Expression de requête de recherche en texte intégral ; Utilisez « * » ou omettez ce paramètre pour faire correspondre tous les documents.
searchFields	string	Liste séparée par des virgules des noms de champs auxquels étendre la recherche en texte intégral. Lors de l’utilisation de la recherche fielded (fieldName :searchExpression) dans une requête Lucene complète, les noms de champs de chaque expression de recherche fielded sont prioritaires sur tous les noms de champs 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 compter le document comme correspondance.
select	string	Liste de champs séparés par des virgules à récupérer. S’il n’est pas spécifié, 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 de documents pour les requêtes sémantiques de type.
semanticErrorHandling	SemanticErrorMode	Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou retourner des résultats partiels (par défaut).
semanticFields	string	Liste séparée par des virgules des noms de champs utilisés pour le classement sémantique.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Permet à l’utilisateur de définir une limite supérieure sur la durée nécessaire à l’enrichissement sémantique pour terminer le traitement avant l’échec de la requête.
semanticQuery	string	Permet de définir une requête de recherche distincte qui sera utilisée uniquement pour la reranking 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 différentes requêtes entre la phase de récupération de base et de classement, et la phase sémantique L2.
sessionId	string	Valeur à utiliser pour créer une session sticky, qui peut vous aider à obtenir des résultats plus cohérents. Tant que le même id de session est utilisé, une tentative optimale sera effectuée pour cibler le même jeu de réplicas. Soyez prudent que la réutilisation des mêmes valeurs sessionID peut interférer à plusieurs reprises avec l’équilibrage de charge des requêtes entre les réplicas et affecter négativement les performances du service de recherche. La valeur utilisée en tant que sessionId ne peut pas commencer par un caractère '_'.
skip	integer (int32)	Nombre de résultats de recherche à ignorer. Cette valeur ne peut pas être supérieure à 100 000. Si vous avez besoin d’analyser des documents dans la séquence, mais que vous ne pouvez pas l’utiliser en raison de cette limitation, envisagez d’utiliser orderby sur une clé totalement ordonnée et filtrer avec une requête de plage à la place.
speller	QuerySpellerType	Valeur qui a spécifié le type de l’orthographique à utiliser pour corriger les termes de requête de recherche individuels.
top	integer (int32)	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 suivante des résultats.
vectorFilterMode	VectorFilterMode	Détermine si les filtres sont appliqués avant ou après l’exécution de la recherche vectorielle. La valeur par défaut est « preFilter ».
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	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	SearchError	Réponse d’erreur.

Exemples

SearchIndexSearchDocumentsPost

Exemple de requête

HTTP

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

{
  "count": true,
  "facets": [
    "category,count:10,sort:count"
  ],
  "filter": "rating gt 4.0",
  "highlight": "description",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": null,
  "orderby": "rating desc",
  "queryType": "simple",
  "scoringParameters": [
    "currentLocation--122.123,44.77233"
  ],
  "scoringProfile": "sp",
  "search": "nice hotels",
  "searchFields": "category,description",
  "searchMode": "any",
  "sessionId": "mysessionid",
  "scoringStatistics": "global",
  "select": "hotelId,description",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "kind": "vector",
      "vector": [
        0.103,
        0.0712,
        0.0852,
        0.1547,
        0.1183
      ],
      "fields": "descriptionEmbedding",
      "k": 5,
      "exhaustive": true
    }
  ],
  "vectorFilterMode": "preFilter"
}

Exemple de réponse

Code d’état:: 200

{
  "@odata.count": 25,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "@search.nextPageParameters": {
    "count": true,
    "facets": [
      "category,count:10,sort:count"
    ],
    "filter": "rating gt 4.0",
    "highlight": "title",
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "minimumCoverage": null,
    "orderby": "search.score() desc,rating desc",
    "queryType": "simple",
    "sessionId": "mysessionid",
    "scoringStatistics": "global",
    "scoringParameters": [
      "currentLocation--122.123,44.77233"
    ],
    "scoringProfile": "sp",
    "search": "nice hotels",
    "searchFields": "title,description",
    "searchMode": "any",
    "select": "docId,title,description",
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 1.5,
      "@search.highlights": {
        "title": [
          "<em>Nice</em> <em>Hotel</em>"
        ]
      },
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.score": 0.7,
      "@search.highlights": {
        "title": [
          "Fancy <em>Hotel</em>"
        ]
      },
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-10-01-Preview"
}

Définitions

Nom	Description
AnswerResult	Une réponse est un passage de texte extrait du contenu des documents les plus pertinents correspondant à la requête. Les réponses sont extraites des résultats de recherche principaux. Les candidats à la réponse sont marqués et les premières réponses sont sélectionnées.
CaptionResult	Les légendes sont les passages les plus représentatifs du document relativement à la requête de recherche. Ils sont souvent utilisés comme résumé de document. Les légendes sont retournées uniquement pour les requêtes de type « sémantique ».
DocumentDebugInfo	Contient des informations de débogage qui peuvent être utilisées pour explorer davantage vos résultats de recherche.
QueryAnswerType	Valeur qui spécifie si les réponses doivent être retournées dans le cadre de la réponse de recherche.
QueryCaptionType	Valeur qui spécifie si les légendes doivent être retournées 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.
QueryLanguage	Langue de la requête.
QueryResultDocumentRerankerInput	Chaînes concaténées brutes envoyées au processus d’enrichissement sémantique.
QueryResultDocumentSemanticField	Description des champs envoyés au processus d’enrichissement sémantique, ainsi que la façon dont ils ont été utilisés
QuerySpellerType	Valeur qui a spécifié le type de l’orthographique à utiliser pour corriger les termes de requête de recherche individuels.
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 et « sémantique » si la syntaxe de requête n’est pas nécessaire.
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 des statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence inférieure. La valeur par défaut est « local ». Utilisez « global » pour agréger les statistiques de scoring globalement avant le scoring. L’utilisation des statistiques de scoring globales peut augmenter la latence des requêtes de recherche.
SearchDocumentsResult	Réponse contenant des résultats de recherche à partir d’un index.
SearchError	Décrit une condition d’erreur pour l’API.
SearchMode	Spécifie si l’un ou l’ensemble des termes de recherche doivent être mis en correspondance pour compter le document comme correspondance.
SearchRequest	Paramètres de filtrage, de tri, de facette, 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.
SemanticDebugInfo
SemanticErrorMode	Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou retourner des résultats partiels (par défaut).
SemanticErrorReason	Raison pour laquelle une réponse partielle a été retournée pour une demande de classement sémantique.
SemanticFieldState	La façon dont le champ a été utilisé pour le processus d’enrichissement sémantique (entièrement utilisé, partiellement utilisé ou inutilisé)
SemanticSearchResultsType	Type de réponse partielle retournée pour une demande de classement sémantique.
VectorFilterMode	Détermine si les filtres sont appliqués avant ou après l’exécution de la recherche vectorielle.
VectorizableTextQuery	Les paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur de texte devant être vectorisée est fournie.
VectorQueryKind	Type de requête vectorielle en cours d’exécution.

AnswerResult

Objet

Une réponse est un passage de texte extrait du contenu des documents les plus pertinents correspondant à la requête. Les réponses sont extraites des résultats de recherche principaux. Les candidats à la réponse sont marqués et les premières réponses sont sélectionnées.

Nom	Type	Description
highlights	string	Même passage de texte que dans la propriété Text avec des expressions de texte en surbrillance les plus pertinentes pour la requête.
key	string	Clé du document à partir duquel la réponse a été extraite.
score	number (double)	La valeur de score représente la pertinence de la réponse à la requête par rapport aux autres réponses retournées pour la requête.
text	string	Passage de texte extrait du contenu du document comme réponse.

CaptionResult

Objet

Les légendes sont les passages les plus représentatifs du document relativement à la requête de recherche. Ils sont souvent utilisés comme résumé de document. Les légendes sont retournées uniquement pour les requêtes de type « sémantique ».

Nom	Type	Description
highlights	string	Même passage de texte que dans la propriété Text avec des expressions mises 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

Objet

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

Nom	Type	Description
semantic	SemanticDebugInfo	Contient des informations de débogage spécifiques aux demandes de classement sémantique.

QueryAnswerType

Énumération

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

Valeur	Description
none	Ne retournez pas de réponses pour la requête.
extractive	Extrait les candidats de réponse du contenu des documents retournés en réponse à une requête exprimée en tant que question en langage naturel.

QueryCaptionType

Énumération

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

Valeur	Description
none	Ne retournez pas de légendes 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 retournée.
semantic	Permet à l’utilisateur d’explorer davantage ses résultats reclassés.

QueryLanguage

Énumération

Langue de la requête.

Valeur	Description
none	Langage de requête non spécifié.
en-us	Valeur de langue de requête pour l’anglais (États-Unis).
en-gb	Valeur de langue de requête pour l’anglais (Grande-Bretagne).
en-in	Valeur de langue de requête pour l’anglais (Inde).
en-ca	Valeur de langue de requête pour l’anglais (Canada).
en-au	Valeur de langue de requête pour l’anglais (Australie).
fr-fr	Valeur de langue de requête pour le français (France).
fr-ca	Valeur de langue de requête pour le français (Canada).
de-de	Valeur de langue de requête pour l’allemand (Allemagne).
es-es	Valeur de langue de requête pour l’espagnol (Espagne).
es-mx	Valeur de langue de requête pour l’espagnol (Mexique).
zh-cn	Valeur de langue de requête pour le chinois (Chine).
zh-tw	Valeur de langue de requête pour le chinois (Taïwan).
pt-br	Valeur de langue de requête pour le portugais (Brésil).
pt-pt	Valeur de langue de requête pour le portugais (Portugal).
it-it	Valeur de langue de requête pour l’italien (Italie).
ja-jp	Valeur du langage de requête pour le japonais (Japon).
ko-kr	Valeur de langue de requête pour le coréen (Corée).
ru-ru	Valeur de langue de requête pour le russe (Russie).
cs-cz	Valeur de langue de requête pour le tchèque (République tchèque).
nl-be	Valeur de langue de requête pour le néerlandais (Belgique).
nl-nl	Valeur de langue de requête pour le néerlandais (Pays-Bas).
hu-hu	Valeur du langage de requête pour le hongrois (Hongrie).
pl-pl	Valeur du langage de requête pour le polonais (Pologne).
sv-se	Valeur de langue de requête pour suédois (Suède).
tr-tr	Valeur de langue de requête pour le turc (Turquie).
hi-in	Valeur du langage de requête pour l’hindi (Inde).
ar-sa	Valeur de langue de requête pour l’arabe (Arabie saoudite).
ar-eg	Valeur de langue de requête pour l’arabe (Égypte).
ar-ma	Valeur de langue de requête pour l’arabe (Maroc).
ar-kw	Valeur de langue de requête pour l’arabe (Koweït).
ar-jo	Valeur de langue de requête pour l’arabe (Jordanie).
da-dk	Valeur de langue de requête pour le danois (Danemark).
no-no	Valeur de langue de requête pour norvégien (Norvège).
bg-bg	Valeur de langue de requête pour le bulgare (Bulgarie).
hr-hr	Valeur de langue de requête pour le croate (Croatie).
hr-ba	Valeur de langue de requête pour le croate (Bosnie-Herzégovine).
ms-my	Valeur du langage de requête pour malay (Malaisie).
ms-bn	Valeur du langage de requête pour Malay (Brunei).
sl-sl	Valeur du langage de requête pour le Slovène (Slovénie).
ta-in	Valeur de langue de requête pour tamoul (Inde).
vi-vn	Valeur de langue de requête pour le Vietnamien (Viet Nam).
el-gr	Valeur de langue de requête pour le grec (Grèce).
ro-ro	Valeur de langue de requête pour le roumain (Roumanie).
is-is	Valeur de langue de requête pour l’Islande (Islande).
id-id	Valeur de langue de requête pour l’Indonésien (Indonésie).
th-th	Valeur de langue de requête pour thaï (Thaïlande).
lt-lt	Valeur de langue de requête pour lituanien (Lituanie).
uk-ua	Valeur de langue de requête pour l’Ukrainien (Ukraine).
lv-lv	Valeur de langue de requête pour letton (Lettonie).
et-ee	Valeur du langage de requête pour l’Estonie (Estonie).
ca-es	Valeur du langage de requête pour le catalan.
fi-fi	Valeur de langue de requête pour le finnois (Finlande).
sr-ba	Valeur de langue de requête pour le serbe (Bosnie-Herzégovine).
sr-me	Valeur de langue de requête pour le Serbe (Monténégro).
sr-rs	Valeur de langue de requête pour le serbe (Serbie).
sk-sk	Valeur du langage de requête pour le slovaque (Slovaquie).
nb-no	Valeur de langue de requête pour norvégien (Norvège).
hy-am	Valeur du langage de requête pour l’Arménien (Arménie).
bn-in	Valeur de langue de requête pour Bengali (Inde).
eu-es	Valeur du langage de requête pour le basque.
gl-es	Valeur du langage de requête pour Galicien.
gu-in	Valeur du langage de requête pour Gujarati (Inde).
he-il	Valeur du langage de requête pour l’hébreu (Israël).
ga-ie	Valeur de langue de requête pour l’Irlandais (Irlande).
kn-in	Valeur du langage de requête pour Kannada (Inde).
ml-in	Valeur du langage de requête pour Malayalam (Inde).
mr-in	Valeur du langage de requête pour Marathi (Inde).
fa-ae	Valeur du langage de requête pour persan (U.A.E.).
pa-in	Valeur du langage de requête pour Punjabi (Inde).
te-in	Valeur du langage de requête pour Telugu (Inde).
ur-pk	Valeur de langue de requête pour Urdu (Pakistan).

QueryResultDocumentRerankerInput

Objet

Chaînes concaténées brutes envoyées au processus d’enrichissement sémantique.

Nom	Type	Description
content	string	Chaînes concaténées brutes pour les champs de contenu utilisés pour l’enrichissement sémantique.
keywords	string	Chaînes concaténées brutes pour les champs de mot clé utilisés pour l’enrichissement sémantique.
title	string	Chaîne brute pour le champ de titre utilisé pour l’enrichissement sémantique.

QueryResultDocumentSemanticField

Objet

Description des champs envoyés au processus d’enrichissement sémantique, ainsi que la façon dont ils ont été utilisés

Nom	Type	Description
name	string	Nom du champ envoyé au processus d’enrichissement sémantique
state	SemanticFieldState	La façon dont le champ a été utilisé pour le processus d’enrichissement sémantique (entièrement utilisé, partiellement utilisé ou inutilisé)

QuerySpellerType

Énumération

Valeur qui a spécifié le type de l’orthographique à utiliser pour corriger les termes de requête de recherche individuels.

Valeur	Description
none	Speller n’est pas activé.
lexicon	Speller corrige les termes de requête individuels à l’aide d’un lexique statique pour le langage spécifié par le paramètre queryLanguage.

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 et « sémantique » si la syntaxe de requête n’est pas nécessaire.

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 permet des symboles tels que +, * et « ». Les requêtes sont évaluées sur tous les champs pouvant faire l’objet d’une recherche par défaut, 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	Mieux adapté aux requêtes exprimées en langage naturel par opposition aux mots clés. Améliore la précision des résultats de la recherche en re-classant les meilleurs résultats de recherche à l’aide d’un modèle de classement formé sur le corpus Web.

RawVectorQuery

Objet

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

Nom	Type	Description
exhaustive	boolean	Quand la valeur est true, déclenche une recherche exhaustive k-nearest voisin sur tous les vecteurs au sein de l’index vectoriel. Utile pour les scénarios où les correspondances exactes sont critiques, telles que la détermination des valeurs de vérité de base.
fields	string	Champs vectoriels de type Collection(Edm.Single) à inclure dans le vecteur recherché.
k	integer (int32)	Nombre de voisins les plus proches à retourner en tant que premiers coups.
kind	string: vector	Type de requête vectorielle en cours d’exécution.
vector	number[] (float)	Représentation vectorielle d’une requête de recherche.

ScoringStatistics

Énumération

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

Valeur	Description
local	Les statistiques de scoring sont calculées localement pour une latence inférieure.
global	Les statistiques de scoring seront calculées globalement pour un scoring plus cohérent.

SearchDocumentsResult

Objet

Réponse contenant des résultats de recherche à partir 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 est présent, 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 retourner tous les documents demandés dans une seule réponse.
@odata.nextLink	string	URL de continuation retourné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 GET ou POST Search pour obtenir la partie suivante de la réponse de recherche. Veillez à utiliser le même verbe (GET ou POST) que la requête qui a produit cette réponse.
@search.answers	AnswerResult[]	Résultats de la requête réponses pour l’opération de recherche ; Null si le paramètre de requête réponses 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 requête.
@search.facets	object	Résultats de la requête de facette 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 retournée lorsque la requête ne peut pas retourner tous les résultats demandés dans une seule réponse. Vous pouvez utiliser ce code JSON avec @odata.nextLink pour formuler une autre requête POST Search pour obtenir la partie suivante de la réponse de recherche.
@search.semanticPartialResponseReason	SemanticErrorReason	Raison pour laquelle une réponse partielle a été retournée pour une demande de classement sémantique.
@search.semanticPartialResponseType	SemanticSearchResultsType	Type de réponse partielle retournée pour une demande de classement sémantique.
value	SearchResult[]	Séquence de résultats retournés par la requête.

SearchError

Objet

Décrit une condition d’erreur pour l’API.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	SearchError[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
message	string	Représentation lisible par l’homme de l’erreur.

SearchMode

Énumération

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

Valeur	Description
any	L’un des termes de recherche doit être mis en correspondance pour compter le document comme correspondance.
all	Tous les termes de recherche doivent être mis en correspondance pour compter le document comme correspondance.

SearchRequest

Objet

Paramètres de filtrage, de tri, de facette, 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 retournées dans le cadre de la réponse de recherche.
captions	QueryCaptionType	Valeur qui spécifie si les légendes doivent être retournées 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 nombre retourné 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 séparée par des virgules de paires name :value.
filter	string	L’expression OData $filter à appliquer à la requête de recherche.
highlight	string	Liste séparée par des virgules des noms de champs à utiliser pour les surbrillances d’accès. Seuls les champs pouvant faire l’objet d’une recherche peuvent être utilisés pour la mise en surbrillance des accès.
highlightPostTag	string	Balise de chaîne ajoutée aux surbrillances d’accès. Doit être défini avec highlightPreTag. La valeur par défaut est </em>.
highlightPreTag	string	Balise de chaîne qui est précédée de mises en surbrillance. 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 afin que la requête soit signalée comme une réussite. Ce paramètre peut être utile pour garantir la disponibilité de la recherche même pour les services avec un seul réplica. La valeur par défaut est 100.
orderby	string	Liste séparée par des virgules d’OData $orderby expressions par lesquelles trier les résultats. Chaque expression peut être un nom de champ ou un appel aux fonctions geo.distance() ou search.score(). Chaque expression peut être suivie d’asc pour indiquer l’ordre croissant ou desc pour indiquer l’ordre décroissant. La valeur par défaut est l’ordre croissant. Les liens seront rompus par les scores de correspondance des documents. Si aucune $orderby n’est spécifiée, l’ordre de tri par défaut descend par score de correspondance de document. Il peut y avoir au maximum 32 clauses $orderby.
queryLanguage	QueryLanguage	Valeur qui spécifie la langue de la requête de recherche.
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 des valeurs de nom de format. Par exemple, si le profil de scoring définit une fonction avec un paramètre appelé « mylocation », la chaîne de paramètre est « mylocation--122.2,44.8 » (sans les guillemets).
scoringProfile	string	Nom d’un profil de scoring pour évaluer les scores de correspondance pour les documents correspondants afin de trier les résultats.
scoringStatistics	ScoringStatistics	Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence inférieure. La valeur par défaut est « local ». Utilisez « global » pour agréger les statistiques de scoring globalement avant le scoring. L’utilisation des statistiques de scoring globales peut augmenter la latence des requêtes de recherche.
search	string	Expression de requête de recherche en texte intégral ; Utilisez « * » ou omettez ce paramètre pour faire correspondre tous les documents.
searchFields	string	Liste séparée par des virgules des noms de champs auxquels étendre la recherche en texte intégral. Lors de l’utilisation de la recherche fielded (fieldName :searchExpression) dans une requête Lucene complète, les noms de champs de chaque expression de recherche fielded sont prioritaires sur tous les noms de champs 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 compter le document comme correspondance.
select	string	Liste de champs séparés par des virgules à récupérer. S’il n’est pas spécifié, 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 de documents pour les requêtes sémantiques de type.
semanticErrorHandling	SemanticErrorMode	Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou retourner des résultats partiels (par défaut).
semanticFields	string	Liste séparée par des virgules des noms de champs utilisés pour le classement sémantique.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Permet à l’utilisateur de définir une limite supérieure sur la durée nécessaire à l’enrichissement sémantique pour terminer le traitement avant l’échec de la requête.
semanticQuery	string	Permet de définir une requête de recherche distincte qui sera utilisée uniquement pour la reranking 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 différentes requêtes entre la phase de récupération de base et de classement, et la phase sémantique L2.
sessionId	string	Valeur à utiliser pour créer une session sticky, qui peut vous aider à obtenir des résultats plus cohérents. Tant que le même id de session est utilisé, une tentative optimale sera effectuée pour cibler le même jeu de réplicas. Soyez prudent que la réutilisation des mêmes valeurs sessionID peut interférer à plusieurs reprises avec l’équilibrage de charge des requêtes entre les réplicas et affecter négativement les performances du service de recherche. La valeur utilisée en tant que sessionId ne peut pas commencer par un caractère '_'.
skip	integer (int32)	Nombre de résultats de recherche à ignorer. Cette valeur ne peut pas être supérieure à 100 000. Si vous avez besoin d’analyser des documents dans la séquence, mais que vous ne pouvez pas l’utiliser en raison de cette limitation, envisagez d’utiliser orderby sur une clé totalement ordonnée et filtrer avec une requête de plage à la place.
speller	QuerySpellerType	Valeur qui a spécifié le type de l’orthographique à utiliser pour corriger les termes de requête de recherche individuels.
top	integer (int32)	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 suivante des résultats.
vectorFilterMode	VectorFilterMode	Détermine si les filtres sont appliqués avant ou après l’exécution de la recherche vectorielle. La valeur par défaut est « preFilter ».
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Paramètres de requête pour les requêtes de recherche vectorielle et hybride.

SearchResult

Objet

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 relativement à la requête de recherche. Ils sont souvent utilisés comme résumé de document. Les légendes sont retournées uniquement pour les requêtes de type « sémantique ».
@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 qui indiquent 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.rerankerScore	number (double)	Score de pertinence calculé par le ranker sémantique pour les résultats de recherche principaux. Les résultats de la recherche sont triés d’abord par RerankerScore, puis par score. RerankerScore n’est retourné que pour les requêtes de type « sémantique ».
@search.score	number (double)	Score de pertinence du document par rapport à d’autres documents retournés par la requête.

SemanticDebugInfo

Objet

Nom	Type	Description
contentFields	QueryResultDocumentSemanticField[]	Champs de contenu envoyés au processus d’enrichissement sémantique, ainsi que la façon dont ils ont été utilisés
keywordFields	QueryResultDocumentSemanticField[]	Champs de mot clé envoyés au processus d’enrichissement sémantique, ainsi que la façon dont ils ont été utilisés
rerankerInput	QueryResultDocumentRerankerInput	Chaînes concaténées brutes envoyées au processus d’enrichissement sémantique.
titleField	QueryResultDocumentSemanticField	Champ de titre envoyé au processus d’enrichissement sémantique, ainsi que la façon dont il a été utilisé

SemanticErrorMode

Énumération

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

Valeur	Description
partial	Si le traitement sémantique échoue, les résultats partiels retournent toujours. La définition des résultats partiels dépend de l’étape sémantique ayant échoué et de la raison de l’échec.
fail	S’il existe une exception pendant l’étape de traitement sémantique, la requête échoue et retourne le code HTTP approprié en fonction de l’erreur.

SemanticErrorReason

Énumération

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

Valeur	Description
maxWaitExceeded	Si « semanticMaxWaitInMilliseconds » a été défini et que la durée de traitement sémantique a dépassé cette valeur. Seuls les résultats de base ont été retournés.
capacityOverloaded	La requête a été limitée. Seuls les résultats de base ont été retournés.
transient	Au moins une étape du processus sémantique a échoué.

SemanticFieldState

Énumération

La façon dont le champ a été utilisé pour le processus d’enrichissement sémantique (entièrement utilisé, partiellement utilisé ou inutilisé)

Valeur	Description
used	Le champ a été entièrement utilisé pour l’enrichissement sémantique.
unused	Le champ n’a pas été utilisé pour l’enrichissement sémantique.
partial	Le champ a été partiellement utilisé pour l’enrichissement sémantique.

SemanticSearchResultsType

Énumération

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

Valeur	Description
baseResults	Résultats sans 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 aucune réponse, les mises en surbrillance des réponses ou les surbrillances de légende.

VectorFilterMode

Énumération

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

Valeur	Description
postFilter	Le filtre est appliqué une fois que l’ensemble de résultats de vecteurs candidat est retourné. Selon la sélectivité du filtre, cela peut entraîner moins de résultats que demandés par le paramètre « k ».
preFilter	Le filtre est appliqué avant la requête de recherche.

VectorizableTextQuery

Objet

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

Nom	Type	Description
exhaustive	boolean	Quand la valeur est true, déclenche une recherche exhaustive k-nearest voisin sur tous les vecteurs au sein de l’index vectoriel. Utile pour les scénarios où les correspondances exactes sont critiques, telles que la détermination des valeurs de vérité de base.
fields	string	Champs vectoriels de type Collection(Edm.Single) à inclure dans le vecteur recherché.
k	integer (int32)	Nombre de voisins les plus proches à retourner en tant que premiers coups.
kind	string: text	Type de requête vectorielle en cours d’exécution.
text	string	Texte à vectoriser pour effectuer une requête de recherche vectorielle.

VectorQueryKind

Énumération

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

Valeur	Description
vector	Requête vectorielle où une valeur vectorielle brute est fournie.
text	Requête vectorielle où une valeur de texte qui doit être vectorisée est fournie.