Aller au contenu principal
NEXCLARADocumentation

knowledge

SAGE, recherche sourcee : passages autorises de la documentation, cites (titre, lien, section, version, fraicheur). Aucune reponse generee : aucun modele de langage n'est employe.

Les descriptions viennent du contrat, rédigé en français. Elles sont reproduites telles quelles pour rester la source de vérité.

POST /api/v1/knowledge/answers

Reponse redigee par assistance, sources designees (desactivee par defaut)

Redaction a partir des seuls passages autorises ; refusee si une citation manque.

knowledgeAnswer

Paramètres

Aucun paramètre.

Corps de la requête

Type de contenu
application/json
Type
AnswerIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonAnswerOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/knowledge/common/{key}

Lire un document du corpus commun

Cible des citations `api` d'un document reserve : meme regle d'acces que la recherche.

knowledgeCommonRead

Paramètres

ParamètreEmplacementTypeRequisContraintes
keypathstringouipattern: "^[a-z0-9][a-z0-9._-]{2,127}$"
languagequery"fr" | "en"oui

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonDocumentOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/knowledge/documents

Documents de l'institution

Corpus propre a l'institution, par cle puis langue (`knowledge.manage`).

knowledgeDocumentList

Paramètres

Aucun paramètre.

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonarray<DocumentSummaryOut>

GET /api/v1/knowledge/documents/{key}

Lire un document

Cible des citations `api` : meme regle d'acces que la recherche.

knowledgeDocumentRead

Paramètres

ParamètreEmplacementTypeRequisContraintes
keypathstringouipattern: "^[a-z0-9][a-z0-9._-]{2,127}$"
languagequery"fr" | "en"oui

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonDocumentOut
422Validation Errorapplication/jsonHTTPValidationError

PUT /api/v1/knowledge/documents/{key}

Deposer ou remplacer un document de l'institution

Valide, decoupe, indexe et trace le depot (`knowledge.manage`).

knowledgeDocumentPut

Paramètres

ParamètreEmplacementTypeRequisContraintes
keypathstringouipattern: "^[a-z0-9][a-z0-9._-]{2,127}$"
languagequery"fr" | "en"oui

Corps de la requête

Type de contenu
application/json
Type
DocumentIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonDocumentPutOut
422Validation Errorapplication/jsonHTTPValidationError

DELETE /api/v1/knowledge/documents/{key}

Retirer un document de l'institution

Retire le document et ses passages ; l'empreinte reste dans la trace.

knowledgeDocumentDelete

Paramètres

ParamètreEmplacementTypeRequisContraintes
keypathstringouipattern: "^[a-z0-9][a-z0-9._-]{2,127}$"
languagequery"fr" | "en"oui

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
204Successful Response—
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/knowledge/search

Recherche sourcee dans la documentation

Passages autorises les plus pertinents, filtres par droits AVANT classement.

knowledgeSearch

Paramètres

ParamètreEmplacementTypeRequisContraintes
qquerystringouiminLength: 1 ; maxLength: 2000
languagequery"fr" | "en"oui
limitqueryintegernonminimum: 1 ; maximum: 50 ; default: 5
modulequerystring | nullnonpattern: "^[a-z]{2,16}$"

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonSearchOut
422Validation Errorapplication/jsonHTTPValidationError