Routes

SayMyData API

post

Créez un nouveau Centre de Connaissance.

Autorisations
Corps
Réponses
200
Centre de Connaissance créé avec succès.
application/json
post
POST /v1/kb HTTP/1.1
Host: api.saymydata.fr
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": "d2d2f116-694d-4062-958f-02d028b7b17a",
  "name": "phramcie",
  "description": "",
  "created_at": "2024-11-11T20:22:41.434Z"
}
post

Créez une nouvelle ressource.

Autorisations
Paramètres de chemin
idstringRequis

Identifiant unique du Centre de Connaissance.

Paramètres d'en-tête
X-API-KeystringRequisDefault: VOTRE_API_KEY
Corps
securitystringOptionnel

Niveau de sécurité de la ressource (par exemple : public, private).

Réponses
200
Ressource créée avec succès.
application/json
post
POST /v1/kb/{id}/resources HTTP/1.1
Host: api.saymydata.fr
X-API-Key: VOTRE_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "security": "text",
  "files": [
    {
      "filename": "text",
      "payload": "text"
    }
  ],
  "text": {
    "body": "text"
  },
  "url": {
    "body": "text"
  }
}
{
  "message": "Ressource créée avec succès, un email de confirmation vous sera envoyé.",
  "status": "success"
}
post

Importez une nouvelle source dans une ressource.

Autorisations
Paramètres de chemin
idstringRequis

Identifiant unique du Centre de Connaissance.

resource_idstringRequis

Identifiant unique de la ressource.

Paramètres d'en-tête
X-API-KeystringRequisDefault: VOTRE_API_KEY
Corps
securitystringOptionnel

Niveau de sécurité de la ressource (par exemple : public, private).

Réponses
200
Source importée avec succès.
application/json
post
POST /v1/kb/{id}/resources/{resource_id}/upload HTTP/1.1
Host: api.saymydata.fr
X-API-Key: VOTRE_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "security": "text",
  "files": [
    {
      "filename": "text",
      "payload": "text"
    }
  ],
  "text": {
    "body": "text"
  },
  "url": {
    "body": "text"
  }
}
{
  "message": "Sources importée avec succès.",
  "status": "success"
}
get

Récupérez une source de données spécifique.

Autorisations
Paramètres de chemin
idstringRequis

Identifiant unique du Centre de Connaissance.

resource_idstringRequis

Identifiant unique de la ressource.

source_idstringRequis

Identifiant unique de la source.

Paramètres d'en-tête
X-API-KeystringRequisDefault: VOTRE_API_KEY
Réponses
200
Source récupérée avec succès.
application/octet-stream
Réponsestring · binary
get
GET /v1/kb/{id}/resources/{resource_id}/sources/download/{source_id} HTTP/1.1
Host: api.saymydata.fr
X-API-Key: VOTRE_API_KEY
Accept: */*

binary
delete

Supprimez une source de données spécifique.

Autorisations
Paramètres de chemin
idstringRequis

Identifiant unique du Centre de Connaissance.

resource_idstringRequis

Identifiant unique de la ressource.

source_idstringRequis

Identifiant unique de la source.

Paramètres d'en-tête
X-API-KeystringRequisDefault: VOTRE_API_KEY
Réponses
200
Source supprimée avec succès.
application/json
delete
DELETE /v1/kb/{id}/resources/{resource_id}/sources/{source_id} HTTP/1.1
Host: api.saymydata.fr
X-API-Key: VOTRE_API_KEY
Accept: */*

{
  "message": "source supprimée avec succès.",
  "status": "success"
}
post

Posez une question à un Centre de Connaissance.

Autorisations
Paramètres de chemin
idstringRequis

Identifiant unique du Centre de Connaissance.

Paramètres d'en-tête
X-API-KeystringRequisDefault: VOTRE_API_KEY
Corps
questionstringRequis

Question à poser au Centre de Connaissance.

search_typestring · enumOptionnel

Type de recherche à effectuer Précise, Créative ou Hybride.

Valeurs possibles:
save_messagebooleanRequis

Indique si la question doit être sauvegardée.

promptstringOptionnel

Indication pour formuler la réponse générée.

streambooleanRequis

Type de réponse souhaitée.

cachebooleanOptionnel

Indique si la réponse doit être mise en cache.

with_contextbooleanOptionnel

Indique si le contexte doit être inclus dans la réponse.

Réponses
200
Question posée avec succès, réponse obtenue.
post
POST /v1/kb/{id}/ask HTTP/1.1
Host: api.saymydata.fr
X-API-Key: VOTRE_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "question": "text",
  "search_type": "sparse",
  "save_message": true,
  "prompt": "text",
  "stream": true,
  "cache": true,
  "with_context": true
}
{
  "message": "text",
  "status": 200
}
post

Posez une question à une ressource spécifique.

Autorisations
Paramètres de chemin
idstringRequis

Identifiant unique du Centre de Connaissance.

resource_idstringRequis

Identifiant unique de la ressource.

Paramètres d'en-tête
X-API-KeystringRequisDefault: VOTRE_API_KEY
Corps
questionstringRequis

Question à poser au Centre de Connaissance.

save_messagebooleanRequis

Indique si la question doit être sauvegardée.

search_typestring · enumRequis

Type de recherche à effectuer Précise, Créative ou Hybride.

Valeurs possibles:
streambooleanRequis

Type de réponse souhaitée.

promptstringOptionnel

Indication pour formuler la réponse générée.

cachebooleanOptionnel

Indique si la réponse doit être mise en cache.

with_contextbooleanOptionnel

Indique si le contexte doit être inclus dans la réponse.

Réponses
200
Question posée avec succès, réponse obtenue.
application/json
post
POST /v1/kb/{id}/resources/{resource_id}/ask HTTP/1.1
Host: api.saymydata.fr
X-API-Key: VOTRE_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "question": "text",
  "save_message": true,
  "search_type": "sparse",
  "stream": true,
  "prompt": "text",
  "cache": true,
  "with_context": true
}
{
  "message": "Ressource créée avec succès, un email de confirmation vous sera envoyé.",
  "status": "success"
}
PrécédentRecherche

Dernière mise à jour