Documents - Search Post

Service:

Search Service

Version d'API:

2024-03-01-Preview

Recherche des documents dans l’index.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2024-03-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 plus en détail vos résultats reclassés.
facets	string[]	Liste d’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 nom :valeur.
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 ajoutée pour atteindre les surbrillances. Doit être défini avec highlightPostTag. La valeur par défaut est <em>.
minimumCoverage	number	Nombre compris entre 0 et 100 indiquant le pourcentage de l’index qui doit être couvert par une requête de recherche pour que la requête soit signalée en tant que 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	La liste séparée par des virgules des expressions OData $orderby selon 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 de desc pour indiquer une valeur décroissante. 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 est décroissant 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ètres à 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 est « mylocation--122.2,44.8 » (sans les guillemets).
scoringProfile	string	Nom du profil de calcul de score utilisé pour é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 des documents) 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 scoring à l’échelle mondiale avant le scoring. L’utilisation de statistiques de scoring 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 faire correspondre tous les documents.
searchFields	string	Liste séparée par des virgules des noms de champs auxquels définir l’étendue de la recherche en texte intégral. Lorsque vous utilisez la recherche sur champ (fieldName :searchExpression) dans une requête Lucene complète, les noms de champs de chaque expression de recherche avec champ sont prioritaires sur les noms de champs répertoriés dans ce paramètre.
searchMode	SearchMode	Valeur qui spécifie si tout ou partie des termes de recherche doivent être mis en correspondance pour compter le document en tant que correspondance.
select	string	Liste de champs séparés par des virgules à récupérer. Si aucune valeur n'est spécifiée, 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 des requêtes de type sémantique.
semanticErrorHandling	SemanticErrorMode	Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou de 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	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 requête.
semanticQuery	string	Permet de définir une requête de recherche distincte qui sera utilisée uniquement pour la 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 différentes requêtes entre la phase de récupération et de classement de base et la phase sémantique L2.
sessionId	string	Valeur à utiliser pour créer une session collante, qui peut vous aider à obtenir des résultats plus cohérents. Tant que le même sessionId est utilisé, une tentative de la meilleure façon est effectuée pour cibler le même réplica défini. Veillez à ce que la réutilisation répétée des mêmes valeurs sessionID puisse interférer avec l’équilibrage de charge des requêtes 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	Nombre de résultats de recherche à ignorer. Cette valeur ne peut pas être supérieure à 100 000. Si vous devez analyser 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 de filtrer avec une requête de plage à la place.
speller	QuerySpellerType	Valeur qui spécifiait le type de l’orthographe à utiliser pour corriger l’orthographe des termes de requête de recherche individuels.
top	integer	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 la 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 Recherche demande pour la page de résultats suivante.
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	ErrorResponse	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=2024-03-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,
      "oversampling": 20
    }
  ],
  "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=2024-03-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 premiers résultats de recherche. Les candidats à la réponse sont notés et les premières 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 sous-titres sont retournés uniquement pour les requêtes de type « sémantique ».
DocumentDebugInfo	Contient des informations de débogage qui peuvent être utilisées pour explorer plus en détail 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 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 plus en détail 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 qui ont été 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’orthographe à utiliser pour corriger l’orthographe des termes de la requête de recherche individuelle.
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 « semantic » 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 les statistiques de scoring (telles que la fréquence des documents) 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 scoring à l’échelle mondiale avant le scoring. L’utilisation de statistiques de scoring globales peut augmenter la latence des requêtes de recherche.
SearchDocumentsResult	Réponse contenant les résultats de recherche d’un index.
SearchMode	Indique si tous les termes recherchés ou l'un d'eux doivent correspondre pour que le document soit considéré comme une correspondance.
SearchRequest	Paramètres de filtrage, de tri, de facettes, 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 de 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 non utilisé)
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	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.

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 premiers résultats de recherche. Les candidats à la réponse sont noté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 les expressions de texte mises en surbrillance les plus pertinentes pour la requête.
key	string	Clé du document dont la réponse a été extraite.
score	number	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

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 sous-titres sont retournés 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 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

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

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

ErrorAdditionalInfo

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

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

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

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

QueryAnswerType

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

Nom	Type	Description
extractive	string	Extrait les candidats-réponses du contenu des documents retournés en réponse à une requête exprimée sous forme de question en langage naturel.
none	string	Ne retournez pas de réponses pour la requête.

QueryCaptionType

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

Nom	Type	Description
extractive	string	Extrait les légendes des documents correspondants qui contiennent des passages pertinents pour la requête de recherche.
none	string	Ne retournez pas de sous-titres pour la requête.

