From 1e137f0bd8f5d53cab2c08a0f826a82411adff38 Mon Sep 17 00:00:00 2001 From: Ali BARIN Date: Tue, 17 Jan 2023 13:23:49 +0100 Subject: [PATCH] docs(openai): describe auth and check moderation action --- packages/docs/pages/.vitepress/config.js | 9 +++++++++ packages/docs/pages/apps/openai/actions.md | 12 ++++++++++++ packages/docs/pages/apps/openai/connection.md | 8 ++++++++ packages/docs/pages/guide/available-apps.md | 1 + packages/docs/pages/public/favicons/openai.svg | 6 ++++++ 5 files changed, 36 insertions(+) create mode 100644 packages/docs/pages/apps/openai/actions.md create mode 100644 packages/docs/pages/apps/openai/connection.md create mode 100644 packages/docs/pages/public/favicons/openai.svg diff --git a/packages/docs/pages/.vitepress/config.js b/packages/docs/pages/.vitepress/config.js index 615cf1ef..d9debf65 100644 --- a/packages/docs/pages/.vitepress/config.js +++ b/packages/docs/pages/.vitepress/config.js @@ -87,6 +87,15 @@ export default defineConfig({ { text: 'Connection', link: '/apps/ntfy/connection' }, ], }, + { + text: 'OpenAI', + collapsible: true, + collapsed: true, + items: [ + { text: 'Actions', link: '/apps/openai/actions' }, + { text: 'Connection', link: '/apps/openai/connection' }, + ], + }, { text: 'RSS', collapsible: true, diff --git a/packages/docs/pages/apps/openai/actions.md b/packages/docs/pages/apps/openai/actions.md new file mode 100644 index 00000000..aafeb453 --- /dev/null +++ b/packages/docs/pages/apps/openai/actions.md @@ -0,0 +1,12 @@ +--- +favicon: /favicons/openai.svg +items: + - name: Check moderation Text + desc: Checks for hate, hate/threatening, self-harm, sexual, sexual/minors, violence, or violence/graphic content in text. +--- + + + + diff --git a/packages/docs/pages/apps/openai/connection.md b/packages/docs/pages/apps/openai/connection.md new file mode 100644 index 00000000..f6967eda --- /dev/null +++ b/packages/docs/pages/apps/openai/connection.md @@ -0,0 +1,8 @@ +# OpenAI + +1. Go to [API Keys page](https://beta.openai.com/account/api-keys) on OpenAI. +2. Create a new secret key. +3. Paste the key into the `API Key` field in Automatisch. +4. Write any screen name to be displayed in Automatisch. +5. Click `Save`. +6. Start using OpenAI integration with Automatisch! diff --git a/packages/docs/pages/guide/available-apps.md b/packages/docs/pages/guide/available-apps.md index bf464ca5..01d31cdb 100644 --- a/packages/docs/pages/guide/available-apps.md +++ b/packages/docs/pages/guide/available-apps.md @@ -13,6 +13,7 @@ Following integrations are currently supported by Automatisch. - [Github](/apps/github/triggers) - [RSS](/apps/rss/triggers) - [Ntfy](/apps/ntfy/triggers) +- [OpenAI](/apps/openai/actions) - [Salesforce](/apps/salesforce/triggers) - [Scheduler](/apps/scheduler/triggers) - [Slack](/apps/slack/actions) diff --git a/packages/docs/pages/public/favicons/openai.svg b/packages/docs/pages/public/favicons/openai.svg new file mode 100644 index 00000000..b62b84eb --- /dev/null +++ b/packages/docs/pages/public/favicons/openai.svg @@ -0,0 +1,6 @@ + + OpenAI + + + + \ No newline at end of file