Documents - Search Post
Recherche de documents dans l’index.
POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2026-04-01
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
URL du point de terminaison du service de recherche. |
|
index
|
path | True |
string |
Nom de l’index. |
|
api-version
|
query | True |
string minLength: 1 |
Version de l’API à utiliser pour cette opération. |
En-tête de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| Accept |
L’en-tête Accept. |
||
| x-ms-client-request-id |
string (uuid) |
Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête. |
Corps de la demande
| 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 des expressions de facette à appliquer à la requête de recherche. Chaque expression de facette contient un nom de champ, éventuellement suivi d’une liste séparée par des virgules de paires name :value. |
| filter |
string |
L’expression OData $filter à appliquer à la requête de recherche. |
| highlight |
string |
Liste séparée par des virgules des noms de champs à utiliser pour les surbrillances d’accès. Seuls les champs pouvant faire l’objet d’une recherche peuvent être utilisés pour la mise en surbrillance des accès. |
| highlightPostTag |
string |
Balise de chaîne ajoutée aux surbrillances d’accès. Doit être défini avec highlightPreTag. La valeur par défaut est </em>. |
| highlightPreTag |
string |
Balise de chaîne qui est précédée de mises en surbrillance. Doit être défini avec highlightPostTag. La valeur par défaut est <em>. |
| minimumCoverage |
number (double) |
Nombre compris entre 0 et 100 indiquant le pourcentage de l’index qui doit être couvert par une requête de recherche afin que la requête soit signalée comme une réussite. Ce paramètre peut être utile pour garantir la disponibilité de la recherche même pour les services avec un seul réplica. La valeur par défaut est 100. |
| orderby |
string |
Liste des expressions OData $orderby séparées par des virgules permettant de trier les résultats. Chaque expression peut être un nom de champ ou un appel aux fonctions geo.distance() ou search.score(). Chaque expression peut être suivie d’asc pour indiquer l’ordre croissant ou desc pour indiquer l’ordre décroissant. La valeur par défaut est l’ordre croissant. Les liens seront rompus par les scores de correspondance des documents. Si aucune $orderby n’est spécifiée, l’ordre de tri par défaut descend par score de correspondance de document. Il peut y avoir au maximum 32 clauses $orderby. |
| 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 |
Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence inférieure. La valeur par défaut est 'local'. Utilisez « global » pour agréger les statistiques de score globales avant de marquer. L’utilisation de statistiques de score globales peut augmenter la latence des requêtes de recherche. |
|
| search |
string |
Une expression de requête de recherche en texte intégral ; Utilisez « * » ou omettez ce paramètre pour correspondre à tous les documents. |
| searchFields |
string |
Liste séparée par des virgules des noms de champs auxquels étendre la recherche en texte intégral. Lors de l’utilisation de la recherche fielded (fieldName :searchExpression) dans une requête Lucene complète, les noms de champs de chaque expression de recherche fielded sont prioritaires sur tous les noms de champs répertoriés dans ce paramètre. |
| searchMode |
Valeur qui spécifie si l’un ou l’ensemble des termes de recherche doivent être mis en correspondance pour compter le document comme correspondance. |
|
| select |
string |
Liste des champs à récupérer, séparés par des virgules. S’il n’est pas spécifié, tous les champs marqués comme récupérables dans le schéma sont inclus. |
| semanticConfiguration |
string |
Nom d’une configuration sémantique qui sera utilisée lors du traitement de documents pour les requêtes sémantiques de type. |
| semanticErrorHandling |
Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement (comportement par défaut / actuel) ou renvoyer des résultats partiels. |
|
| semanticMaxWaitInMilliseconds |
integer (int32) minimum: 700 |
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 post-it, ce qui peut aider à obtenir des résultats plus cohérents. Tant que le même id de session est utilisé, une tentative optimale sera effectuée pour cibler le même jeu de réplicas. Soyez prudent que la réutilisation des mêmes valeurs sessionID peut interférer à plusieurs reprises avec l’équilibrage de charge des requêtes entre les réplicas et affecter négativement les performances du service de recherche. La valeur utilisée en tant que sessionId ne peut pas commencer par un caractère '_'. |
| skip |
integer (int32) |
Nombre de résultats de recherche à ignorer. Cette valeur ne peut pas être supérieure à 100 000. Si vous avez besoin d’analyser des documents dans la séquence, mais que vous ne pouvez pas l’utiliser en raison de cette limitation, envisagez d’utiliser orderby sur une clé totalement ordonnée et filtrer avec une requête de plage à la place. |
| top |
integer (int32) |
Nombre de résultats de recherche à récupérer. Cela peut être utilisé conjointement avec $skip pour implémenter la pagination côté client des résultats de recherche. Si les résultats sont tronqués en raison de la pagination côté serveur, la réponse inclut un jeton de continuation qui peut être utilisé pour émettre une autre demande de recherche pour la page suivante des résultats. |
| vectorFilterMode |
Détermine si des filtres sont appliqués avant ou après l’exécution de la recherche vectorielle. La valeur par défaut est 'preFilter' pour les nouveaux index. |
|
| vectorQueries | VectorQuery[]: |
Paramètres de requête pour les requêtes de recherche vectorielle et hybride. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
La demande a réussi. |
|
| Other Status Codes |
Réussite |
|
| Other Status Codes |
Réponse d’erreur inattendue. |
Sécurité
api-key
Type:
apiKey
Dans:
header
OAuth2Auth
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Étendues
| Nom | Description |
|---|---|
| https://search.azure.com/.default |
Exemples
|
Search |
|
Search |
SearchIndexSearchDocumentsPost
Exemple de requête
POST https://exampleservice.search.windows.net/indexes('test-index')/docs/search.post.search?api-version=2026-04-01
{
"count": true,
"facets": [
"ownerId",
"price,metric:sum,default:10"
],
"filter": "category eq 'purple' or category eq 'pink'",
"highlight": "category",
"highlightPostTag": "</em>",
"highlightPreTag": "</em>",
"minimumCoverage": 100,
"queryType": "semantic",
"scoringStatistics": "global",
"sessionId": "mysessionid",
"scoringParameters": [
"categoryTag:desiredCategoryValue"
],
"scoringProfile": "stringFieldBoost",
"debug": "vector",
"search": "purple",
"searchFields": "id,name,description,category,ownerId",
"searchMode": "any",
"select": "id,name,description,category,ownerId",
"skip": 0,
"top": 10,
"semanticConfiguration": "testconfig",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 5000,
"semanticQuery": "find all purple",
"answers": "extractive",
"captions": "extractive",
"vectorQueries": [
{
"vector": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"kind": "vector",
"k": 50,
"fields": "vector22, vector1b",
"oversampling": 20,
"weight": 1
}
],
"vectorFilterMode": "preFilter"
}
Exemple de réponse
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011627906933426857,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011904762126505375,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6994102001190186,
"@search.rerankerBoostedScore": 1.6994102001190186,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6937386989593506,
"@search.rerankerBoostedScore": 1.6937386989593506,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6923208236694336,
"@search.rerankerBoostedScore": 1.6923208236694336,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.691611886024475,
"@search.rerankerBoostedScore": 1.691611886024475,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6781420707702637,
"@search.rerankerBoostedScore": 1.6781420707702637,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6653810739517212,
"@search.rerankerBoostedScore": 1.6653810739517212,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6618363857269287,
"@search.rerankerBoostedScore": 1.6618363857269287,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011627906933426857,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011904762126505375,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6994102001190186,
"@search.rerankerBoostedScore": 1.6994102001190186,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6937386989593506,
"@search.rerankerBoostedScore": 1.6937386989593506,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6923208236694336,
"@search.rerankerBoostedScore": 1.6923208236694336,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.691611886024475,
"@search.rerankerBoostedScore": 1.691611886024475,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6781420707702637,
"@search.rerankerBoostedScore": 1.6781420707702637,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6653810739517212,
"@search.rerankerBoostedScore": 1.6653810739517212,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6618363857269287,
"@search.rerankerBoostedScore": 1.6618363857269287,
"@search.captions": [
{
"text": "This is a caption from the document.",
"highlights": "This is a <em>caption</em> from the document."
}
],
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}
SearchIndexSearchDocumentsSemanticPost
Exemple de requête
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2026-04-01
{
"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
{
"@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=2026-04-01"
}
{
"@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=2026-04-01"
}
Définitions
| Nom | Description |
|---|---|
| Accept |
L’en-tête Accept. |
|
Document |
Contient des informations de débogage qui peuvent être utilisées pour explorer davantage 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 à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.). |
|
Query |
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. |
|
Query |
Ce paramètre n’est valide que si le type de requête est |
|
Query |
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 |
|
Query |
Ce paramètre n’est valide que si le type de requête est |
|
Query |
Active un outil de débogage qui peut être utilisé pour explorer davantage vos résultats de recherche. Vous pouvez activer plusieurs modes de débogage simultanément en les séparant par un | caractère, par exemple : semantic|queryRewrites. |
|
Query |
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. |
|
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. |
|
Scoring |
Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence inférieure. La valeur par défaut est 'local'. Utilisez « global » pour agréger les statistiques de score globales avant de marquer. L’utilisation de statistiques de score globales peut augmenter la latence des requêtes de recherche. |
|
Search |
Réponse contenant des résultats de recherche à partir d’un index. |
|
Search |
Spécifie si l’un ou l’ensemble des termes de recherche doivent être mis en correspondance pour que le document soit considéré comme une correspondance. |
|
Search |
Paramètres de filtrage, de tri, de facette, 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. |
|
Semantic |
Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou de retourner des résultats partiels. |
|
Semantic |
Raison pour laquelle une réponse partielle a été renvoyée pour une demande de classement sémantique. |
|
Semantic |
Type de réponse partielle renvoyée pour une demande de classement sémantique. |
|
Single |
Résultat d’un champ vectoriel unique. Les deux |
|
Text |
Score BM25 ou Classique pour la partie texte de la requête. |
|
Vector |
Détermine si des 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 devant être vectorisée est fourni. |
|
Vectorizable |
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. |
|
Vectorizable |
Les paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur de texte devant être vectorisée est fournie. |
|
Vectorized |
Paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur vectorielle brute est fournie. |
|
Vector |
Type de requête vectorielle en cours d’exécution. |
|
Vectors |
« Contient des informations de débogage spécifiques à la recherche vectorielle et hybride. ») |
Accept
L’en-tête Accept.
| Valeur | Description |
|---|---|
| application/json;odata.metadata=none |
DocumentDebugInfo
Contient des informations de débogage qui peuvent être utilisées pour explorer davantage vos résultats de recherche.
| Nom | Type | Description |
|---|---|---|
| vectors |
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 |
Informations supplémentaires. |
|
| type |
string |
Type d’informations supplémentaire. |
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 à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).
| Nom | Type | Description |
|---|---|---|
| error |
Objet d’erreur. |
QueryAnswerResult
Une réponse est un passage de texte extrait du contenu des documents les plus pertinents correspondant à la requête. Les réponses sont extraites des résultats de recherche principaux. Les candidats à la réponse sont marqués et les premières réponses sont sélectionnées.
| 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 (double) |
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. |
QueryAnswerType
Ce paramètre n’est valide que si le type de requête est semantic. Si elle est définie, la requête retourne des réponses extraites des passages clés dans les documents classés les plus élevés. Le nombre de réponses renvoyées peut être configuré en ajoutant la barre | verticale suivie de l’option count-<number of answers> après la valeur du paramètre answers, par extractive|count-3exemple . Le nombre par défaut est de 1. Le seuil de confiance peut être configuré en ajoutant la barre | verticale suivie de l’option threshold-<confidence threshold> après la valeur du paramètre answers, par extractive|threshold-0.9exemple . Le seuil par défaut est de 0,7. La longueur maximale des réponses peut être configurée en ajoutant le caractère barre verticale '|' suivi du 'count-number< of maximum character length>', tel que 'extractive|maxcharlength-600'.
| Valeur | Description |
|---|---|
| none |
Ne renvoyez pas de réponses à la requête. |
| extractive |
Extrait les candidats de réponse du contenu des documents retournés en réponse à une requête exprimée en tant que question en langage naturel. |
QueryCaptionResult
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. |
QueryCaptionType
Ce paramètre n’est valide que si le type de requête est semantic. Si elle est définie, la requête retourne des légendes extraites des passages clés dans les documents classés les plus élevés. Lorsque l’option Sous-titres est définie sur extractive, la mise en surbrillance est activée par défaut et peut être configurée en ajoutant la barre | verticale suivie de l’option highlight-<true/false> , telle que extractive|highlight-true. La valeur par défaut est None. La longueur maximale des caractères des légendes peut être configurée en ajoutant le caractère pipe '|' suivi du 'count-number< of maximum character length>', tel que 'extractive|maxcharlength-600'.
| Valeur | Description |
|---|---|
| none |
Ne renvoyez pas de sous-titres pour la requête. |
| extractive |
Extrait les légendes des documents correspondants qui contiennent des passages pertinents pour la requête de recherche. |
QueryDebugMode
Active un outil de débogage qui peut être utilisé pour explorer davantage vos résultats de recherche. Vous pouvez activer plusieurs modes de débogage simultanément en les séparant par un | caractère, par exemple : semantic|queryRewrites.
| Valeur | Description |
|---|---|
| disabled |
Aucune information de débogage de requête n’est retournée. |
| semantic |
Permet à l’utilisateur d’explorer davantage ses résultats reclassés. |
| vector |
Permet à l’utilisateur d’explorer davantage ses résultats de requête hybride et vectorielle. |
| queryRewrites |
Permet à l’utilisateur d’explorer la liste des réécritures de requête générées pour sa requête de recherche. |
| innerHits |
Permet à l’utilisateur de récupérer des informations de score concernant des vecteurs appariés au sein d’une collection de types complexes. |
| all |
Activez toutes les options de débogage. |
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 (double) |
Score BM25 ou Classique pour la partie texte de la requête. |
| text |
Score BM25 ou Classique pour la partie texte de la requête. |
|
| vectors |
<string,
Single |
La similarité vectorielle et |
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.
| Valeur | Description |
|---|---|
| simple |
Utilise la syntaxe de requête simple pour les recherches. Le texte de recherche est interprété à l’aide d’un langage de requête simple qui autorise l’utilisation de symboles tels que +, * et « ». Par défaut, les requêtes sont évaluées dans tous les champs pouvant faire l’objet d’une recherche, sauf si le paramètre searchFields est spécifié. |
| full |
Utilise la syntaxe de requête Lucene complète pour les recherches. Le texte de recherche est interprété à l’aide du langage de requête Lucene qui permet des recherches spécifiques aux champs et pondérées, ainsi que d’autres fonctionnalités avancées. |
| semantic |
Idéal pour les requêtes exprimées en langage naturel plutôt que pour les mots-clés. Améliore la précision des résultats de recherche en reclassant les premiers résultats de recherche à l’aide d’un modèle de classement entraîné sur le corpus Web. |
ScoringStatistics
Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence inférieure. La valeur par défaut est 'local'. Utilisez « global » pour agréger les statistiques de score globales avant de marquer. L’utilisation de statistiques de score globales peut augmenter la latence des requêtes de recherche.
| Valeur | Description |
|---|---|
| local |
Les statistiques de score seront calculées localement pour réduire la latence. |
| global |
Les statistiques de pointage seront calculées globalement pour un score plus cohérent. |
SearchDocumentsResult
Réponse contenant des résultats de recherche à partir d’un index.
| Nom | Type | Description |
|---|---|---|
| @odata.count |
integer (int64) |
Nombre total de résultats trouvés par l’opération de recherche ou null si le nombre n’a pas été demandé. S’il est présent, le nombre peut être supérieur au nombre de résultats dans cette réponse. Cela peut se produire si vous utilisez les paramètres $top ou $skip, ou si la requête ne peut pas renvoyer tous les documents demandés en une seule réponse. |
| @odata.nextLink |
string |
URL de continuation renvoyée lorsque la requête ne peut pas retourner tous les résultats demandés dans une seule réponse. Vous pouvez utiliser cette URL pour formuler une autre requête de recherche GET ou POST afin d’obtenir la partie suivante de la réponse de recherche. Assurez-vous d’utiliser le même verbe (GET ou POST) que la requête qui a produit cette réponse. |
| @search.answers |
Résultats de la requête réponses pour l’opération de recherche ; Null si le paramètre de requête réponses n’a pas été spécifié ou défini sur « none ». |
|
| @search.coverage |
number (double) |
Valeur indiquant le pourcentage de l’index inclus dans la requête ou null si minimumCoverage n’a pas été spécifié dans la requête. |
| @search.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 |
Charge utile JSON de continuation renvoyée lorsque la requête ne peut pas retourner tous les résultats demandés dans une seule réponse. Vous pouvez utiliser ce JSON en même temps que |
|
| @search.semanticPartialResponseReason |
Raison pour laquelle une réponse partielle a été renvoyée pour une demande de classement sémantique. |
|
| @search.semanticPartialResponseType |
Type de réponse partielle renvoyée pour une demande de classement sémantique. |
|
| value |
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 que le document soit considéré comme une correspondance.
| Valeur | Description |
|---|---|
| any |
Tous les termes de recherche doivent correspondre pour que le document soit considéré comme une correspondance. |
| all |
Tous les termes de recherche doivent correspondre pour que le document soit considéré comme une correspondance. |
SearchRequest
Paramètres de filtrage, de tri, de facette, 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 des expressions de facette à appliquer à la requête de recherche. Chaque expression de facette contient un nom de champ, éventuellement suivi d’une liste séparée par des virgules de paires name :value. |
| filter |
string |
L’expression OData $filter à appliquer à la requête de recherche. |
| highlight |
string |
Liste séparée par des virgules des noms de champs à utiliser pour les surbrillances d’accès. Seuls les champs pouvant faire l’objet d’une recherche peuvent être utilisés pour la mise en surbrillance des accès. |
| highlightPostTag |
string |
Balise de chaîne ajoutée aux surbrillances d’accès. Doit être défini avec highlightPreTag. La valeur par défaut est </em>. |
| highlightPreTag |
string |
Balise de chaîne qui est précédée de mises en surbrillance. Doit être défini avec highlightPostTag. La valeur par défaut est <em>. |
| minimumCoverage |
number (double) |
Nombre compris entre 0 et 100 indiquant le pourcentage de l’index qui doit être couvert par une requête de recherche afin que la requête soit signalée comme une réussite. Ce paramètre peut être utile pour garantir la disponibilité de la recherche même pour les services avec un seul réplica. La valeur par défaut est 100. |
| orderby |
string |
Liste des expressions OData $orderby séparées par des virgules permettant de trier les résultats. Chaque expression peut être un nom de champ ou un appel aux fonctions geo.distance() ou search.score(). Chaque expression peut être suivie d’asc pour indiquer l’ordre croissant ou desc pour indiquer l’ordre décroissant. La valeur par défaut est l’ordre croissant. Les liens seront rompus par les scores de correspondance des documents. Si aucune $orderby n’est spécifiée, l’ordre de tri par défaut descend par score de correspondance de document. Il peut y avoir au maximum 32 clauses $orderby. |
| 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 |
Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence inférieure. La valeur par défaut est 'local'. Utilisez « global » pour agréger les statistiques de score globales avant de marquer. L’utilisation de statistiques de score globales peut augmenter la latence des requêtes de recherche. |
|
| search |
string |
Une expression de requête de recherche en texte intégral ; Utilisez « * » ou omettez ce paramètre pour correspondre à tous les documents. |
| searchFields |
string |
Liste séparée par des virgules des noms de champs auxquels étendre la recherche en texte intégral. Lors de l’utilisation de la recherche fielded (fieldName :searchExpression) dans une requête Lucene complète, les noms de champs de chaque expression de recherche fielded sont prioritaires sur tous les noms de champs répertoriés dans ce paramètre. |
| searchMode |
Valeur qui spécifie si l’un ou l’ensemble des termes de recherche doivent être mis en correspondance pour compter le document comme correspondance. |
|
| select |
string |
Liste des champs à récupérer, séparés par des virgules. S’il n’est pas spécifié, tous les champs marqués comme récupérables dans le schéma sont inclus. |
| semanticConfiguration |
string |
Nom d’une configuration sémantique qui sera utilisée lors du traitement de documents pour les requêtes sémantiques de type. |
| semanticErrorHandling |
Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement (comportement par défaut / actuel) ou renvoyer des résultats partiels. |
|
| semanticMaxWaitInMilliseconds |
integer (int32) minimum: 700 |
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 post-it, ce qui peut aider à obtenir des résultats plus cohérents. Tant que le même id de session est utilisé, une tentative optimale sera effectuée pour cibler le même jeu de réplicas. Soyez prudent que la réutilisation des mêmes valeurs sessionID peut interférer à plusieurs reprises avec l’équilibrage de charge des requêtes entre les réplicas et affecter négativement les performances du service de recherche. La valeur utilisée en tant que sessionId ne peut pas commencer par un caractère '_'. |
| skip |
integer (int32) |
Nombre de résultats de recherche à ignorer. Cette valeur ne peut pas être supérieure à 100 000. Si vous avez besoin d’analyser des documents dans la séquence, mais que vous ne pouvez pas l’utiliser en raison de cette limitation, envisagez d’utiliser orderby sur une clé totalement ordonnée et filtrer avec une requête de plage à la place. |
| top |
integer (int32) |
Nombre de résultats de recherche à récupérer. Cela peut être utilisé conjointement avec $skip pour implémenter la pagination côté client des résultats de recherche. Si les résultats sont tronqués en raison de la pagination côté serveur, la réponse inclut un jeton de continuation qui peut être utilisé pour émettre une autre demande de recherche pour la page suivante des résultats. |
| vectorFilterMode |
Détermine si des filtres sont appliqués avant ou après l’exécution de la recherche vectorielle. La valeur par défaut est 'preFilter' pour les nouveaux index. |
|
| vectorQueries | VectorQuery[]: |
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 ne sont renvoyées que pour les requêtes de type 'semantic'. |
|
| @search.documentDebugInfo |
Contient des informations de débogage qui peuvent être utilisées pour explorer davantage vos résultats de recherche. |
|
| @search.highlights |
object |
Fragments de texte du document indiquant les termes de recherche correspondants, organisés par chaque champ applicable ; null si la mise en surbrillance de l’accès n’a pas été activée pour la requête. |
| @search.rerankerBoostedScore |
number (double) |
Le score de pertinence calculé en augmentant le score Reranker. Les résultats de recherche sont triés par RerankerScore/RerankerBoostedScore en fonction de useScoringProfileBoostedRanking dans la configuration sémantique. RerankerBoostedScore n’est retourné que pour les requêtes de type « sémantique ». |
| @search.rerankerScore |
number (double) |
Le score de pertinence calculé par le classeur sémantique pour les premiers résultats de recherche. Les résultats de recherche sont triés en fonction du RerankerScore d’abord, puis du Score. RerankerScore n’est renvoyé que pour les requêtes de type 'semantic'. |
| @search.score |
number (double) |
Le score de pertinence du document par rapport aux autres documents renvoyés par la requête. |
SemanticErrorMode
Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou de retourner des résultats partiels.
| Valeur | Description |
|---|---|
| partial |
Si le traitement sémantique échoue, 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. |
| fail |
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. |
SemanticErrorReason
Raison pour laquelle une réponse partielle a été renvoyée pour une demande de classement sémantique.
| Valeur | Description |
|---|---|
| maxWaitExceeded |
Si |
| capacityOverloaded |
La requête a été limitée. Seuls les résultats de base ont été retournés. |
| transient |
Au moins une étape du processus sémantique a échoué. |
SemanticSearchResultsType
Type de réponse partielle renvoyée pour une demande de classement sémantique.
| Valeur | Description |
|---|---|
| baseResults |
Résultats sans enrichissement sémantique ni reclassement. |
| rerankedResults |
Les résultats ont été reclassés avec le modèle de reclassement et incluront des légendes sémantiques. Ils n’incluront 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 deux
| Nom | Type | Description |
|---|---|---|
| searchScore |
number (double) |
Lla |
| vectorSimilarity |
number (double) |
Le score de similarité vectorielle pour ce document. Notez qu’il s’agit de la définition canonique de la métrique de similarité, et non de la version « distance ». Par exemple, similarité cosinusoïdale au lieu de distance cosinus. |
TextResult
Score BM25 ou Classique pour la partie texte de la requête.
| Nom | Type | Description |
|---|---|---|
| searchScore |
number (double) |
Score BM25 ou Classique pour la partie texte de la requête. |
VectorFilterMode
Détermine si des filtres sont appliqués avant ou après l’exécution de la recherche vectorielle.
| Valeur | Description |
|---|---|
| postFilter |
Le filtre est appliqué une fois que l’ensemble de résultats de vecteurs candidat est retourné. Selon la sélectivité du filtre, cela peut entraîner moins de résultats que demandés par le paramètre « k ». |
| preFilter |
Le filtre est appliqué avant la requête de recherche. |
| strictPostFilter |
Le filtre sera appliqué après le retour de l’ensemble global des k premiers résultats vectoriels. Cela se traduira par moins de résultats que ce qui est demandé par le paramètre 'k'. |
VectorizableImageBinaryQuery
Les paramètres de requête à utiliser pour la recherche vectorielle lorsqu’un binaire codé en base 64 d’une image devant être vectorisée est fourni.
| Nom | Type | Description |
|---|---|---|
| base64Image |
string |
Le binaire encodé en base 64 d’une image à vectoriser pour effectuer une requête de recherche vectorielle. |
| exhaustive |
boolean |
Quand la valeur est true, déclenche une recherche exhaustive k-nearest voisin sur tous les vecteurs au sein de l’index vectoriel. Utile pour les scénarios où les correspondances exactes sont critiques, telles que la détermination des valeurs de vérité de base. |
| fields |
string |
Champs vectoriels de type Collection(Edm.Single) à inclure dans le vecteur recherché. |
| k |
integer (int32) |
Nombre de voisins les plus proches à retourner en tant que premiers coups. |
| kind |
string:
image |
Type de requête. |
| oversampling |
number (double) |
Facteur de surachantillonnage. La valeur minimale est de 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. |
| weight |
number (float) |
Poids relatif de la requête vectorielle par rapport à une autre requête vectorielle et/ou à la requête de texte dans la même requête de recherche. Cette valeur est utilisée lors de la combinaison des résultats de plusieurs listes de classement produites par les différentes requêtes vectorielles et/ou les résultats récupérés via la requête de texte. Plus le poids est élevé, plus les documents correspondants à cette requête seront dans le classement final. La valeur par défaut est 1.0 et la valeur doit être un nombre positif supérieur à zéro. |
VectorizableImageUrlQuery
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é. |
| k |
integer (int32) |
Nombre de voisins les plus proches à retourner en tant que premiers coups. |
| kind |
string:
image |
Type de requête. |
| oversampling |
number (double) |
Facteur de surachantillonnage. La valeur minimale est de 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. |
| url |
string |
URL d’une image à vectoriser pour effectuer une requête de recherche vectorielle. |
| weight |
number (float) |
Poids relatif de la requête vectorielle par rapport à une autre requête vectorielle et/ou à la requête de texte dans la même requête de recherche. Cette valeur est utilisée lors de la combinaison des résultats de plusieurs listes de classement produites par les différentes requêtes vectorielles et/ou les résultats récupérés via la requête de texte. Plus le poids est élevé, plus les documents correspondants à cette requête seront dans le classement final. La valeur par défaut est 1.0 et la valeur doit être un nombre positif supérieur à zéro. |
VectorizableTextQuery
Les paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur de texte devant être vectorisée est fournie.
| Nom | Type | Description |
|---|---|---|
| exhaustive |
boolean |
Quand la valeur est true, déclenche une recherche exhaustive k-nearest voisin sur tous les vecteurs au sein de l’index vectoriel. Utile pour les scénarios où les correspondances exactes sont critiques, telles que la détermination des valeurs de vérité de base. |
| fields |
string |
Champs vectoriels de type Collection(Edm.Single) à inclure dans le vecteur recherché. |
| k |
integer (int32) |
Nombre de voisins les plus proches à retourner en tant que premiers coups. |
| kind |
string:
text |
Type de requête. |
| oversampling |
number (double) |
Facteur de surachantillonnage. La valeur minimale est de 1. Il remplace le paramètre « defaultOversampling » configuré dans la définition d’index. Elle ne peut être définie que lorsque « rerankWithOriginalVectors » a la valeur true. Ce paramètre est autorisé uniquement lorsqu’une méthode de compression est utilisée sur le champ vectoriel sous-jacent. |
| text |
string |
Texte à vectoriser pour effectuer une requête de recherche vectorielle. |
| weight |
number (float) |
Poids relatif de la requête vectorielle par rapport à une autre requête vectorielle et/ou à la requête de texte dans la même requête de recherche. Cette valeur est utilisée lors de la combinaison des résultats de plusieurs listes de classement produites par les différentes requêtes vectorielles et/ou les résultats récupérés via la requête de texte. Plus le poids est élevé, plus les documents correspondants à cette requête seront dans le classement final. La valeur par défaut est 1.0 et la valeur doit être un nombre positif supérieur à zéro. |
VectorizedQuery
Paramètres de requête à utiliser pour la recherche vectorielle lorsqu’une valeur vectorielle brute est fournie.
| Nom | Type | Description |
|---|---|---|
| exhaustive |
boolean |
Quand la valeur est true, déclenche une recherche exhaustive k-nearest voisin sur tous les vecteurs au sein de l’index vectoriel. Utile pour les scénarios où les correspondances exactes sont critiques, telles que la détermination des valeurs de vérité de base. |
| fields |
string |
Champs vectoriels de type Collection(Edm.Single) à inclure dans le vecteur recherché. |
| k |
integer (int32) |
Nombre de voisins les plus proches à retourner en tant que premiers coups. |
| kind |
string:
vector |
Type de requête. |
| oversampling |
number (double) |
Facteur de surachantillonnage. La valeur minimale est de 1. Il remplace le paramètre « defaultOversampling » configuré dans la définition d’index. Elle ne peut être définie que lorsque « rerankWithOriginalVectors » a la valeur true. Ce paramètre est autorisé uniquement lorsqu’une méthode de compression est utilisée sur le champ vectoriel sous-jacent. |
| vector |
number[] (float) |
Représentation vectorielle d’une requête de recherche. |
| weight |
number (float) |
Poids relatif de la requête vectorielle par rapport à une autre requête vectorielle et/ou à la requête de texte dans la même requête de recherche. Cette valeur est utilisée lors de la combinaison des résultats de plusieurs listes de classement produites par les différentes requêtes vectorielles et/ou les résultats récupérés via la requête de texte. Plus le poids est élevé, plus les documents correspondants à cette requête seront dans le classement final. La valeur par défaut est 1.0 et la valeur doit être un nombre positif supérieur à zéro. |
VectorQueryKind
Type de requête vectorielle en cours d’exécution.
| Valeur | Description |
|---|---|
| vector |
Requête vectorielle où une valeur vectorielle brute est fournie. |
| text |
Requête vectorielle où une valeur de texte qui doit être vectorisée est fournie. |
| imageUrl |
Requête vectorielle dans laquelle une URL représentant une valeur d’image qui doit être vectorisée est fournie. |
| imageBinary |
Requête vectorielle dans laquelle un binaire encodé en base 64 d’une image qui doit être vectorisée est fourni. |
VectorsDebugInfo
« Contient des informations de débogage spécifiques à la recherche vectorielle et hybride. »)
| Nom | Type | Description |
|---|---|---|
| subscores |
La répartition des sous-scores du document avant la méthode de fusion/combinaison d’ensemble de résultats choisie, telle que RRF. |