Pack to integrate OpenAI API to Stackstorm

.github/workflows/build_and_test.yaml

@@ -19,8 +19,8 @@ jobs:
     strategy:
       matrix:
         include:
-          - python-version-short: "3.6"
-            python-version: 3.6.15
+          - python-version-short: "3.8"
+            python-version: 3.8.18
     steps:
       - name: Checkout Pack Repo and CI Repos
         uses: StackStorm-Exchange/ci/.github/actions/checkout@master

openai/.github/CODEOWNERS

@@ -0,0 +1,16 @@
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence, users and
+# teams which are put in owners will be requested for review
+# when someone opens a pull request.
+
+# This is base configuration. These owners could review the
+# whole file in this repository.
+* @dalarsen @StackStorm-Exchange/tsc
+
+# CI configuration files should be reviewed by specific owners
+# who are more responsible for ensuring the quality of this pack
+# or orchestrate StackStorm-Exchanges.
+.circleci/**  @StackStorm-Exchange/tsc

openai/CHANGES.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## v0.1.0
+
+* Initial release

openai/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

openai/README.md

@@ -0,0 +1,19 @@
+# OpenAI Integration Pack
+
+Perform chat completions and image generation with OpenAI API
+
+## Configuration
+
+The configuration schema contains two attributes:
+
+* ``openai_token`` - Your OpenAI API access token
+* ``openai_org`` - The organization associated with your API token
+
+## Actions
+
+* `chat_completion` - Perform a chat completion query (text-based "chat" query)
+* `image_generation` - Request a OpenAI generative graphical image
+
+## Maintainers
+Active pack maintainers with review & write repository access:
+* Dave Larsen ([@dalarsen](https://github.com/dalarsen))

openai/actions/chat_completion.py

@@ -0,0 +1,16 @@
+import openai
+
+from st2common.runners.base_action import Action
+
+
+class ChatCompletion(Action):
+    def run(self, query, model):
+        config = self.config
+        openai.api_key = config.get("openai_token")
+        openai.organization = config.get("openai_org")
+        return openai.ChatCompletion.create(
+            model=model,
+            messages=[
+                {"role": "user", "content": query}
+            ]
+        )

openai/actions/chat_completion.yaml

@@ -0,0 +1,16 @@
+name: chat_completion
+pack: openai
+description: Action to query the OpenAI chat completion API.
+runner_type: "python-script"
+entry_point: chat_completion.py
+enabled: true
+parameters:
+ query:
+  required: true
+  type: string
+  secret: false
+ model:
+  required: false
+  type: string
+  default: "gpt-4"
+  secret: false

openai/actions/image_generation.py

@@ -0,0 +1,11 @@
+import openai
+
+from st2common.runners.base_action import Action
+
+
+class ImageGeneration(Action):
+    def run(self, query, size):
+        config = self.config
+        openai.api_key = config.get("openai_token")
+        openai.organization = config.get("openai_org")
+        return openai.Image.create(prompt=query, size=size)

openai/actions/image_generation.yaml

@@ -0,0 +1,16 @@
+name: image_generation
+pack: openai
+description: Action to query the OpenAI image API.
+runner_type: "python-script"
+entry_point: image_generation.py
+enabled: true
+parameters:
+ query:
+  required: true
+  type: string
+  secret: false
+ size:
+  required: false
+  type: string
+  default: "512x512"
+  secret: false

openai/aliases/chat_completion.yaml

@@ -0,0 +1,21 @@
+---
+name: openai_chat_completion
+action_ref: openai.chat_completion
+description: Make a chat completion query to the OpenAI API
+formats:
+  - "ask chatgpt {{query}}"
+ack:
+  format: "Sending your ChatGPT chat completion query now, please wait..."
+enabled: true
+result:
+  format: |       
+    Response from OpenAI for the ChatGPT chat completion query {{execution.parameters.question}}:
+
+    {% if execution.status == 'succeeded' %}
+      {% for choice in execution.result.result.choices %}
+        -----
+        {{ choice.message.content }}
+      {% endfor %}        
+    {% else %}
+    Query to OpenAI failed: {{execution}}
+    {% endif %}

openai/aliases/image_generation.yaml

@@ -0,0 +1,18 @@
+---
+name: openai_image_generation
+action_ref: openai.image_generation
+description: Make an image generation query to the OpenAI API
+formats:
+  - "ask dall-e {{query}}"
+ack:
+  format: "Sending your DALL-E image generation query now, please wait..."
+enabled: true
+result:
+  format: |       
+    Response from OpenAI for the DALL-E image generation query {{execution.parameters.question}}:
+
+    {% if execution.status == 'succeeded' %}
+      {{ execution.result.result.data }}              
+    {% else %}
+    Query to OpenAI failed: {{execution}}
+    {% endif %}

openai/config.schema.yaml

@@ -0,0 +1,12 @@
+---
+
+openai_token:
+  description: "Authentication token for OpenAI API"
+  type: string
+  required: false
+  secret: true
+openai_org:
+  description: "Organization identifier for OpenAI API auth token"
+  type: string
+  required: false
+  secret: false

openai/openai.yaml.example

@@ -0,0 +1,3 @@
+---
+openai_token: 'abcdefghikjl1234567890'
+openai_org: 'nobody_org'

openai/pack.yaml

@@ -0,0 +1,12 @@
+---
+ref: openai
+name: OpenAI Query Pack
+description: Pack to query OpenAI API
+keywords:
+  - openai
+  - ai
+version: 0.1.0
+python_versions:
+  - "3"
+author: David Larsen
+email: [email protected]

openai/requirements.txt

@@ -0,0 +1 @@
+openai>=0.27.0,<1.0