elastic / elastic/docs-content

Improve discoverability of OpenAI url service setting

Open Beginner friendly
#7,876 1 comment 0 reactions 0 assignees View on GitHub
Team:Developer
Dominant language
No language data
Stars
47
Forks
261
Avg merge
3d 12h
Merged PRs (30d)
116

Description

The `openai` inference service accepts an optional `url` in `service_settings` to point at any OpenAI-compatible endpoint. Two issues:

1. The [REST API docs](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-openai) describe `url` as something that "can be changed for testing purposes." Can it be used in production for local LLMs and compatible gateways? Iff yes, the description should say that.

2. [Using OpenAI compatible models](https://www.elastic.co/docs/solutions/search/using-openai-compatible-models) covers this use case in detail but nothing links to it. Cross-referencing from the API docs or the inference processor page would help people find it.

Context: [elasticsearch#155700](https://github.com/elastic/elasticsearch/pull/155700) tried to add this info as a tip with a tracked marketing link. The info is already there, just hard to find.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the REST API documentation for the OpenAI inference service and the “Using OpenAI compatible models” page linked in the issue. Confirm whether the optional service_settings url supports production use for local LLMs and compatible gateways, then add accurate wording and a cross-reference from the API docs or inference processor page. Done means the use case is clearly described and the existing guidance is discoverable.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.