docs(from_provider): note OpenAI-compatible multi-model gateway base_url - #2504
Closed
seven7763 wants to merge 1 commit into
Closed
docs(from_provider): note OpenAI-compatible multi-model gateway base_url#2504seven7763 wants to merge 1 commit into
seven7763 wants to merge 1 commit into
Conversation
from_provider already forwards base_url to the OpenAI client. Document that the same pattern works with OpenAI-compatible multi-model gateways, using DaoXE (https://api.daoxe.com/v1) as one concrete example. Docs only — no runtime behavior changes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
jxnl
added a commit
that referenced
this pull request
Aug 3, 2026
## Summary - update the wheel/sdist repository metadata from the former `instructor-ai` organization to `567-labs/instructor` - make release preparation reject stale repository metadata before artifacts are built or published - include the compact OpenAI-compatible multi-model gateway `base_url` example from #2504 while preserving contributor authorship - document the package metadata correction in the `1.15.5` notes The package metadata defect was found by inspecting the exact wheel produced by the non-publishing readiness run after #2503 merged. ## Included / superseded - includes #2504 as the canonical compact docs update - supersedes the broader DaoXE-specific docs PR #2436 with the generic eight-line example Both source commits remain separately attributed on this branch. ## Validation - release validator tests: 6 passed - Ruff check and format: passed - scoped test type check: passed - release metadata validation for `1.15.5`: passed - `uv lock --check`: passed - pre-commit hooks: passed - wheel and sdist build: passed - Twine metadata checks: passed - built wheel reports `Project-URL: repository, https://github.com/567-labs/instructor` - DaoXE `api.daoxe.com/v1/models` and `daoxe.com/v1/models` endpoints both return the expected authenticated API response - `git diff --check`: passed ## Skipped - no runtime/provider implementation changes - no dependency changes - no tag, release, PyPI publication, or social post <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Metadata, release script, docs, and tests only—no library runtime or dependency changes. > > **Overview** > Updates **published package metadata** so `project.urls.repository` points at `567-labs/instructor` instead of the old `instructor-ai` org, and records that fix in the **1.15.5** changelog. > > **Release preparation** now reads that URL from `pyproject.toml` and fails fast with a repository URL mismatch if it still points at the wrong GitHub org, with a test covering the stale-URL case. > > **Docs** add a short `from_provider` example for OpenAI-compatible gateways using `base_url` and a gateway API key (DaoXE as the sample endpoint). > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 5ff8c87. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY -->
Collaborator
|
Consolidated into #2505 and merged with the original commit and authorship preserved. The compact OpenAI-compatible gateway example is now on main, so this parallel PR is superseded. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
from_provideralready accepts OpenAI client kwargs such asbase_url. This PR documents that the same pattern works with OpenAI-compatible multi-model gateways — DaoXE (https://api.daoxe.com/v1) is one concrete example.Docs only — no runtime behavior changes.
Test plan
Co-Authored-By: Claude Fable 5 noreply@anthropic.com