Ressources

Une Ressource est composée d'un ou plusieurs champs. Un champ est une valeur stockée au sein d'une Ressource, et cette valeur peut être un fichier, un texte, une page web ou une conversation.

Par exemple, si vous souhaitez centraliser des informations relatives à un patient, chaque Ressource pourrait inclure :

• Un fichier PDF de l'ordonnance,

• Un compte rendu médical sous forme de texte,

• Une conversation avec les recommandations du médecin ou les retours du patient.

Exemple API - Création d’une Ressource :

curl --location --request POST 'https://api.saymydata.com/v1/kb/<your-knowledge-box-id>/resources' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "title": "Document Exemple",
    "security": "private",
    "files": [
        {
            "filename": "my_test_file.txt",
            "content_type": "text/plain",
            "payload": "contenu du fichier"
        }
    ],
    "links": [
        {
            "url": "https://example.com",
            "description": "Exemple de lien"
        }
    ],
    "texts": [
        {
            "content": "Ceci est un exemple de texte"
        }
    ]
}'

Explication des champs :

1. title :

   • Description : Le titre de la ressource que vous souhaitez créer. Il peut être utilisé pour identifier facilement cette ressource dans votre Knowledge Box.

   • Exemple : "title": "Document Exemple"

2. security :

   • Description : Le niveau de sécurité de la ressource. Par exemple, cela peut indiquer si la ressource est privée ou publique. Ce champ permet de gérer les permissions d'accès.

   • Exemple : "security": "private"

3. files :

   • Description : Un tableau contenant les fichiers associés à la ressource. Chaque fichier doit inclure son nom (filename), son type de contenu (content_type), et son contenu en base64 (payload).

   • Exemple :

     "files": [
       {
         "filename": "my_test_file.txt",
         "content_type": "text/plain",
         "payload": "contenu du fichier"
       }
     ]

4. links :

   • Description : Un tableau de liens associés à la ressource. Chaque lien doit inclure l'URL (url) et une description (description) qui aide à identifier l'importance ou le contenu du lien.

   • Exemple :

     "links": [
       {
         "url": "https://example.com",
         "description": "Exemple de lien"
       }
     ]

5. texts :

   • Description : Un tableau de textes associés à la ressource. Chaque texte représente un contenu textuel spécifique lié à cette ressource. Cela peut inclure des descriptions, des notes ou tout autre type de texte.

   • Exemple :

     "texts": [
       {
         "content": "Ceci est un exemple de texte"
       }
     ]

Dans une requête de création de ressource via l'API, au moins un des trois champs suivants doit être présent :

• files : Pour attacher des fichiers à la ressource.

• links : Pour associer des liens externes à la ressource.

• texts : Pour inclure des textes explicatifs ou descriptifs.