Adds step by step instructions for connecting to Azure OpenAI #5158

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.

Sign up for GitHub

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

Jump to bottom

Merged

benironside merged 16 commits into main from 5136-azure-openai-stepbystep-connector

May 6, 2024

Contributor

benironside commented May 3, 2024 •

edited

Loading

Fixes #5136 by adding step-by-step instructions for setting up an Azure OpenAI connector.

Preview: Connect to Azure OpenAI


          Adds step by step instructions for connecting to Azure OpenAI

0c94551

benironside added Priority: High Team: GenAI labels

benironside self-assigned this

benironside requested a review from a team as a code owner

May 3, 2024 16:05

benironside requested a review from Charelzard

May 3, 2024 16:05

github-actions bot commented May 3, 2024

A documentation preview will be available soon.

🔨 Buildkite builds
📚 HTML diff
📙 Preview page

Request a new doc build by commenting

Rebuild this PR: run docs-build
Rebuild this PR and all Elastic docs: run docs-build rebuild

_{run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.}

_{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

mergify bot commented May 3, 2024

This pull request does not have a backport label. Could you fix it @benironside? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

v7.x is the label to automatically backport to the 7.x branch.
v7./d./d is the label to automatically backport to the 7./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

mergify bot added the backport-skip label

benironside added 3 commits

May 3, 2024 10:20


          adjust headings

c065c61


          fixes slug

adaa730


          adds intro paragraph

2618a5b

benironside added v8.13.0 v8.14.0 labels

mergify bot removed the backport-skip label

Contributor

mergify bot commented May 3, 2024

This pull request is now in conflicts. Could you fix it @benironside? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b 5136-azure-openai-stepbystep-connector upstream/5136-azure-openai-stepbystep-connector
git merge upstream/main
git push upstream 5136-azure-openai-stepbystep-connector

nastasha-solomon previously approved these changes

View reviewed changes

Contributor

nastasha-solomon left a comment

Looks great! Good job pulling all of this together so quickly!

docs/assistant/azure-openai-setup.asciidoc Outdated Show resolved Hide resolved

docs/assistant/azure-openai-setup.asciidoc Outdated Show resolved Hide resolved

docs/assistant/azure-openai-setup.asciidoc Outdated Show resolved Hide resolved

docs/assistant/azure-openai-setup.asciidoc Outdated Show resolved Hide resolved

docs/assistant/azure-openai-setup.asciidoc Outdated Show resolved Hide resolved

docs/assistant/azure-openai-setup.asciidoc Outdated Show resolved Hide resolved


          Update docs/assistant/azure-openai-setup.asciidoc

5ad7baf

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

benironside dismissed nastasha-solomon’s stale review via

5ad7baf

May 3, 2024 19:48

benironside and others added 5 commits

May 3, 2024 12:48


          Update docs/assistant/azure-openai-setup.asciidoc

4b35f33

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>


          Update docs/assistant/azure-openai-setup.asciidoc

5a683ed

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>


          Update docs/assistant/azure-openai-setup.asciidoc

89a207e

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>


          Update docs/assistant/azure-openai-setup.asciidoc

20755b6

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>


          Update docs/assistant/azure-openai-setup.asciidoc

31f84ef

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

benironside requested a review from dhru42

May 3, 2024 19:49


          Merge branch 'main' into 5136-azure-openai-stepbystep-connector

b2c1b86

nastasha-solomon self-requested a review

May 3, 2024 19:50

nastasha-solomon previously approved these changes

View reviewed changes

Charelzard reviewed

View reviewed changes

Charelzard left a comment

See 4 comments.

docs/assistant/azure-openai-setup.asciidoc Outdated

+              Next, create access keys for the deployment:
+              . From within your Azure OpenAI deployment, select **Click here to manage keys**.
+              . Store your keys in a secure location. You'll need them later.

Charelzard May 3, 2024

. Store your keys in a secure location.

docs/assistant/azure-openai-setup.asciidoc Outdated

+              . Log in to {kib}.
+              . Go to **Stack Management → Connectors → Create connector → OpenAI**.
+              . Name your connector.
+              . (Optional) Add one of the following strings if you want to use a model other than the default:

Charelzard May 3, 2024

Give your Connector a name, something like this naming convention can help you keep track of various models: Azure OpenAI (GPT-4 Turbo v. 0125)

docs/assistant/azure-openai-setup.asciidoc Outdated

+              . Go to **Stack Management → Connectors → Create connector → OpenAI**.
+              . Name your connector.
+              . (Optional) Add one of the following strings if you want to use a model other than the default:
+              ** For Turbo: `Azure OpenAI (GPT-4 Turbo v. 0125)`

Charelzard May 3, 2024

Remove

docs/assistant/azure-openai-setup.asciidoc Outdated

+              . Name your connector.
+              . (Optional) Add one of the following strings if you want to use a model other than the default:
+              ** For Turbo: `Azure OpenAI (GPT-4 Turbo v. 0125)`
+              ** For 32k: `Azure OpenAI (GPT-4-32k)`

Charelzard May 3, 2024

Remove


          Incorporates Charles' review. Thanks Charles!

ebd0491

benironside dismissed nastasha-solomon’s stale review via

ebd0491

May 4, 2024 20:45


          line edit

80380f8

nastasha-solomon previously approved these changes

View reviewed changes

Contributor

nastasha-solomon left a comment

Don't see any major issues - LGTM! 👍🏼

jmikell821 reviewed

View reviewed changes

Contributor

jmikell821 left a comment

Looks great! Love the included videos here; makes it easier to follow the steps! Just a few suggestions.

docs/assistant/azure-openai-setup.asciidoc Outdated Show resolved Hide resolved

docs/assistant/azure-openai-setup.asciidoc Outdated Show resolved Hide resolved

docs/assistant/azure-openai-setup.asciidoc Outdated Show resolved Hide resolved


          Update docs/assistant/azure-openai-setup.asciidoc

4c6af31

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

benironside dismissed nastasha-solomon’s stale review via

4c6af31

May 6, 2024 13:18

benironside and others added 2 commits

May 6, 2024 06:18


          Update docs/assistant/azure-openai-setup.asciidoc

894aeac

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>


          Update docs/assistant/azure-openai-setup.asciidoc

5ba5165

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

joepeeples approved these changes

View reviewed changes

Contributor

joepeeples left a comment

🌻

benironside merged commit 2b8440e into main

mergify bot pushed a commit that referenced this pull request


          Adds step by step instructions for connecting to Azure OpenAI (#5158)

99d905a

* Adds step by step instructions for connecting to Azure OpenAI

* adjust headings

* fixes slug

* adds intro paragraph

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Incorporates Charles' review. Thanks Charles!

* line edit

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

---------

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>
(cherry picked from commit 2b8440e)

mergify bot pushed a commit that referenced this pull request


          Adds step by step instructions for connecting to Azure OpenAI (#5158)

3ad92e6

* Adds step by step instructions for connecting to Azure OpenAI

* adjust headings

* fixes slug

* adds intro paragraph

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Incorporates Charles' review. Thanks Charles!

* line edit

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

---------

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>
(cherry picked from commit 2b8440e)

This was referenced May 6, 2024

[8.14] Adds step by step instructions for connecting to Azure OpenAI (backport #5158) #5164

Merged

[8.13] Adds step by step instructions for connecting to Azure OpenAI (backport #5158) #5165

Merged

benironside added a commit that referenced this pull request


          Adds step by step instructions for connecting to Azure OpenAI (#5158) (…

abea2a4

…#5165)

* Adds step by step instructions for connecting to Azure OpenAI

* adjust headings

* fixes slug

* adds intro paragraph

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Incorporates Charles' review. Thanks Charles!

* line edit

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

---------

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>
(cherry picked from commit 2b8440e)

Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>

benironside added a commit that referenced this pull request


          Adds step by step instructions for connecting to Azure OpenAI (#5158) (…

75725d3

…#5164)

* Adds step by step instructions for connecting to Azure OpenAI

* adjust headings

* fixes slug

* adds intro paragraph

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Incorporates Charles' review. Thanks Charles!

* line edit

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

* Update docs/assistant/azure-openai-setup.asciidoc

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

---------

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>
(cherry picked from commit 2b8440e)

Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jmikell821 jmikell821 left review comments

Charelzard Charelzard left review comments

nastasha-solomon nastasha-solomon left review comments

dhru42 Awaiting requested review from dhru42

+1 more reviewer

joepeeples joepeeples approved these changes

Labels

Priority: High Team: GenAI v8.13.0 v8.14.0