Documentaliste

Ce document décrit comment utiliser l’API DIMARC pour interagir avec l’endpoint /documentalist. Cet endpoint permet d’envoyer des requêtes à un agent documentaliste avec une question, des instructions spécifiques et un historique de conversation.

POST /v2/documentalist

Prérequis

• Un compte DIMARC actif.
• Être administrateur de votre organisation.
• Un agent de type “Documentaliste” configurer.
• Votre token d’authentification x-api-key (voir Récupération de votre Token d’Authentification)

Récupérer l’ID d’un agent

Chacun des agents à un id unique. Pour récupérer l’ID de l’agent Documentaliste, rendez-vous sur votre tableau de bord

1. Cliquez en haut à droite sur l’icône de votre profil puis accédez à la section Organisation > API ou en cliquant ici
2. Dans la section Références de vos agents, vous pouvez récupérer l’ID de l’agent Documentaliste que vous souhaitez utiliser.

Communiquez avec votre Documentaliste

Pour communiquer avec l’agent Documentaliste, envoyez une requête POST à l’endpoint /v2/documentalist/<agent_id> avec votre token d’authentification.

Paramètres de requête

Paramètre	Type	Description
query	string	La question ou requête à adresser à l’agent documentaliste
instructions	array	Liste d’instructions spécifiques pour guider la réponse de l’agent (optionnel)
historic	array	Historique des conversations précédentes (optionnel)

Exemple de requête

curl --location 'https://api.dimarc.ai/v2/documentalist/<agent_id>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <your_api_key>' \
--data '{
    "query": "Que fait Dimarc ?",
    "instructions": ["Ajoute des 🌈 dans tes réponses"],
    "historic": []
}'

Format de réponse

La réponse est retournée sous forme de stream HTTP. Cela permet de recevoir les informations de manière progressive à mesure qu’elles sont générées par l’agent. Chaque chunk du stream contient une partie de la réponse.

Astuce

Pour traiter correctement le stream, votre client doit être configuré pour lire les chunks de données au fur et à mesure qu’ils arrivent et les assembler pour reconstituer la réponse complète. Pour plus d’informations sur l’utilisation des streams en JavaScript, consultez la documentation MDN sur les Streams API.

Gestion de l’historique de conversation

Pour maintenir un contexte cohérent au fil des échanges, vous pouvez inclure l’historique des conversations précédentes dans le paramètre historic. Cela permet à l’agent de comprendre le contexte complet de l’échange.

Format de l’historique

L’historique doit être fourni sous forme d’un tableau d’objets alternant entre les messages de l’utilisateur et les réponses de l’agent :

"historic": [
  {
    "role": "user",
    "content": "Que fait Dimarc ?"
  },
  {
    "role": "assistant",
    "content": "🌈 Dimarc est une plateforme d'intelligence artificielle spécialisée dans la création d'agents IA personnalisés. 🌈"
  }
]

Limites et considérations

• Les temps de réponse peuvent varier selon la complexité de la requête et les sources d’informations que l’agent Documentaliste décidé d’utiliser.
• Les sources utilisées par l’agent Documentaliste ne sont pas retourner dans la réponse pour le moment.

Support et assistance

Pour toute question concernant l’API Documentalist, contactez notre équipe de support à l’adresse support@dimarc.fr