pyxecm 2.0.4__py3-none-any.whl → 3.0.1__py3-none-any.whl

pyxecm/otds.py

@@ -2220,7 +2220,7 @@ class OTDS:
             name (str):
                 The name of the OTDS resource to update.
             resource (object):
-                updated resource object of get_resource called before
+                The updated resource object of get_resource called before
             show_error (bool, optional):
                 If True, log an error if resource is not found. Else just log a warning.
 

pyxecm/otmm.py

@@ -19,7 +19,7 @@ import threading
 import traceback
 import urllib.parse
 from collections.abc import Callable
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 from importlib.metadata import version
 from json import JSONDecodeError
 
@@ -884,11 +884,11 @@ class OTMM:
             try:
                 if os.path.exists(file_name):
                     if asset_modification_date:
-                        file_mod_time = datetime.fromtimestamp(os.path.getmtime(file_name), tz=timezone.utc)
+                        file_mod_time = datetime.fromtimestamp(os.path.getmtime(file_name), tz=UTC)
                         date_last_updated = datetime.strptime(
                             asset_modification_date,
                             "%Y-%m-%dT%H:%M:%SZ",
-                        ).replace(tzinfo=timezone.utc)
+                        ).replace(tzinfo=UTC)
                         download_up_to_date: bool = file_mod_time >= date_last_updated
                     else:
                         download_up_to_date = True
@@ -927,8 +927,7 @@ class OTMM:
                     response = self._session.get(request_url, stream=True)
                     response.raise_for_status()
                     with open(file_name, "wb") as f:
-                        for chunk in response.iter_content(chunk_size=8192):
-                            f.write(chunk)
+                        f.writelines(response.iter_content(chunk_size=8192))
                     success = True
             # end try:
 