QueryDebugMode

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

Nom	Type	Description
disabled	string	Aucune information de débogage de requête ne sera retournée.
semantic	string	Permet à l’utilisateur d’explorer davantage ses résultats réécrits.

QueryLanguage

Langue de la requête.

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

QueryResultDocumentRerankerInput

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	Les chaînes concaténées brutes pour les champs mot clé qui ont été utilisés pour l’enrichissement sémantique.
title	string	Chaîne brute du champ de titre utilisé pour l’enrichissement sémantique.

QueryResultDocumentSemanticField

Description des champs qui ont été 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 non utilisé)

QuerySpellerType

Valeur qui a spécifié le type de l’orthographe à utiliser pour corriger l’orthographe des termes de la requête de recherche individuelle.

Nom	Type	Description
lexicon	string	Speller corrige les termes de requête individuels à l’aide d’un lexique statique pour le langage spécifié par le paramètre queryLanguage.
none	string	Orthographe non activé.

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

Nom	Type	Description
full	string	Utilise la syntaxe de requête Lucene complète pour les recherches. Recherche texte 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	string	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 recherche en replaçant les premiers résultats de la recherche à l’aide d’un modèle de classement formé sur le corpus web.
simple	string	Utilise la syntaxe de requête simple pour les recherches. Recherche texte est interprété à l’aide d’un langage de requête simple qui autorise les 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é.

RawVectorQuery

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ù des correspondances exactes sont critiques, comme la détermination des valeurs de vérité au sol.
fields	string	Champs vectoriels de type Collection(Edm.Single) à inclure dans le vecteur recherché.
k	integer	Nombre de voisins les plus proches à retourner en tant que premiers résultats.
kind	string: vector	Type de requête vectorielle en cours d’exécution.
oversampling	number	Facteur de suréchantillonnage. La valeur minimale est 1. Il remplace le paramètre « defaultOversampling » configuré dans la définition d’index. Il ne peut être défini que lorsque « rerankWithOriginalVectors » a la valeur true. Ce paramètre n’est autorisé que lorsqu’une méthode de compression est utilisée sur le champ vectoriel sous-jacent.
vector	number[]	Représentation vectorielle d’une requête de recherche.

ScoringStatistics

Valeur qui spécifie si nous voulons calculer les statistiques de scoring (telles que la fréquence des documents) 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 scoring à l’échelle mondiale avant le scoring. L’utilisation de statistiques de scoring globales peut augmenter la latence des requêtes de recherche.

Nom	Type	Description
global	string	Les statistiques de scoring seront calculées globalement pour un scoring plus cohérent.
local	string	Les statistiques de scoring sont calculées localement pour une latence plus faible.

SearchDocumentsResult

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

Nom	Type	Description
@odata.count	integer	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 Recherche afin d’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 de réponses pour l’opération de recherche ; null si le paramètre de requête de réponses n’a pas été spécifié ou défini sur « none ».
@search.coverage	number	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 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’a pas inclus d’expressions 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 Recherche afin d’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.

SearchMode

Indique si tous les termes recherchés ou l'un d'eux doivent correspondre pour que le document soit considéré comme une correspondance.

Nom	Type	Description
all	string	Tous les termes de recherche doivent être mis en correspondance pour compter le document comme une correspondance.
any	string	Tous les termes de recherche doivent être mis en correspondance pour compter le document comme une correspondance.

SearchRequest

