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.
Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.
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
Parameters
No parameters.
Request body
- Content type
application/json- Type
AnswerIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | AnswerOut |
422 | Validation Error | application/json | HTTPValidationError |
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
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
key | path | string | yes | pattern: "^[a-z0-9][a-z0-9._-]{2,127}$" |
language | query | "fr" | "en" | yes |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | DocumentOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/knowledge/documents
Documents de l'institution
Corpus propre a l'institution, par cle puis langue (`knowledge.manage`).
knowledgeDocumentList
Parameters
No parameters.
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | array<DocumentSummaryOut> |
GET /api/v1/knowledge/documents/{key}
Lire un document
Cible des citations `api` : meme regle d'acces que la recherche.
knowledgeDocumentRead
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
key | path | string | yes | pattern: "^[a-z0-9][a-z0-9._-]{2,127}$" |
language | query | "fr" | "en" | yes |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | DocumentOut |
422 | Validation Error | application/json | HTTPValidationError |
PUT /api/v1/knowledge/documents/{key}
Deposer ou remplacer un document de l'institution
Valide, decoupe, indexe et trace le depot (`knowledge.manage`).
knowledgeDocumentPut
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
key | path | string | yes | pattern: "^[a-z0-9][a-z0-9._-]{2,127}$" |
language | query | "fr" | "en" | yes |
Request body
- Content type
application/json- Type
DocumentIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | DocumentPutOut |
422 | Validation Error | application/json | HTTPValidationError |
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
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
key | path | string | yes | pattern: "^[a-z0-9][a-z0-9._-]{2,127}$" |
language | query | "fr" | "en" | yes |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
204 | Successful Response | — | |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/knowledge/search
Recherche sourcee dans la documentation
Passages autorises les plus pertinents, filtres par droits AVANT classement.
knowledgeSearch
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
q | query | string | yes | minLength: 1 ; maxLength: 2000 |
language | query | "fr" | "en" | yes | |
limit | query | integer | no | minimum: 1 ; maximum: 50 ; default: 5 |
module | query | string | null | no | pattern: "^[a-z]{2,16}$" |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | SearchOut |
422 | Validation Error | application/json | HTTPValidationError |