Skip to content

Commit

Permalink
[8.15] [DOCS][Playground] Mention local model compatibility (#192911) (
Browse files Browse the repository at this point in the history
…#193009)

# Backport

This will backport the following commits from `main` to `8.15`:
- [[DOCS][Playground] Mention local model compatibility
(#192911)](#192911)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Liam
Thompson","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-16T13:18:22Z","message":"[DOCS][Playground]
Mention local model compatibility (#192911)\n\nNote about openai sdk
compatible local models + links to
examples","sha":"0a385f30fd9b9ab509b3be091d5e1add789cadeb","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","v8.15.0","v8.16.0"],"title":"[DOCS][Playground]
Mention local model
compatibility","number":192911,"url":"https://github.com/elastic/kibana/pull/192911","mergeCommit":{"message":"[DOCS][Playground]
Mention local model compatibility (#192911)\n\nNote about openai sdk
compatible local models + links to
examples","sha":"0a385f30fd9b9ab509b3be091d5e1add789cadeb"}},"sourceBranch":"main","suggestedTargetBranches":["8.15","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/192911","number":192911,"mergeCommit":{"message":"[DOCS][Playground]
Mention local model compatibility (#192911)\n\nNote about openai sdk
compatible local models + links to
examples","sha":"0a385f30fd9b9ab509b3be091d5e1add789cadeb"}},{"branch":"8.15","label":"v8.15.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Liam Thompson <[email protected]>
  • Loading branch information
kibanamachine and leemthompo authored Sep 16, 2024
1 parent 40f37ee commit 42fa6fa
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions docs/playground/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,17 @@ a|

|===

[[playground-local-llms]]
[TIP]
====
You can also use locally hosted LLMs that are compatible with the OpenAI SDK.
Once you've set up your LLM, you can connect to it using the OpenAI connector.
Refer to the following for examples:
* {security-guide}/connect-to-byo-llm.html[Using LM Studio]
* https://www.elastic.co/search-labs/blog/localai-for-text-embeddings[LocalAI with `docker-compose`]
====

[float]
[[playground-getting-started]]
== Getting started
Expand All @@ -101,13 +112,15 @@ image::get-started.png[width=600]
=== Connect to LLM provider

To get started with {x}, you need to create a <<action-types,connector>> for your LLM provider.
Follow these steps on the {x} landing page:
You can also connect to <<playground-local-llms,locally hosted LLMs>> which are compatible with the OpenAI API, by using the OpenAI connector.

To connect to an LLM provider, follow these steps on the {x} landing page:

. Under *Connect to an LLM*, click *Create connector*.
. Select your *LLM provider*.
. *Name* your connector.
. Select a *URL endpoint* (or use the default).
. Enter *access credentials* for your LLM provider.
. Enter *access credentials* for your LLM provider. (If you're running a locally hosted LLM using the OpenAI connector, you must input a value in the API key form, but the specific value doesn't matter.)

[TIP]
====
Expand Down

0 comments on commit 42fa6fa

Please sign in to comment.