Metadata-Version: 2.1
Name: odoo-addon-ai_oca_bridge_extra_parameters
Version: 18.0.1.0.0.2
Requires-Python: >=3.10
Requires-Dist: odoo-addon-ai_oca_bridge==18.0.*
Requires-Dist: odoo==18.0.*
Summary: Adds extra parameters to the AI OCA Bridge payload.
Home-page: https://github.com/OCA/ai
License: AGPL-3
Author: Binhex,Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Development Status :: 4 - Beta
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

==============================
AI OCA Bridge Extra Parameters
==============================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:4455910d9cc5df1aadec26978ccb47f793a33062e39b78341205f252a0051fd0
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fai-lightgray.png?logo=github
    :target: https://github.com/OCA/ai/tree/18.0/ai_oca_bridge_extra_parameters
    :alt: OCA/ai
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/ai-18-0/ai-18-0-ai_oca_bridge_extra_parameters
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/ai&target_branch=18.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module is used for adding extra parameters to the AI OCA Bridge's
payloads

**Table of contents**

.. contents::
   :local:

Configuration
=============

This module allows adding extra parameters to be sent in the bridge's
payloads, using Python expressions. These parameters, unlike fields, can
be used independently from the model.

Extra Parameters
================

| Create extra parameters by navigating to: **AI Bridge → AI Bridge
  Extra Parameters**.
| Extra parameters define what additional information will be available
  in the payload.

Fields Description
------------------

**Parameter Type:**

- | **Record**:
  | Evaluated in the context of the record being processed.

- | **Bridge Self**:
  | Evaluated in the context of the AI Bridge itself (useful for using
    ``self.env[...]``).

| **Name:**
| Name for this extra parameter.

| **Value:**
| The actual information the agent will use.

- | Use curly braces ``{}`` for dynamic values.
  | Example: ``{object.name}`` for ``object.name``,
  | ``{object.env["product.product"].search([]).mapped("name")}`` for
    passing all product names.

- Without braces: the agent receives literal text.

Usage
=====

When configuring AI OCA Bridge's record payload, add some of your
previously created extra parameters.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/ai/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 <https://github.com/OCA/ai/issues/new?body=module:%20ai_oca_bridge_extra_parameters%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

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

Credits
=======

Authors
-------

* Binhex

Contributors
------------

- `Binhex <https://binhex.cloud>`__

  - Ariel Barreiros

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

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.

.. |maintainer-arielbarreiros96| image:: https://github.com/arielbarreiros96.png?size=40px
    :target: https://github.com/arielbarreiros96
    :alt: arielbarreiros96

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-arielbarreiros96| 

This module is part of the `OCA/ai <https://github.com/OCA/ai/tree/18.0/ai_oca_bridge_extra_parameters>`_ project on GitHub.

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