Documents - Search Get

Référence

Service:: Search Service

Version d'API:: 2024-07-01

Recherche des documents dans l’index.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-07-01

Avec des paramètres facultatifs:

GET {endpoint}/indexes('{indexName}')/docs?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}&api-version=2024-07-01&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}

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.
$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 d’asc pour indiquer l’ordre croissant et 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 aucun orderBy n’est spécifié, l’ordre de tri par défaut descend par score de correspondance de 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 avez besoin d’analyser des documents en séquence, mais ne pouvez pas utiliser $skip en raison de cette limitation, envisagez d’utiliser $orderby sur une clé totalement ordonnée et $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 elle est définie, la requête retourne des réponses extraites des passages clés dans les documents classés les plus élevés. Le nombre de réponses retournées peut être configuré en ajoutant le caractère de canal `\|` suivi de l’option `count-<number of answers>` après la valeur du paramètre de réponses, telle que `extractive\|count-3`. Le nombre par défaut est 1. Le seuil de confiance peut être configuré en ajoutant le caractère de canal `\|` suivi de l’option `threshold-<confidence threshold>` après la valeur du paramètre de réponses, telle que `extractive\|threshold-0.9`. Le seuil par défaut est 0,7.
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 les légendes sont définies sur `extractive`, la mise en surbrillance est activée par défaut et peut être configurée en ajoutant le caractère de canal `\|` suivi de l’option `highlight-<true/false>`, telle que `extractive\|highlight-true`. La valeur par défaut est `None`.
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[]	Liste 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	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.
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	Expression de requête de recherche en texte intégral ; Utilisez « * » ou omettez ce paramètre pour faire correspondre tous les documents.
searchFields	query		string[]	Liste 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	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 mises en surbrillance et les réponses
semanticErrorHandling	query		SemanticErrorMode	Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou retourner des résultats partiels (par défaut).
semanticMaxWaitInMilliseconds	query		integer int32	Permet à l’utilisateur de définir une limite supérieure sur la durée nécessaire à l’enrichissement sémantique pour terminer le traitement avant l’échec de la requête.
semanticQuery	query		string	Permet de définir une requête de recherche distincte qui sera utilisée uniquement pour la reranking sémantique, les légendes sémantiques et les réponses sémantiques. Est utile pour les scénarios où il est nécessaire d’utiliser différentes requêtes entre la phase de récupération de base et de classement, et la phase sémantique L2.
sessionId	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 '_'.

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.

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

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

Exemple de requête

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?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&api-version=2024-07-01

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

SearchIndexSearchDocumentsSemanticGet

Exemple de requête

HTTP

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

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

Définitions

Nom	Description
AnswerResult	Une réponse est un passage de texte extrait du contenu des documents les plus pertinents correspondant à la requête. Les réponses sont extraites des résultats de recherche principaux. Les candidats à la réponse sont marqués et les premières réponses sont sélectionnées.
CaptionResult	Les légendes sont les passages les plus représentatifs du document relativement à la requête de recherche. Ils sont souvent utilisés comme résumé de document. Les légendes sont retournées uniquement pour les requêtes de type `semantic`.
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.
QueryType	Spécifie la syntaxe de la requête de recherche. La valeur par défaut est « simple ». Utilisez « full » si votre requête utilise la syntaxe de requête Lucene.
RawVectorQuery	Paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur vectorielle brute est fournie.
ScoringStatistics	Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence inférieure. La valeur par défaut est « local ». Utilisez « global » pour agréger les statistiques de scoring globalement avant le scoring. L’utilisation des statistiques de scoring globales peut augmenter la latence des requêtes de recherche.
SearchDocumentsResult	Réponse contenant des résultats de recherche à partir d’un index.
SearchMode	Spécifie si l’un ou l’ensemble des termes de recherche doivent être mis en correspondance pour compter le document comme correspondance.
SearchRequest	Paramètres de filtrage, de tri, de facette, de pagination et d’autres comportements de requête de recherche.
SearchResult	Contient un document trouvé par une requête de recherche, ainsi que les métadonnées associées.
SemanticErrorMode	Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement (comportement par défaut/actuel) ou retourner des résultats partiels.
SemanticErrorReason	Raison pour laquelle une réponse partielle a été retournée pour une demande de classement sémantique.
SemanticSearchResultsType	Type de réponse partielle retournée pour une demande de classement sémantique.
VectorFilterMode	Détermine si les filtres sont appliqués avant ou après l’exécution de la recherche vectorielle.
VectorizableTextQuery	Les paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur de texte devant être vectorisée est fournie.
VectorQueryKind	Type de requête vectorielle en cours d’exécution.

AnswerResult

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

