Skip to content

Add AISIX AI Gateway integration page - #603

Merged
kacperlukawski merged 2 commits into
deepset-ai:mainfrom
Yilialinn:docs/add-aisix-integration
Sep 17, 2026
Merged

kacperlukawski merged 2 commits into
deepset-ai:mainfrom
Yilialinn:docs/add-aisix-integration

Conversation

@Yilialinn

Copy link
Copy Markdown
Contributor

Summary

This adds an AISIX AI Gateway integration page showing how a Haystack RAG pipeline can send model requests through AISIX with the built-in OpenAIChatGenerator.

The example demonstrates:

  • separate gateway caller and upstream provider credentials;
  • a stable caller-facing model alias backed by two AISIX targets;
  • gateway-owned failover with Haystack client retries disabled for the example; and
  • a complete in-memory BM25 RAG pipeline, rather than only a custom api_base_url snippet.

No new Haystack component, integration package, or dependency is introduced.

Validation

  • Tested with Haystack 3.1.1 and ghcr.io/api7/aisix:1.2.0.
  • Validated the AISIX resource schema with aisix validate.
  • Ran the documented Python example end to end against a deterministic OpenAI-compatible fixture.
  • Confirmed that a primary HTTP 503 caused AISIX to use the backup target and that an invalid caller key returned HTTP 401 without reaching the upstream fixture.

Scope

The change is limited to one integration page. It adds no package, logo, generated asset, or runtime code.

Disclosure: I work at API7.ai, which maintains AISIX. AISIX is an independent Apache-2.0-licensed open-source project and is not an Apache Software Foundation project.

Signed-off-by: Yilia Lin <Yilialin@apache.org>
@Yilialinn
Yilialinn requested a review from a team as a code owner September 15, 2026 02:28
@vercel

vercel Bot commented Sep 15, 2026

Copy link
Copy Markdown

@Yilialinn is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

@vercel

vercel Bot commented Sep 17, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
haystack-integrations Ready Ready Preview Sep 17, 2026 4:19pm UTC

Request Review

Copilot AI left a comment

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.

馃煝 Approval recommended

No unresolved review issues were identified.

Pull request overview

Adds an AISIX AI Gateway integration guide for Haystack鈥檚 OpenAIChatGenerator, including credential separation, failover, and an end-to-end BM25 RAG example.

Changes:

  • Documents AISIX installation and configuration.
  • Explains gateway-owned retries and failover.
  • Adds a complete Haystack RAG example.
File summaries
File Summary
integrations/aisix.md New AISIX integration documentation and example.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Lite

馃挕 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread integrations/aisix.md Outdated
@kacperlukawski
kacperlukawski self-requested a review September 17, 2026 16:21

@kacperlukawski kacperlukawski left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you, @Yilialinn I made a small change and should be ready to merge

@kacperlukawski
kacperlukawski merged commit 2743dad into deepset-ai:main Sep 17, 2026
1 check failed
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.

3 participants