From 2ce49d0304d50423589ad60069c897ebf2665f81 Mon Sep 17 00:00:00 2001 From: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com> Date: Mon, 13 May 2024 16:05:47 -0400 Subject: [PATCH] Documents OpenAI Connector setup (#5199) * incorporates Dhru's first review * Adds page for OpenAI connector setup * Minor edit * Update docs/assistant/connect-to-openai.asciidoc Co-authored-by: Joe Peeples * Update docs/assistant/connect-to-openai.asciidoc Co-authored-by: Joe Peeples * removes unused image --------- Co-authored-by: Joe Peeples --- docs/assistant/connect-to-openai.asciidoc | 72 ++++++++++++++++++++++ docs/assistant/security-assistant.asciidoc | 1 + 2 files changed, 73 insertions(+) create mode 100644 docs/assistant/connect-to-openai.asciidoc diff --git a/docs/assistant/connect-to-openai.asciidoc b/docs/assistant/connect-to-openai.asciidoc new file mode 100644 index 0000000000..8a0dbd003f --- /dev/null +++ b/docs/assistant/connect-to-openai.asciidoc @@ -0,0 +1,72 @@ +[[assistant-connect-to-openai]] += Connect to OpenAI + +This page provides step-by-step instructions for setting up an OpenAI connector for the first time. This connector type enables you to leverage OpenAI's large language models (LLMs) within {kib}. You'll first need to create an OpenAI API key, then configure the connector in {kib}. + + +[discrete] +== Configure OpenAI + +[discrete] +=== Select a model + +Before creating an API key, you must choose a model. Refer to the https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4[OpenAI docs] to select a model. Take note of the specific model name (for example `gpt-4-turbo`); you'll need it when configuring {kib}. + +NOTE: `GPT-4 Turbo` offers increased performance. `GPT-4` and `GPT-3.5` are also supported. + +[discrete] +=== Create an API key + +To generate an API key: + +. Log in to the OpenAI platform and navigate to **API keys**. +. Select **Create new secret key**. +. Name your key, select an OpenAI project, and set the desired permissions. +. Click **Create secret key** and then copy and securely store the key. It will not be accessible after you leave this screen. + +The following video demonstrates these steps. + +======= +++++ + + +
+++++ +======= + +[discrete] +== Configure the OpenAI connector + +To integrate with {kib}: + +. Log in to {kib}. +. Navigate to **Stack Management → Connectors → Create Connector → OpenAI**. +. Provide a name for your connector, such as `OpenAI (GPT-4 Turbo Preview)`, to help keep track of the model and version you are using. +. Under **Select an OpenAI provider**, choose **OpenAI**. +. The **URL** field can be left as default. +. Paste the API key that you created into the corresponding field. +. Click **Save**. + +The following video demonstrates these steps. + +======= +++++ + + +
+++++ +======= diff --git a/docs/assistant/security-assistant.asciidoc b/docs/assistant/security-assistant.asciidoc index bd0b9ae059..78e6eaeaf3 100644 --- a/docs/assistant/security-assistant.asciidoc +++ b/docs/assistant/security-assistant.asciidoc @@ -227,4 +227,5 @@ In addition to practical advice, AI Assistant can offer conceptual advice, tips, include::ai-alert-triage.asciidoc[leveloffset=+1] include::azure-openai-setup.asciidoc[leveloffset=+1] +include::connect-to-openai.asciidoc[leveloffset=+1] include::connect-to-bedrock.asciidoc[leveloffset=+1]