Skip to content

Complete documentation update for OpenAI SDK base URL new behavior#6093

Closed
jewoodev wants to merge 1 commit into
spring-projects:mainfrom
jewoodev:docs/gh-6036-openai-base-url-followup
Closed

Complete documentation update for OpenAI SDK base URL new behavior#6093
jewoodev wants to merge 1 commit into
spring-projects:mainfrom
jewoodev:docs/gh-6036-openai-base-url-followup

Conversation

@jewoodev
Copy link
Copy Markdown
Contributor

This documentation-only PR follows up on #6036 and completes the OpenAI SDK base URL documentation corrections started in 192eb5c. Across 8 documentation files, it corrects the remaining OpenAI-compatible base URLs and removes documentation for properties dropped by the migration.

File Problem Fix
api/chat/dmr-chat.adoc The spring.ai.openai.base-url connection property pointed to https://hub.docker.com/u/ai, which is a Docker Hub page rather than an OpenAI-compatible API endpoint. Changed the documented base URL to http://localhost:12434/engines/v1, matching the Docker Model Runner endpoint used elsewhere on the page.
api/embeddings/openai-embeddings.adoc, api/audio/speech/openai-speech.adoc, api/audio/transcriptions/openai-transcriptions.adoc, api/moderation/openai-moderation.adoc The embeddings-path, speech-path, transcription-path, and moderation-path properties were removed by the openai-java SDK migration in 75fa844, alongside completions-path. Removed the remaining property table rows and the dedicated custom API path sections that only documented those removed properties.
api/chat/dmr-chat.adoc The Docker Model Runner page still used http://localhost:12434/engines without /v1 in 5 OpenAI-compatible occurrences. Updated them to http://localhost:12434/engines/v1, aligning this page with the note added to openai-chat.adoc in 192eb5c.
api/chat/ollama-chat.adoc The OpenAI API compatibility section used http://localhost:11434 without /v1 in 2 occurrences. Updated only the OpenAI-compatible client examples to http://localhost:11434/v1; the native spring.ai.ollama.* base URL is unchanged.
api/chat/groq-chat.adoc The Groq OpenAI-compatible base URL was documented as https://api.groq.com/openai without /v1 in 8 occurrences. Updated them to https://api.groq.com/openai/v1.
api/chat/mistralai-chat.adoc The OpenAI API compatibility section used https://api.mistral.ai without /v1. Updated only the OpenAI-compatible client example to https://api.mistral.ai/v1; the native spring.ai.mistralai.* base URL is unchanged.

All changes are documentation-only, and the affected AsciiDoc structure was verified intact.

Follow-up to #6036.

Follow-up to spring-projects#6036, completing the documentation corrections started in
192eb5c.

Signed-off-by: jewoodev <jewoos15@naver.com>
@ilayaperumalg ilayaperumalg requested a review from sdeleuze May 21, 2026 07:47
@sdeleuze sdeleuze added this to the 2.0.0-M7 milestone May 21, 2026
@sdeleuze sdeleuze added documentation Improvements or additions to documentation openai labels May 21, 2026
@ilayaperumalg
Copy link
Copy Markdown
Member

@jewoodev Thanks for the PR and detailed description!

@ilayaperumalg
Copy link
Copy Markdown
Member

Rebased and merged via d7f3c6c

@jewoodev jewoodev deleted the docs/gh-6036-openai-base-url-followup branch May 21, 2026 09:17
@sdeleuze sdeleuze removed their request for review May 21, 2026 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation openai

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants