Documents - Search Get

Service:: Search Service

Version d'API:: 2025-11-01-preview

Recherche de documents dans l’index.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2025-11-01-preview

Avec des paramètres facultatifs:

GET {endpoint}/indexes('{indexName}')/docs?api-version=2025-11-01-preview&search={search}&$count={$count}&facet={facet}&$filter={$filter}&highlight={highlight}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&queryType={queryType}&scoringParameter={scoringParameter}&scoringProfile={scoringProfile}&searchFields={searchFields}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}&queryRewrites={queryRewrites}&debug={debug}&queryLanguage={queryLanguage}&speller={speller}&semanticFields={semanticFields}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	URL du point de terminaison du service de recherche.
indexName	path	True	string	Nom de l’index.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
$count	query		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.
$filter	query		string	L’expression OData $filter à appliquer à la requête de recherche.
$orderby	query		string[]	Liste des expressions OData $orderby 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 de asc pour indiquer l’ascendant et de desc pour indiquer la descente. La valeur par défaut est l’ordre croissant. Les liens seront rompus par les scores de correspondance 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 maximum 32 clauses $orderby.
$select	query		string[]	Liste des champs à 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.
$skip	query		integer (int32)	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 de $filter avec une requête de plage à la place.
$top	query		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.
answers	query		QueryAnswerType	Ce paramètre n’est valide que si le type de requête est `semantic`. Si cette option est définie, la requête renvoie des réponses extraites des passages clés des documents les mieux classés. Le nombre de réponses renvoyées peut être configuré en ajoutant la barre `\|` verticale suivie de l’option `count-<number of answers>` après la valeur du paramètre answers, par `extractive\|count-3`exemple . Le nombre par défaut est de 1. Le seuil de confiance peut être configuré en ajoutant la barre `\|` verticale suivie de l’option `threshold-<confidence threshold>` après la valeur du paramètre answers, par `extractive\|threshold-0.9`exemple . Le seuil par défaut est de 0,7. La longueur maximale des réponses peut être configurée en ajoutant le caractère barre verticale '\|' suivi du 'count-number< of maximum character length>', tel que 'extractive\|maxcharlength-600'.
captions	query		QueryCaptionType	Ce paramètre n’est valide que si le type de requête est `semantic`. Si elle est définie, la requête retourne des légendes extraites des passages clés dans les documents classés les plus élevés. Lorsque l’option Sous-titres est définie sur `extractive`, la mise en surbrillance est activée par défaut et peut être configurée en ajoutant la barre `\|` verticale suivie de l’option `highlight-<true/false>` , telle que `extractive\|highlight-true`. La valeur par défaut est `None`. La longueur maximale des caractères des légendes peut être configurée en ajoutant le caractère pipe '\|' suivi du 'count-number< of maximum character length>', tel que 'extractive\|maxcharlength-600'.
debug	query		QueryDebugMode	Active un outil de débogage qui peut être utilisé pour explorer davantage vos résultats de recherche.
facet	query		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.
highlight	query		string[]	La liste des noms de champs à 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 surbrillance des accès.
highlightPostTag	query		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	query		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	query		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.
queryLanguage	query		QueryLanguage	Langue de la requête.
queryRewrites	query		QueryRewritesType	Lorsque QueryRewrites est défini sur `generative`, les termes de requête sont envoyés à un modèle de génération qui produira 10 réécritures (par défaut) pour aider à augmenter le rappel de la demande. Le nombre demandé peut être configuré en ajoutant la barre `\|` verticale suivie de l’option `count-<number of rewrites>` , telle que `generative\|count-3`. La valeur par défaut est `None`. Ce paramètre n’est valide que si le type de requête est `semantic`.
queryType	query		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.
scoringParameter	query		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	query		string	Nom d’un profil de scoring pour évaluer les scores de correspondance pour les documents correspondants afin de trier les résultats.
scoringStatistics	query		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.
search	query		string	Une expression de requête de recherche en texte intégral ; Utilisez « * » ou omettez ce paramètre pour correspondre à tous les documents.
searchFields	query		string[]	Liste des noms de champs auxquels la recherche en texte intégral doit être étendue. 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	query		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.
semanticConfiguration	query		string	Nom de la configuration sémantique qui répertorie les champs à utiliser pour le classement sémantique, les légendes, les surbrillances et les réponses
semanticErrorHandling	query		SemanticErrorMode	Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou renvoyer des résultats partiels (par défaut).
semanticFields	query		string[]	La liste des noms de champs utilisés pour le classement sémantique.
semanticMaxWaitInMilliseconds	query		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	query		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	query		string	Valeur à utiliser pour créer une session sticky, qui peut 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 '_'.
speller	query		QuerySpellerType	Améliorez le rappel de recherche en corrigeant les termes de requête de recherche individuels.

