Documents - Search Post
Recherche des documents dans l’index.
POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2023-11-01
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. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
ID de suivi envoyé avec la demande pour faciliter le débogage. |
Corps de la demande
Nom | Type | Description |
---|---|---|
answers |
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. |
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>. |
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. |
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 (comportement par défaut/actuel) ou de retourner des résultats partiels. |
|
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 requête. |
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é totalement ordonnée et de filtrer avec une requête de plage à la place. |
top |
integer |
Nombre de résultats de recherche à récupérer. Cela peut être utilisé conjointement avec $skip pour implémenter la pagination côté client des résultats de 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 » 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 |
Réponse contenant des documents qui correspondent aux critères de recherche. |
|
Other Status Codes |
Réponse d’erreur. |
Exemples
Search |
Search |
SearchIndexSearchDocumentsPost
Exemple de requête
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01
{
"count": true,
"facets": [
"category,count:10,sort:count"
],
"filter": "rating gt 4.0",
"highlight": "description",
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"minimumCoverage": null,
"orderby": "rating desc",
"queryType": "simple",
"scoringParameters": [
"currentLocation--122.123,44.77233"
],
"scoringProfile": "sp",
"search": "nice hotels",
"searchFields": "category,description",
"searchMode": "any",
"sessionId": "mysessionid",
"scoringStatistics": "global",
"select": "hotelId,category,description",
"skip": 0,
"top": 10,
"vectorQueries": [
{
"kind": "vector",
"vector": [
0.103,
0.0712,
0.0852,
0.1547,
0.1183
],
"fields": "descriptionEmbedding",
"k": 5,
"exhaustive": true
}
],
"vectorFilterMode": "preFilter"
}
Exemple de réponse
{
"@odata.count": 25,
"@search.facets": {
"category": [
{
"count": 1,
"value": "Economy"
},
{
"count": 1,
"value": "Luxury"
}
]
},
"@search.nextPageParameters": {
"count": true,
"facets": [
"category,count:10,sort:count"
],
"filter": "rating gt 4.0",
"highlight": "title",
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"minimumCoverage": null,
"orderby": "search.score() desc,rating desc",
"queryType": "simple",
"sessionId": "mysessionid",
"scoringStatistics": "global",
"scoringParameters": [
"currentLocation--122.123,44.77233"
],
"scoringProfile": "sp",
"search": "nice hotels",
"searchFields": "title,description",
"searchMode": "any",
"select": "docId,title,description",
"skip": 2,
"top": 8
},
"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"
}
],
"@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01"
}
SearchIndexSearchDocumentsSemanticPost
Exemple de requête
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-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=2023-11-01"
}
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 par rapport à la requête de recherche. Ils sont souvent utilisés comme résumé de document. Les sous-titres sont retournés uniquement pour les requêtes de type |
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 |
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. |
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 |
Décrit une condition d’erreur pour l’API. |
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. |
Semantic |
Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement (comportement par défaut/actuel) ou de retourner des résultats partiels. |
Semantic |
Raison pour laquelle une réponse partielle a été retournée pour une demande de classement sémantique. |
Semantic |
Type de réponse partielle retournée pour une demande de classement sémantique. |
Vector |
Détermine si les filtres sont appliqués avant ou après l’exécution de la recherche vectorielle. |
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 par rapport à la requête de recherche. Ils sont souvent utilisés comme résumé de document. Les sous-titres sont retournés uniquement pour les requêtes de type semantic
.
Nom | Type | Description |
---|---|---|
highlights |
string |
Même passage de texte que dans la propriété Text avec les expressions en surbrillance les plus pertinentes pour la requête. |
text |
string |
Passage de texte représentatif extrait du document le plus pertinent pour la requête de recherche. |
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. |
QueryType
Spécifie la syntaxe de la requête de recherche. La valeur par défaut est « simple ». Utilisez « full » si votre requête utilise la syntaxe de requête Lucene.
Nom | Type | Description |
---|---|---|
full |
string |
Utilise la syntaxe de requête Lucene complète pour les recherches. Le texte de recherche est interprété à l’aide du langage de requête Lucene qui permet des recherches spécifiques aux champs et pondérées, ainsi que d’autres fonctionnalités avancées. |
semantic |
string |
Mieux adapté aux requêtes exprimées en langage naturel par opposition aux mots clés. Améliore la précision des résultats de 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 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:
vector |
Type de requête vectorielle en cours d’exécution. |
vector |
number[] |
Représentation vectorielle d’une requête de recherche. |
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. |
SearchError
Décrit une condition d’erreur pour l’API.
Nom | Type | Description |
---|---|---|
code |
string |
Un des codes d’erreur définis par le serveur. |
details |
Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée. |
|
message |
string |
Représentation lisible par l’homme de l’erreur. |
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. |
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>. |
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. |
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 (comportement par défaut/actuel) ou de retourner des résultats partiels. |
|
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. |
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. |
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 » 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 par rapport à la requête de recherche. Ils sont souvent utilisés comme résumé de document. Les sous-titres sont retournés uniquement pour les requêtes de type |
|
@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 premiers résultats de recherche. 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 |
@search.score |
number |
Score de pertinence du document par rapport à d’autres documents retournés par la requête. |
SemanticErrorMode
Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement (comportement par défaut/actuel) ou de retourner des résultats partiels.
Nom | Type | Description |
---|---|---|
fail |
string |
S’il existe une exception pendant l’étape de traitement sémantique, la requête échoue et retourne le code HTTP approprié en fonction de l’erreur. |
partial |
string |
Si le traitement sémantique échoue, les résultats partiels retournent toujours. La définition des résultats partiels dépend de l’étape sémantique 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 |
transient |
string |
Au moins une étape du processus sémantique a échoué. |
SemanticSearchResultsType
Type de réponse partielle retournée pour une demande de classement sémantique.
Nom | Type | Description |
---|---|---|
baseResults |
string |
Résultats sans enrichissement sémantique ni reclassement. |
rerankedResults |
string |
Les résultats ont été reclassés avec le modèle de reclassement et incluront des légendes sémantiques. Ils n’incluront pas de réponses, de surbrillances de réponses ou de légende points forts. |
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, le nombre de résultats peut être inférieur à celui demandé par le paramètre « k ». |
preFilter |
string |
Le filtre sera appliqué avant la requête de recherche. |
VectorQueryKind
Type de requête vectorielle en cours d’exécution.
Nom | Type | Description |
---|---|---|
vector |
string |
Requête vectorielle dans laquelle une valeur vectorielle brute est fournie. |