neo4j / neo4j/neo4j-graphrag-python
[DOC]: OpenAILLM base_url is the /v1 root for OpenAI-compat hosts
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.3k
- Forks
- 246
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 11
Description
Suggested Changes
Document OpenAILLM against an OpenAI-compatible Chat Completions host: base_url is the /v1 root, model_name is that host's catalog id.
A host whose public catalog is GET https://api.pzero.studio/v1/models (no key) fits:
from neo4j_graphrag.llm import OpenAILLM
llm = OpenAILLM(
model_name="deepseek-v4-flash",
api_key="<Bearer key for that host>",
base_url="https://api.pzero.studio/v1",
)
Do not use AzureOpenAILLM (that constructs AzureOpenAI). OpenAILLM posts Chat Completions (client.chat.completions.create). Keep OpenAIEmbeddings on a real embedding host. Do not paste /v1/chat/completions as base_url. Override example gpt-5 with a catalog id from that host.
Not asking for a first-party provider. OpenAILLM plus base_url is enough.
Additional Info
Verified against src/neo4j_graphrag/llm/openai_llm.py (OpenAILLM.__init__ forwards base_url to both SDK clients).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading src/neo4j_graphrag/llm/openai_llm.py, especially OpenAILLM.init, to confirm how base_url is forwarded. Update the relevant documentation with the OpenAI-compatible Chat Completions example, explaining that base_url is the host's /v1 root and model_name is its catalog id; done when the documented example and cautions match the verified behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 78/100