Nom	Type	Description
highlights	string	Même passage de texte que dans la propriété Text avec des expressions de texte en surbrillance les plus pertinentes pour la requête.
key	string	Clé du document à partir duquel la réponse a été extraite.
score	number	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 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 des expressions mises en surbrillance les plus pertinentes pour la requête.
text	string	Passage de texte représentatif extrait du document le plus pertinent pour la requête de recherche.

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

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 de réponse du contenu des documents retournés en réponse à une requête exprimée en tant que 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 légendes pour la requête.

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.

Nom	Type	Description
full	string	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	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 la recherche en re-classant les meilleurs résultats de 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. Le texte de recherche est interprété à l’aide d’un langage de requête simple qui permet des symboles tels que +, * et « ». Les requêtes sont évaluées sur tous les champs pouvant faire l’objet d’une recherche par défaut, sauf si le paramètre searchFields est spécifié.

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ù les correspondances exactes sont critiques, telles que la détermination des valeurs de vérité de base.
fields	string	Champs vectoriels de type Collection(Edm.Single) à inclure dans le vecteur recherché.
k	integer	Nombre de voisins les plus proches à retourner en tant que premiers coups.
kind	string: vector	Type de requête vectorielle en cours d’exécution.
oversampling	number	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.
vector	number[]	Représentation vectorielle d’une requête de recherche.
weight	number	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.

ScoringStatistics

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

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 inférieure.

SearchDocumentsResult

Réponse contenant des résultats de recherche à partir 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 Search pour obtenir la partie suivante de la réponse de recherche. Veillez à utiliser le même verbe (GET ou POST) que la requête qui a produit cette réponse.
@search.answers	AnswerResult[]	Résultats de la requête réponses pour l’opération de recherche ; Null si le paramètre de requête réponses n’a pas été spécifié ou défini sur « none ».
@search.coverage	number	Valeur indiquant le pourcentage de l’index inclus dans la requête ou null si minimumCoverage n’a pas été spécifié dans la requête.
@search.facets	object	Résultats de la requête de facette pour l’opération de recherche, organisés sous la forme d’une collection de compartiments pour chaque champ à facettes ; Null si la requête n’incluait aucune expression de facette.
@search.nextPageParameters	SearchRequest	Charge utile JSON de continuation retournée lorsque la requête ne peut pas retourner tous les résultats demandés dans une seule réponse. Vous pouvez utiliser ce code JSON avec @odata.nextLink pour formuler une autre requête POST Search pour obtenir la partie suivante de la réponse de recherche.
@search.semanticPartialResponseReason	SemanticErrorReason	Raison pour laquelle une réponse partielle a été retournée pour une demande de classement sémantique.
@search.semanticPartialResponseType	SemanticSearchResultsType	Type de réponse partielle retournée pour une demande de classement sémantique.
value	SearchResult[]	Séquence de résultats retournés par la requête.

SearchMode

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

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

