Sample Application Flow OAuth2 Project
This is an example of using OAuth2 Application Flow in a specification to describe security to your API.
Version: 1.0.0
Security
application
| oauth2 | OAuth 2.0 |
|---|---|
| Token URL | http://example.com/oauth/token |
| Flow | application |
| Scopes | |
| write | allows modifying resources |
| read | allows reading resources |
/GetFaqById
GET
Summary:
Obtenir une smart FAQ depuis son identifiant
Description:
Permet de récupérer un object smart FAQ depuis son identifiant passé en paramètre
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | body | L'identifiant de la smart FAQ | No | integer |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | FaqItem |
/Predict
GET
Summary:
Interroge la base de connaissance
Description:
Cette opération retourne les smart FAQ, les plus proches de la phrase passée en paramètre.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Phrase de l'utilisateur pour interroger la base de connaissance | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | FaqSingle |
Models
FaqItem
| Name | Type | Description | Required |
|---|---|---|---|
| Id | integer | Identifiant unique de la smart FAQ. | No |
| InternalId | integer | Identifiant logique. | No |
| Answer | string | Réponse de la smart FAQ. | No |
| Uri | string | Uri associé à la smart FAQ. | No |
| Tags | [ string ] | Tags associées à la smart FAQ. | No |
| Questions | [ string ] | Questions associées à la smart FAQ. | No |
| Categories | [ string ] | Categorie associée à la smart FAQ. Ne peut contenir que une seule valeur au maximum | No |
| SousCategories | [ string ] | Sous-categorie associée à la smart FAQ. Ne peut contenir que une seule valeur au maximum | No |
FaqSingle
| Name | Type | Description | Required |
|---|---|---|---|
| Id | integer | Identifiant unique de la smart FAQ. | No |
| Answer | string | Réponse de la smart FAQ. | No |
| Uri | string | Uri associée à la smart FAQ. | No |
| Tags | [ string ] | Tags associées à la smart FAQ. | No |
| Question | [ string ] | Questions associées à la smart FAQ. | No |
| Categories | [ string ] | Categorie associée à la smart FAQ. Ne peut contenir que une seule valeur au maximum | No |
| SousCategories | [ string ] | Sous-categorie associée à la smart FAQ. Ne peut contenir que une seule valeur au maximum | No |