Documents - Search Get
Recherche des documents dans l’index.
GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-05-01-preview
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-05-01-preview&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}&debug={debug}&queryLanguage={queryLanguage}&speller={speller}&semanticFields={semanticFields}
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
URL du point de terminaison du service de recherche. |
index
|
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 selon lesquelles trier les résultats. Chaque expression peut être un nom de champ ou un appel aux fonctions geo.distance() ou search.score(). Chaque expression peut être suivie d’asc pour indiquer la montée et de desc pour indiquer la décroissante. La valeur par défaut est l'ordre croissant. Les liens seront rompus par les scores de correspondance des documents. Si aucun OrderBy n’est spécifié, l’ordre de tri par défaut est décroissant par score de correspondance de document. Il peut y avoir au maximum 32 clauses $orderby. |
|
$select
|
query |
string[] |
Liste des champs à récupérer. Si aucune valeur n'est spécifiée, tous les champs marqués comme récupérables dans le schéma sont inclus. |
|
$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 dans l’ordre, mais que vous ne pouvez pas utiliser $skip en raison de cette limitation, envisagez d’utiliser $orderby sur une clé entièrement ordonnée et $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 la recherche. Si les résultats sont tronqués en raison de la pagination côté serveur, la réponse inclut un jeton de continuation qui peut être utilisé pour émettre une autre demande de recherche pour la page de résultats suivante. |
|
answers
|
query |
Ce paramètre est valide uniquement si le type de requête est |
||
captions
|
query |
Ce paramètre est valide uniquement si le type de requête est |
||
debug
|
query |
Active un outil de débogage qui peut être utilisé pour explorer plus en détail vos résultats de recherche. |
||
facet
|
query |
string[] |
Liste d’expressions de facette à appliquer à la requête de recherche. Chaque expression de facette contient un nom de champ, éventuellement suivi d’une liste séparée par des virgules de paires nom :valeur. |
|
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. |
|
highlight
|
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>. |
|
highlight
|
query |
string |
Balise de chaîne qui est ajoutée pour atteindre les surbrillances. Doit être défini avec highlightPostTag. La valeur par défaut est <em>. |
|
minimum
|
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 pour que la requête soit signalée en tant que réussite. Ce paramètre peut être utile pour garantir la disponibilité de la recherche, même pour les services avec un seul réplica. La valeur par défaut est 100. |
|
query
|
query |
Langue de la requête. |
||
query
|
query |
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. |
||
scoring
|
query |
string[] |
Liste des valeurs de paramètres à utiliser dans les fonctions de scoring (par exemple, referencePointParameter) à l’aide du format name-values. Par exemple, si le profil de scoring définit une fonction avec un paramètre appelé « mylocation », la chaîne de paramètre est « mylocation--122.2,44.8 » (sans les guillemets). |
|
scoring
|
query |
string |
Nom du profil de calcul de score utilisé pour évaluer les scores de correspondance des documents correspondants afin de trier les résultats. |
|
scoring
|
query |
Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence des documents) globalement pour un scoring plus cohérent, ou localement, pour une latence plus faible. |
||
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. |
|
search
|
query |
string[] |
Liste des noms de champs auxquels étendre la recherche en texte intégral. Lorsque vous utilisez la recherche sur champ (fieldName :searchExpression) dans une requête Lucene complète, les noms de champ de chaque expression de recherche avec champ sont prioritaires sur les noms de champs répertoriés dans ce paramètre. |
|
search
|
query |
Valeur qui spécifie si tout ou partie des termes de recherche doivent être mis en correspondance pour compter le document comme une correspondance. |
||
semantic
|
query |
string |
Nom de la configuration sémantique qui répertorie les champs à utiliser pour le classement sémantique, les légendes, les surbrillances et les réponses |
|
semantic
|
query |
Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou de retourner des résultats partiels (par défaut). |
||
semantic
|
query |
string[] |
Liste des noms de champs utilisés pour le classement sémantique. |
|
semantic
|
query |
integer int32 |
Permet à l’utilisateur de définir une limite supérieure sur le temps nécessaire à l’enrichissement sémantique pour terminer le traitement avant l’échec de la demande. |
|
semantic
|
query |
string |
Permet de définir une requête de recherche distincte qui sera utilisée uniquement pour le reclassement sémantique, les légendes sémantiques et les réponses sémantiques. Est utile pour les scénarios où il est nécessaire d’utiliser différentes requêtes entre la phase de récupération et de classement de base et la phase sémantique L2. |
|
session
|
query |
string |
Valeur à utiliser pour créer une session collante, ce qui peut aider à obtenir des résultats plus cohérents. Tant que le même sessionId est utilisé, une tentative optimale est effectuée pour cibler le même réplica ensemble. Méfiez-vous que la réutilisation répétée des mêmes valeurs sessionID peut interférer avec l’équilibrage de charge des requêtes entre les réplicas et nuire aux performances du service de recherche. La valeur utilisée comme sessionId ne peut pas commencer par un caractère « _ ». |
|
speller
|
query |
Améliorez le rappel de recherche en corrigeant l’orthographe des termes de requête de recherche individuels. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
ID de suivi envoyé avec la demande d’aide pour le débogage. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Réponse contenant des documents qui correspondent aux critères de recherche. |
|
Other Status Codes |
Réponse d’erreur. |
Exemples
SearchIndexSearchDocumentsGet
Exemple de requête
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-05-01-preview&speller={speller}
Exemple de réponse
{
"@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"
}
]
}
Définitions
Nom | Description |
---|---|
Answer |
Une réponse est un passage de texte extrait du contenu des documents les plus pertinents correspondant à la requête. Les réponses sont extraites des premiers résultats de recherche. Les candidats à la réponse sont notés et les premières réponses sont sélectionnées. |
Caption |
Les légendes sont les passages les plus représentatifs du document relativement à la requête de recherche. Ils sont souvent utilisés comme résumé de document. Les légendes sont uniquement retournées pour les requêtes de type « sémantique ». |
Document |
Contient des informations de débogage qui peuvent être utilisées pour explorer plus en détail vos résultats de recherche. |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Hybrid |
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 ». |
Hybrid |
T Paramètres de requête pour configurer les comportements de recherche hybride. |
Query |
Valeur qui spécifie si les réponses doivent être retournées dans le cadre de la réponse de recherche. |
Query |
Valeur qui spécifie si les légendes doivent être retournées dans le cadre de la réponse de recherche. |
Query |
Active un outil de débogage qui peut être utilisé pour explorer plus en détail vos résultats de recherche. |
Query |
Langue de la requête. |
Query |
Chaînes concaténées brutes envoyées au processus d’enrichissement sémantique. |
Query |
Description des champs qui ont été envoyés au processus d’enrichissement sémantique, ainsi que la façon dont ils ont été utilisés |
Query |
Valeur qui spécifiait le type de l’orthographe à utiliser pour corriger l’orthographe des termes de requête de recherche individuels. |
Query |
Spécifie la syntaxe de la requête de recherche. La valeur par défaut est « simple ». Utilisez « full » si votre requête utilise la syntaxe de requête Lucene et « semantic » si la syntaxe de requête n’est pas nécessaire. |
Raw |
Paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur vectorielle brute est fournie. |
Scoring |
Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence des documents) globalement pour un scoring plus cohérent, ou localement, pour une latence plus faible. La valeur par défaut est « local ». Utilisez « global » pour agréger les statistiques de scoring à l’échelle mondiale avant de scorer. L’utilisation des statistiques de scoring global peut augmenter la latence des requêtes de recherche. |
Search |
Réponse contenant les résultats de recherche d’un index. |
Search |
Indique si tous les termes recherchés ou l'un d'eux doivent correspondre pour que le document soit considéré comme une correspondance. |
Search |
Paramètres de filtrage, de tri, de facettes, de pagination et d’autres comportements de requête de recherche. |
Search |
Contient un document trouvé par une requête de recherche, ainsi que les métadonnées associées. |
Search |
Les résultats de la requête vectorielle sont filtrés en fonction de la valeur « @search.score ». Notez qu’il s’agit du @search.score retourné dans le cadre de la réponse de recherche. La direction du seuil est choisie pour les valeurs supérieures @search.score. |
Semantic |
|
Semantic |
Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou de retourner des résultats partiels (par défaut). |
Semantic |
Raison pour laquelle une réponse partielle a été retournée pour une demande de classement sémantique. |
Semantic |
La façon dont le champ a été utilisé pour le processus d’enrichissement sémantique (entièrement utilisé, partiellement utilisé ou non utilisé) |
Semantic |
Type de réponse partielle retournée pour une demande de classement sémantique. |
Speller |
Améliorez le rappel de recherche en corrigeant l’orthographe des termes de requête de recherche individuels. |
Vector |
Détermine si les filtres sont appliqués avant ou après l’exécution de la recherche vectorielle. |
Vectorizable |
Les paramètres de requête à utiliser pour la recherche vectorielle lorsqu’un binaire codé en base 64 d’une image qui doit être vectorisé est fourni. |
Vectorizable |
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. |
Vectorizable |
Paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur de texte qui doit être vectorisée est fournie. |
Vector |
Type de requête vectorielle en cours d’exécution. |
Vector |
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) est choisie automatiquement en fonction de la métrique utilisée par le champ. |
Vector |
Type de requête vectorielle en cours d’exécution. |
AnswerResult
Une réponse est un passage de texte extrait du contenu des documents les plus pertinents correspondant à la requête. Les réponses sont extraites des premiers résultats de recherche. Les candidats à la réponse sont notés et les premières réponses sont sélectionnées.
Nom | Type | Description |
---|---|---|
highlights |
string |
Même passage de texte que dans la propriété Text avec les expressions de texte en surbrillance les plus pertinentes pour la requête. |
key |
string |
Clé du document dont la réponse a été extraite. |
score |
number |
La valeur de score représente la pertinence de la réponse à la requête par rapport aux autres réponses retournées pour la requête. |
text |
string |
Passage de texte extrait du contenu du document comme réponse. |
CaptionResult
Les légendes sont les passages les plus représentatifs du document relativement à la requête de recherche. Ils sont souvent utilisés comme résumé de document. Les légendes sont uniquement retournées pour les requêtes de type « sémantique ».
Nom | Type | Description |
---|---|---|
highlights |
string |
Même passage de texte que dans la propriété Text avec les 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 plus en détail vos résultats de recherche.
Nom | Type | Description |
---|---|---|
semantic |
Contient des informations de débogage spécifiques aux demandes de classement sémantique. |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
Nom | Type | Description |
---|---|---|
info |
object |
Informations supplémentaires |
type |
string |
Type d’informations supplémentaires. |
ErrorDetail
Détail de l’erreur.
Nom | Type | Description |
---|---|---|
additionalInfo |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d'erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
Nom | Type | Description |
---|---|---|
error |
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 du calcul des « nombre » et des « 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 » lors du calcul des « nombre » et des « facettes ». |
HybridSearch
T Paramètres de requête pour configurer les comportements de recherche hybride.
Nom | Type | Description |
---|---|---|
countAndFacetMode |
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 (à l’aide des paramètres top et skip), au prix d’une utilisation plus élevée des ressources et d’une latence plus élevée. La valeur doit être comprise entre 1 et 10 000. La valeur par défaut est 1000. |
QueryAnswerType
Valeur qui spécifie si les réponses doivent être retournées dans le cadre de la réponse de recherche.
Nom | Type | Description |
---|---|---|
extractive |
string |
Extrait les candidats-réponses du contenu des documents retournés en réponse à une requête exprimée sous forme de question en langage naturel. |
none |
string |
Ne retournez pas de réponses pour la requête. |
QueryCaptionType
Valeur qui spécifie si les légendes doivent être retournées dans le cadre de la réponse de recherche.
Nom | Type | Description |
---|---|---|
extractive |
string |
Extrait les légendes des documents correspondants qui contiennent des passages pertinents pour la requête de recherche. |
none |
string |
Ne retournez pas de sous-titres pour la requête. |
QueryDebugMode
Active un outil de débogage qui peut être utilisé pour explorer plus en détail vos résultats de recherche.
Nom | Type | Description |
---|---|---|
disabled |
string |
Aucune information de débogage de requête 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 la langue de requête pour l’arabe (Égypte). |
ar-jo |
string |
Valeur de la 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 la langue de requête pour l’arabe (Maroc). |
ar-sa |
string |
Valeur de langue de requête pour l’arabe (Arabie saoudite). |
bg-bg |
string |
Valeur de langue de requête pour le bulgare (Bulgarie). |
bn-in |
string |
Valeur de langue de requête pour bengali (Inde). |
ca-es |
string |
Valeur de langue de requête pour le catalan. |
cs-cz |
string |
Valeur de langue de requête pour le tchèque (République tchèque). |
da-dk |
string |
Valeur de langue de requête pour le danois (Danemark). |
de-de |
string |
Valeur de langue de requête pour l’allemand (Allemagne). |
el-gr |
string |
Valeur de langue de requête pour le grec (Grèce). |
en-au |
string |
Valeur de la langue de requête pour l’anglais (Australie). |
en-ca |
string |
Valeur de la langue de requête pour l’anglais (Canada). |
en-gb |
string |
Valeur de la langue de requête pour l’anglais (Grande-Bretagne). |
en-in |
string |
Valeur de la langue de requête pour l’anglais (Inde). |
en-us |
string |
Valeur de langue de requête pour l’anglais (États-Unis). |
es-es |
string |
Valeur de langue de requête pour l’espagnol (Espagne). |
es-mx |
string |
Valeur de langue de requête pour l’espagnol (Mexique). |
et-ee |
string |
Valeur de langue de requête pour l’estonien (Estonie). |
eu-es |
string |
Valeur de la langue de requête pour le basque. |
fa-ae |
string |
Valeur de langue de requête pour le persan (U.A.E.). |
fi-fi |
string |
Valeur de langue de requête pour le finnois (Finlande). |
fr-ca |
string |
Valeur de langue de requête pour Français (Canada). |
fr-fr |
string |
Valeur de langue de requête pour Français (France). |
ga-ie |
string |
Valeur de langue de requête pour l’irlandais (Irlande). |
gl-es |
string |
Valeur de la langue de requête pour le galicien. |
gu-in |
string |
Valeur de langue de requête pour Gujarati (Inde). |
he-il |
string |
Valeur de langue de requête pour l’hébreu (Israël). |
hi-in |
string |
Valeur de la langue de requête pour l’hindi (Inde). |
hr-ba |
string |
Valeur de langue de requête pour le croate (Bosnie-Herzégovine). |
hr-hr |
string |
Valeur de langue de requête pour le croate (Croatie). |
hu-hu |
string |
Valeur de langue de requête pour le hongrois (Hongrie). |
hy-am |
string |
Valeur de la langue de requête pour l’arménien (Arménie). |
id-id |
string |
Valeur de langue de requête pour l’indonésien (Indonésie). |
is-is |
string |
Valeur de langue de requête pour l’islandais (Islande). |
it-it |
string |
Valeur de langue de requête pour italien (Italie). |
ja-jp |
string |
Valeur de langue de requête pour le japonais (Japon). |
kn-in |
string |
Valeur de langue de requête pour Kannada (Inde). |
ko-kr |
string |
Valeur de la langue de requête pour le coréen (Corée). |
lt-lt |
string |
Valeur de langue de requête pour le lituanien (Lituanie). |
lv-lv |
string |
Valeur de langue de requête pour le letton (Lettonie). |
ml-in |
string |
Valeur de la langue de requête pour Malayalam (Inde). |
mr-in |
string |
Valeur de langue de requête pour Marathi (Inde). |
ms-bn |
string |
Valeur de la langue de requête pour le malais (Brunei Darussalam). |
ms-my |
string |
Valeur de la langue de requête pour le malais (Malaisie). |
nb-no |
string |
Valeur de langue de requête pour le norvégien (Norvège). |
nl-be |
string |
Valeur de langue de requête pour le néerlandais (Belgique). |
nl-nl |
string |
Valeur de langue de requête pour le néerlandais (Pays-Bas). |
no-no |
string |
Valeur de langue de requête pour le norvégien (Norvège). |
none |
string |
Langue de requête non spécifiée. |
pa-in |
string |
Valeur de langue de requête pour punjabi (Inde). |
pl-pl |
string |
Valeur de langue de requête pour le polonais (Pologne). |
pt-br |
string |
Valeur de langue de requête pour le portugais (Brésil). |
pt-pt |
string |
Valeur de langue de requête pour le portugais (Portugal). |
ro-ro |
string |
Valeur de langue de requête pour le roumain (Roumanie). |
ru-ru |
string |
Valeur de langue de requête pour le russe (Russie). |
sk-sk |
string |
Valeur de langue de requête pour le slovaque (Slovaquie). |
sl-sl |
string |
Valeur de langue de requête pour le slovène (Slovénie). |
sr-ba |
string |
Valeur de langue de requête pour le serbe (Bosnie-Herzégovine). |
sr-me |
string |
Valeur de langue de requête pour le serbe (Monténégro). |
sr-rs |
string |
Valeur de langue de requête pour le serbe (Serbie). |
sv-se |
string |
Valeur de langue de requête pour le suédois (Suède). |
ta-in |
string |
Valeur de langue de requête pour tamoul (Inde). |
te-in |
string |
Valeur de langue de requête pour Telugu (Inde). |
th-th |
string |
Valeur de langue de requête pour thaï (Thaïlande). |
tr-tr |
string |
Valeur de langue de requête pour le turc (Turquie). |
uk-ua |
string |
Valeur de langue de requête pour l’ukrainien (Ukraine). |
ur-pk |
string |
Valeur de langue de requête pour l’ourdou (Pakistan). |
vi-vn |
string |
Valeur de langue de requête pour le vietnamien (Viet Nam). |
zh-cn |
string |
Valeur de la langue de requête pour le chinois (Chine). |
zh-tw |
string |
Valeur de langue de requête pour le chinois (Taïwan). |
QueryResultDocumentRerankerInput
Chaînes concaténées brutes envoyées au processus d’enrichissement sémantique.
Nom | Type | Description |
---|---|---|
content |
string |
Chaînes concaténées brutes pour les champs de contenu utilisés pour l’enrichissement sémantique. |
keywords |
string |
Les chaînes concaténées brutes pour les champs mot clé qui ont été utilisés pour l’enrichissement sémantique. |
title |
string |
Chaîne brute du champ de titre utilisé pour l’enrichissement sémantique. |
QueryResultDocumentSemanticField
Description des champs qui ont été envoyés au processus d’enrichissement sémantique, ainsi que la façon dont ils ont été utilisés
Nom | Type | Description |
---|---|---|
name |
string |
Nom du champ envoyé au processus d’enrichissement sémantique |
state |
La façon dont le champ a été utilisé pour le processus d’enrichissement sémantique (entièrement utilisé, partiellement utilisé ou non utilisé) |
QuerySpellerType
Valeur qui spécifiait le type de l’orthographe à utiliser pour corriger l’orthographe des 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 la langue spécifiée par le paramètre queryLanguage. |
none |
string |
Speller non activé. |
QueryType
Spécifie la syntaxe de la requête de recherche. La valeur par défaut est « simple ». Utilisez « full » si votre requête utilise la syntaxe de requête Lucene et « semantic » si la syntaxe de requête n’est pas nécessaire.
Nom | Type | Description |
---|---|---|
full |
string |
Utilise la syntaxe de requête Lucene complète pour les recherches. 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 recherche en replaçant les premiers résultats de recherche à l’aide d’un modèle de classement entraîné 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 autorise les symboles tels que +, * et « ». Les requêtes sont évaluées sur tous les champs pouvant faire l’objet d’une recherche par défaut, sauf si le paramètre searchFields est spécifié. |
RawVectorQuery
Paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur vectorielle brute est fournie.
Nom | Type | Description |
---|---|---|
exhaustive |
boolean |
Quand la valeur est true, déclenche une recherche complète du voisin le plus proche sur tous les vecteurs au sein de l’index vectoriel. Utile pour les scénarios où des correspondances exactes sont critiques, comme la détermination des valeurs de vérité au sol. |
fields |
string |
Champs vectoriels de type Collection (Edm.Single) à inclure dans le vecteur recherché. |
k |
integer |
Nombre de voisins les plus proches à revenir en tant que coups de tête. |
kind |
string:
vector |
Type de requête vectorielle en cours d’exécution. |
oversampling |
number |
Facteur de suréchantillonnage. La valeur minimale est 1. Il remplace le paramètre « defaultOversampling » configuré dans la définition d’index. Elle peut être définie uniquement lorsque « rerankWithOriginalVectors » a la valeur true. Ce paramètre n’est autorisé que lorsqu’une méthode de compression est utilisée sur le champ vecteur sous-jacent. |
threshold | VectorThreshold: |
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 à d’autres requêtes vectorielles 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 correspondant à cette requête sont élevés 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 des documents) globalement pour un scoring plus cohérent, ou localement, pour une latence plus faible. La valeur par défaut est « local ». Utilisez « global » pour agréger les statistiques de scoring à l’échelle mondiale avant de scorer. L’utilisation des statistiques de scoring global peut augmenter la latence des requêtes de recherche.
Nom | Type | Description |
---|---|---|
global |
string |
Les statistiques de scoring seront calculées globalement pour une notation plus cohérente. |
local |
string |
Les statistiques de scoring seront calculées localement pour une latence plus faible. |
SearchDocumentsResult
Réponse contenant les résultats de recherche d’un index.
Nom | Type | Description |
---|---|---|
@odata.count |
integer |
Nombre total de résultats trouvés par l’opération de recherche, ou null si le nombre n’a pas été demandé. S’il est présent, le nombre peut être supérieur au nombre de résultats dans cette réponse. Cela peut se produire si vous utilisez les paramètres $top ou $skip, ou si la requête ne peut pas retourner tous les documents demandés dans une seule réponse. |
@odata.nextLink |
string |
URL de continuation retournée lorsque la requête ne peut pas retourner tous les résultats demandés dans une seule réponse. Vous pouvez utiliser cette URL pour formuler une autre demande de recherche GET ou POST afin d’obtenir la partie suivante de la réponse de recherche. Veillez à utiliser le même verbe (GET ou POST) que la requête qui a produit cette réponse. |
@search.answers |
Résultats de la requête de réponses pour l’opération de recherche ; null si le paramètre de requête de réponses n’a pas été spécifié ou défini sur « none ». |
|
@search.coverage |
number |
Valeur indiquant le pourcentage de l’index inclus dans la requête, ou null si minimumCoverage n’a pas été spécifié dans la requête. |
@search.facets |
object |
Résultats de la requête facette pour l’opération de recherche, organisés sous la forme d’une collection de compartiments pour chaque champ à facettes ; Null si la requête n’a pas inclus d’expressions de facette. |
@search.nextPageParameters |
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 demande de recherche POST afin d’obtenir la partie suivante de la réponse de recherche. |
|
@search.semanticPartialResponseReason |
Raison pour laquelle une réponse partielle a été retournée pour une demande de classement sémantique. |
|
@search.semanticPartialResponseType |
Type de réponse partielle retournée pour une demande de classement sémantique. |
|
value |
Séquence de résultats retournés par la requête. |
SearchMode
Indique si tous les termes recherchés ou l'un d'eux doivent correspondre pour que le document soit considéré comme une correspondance.
Nom | Type | Description |
---|---|---|
all |
string |
Tous les termes de recherche doivent être mis en correspondance pour compter le document comme une correspondance. |
any |
string |
Tous les termes de recherche doivent être mis en correspondance pour compter le document comme une correspondance. |
SearchRequest
Paramètres de filtrage, de tri, de facettes, de pagination et d’autres comportements de requête de recherche.
Nom | Type | Description |
---|---|---|
answers |
Valeur qui spécifie si les réponses doivent être retournées dans le cadre de la réponse de recherche. |
|
captions |
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 |
Active un outil de débogage qui peut être utilisé pour explorer davantage vos résultats reclassés. |
|
facets |
string[] |
Liste d’expressions de facette à appliquer à la requête de recherche. Chaque expression de facette contient un nom de champ, éventuellement suivi d’une liste séparée par des virgules de paires nom :valeur. |
filter |
string |
L’expression OData $filter à appliquer à la requête de recherche. |
highlight |
string |
Liste séparée par des virgules des noms de champs à utiliser pour les surbrillances d’accès. Seuls les champs pouvant faire l’objet d’une recherche peuvent être utilisés pour la mise en surbrillance des accès. |
highlightPostTag |
string |
Balise de chaîne ajoutée aux surbrillances d’accès. Doit être défini avec highlightPreTag. La valeur par défaut est </em>. |
highlightPreTag |
string |
Balise de chaîne qui est ajoutée pour atteindre les surbrillances. Doit être défini avec highlightPostTag. La valeur par défaut est <em>. |
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 pour que la requête soit signalée en tant que réussite. Ce paramètre peut être utile pour garantir la disponibilité de la recherche, même pour les services avec un seul réplica. La valeur par défaut est 100. |
orderby |
string |
La liste séparée par des virgules des expressions OData $orderby selon lesquelles trier les résultats. Chaque expression peut être un nom de champ ou un appel aux fonctions geo.distance() ou search.score(). Chaque expression peut être suivie d’asc pour indiquer l’ordre croissant, ou de desc pour indiquer la décroissante. La valeur par défaut est l'ordre croissant. Les liens seront rompus par les scores de correspondance des documents. Si aucune $orderby n’est spécifiée, l’ordre de tri par défaut est décroissant par score de correspondance de document. Il peut y avoir au maximum 32 clauses $orderby. |
queryLanguage |
Valeur qui spécifie la langue de la requête de recherche. |
|
queryType |
Valeur qui spécifie la syntaxe de la requête de recherche. La valeur par défaut est « simple ». Utilisez « full » si votre requête utilise la syntaxe de requête Lucene. |
|
scoringParameters |
string[] |
Liste des valeurs de paramètres à utiliser dans les fonctions de scoring (par exemple, referencePointParameter) à l’aide du format name-values. Par exemple, si le profil de scoring définit une fonction avec un paramètre appelé « mylocation », la chaîne de paramètre est « mylocation--122.2,44.8 » (sans les guillemets). |
scoringProfile |
string |
Nom du profil de calcul de score utilisé pour évaluer les scores de correspondance des documents correspondants afin de trier les résultats. |
scoringStatistics |
Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence des documents) globalement pour un scoring plus cohérent, ou localement, pour une latence plus faible. La valeur par défaut est « local ». Utilisez « global » pour agréger les statistiques de scoring à l’échelle mondiale avant de scorer. L’utilisation des statistiques de scoring global peut augmenter la latence des requêtes de recherche. |
|
search |
string |
Expression de requête de recherche en texte intégral ; Utilisez « * » ou omettez ce paramètre pour faire correspondre tous les documents. |
searchFields |
string |
Liste séparée par des virgules des noms de champs auxquels étendre la recherche en texte intégral. Lorsque vous utilisez la recherche sur champ (fieldName :searchExpression) dans une requête Lucene complète, les noms de champ de chaque expression de recherche avec champ sont prioritaires sur les noms de champs répertoriés dans ce paramètre. |
searchMode |
Valeur qui spécifie si tout ou partie des termes de recherche doivent être mis en correspondance pour compter le document comme une correspondance. |
|
select |
string |
Liste des champs séparés par des virgules à récupérer. Si aucune valeur n'est spécifiée, tous les champs marqués comme récupérables dans le schéma sont inclus. |
semanticConfiguration |
string |
Nom d’une configuration sémantique qui sera utilisée lors du traitement de documents pour des requêtes de type sémantique. |
semanticErrorHandling |
Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou de retourner des résultats partiels (par défaut). |
|
semanticFields |
string |
Liste séparée par des virgules des noms de champs utilisés pour le classement sémantique. |
semanticMaxWaitInMilliseconds |
integer |
Permet à l’utilisateur de définir une limite supérieure sur le temps nécessaire à l’enrichissement sémantique pour terminer le traitement avant l’échec de la demande. |
semanticQuery |
string |
Permet de définir une requête de recherche distincte qui sera utilisée uniquement pour le reclassement sémantique, les légendes sémantiques et les réponses sémantiques. Est utile pour les scénarios où il est nécessaire d’utiliser différentes requêtes entre la phase de récupération et de classement de base et la phase sémantique L2. |
sessionId |
string |
Valeur à utiliser pour créer une session collante, ce qui peut vous aider à obtenir des résultats plus cohérents. Tant que le même sessionId est utilisé, une tentative optimale est effectuée pour cibler le même réplica ensemble. Méfiez-vous que la réutilisation répétée des mêmes valeurs sessionID peut interférer avec l’équilibrage de charge des requêtes entre les réplicas et nuire aux performances du service de recherche. La valeur utilisée comme sessionId ne peut pas commencer par un caractère « _ ». |
skip |
integer |
Nombre de résultats de recherche à ignorer. Cette valeur ne peut pas être supérieure à 100 000. Si vous devez analyser des documents dans l’ordre, mais que vous ne pouvez pas utiliser skip en raison de cette limitation, envisagez d’utiliser orderby sur une clé entièrement ordonnée et de filtrer avec une requête de plage à la place. |
speller |
Valeur qui a spécifié le type de l’orthographe à utiliser pour corriger l’orthographe des termes de la requête de recherche individuelle. |
|
top |
integer |
Nombre de résultats de recherche à récupérer. Cela peut être utilisé conjointement avec $skip pour implémenter la pagination côté client des résultats de la recherche. Si les résultats sont tronqués en raison 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 de résultats suivante. |
vectorFilterMode |
Détermine si les filtres sont appliqués avant ou après l’exécution de la recherche vectorielle. La valeur par défaut est « preFilter ». |
|
vectorQueries | VectorQuery[]: |
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 |
Les légendes sont les passages les plus représentatifs du document relativement à la requête de recherche. Ils sont souvent utilisés comme résumé de document. Les légendes sont uniquement retournées pour les requêtes de type « sémantique ». |
|
@search.documentDebugInfo |
Contient des informations de débogage qui peuvent être utilisées pour explorer plus en détail vos résultats de recherche. |
|
@search.highlights |
object |
Fragments de texte du document qui indiquent les termes de recherche correspondants, organisés par chaque champ applicable ; Null si la mise en surbrillance de l’accès n’a pas été activée pour la requête. |
@search.rerankerScore |
number |
Score de pertinence calculé par le classement sémantique pour les résultats de recherche les plus importants. Les résultats de la recherche sont triés d’abord par RerankerScore, puis par score. RerankerScore est retourné uniquement pour les requêtes de type « sémantique ». |
@search.score |
number |
Score de pertinence du document par rapport aux autres documents retournés par la requête. |
SearchScoreThreshold
Les résultats de la requête vectorielle sont filtrés en fonction de la valeur « @search.score ». Notez qu’il s’agit du @search.score retourné dans le cadre de la réponse de recherche. La direction du seuil est choisie pour les valeurs supérieures @search.score.
Nom | Type | Description |
---|---|---|
kind |
string:
search |
Type de seuil utilisé pour filtrer les requêtes vectorielles |
value |
number |
Le seuil est filtré en fonction de la valeur « @search.score ». Notez qu’il s’agit du @search.score retourné dans le cadre de la réponse de recherche. La direction du seuil est choisie pour les valeurs supérieures @search.score. |
SemanticDebugInfo
Nom | Type | Description |
---|---|---|
contentFields |
Les champs de contenu qui ont été envoyés au processus d’enrichissement sémantique, ainsi que la façon dont ils ont été utilisés |
|
keywordFields |
Le mot clé les champs qui ont été envoyés au processus d’enrichissement sémantique, ainsi que la façon dont ils ont été utilisés |
|
rerankerInput |
Chaînes concaténées brutes envoyées au processus d’enrichissement sémantique. |
|
titleField |
Champ de titre envoyé au processus d’enrichissement sémantique, ainsi que la façon dont il a été utilisé |
SemanticErrorMode
Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou de retourner des résultats partiels (par défaut).
Nom | Type | Description |
---|---|---|
fail |
string |
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 qui a échoué et de la raison de l’échec. |
SemanticErrorReason
Raison pour laquelle une réponse partielle a été retournée pour une demande de classement sémantique.
Nom | Type | Description |
---|---|---|
capacityOverloaded |
string |
La demande a été limitée. Seuls les résultats de base ont été retournés. |
maxWaitExceeded |
string |
Si « semanticMaxWaitInMilliseconds » a été défini et que la durée de traitement sémantique a dépassé cette valeur. Seuls les résultats de base ont été retournés. |
transient |
string |
Au moins une étape du processus sémantique a échoué. |
SemanticFieldState
La façon dont le champ a été utilisé pour le processus d’enrichissement sémantique (entièrement utilisé, partiellement utilisé ou non utilisé)
Nom | Type | Description |
---|---|---|
partial |
string |
Le champ a été partiellement utilisé pour l’enrichissement sémantique. |
unused |
string |
Le champ n’a pas été utilisé pour l’enrichissement sémantique. |
used |
string |
Le champ a été entièrement utilisé pour l’enrichissement sémantique. |
SemanticSearchResultsType
Type de réponse partielle retournée pour une demande de classement sémantique.
Nom | Type | Description |
---|---|---|
baseResults |
string |
Résultats sans enrichissement sémantique ni reclassement. |
rerankedResults |
string |
Les résultats ont été reclassés avec le modèle de reclassement et incluent des légendes sémantiques. Ils n’incluront pas de réponses, de réponses en surbrillance ou de légende de faits saillants. |
Speller
Améliorez le rappel de recherche en corrigeant l’orthographe des 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 |
Orthographe non activé. |
VectorFilterMode
Détermine si les filtres sont appliqués avant ou après l’exécution de la recherche vectorielle.
Nom | Type | Description |
---|---|---|
postFilter |
string |
Le filtre est appliqué une fois que l’ensemble de résultats vectoriels candidats est retourné. En fonction de la sélectivité du filtre, cela peut entraîner moins de résultats que celui demandé par le paramètre « k ». |
preFilter |
string |
Le filtre sera 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 qui doit être vectorisé 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ù des correspondances exactes sont critiques, comme la détermination des valeurs de vérité au sol. |
fields |
string |
Champs vectoriels de type Collection(Edm.Single) à inclure dans le vecteur recherché. |
k |
integer |
Nombre de voisins les plus proches à retourner en tant que premiers résultats. |
kind |
string:
image |
Type de requête vectorielle en cours d’exécution. |
oversampling |
number |
Facteur de suréchantillonnage. La valeur minimale est 1. Il remplace le paramètre « defaultOversampling » configuré dans la définition d’index. Il ne peut être défini que lorsque « rerankWithOriginalVectors » a la valeur true. Ce paramètre n’est autorisé que lorsqu’une méthode de compression est utilisée sur le champ vectoriel sous-jacent. |
threshold | VectorThreshold: |
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 à d’autres requêtes vectorielles 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 correspondant à cette requête sont élevés 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
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 complète du voisin le plus proche sur tous les vecteurs au sein de l’index vectoriel. Utile pour les scénarios où des correspondances exactes sont critiques, comme la détermination des valeurs de vérité au sol. |
fields |
string |
Champs vectoriels de type Collection (Edm.Single) à inclure dans le vecteur recherché. |
k |
integer |
Nombre de voisins les plus proches à revenir en tant que coups de tête. |
kind |
string:
image |
Type de requête vectorielle en cours d’exécution. |
oversampling |
number |
Facteur de suréchantillonnage. La valeur minimale est 1. Il remplace le paramètre « defaultOversampling » configuré dans la définition d’index. Elle peut être définie uniquement lorsque « rerankWithOriginalVectors » a la valeur true. Ce paramètre n’est autorisé que lorsqu’une méthode de compression est utilisée sur le champ vecteur sous-jacent. |
threshold | VectorThreshold: |
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 à d’autres requêtes vectorielles 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 correspondant à cette requête sont élevés 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
Paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur de texte qui doit être vectorisée est fournie.
Nom | Type | Description |
---|---|---|
exhaustive |
boolean |
Quand la valeur est true, déclenche une recherche complète du voisin le plus proche sur tous les vecteurs au sein de l’index vectoriel. Utile pour les scénarios où des correspondances exactes sont critiques, comme la détermination des valeurs de vérité au sol. |
fields |
string |
Champs vectoriels de type Collection (Edm.Single) à inclure dans le vecteur recherché. |
k |
integer |
Nombre de voisins les plus proches à revenir en tant que coups de tête. |
kind |
string:
text |
Type de requête vectorielle en cours d’exécution. |
oversampling |
number |
Facteur de suréchantillonnage. La valeur minimale est 1. Il remplace le paramètre « defaultOversampling » configuré dans la définition d’index. Elle peut être définie uniquement lorsque « rerankWithOriginalVectors » a la valeur true. Ce paramètre n’est autorisé que lorsqu’une méthode de compression est utilisée sur le champ vecteur sous-jacent. |
text |
string |
Texte à vectoriser pour effectuer une requête de recherche vectorielle. |
threshold | VectorThreshold: |
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 à d’autres requêtes vectorielles 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 correspondant à cette requête sont élevés 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 dans laquelle un binaire codé en base 64 d’une image qui doit être vectorisé est fourni. |
imageUrl |
string |
Requête vectorielle dans laquelle une URL qui représente une valeur d’image qui doit être vectorisée est fournie. |
text |
string |
Requête vectorielle dans laquelle une valeur de texte qui doit être vectorisée est fournie. |
vector |
string |
Requête vectorielle dans laquelle une valeur vectorielle brute est fournie. |
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) est choisie automatiquement en fonction de la métrique utilisée par le champ.
Nom | Type | Description |
---|---|---|
kind |
string:
vector |
Type de seuil utilisé pour filtrer les requêtes vectorielles |
value |
number |
Le seuil filtre en fonction de la valeur de la métrique de similarité. Notez qu’il s’agit de la définition canonique de la métrique de similarité, et non de la version « distance ». La direction du seuil (plus grande ou plus petite) est 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 sont filtrés en fonction de la valeur « @search.score ». Notez qu’il s’agit du @search.score retourné dans le cadre de la réponse de recherche. La direction du seuil est choisie pour les valeurs supérieures @search.score. |
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) est choisie automatiquement en fonction de la métrique utilisée par le champ. |