Skip to content

Commit

Permalink
[docs] Add note about accessing Azure OpenAI through a proxy (#186436)
Browse files Browse the repository at this point in the history
## Summary

Closes elastic/observability-docs#4005.

### Checklist

n/a

(cherry picked from commit 4b38ffd)
  • Loading branch information
dedemorton committed Jul 9, 2024
1 parent ee7fd95 commit 4d68b7e
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions docs/management/connectors/action-types/openai.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
<titleabbrev>OpenAI</titleabbrev>
++++
:frontmatter-description: Add a connector that can send requests to an OpenAI provider.
:frontmatter-tags-products: [kibana]
:frontmatter-tags-content-type: [how-to]
:frontmatter-tags-products: [kibana]
:frontmatter-tags-content-type: [how-to]
:frontmatter-tags-user-goals: [configure]


Expand All @@ -21,6 +21,17 @@ You can create connectors in *{stack-manage-app} > {connectors-ui}*. For exampl
image::management/connectors/images/gen-ai-connector.png[OpenAI connector]
// NOTE: This is an autogenerated screenshot. Do not edit it directly.

[IMPORTANT]
====
Elastic provides no official support for connecting to the Azure OpenAI service through a proxy.
However if you must use a proxy,
ensure that the proxy supports streaming and is SSE-compatible.
Elastic will only parse streamed responses.
To validate that your connectivity problems are caused by using a proxy,
you can attempt to set up the connector and access the Azure OpenAI service without using a proxy.
====

[float]
[[openai-connector-configuration]]
==== Connector configuration
Expand All @@ -46,7 +57,7 @@ image::management/connectors/images/gen-ai-params-test.png[OpenAI params test]

The OpenAI actions have the following configuration properties.

Body:: A JSON payload sent to the OpenAI API URL. For example:
Body:: A JSON payload sent to the OpenAI API URL. For example:
+
[source,text]
--
Expand Down

0 comments on commit 4d68b7e

Please sign in to comment.