En-tête de la demande

Nom	Type	Description
Accept	Accept	L’en-tête Accept.
x-ms-query-source-authorization	string	Jeton identifiant l’utilisateur pour lequel la requête est exécutée. Ce jeton est utilisé pour appliquer des restrictions de sécurité sur les documents.
x-ms-enable-elevated-read	boolean	Une valeur qui permet une lecture élevée contournant les vérifications de permissions au niveau du document pour l’opération de requête.
x-ms-client-request-id	string (uuid)	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Réponses

Nom	Type	Description
200 OK	SearchDocumentsResult	La demande a réussi.
Other Status Codes	SearchDocumentsResult	Réussite
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

api-key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

Nom	Description
https://search.azure.com/.default

Exemples

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

Exemple de requête

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?api-version=2025-11-01-preview&search=nice hotels&$count=True&facet=category,count:10,sort:count&$filter=rating gt 10&highlight=title&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&queryType=simple&scoringProfile=sp&searchFields=title,description&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&speller={speller}

Exemple de réponse

Code d’état:: 200

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "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"
    }
  ]
}

Code d’état:: 206

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "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"
    }
  ]
}

SearchIndexSearchDocumentsSemanticGet

Exemple de requête

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?api-version=2025-11-01-preview&search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}&semanticFields={semanticFields}

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
    }
  ],
  "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"
      ]
    }
  ]
}

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
    }
  ],
  "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"
      ]
    }
  ]
}

Définitions

Nom	Description
Accept	L’en-tête Accept.
DebugInfo	Contient des informations de débogage qui peuvent être utilisées pour explorer davantage vos résultats de recherche.
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 à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).
HybridCountAndFacetMode	Détermine si le nombre et les facettes doivent inclure tous les documents qui correspondent à la requête de recherche ou uniquement les documents récupérés dans la fenêtre 'maxTextRecallSize'. La valeur par défaut est 'countAllResults'.
HybridSearch	Paramètres de requête pour configurer les comportements de recherche hybride.
QueryAnswerResult	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.
QueryAnswerType	Ce paramètre n’est valide que si le type de requête est `semantic`. Si cette option est définie, la requête renvoie des réponses extraites des passages clés des documents les mieux classés. Le nombre de réponses renvoyées peut être configuré en ajoutant la barre `\|` verticale suivie de l’option `count-<number of answers>` après la valeur du paramètre answers, par `extractive\|count-3`exemple . Le nombre par défaut est de 1. Le seuil de confiance peut être configuré en ajoutant la barre `\|` verticale suivie de l’option `threshold-<confidence threshold>` après la valeur du paramètre answers, par `extractive\|threshold-0.9`exemple . Le seuil par défaut est de 0,7. La longueur maximale des réponses peut être configurée en ajoutant le caractère barre verticale '\|' suivi du 'count-number< of maximum character length>', tel que 'extractive\|maxcharlength-600'.
QueryCaptionResult	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 `semantic`.
QueryCaptionType	Ce paramètre n’est valide que si le type de requête est `semantic`. Si elle est définie, la requête retourne des légendes extraites des passages clés dans les documents classés les plus élevés. Lorsque l’option Sous-titres est définie sur `extractive`, la mise en surbrillance est activée par défaut et peut être configurée en ajoutant la barre `\|` verticale suivie de l’option `highlight-<true/false>` , telle que `extractive\|highlight-true`. La valeur par défaut est `None`. La longueur maximale des caractères des légendes peut être configurée en ajoutant le caractère pipe '\|' suivi du 'count-number< of maximum character length>', tel que 'extractive\|maxcharlength-600'.
QueryDebugMode	Active un outil de débogage qui peut être utilisé pour explorer davantage vos résultats de recherche. Vous pouvez activer plusieurs modes de débogage simultanément en les séparant par un \| caractère, par exemple : semantic\|queryRewrites.
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
QueryResultDocumentSubscores	Répartition des sous-scores entre les composants de requête de texte et de requête vectorielle de la requête de recherche pour ce document. Chaque requête vectorielle s’affiche sous la forme d’un objet distinct dans le même ordre qu’ils ont été reçus.
QueryRewritesDebugInfo	Contient des informations de débogage spécifiques aux réécritures de requête.
QueryRewritesType	Ce paramètre n’est valide que si le type de requête est `semantic`. Lorsque QueryRewrites est défini sur `generative`, les termes de requête sont envoyés à un modèle de génération qui produira 10 réécritures (par défaut) pour aider à augmenter le rappel de la demande. Le nombre demandé peut être configuré en ajoutant la barre `\|` verticale suivie de l’option `count-<number of rewrites>` , telle que `generative\|count-3`. La valeur par défaut est `None`.
QueryRewritesValuesDebugInfo	Contient des informations de débogage spécifiques aux réécritures de requête.
QuerySpellerType	Améliorez le rappel de recherche en corrigeant 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 'semantic' si la syntaxe de requête n’est pas nécessaire.
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 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 des résultats de recherche à partir 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 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.
SearchScoreThreshold	Les résultats de la requête vectorielle seront filtrés selon le '
SemanticDebugInfo	Contient des informations de débogage spécifiques aux demandes de classement sémantique.
SemanticErrorMode	Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou de retourner des résultats partiels.
SemanticErrorReason	Raison pour laquelle une réponse partielle a été renvoyé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.
SemanticQueryRewritesResultType	Type de réécriture de requête utilisé pour cette demande.
SemanticSearchResultsType	Type de réponse partielle renvoyée pour une demande de classement sémantique.
SingleVectorFieldResult	Résultat d’un champ vectoriel unique. Les deux
TextResult	Score BM25 ou Classique 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.
VectorizableImageBinaryQuery	Les paramètres de requête à utiliser pour la recherche vectorielle lorsqu’un binaire codé en base 64 d’une image devant être vectorisée est fourni.
VectorizableImageUrlQuery	Les paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une URL qui représente une valeur d’image qui doit être vectorisée est fournie.
VectorizableTextQuery	Les paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur de texte devant être vectorisée est fournie.
VectorizedQuery	Paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur vectorielle brute est fournie.
VectorQueryKind	Type de requête vectorielle en cours d’exécution.
VectorsDebugInfo	« Contient des informations de débogage spécifiques à la recherche vectorielle et hybride. »)
VectorSimilarityThreshold	Les résultats de la requête vectorielle seront filtrés en fonction de la métrique de similarité vectorielle. Notez qu’il s’agit de la définition canonique de la métrique de similarité, et non de la version « distance ». La direction du seuil (plus grande ou plus petite) sera choisie automatiquement en fonction de la métrique utilisée par le champ.
VectorThresholdKind	Le type de seuil utilisé pour filtrer les requêtes vectorielles.

Accept

Énumération

L’en-tête Accept.

Valeur	Description
application/json;odata.metadata=none

DebugInfo

Objet

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

Nom	Type	Description
queryRewrites	QueryRewritesDebugInfo	Contient des informations de débogage spécifiques aux réécritures de requête.

DocumentDebugInfo

Objet

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

Nom	Type	Description
innerHits	object	Contient des informations de débogage spécifiques aux vecteurs appariés au sein d’une collection de types complexes.
semantic	SemanticDebugInfo	Contient des informations de débogage spécifiques aux demandes de classement sémantique.
vectors	VectorsDebugInfo	Contient des informations de débogage spécifiques à la recherche vectorielle et hybride.

ErrorAdditionalInfo

Objet

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

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

ErrorDetail

Objet

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

Objet

Réponse à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

HybridCountAndFacetMode

Énumération

Détermine si le nombre et les facettes doivent inclure tous les documents qui correspondent à la requête de recherche ou uniquement les documents récupérés dans la fenêtre 'maxTextRecallSize'. La valeur par défaut est 'countAllResults'.

Valeur	Description
countRetrievableResults	N’incluez que les documents qui ont été mis en correspondance dans la fenêtre d’extraction 'maxTextRecallSize' lors du calcul du 'count' et des 'facets'.
countAllResults	Incluez tous les documents qui ont été mis en correspondance par la requête de recherche lors du calcul de « count » et de « facettes », que ces documents se trouvent ou non dans la fenêtre d’extraction « maxTextRecallSize ».

HybridSearch

Objet

Paramètres de requête pour configurer les comportements de recherche hybride.

Nom	Type	Description
countAndFacetMode	HybridCountAndFacetMode	Détermine si le nombre et les facettes doivent inclure tous les documents qui correspondent à la requête de recherche ou uniquement les documents récupérés dans la fenêtre 'maxTextRecallSize'.
maxTextRecallSize	integer (int32)	Détermine le nombre maximal de documents à extraire par la partie requête textuelle d’une demande de recherche hybride. Ces documents seront combinés avec les documents correspondant aux requêtes vectorielles pour produire une seule liste finale de résultats. Le choix d’une valeur maxTextRecallSize plus élevée permet d’extraire et de parcourir davantage de documents (à l’aide des paramètres top et skip), au prix d’une utilisation plus élevée des ressources et d’une latence plus élevée. La valeur doit être comprise entre 1 et 10 000. La valeur par défaut est 1 000.

QueryAnswerResult

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 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.

QueryAnswerType

Énumération

Ce paramètre n’est valide que si le type de requête est semantic. Si cette option est définie, la requête renvoie des réponses extraites des passages clés des documents les mieux classés. Le nombre de réponses renvoyées peut être configuré en ajoutant la barre | verticale suivie de l’option count-<number of answers> après la valeur du paramètre answers, par extractive|count-3exemple . Le nombre par défaut est de 1. Le seuil de confiance peut être configuré en ajoutant la barre | verticale suivie de l’option threshold-<confidence threshold> après la valeur du paramètre answers, par extractive|threshold-0.9exemple . Le seuil par défaut est de 0,7. La longueur maximale des réponses peut être configurée en ajoutant le caractère barre verticale '|' suivi du 'count-number< of maximum character length>', tel que 'extractive|maxcharlength-600'.

Valeur	Description
none	Ne renvoyez pas de réponses à 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.

QueryCaptionResult

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 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.

QueryCaptionType

Énumération

Ce paramètre n’est valide que si le type de requête est semantic. Si elle est définie, la requête retourne des légendes extraites des passages clés dans les documents classés les plus élevés. Lorsque l’option Sous-titres est définie sur extractive, la mise en surbrillance est activée par défaut et peut être configurée en ajoutant la barre | verticale suivie de l’option highlight-<true/false> , telle que extractive|highlight-true. La valeur par défaut est None. La longueur maximale des caractères des légendes peut être configurée en ajoutant le caractère pipe '|' suivi du 'count-number< of maximum character length>', tel que 'extractive|maxcharlength-600'.

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. Vous pouvez activer plusieurs modes de débogage simultanément en les séparant par un | caractère, par exemple : semantic|queryRewrites.

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.
vector	Permet à l’utilisateur d’explorer davantage ses résultats de requête hybride et vectorielle.
queryRewrites	Permet à l’utilisateur d’explorer la liste des réécritures de requête générées pour sa requête de recherche.
innerHits	Permet à l’utilisateur de récupérer des informations de score concernant des vecteurs appariés au sein d’une collection de types complexes.
all	Activez toutes les options de débogage.

QueryLanguage

Énumération

Langue de la requête.

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

QueryResultDocumentSubscores

Objet

Répartition des sous-scores entre les composants de requête de texte et de requête vectorielle de la requête de recherche pour ce document. Chaque requête vectorielle s’affiche sous la forme d’un objet distinct dans le même ordre qu’ils ont été reçus.

Nom	Type	Description
documentBoost	number (double)	Score BM25 ou Classique pour la partie texte de la requête.
text	TextResult	Score BM25 ou Classique pour la partie texte de la requête.
vectors	<string, SingleVectorFieldResult>	La similarité vectorielle et

QueryRewritesDebugInfo

Objet

Contient des informations de débogage spécifiques aux réécritures de requête.

Nom	Type	Description
text	QueryRewritesValuesDebugInfo	Liste des réécritures de requête générées pour la requête textuelle.
vectors	QueryRewritesValuesDebugInfo[]	Liste des réécritures de requêtes générées pour les requêtes de texte vectorisables.

QueryRewritesType

Énumération

Ce paramètre n’est valide que si le type de requête est semantic. Lorsque QueryRewrites est défini sur generative, les termes de requête sont envoyés à un modèle de génération qui produira 10 réécritures (par défaut) pour aider à augmenter le rappel de la demande. Le nombre demandé peut être configuré en ajoutant la barre | verticale suivie de l’option count-<number of rewrites> , telle que generative|count-3. La valeur par défaut est None.

Valeur	Description
none	Ne générez pas de réécritures de requête supplémentaires pour cette requête.
generative	Générez d’autres termes de requête pour augmenter le rappel d’une demande de recherche.

QueryRewritesValuesDebugInfo

Objet

Contient des informations de débogage spécifiques aux réécritures de requête.

Nom	Type	Description
inputQuery	string	Texte d’entrée du modèle de réécriture de requête générative. Il peut y avoir des cas où la requête de l’utilisateur et l’entrée du modèle génératif ne sont pas identiques.
rewrites	string[]	Liste des réécritures de requêtes.

QuerySpellerType

Énumération

Améliorez le rappel de recherche en corrigeant les termes de requête de recherche individuels.

Valeur	Description
none	Correcteur orthographique non activé.
lexicon	Le correcteur d’orthographe corrige les termes de requête individuels à l’aide d’un lexique statique pour la langue spécifiée 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 'semantic' 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 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.

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 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

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 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	QueryAnswerResult[]	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.debug	DebugInfo	Déboguer des informations qui s’appliquent aux résultats de la recherche dans son ensemble.
@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 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 en même temps que
@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.
@search.semanticQueryRewritesResultType	SemanticQueryRewritesResultType	Type de réécriture de requête utilisé pour récupérer des documents.
value	SearchResult[]	Séquence de résultats retourné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

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>.
hybridSearch	HybridSearch	Paramètres de requête pour configurer les comportements de recherche hybride.
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 des expressions OData $orderby séparées par des virgules permettant de 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.
queryRewrites	QueryRewritesType	Valeur qui spécifie si des réécritures de requête doivent être générées pour augmenter 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 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 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 des champs à récupérer, séparés par des virgules. 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 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.
semanticFields	string	Liste des noms de champs séparés par des virgules utilisée pour le classement sémantique.
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 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	Une valeur qui spécifie le type de l’orthographe à utiliser pour corriger chaque requête de recherche par l’orthographe.
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 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[]: VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[] VectorizedQuery[]	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	QueryCaptionResult[]	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 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 par RerankerScore/RerankerBoostedScore en fonction de useScoringProfileBoostedRanking dans la configuration sémantique. RerankerBoostedScore n’est retourné que pour les requêtes de type « sémantique ».
@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.

SearchScoreThreshold

Objet

Les résultats de la requête vectorielle seront filtrés selon le '

Nom	Type	Description
kind	string: searchScore	Un type de seuil.
value	number (double)	Le seuil filtrera en fonction de la

SemanticDebugInfo

Objet

Contient des informations de débogage spécifiques aux demandes de classement sémantique.

Nom	Type	Description
contentFields	QueryResultDocumentSemanticField[]	Les champs de contenu qui ont été envoyés au processus d’enrichissement sémantique, ainsi que leur utilisation
keywordFields	QueryResultDocumentSemanticField[]	Les champs de mots-clés qui ont été envoyés au processus d’enrichissement sémantique, ainsi que leur utilisation
rerankerInput	QueryResultDocumentRerankerInput	Chaînes concaténées brutes envoyées au processus d’enrichissement sémantique.
titleField	QueryResultDocumentSemanticField	Le champ de titre qui a été envoyé au processus d’enrichissement sémantique, ainsi que son utilisation

SemanticErrorMode

Énumération

Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou de retourner 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é.

SemanticFieldState

Énumération

La façon dont le champ a été utilisé pour le processus d’enrichissement sémantique.

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.

SemanticQueryRewritesResultType

Énumération

Type de réécriture de requête utilisé pour cette demande.

Valeur	Description
originalQueryOnly	Les réécritures de requête n’ont pas été générées pour cette demande. Seule la requête d’origine a été utilisée pour récupérer les résultats.

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

Objet

Résultat d’un champ vectoriel unique. Les deux

Nom	Type	Description
searchScore	number (double)	Les
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

Objet

Score BM25 ou Classique pour la partie texte de la requête.

Nom	Type	Description
searchScore	number (double)	Score BM25 ou Classique 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 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.
strictPostFilter	Le filtre sera appliqué après le retour de l’ensemble global des k premiers résultats vectoriels. Cela se traduira par moins de résultats que ce qui est demandé par le paramètre 'k'.

VectorizableImageBinaryQuery

Objet

Les paramètres de requête à utiliser pour la recherche vectorielle lorsqu’un binaire codé en base 64 d’une image devant être vectorisée est fourni.

Nom	Type	Description
base64Image	string	Le binaire encodé en base 64 d’une image à vectoriser pour effectuer une requête de recherche vectorielle.
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é.
filterOverride	string	Expression de filtre OData à appliquer à cette requête vectorielle spécifique. Si aucune expression de filtre n’est définie au niveau du vecteur, l’expression définie dans le paramètre de filtre de niveau supérieur est utilisée à la place.
k	integer (int32)	Nombre de voisins les plus proches à retourner en tant que premiers coups.
kind	string: imageBinary	Type de requête.
oversampling	number (double)	Facteur de surachantillonnage. La valeur minimale est 1. Il remplace le paramètre « defaultOversampling » configuré dans la définition d’index. Elle ne peut être définie que lorsque « rerankWithOriginalVectors » a la valeur true. Ce paramètre est autorisé uniquement lorsqu’une méthode de compression est utilisée sur le champ vectoriel sous-jacent.
perDocumentVectorLimit	integer (int32)	Contrôle le nombre de vecteurs pouvant être mis en correspondance à partir de chaque document dans une requête de recherche vectorielle. La définition de 1 garantit qu’au plus un vecteur par document est mis en correspondance, ce qui garantit que les résultats proviennent de documents distincts. La définition de 0 (illimité) permet de faire correspondre plusieurs vecteurs pertinents du même document. La valeur par défaut est 0.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Seuil utilisé pour les requêtes vectorielles. Notez que cela ne peut être défini que si tous les « champs » utilisent la même métrique de similarité.
weight	number (float)	Poids relatif de la requête vectorielle par rapport à une autre requête vectorielle et/ou à la requête de texte dans 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 les résultats récupérés via la requête de texte. Plus le poids est élevé, plus les documents correspondants à cette requête seront dans le classement final. La valeur par défaut est 1.0 et la valeur doit être un nombre positif supérieur à zéro.

VectorizableImageUrlQuery

Objet

Les paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une URL qui représente une valeur d’image qui doit ê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é.
filterOverride	string	Expression de filtre OData à appliquer à cette requête vectorielle spécifique. Si aucune expression de filtre n’est définie au niveau du vecteur, l’expression définie dans le paramètre de filtre de niveau supérieur est utilisée à la place.
k	integer (int32)	Nombre de voisins les plus proches à retourner en tant que premiers coups.
kind	string: imageUrl	Type de requête.
oversampling	number (double)	Facteur de surachantillonnage. La valeur minimale est 1. Il remplace le paramètre « defaultOversampling » configuré dans la définition d’index. Elle ne peut être définie que lorsque « rerankWithOriginalVectors » a la valeur true. Ce paramètre est autorisé uniquement lorsqu’une méthode de compression est utilisée sur le champ vectoriel sous-jacent.
perDocumentVectorLimit	integer (int32)	Contrôle le nombre de vecteurs pouvant être mis en correspondance à partir de chaque document dans une requête de recherche vectorielle. La définition de 1 garantit qu’au plus un vecteur par document est mis en correspondance, ce qui garantit que les résultats proviennent de documents distincts. La définition de 0 (illimité) permet de faire correspondre plusieurs vecteurs pertinents du même document. La valeur par défaut est 0.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Seuil utilisé pour les requêtes vectorielles. Notez que cela ne peut être défini que si tous les « champs » utilisent la même métrique de similarité.
url	string	URL d’une image à vectoriser pour effectuer une requête de recherche vectorielle.
weight	number (float)	Poids relatif de la requête vectorielle par rapport à une autre requête vectorielle et/ou à la requête de texte dans 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 les résultats récupérés via la requête de texte. Plus le poids est élevé, plus les documents correspondants à cette requête seront dans le classement final. La valeur par défaut est 1.0 et la valeur doit être un nombre positif supérieur à zéro.

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é.
filterOverride	string	Expression de filtre OData à appliquer à cette requête vectorielle spécifique. Si aucune expression de filtre n’est définie au niveau du vecteur, l’expression définie dans le paramètre de filtre de niveau supérieur est utilisée à la place.
k	integer (int32)	Nombre de voisins les plus proches à retourner en tant que premiers coups.
kind	string: text	Type de requête.
oversampling	number (double)	Facteur de surachantillonnage. La valeur minimale est 1. Il remplace le paramètre « defaultOversampling » configuré dans la définition d’index. Elle ne peut être définie que lorsque « rerankWithOriginalVectors » a la valeur true. Ce paramètre est autorisé uniquement lorsqu’une méthode de compression est utilisée sur le champ vectoriel sous-jacent.
perDocumentVectorLimit	integer (int32)	Contrôle le nombre de vecteurs pouvant être mis en correspondance à partir de chaque document dans une requête de recherche vectorielle. La définition de 1 garantit qu’au plus un vecteur par document est mis en correspondance, ce qui garantit que les résultats proviennent de documents distincts. La définition de 0 (illimité) permet de faire correspondre plusieurs vecteurs pertinents du même document. La valeur par défaut est 0.
queryRewrites	QueryRewritesType	Peut être configuré pour permettre à un modèle génératif de réécrire la requête avant de l’envoyer à vectoriser.
text	string	Texte à vectoriser pour effectuer une requête de recherche vectorielle.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Seuil utilisé pour les requêtes vectorielles. Notez que cela ne peut être défini que si tous les « champs » utilisent la même métrique de similarité.
weight	number (float)	Poids relatif de la requête vectorielle par rapport à une autre requête vectorielle et/ou à la requête de texte dans 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 les résultats récupérés via la requête de texte. Plus le poids est élevé, plus les documents correspondants à cette requête seront dans le classement final. La valeur par défaut est 1.0 et la valeur doit être un nombre positif supérieur à zéro.

