DocuWare Aura peut également être utilisé en dehors de l'interface utilisateur de DocuWare Cloud. L'API Aura permet à des applications d'envoyer des questions à DocuWare Aura et d'utiliser les réponses et les documents sources dans leurs propres applications, portails, processus d'automatisation et assistants IA.
Il existe deux façons principales d'utiliser l'API.
Vous pouvez laisser DocuWare Aura répondre à la question.
Ou vous pouvez utiliser Aura uniquement pour récupérer les documents pertinents et laisser une autre application ou un agent IA effectuer le raisonnement. Cette seconde option est utile lorsque DocuWare est l'un des différents systèmes avec lesquels un agent externe doit travailler.
Vous utilisez l'API Aura via l'URL DocuWare Cloud de votre organisation. Les requêtes d'API sont spécifiques à l'organisation et nécessitent l'UUID de l'organisation (org_id). Tous les points de terminaison utilisent un jeton JWT de type bearer pour l'authentification. Le jeton est émis par le DocuWare Identity Service (IDS) ; l'API Aura valide le jeton mais ne l'émet pas.
La définition complète de l'API est disponible dans votre DocuWare Cloud. Remplacez « YourCloudDomain » par votre domaine Cloud réel :
https://YourCloudDomain.docuware.cloud/DocuWare/aura/docs#/ Ce que vous pouvez faire avec l'API Aura
L'API est utile chaque fois qu'une application a besoin de documents DocuWare dans le cadre d'une autre expérience utilisateur ou d'un autre processus métier.
Voici des exemples typiques :
Ajouter des questions sur les documents à un ERP, un CRM, un portail d'achats ou une autre application métier.
Répondre à des questions à partir de contrats, d'accords ou d'autres documents sans renvoyer l'utilisateur vers l'interface DocuWare.
Donner à un agent externe l'accès à des connaissances documentaires DocuWare encadrées par les autorisations, pendant que l'agent les combine avec des informations provenant d'autres systèmes.
Utiliser DocuWare comme l'une des sources de connaissances, aux côtés de systèmes tels que SharePoint, un CRM, un ERP ou des plateformes de services.
DocuWare reste le référentiel de documents. L'API fournit la couche d'intelligence qu'une application externe peut utiliser sans que les documents aient à être copiés dans un autre système. L'accès aux documents continue de suivre les autorisations du contexte authentifié.
Choisir la bonne API
La décision la plus importante est de savoir si vous voulez que DocuWare Aura génère la réponse ou qu'il récupère seulement les documents pertinents.
Aura query API
Utilisez-la lorsque vous voulez que DocuWare Aura comprenne la question, trouve les documents pertinents et génère la réponse. La réponse contient également les documents sources utilisés pour la produire.
Retrieval API
Utilisez-la lorsqu'une autre application ou un autre modèle d'IA doit effectuer le raisonnement final. La Retrieval API trouve les documents pertinents et autorisés, et renvoie les sources.
Se connecter à l'API
La documentation complète de l'API, y compris les points de terminaison exacts, les paramètres, les schémas, les exemples de requête et les extraits de code, est disponible directement dans la documentation Swagger de votre DocuWare Cloud :
https://YourCloudDomain.docuware.cloud/DocuWare/aura/docs#/ Principaux points de terminaison de l'API
Poser une question à Aura
Utilisez ce point de terminaison pour les requêtes conversationnelles. Vous pouvez éventuellement indiquer des armoires ou des documents, et poursuivre des conversations à l'aide d'un session_id.
POST /api/v3/{org_id}/query Requête unique sans historique de conversation
Renvoie une réponse à la question en cours sans utiliser de session.
POST /api/v2/{org_id}/single-query Réponses en streaming
Diffuse la réponse au moyen de Server-Sent Events (SSE), ce qui est utile pour les interfaces de chat.
POST /api/v3/{org_id}/query/stream Récupération de documents uniquement
Récupère les documents DocuWare pertinents sans générer de réponse en texte intégral.
POST /api/v2/{org_id}/retrieval-query Pour connaître les corps de requête exacts, les paramètres disponibles, les formats de réponse et les extraits de code prêts à l'emploi, reportez-vous directement à la documentation Swagger de votre DocuWare Cloud.
Autres points de terminaison de l'API
L'API Aura contient des points de terminaison supplémentaires pour la configuration, l'état du traitement des documents, les conversations, les retours et les opérations associées.
Par exemple, les points de terminaison de conversation peuvent répertorier les conversations enregistrées d'un utilisateur, récupérer une conversation avec l'intégralité de son historique de messages, renommer ou épingler une conversation et supprimer une conversation. Ces points de terminaison sont utiles pour construire une expérience de chat entièrement personnalisée, mais la plupart des intégrations n'ont besoin que des points de terminaison de requête ou de récupération décrits ci-dessus.
La liste complète des points de terminaison, les schémas de requête, les schémas de réponse et les exemples sont disponibles dans la documentation Swagger.
Connecter un agent IA à DocuWare
Vous pouvez utiliser DocuWare comme outil pour votre agent IA externe. L'agent peut rechercher des documents DocuWare et utiliser les résultats avec des informations provenant d'autres systèmes tels qu'un ERP ou un CRM.
Pour commencer
Ouvrez la documentation Swagger dans votre DocuWare Cloud :
https://YourCloudDomain.docuware.cloud/DocuWare/aura/docs#/Donnez à votre agent la définition de l'API
Si votre agent ou votre plateforme d'IA prend en charge l'import OpenAPI/Swagger, vous pouvez fournir directement la spécification Swagger. La plateforme peut alors en créer les outils d'API disponibles.
Configurez l'authentification
L'agent a besoin d'un JWT DocuWare valide pour appeler l'API.
Choisissez l'API dont vous avez besoin
Query API : poser à Aura des questions sur les documents.
Retrieval API : récupérer les documents pertinents pour votre propre modèle d'IA ou votre propre agent.
Laissez l'agent utiliser DocuWare lorsque c'est nécessaire.
Par exemple, l'agent peut récupérer des données de facture dans un ERP, rechercher le contrat associé dans DocuWare, puis comparer les deux avant de donner une réponse
La documentation Swagger contient les points de terminaison exacts, les paramètres, les schémas de requête/réponse et les extraits de code nécessaires à la construction de l'intégration.
En résumé : si votre plateforme d'agent prend en charge OpenAPI, fournissez-lui la définition Swagger/OpenAPI de DocuWare, configurez l'authentification JWT et exposez comme outils les points de terminaison DocuWare requis.