pyxecm-3.0.1.dist-info/METADATA

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: pyxecm
+Version: 3.0.1
+Summary: A Python library to interact with Opentext Content Management Rest API
+Project-URL: Homepage, https://github.com/opentext/pyxecm
+Author-email: Kai Gatzweiler <kgatzweiler@opentext.com>, "Dr. Marc Diefenbruch" <mdiefenb@opentext.com>
+Keywords: appworks,archivecenter,contentserver,extendedecm,opentext,otds
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System
+Requires-Python: >=3.10
+Requires-Dist: lxml>=6.0.0
+Requires-Dist: opentelemetry-api>=1.34.1
+Requires-Dist: opentelemetry-exporter-otlp>=1.34.1
+Requires-Dist: opentelemetry-instrumentation-requests>=0.55b1
+Requires-Dist: opentelemetry-instrumentation-threading>=0.55b1
+Requires-Dist: opentelemetry-sdk>=1.34.1
+Requires-Dist: pandas>=2.3.1
+Requires-Dist: requests-toolbelt>=1.0.0
+Requires-Dist: requests>=2.32.4
+Requires-Dist: suds>=1.2.0
+Requires-Dist: websockets>=15.0.1
+Requires-Dist: xmltodict>=0.14.2
+Provides-Extra: api
+Requires-Dist: asyncio>=3.4.3; extra == 'api'
+Requires-Dist: fastapi>=0.116.0; extra == 'api'
+Requires-Dist: jinja2>=3.1.6; extra == 'api'
+Requires-Dist: opentelemetry-api>=1.34.1; extra == 'api'
+Requires-Dist: opentelemetry-instrumentation-fastapi>=0.55b1; extra == 'api'
+Requires-Dist: opentelemetry-sdk>=1.34.1; extra == 'api'
+Requires-Dist: prometheus-fastapi-instrumentator>=7.1.0; extra == 'api'
+Requires-Dist: pydantic-settings>=2.10.1; extra == 'api'
+Requires-Dist: python-multipart>=0.0.20; extra == 'api'
+Requires-Dist: uvicorn>=0.35.0; extra == 'api'
+Provides-Extra: customizer
+Requires-Dist: kubernetes>=33.1.0; extra == 'customizer'
+Requires-Dist: playwright>=1.53.0; extra == 'customizer'
+Requires-Dist: pydantic>=2.11.7; extra == 'customizer'
+Requires-Dist: python-hcl2>=7.2.1; extra == 'customizer'
+Provides-Extra: magic
+Requires-Dist: python-magic; extra == 'magic'
+Provides-Extra: pyvis
+Requires-Dist: pyvis>=0.3.2; extra == 'pyvis'
+Provides-Extra: sap
+Requires-Dist: pyrfc==3.3.1; extra == 'sap'
+Description-Content-Type: text/markdown
+
+# PYXECM
+
+A python library to interact with Opentext Content Mangement REST API.
+The product API documentation is available on [OpenText Developer](https://developer.opentext.com/ce/products/extendedecm)
+Detailed documentation of this package is available [here](https://opentext.github.io/pyxecm/).
+
+## Quick start - Library usage
+
+Install the latest version from pypi:
+
+```bash
+pip install pyxecm
+```
+
+### Start using the package libraries
+
+example usage of the OTCS class, more details can be found in the docs:
+
+```python
+from pyxecm import OTCS
+
+otcs_object = OTCS(
+    protocol="https",
+    hostname="otcs.domain.tld",
+    port="443",
+    public_url="otcs.domain.tld",
+    username="admin",
+    password="********",
+    base_path="/cs/llisapi.dll",
+)
+
+otcs_object.authenticate()
+
+nodes = otcs_object.get_subnodes(2000)
+
+for node in nodes["results"]:
+    print(node["data"]["properties"]["id"], node["data"]["properties"]["name"])
+```
+
+## Quick start - Customizer usage
+
+- Create an `.env` file as described here: [sample-environment-variables](customizerapisettings/#sample-environment-variables)
+- Create an payload file to define what the customizer should do, as described here [payload-syntax](payload-syntax)
+
+```bash
+pip install pyxecm[customizer]
+
+pyxecm-customizer PAYLOAD.tfvars/PAYLOAD.yaml
+```
+
+## Quick start - API 
+
+- Install pyxecm with api and customizer dependencies
+- Launch the Rest API server
+- Access the Customizer API at [http://localhost:8000/api](http://localhost:8000/api)
+
+```bash
+pip install pyxecm[api,customizer]
+
+pyxecm-api
+```
+
+## Disclaimer
+
+
+Copyright © 2025 Open Text Corporation, All Rights Reserved.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyxecm-3.0.1.dist-info/RECORD

@@ -0,0 +1,96 @@
+pyxecm/__init__.py,sha256=KNvTFbDVHylf8Ub28osm5Dw0W-ck-94y27lIBuE32RE,441
+pyxecm/avts.py,sha256=J-W7JYrYv7JSI9whZ5iCHtim6vNrTZCXa1oizUWIc0Y,56952
+pyxecm/coreshare.py,sha256=nV3JmWbxnjZP2SyJzVwJnrC_hdn4lwAYPZ-XMtuumjM,95885
+pyxecm/otac.py,sha256=gXoZc-mkI1XoR_mPmDy3up58C1mTYf76rOaSsC4xOHg,22847
+pyxecm/otawp.py,sha256=JA4LGvbqRvXxc7-7pE1YSLO5JxI3rr9rJdMmuUItrNM,112890
+pyxecm/otca.py,sha256=Jtc4rlgI2g1cfqOiclM5qQdwBN-UAq31VP-2SYGZ4MU,71410
+pyxecm/otcs.py,sha256=qby8ctrgYyTKscoi-S6bJp_n8oNdu8Vi33tdJx7QX44,761951
+pyxecm/otds.py,sha256=oDXG3m_YJrJnMKVuL8i57i1eC5iH2Tzkm-xcNo2N-NY,184222
+pyxecm/otiv.py,sha256=I5lt4sz7TN3W7BCstCKQY2WQnei-t0tXdM4QjRQRmWI,2358
+pyxecm/otkd.py,sha256=JMpUa99vtTK7PfCnMJjt6lUyK6C6Aq1i1zjMROI9cvQ,47480
+pyxecm/otmm.py,sha256=OIzhbk6cTtiQMK9z_CQW8orOZNA690WASqyD2OGn1hw,80731
+pyxecm/otpd.py,sha256=6rfCoO5Jm6pETCyp6aKYNTyvI1z44wP76zS-qRotyVk,14831
+pyxecm/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyxecm/helper/__init__.py,sha256=B35HdIZC9wZ1m_sx4NOPggyFFJoXmFuA1T2tuPDU1W8,246
+pyxecm/helper/assoc.py,sha256=yOh4GFZEkTfIaVVrHBr4bhMtIv-E76oDVWGqaUdVqyA,7321
+pyxecm/helper/data.py,sha256=nC0m7-3hpsVKGamKqz1J62jnhDy1GpphIciduMkyMMI,123315
+pyxecm/helper/logadapter.py,sha256=ExrIKpA2JKegkTIky0wDDTgPYSvVmwQLrDh5jko_6hQ,724
+pyxecm/helper/otel_config.py,sha256=nMzNi3Jv2_kmYG4thzDpN95bqjy6MbRfV6nlpIZ6SjQ,907
+pyxecm/helper/web.py,sha256=6kPfs6ZFNAOCly3B4qq_lWJMmiNfTrtQrkjl86WLatc,13345
+pyxecm/helper/xml.py,sha256=QhavLKGl_lwSasq1LF05ftj0OIVr04lyNE3bTqtemiA,45641
+pyxecm_api/__init__.py,sha256=8oXxEEFSu2afpyQURpxMA2qTZAB3MUdbBrndogDn5Oc,92
+pyxecm_api/__main__.py,sha256=Q2tcaoSExPMUwGVBrE4AHT8DNvB4XIgwoN4EPDx5Rt8,117
+pyxecm_api/app.py,sha256=xqNLjnCxi2WwZge3klqMgM6-Mf4ZBrdfn1R26icWx04,7074
+pyxecm_api/settings.py,sha256=7hHVxFdK8P8Xy3VF5f-RbbBvTNrJKLTJQZNrGbjNiHQ,5814
+pyxecm_api/agents/__init__.py,sha256=oLpLHN1f7ixqBXdSXaD-4-byeRJaHwpsZ06wIIVgImM,344
+pyxecm_api/agents/app.py,sha256=a_IrajL7oIykFInRNSl5CaUTROcLNiaY3Z71VELJTGY,387
+pyxecm_api/agents/functions.py,sha256=CtNrkrpBKgldcq8HEjNp-8NA_07OvIso3zsunwDzJPo,3665
+pyxecm_api/agents/models.py,sha256=IjLHOt63c9DwtzhaTtQqF-09KXPim-3TmsjfhTh8x3M,218
+pyxecm_api/agents/otcm_knowledgegraph/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
+pyxecm_api/agents/otcm_knowledgegraph/functions.py,sha256=Mk4u_z54j0lpEgPxAyCanNm0cwQy8Ay8sh1Bp7i_7jQ,3301
+pyxecm_api/agents/otcm_knowledgegraph/models.py,sha256=EL2rXOU3CVXLoQVkhK0iMIY9vxRJj017BAwsf6e4fNo,2858
+pyxecm_api/agents/otcm_knowledgegraph/router.py,sha256=4-Th2G3E1a_jC5hNvIaiPmBA8uYXsaOAfyL1K3AJfvs,3005
+pyxecm_api/agents/otcm_user_agent/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
+pyxecm_api/agents/otcm_user_agent/models.py,sha256=uFIU_6cZhWlruRKThsQEgDQGVRRBr7xYAAVfMoNMiyw,844
+pyxecm_api/agents/otcm_user_agent/router.py,sha256=6gEWXtiKM4d4hnVaTmbNXaTplcJOnjDRFz-CDN4enec,2454
+pyxecm_api/agents/otcm_workspace_agent/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
+pyxecm_api/agents/otcm_workspace_agent/models.py,sha256=Sd70syKPGn0Z-q0AQN9NpqaUgO4h6yQ22sUim9Glgl4,1594
+pyxecm_api/agents/otcm_workspace_agent/router.py,sha256=xLkf4D_k_vsbtdQcrcd6AQpMjERrYS2Pavoy8scJaYo,7457
+pyxecm_api/auth/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
+pyxecm_api/auth/functions.py,sha256=O15QieJo_lJnviTUcnNs1vNcJGSh2DQdGcUjt-S_Vj8,3336
+pyxecm_api/auth/models.py,sha256=lKebaIHbALZ10quCCKQ3wf7w8V6k84tFXcPV1zbQsS0,271
+pyxecm_api/auth/router.py,sha256=cLWMupxPtuc4wtWJ80jAsbNBte31m5CeZgClN_TMuPs,2165
+pyxecm_api/common/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
+pyxecm_api/common/functions.py,sha256=fvgJsyqYi6QDHRL1TF6pJHNfrOG-HuqvxoGSC8N-xMk,3485
+pyxecm_api/common/metrics.py,sha256=kOJ1DZveZJ7xFd1pB12Zbkq6Z-evaTivpgO_ujVbsxM,2707
+pyxecm_api/common/models.py,sha256=c76ysWUt40A875DirsFMXttxwjHvBYvjuOVEXePSZ9k,456
+pyxecm_api/common/router.py,sha256=BXi3SMvkswCIftoVkJIP_Wx8gd3WKJsE3rq6Pult50I,3482
+pyxecm_api/terminal/__init__.py,sha256=RHlTzdGeOY0_dvvNZS_wq6uJcY1OatIUHwCxAUwklaE,43
+pyxecm_api/terminal/router.py,sha256=aler89EUj-d9RDukn-cTKmiogS4Xn0u_mlJBXlGfIUQ,3581
+pyxecm_api/v1_csai/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
+pyxecm_api/v1_csai/models.py,sha256=c0VEJP09jsTW83dpHtZnooNvg3SZNuyMHEBCgWQDJ1s,489
+pyxecm_api/v1_csai/router.py,sha256=nN16b5cCDab9tgijFcCehHpHp1aHLZXSLslATrc6vhE,4586
+pyxecm_api/v1_csai/statics/bindings/utils.js,sha256=MRPHMxfDDJnqr7x4KRYWDOfSMYOhSGFdoElmQ-lWDLA,6311
+pyxecm_api/v1_csai/statics/tom-select/tom-select.complete.min.js,sha256=f2dQEyWhXp7M5o3MsmgS6zJ_Gq4pXFxSxSTsYrPxPc0,44776
+pyxecm_api/v1_csai/statics/tom-select/tom-select.css,sha256=JgqUGftl29aF9fEJ-ObePYuXmhVAUK-Tp2GiLTTt54Q,9328
+pyxecm_api/v1_csai/statics/vis-9.1.2/vis-network.css,sha256=LoLURa1YeOqIFlJHDOYyYB-PVfG5nm6-zf-GFGAObQ4,220163
+pyxecm_api/v1_csai/statics/vis-9.1.2/vis-network.min.js,sha256=HyDwc28yy5vt-PY4OyXP6i-Dnhq-gNboBAtNW-o3jGk,468813
+pyxecm_api/v1_maintenance/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
+pyxecm_api/v1_maintenance/functions.py,sha256=NDU08aHzPi7KXxKMA4KPHwc-LkpiqqwZU7Wif8yjaJk,3001
+pyxecm_api/v1_maintenance/models.py,sha256=HcrhBg9hhRZg4Y6xuus9T8SCNIsL8ZxX1uuaRrBnFBw,271
+pyxecm_api/v1_maintenance/router.py,sha256=gL_f_-9Slq7yzzOO1uS1aB8N3GduKnm1__7b6cSH7VI,2238
+pyxecm_api/v1_otcs/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
+pyxecm_api/v1_otcs/functions.py,sha256=YKC4b6nVtlnBGcu2WqSRLmS3faXagkAokrBMXUblkJE,2012
+pyxecm_api/v1_otcs/router.py,sha256=VCtGmObA2TVJREwx4mA047SzSpsJlfxhRXA6DdlppZw,7055
+pyxecm_api/v1_payload/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
+pyxecm_api/v1_payload/functions.py,sha256=xA06ACS4NWUut0FXfrw6Ww-R94y43PVSESyEiZEhKAA,6295
+pyxecm_api/v1_payload/models.py,sha256=eD9A2K23L_cGhBDTO1FGVGJMQ1COaYWmcr-ELE66tOA,1006
+pyxecm_api/v1_payload/router.py,sha256=2twiLBeNNDGIEQ6SCZwLFgd8oYOzgbskS-Q3OL-lKe4,15441
+pyxecm_customizer/__init__.py,sha256=x2NhDlNcubRC-jXzqT02j9kQGXBo36QAehjmcQuSbXw,721
+pyxecm_customizer/__main__.py,sha256=QGQlJJAdLmJccArwPT8XEhBOMSJ-Z8gwLrtHPNfL8Ps,1407
+pyxecm_customizer/browser_automation.py,sha256=2mlj3MxbRFKHgckCml7MZkHWjFno6cej-6YE88_bVV0,67309
+pyxecm_customizer/customizer.py,sha256=9sR2xzJMDx_We3jejt3qMDbUJQTx93LsuTuC3FbTdTE,84059
+pyxecm_customizer/exceptions.py,sha256=YXX0in-UGXfJb6Fei01JQetOtAHqUiITb49OTSaZRkE,909
+pyxecm_customizer/guidewire.py,sha256=YMWb7GQINhHDOfRI33O_aHQ7KVkFwJnnyfgf-oR7RH4,51599
+pyxecm_customizer/k8s.py,sha256=w35Y1h9xuSFwZ3yuL9mBWWnXxI9GEDneBYl8bkaZ70o,56164
+pyxecm_customizer/knowledge_graph.py,sha256=Hsg-z4vusOae4ei8OiZIkeoneD0EvgfL_uKN50eLFSM,30169
+pyxecm_customizer/log.py,sha256=2DmGF3b-ZIOAJCPSmZmxGD7BNxY4-mZm0H_X0HeJedE,916
+pyxecm_customizer/m365.py,sha256=NKtWRFDwVHEQ1nU_LxxKvn2kvZQO7OuXr3A09xQWlBQ,213778
+pyxecm_customizer/payload.py,sha256=x2GjS8ukgHeXE8Qvuc_1f9cWya0AYeQ6zqqrS3Pm28w,1339959
+pyxecm_customizer/payload_list.py,sha256=jCBqDX0g0cH6lPwgJ22M8TwzOq_D9fGani3RgfZrUvs,28153
+pyxecm_customizer/salesforce.py,sha256=rAcjqGJxy-NTWqvm9pV-tYWJD4CEV0Y4g9lI0VZTaS4,63518
+pyxecm_customizer/sap.py,sha256=lD_riOZhYjbZ0_pUZyqhxP6guzBM__TcUjZhSgDowoE,6506
+pyxecm_customizer/servicenow.py,sha256=krgv_LJKX56_WF1Wx62EUeUWwBaVjdcHFxcnyBbDoCI,65333
+pyxecm_customizer/settings.py,sha256=RG3Jhn5pLN1ooESolGX70371Bgw8VB9NHJaADfjtqpk,21219
+pyxecm_customizer/successfactors.py,sha256=DINciC07L2xx6SDQnZYN5SxNzCx7P0F-Yv3GYOFH2o4,38657
+pyxecm_customizer/translate.py,sha256=8ZoCFMN7_cpT6_JVaNL33xTLWREFt36YWj9mYAS8YyQ,4958
+pyxecm_maintenance_page/__init__.py,sha256=09to4a8rygOIN6Z1SCN9tLtW1qPUC78Z-scDbpt0E-Q,136
+pyxecm_maintenance_page/__main__.py,sha256=N_0tw2upUPQZhTYCaIr75LogyaEsp-mlZCon-lIyaxM,158
+pyxecm_maintenance_page/app.py,sha256=pTOeZfgPPq6BT7P8naUjW-ZT9dXqwX6DWazIVL-9Fkc,1997
+pyxecm_maintenance_page/settings.py,sha256=VRReZeNdza7i7lgnQ3wVojzoPDGXZnzr5rsMJY1EnHk,955
+pyxecm_maintenance_page/static/favicon.avif,sha256=POuuPXKbjHVP3BjNLpFIx8MfkQg5z2LZA7sK6lejARg,1543
+pyxecm_maintenance_page/templates/maintenance.html,sha256=0OAinv7jmj3Aa7GNCIoBLDGEMW1-_HdJfwWmkmb6Cs4,5581
+pyxecm-3.0.1.dist-info/METADATA,sha256=DpJqpnLy9py7ju-mO8HRQ4Rddm5EuHWADJ50cU71bRQ,4512
+pyxecm-3.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pyxecm-3.0.1.dist-info/entry_points.txt,sha256=prc1mDdpd3bQk98VRBozI363mDUgSwDibDKXGNqKqgI,151
+pyxecm-3.0.1.dist-info/RECORD,,

{pyxecm-2.0.4.dist-info → pyxecm-3.0.1.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-

pyxecm-3.0.1.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+pyxecm-api = pyxecm_api:run_api
+pyxecm-customizer = pyxecm_customizer:main
+pyxecm-maintenance-page = pyxecm_maintenance_page:run_api

{pyxecm/customizer/api → pyxecm_api}/__main__.py

@@ -1,6 +1,6 @@
 """Wrapper to start the Customizer API."""
 
-from pyxecm.customizer.api import run_api
+from pyxecm_api import run_api
 
 if __name__ == "__main__":
     run_api()

pyxecm_api/agents/__init__.py

@@ -0,0 +1,7 @@
+"""init Module."""
+
+from .otcm_knowledgegraph.router import router as otcm_knowledgegraph_router
+from .otcm_user_agent.router import router as otcm_user_agent_router
+from .otcm_workspace_agent.router import router as otcm_workspace_agent_router
+
+__all__ = ["otcm_knowledgegraph_router", "otcm_user_agent_router", "otcm_workspace_agent_router"]

pyxecm_api/agents/app.py

@@ -0,0 +1,13 @@
+"""List of all routers for the csai agents."""
+
+import logging
+
+from fastapi import APIRouter
+
+from . import otcm_knowledgegraph_router, otcm_user_agent_router, otcm_workspace_agent_router
+
+logger = logging.getLogger("pyxecm_api.agents")
+
+router = APIRouter(tags=["csai agents"])
+
+agent_routers = [router, otcm_workspace_agent_router, otcm_user_agent_router, otcm_knowledgegraph_router]

pyxecm_api/agents/functions.py

@@ -0,0 +1,119 @@
+"""List of all routers for the csai agents."""
+
+import logging
+from importlib.metadata import version
+from threading import Thread
+
+from fastapi.openapi.utils import get_openapi
+from fastapi.routing import APIRoute
+from pyxecm import OTCA, OTCS
+from pyxecm_customizer.settings import Settings
+
+from pyxecm_api.common.functions import get_k8s_object, get_otcs_object
+
+logger = logging.getLogger("pyxecm_api.agents")
+
+SETTINGS = Settings()
+
+
+def get_otca_object(otcs_object: OTCS | None = None) -> OTCA:
+    """Get the OTCA object."""
+
+    k8s_object = get_k8s_object()
+    content_system = {}
+    for service in ["chat", "embed"]:
+        cm = k8s_object.get_config_map(f"csai-{service}-svc")
+        if cm:
+            content_system[service] = cm.data.get("CONTENT_SYSTEM", "none")
+
+    otca = OTCA(
+        chat_url=str(SETTINGS.aviator.chat_svc_url),
+        embed_url=str(SETTINGS.aviator.embed_svc_url),
+        studio_url=str(SETTINGS.aviator.studio_url),
+        otds_url=str(SETTINGS.otds.url_internal),
+        client_id=SETTINGS.aviator.oauth_client,
+        client_secret=SETTINGS.aviator.oauth_secret,
+        otcs_object=otcs_object,
+        content_system=content_system,
+        logger=logger.getChild("otca"),
+    )
+
+    return otca
+
+
+# end function
+
+
+def register_tool_body(route: APIRoute, agents: list[str] | None = None) -> dict:
+    """Generate the request body for the CSAI Studio integration.
+
+    Args:
+        route (APIRoute):
+            The API routes.
+        agents (list[str] | None, optional):
+            A list of agents this tool is associated with.
+            Defaults to ["retrieverAgent"].
+
+    Returns:
+        dict:
+            The body for the REST API call to register a tool in Content Aviator.
+
+    """
+
+    if agents is None:
+        agents = ["retrieverAgent"]
+
+    return {
+        "name": route.name,
+        "description": route.description,
+        "APISchema": get_openapi(
+            title=route.name,
+            openapi_version="3.0.0",
+            version=version("pyxecm"),
+            servers=[{"url": "http://customizer:8000"}],
+            routes=[route],
+        ),
+        "requestTemplate": {
+            "data": {"context": {"where": "memory.input.where", "query": "memory.input.query"}},
+        },
+        "responseTemplate": {},  # Optional response template used to filter the response from the API.
+        "agents": agents,
+    }
+
+
+# end function
+
+
+def register_all() -> None:
+    """Register all tools."""
+
+    def register_all_routes() -> None:
+        otca = get_otca_object(otcs_object=get_otcs_object())
+        response = otca.do_request(
+            method="POST",
+            url=str(SETTINGS.aviator.studio_url) + "studio/v1/import",
+            show_error=False,
+            parse_request_response=False,
+        )
+        if not response or response.text != "Accepted":
+            logger.error("Failed to import tools!")
+            return
+        get_k8s_object().restart_deployment(deployment_name="csai-chat-svc")
+
+        for route in routes:
+            logger.info("Registering Content Aviator tool -> '%s'...", route.name)
+            request_body = register_tool_body(route=route)
+            result = otca.register_tool(request_body=request_body)
+            if result:
+                logger.info("Tool got registered successfully -> %s", route.name)
+                logger.debug("%s", result)
+
+    from pyxecm_api.app import app
+
+    # Get all FastAPI routes and register them as tools:
+    routes: list[APIRoute] = [route for route in app.routes if route.path.startswith("/agents")]
+
+    Thread(target=register_all_routes, name="RegisterTools").start()
+
+
+# end function

pyxecm_api/agents/models.py

@@ -0,0 +1,10 @@
+"""Define commonly used models."""
+
+from pydantic import BaseModel
+
+
+class Context(BaseModel):
+    """Define Model that is used to provide static context information for tools."""
+
+    where: list[dict]
+    query: str

pyxecm_api/agents/otcm_knowledgegraph/functions.py

@@ -0,0 +1,85 @@
+"""Function to build a knowledge graph from the OTCS object."""
+
+import logging
+import time
+from datetime import UTC, datetime
+
+from pyxecm_customizer.knowledge_graph import KnowledgeGraph
+
+from pyxecm_api.common.functions import get_otcs_object
+
+logger = logging.getLogger("pyxecm_api.agent.otcm_knowledge_graph")
+
+KNOWLEDGEGRAPH_OBJECT: KnowledgeGraph = None
+KNOWLEDGEGRAPH_ONTOLOGY = {
+    ("Vendor", "Material", "child"): ["offers", "supplies", "provides"],
+    ("Vendor", "Purchase Order", "child"): ["supplies", "provides"],
+    ("Vendor", "Purchase Contract", "child"): ["signs", "owns"],
+    ("Material", "Vendor", "parent"): ["is supplied by"],
+    ("Purchase Order", "Material", "child"): ["includes", "is part of"],
+    ("Customer", "Sales Order", "child"): ["has ordered"],
+    ("Customer", "Sales Contract", "child"): ["signs", "owns"],
+    ("Sales Order", "Customer", "parent"): ["belongs to", "is initiated by"],
+    ("Sales Order", "Material", "child"): ["includes", "consists of"],
+    ("Sales Order", "Delivery", "child"): ["triggers", "is followed by"],
+    ("Sales Order", "Production Order", "child"): ["triggers", "is followed by"],
+    ("Sales Contract", "Material", "child"): ["includes", "consists of"],
+    ("Production Order", "Material", "child"): ["includes", "consists of"],
+    ("Production Order", "Delivery", "child"): ["triggers", "is followed by"],
+    ("Production Order", "Goods Movement", "child"): ["triggers", "is followed by"],
+    ("Delivery", "Goods Movement", "child"): ["triggers", "is followed by"],
+    ("Delivery", "Material", "child"): ["triggers", "is followed by"],
+}
+
+
+def build_graph() -> None:
+    """Build the knowledgeGraph. And keep it updated every hour."""
+
+    def build() -> None:
+        knowledge_graph = KnowledgeGraph(otcs_object=get_otcs_object(), ontology=KNOWLEDGEGRAPH_ONTOLOGY)
+
+        start_time = datetime.now(UTC)
+        result = knowledge_graph.build_graph(
+            workspace_type_exclusions=None,
+            workspace_type_inclusions=[
+                "Vendor",
+                "Purchase Contract",
+                "Purchase Order",
+                "Material",
+                "Customer",
+                "Sales Order",
+                "Sales Contract",
+                "Delivery",
+                "Goods Movement",
+            ],
+            workers=20,
+            filter_at_traversal=True,  # also filter for workspace types if following relationships
+            relationship_types=["child"],  # only go from parent to child
+            strategy="BFS",
+            metadata=False,
+        )
+        end_time = datetime.now(UTC)
+        logger.info(
+            "Knowledge Graph completed in %s. Processed %d workspace nodes and traversed %d workspace relationships.",
+            str(end_time - start_time),
+            result["processed"],
+            result["traversed"],
+        )
+
+        global KNOWLEDGEGRAPH_OBJECT  # noqa: PLW0603
+        KNOWLEDGEGRAPH_OBJECT = knowledge_graph
+
+    while True:
+        logger.info("Building knowledge graph...")
+        build()
+        logger.info("Knowledge graph build complete. Waiting for 1 hour before rebuilding...")
+        time.sleep(3600)
+
+
+###
+
+
+def get_knowledgegraph_object() -> KnowledgeGraph:
+    """Get the OTCA object."""
+
+    return KNOWLEDGEGRAPH_OBJECT

pyxecm_api/agents/otcm_knowledgegraph/models.py

@@ -0,0 +1,61 @@
+"""Define Models for KnowledgeGraph."""
+
+from typing import Annotated, Literal
+
+from pydantic import BaseModel, Field
+
+from pyxecm_api.agents.models import Context
+from pyxecm_api.agents.otcm_workspace_agent.models import WorkspaceModel
+
+
+class KnowledgeGraphQueryModel(BaseModel):
+    """Defines Model for describing workspaces in OTCM (Opentext Content Management).
+
+    To display an instance of this model, please display the link.
+    """
+
+    source_type: Annotated[
+        str,
+        Field(
+            description="Source workspace type name provided in the user query. This provides the start point of the query in the Knowledge Graph."
+        ),
+    ]
+    source_value: Annotated[
+        str,
+        Field(
+            description="Name of the source workspace instance (of the type provided by source_type). This is NOT optional. If it is missing then you need to switch source and target. The source always needs to have a specific value!"
+        ),
+    ]
+    target_type: Annotated[
+        str,
+        Field(
+            description="Target workspace type name provided in the user query. This defines the result workspace types of the Knolwedge Graph query."
+        ),
+    ] = None
+    target_value: Annotated[
+        str,
+        Field(
+            description="Name of the target workspace instance (of the type provided by the target_type). This value is optionalis an additional / optional selection criteria."
+        ),
+    ] = None
+    intermediate_types: Annotated[
+        list[str],
+        Field(
+            description="List of workspace types (entities) that are on the path between the source workspace type and target workspace type. These are typically additional relational conditions the user is giving in the query. The start type and target types should never be in intermediate types!"
+        ),
+    ] = None
+    direction: Annotated[
+        Literal["child", "parent"],
+        Field(
+            description="The direction the graph should be traversed in. This is either 'child' (the default) or 'parent'. 'child' is typically used if traversing from main entities to related sub-entities thus following a '1 -> many' relationship (top-down). 'parent' is typically used if traversing bottom-up. This should reflect the relationship between the source type of the workspace and the requested target type. A 'child' relationship is e.g. 'Customer' -> 'Sales Order'. A 'parent' relationship is e.g. 'Material' -> 'Sales Order'."
+        ),
+    ] = None
+
+
+class KnowledgeGraphResponseModel(BaseModel):
+    """Response of the Knowledge Graph tool."""
+
+    results: Annotated[list[WorkspaceModel], Field(description="A list of workspaces matching the query.")]
+    context_update: Annotated[
+        Context, Field(description="An update for the LLM context. Update the graph state with this information!")
+    ]