docs: add MLflow AI Gateway documentation page#11025
Open
PattaraS wants to merge 4 commits intodeepset-ai:mainfrom
Open
docs: add MLflow AI Gateway documentation page#11025PattaraS wants to merge 4 commits intodeepset-ai:mainfrom
PattaraS wants to merge 4 commits intodeepset-ai:mainfrom
Conversation
Adds a documentation page showing how to use OpenAIChatGenerator with MLflow AI Gateway's OpenAI-compatible endpoint via the api_base_url parameter. Includes standalone, pipeline, and streaming examples.
|
@PattaraS is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
|
|
The mlflow.deployments.get_deploy_client API is deprecated. Replace with the current recommended approaches: OpenAI SDK with base_url, and plain HTTP requests via the MLflow Invocations API.
Adds a documentation page showing how to use OpenAIChatGenerator with MLflow AI Gateway's OpenAI-compatible endpoint via the api_base_url parameter. Includes standalone, pipeline, streaming examples, and alternative direct query methods via OpenAI SDK and HTTP. Also adds release note and sidebar entry.
Add screenshots for endpoint creation, budget tracking, usage dashboard, trace list, and trace detail views.
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.
Related Issues
N/A — new documentation page for MLflow AI Gateway integration.
Proposed Changes:
Adds a documentation page (
mlflowgatewaychatgenerator.mdx) showing how to use the built-inOpenAIChatGeneratorwith MLflow AI Gateway as an LLM proxy.Files changed:
docs-website/docs/pipeline-components/generators/mlflowgatewaychatgenerator.mdx— new page with standalone, pipeline, streaming examples, and alternative direct query methodsdocs-website/sidebars.js— sidebar entry for the new pagereleasenotes/notes/add-mlflow-gateway-docs-*.yaml— release noteMLflow AI Gateway (MLflow ≥ 3.0) is a database-backed LLM proxy that provides a unified OpenAI-compatible API across 20+ providers with encrypted secrets management, fallback/retry, traffic splitting, and usage tracing — all configured through the MLflow UI. Since it's OpenAI-compatible, it works with
OpenAIChatGeneratorviaapi_base_urlwith no extra packages.How did you test it?
OpenAIChatGeneratorworks with MLflow Gateway usingapi_base_url="http://localhost:5000/gateway/openai/v1"against a running MLflow servernvidiachatgenerator.mdx)Notes for the reviewer
ignore-for-release-noteslabelAI Disclosure
This pull request was AI-assisted by Claude. All content was reviewed and validated by a human contributor.
Checklist
docs: