diff --git a/data-workflow/swagger.json b/data-workflow/swagger.json index e571080..727d19a 100644 --- a/data-workflow/swagger.json +++ b/data-workflow/swagger.json @@ -3,7 +3,7 @@ "info": { "title": "data-workflow - Enchainement de traitements asynchrones", "summary": "Les worflows permettent de traiter des fichiers corpus compressés en appelant des webservices d'enrichissement par documents (webservices synchrones)", - "version": "1.0.0", + "version": "1.0.1", "termsOfService": "https://services.istex.fr/", "contact": { "name": "Inist-CNRS", diff --git a/data-workflow/v1/retrieve.ini b/data-workflow/v1/retrieve.ini new file mode 100644 index 0000000..fd45198 --- /dev/null +++ b/data-workflow/v1/retrieve.ini @@ -0,0 +1,28 @@ +# Entrypoint output format +mimeType = application/x-tar +extension = tar.gz + +# OpenAPI Documentation - JSON format (dot notation) +post.operationId = post-v1-retrieve +post.description = Récupération d'un résulat produit sous forme d'un fichier corpus +post.summary = Les traitments étant asynchrone le résulat une fois créé doit-être récupéré par cette route +post.tags.0 = data-computer +post.responses.default.description = Fichier corpus au format tar.gz +post.responses.default.content.application/x-tar.schema.type = string +post.responses.default.content.application/x-tar.schema.format = binary +post.requestBody.content.application/json.example.0.value = xMkWJX7GU +post.requestBody.content.application/json.schema.$ref = #/components/schemas/JSONStream +post.requestBody.required = true + +[use] +plugin = basics + +[JSONParse] +separator = * + +[exchange] +value = get('value') + +[FILELoad] +location = /tmp/retrieve + diff --git a/fund-ner/README.md b/fund-ner/README.md new file mode 100644 index 0000000..40dddd7 --- /dev/null +++ b/fund-ner/README.md @@ -0,0 +1,32 @@ +# fund-ner + +Cette instance propose un outil de détection de financeurs. + +## Configuration + +L'application à utiliser est XXX. + +## Utilisation + +- [v1/funderTagger/funderTagger](#v1) + +### v1 + +Ce web-service renvoie la liste des financeurs présent dans un texte. +Il prend en entrée du JSON avec deux champs, `id` et `value`, et renvoie un JSON avec le la liste des financeurs trouvés dans le champ `value`. +Il est important de souligner que le programme détécte en fonction du contexte de la phrase, il ne s'agit pas de détéction via une base de financeurs existante. + +#### Exemple de v1/first-name/gender + +Entrée +```bash +$ cat <