VectorizedQuery

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é.
filterOverride	string	Expression de filtre OData à appliquer à cette requête vectorielle spécifique. Si aucune expression de filtre n’est définie au niveau du vecteur, l’expression définie dans le paramètre de filtre de niveau supérieur est utilisée à la place.
k	integer (int32)	Nombre de voisins les plus proches à retourner en tant que premiers coups.
kind	string: vector	Type de requête.
oversampling	number (double)	Facteur de surachantillonnage. La valeur minimale est 1. Il remplace le paramètre « defaultOversampling » configuré dans la définition d’index. Elle ne peut être définie que lorsque « rerankWithOriginalVectors » a la valeur true. Ce paramètre est autorisé uniquement lorsqu’une méthode de compression est utilisée sur le champ vectoriel sous-jacent.
perDocumentVectorLimit	integer (int32)	Contrôle le nombre de vecteurs pouvant être mis en correspondance à partir de chaque document dans une requête de recherche vectorielle. La définition de 1 garantit qu’au plus un vecteur par document est mis en correspondance, ce qui garantit que les résultats proviennent de documents distincts. La définition de 0 (illimité) permet de faire correspondre plusieurs vecteurs pertinents du même document. La valeur par défaut est 0.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Seuil utilisé pour les requêtes vectorielles. Notez que cela ne peut être défini que si tous les « champs » utilisent la même métrique de similarité.
vector	number[] (float)	Représentation vectorielle d’une requête de recherche.
weight	number (float)	Poids relatif de la requête vectorielle par rapport à une autre requête vectorielle et/ou à la requête de texte dans 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 les résultats récupérés via la requête de texte. Plus le poids est élevé, plus les documents correspondants à cette requête seront 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.
imageUrl	Requête vectorielle dans laquelle une URL représentant une valeur d’image qui doit être vectorisée est fournie.
imageBinary	Requête vectorielle dans laquelle un binaire encodé en base 64 d’une image qui doit être vectorisée est fourni.

VectorsDebugInfo

Objet

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

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.

VectorSimilarityThreshold

Objet

Les résultats de la requête vectorielle seront filtrés en fonction de la métrique de similarité vectorielle. Notez qu’il s’agit de la définition canonique de la métrique de similarité, et non de la version « distance ». La direction du seuil (plus grande ou plus petite) sera choisie automatiquement en fonction de la métrique utilisée par le champ.

Nom	Type	Description
kind	string: vectorSimilarity	Un type de seuil.
value	number (double)	Le seuil sera filtré en fonction de la valeur de la métrique de similarité. Notez qu’il s’agit de la définition canonique de la métrique de similarité, et non de la version « distance ». La direction du seuil (plus grande ou plus petite) sera choisie automatiquement en fonction de la métrique utilisée par le champ.

VectorThresholdKind

Énumération

Le type de seuil utilisé pour filtrer les requêtes vectorielles.

Valeur	Description
vectorSimilarity	Les résultats de la requête vectorielle seront filtrés en fonction de la métrique de similarité vectorielle. Notez qu’il s’agit de la définition canonique de la métrique de similarité, et non de la version « distance ». La direction du seuil (plus grande ou plus petite) sera choisie automatiquement en fonction de la métrique utilisée par le champ.
searchScore	Les résultats de la requête vectorielle filtrent en fonction de la valeur « @search.score ». Notez qu’il s’agit de la @search.score retournée dans le cadre de la réponse de recherche. La direction du seuil sera choisie pour une @search.scoresupérieure.