-
Notifications
You must be signed in to change notification settings - Fork 191
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
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
1df585c
incorporates Dhru's first review
benironside 1f38d63
Adds page for OpenAI connector setup
benironside ce10d89
Minor edit
benironside 887345c
Update docs/assistant/connect-to-openai.asciidoc
benironside 693bf72
Update docs/assistant/connect-to-openai.asciidoc
benironside ae463f3
removes unused image
benironside File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
[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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add this line after . 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. | ||
|
||
======= | ||
++++ | ||
<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> | ||
++++ | ||
======= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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