DocuWare Aura también se puede utilizar fuera de la interfaz de usuario de DocuWare Cloud. La API de Aura permite que las aplicaciones envíen preguntas a DocuWare Aura y utilicen las respuestas y los documentos de origen en sus propias aplicaciones, portales, procesos de automatización y asistentes de IA.
Hay dos maneras principales de utilizar la API.
Puede dejar que DocuWare Aura responda a la pregunta.
O puede utilizar Aura únicamente para recuperar los documentos relevantes y dejar que otra aplicación o un agente de IA realice el razonamiento. Esta segunda opción es útil cuando DocuWare es uno de los varios sistemas con los que tiene que trabajar un agente externo.
La API de Aura se utiliza a través de la URL de DocuWare Cloud de su organización. Las solicitudes a la API son específicas de la organización y requieren el UUID de la organización (org_id). Todos los endpoints utilizan un token JWT de tipo bearer para la autenticación. El token lo emite el DocuWare Identity Service (IDS); la API de Aura valida el token, pero no lo emite.
La definición completa de la API está disponible en su DocuWare Cloud. Sustituya «YourCloudDomain» por su dominio de Cloud real:
https://YourCloudDomain.docuware.cloud/DocuWare/aura/docs#/ Qué puede hacer con la API de Aura
La API es útil siempre que una aplicación necesite documentos de DocuWare como parte de otra experiencia de usuario o de otro proceso de negocio.
Ejemplos típicos:
Añadir preguntas sobre documentos a un ERP, un CRM, un portal de compras u otra aplicación de negocio.
Responder preguntas a partir de contratos, acuerdos u otros documentos sin enviar al usuario a la interfaz de DocuWare.
Dar a un agente externo acceso al conocimiento documental de DocuWare sujeto a los permisos, mientras el agente lo combina con información de otros sistemas.
Utilizar DocuWare como una fuente de conocimiento más, junto con sistemas como SharePoint, CRM, ERP o plataformas de servicio.
DocuWare sigue siendo el repositorio de documentos. La API aporta la capa de inteligencia que una aplicación externa puede utilizar sin que haga falta copiar los documentos a otro sistema. El acceso a los documentos sigue rigiéndose por los permisos del contexto autenticado.
Elegir la API adecuada
La decisión más importante es si quiere que DocuWare Aura genere la respuesta o que solo recupere los documentos relevantes.
Aura query API
Utilícela cuando quiera que DocuWare Aura entienda la pregunta, encuentre los documentos relevantes y genere la respuesta. La respuesta contiene además los documentos de origen utilizados para elaborarla.
Retrieval API
Utilícela cuando otra aplicación u otro modelo de IA deba realizar el razonamiento final. La Retrieval API encuentra los documentos relevantes y autorizados, y devuelve las fuentes.
Conectarse a la API
La documentación completa de la API, incluidos los endpoints exactos, los parámetros, los esquemas, los ejemplos de solicitud y los fragmentos de código, está disponible directamente en la documentación de Swagger de su DocuWare Cloud:
https://YourCloudDomain.docuware.cloud/DocuWare/aura/docs#/ Endpoints principales de la API
Hacer una pregunta a Aura
Utilice este endpoint para consultas conversacionales. Opcionalmente puede indicar archivadores o documentos y continuar conversaciones mediante un session_id.
POST /api/v3/{org_id}/query Consulta única sin historial de conversación
Devuelve una respuesta a la pregunta actual sin utilizar una sesión.
POST /api/v2/{org_id}/single-query Respuestas en streaming
Transmite la respuesta mediante Server-Sent Events (SSE), lo que resulta útil para interfaces de chat.
POST /api/v3/{org_id}/query/stream Solo recuperación de documentos
Recupera los documentos de DocuWare relevantes sin generar una respuesta de texto completo.
POST /api/v2/{org_id}/retrieval-query Para conocer los cuerpos de solicitud exactos, los parámetros disponibles, los formatos de respuesta y los fragmentos de código listos para usar, consulte directamente la documentación de Swagger en su DocuWare Cloud.
Otros endpoints de la API
La API de Aura contiene endpoints adicionales para la configuración, el estado del procesamiento de documentos, las conversaciones, los comentarios y operaciones relacionadas.
Por ejemplo, los endpoints de conversación pueden enumerar las conversaciones guardadas de un usuario, recuperar una conversación con todo su historial de mensajes, renombrar o fijar una conversación y eliminar una conversación. Estos endpoints son útiles para crear una experiencia de chat totalmente personalizada, pero la mayoría de las integraciones solo necesitan los endpoints de consulta o de recuperación descritos arriba.
La lista completa de endpoints, los esquemas de solicitud, los esquemas de respuesta y los ejemplos están disponibles en la documentación de Swagger.
Conectar un agente de IA a DocuWare
Puede utilizar DocuWare como herramienta para su agente de IA externo. El agente puede buscar documentos de DocuWare y utilizar los resultados junto con información de otros sistemas, como un ERP o un CRM.
Cómo empezar
Abra la documentación de Swagger en su DocuWare Cloud:
https://YourCloudDomain.docuware.cloud/DocuWare/aura/docs#/Dé a su agente la definición de la API
Si su agente o su plataforma de IA admite la importación de OpenAPI/Swagger, puede proporcionar directamente la especificación de Swagger. La plataforma puede crear entonces las herramientas de API disponibles a partir de ella.
Configure la autenticación
El agente necesita un JWT de DocuWare válido para llamar a la API.
Elija la API que necesita
Query API: haga a Aura preguntas sobre documentos.
Retrieval API: recupere los documentos relevantes para su propio modelo de IA o su propio agente.
Deje que el agente utilice DocuWare cuando sea necesario.
Por ejemplo, el agente puede obtener datos de factura de un ERP, buscar el contrato relacionado en DocuWare y comparar ambos antes de dar una respuesta
La documentación de Swagger contiene los endpoints exactos, los parámetros, los esquemas de solicitud/respuesta y los fragmentos de código necesarios para construir la integración.
En resumen: si su plataforma de agentes admite OpenAPI, proporciónele la definición de Swagger/OpenAPI de DocuWare, configure la autenticación JWT y exponga como herramientas los endpoints de DocuWare necesarios.