API SmartFAQ

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

oauth2OAuth 2.0
Token URLhttp://example.com/oauth/token
Flowapplication
Scopes
writeallows modifying resources
readallows 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
NameLocated inDescriptionRequiredSchema
idbodyL'identifiant de la smart FAQNointeger
Responses
CodeDescriptionSchema
200OKFaqItem

/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
NameLocated inDescriptionRequiredSchema
inputbodyPhrase de l'utilisateur pour interroger la base de connaissanceNostring
Responses
CodeDescriptionSchema
200OKFaqSingle

Models

FaqItem

NameTypeDescriptionRequired
IdintegerIdentifiant unique de la smart FAQ.No
InternalIdintegerIdentifiant logique.No
AnswerstringRéponse de la smart FAQ.No
UristringUri 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 maximumNo
SousCategories[ string ]Sous-categorie associée à la smart FAQ. Ne peut contenir que une seule valeur au maximumNo

FaqSingle

NameTypeDescriptionRequired
IdintegerIdentifiant unique de la smart FAQ.No
AnswerstringRéponse de la smart FAQ.No
UristringUri 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 maximumNo
SousCategories[ string ]Sous-categorie associée à la smart FAQ. Ne peut contenir que une seule valeur au maximumNo