L'API Retrieve renvoie des segments de texte issus d'une base de connaissances en se basant sur la similarité sémantique. Lorsque la recherche sémantique retourne trop de résultats non pertinents, utilisez SearchFilters pour appliquer un filtrage basé sur les métadonnées aux résultats sémantiques. Cette approche est efficace pour les données structurées, telles que les tableaux de données disposant de champs bien définis.
Fonctionnement de SearchFilters
Sans SearchFilters, l'API Retrieve renvoie tous les segments de texte sémantiquement similaires, ce qui peut inclure des correspondances non pertinentes. SearchFilters effectue d'abord une recherche sémantique, puis filtre les résultats selon des conditions de champ.
Sans SearchFilters :

Name: "San Zhang".

Syntaxe
SearchFilters est un tableau de sous-groupes. Chaque sous-groupe est un objet JSON contenant une ou plusieurs paires field: value. Les sous-groupes sont toujours combinés avec une logique AND.
Name = "San Zhang" ET Sex = "Male" (au sein du sous-groupe 1) ET Position = "Engineer" (sous-groupe 2).
Types de requête pris en charge
Référence des opérateurs
| Type de requête | Opérateur | Types de champ pris en charge | Description |
|---|---|---|---|
| Valeur unique | *(valeur directe)* | chaîne, numérique (long, double) | Correspond à une seule valeur exacte. Exemple : {"Name": "San Zhang"} |
| Valeurs multiples | *(tableau JSON)* | tableau de chaînes, tableau numérique | Correspond à n'importe quelle valeur du tableau (similaire à SQL IN). Exemple : {"Name": "[\"San Zhang\",\"Si Li\"]"} |
| Égalité | eq | chaîne, numérique | Égal à. Exemple : {"Name": {"eq": "San Zhang"}} |
| Égalité | neq | chaîne, numérique | Différent de. Exemple : {"Name": {"neq": "San Zhang"}} |
| Intervalle | gt | numérique | Supérieur à. Exemple : {"Age": {"gt": 20}} |
| Intervalle | gte | numérique | Supérieur ou égal à. Exemple : {"Age": {"gte": 20}} |
| Intervalle | lt | numérique | Inférieur à. Exemple : {"Age": {"lt": 30}} |
| Intervalle | lte | numérique | Inférieur ou égal à. Exemple : {"Age": {"lte": 30}} |
| Floue | like | chaîne | Correspondance de motif avec caractères génériques. Exemple : {"Position": {"like": "E%r"}} |
| Tag | tags | tableau de chaînes | Filtrer par tags de document (bases de connaissances de recherche de documents uniquement). Exemple : {"tags": "[\"tag1\",\"tag2\"]"} |
Caractères génériques pour les requêtes floues
| Caractère | Description | Exemple |
|---|---|---|
% | Correspond à zéro ou plusieurs caractères | E%r correspond à Engineer |
_ | Correspond à exactement un caractère | E_gineer correspond à Engineer |
Logique des requêtes de tag
- Plusieurs tags au sein d'un même sous-groupe utilisent une logique OR : les fichiers correspondant à n'importe quel tag sont renvoyés.
- Pour appliquer une logique AND entre les tags, placez chaque tag dans un sous-groupe distinct.
Prérequis
Vous avez besoin des éléments suivants :
- (Uniquement pour les utilisateurs RAM) La stratégie AliyunBailianDataFullAccess et l'adhésion à l'espace de travail. Non requis pour un compte Alibaba Cloud.
- Un ID d'espace de travail
- Le SDK Model Studio installé et configuré
- AccessKey et AccessKey secret configurés en tant que variables d'environnement
Les utilisateurs RAM peuvent gérer les bases de connaissances uniquement dans les espaces de travail auxquels ils ont adhéré. Les comptes Alibaba Cloud peuvent gérer tous les espaces de travail.
Configuration des exemples de données
Les exemples utilisent le fichier EmployeeInformation.xlsx (3 enregistrements). Créez une base de connaissances avec les paramètres suivants :
| Paramètre | Valeur |
|---|---|
| Knowledge base type | Data Query |
| Data source | Upload Data Table |
| Fields | Name (string), Sex (string), Position (string), Age (double) |
| Index settings | Tous les champs utilisés pour la récupération et les réponses du modèle |

Exemples de code complets
Les exemples Python et Java suivants couvrent tous les types de requête.
Avant d'exécuter l'exemple de code, configurez votre AccessKey et votre AccessKey secret en tant que variables d'environnement .
- Python
- Java
SearchFiltersFullExample.py
SearchFiltersFullExample.py
Exemples par type de requête
Chaque type de requête inclut la syntaxe JSON ainsi qu'un exemple de requête et de réponse.
Remplacez ces espaces réservés par vos valeurs réelles :
| Espace réservé | Description | Exemple |
|---|---|---|
<knowledge-base-id> | ID d'index de la base de connaissances | 27ubwxxxxx |
<workspace-id> | ID de l'espace de travail | llm-4u5xpd1xdjxxxxxx |
Requête par sous-groupe
Chaque élément du tableau searchFilters constitue un sous-groupe combinant des conditions de filtrage. Tous les sous-groupes doivent correspondre (logique AND).
Filtrer les enregistrements où Name est « San Zhang » ET Sex est « Female » :
nodes est vide.
- Python
- Java
SubGroupQueryExample.py
SubGroupQueryExample.py
Exemple de requête
Exemple de requête
Exemple de réponse
Exemple de réponse
Requête à valeur unique
Transmettez une valeur unique pour un champ afin de faire correspondre les enregistrements ayant exactement cette valeur.
Filtrer les enregistrements où Name est « San Zhang » :
- Python
- Java
SingleQueryExample.py
SingleQueryExample.py
Exemple de requête
Exemple de requête
Exemple de réponse
Exemple de réponse
Requête à valeurs multiples
Transmettez plusieurs valeurs pour un champ afin de faire correspondre les enregistrements contenant l'une des valeurs spécifiées, similairement à l'opérateur SQL IN. Sérialisez le tableau de valeurs sous forme de chaîne JSON.
Filtrer les enregistrements où Name est « San Zhang » ou « Si Li » :
- Python
- Java
MultiQueryExample.py
MultiQueryExample.py
Exemple de requête
Exemple de requête
Exemple de réponse
Exemple de réponse
Requête de plage
Utilisez les requêtes de plage pour trouver les enregistrements dont un champ numérique se situe dans un intervalle spécifié. Combinez les requêtes de plage avec d'autres types de requête en les plaçant dans des sous-groupes distincts.
Filtrer les enregistrements où Position est « Engineer » (valeur unique) ET Age est compris entre 20 et 25 (plage) :
- Python
- Java
RangeQueryExample.py
RangeQueryExample.py
Exemple de requête
Exemple de requête
Exemple de réponse
Exemple de réponse
Requête floue
Utilisez des motifs avec caractères génériques pour faire correspondre partiellement les champs de chaîne, similairement à l'opérateur SQL LIKE. Enveloppez le motif dans un objet {"like": "<pattern>"} et sérialisez-le sous forme de chaîne JSON.
Filtrer les enregistrements où Name est « San Zhang » ET Position commence par « E » et se termine par « r » :
- Python
- Java
WildcardQueryExample.py
WildcardQueryExample.py
Exemple de requête
Exemple de requête
Exemple de réponse
Exemple de réponse
Requête de tag
Filtrez par tags de document dans une base de connaissances de recherche de documents . Les tags restreignent la récupération aux segments de texte provenant de fichiers correspondant à des valeurs de tag spécifiques.
Configuration de l'exemple : Une base de connaissances de recherche de documents contient trois fichiers de CV avec les tags suivants :
| Fichier | Tags |
|---|---|
| CV de San Zhang | University A, Sports Specialist Student |
| CV de Si Li | University B |
| CV de Wu Wang | University B, Student Union President |
Exemple 1 : Logique OR (plusieurs tags dans un seul sous-groupe)
Renvoyer les segments de texte des fichiers tagués avec University A OU Student Union President :
Plusieurs tags au sein d'un même sous-groupe utilisent une logique OR. Pour appliquer une logique AND, placez chaque tag dans un sous-groupe distinct (voir l'exemple 2).
Python -- TagQueryExample.py
Python -- TagQueryExample.py
Java -- TagQueryExample.java
Java -- TagQueryExample.java
Exemple de requête
Exemple de requête
Exemple de réponse
Exemple de réponse
University A) et du CV de Wu Wang (tagué Student Union President).
Exemple 2 : Logique AND (tags dans des sous-groupes distincts)
Renvoyer les segments de texte des fichiers tagués à la fois avec University A ET Sports Specialist Student :
Python -- TagQueryExample2.py
Python -- TagQueryExample2.py
Java -- TagQueryExample2.java
Java -- TagQueryExample2.java
Exemple de requête
Exemple de requête
Exemple de réponse
Exemple de réponse
Références
| Ressource | Description |
|---|---|
| Créer et utiliser une base de connaissances | Guide d'utilisation de la base de connaissances |
| API Retrieve | Récupérer des segments de texte depuis une base de connaissances |
| Accorder des autorisations API à un utilisateur RAM | Configurer l'accès utilisateur RAM pour l'API Retrieve |
| Codes d'erreur | Résoudre les échecs d'appel API |