diff --git a/addons/gd-openai/LICENSE b/addons/gd-openai/LICENSE new file mode 100644 index 0000000..f562216 --- /dev/null +++ b/addons/gd-openai/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Clemens Tolboom + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +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. diff --git a/addons/gd-openai/README.md b/addons/gd-openai/README.md new file mode 100644 index 0000000..b050d54 --- /dev/null +++ b/addons/gd-openai/README.md @@ -0,0 +1,108 @@ +# GD Script OpenAI + +Interfacing with the [OpenAI API's](https://platform.openai.com/overview) using their **[API Key](https://platform.openai.com/account/api-keys)** + +With the `gd-openai` addon you can quickly create scenes interacting with the +[API](https://platform.openai.com/docs/api-reference) of OpenAI. See the examples below. + +Download the ZIP file from GitHub or install through the AssetLib when available. + +## User Data + +The settings file `open_ai_user_data.tres` and all requests and responses are saved in `user://`. + +The settings file for security reasons as it may not become part of the build. + +The requests and responses for browsing back possibilities. + +## What calls are available? + +- [/v1/chat/completions](https://platform.openai.com/docs/api-reference/chat) + to mimic ChatGPT sessions. **Note**: only model, system, assistent, user are available. +- [/v1/models](https://platform.openai.com/docs/api-reference/models) to find available models. +- [/v1/images/generations](https://platform.openai.com/docs/api-reference/images) for generating inspiring images. + +## API Key + +The tool needs an [API key](https://platform.openai.com/account/api-keys) +from your OpenAI account. + +**Copy** the `open_ai_user_data.tres` from the examples dir to your project root. + +Then open it and replace the `API Key` field with your OpenAI API Key. + +Then **move** the file out of your project to the game data directory using the menu `Project > Open User Data Folder. + +You must move it to make sure not to expose your API Key to the world. + +## Examples + +The are some examples available to list the `models`, start a `chat/completions` +or fiddle with `images/generations`. + +## Building a scene + +You need to add 3 parts to your scene: + +### OpenAiApiRequest + +As a child in your tree. + +```gdscript +@ready var openai_api_request:OpenAiApiRequest = $OpenAiApiRequest + +func _ready(): + # Connect openai_api_request signals through the UI or code + +func _on_open_ai_api_request_data_received(data): + response = data + +func _on_open_ai_api_request_error_response(error): + print(error) +``` + +### RequestData sub-class + +RequestData sub-class like ModelsRequest, ChatCompletionsRequest, ImageGenerationsRequest, etc + +```gdscript +@export var request:ChatCompletionsRequest +``` + +Then set it's value through the UI. + +### ResponseData sub-class + +ResponseData sub-class like ModelsResponse. + +```gdscript +var response:ChatCompletionsResponse = ChatCompletionsResponse.new() +``` + +### Request/response + +Initiate the call ie by a Button click + +``` +connector.do_post(request, response) +``` + +and wait for one of the two signals to appear. + +## Roadmap + +- Add **all** properties to [/v1/chat/completions](https://platform.openai.com/docs/api-reference/chat) +- [/v1/models/{model}](https://platform.openai.com/docs/api-reference/models/retrieve) +- your wishes / PRs / support + +## References + +- [OpenAI API's](https://platform.openai.com/overview) +- [API Key](https://platform.openai.com/account/api-keys) +- [API](https://platform.openai.com/docs/api-reference) + +### Some other implementations + +- [godot-openai](https://github.com/Buri/godot-openai) +- [GPTIntegration](https://github.com/finepointcgi/Godot-Open-AI-GPT-Integration) +- [GodotGPT](https://github.com/rrbenx/GodotGPT)