Skip to content

docs: OpenAI-compatible multi-model gateway example (DaoXE)#561

Open
seven7763 wants to merge 1 commit into
neo4j:mainfrom
seven7763:docs/daoxe-openai-compatible-gateway
Open

docs: OpenAI-compatible multi-model gateway example (DaoXE)#561
seven7763 wants to merge 1 commit into
neo4j:mainfrom
seven7763:docs/daoxe-openai-compatible-gateway

Conversation

@seven7763

@seven7763 seven7763 commented Jul 15, 2026

Copy link
Copy Markdown

Description

Add README example showing OpenAILLM / OpenAIEmbeddings with OpenAI client kwargs (base_url, api_key) pointed at OpenAI-compatible multi-model gateway. Example uses DaoXE (https://daoxe.com/v1), account-scoped model IDs, Chat Completions / embeddings paths. Same kwargs path already used for custom OpenAI clients — docs only, no code change.

Note: DaoXE not available in mainland China. Contributor affiliated with DaoXE.

Type of Change

  • New feature
  • Bug fix
  • Breaking change
  • Documentation update
  • Project configuration change

Complexity

Complexity: Low

How Has This Been Tested?

  • Manual tests (README renders)

Checklist

The following requirements should have been met (depending on the changes in the branch):

  • Documentation has been updated
  • Unit tests have been updated
  • E2E tests have been updated
  • Examples have been updated
  • New files have copyright header
  • CLA (https://neo4j.com/developer/cla/) has been signed
  • CHANGELOG.md updated if appropriate

Show OpenAILLM/OpenAIEmbeddings with base_url https://daoxe.com/v1 and
account-scoped model IDs.

Signed-off-by: seven7763 <246023385+seven7763@users.noreply.github.com>
@seven7763
seven7763 requested a review from a team as a code owner July 15, 2026 12:55
Comment thread README.md
asyncio.run(kg_builder.run_async(text=text))
driver.close()

### OpenAI-compatible multi-model gateways

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With your change, the README would promote a specific third-party service (DaoXE) with a direct URL. This is unusual for an open-source library README. A more neutral approach would use a generic placeholder like https://your-gateway.example.com/v1 and mention well-known alternatives (LiteLLM, vLLM, Ollama, Azure OpenAI, etc.) rather than one lesser-known commercial gateway.

Comment thread README.md
- Model IDs are account-scoped; do not hardcode a static public catalog.
- Chat Completions / embeddings paths only for this snippet.
- DaoXE is not available in mainland China.
- Contributor disclosure: this example was contributed by a DaoXE affiliate.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reads as an advertisement. It's atypical for library documentation to include affiliate disclosures inline

Comment thread README.md

- Model IDs are account-scoped; do not hardcode a static public catalog.
- Chat Completions / embeddings paths only for this snippet.
- DaoXE is not available in mainland China.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a product-specific limitation note that has no place in generic library doc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants