blog image

19 Novembre 2023

Documentation

Utiliser les données Remède

Ce poste est destiné à vous apprendre comment intégrer notre dictionnaire dans vos applications…

Table des matières

Pourquoi utiliser Remède ?

Si vous avez besoins de chercher une définition, des synonymes, des antonymes et plus d’informations à propos d’un mot Remède est fait pour vous:

  • 100% open source
  • Français
  • Tout type de support (JSON, API, Sqlite)
  • +220 000 mots

Utiliser nos services

Vous avez désormais trouvé l’outil parfait pour s’intégrer dans votre projet. Vous verrez ci-dessous comment procéder pour chaque support disponible…

Chaque support renvoie un document JSON suivant le schéma REMEDE

Avec l’API

Remède possède sa propre API écrite en python avec Fastapi.

Une instance publique est accessible à api-remede.camarm.fr (retrouvez la documentation ici).

Elle vous permet de:

  • Rechercher un mot (renvoie 6 mots commençant par query ): /autocomplete/[query]
  • Obtenir le document d’un mot: /word/[word]
  • Obtenir un mot aléatoire: /random
  • Télécharger la base Sqlite: /download
  • Obtenir des informations sur l’API: /

Cette option est conseillée pour les applications web, basées sur le web, light.

Lancez votre propre instance

Il est possible que vous vouliez garder le contrôle et la maintenance de votre propre API. C’est pour cela que vous pouvez facilement lancer votre propre instance.

  1. Clonez le dépôt
  2. Suivez la documentation configurer et lancer l’api

Avec les fichiers JSON

Remède stocke par défaut ses mots indexés dans des fichiers JSON.

Ils sont disponibles depuis la racine du projet dans le dossier data, sous les noms REMEDE_[lettre].json. Le ficher REMEDE_a.json contient tous les mots commençants par ‘a’ et ainsi de suite…

Ils contiennent chaque mot, représentés par une clé du dictionnaire, qui est associée au document Remède de ce mot.

Cette option est conseillée pour les applications javascript, python, expérimentales.

Avec la base Sqlite

Une base Sqlite peut être générée depuis les données JSON avec le script generate_sqlite.py, placé à la racine du projet.

Elle est formée ainsi:

  • Une table dictionary
  • Avec les champs
    • word: le mot
    • document: le document associé, en format JSON

Cette option est conseillée pour les applications backend, utilitaire, natives.

Attributions

Merci de préciser que vous utilisez nos services dans vos applications:

Licence Cecill V2.1