Documents OpenAI Connector setup #5199
Merged
Conversation
This file contains hidden or 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
|
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
Contributor
|
This pull request does not have a backport label. Could you fix it @benironside? 🙏
NOTE: |
joepeeples
reviewed
May 13, 2024
Contributor
joepeeples
left a comment
joepeeples
left a comment
There was a problem hiding this comment.
A couple comments for consideration, thanks!
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
mergify bot
pushed a commit
that referenced
this pull request
May 13, 2024
* 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 <joe.peeples@elastic.co> * Update docs/assistant/connect-to-openai.asciidoc Co-authored-by: Joe Peeples <joe.peeples@elastic.co> * removes unused image --------- Co-authored-by: Joe Peeples <joe.peeples@elastic.co> (cherry picked from commit 2ce49d0)
mergify bot
pushed a commit
that referenced
this pull request
May 13, 2024
* 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 <joe.peeples@elastic.co> * Update docs/assistant/connect-to-openai.asciidoc Co-authored-by: Joe Peeples <joe.peeples@elastic.co> * removes unused image --------- Co-authored-by: Joe Peeples <joe.peeples@elastic.co> (cherry picked from commit 2ce49d0)
This was referenced May 13, 2024
benironside
added a commit
that referenced
this pull request
May 13, 2024
* 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 <joe.peeples@elastic.co> * Update docs/assistant/connect-to-openai.asciidoc Co-authored-by: Joe Peeples <joe.peeples@elastic.co> * removes unused image --------- Co-authored-by: Joe Peeples <joe.peeples@elastic.co> (cherry picked from commit 2ce49d0) Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>
benironside
added a commit
that referenced
this pull request
May 13, 2024
* 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 <joe.peeples@elastic.co> * Update docs/assistant/connect-to-openai.asciidoc Co-authored-by: Joe Peeples <joe.peeples@elastic.co> * removes unused image --------- Co-authored-by: Joe Peeples <joe.peeples@elastic.co> (cherry picked from commit 2ce49d0) Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>
Charelzard
reviewed
May 13, 2024
|
|
||
| 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. |
There was a problem hiding this comment.
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
| . 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.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #5137 by adding a step-by-step guide for setting up an OpenAI connector.
Preview: Connect to OpenAI