Documents - Search Post

Référence

Service:: Search Service

Version d'API:: 2024-09-01-preview

Recherche des documents dans l’index.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	URL du point de terminaison du service de recherche.
indexName	path	True	string	Nom de l’index.
api-version	query	True	string	Version de l’API cliente.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string uuid	ID de suivi envoyé avec la demande pour faciliter le débogage.

Corps de la demande

Nom	Type	Description
answers	QueryAnswerType	Valeur qui spécifie si les réponses doivent être retournées dans le cadre de la réponse de recherche.
captions	QueryCaptionType	Valeur qui spécifie si les légendes doivent être retournées dans le cadre de la réponse de recherche.
count	boolean	Valeur qui spécifie s’il faut extraire le nombre total de résultats. La valeur par défaut est false. La définition de cette valeur sur true peut avoir un impact sur les performances. Notez que le nombre retourné est une approximation.
debug	QueryDebugMode	Active un outil de débogage qui peut être utilisé pour explorer davantage vos résultats reclassés.
facets	string[]	Liste des expressions de facette à appliquer à la requête de recherche. Chaque expression de facette contient un nom de champ, éventuellement suivi d’une liste séparée par des virgules de paires name :value.
filter	string	L’expression OData $filter à appliquer à la requête de recherche.
highlight	string	Liste séparée par des virgules des noms de champs à utiliser pour les surbrillances d’accès. Seuls les champs pouvant faire l’objet d’une recherche peuvent être utilisés pour la mise en surbrillance des accès.
highlightPostTag	string	Balise de chaîne ajoutée aux surbrillances d’accès. Doit être défini avec highlightPreTag. La valeur par défaut est </em>.
highlightPreTag	string	Balise de chaîne qui est précédée de mises en surbrillance. Doit être défini avec highlightPostTag. La valeur par défaut est <em>.
hybridSearch	HybridSearch	Paramètres de requête pour configurer les comportements de recherche hybride.
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.
queryLanguage	QueryLanguage	Valeur qui spécifie la langue de la requête de recherche.
queryType	QueryType	Valeur qui spécifie la syntaxe de la requête de recherche. La valeur par défaut est « simple ». Utilisez « full » si votre requête utilise la syntaxe de requête Lucene.
scoringParameters	string[]	Liste des valeurs de paramètre à utiliser dans les fonctions de scoring (par exemple, referencePointParameter) à l’aide des valeurs de nom de format. Par exemple, si le profil de scoring définit une fonction avec un paramètre appelé « mylocation », la chaîne de paramètre est « mylocation--122.2,44.8 » (sans les guillemets).
scoringProfile	string	Nom d’un profil de scoring pour évaluer les scores de correspondance pour les documents correspondants afin de trier les résultats.
scoringStatistics	ScoringStatistics	Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence inférieure. La valeur par défaut est « local ». Utilisez « global » pour agréger les statistiques de scoring globalement avant le scoring. L’utilisation des statistiques de scoring globales peut augmenter la latence des requêtes de recherche.
search	string	Expression de requête de recherche en texte intégral ; Utilisez « * » ou omettez ce paramètre pour faire correspondre tous les documents.
searchFields	string	Liste séparée par des virgules des noms de champs auxquels étendre la recherche en texte intégral. Lors de l’utilisation de la recherche fielded (fieldName :searchExpression) dans une requête Lucene complète, les noms de champs de chaque expression de recherche fielded sont prioritaires sur tous les noms de champs répertoriés dans ce paramètre.
searchMode	SearchMode	Valeur qui spécifie si l’un ou l’ensemble des termes de recherche doivent être mis en correspondance pour compter le document comme correspondance.
select	string	Liste de champs séparés par des virgules à récupérer. S’il n’est pas spécifié, tous les champs marqués comme récupérables dans le schéma sont inclus.
semanticConfiguration	string	Nom d’une configuration sémantique qui sera utilisée lors du traitement de documents pour les requêtes sémantiques de type.
semanticErrorHandling	SemanticErrorMode	Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement (comportement par défaut/actuel) ou retourner des résultats partiels.
semanticFields	string	Liste séparée par des virgules des noms de champs utilisés pour le classement sémantique.
semanticMaxWaitInMilliseconds	integer	Permet à l’utilisateur de définir une limite supérieure sur 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.
speller	QuerySpellerType	Valeur qui a spécifié le type de l’orthographique à utiliser pour corriger les termes de requête de recherche individuels.
top	integer	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[] VectorizableImageUrlQuery[] VectorizableImageBinaryQuery[]	Paramètres de requête pour les requêtes de recherche vectorielle et hybride.

Réponses

Nom	Type	Description
200 OK	SearchDocumentsResult	Réponse contenant des documents qui correspondent aux critères de recherche.
Other Status Codes	ErrorResponse	Réponse d’erreur.

Exemples

SearchIndexSearchDocumentsPost

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Exemple de requête

HTTP

POST https://previewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.search?api-version=2024-09-01-preview


{
  "count": true,
  "facets": [
    "ownerId"
  ],
  "filter": "category eq 'purple' or category eq 'pink'",
  "highlight": "category",
  "highlightPostTag": "</em>",
  "highlightPreTag": "</em>",
  "orderby": "id desc",
  "queryType": "simple",
  "scoringStatistics": "global",
  "sessionId": "mysessionid",
  "scoringParameters": [
    "categoryTag:desiredCategoryValue"
  ],
  "scoringProfile": "stringFieldBoost",
  "search": "purple",
  "searchFields": "id,name,description,category,ownerId",
  "searchMode": "any",
  "select": "id,name,description,category,ownerId",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "vector": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9
      ],
      "kind": "vector",
      "k": 50,
      "fields": "vector22, vector1b",
      "oversampling": 20,
      "weight": 1,
      "threshold": {
        "value": 0.984,
        "kind": "vectorSimilarity"
      },
      "filterOverride": "ownerId eq 'sam'"
    }
  ],
  "vectorFilterMode": "preFilter",
  "hybridSearch": {
    "maxTextRecallSize": 100,
    "countAndFacetMode": "countAllResults"
  }
}

Exemple de réponse

Code d’état:: 200

{
  "@odata.count": 27,
  "@search.facets": {
    "ownerId": [
      {
        "count": 16,
        "value": "sam"
      },
      {
        "count": 8,
        "value": "ryan"
      },
      {
        "count": 3,
        "value": "benny"
      }
    ]
  },
  "value": [
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "9",
      "name": "test",
      "description": "test9 hello",
      "category": "purple",
      "ownerId": "ryan"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "6",
      "name": "test",
      "description": "test6 hello",
      "category": "purple",
      "ownerId": "ryan"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "3",
      "name": "test",
      "description": "test3 hello",
      "category": "purple",
      "ownerId": "ryan"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "24",
      "name": "test",
      "description": "test24 hello",
      "category": "purple",
      "ownerId": "ryan"
    }
  ]
}

SearchIndexSearchDocumentsSemanticPost

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
AnswerResult	Une réponse est un passage de texte extrait du contenu des documents les plus pertinents correspondant à la requête. Les réponses sont extraites des résultats de recherche principaux. Les candidats à la réponse sont marqués et les premières réponses sont sélectionnées.
CaptionResult	Les légendes sont les passages les plus représentatifs du document relativement à la requête de recherche. Ils sont souvent utilisés comme résumé de document. Les légendes sont retournées uniquement pour les requêtes de type `semantic`.
DocumentDebugInfo	Contient des informations de débogage qui peuvent être utilisées pour explorer davantage vos résultats de recherche.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
HybridCountAndFacetMode	Détermine si le nombre et les facettes doivent inclure tous les documents correspondant à 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.
QueryAnswerType	Valeur qui spécifie si les réponses doivent être retournées dans le cadre de la réponse de recherche.
QueryCaptionType	Valeur qui spécifie si les légendes doivent être retournées dans le cadre de la réponse de recherche.
QueryDebugMode	Active un outil de débogage qui peut être utilisé pour explorer davantage vos résultats de recherche.
QueryLanguage	Langue de la requête.
QueryResultDocumentRerankerInput	Chaînes concaténées brutes envoyées au processus d’enrichissement sémantique.
QueryResultDocumentSemanticField	Description des champs envoyés au processus d’enrichissement sémantique, ainsi que la façon dont ils ont été utilisés
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.
QuerySpellerType	Valeur qui a spécifié le type de l’orthographique à utiliser pour corriger les termes de requête de recherche individuels.
QueryType	Spécifie la syntaxe de la requête de recherche. La valeur par défaut est « simple ». Utilisez « full » si votre requête utilise la syntaxe de requête Lucene et « sémantique » si la syntaxe de requête n’est pas nécessaire.
RawVectorQuery	Paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur vectorielle brute est fournie.
ScoringStatistics	Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence inférieure. La valeur par défaut est « local ». Utilisez « global » pour agréger les statistiques de scoring globalement avant le scoring. L’utilisation des statistiques de scoring globales peut augmenter la latence des requêtes de recherche.
SearchDocumentsResult	Réponse contenant des résultats de recherche à partir d’un index.
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.
SearchScoreThreshold	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.
SemanticDebugInfo
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.
SemanticFieldState	La façon dont le champ a été utilisé pour le processus d’enrichissement sémantique (entièrement utilisé, partiellement utilisé ou inutilisé)
SemanticSearchResultsType	Type de réponse partielle retournée pour une demande de classement sémantique.
SingleVectorFieldResult	Résultat d’un champ vectoriel unique. Les valeurs @search.score et de similarité vectorielle sont retournées. La similarité vectorielle est liée à @search.score par une équation.
TextResult	Score BM25 ou Classique pour la partie texte de la requête.
VectorFilterMode	Détermine si les 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.
VectorQueryKind	Type de requête vectorielle en cours d’exécution.
VectorsDebugInfo
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	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.

DocumentDebugInfo

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

Nom	Type	Description
semantic	SemanticDebugInfo	Contient des informations de débogage spécifiques aux demandes de classement sémantique.
vectors	VectorsDebugInfo	Contient des informations de débogage spécifiques à la recherche vectorielle et hybride.

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.

HybridCountAndFacetMode

Détermine si le nombre et les facettes doivent inclure tous les documents correspondant à 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 ».

Nom	Type	Description
countAllResults	string	Incluez tous les documents qui ont été mis en correspondance par la requête de recherche lors de l’informatique de « count » et de « facettes », que ces documents se trouvent ou non dans la fenêtre de récupération « maxTextRecallSize ».
countRetrievableResults	string	Incluez uniquement les documents qui ont été mis en correspondance dans la fenêtre de récupération « maxTextRecallSize » lorsque vous calculez « count » et « facets ».

HybridSearch

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 correspondant à la requête de recherche ou uniquement les documents récupérés dans la fenêtre « maxTextRecallSize ».
maxTextRecallSize	integer	Détermine le nombre maximal de documents à récupérer par la partie requête de texte 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 grande permet de récupérer et de paginer davantage de documents (en utilisant les paramètres supérieurs et ignorer), au coût 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.

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.

QueryDebugMode

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

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

QueryLanguage

Langue de la requête.

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

QueryResultDocumentRerankerInput

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

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

QueryResultDocumentSemanticField

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

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

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.

Nom	Type	Description
documentBoost	number	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>	Similarité de vecteur et valeurs @search.score pour chaque requête vectorielle.

QuerySpellerType

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

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

QueryType

Spécifie la syntaxe de la requête de recherche. La valeur par défaut est « simple ». Utilisez « full » si votre requête utilise la syntaxe de requête Lucene et « sémantique » si la syntaxe de requête n’est pas nécessaire.

Nom	Type	Description
full	string	Utilise la syntaxe de requête Lucene complète pour les recherches. 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é.
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	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.
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[]	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.
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	Nombre compris entre 0 et 100 indiquant le pourcentage de l’index qui doit être couvert par une requête de recherche afin que la requête soit signalée comme une réussite. Ce paramètre peut être utile pour garantir la disponibilité de la recherche même pour les services avec un seul réplica. La valeur par défaut est 100.
orderby	string	Liste séparée par des virgules d’OData $orderby expressions par lesquelles trier les résultats. Chaque expression peut être un nom de champ ou un appel aux fonctions geo.distance() ou search.score(). Chaque expression peut être suivie d’asc pour indiquer l’ordre croissant ou desc pour indiquer l’ordre décroissant. La valeur par défaut est l’ordre croissant. Les liens seront rompus par les scores de correspondance des documents. Si aucune $orderby n’est spécifiée, l’ordre de tri par défaut descend par score de correspondance de document. Il peut y avoir au maximum 32 clauses $orderby.
queryLanguage	QueryLanguage	Valeur qui spécifie la langue de la requête de recherche.
queryType	QueryType	Valeur qui spécifie la syntaxe de la requête de recherche. La valeur par défaut est « simple ». Utilisez « full » si votre requête utilise la syntaxe de requête Lucene.
scoringParameters	string[]	Liste des valeurs de paramètre à utiliser dans les fonctions de scoring (par exemple, referencePointParameter) à l’aide des valeurs de nom de format. Par exemple, si le profil de scoring définit une fonction avec un paramètre appelé « mylocation », la chaîne de paramètre est « mylocation--122.2,44.8 » (sans les guillemets).
scoringProfile	string	Nom d’un profil de scoring pour évaluer les scores de correspondance pour les documents correspondants afin de trier les résultats.
scoringStatistics	ScoringStatistics	Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence inférieure. La valeur par défaut est « local ». Utilisez « global » pour agréger les statistiques de scoring globalement avant le scoring. L’utilisation des statistiques de scoring globales peut augmenter la latence des requêtes de recherche.
search	string	Expression de requête de recherche en texte intégral ; Utilisez « * » ou omettez ce paramètre pour faire correspondre tous les documents.
searchFields	string	Liste séparée par des virgules des noms de champs auxquels étendre la recherche en texte intégral. Lors de l’utilisation de la recherche fielded (fieldName :searchExpression) dans une requête Lucene complète, les noms de champs de chaque expression de recherche fielded sont prioritaires sur tous les noms de champs répertoriés dans ce paramètre.
searchMode	SearchMode	Valeur qui spécifie si l’un ou l’ensemble des termes de recherche doivent être mis en correspondance pour compter le document comme correspondance.
select	string	Liste de champs séparés par des virgules à récupérer. S’il n’est pas spécifié, tous les champs marqués comme récupérables dans le schéma sont inclus.
semanticConfiguration	string	Nom d’une configuration sémantique qui sera utilisée lors du traitement de documents pour les requêtes sémantiques de type.
semanticErrorHandling	SemanticErrorMode	Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement (comportement par défaut/actuel) ou retourner des résultats partiels.
semanticFields	string	Liste séparée par des virgules des noms de champs utilisés pour le classement sémantique.
semanticMaxWaitInMilliseconds	integer	Permet à l’utilisateur de définir une limite supérieure sur 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.
speller	QuerySpellerType	Valeur qui a spécifié le type de l’orthographique à utiliser pour corriger les termes de requête de recherche individuels.
top	integer	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[] VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] 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.documentDebugInfo	DocumentDebugInfo[]	Contient des informations de débogage qui peuvent être utilisées pour explorer davantage vos résultats de recherche.
@search.highlights	object	Fragments de texte du document qui indiquent les termes de recherche correspondants, organisés par chaque champ applicable ; Null si la mise en surbrillance de l’accès n’a pas été activée pour la requête.
@search.rerankerScore	number	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.

SearchScoreThreshold

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.

Nom	Type	Description
kind	string: searchScore	Type de seuil utilisé pour filtrer les requêtes vectorielles
value	number	Le seuil filtre 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.

SemanticDebugInfo

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

SemanticErrorMode

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

SemanticFieldState

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

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

SemanticSearchResultsType

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

Nom	Type	Description
baseResults	string	Résultats sans enrichissement sémantique ni reclassement.
rerankedResults	string	Les résultats ont été reclassés avec le modèle de reclassement et 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.

SingleVectorFieldResult

Résultat d’un champ vectoriel unique. Les valeurs @search.score et de similarité vectorielle sont retournées. La similarité vectorielle est liée à @search.score par une équation.

Nom	Type	Description
searchScore	number	Valeur @search.score calculée à partir du score de similarité vectorielle. Il s’agit du score visible dans une requête à vecteur unique pur.
vectorSimilarity	number	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, la similarité cosinus au lieu de la distance cosinus.

TextResult

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

Nom	Type	Description
searchScore	number	Score BM25 ou Classique pour la partie texte de la requête.

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.

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.

Nom	Type	Description
base64Image	string	Binaire codé 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	Nombre de voisins les plus proches à retourner en tant que premiers coups.
kind	string: imageBinary	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.
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	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

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	Nombre de voisins les plus proches à retourner en tant que premiers coups.
kind	string: imageUrl	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.
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	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

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	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.
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	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
imageBinary	string	Requête vectorielle où un binaire codé en base 64 d’une image qui doit être vectorisée est fourni.
imageUrl	string	Requête vectorielle où une URL qui représente une valeur d’image qui doit être vectorisée est fournie.
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.

VectorsDebugInfo

Nom	Type	Description
subscores	QueryResultDocumentSubscores	Répartition des sous-scores du document avant la méthode fusion/combinaison du jeu de résultats choisi, telle que RRF.

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.

Nom	Type	Description
kind	string: vectorSimilarity	Type de seuil utilisé pour filtrer les requêtes vectorielles
value	number	Le seuil filtre en fonction de la valeur de 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

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

Nom	Type	Description
searchScore	string	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.
vectorSimilarity	string	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.

Partager via

Documents - Search Post

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Exemples

SearchIndexSearchDocumentsPost

Exemple de requête

Exemple de réponse

SearchIndexSearchDocumentsSemanticPost

Exemple de requête

Exemple de réponse

Définitions

AnswerResult

CaptionResult

DocumentDebugInfo

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HybridCountAndFacetMode

HybridSearch

QueryAnswerType

QueryCaptionType

QueryDebugMode

QueryLanguage

QueryResultDocumentRerankerInput

QueryResultDocumentSemanticField

QueryResultDocumentSubscores

QuerySpellerType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SearchScoreThreshold

SemanticDebugInfo

SemanticErrorMode

SemanticErrorReason

SemanticFieldState

SemanticSearchResultsType

SingleVectorFieldResult

TextResult

VectorFilterMode

VectorizableImageBinaryQuery

VectorizableImageUrlQuery

VectorizableTextQuery

VectorQueryKind

VectorsDebugInfo

VectorSimilarityThreshold

VectorThresholdKind

Ressources supplémentaires