Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documents OpenAI Connector setup #5199

Merged
merged 6 commits into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions docs/assistant/connect-to-openai.asciidoc
Original file line number Diff line number Diff line change
@@ -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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NOTE: For best performance we recommend gpt-4o. Alternatively you can use gpt-4-turbo, but at a minimum, gpt-4-32k can be used.


--


or


[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.
benironside marked this conversation as resolved.
Show resolved Hide resolved

=======
++++
<script type="text/javascript" async src="https://play.vidyard.com/embed/v4.js"></script>
<img
style="width: 100%; margin: auto; display: block;"
class="vidyard-player-embed"
src="https://play.vidyard.com/vbD7fGBGgyxK4TRbipeacL.jpg"
data-uuid="vbD7fGBGgyxK4TRbipeacL"
data-v="4"
data-type="inline"
/>
</br>
++++
=======

[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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add this line after . The URL field can be left as default.
In the default model specify your model of choice. This section can be updated later on to reflect new releases in models.

. Paste the API key that you created into the corresponding field.
. Click **Save**.

The following video demonstrates these steps.

=======
++++
<script type="text/javascript" async src="https://play.vidyard.com/embed/v4.js"></script>
<img
style="width: 100%; margin: auto; display: block;"
class="vidyard-player-embed"
src="https://play.vidyard.com/BGaQ73KBJCzeqWoxXkQvy9.jpg"
data-uuid="BGaQ73KBJCzeqWoxXkQvy9"
data-v="4"
data-type="inline"
/>
</br>
++++
=======
1 change: 1 addition & 0 deletions docs/assistant/security-assistant.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -224,4 +224,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]