SearchRequest

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

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.
facets	string[]	Liste des expressions de facette à appliquer à la requête de recherche. Chaque expression de facette contient un nom de champ, éventuellement suivi d’une liste séparée par des virgules de paires name :value.
filter	string	L’expression OData $filter à appliquer à la requête de recherche.
highlight	string	Liste séparée par des virgules des noms de champs à utiliser pour les surbrillances d’accès. Seuls les champs pouvant faire l’objet d’une recherche peuvent être utilisés pour la mise en surbrillance des accès.
highlightPostTag	string	Balise de chaîne ajoutée aux surbrillances d’accès. Doit être défini avec highlightPreTag. La valeur par défaut est </em>.
highlightPreTag	string	Balise de chaîne qui est précédée de mises en surbrillance. Doit être défini avec highlightPostTag. La valeur par défaut est <em>.
minimumCoverage	number	Nombre compris entre 0 et 100 indiquant le pourcentage de l’index qui doit être couvert par une requête de recherche afin que la requête soit signalée comme une réussite. Ce paramètre peut être utile pour garantir la disponibilité de la recherche même pour les services avec un seul réplica. La valeur par défaut est 100.
orderby	string	Liste séparée par des virgules d’OData $orderby expressions par lesquelles trier les résultats. Chaque expression peut être un nom de champ ou un appel aux fonctions geo.distance() ou search.score(). Chaque expression peut être suivie d’asc pour indiquer l’ordre croissant ou desc pour indiquer l’ordre décroissant. La valeur par défaut est l’ordre croissant. Les liens seront rompus par les scores de correspondance des documents. Si aucune $orderby n’est spécifiée, l’ordre de tri par défaut descend par score de correspondance de document. Il peut y avoir au maximum 32 clauses $orderby.
queryType	QueryType	Valeur qui spécifie la syntaxe de la requête de recherche. La valeur par défaut est « simple ». Utilisez « full » si votre requête utilise la syntaxe de requête Lucene.
scoringParameters	string[]	Liste des valeurs de paramètre à utiliser dans les fonctions de scoring (par exemple, referencePointParameter) à l’aide des valeurs de nom de format. Par exemple, si le profil de scoring définit une fonction avec un paramètre appelé « mylocation », la chaîne de paramètre est « mylocation--122.2,44.8 » (sans les guillemets).
scoringProfile	string	Nom d’un profil de scoring pour évaluer les scores de correspondance pour les documents correspondants afin de trier les résultats.
scoringStatistics	ScoringStatistics	Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence inférieure. La valeur par défaut est « local ». Utilisez « global » pour agréger les statistiques de scoring globalement avant le scoring. L’utilisation des statistiques de scoring globales peut augmenter la latence des requêtes de recherche.
search	string	Expression de requête de recherche en texte intégral ; Utilisez « * » ou omettez ce paramètre pour faire correspondre tous les documents.
searchFields	string	Liste séparée par des virgules des noms de champs auxquels étendre la recherche en texte intégral. Lors de l’utilisation de la recherche fielded (fieldName :searchExpression) dans une requête Lucene complète, les noms de champs de chaque expression de recherche fielded sont prioritaires sur tous les noms de champs répertoriés dans ce paramètre.
searchMode	SearchMode	Valeur qui spécifie si l’un ou l’ensemble des termes de recherche doivent être mis en correspondance pour compter le document comme correspondance.
select	string	Liste de champs séparés par des virgules à récupérer. S’il n’est pas spécifié, tous les champs marqués comme récupérables dans le schéma sont inclus.
semanticConfiguration	string	Nom d’une configuration sémantique qui sera utilisée lors du traitement de documents pour les requêtes sémantiques de type.
semanticErrorHandling	SemanticErrorMode	Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement (comportement par défaut/actuel) ou retourner des résultats partiels.
semanticMaxWaitInMilliseconds	integer	Permet à l’utilisateur de définir une limite supérieure sur la durée nécessaire à l’enrichissement sémantique pour terminer le traitement avant l’échec de la requête.
semanticQuery	string	Permet de définir une requête de recherche distincte qui sera utilisée uniquement pour la reranking sémantique, les légendes sémantiques et les réponses sémantiques. Est utile pour les scénarios où il est nécessaire d’utiliser différentes requêtes entre la phase de récupération de base et de classement, et la phase sémantique L2.
sessionId	string	Valeur à utiliser pour créer une session sticky, qui peut vous aider à obtenir des résultats plus cohérents. Tant que le même id de session est utilisé, une tentative optimale sera effectuée pour cibler le même jeu de réplicas. Soyez prudent que la réutilisation des mêmes valeurs sessionID peut interférer à plusieurs reprises avec l’équilibrage de charge des requêtes entre les réplicas et affecter négativement les performances du service de recherche. La valeur utilisée en tant que sessionId ne peut pas commencer par un caractère '_'.
skip	integer	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.
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 recherche. Si les résultats sont tronqués en raison de la pagination côté serveur, la réponse inclut un jeton de continuation qui peut être utilisé pour émettre une autre demande de recherche pour la page suivante des résultats.
vectorFilterMode	VectorFilterMode	Détermine si les filtres sont appliqués avant ou après l’exécution de la recherche vectorielle. La valeur par défaut est « preFilter » pour les nouveaux index.
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 retournées uniquement pour les requêtes de type « sémantique ».
@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 ranker sémantique pour les résultats de recherche principaux. Les résultats de la recherche sont triés d’abord par RerankerScore, puis par score. RerankerScore n’est retourné que pour les requêtes de type « sémantique ».
@search.score	number	Score de pertinence du document par rapport à d’autres documents retournés par la requête.

SemanticErrorMode

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

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

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 requête a été limitée. Seuls les résultats de base ont été retournés.
maxWaitExceeded	string	Si `semanticMaxWaitInMilliseconds` a été définie 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é.

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 incluront des légendes sémantiques. Ils n’incluront aucune réponse, les mises en surbrillance des réponses ou les surbrillances de légende.

VectorFilterMode

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 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	string	Le filtre est appliqué avant la requête de recherche.

VectorizableTextQuery

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

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

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

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

Partager via

Documents - Search Get

Paramètres URI

En-tête de la demande

Réponses

Exemples

SearchIndexSearchDocumentsGet

Exemple de requête

Exemple de réponse

SearchIndexSearchDocumentsSemanticGet

Exemple de requête

Exemple de réponse

Définitions

AnswerResult

CaptionResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryAnswerType

QueryCaptionType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

VectorFilterMode

VectorizableTextQuery

VectorQueryKind

Ressources supplémentaires