Skip to main content

Adds Documents synchronization using AI Bridges

Project description

Beta License: AGPL-3 OCA/ai Translate me on Weblate Try me on Runboat

This module is intended for allowing users to use OCA’s Knowledge app for as a source of knowledge for AI Agents, although this is not the only usage this module could have

Table of contents

Configuration

Configuration Guide

To use this module as intended, two components must be configured:

  1. Bridge configuration on the Odoo side

  2. An endpoint capable of handling bridge requests

For an agent to have updated RAG (Retrieval-Augmented Generation) capabilities, you must create at least three bridges for each active knowledge database:

  • Bridge with ``Usage = “AI Thread Create”``
    Adds document pages to the external database used by agents.
  • Bridge with ``Usage = “AI Thread Write”``
    Updates document pages already on the external database used by agents.
  • Bridge with ``Usage = “AI Thread Unlink”``
    Removes document pages from the external database when those pages are deleted from Odoo.

For creating those bridges, apart from the usage of the bridge, the user must define:

  • Payload Type: it depends on the endpoint configuration, normally “Record” would work.

  • Result Type: for this case “No processing” is OK.

  • Model: select the “Document Page” model

  • Field: add at least the fields the endpoint is expecting on the other side.

  • Filter: add a domain for using the bridge only with the documents intended to trigger bridge

For context, you can download an example n8n workflow JSON file capable of handling the bridge with Usage = "AI Thread Create". This workflow includes a manual trigger for testing purposes. Remember to update the models and database knowledge as needed.

Usage

Depending on the bridges you have created, create, update or delete a Document Page mathing the bridge domain. You should see the execution on the AI Bridge Execution menu.

For testing the endpoint side, you can download this n8n workflow JSON, capable of inserting information on the database. Keep in mind that for this to work at least content, display_name and draft_name fields should be included on the list of fields

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Binhex

Contributors

Maintainers

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

This module is part of the OCA/ai project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file odoo_addon_ai_oca_bridge_document_page-16.0.1.0.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo_addon_ai_oca_bridge_document_page-16.0.1.0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d557237c791afa34c3216744455d28c04bacdcae16af7d346ee8e0a80f02ff39
MD5 4292a94ae8fb459e4f4a93c1a00e51f7
BLAKE2b-256 a4c6e8d69426eec31f0d9df8c40a6b19e6795f24e062acd6158905af79d4c027

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page