tracdap-ext-openai 0.10.0.dev15__tar.gz

tracdap_ext_openai-0.10.0.dev15/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tracdap_ext_openai-0.10.0.dev15/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.4
+Name: tracdap-ext-openai
+Version: 0.10.0.dev15
+Summary: An extension for TRAC D.A.P. that lets models connect to OpenAI endpoints
+Author-email: Martin Traverse <martin@fintrac.co.uk>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://tracdap.finos.org/
+Project-URL: Documentation, https://tracdap.readthedocs.io/
+Project-URL: Source Code, https://github.com/finos/tracdap
+Project-URL: Issue Tracker, https://github.com/finos/tracdap/issues
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: tracdap-runtime>=0.10.0-dev.15
+Requires-Dist: openai~=1.0
+Dynamic: license-file
+
+<h1 align="center">
+
+![tracdap](https://github.com/finos/tracdap/raw/main/doc/_images/tracmmp_horizontal_400.png)
+
+</h1>
+
+<p align="center">
+  <a href="https://pypi.org/project/tracdap-ext-openai"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/tracdap-ext-openai.svg?maxAge=86400" /></a>
+  <a href="https://pypi.org/project/tracdap-ext-openai"><img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/tracdap-ext-openai.svg?maxAge=86400" /></a>
+  <a href="https://github.com/finos/tracdap/actions/workflows/packaging.yaml?query=branch%3Amain"><img alt="Packaging status" src="https://github.com/finos/tracdap/actions/workflows/packaging.yaml/badge.svg?branch:main&workflow:CI" /></a>
+  <a href="https://github.com/finos/tracdap/actions/workflows/compliance.yaml?query=branch%3Amain"><img alt="Compliance status" src="https://github.com/finos/tracdap/actions/workflows/compliance.yaml/badge.svg?branch:main&workflow:CI" /></a>
+  <a href="https://community.finos.org/docs/governance/software-projects/stages/incubating/"><img alt="FINOS - Incubating" src="https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-incubating.svg" /></a>
+</p>
+
+
+# OpenAI Extension for the TRAC Model Runtime
+
+This extension makes the OpenAI Python SDK available to use from inside a TRAC model.
+
+- Use the native OpenAI client classes directly in TRAC model code
+- Connection settings managed by TRAC for both local and deployed models
+- Supports both OpenAI and AzureOpenAI clients
+- Everything available in the OpenAI SDK, also works in TRAC
+
+Models that make external calls are not considered repeatable,
+and will be flagged as non-repeatable when they run on the TRAC platform.
+
+This extension is a pre-release and will be finalized inTRAC 0.10.
+
+
+## Installing
+
+The OpenAI extension can be installed with [pip](https://pip.pypa.io):
+
+```shell
+$ pip install tracdap-ext-openai
+```
+
+The package has the following dependencies:
+
+- tracdap-runtime (version 0.10.0-beta1 or later)
+- openai (version 1.x)
+
+
+## Using the OpenAI client
+
+Here is a minimum working example of a TRAC model using the OpenAI client:
+
+```python
+import tracdap.rt.api as trac
+import openai
+
+class OpenAIModel(trac.TracModel):
+
+    # ... define parameters, inputs and outputs
+
+    def define_resources(self):
+
+        return {
+            "openai": trac.define_external_system("openai", openai.OpenAI),
+        }
+
+    def run_model(self, ctx: trac.TracContext):
+
+        with ctx.get_external_system("openai", openai.OpenAI) as client:
+
+            response = client.responses.create(
+                model="gpt-4o",
+                instructions="You are a coding assistant that talks like a pirate.",
+                input="How do I check if a Python object is an instance of a class?",
+            )
+
+            ctx.log.info(response.output_text)
+
+if __name__ == '__main__':
+    import tracdap.rt.launch as launch
+    launch.launch_model(OpenAIModel, "config/job_config.yaml", "config/sys_config.yaml")
+```
+
+To make this example work, you will need to add ``openai`` as a resource in the system config file:
+
+```yaml
+resources:
+
+  openai:
+    resourceType: EXTERNAL_SYSTEM
+    protocol: openai
+```
+
+The client can be customized by setting additional properties on the resource,
+which are passed through to the OpenAI client.
+
+```yaml
+resources:
+
+  openai:
+    resourceType: EXTERNAL_SYSTEM
+    protocol: openai
+    properties:
+      project: proj_xxxxxxxxxxxxx
+```
+
+The following configuration properties are supported:
+
+- api_key, string, required
+- organization, string, optional
+- project, string, optional
+- base_url, string, default = https://api.openai.com/v1/
+- timeout, float, defeault = openai.DEFAULT_TIMEOUT.read (currently 600 seconds)
+- max_retries, int, default = openai.DEFAULT_MAX_RETRIES (currently 2)
+
+The ``api_key`` should not be put into a config file in plain text,
+for local development it is recommended to set the OPENAI_API_KEY environment variable instead.
+If both the config property and the environment variable are set, the config property takes precedence.
+
+
+## Using the AzureOpenAI client
+
+Here is a minimum working example of a TRAC model using the AzureOpenAI client.
+This assumes the required resources and deployments have been set up in Azure.
+
+```python
+import tracdap.rt.api as trac
+import openai
+
+class TestModel(trac.TracModel):
+
+    # ... define parameters, inputs and outputs
+
+    def define_resources(self):
+
+        return {
+            "openai_azure": trac.define_external_system("openai", openai.AzureOpenAI)
+        }
+
+    def run_model(self, ctx: trac.TracContext):
+
+        with ctx.get_external_system("openai_azure", openai.AzureOpenAI) as client:
+
+            completion = client.chat.completions.create(
+                model="gpt-4.1-mini",
+                messages=[
+                    { "role": "system", "content": "You are a coding assistant that talks like a pirate."},
+                    { "role": "user", "content": "How do I check if a Python object is an instance of a class?" },
+                ]
+            )
+
+            ctx.log.info(completion.choices[0].message.content)
+
+if __name__ == '__main__':
+    import tracdap.rt.launch as launch
+    launch.launch_model(TestModel, "config/job_config.yaml", "config/sys_config.yaml")
+```
+
+To make this example work, you will need to add ``openai_azure`` as a resource in the system config file:
+
+```yaml
+resources:
+
+  openai_azure:
+    resourceType: EXTERNAL_SYSTEM
+    protocol: openai
+    subProtocol: azure
+    properties:
+      api_version: 2025-04-01-preview
+      azure_endpoint: https://my-azure-endpoint.cognitiveservices.azure.com/
+```
+
+Setting ``supProtcol: azure`` is required for to create an Azure client.
+The ``api_version`` and ``azure_endpoint`` properties must be specified,
+and ``model`` parameter in the client call must refer to live model deployment on that endpoint.
+
+All the configuration properties supported by the regular client are also supported by the Azure client.
+Additionally, the Azure client supports these extra properties:
+
+- api_version, string, required
+- azure_endpoint, string, required
+- azure_deployment, string, optional
+- azure_ad_token, string, optional
+
+For he Azure client, if ``api_key`` is not specified in the config file
+it is read from the environment variable ``AZURE_OPENAI_API_KEY``.
+Similarly, ``azure_ad_token`` can be read from the environment variable ``AZURE_OPENAI_AD_TOKEN``.
+If both the config property and the environment variable are set, the config property takes precedence.

tracdap_ext_openai-0.10.0.dev15/README.md

@@ -0,0 +1,184 @@
+<h1 align="center">
+
+![tracdap](https://github.com/finos/tracdap/raw/main/doc/_images/tracmmp_horizontal_400.png)
+
+</h1>
+
+<p align="center">
+  <a href="https://pypi.org/project/tracdap-ext-openai"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/tracdap-ext-openai.svg?maxAge=86400" /></a>
+  <a href="https://pypi.org/project/tracdap-ext-openai"><img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/tracdap-ext-openai.svg?maxAge=86400" /></a>
+  <a href="https://github.com/finos/tracdap/actions/workflows/packaging.yaml?query=branch%3Amain"><img alt="Packaging status" src="https://github.com/finos/tracdap/actions/workflows/packaging.yaml/badge.svg?branch:main&workflow:CI" /></a>
+  <a href="https://github.com/finos/tracdap/actions/workflows/compliance.yaml?query=branch%3Amain"><img alt="Compliance status" src="https://github.com/finos/tracdap/actions/workflows/compliance.yaml/badge.svg?branch:main&workflow:CI" /></a>
+  <a href="https://community.finos.org/docs/governance/software-projects/stages/incubating/"><img alt="FINOS - Incubating" src="https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-incubating.svg" /></a>
+</p>
+
+
+# OpenAI Extension for the TRAC Model Runtime
+
+This extension makes the OpenAI Python SDK available to use from inside a TRAC model.
+
+- Use the native OpenAI client classes directly in TRAC model code
+- Connection settings managed by TRAC for both local and deployed models
+- Supports both OpenAI and AzureOpenAI clients
+- Everything available in the OpenAI SDK, also works in TRAC
+
+Models that make external calls are not considered repeatable,
+and will be flagged as non-repeatable when they run on the TRAC platform.
+
+This extension is a pre-release and will be finalized inTRAC 0.10.
+
+
+## Installing
+
+The OpenAI extension can be installed with [pip](https://pip.pypa.io):
+
+```shell
+$ pip install tracdap-ext-openai
+```
+
+The package has the following dependencies:
+
+- tracdap-runtime (version 0.10.0-beta1 or later)
+- openai (version 1.x)
+
+
+## Using the OpenAI client
+
+Here is a minimum working example of a TRAC model using the OpenAI client:
+
+```python
+import tracdap.rt.api as trac
+import openai
+
+class OpenAIModel(trac.TracModel):
+
+    # ... define parameters, inputs and outputs
+
+    def define_resources(self):
+
+        return {
+            "openai": trac.define_external_system("openai", openai.OpenAI),
+        }
+
+    def run_model(self, ctx: trac.TracContext):
+
+        with ctx.get_external_system("openai", openai.OpenAI) as client:
+
+            response = client.responses.create(
+                model="gpt-4o",
+                instructions="You are a coding assistant that talks like a pirate.",
+                input="How do I check if a Python object is an instance of a class?",
+            )
+
+            ctx.log.info(response.output_text)
+
+if __name__ == '__main__':
+    import tracdap.rt.launch as launch
+    launch.launch_model(OpenAIModel, "config/job_config.yaml", "config/sys_config.yaml")
+```
+
+To make this example work, you will need to add ``openai`` as a resource in the system config file:
+
+```yaml
+resources:
+
+  openai:
+    resourceType: EXTERNAL_SYSTEM
+    protocol: openai
+```
+
+The client can be customized by setting additional properties on the resource,
+which are passed through to the OpenAI client.
+
+```yaml
+resources:
+
+  openai:
+    resourceType: EXTERNAL_SYSTEM
+    protocol: openai
+    properties:
+      project: proj_xxxxxxxxxxxxx
+```
+
+The following configuration properties are supported:
+
+- api_key, string, required
+- organization, string, optional
+- project, string, optional
+- base_url, string, default = https://api.openai.com/v1/
+- timeout, float, defeault = openai.DEFAULT_TIMEOUT.read (currently 600 seconds)
+- max_retries, int, default = openai.DEFAULT_MAX_RETRIES (currently 2)
+
+The ``api_key`` should not be put into a config file in plain text,
+for local development it is recommended to set the OPENAI_API_KEY environment variable instead.
+If both the config property and the environment variable are set, the config property takes precedence.
+
+
+## Using the AzureOpenAI client
+
+Here is a minimum working example of a TRAC model using the AzureOpenAI client.
+This assumes the required resources and deployments have been set up in Azure.
+
+```python
+import tracdap.rt.api as trac
+import openai
+
+class TestModel(trac.TracModel):
+
+    # ... define parameters, inputs and outputs
+
+    def define_resources(self):
+
+        return {
+            "openai_azure": trac.define_external_system("openai", openai.AzureOpenAI)
+        }
+
+    def run_model(self, ctx: trac.TracContext):
+
+        with ctx.get_external_system("openai_azure", openai.AzureOpenAI) as client:
+
+            completion = client.chat.completions.create(
+                model="gpt-4.1-mini",
+                messages=[
+                    { "role": "system", "content": "You are a coding assistant that talks like a pirate."},
+                    { "role": "user", "content": "How do I check if a Python object is an instance of a class?" },
+                ]
+            )
+
+            ctx.log.info(completion.choices[0].message.content)
+
+if __name__ == '__main__':
+    import tracdap.rt.launch as launch
+    launch.launch_model(TestModel, "config/job_config.yaml", "config/sys_config.yaml")
+```
+
+To make this example work, you will need to add ``openai_azure`` as a resource in the system config file:
+
+```yaml
+resources:
+
+  openai_azure:
+    resourceType: EXTERNAL_SYSTEM
+    protocol: openai
+    subProtocol: azure
+    properties:
+      api_version: 2025-04-01-preview
+      azure_endpoint: https://my-azure-endpoint.cognitiveservices.azure.com/
+```
+
+Setting ``supProtcol: azure`` is required for to create an Azure client.
+The ``api_version`` and ``azure_endpoint`` properties must be specified,
+and ``model`` parameter in the client call must refer to live model deployment on that endpoint.
+
+All the configuration properties supported by the regular client are also supported by the Azure client.
+Additionally, the Azure client supports these extra properties:
+
+- api_version, string, required
+- azure_endpoint, string, required
+- azure_deployment, string, optional
+- azure_ad_token, string, optional
+
+For he Azure client, if ``api_key`` is not specified in the config file
+it is read from the environment variable ``AZURE_OPENAI_API_KEY``.
+Similarly, ``azure_ad_token`` can be read from the environment variable ``AZURE_OPENAI_AD_TOKEN``.
+If both the config property and the environment variable are set, the config property takes precedence.

tracdap_ext_openai-0.10.0.dev15/pyproject.toml

@@ -0,0 +1,59 @@
+
+
+[build-system]
+
+requires = ["setuptools >= 77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+
+dynamic = ["version", "dependencies"]
+
+name = "tracdap-ext-openai"
+description = "An extension for TRAC D.A.P. that lets models connect to OpenAI endpoints"
+readme = "README.md"
+
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+
+authors = [
+    {name = "Martin Traverse", email = "martin@fintrac.co.uk"}
+]
+
+classifiers = [
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
+    "Intended Audience :: Financial and Insurance Industry",
+    "Topic :: Office/Business",
+    "Topic :: Office/Business :: Financial",
+    "Topic :: Software Development",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+
+requires-python = ">= 3.10"
+
+
+[project.urls]
+
+Homepage = "https://tracdap.finos.org/"
+Documentation = "https://tracdap.readthedocs.io/"
+"Source Code" = "https://github.com/finos/tracdap"
+"Issue Tracker" = "https://github.com/finos/tracdap/issues"
+
+[tool.setuptools.packages.find]
+
+where = ["src"]
+namespaces = true
+
+
+[tool.setuptools.dynamic]
+
+version = { attr = "tracdap.ext.openai.__version__" }
+dependencies = { file = ["requirements.txt"] }

tracdap_ext_openai-0.10.0.dev15/requirements.txt

@@ -0,0 +1,3 @@
+
+tracdap-runtime >= 0.10.0-dev.15
+openai ~= 1.0

tracdap_ext_openai-0.10.0.dev15/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tracdap_ext_openai-0.10.0.dev15/src/tracdap/ext/openai/__init__.py

@@ -0,0 +1,16 @@
+#  Licensed to the Fintech Open Source Foundation (FINOS) under one or
+#  more contributor license agreements. See the NOTICE file distributed
+#  with this work for additional information regarding copyright ownership.
+#  FINOS licenses this file to you under the Apache License, Version 2.0
+#  (the "License"); you may not use this file except in compliance with the
+#  License. You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+__version__ = "0.10.0.dev15"

tracdap_ext_openai-0.10.0.dev15/src/tracdap/ext/openai/openai_plugin.py

@@ -0,0 +1,261 @@
+#  Licensed to the Fintech Open Source Foundation (FINOS) under one or
+#  more contributor license agreements. See the NOTICE file distributed
+#  with this work for additional information regarding copyright ownership.
+#  FINOS licenses this file to you under the Apache License, Version 2.0
+#  (the "License"); you may not use this file except in compliance with the
+#  License. You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+import os
+import threading
+import concurrent.futures as fut
+import queue
+import logging
+
+
+try:
+    import openai  # noqa
+except ModuleNotFoundError:
+    openai = None
+
+import tracdap.rt.config as _cfg
+import tracdap.rt.exceptions as _ex
+import tracdap.rt.ext.external as _external
+import tracdap.rt.ext.plugins as _plugins
+import tracdap.rt.ext.util as _util
+
+
+class OpenAIPlugin(_external.IExternalSystem):
+
+    API_KEY_KEY = "api_key"
+    ORGANIZATION_KEY = "organization"
+    PROJECT_KEY = "project"
+    BASE_URL_KEY = "base_url"
+    TIMEOUT_KEY = "timeout"
+    MAX_RETRIES_KEY = "max_retries"
+
+    AZURE_SUB_PROTOCOL = "azure"
+    API_VERSION_KEY = "api_version"
+    AZURE_ENDPOINT_KEY = "azure_endpoint"
+    AZURE_DEPLOYMENT_KEY = "azure_deployment"
+    AZURE_AD_TOKEN_KEY = "azure_ad_token"
+
+    OPENAI_API_KEY = "OPENAI_API_KEY"
+    AZURE_OPENAI_API_KEY = "AZURE_OPENAI_API_KEY"
+    AZURE_OPENAI_AD_TOKEN = "AZURE_OPENAI_AD_TOKEN"
+
+    def __init__(self, resource_name: str, config: _cfg.PluginConfig):
+
+        log_name = f"{OpenAIPlugin.__module__}.{OpenAIPlugin.__name__}"
+        self.__log = logging.getLogger(log_name)
+
+        self.__resource_name = resource_name
+        self.__protocol = config.protocol
+        self.__sub_protocol = config.subProtocol
+
+        self.__organization = _util.read_plugin_config(config, self.ORGANIZATION_KEY, optional=True)
+        self.__project = _util.read_plugin_config(config, self.PROJECT_KEY, optional=True)
+        self.__base_url = _util.read_plugin_config(config, self.BASE_URL_KEY, optional=True)
+        self.__timeout = _util.read_plugin_config(config, self.TIMEOUT_KEY, default=openai.DEFAULT_TIMEOUT.read, convert=float)
+        self.__max_retries = _util.read_plugin_config(config, self.MAX_RETRIES_KEY, default=openai.DEFAULT_MAX_RETRIES, convert=int)
+
+        self.__api_version = _util.read_plugin_config(config, self.API_VERSION_KEY, optional=True)
+        self.__azure_endpoint = _util.read_plugin_config(config, self.AZURE_ENDPOINT_KEY, optional=True)
+        self.__azure_deployment = _util.read_plugin_config(config, self.AZURE_DEPLOYMENT_KEY, optional=True)
+
+        if _util.has_plugin_config(config, self.API_KEY_KEY):
+            api_key = _util.read_plugin_config(config, self.API_KEY_KEY)
+            self.__api_key_func = lambda: api_key
+        else:
+            self.__api_key_func = None
+
+        if _util.has_plugin_config(config, self.AZURE_AD_TOKEN_KEY):
+            ad_token = _util.read_plugin_config(config, self.AZURE_AD_TOKEN_KEY)
+            self.__azure_ad_token_func = lambda: ad_token
+        else:
+            self.__azure_ad_token_func = None
+
+        self.__factory_queue = queue.Queue()
+        self.__factory_thread = threading.Thread(name="openai-factory", target=self.__factory_main, daemon=True)
+        self.__factory_thread.start()
+        self.__warmed_up = False
+
+        # Do not print info-level logs from the low-level frameworks
+        # HTTPX logs every request by default
+        logging.getLogger("httpx").setLevel(logging.WARNING)
+        logging.getLogger("httpcore").setLevel(logging.WARNING)
+        logging.getLogger("openai").setLevel(logging.WARNING)
+
+    def supported_types(self) -> list[type]:
+
+        supported_types = [openai.OpenAI]
+
+        if openai.AzureOpenAI is not None:
+            supported_types.append(openai.AzureOpenAI)
+
+        return supported_types
+
+    def supported_args(self) -> dict[str, type] | None:
+
+        return {
+            self.TIMEOUT_KEY: float,
+            self.MAX_RETRIES_KEY: int
+        }
+
+    def create_client(self, client_type: type, **client_args) -> object:
+
+        future = fut.Future()
+        msg = (lambda: self._create_client_internal(client_type, **client_args), future)
+
+        self.__factory_queue.put(msg)
+
+        return future.result()
+
+    def _create_client_internal(self, client_type: type, **client_args) -> object:
+
+        if client_type == openai.OpenAI:
+            if self.__sub_protocol:
+                detail = f"The resource [{self.__resource_name }] is configured with sub protocol = [{self.__sub_protocol}]"
+                raise _ex.ERuntimeValidation(f"Cannot create OpenAI client: {detail}")
+            else:
+                return self._create_client_std(**client_args)
+
+        if openai.AzureOpenAI and client_type == openai.AzureOpenAI:
+            if self.__sub_protocol != self.AZURE_SUB_PROTOCOL:
+                detail = f"The resource [{self.__resource_name }] is configured with sub protocol = [{self.__sub_protocol}]"
+                raise _ex.ERuntimeValidation(f"Cannot create Azure OpenAI client: {detail}")
+            else:
+                return self._create_client_azure(**client_args)
+
+        raise _ex.EPluginNotAvailable(f"Client type [{client_type.__qualname__}] is not available in {self.__class__.__name__}")
+
+    def _create_client_std(self, **client_args):
+
+        std_args = self._build_std_args(**client_args)
+        return openai.OpenAI(**std_args)
+
+    def _create_client_azure(self, **client_args):
+
+        azure_args = self._build_azure_args(**client_args)
+        return openai.AzureOpenAI(**azure_args)
+
+    def _build_std_args(self, **client_args):
+
+        args = self._build_common_args(**client_args)
+
+        if self.__api_key_func:
+            api_key = self.__api_key_func()
+        else:
+            api_key = os.getenv(self.OPENAI_API_KEY)
+
+        if api_key:
+            args[self.API_KEY_KEY] = lambda: api_key
+
+        return args
+
+    def _build_azure_args(self, **client_args):
+
+        args = self._build_common_args(**client_args)
+
+        self._optional_arg(args, self.API_VERSION_KEY, self.__api_version)
+        self._optional_arg(args, self.AZURE_ENDPOINT_KEY, self.__azure_endpoint)
+        self._optional_arg(args, self.AZURE_DEPLOYMENT_KEY, self.__azure_deployment)
+
+        if self.__api_key_func:
+            api_key = self.__api_key_func()
+        else:
+            api_key = os.getenv(self.AZURE_OPENAI_API_KEY)
+
+        if api_key:
+            args[self.API_KEY_KEY] = api_key
+
+        if self.__azure_ad_token_func:
+            azure_ad_token = self.__azure_ad_token_func()
+        else:
+            azure_ad_token = os.getenv(self.AZURE_OPENAI_AD_TOKEN)
+
+        if azure_ad_token is not None:
+            args[self.AZURE_AD_TOKEN_KEY] = azure_ad_token
+
+        return args
+
+    def _build_common_args(self, **client_args):
+
+        args = dict()
+
+        self._optional_arg(args, self.ORGANIZATION_KEY, self.__organization)
+        self._optional_arg(args, self.PROJECT_KEY, self.__project)
+        self._optional_arg(args, self.BASE_URL_KEY, self.__base_url)
+
+        if self.TIMEOUT_KEY in client_args:
+            args[self.TIMEOUT_KEY] = min(client_args[self.TIMEOUT_KEY], self.__timeout)
+        else:
+            args[self.TIMEOUT_KEY] = self.__timeout
+
+        if self.MAX_RETRIES_KEY in client_args:
+            args[self.MAX_RETRIES_KEY] = min(client_args[self.MAX_RETRIES_KEY], self.__max_retries)
+        else:
+            args[self.MAX_RETRIES_KEY] = self.__max_retries
+
+        return args
+
+    @staticmethod
+    def _optional_arg(args, key, value):
+
+        if value is not None:
+            args[key] = value
+
+    def close_client(self, client: object):
+
+        client.close()  # noqa
+
+    def __factory_main(self):
+
+        # OpenAI uses asyncio under the hood, even for synchronous clients
+        # TRAC Actor threads have their own synchronization logic that interferes with AIO
+        # These issues can be avoided by creating OpenAI clients on a dedicated factory thread
+        # Initialization also happens on first use, so there has to be a warmup call as well
+
+        while True:
+
+            create_func, future = self.__factory_queue.get()
+            client = None
+
+            try:
+
+                client = create_func()
+
+                if not self.__warmed_up:
+                    self.__warmup_client(client)
+                    self.__warmed_up = True
+
+                future.set_result(client)
+
+            except Exception as e:
+
+                if client is not None:
+                    client.close()
+
+                future.set_exception(e)
+
+    def __warmup_client(self, client):
+
+        self.__log.info("Warming up the OpenAI client...")
+
+        model_list = client.models.list()
+        model_count = len(model_list.data)
+
+        self.__log.info(f"Warmup complete: Found {model_count} models (there may be more)")
+
+
+if openai:
+    _plugins.PluginManager.register_plugin(
+        _external.IExternalSystem, OpenAIPlugin,
+        protocols=["openai"])

tracdap_ext_openai-0.10.0.dev15/src/tracdap_ext_openai.egg-info/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.4
+Name: tracdap-ext-openai
+Version: 0.10.0.dev15
+Summary: An extension for TRAC D.A.P. that lets models connect to OpenAI endpoints
+Author-email: Martin Traverse <martin@fintrac.co.uk>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://tracdap.finos.org/
+Project-URL: Documentation, https://tracdap.readthedocs.io/
+Project-URL: Source Code, https://github.com/finos/tracdap
+Project-URL: Issue Tracker, https://github.com/finos/tracdap/issues
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: tracdap-runtime>=0.10.0-dev.15
+Requires-Dist: openai~=1.0
+Dynamic: license-file
+
+<h1 align="center">
+
+![tracdap](https://github.com/finos/tracdap/raw/main/doc/_images/tracmmp_horizontal_400.png)
+
+</h1>
+
+<p align="center">
+  <a href="https://pypi.org/project/tracdap-ext-openai"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/tracdap-ext-openai.svg?maxAge=86400" /></a>
+  <a href="https://pypi.org/project/tracdap-ext-openai"><img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/tracdap-ext-openai.svg?maxAge=86400" /></a>
+  <a href="https://github.com/finos/tracdap/actions/workflows/packaging.yaml?query=branch%3Amain"><img alt="Packaging status" src="https://github.com/finos/tracdap/actions/workflows/packaging.yaml/badge.svg?branch:main&workflow:CI" /></a>
+  <a href="https://github.com/finos/tracdap/actions/workflows/compliance.yaml?query=branch%3Amain"><img alt="Compliance status" src="https://github.com/finos/tracdap/actions/workflows/compliance.yaml/badge.svg?branch:main&workflow:CI" /></a>
+  <a href="https://community.finos.org/docs/governance/software-projects/stages/incubating/"><img alt="FINOS - Incubating" src="https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-incubating.svg" /></a>
+</p>
+
+
+# OpenAI Extension for the TRAC Model Runtime
+
+This extension makes the OpenAI Python SDK available to use from inside a TRAC model.
+
+- Use the native OpenAI client classes directly in TRAC model code
+- Connection settings managed by TRAC for both local and deployed models
+- Supports both OpenAI and AzureOpenAI clients
+- Everything available in the OpenAI SDK, also works in TRAC
+
+Models that make external calls are not considered repeatable,
+and will be flagged as non-repeatable when they run on the TRAC platform.
+
+This extension is a pre-release and will be finalized inTRAC 0.10.
+
+
+## Installing
+
+The OpenAI extension can be installed with [pip](https://pip.pypa.io):
+
+```shell
+$ pip install tracdap-ext-openai
+```
+
+The package has the following dependencies:
+
+- tracdap-runtime (version 0.10.0-beta1 or later)
+- openai (version 1.x)
+
+
+## Using the OpenAI client
+
+Here is a minimum working example of a TRAC model using the OpenAI client:
+
+```python
+import tracdap.rt.api as trac
+import openai
+
+class OpenAIModel(trac.TracModel):
+
+    # ... define parameters, inputs and outputs
+
+    def define_resources(self):
+
+        return {
+            "openai": trac.define_external_system("openai", openai.OpenAI),
+        }
+
+    def run_model(self, ctx: trac.TracContext):
+
+        with ctx.get_external_system("openai", openai.OpenAI) as client:
+
+            response = client.responses.create(
+                model="gpt-4o",
+                instructions="You are a coding assistant that talks like a pirate.",
+                input="How do I check if a Python object is an instance of a class?",
+            )
+
+            ctx.log.info(response.output_text)
+
+if __name__ == '__main__':
+    import tracdap.rt.launch as launch
+    launch.launch_model(OpenAIModel, "config/job_config.yaml", "config/sys_config.yaml")
+```
+
+To make this example work, you will need to add ``openai`` as a resource in the system config file:
+
+```yaml
+resources:
+
+  openai:
+    resourceType: EXTERNAL_SYSTEM
+    protocol: openai
+```
+
+The client can be customized by setting additional properties on the resource,
+which are passed through to the OpenAI client.
+
+```yaml
+resources:
+
+  openai:
+    resourceType: EXTERNAL_SYSTEM
+    protocol: openai
+    properties:
+      project: proj_xxxxxxxxxxxxx
+```
+
+The following configuration properties are supported:
+
+- api_key, string, required
+- organization, string, optional
+- project, string, optional
+- base_url, string, default = https://api.openai.com/v1/
+- timeout, float, defeault = openai.DEFAULT_TIMEOUT.read (currently 600 seconds)
+- max_retries, int, default = openai.DEFAULT_MAX_RETRIES (currently 2)
+
+The ``api_key`` should not be put into a config file in plain text,
+for local development it is recommended to set the OPENAI_API_KEY environment variable instead.
+If both the config property and the environment variable are set, the config property takes precedence.
+
+
+## Using the AzureOpenAI client
+
+Here is a minimum working example of a TRAC model using the AzureOpenAI client.
+This assumes the required resources and deployments have been set up in Azure.
+
+```python
+import tracdap.rt.api as trac
+import openai
+
+class TestModel(trac.TracModel):
+
+    # ... define parameters, inputs and outputs
+
+    def define_resources(self):
+
+        return {
+            "openai_azure": trac.define_external_system("openai", openai.AzureOpenAI)
+        }
+
+    def run_model(self, ctx: trac.TracContext):
+
+        with ctx.get_external_system("openai_azure", openai.AzureOpenAI) as client:
+
+            completion = client.chat.completions.create(
+                model="gpt-4.1-mini",
+                messages=[
+                    { "role": "system", "content": "You are a coding assistant that talks like a pirate."},
+                    { "role": "user", "content": "How do I check if a Python object is an instance of a class?" },
+                ]
+            )
+
+            ctx.log.info(completion.choices[0].message.content)
+
+if __name__ == '__main__':
+    import tracdap.rt.launch as launch
+    launch.launch_model(TestModel, "config/job_config.yaml", "config/sys_config.yaml")
+```
+
+To make this example work, you will need to add ``openai_azure`` as a resource in the system config file:
+
+```yaml
+resources:
+
+  openai_azure:
+    resourceType: EXTERNAL_SYSTEM
+    protocol: openai
+    subProtocol: azure
+    properties:
+      api_version: 2025-04-01-preview
+      azure_endpoint: https://my-azure-endpoint.cognitiveservices.azure.com/
+```
+
+Setting ``supProtcol: azure`` is required for to create an Azure client.
+The ``api_version`` and ``azure_endpoint`` properties must be specified,
+and ``model`` parameter in the client call must refer to live model deployment on that endpoint.
+
+All the configuration properties supported by the regular client are also supported by the Azure client.
+Additionally, the Azure client supports these extra properties:
+
+- api_version, string, required
+- azure_endpoint, string, required
+- azure_deployment, string, optional
+- azure_ad_token, string, optional
+
+For he Azure client, if ``api_key`` is not specified in the config file
+it is read from the environment variable ``AZURE_OPENAI_API_KEY``.
+Similarly, ``azure_ad_token`` can be read from the environment variable ``AZURE_OPENAI_AD_TOKEN``.
+If both the config property and the environment variable are set, the config property takes precedence.

tracdap_ext_openai-0.10.0.dev15/src/tracdap_ext_openai.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+requirements.txt
+src/tracdap/ext/openai/__init__.py
+src/tracdap/ext/openai/openai_plugin.py
+src/tracdap_ext_openai.egg-info/PKG-INFO
+src/tracdap_ext_openai.egg-info/SOURCES.txt
+src/tracdap_ext_openai.egg-info/dependency_links.txt
+src/tracdap_ext_openai.egg-info/requires.txt
+src/tracdap_ext_openai.egg-info/top_level.txt

tracdap_ext_openai-0.10.0.dev15/src/tracdap_ext_openai.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

tracdap_ext_openai-0.10.0.dev15/src/tracdap_ext_openai.egg-info/requires.txt

@@ -0,0 +1,2 @@
+tracdap-runtime>=0.10.0-dev.15
+openai~=1.0

tracdap_ext_openai-0.10.0.dev15/src/tracdap_ext_openai.egg-info/top_level.txt

@@ -0,0 +1 @@
+tracdap