Paramètres de filtrage, de tri, de facettes, 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 d’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 nom :valeur.
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 ajoutée pour atteindre les surbrillances. Doit être défini avec highlightPostTag. La valeur par défaut est <em>.
minimumCoverage	number	Nombre compris entre 0 et 100 indiquant le pourcentage de l’index qui doit être couvert par une requête de recherche pour que la requête soit signalée en tant que 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	La liste séparée par des virgules des expressions OData $orderby selon 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 de desc pour indiquer la décroissante. 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 est décroissant 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ètres à 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 est « mylocation--122.2,44.8 » (sans les guillemets).
scoringProfile	string	Nom du profil de calcul de score utilisé pour évaluer les scores de correspondance des 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 des documents) 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 scoring à l’échelle mondiale avant de scorer. L’utilisation des statistiques de scoring global 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. Lorsque vous utilisez la recherche sur champ (fieldName :searchExpression) dans une requête Lucene complète, les noms de champ de chaque expression de recherche avec champ sont prioritaires sur les noms de champs répertoriés dans ce paramètre.
searchMode	SearchMode	Valeur qui spécifie si tout ou partie des termes de recherche doivent être mis en correspondance pour compter le document comme une correspondance.
select	string	Liste des champs séparés par des virgules à récupérer. Si aucune valeur n'est spécifiée, 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 des requêtes de type sémantique.
semanticErrorHandling	SemanticErrorMode	Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou de 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	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 différentes requêtes entre la phase de récupération et de classement de base et la phase sémantique L2.
sessionId	string	Valeur à utiliser pour créer une session collante, ce qui peut vous aider à obtenir des résultats plus cohérents. Tant que le même sessionId est utilisé, une tentative optimale est effectuée pour cibler le même réplica ensemble. Méfiez-vous que la réutilisation répétée des mêmes valeurs sessionID peut interférer avec l’équilibrage de charge des requêtes 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	Nombre de résultats de recherche à ignorer. Cette valeur ne peut pas être supérieure à 100 000. Si vous devez analyser 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é entièrement ordonnée et de filtrer avec une requête de plage à la place.
speller	QuerySpellerType	Valeur qui a spécifié le type de l’orthographe à utiliser pour corriger l’orthographe des termes de la requête de recherche individuelle.
top	integer	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 la recherche. Si les résultats sont tronqués en raison d’une pagination côté serveur, la réponse inclut un jeton de continuation qui peut être utilisé pour émettre une autre Recherche demande 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

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 uniquement retournées pour les requêtes de type « sémantique ».
@search.documentDebugInfo	DocumentDebugInfo[]	Contient des informations de débogage qui peuvent être utilisées pour explorer plus en détail 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	Score de pertinence calculé par le classement sémantique pour les résultats de recherche les plus importants. Recherche résultats sont triés d’abord par RerankerScore, puis par score. RerankerScore est retourné uniquement pour les requêtes de type « sémantique ».
@search.score	number	Score de pertinence du document par rapport aux autres documents retournés par la requête.

SemanticDebugInfo

Nom	Type	Description
contentFields	QueryResultDocumentSemanticField[]	Les champs de contenu qui ont été envoyés au processus d’enrichissement sémantique, ainsi que la façon dont ils ont été utilisés
keywordFields	QueryResultDocumentSemanticField[]	Le mot clé les champs qui ont été 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

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

Nom	Type	Description
fail	string	En cas d’exception pendant l’étape de traitement sémantique, la requête échoue et retourne le code HTTP approprié en fonction de l’erreur.
partial	string	Si le traitement sémantique échoue, les résultats partiels sont toujours retourné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.

SemanticErrorReason

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

Nom	Type	Description
capacityOverloaded	string	La demande a été limitée. Seuls les résultats de base ont été retournés.
maxWaitExceeded	string	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.
transient	string	Au moins une étape du processus sémantique a échoué.

SemanticFieldState

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

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

SemanticSearchResultsType

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

Nom	Type	Description
baseResults	string	Résultats sans enrichissement sémantique ni reclassement.
rerankedResults	string	Les résultats ont été reclassés avec le modèle de reclassement et incluent des légendes sémantiques. Ils n’incluront pas de réponses, de réponses en surbrillance ou de légende de faits saillants.

VectorFilterMode

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

Nom	Type	Description
postFilter	string	Le filtre est appliqué une fois que l’ensemble de résultats vectoriels candidats est retourné. En fonction de la sélectivité du filtre, le nombre de résultats peut être inférieur à celui demandé par le paramètre « k ».
preFilter	string	Le filtre sera appliqué avant la requête de recherche.

VectorizableTextQuery

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	Quand la valeur est true, déclenche une recherche complète du voisin le plus proche sur tous les vecteurs au sein de l’index vectoriel. Utile pour les scénarios où des correspondances exactes sont critiques, comme la détermination des valeurs de vérité au sol.
fields	string	Champs vectoriels de type Collection (Edm.Single) à inclure dans le vecteur recherché.
k	integer	Nombre de voisins les plus proches à retourner en tant que premiers résultats.
kind	string: text	Type de requête vectorielle en cours d’exécution.
oversampling	number	Facteur de suréchantillonnage. La valeur minimale est 1. Il remplace le paramètre « defaultOversampling » configuré dans la définition d’index. Elle peut être définie uniquement lorsque « rerankWithOriginalVectors » a la valeur true. Ce paramètre n’est autorisé que lorsqu’une méthode de compression est utilisée sur le champ vecteur sous-jacent.
text	string	Texte à vectoriser pour effectuer une requête de recherche vectorielle.

VectorQueryKind

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

Nom	Type	Description
text	string	Requête vectorielle dans laquelle une valeur de texte qui doit être vectorisée est fournie.
vector	string	Requête vectorielle dans laquelle une valeur vectorielle brute est fournie.