Files
ragflow/internal/entity/models/xinference_test.go
tmimmanuel 09a06f1b00 Go: implement provider: Xinference (#14938)
### What problem does this PR solve?

Closes #14808.

Adds a Go model driver for Xinference so self-hosted Xinference chat
models can be used through the Go provider layer instead of falling
through to the dummy driver. Xinference exposes an OpenAI-compatible API
under `/v1`; the driver accepts either a root endpoint such as
`http://127.0.0.1:9997` or an OpenAI-compatible endpoint such as
`http://127.0.0.1:9997/v1` and normalizes it before calling chat or
model-listing routes.

### What is changed?

- Add `internal/entity/models/xinference.go` implementing `ModelDriver`
for Xinference chat.
- Route provider name `xinference` in
`internal/entity/models/factory.go`.
- Add `conf/models/xinference.json` as a local provider config.
- Add focused unit tests in `internal/entity/models/xinference_test.go`.

Initial method coverage:

- `ChatWithMessages`: POST `/v1/chat/completions`.
- `ChatStreamlyWithSender`: SSE streaming from `/v1/chat/completions`.
- `ListModels`: GET `/v1/models`.
- `CheckConnection`: lightweight `ListModels` probe.
- Optional auth: send `Authorization: Bearer <api_key>` only when a
non-empty key is configured, matching Xinference no-auth and
auth-enabled deployments.
- `Balance`, `Embed`, `Rerank`, ASR, TTS, and OCR return `no such
method` for this initial chat-provider PR.

### Type of change

- [x] New Feature (non-breaking change which adds functionality)
- [x] Bug Fix (non-breaking change which fixes an issue)

### Tests

- `go test -vet=off -run TestXinference -count=1
./internal/entity/models/...`
- `go test -vet=off -count=1 ./internal/entity/models/...`

### References

- Xinference docs:
https://inference.readthedocs.io/zh-cn/latest/index.html
- OpenAI-compatible chat usage:
https://inference.readthedocs.io/zh-cn/latest/getting_started/using_xinference.html
- API key auth:
https://inference.readthedocs.io/zh-cn/latest/user_guide/auth_system.html

---------

Co-authored-by: Jin Hai <haijin.chn@gmail.com>
2026-05-19 15:10:13 +08:00

314 lines
10 KiB
Go

package models
import (
"encoding/json"
"io"
"net/http"
"net/http/httptest"
"strings"
"testing"
"time"
)
func newXinferenceForTest(baseURL string) *XinferenceModel {
return NewXinferenceModel(
map[string]string{"default": baseURL},
URLSuffix{
Chat: "v1/chat/completions",
Models: "v1/models",
},
)
}
func withXinferenceIdleTimeout(t *testing.T, d time.Duration) {
t.Helper()
original := xinferenceStreamIdleTimeout
xinferenceStreamIdleTimeout = d
t.Cleanup(func() {
xinferenceStreamIdleTimeout = original
})
}
func TestXinferenceName(t *testing.T) {
x := newXinferenceForTest("http://unused")
if got := x.Name(); got != "xinference" {
t.Errorf("Name()=%q, want %q", got, "xinference")
}
}
func TestNormalizeXinferenceBaseURL(t *testing.T) {
cases := []struct {
in string
want string
}{
{"http://127.0.0.1:9997", "http://127.0.0.1:9997"},
{"http://127.0.0.1:9997/", "http://127.0.0.1:9997"},
{"http://127.0.0.1:9997/v1", "http://127.0.0.1:9997"},
{" http://127.0.0.1:9997/v1/ ", "http://127.0.0.1:9997"},
}
for _, tc := range cases {
if got := normalizeXinferenceBaseURL(tc.in); got != tc.want {
t.Errorf("normalizeXinferenceBaseURL(%q)=%q, want %q", tc.in, got, tc.want)
}
}
}
func TestXinferenceFactoryRoute(t *testing.T) {
driver, err := NewModelFactory().CreateModelDriver("xinference", map[string]string{"default": "http://unused"}, URLSuffix{})
if err != nil {
t.Fatalf("CreateModelDriver: %v", err)
}
if driver.Name() != "xinference" {
t.Errorf("driver.Name()=%q, want xinference", driver.Name())
}
}
func TestXinferenceChatHappyPathNormalizesBaseURLAndOmitsEmptyAuth(t *testing.T) {
var seen map[string]interface{}
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path != "/v1/chat/completions" {
t.Errorf("path=%s, want /v1/chat/completions", r.URL.Path)
}
if got := r.Header.Get("Authorization"); got != "" {
t.Errorf("expected no Authorization header, got %q", got)
}
raw, err := io.ReadAll(r.Body)
if err != nil {
t.Errorf("read body: %v", err)
return
}
if err := json.Unmarshal(raw, &seen); err != nil {
t.Errorf("unmarshal request: %v", err)
return
}
_, _ = io.WriteString(w, `{"choices":[{"message":{"content":"pong"}}]}`)
}))
defer srv.Close()
x := newXinferenceForTest(srv.URL)
maxTokens := 32
temp := 0.2
resp, err := x.ChatWithMessages("qwen2.5-instruct",
[]Message{{Role: "user", Content: "ping"}},
&APIConfig{},
&ChatConfig{MaxTokens: &maxTokens, Temperature: &temp})
if err != nil {
t.Fatalf("ChatWithMessages: %v", err)
}
if resp.Answer == nil || *resp.Answer != "pong" {
t.Fatalf("Answer=%v, want pong", resp.Answer)
}
if seen["stream"] != false {
t.Errorf("stream=%v, want false", seen["stream"])
}
if seen["max_tokens"] != float64(32) {
t.Errorf("max_tokens=%v, want 32", seen["max_tokens"])
}
if seen["temperature"] != 0.2 {
t.Errorf("temperature=%v, want 0.2", seen["temperature"])
}
}
func TestXinferenceChatSendsAuthHeaderWhenKeyProvided(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if got := r.Header.Get("Authorization"); got != "Bearer sk-test" {
t.Errorf("Authorization=%q, want Bearer sk-test", got)
}
_, _ = io.WriteString(w, `{"choices":[{"message":{"content":"ok"}}]}`)
}))
defer srv.Close()
x := newXinferenceForTest(srv.URL + "/v1")
key := "sk-test"
_, err := x.ChatWithMessages("qwen2.5-instruct",
[]Message{{Role: "user", Content: "x"}},
&APIConfig{ApiKey: &key}, nil)
if err != nil {
t.Fatalf("ChatWithMessages: %v", err)
}
}
func TestXinferenceChatExtractsReasoningFields(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
_, _ = io.WriteString(w, `{"choices":[{"message":{
"content":"12",
"reasoning_content":"0.15 * 80 = 12"
}}]}`)
}))
defer srv.Close()
x := newXinferenceForTest(srv.URL)
resp, err := x.ChatWithMessages("qwen3",
[]Message{{Role: "user", Content: "15% of 80?"}},
&APIConfig{}, nil)
if err != nil {
t.Fatalf("ChatWithMessages: %v", err)
}
if resp.ReasonContent == nil || *resp.ReasonContent != "0.15 * 80 = 12" {
t.Errorf("ReasonContent=%v", resp.ReasonContent)
}
}
func TestXinferenceStreamHappyPath(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path != "/v1/chat/completions" {
t.Errorf("path=%s", r.URL.Path)
}
var seen map[string]interface{}
raw, _ := io.ReadAll(r.Body)
_ = json.Unmarshal(raw, &seen)
if seen["stream"] != true {
t.Errorf("stream=%v, want true", seen["stream"])
}
w.Header().Set("Content-Type", "text/event-stream")
_, _ = io.WriteString(w,
`data: {"choices":[{"delta":{"reasoning_content":"step. "}}]}`+"\n"+
`data: {"choices":[{"delta":{"content":"Hello"}}]}`+"\n"+
`data: {"choices":[{"delta":{"content":" world"},"finish_reason":"stop"}]}`+"\n"+
`data: [DONE]`+"\n",
)
}))
defer srv.Close()
x := newXinferenceForTest(srv.URL)
var content []string
var reasoning []string
var sawDone bool
err := x.ChatStreamlyWithSender("qwen2.5-instruct",
[]Message{{Role: "user", Content: "hi"}},
&APIConfig{}, nil,
func(c *string, r *string) error {
if r != nil && *r != "" {
reasoning = append(reasoning, *r)
}
if c != nil && *c == "[DONE]" {
sawDone = true
}
if c != nil && *c != "" && *c != "[DONE]" {
content = append(content, *c)
}
return nil
})
if err != nil {
t.Fatalf("ChatStreamlyWithSender: %v", err)
}
if strings.Join(reasoning, "") != "step. " {
t.Errorf("reasoning=%q", strings.Join(reasoning, ""))
}
if strings.Join(content, "") != "Hello world" {
t.Errorf("content=%q", strings.Join(content, ""))
}
if !sawDone {
t.Error("expected [DONE] callback")
}
}
func TestXinferenceStreamRejectsFalseStreamConfig(t *testing.T) {
x := newXinferenceForTest("http://unused")
stream := false
err := x.ChatStreamlyWithSender("qwen2.5-instruct",
[]Message{{Role: "user", Content: "x"}},
&APIConfig{},
&ChatConfig{Stream: &stream},
func(*string, *string) error { return nil })
if err == nil || !strings.Contains(err.Error(), "stream must be true") {
t.Errorf("expected stream-must-be-true error, got %v", err)
}
}
func TestXinferenceStreamCancelsOnIdle(t *testing.T) {
withXinferenceIdleTimeout(t, 200*time.Millisecond)
hold := make(chan struct{})
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "text/event-stream")
w.WriteHeader(http.StatusOK)
if f, ok := w.(http.Flusher); ok {
_, _ = io.WriteString(w, `data: {"choices":[{"delta":{"content":"hi"}}]}`+"\n")
f.Flush()
}
select {
case <-hold:
case <-r.Context().Done():
}
}))
t.Cleanup(srv.Close)
t.Cleanup(func() { close(hold) })
x := newXinferenceForTest(srv.URL)
err := x.ChatStreamlyWithSender("qwen2.5-instruct",
[]Message{{Role: "user", Content: "x"}},
&APIConfig{}, nil,
func(*string, *string) error { return nil })
if err == nil || !strings.Contains(err.Error(), "stream idle") {
t.Errorf("expected stream-idle error, got %v", err)
}
}
func TestXinferenceListModelsAndCheckConnection(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path != "/v1/models" {
t.Errorf("path=%s, want /v1/models", r.URL.Path)
}
if got := r.Header.Get("Authorization"); got != "Bearer sk-test" {
t.Errorf("Authorization=%q, want Bearer sk-test", got)
}
_, _ = io.WriteString(w, `{"object":"list","data":[{"id":"qwen2.5-instruct"},{"id":"custom-chat"}]}`)
}))
defer srv.Close()
x := newXinferenceForTest(srv.URL)
key := "sk-test"
apiConfig := &APIConfig{ApiKey: &key}
models, err := x.ListModels(apiConfig)
if err != nil {
t.Fatalf("ListModels: %v", err)
}
if strings.Join(models, ",") != "qwen2.5-instruct,custom-chat" {
t.Errorf("models=%v", models)
}
if err := x.CheckConnection(apiConfig); err != nil {
t.Fatalf("CheckConnection: %v", err)
}
}
func TestXinferenceMissingBaseURLFailsClearly(t *testing.T) {
x := NewXinferenceModel(map[string]string{}, URLSuffix{Chat: "v1/chat/completions"})
_, err := x.ChatWithMessages("qwen2.5-instruct",
[]Message{{Role: "user", Content: "x"}},
&APIConfig{}, nil)
if err == nil || !strings.Contains(err.Error(), "missing base URL") {
t.Errorf("expected missing-base-URL error, got %v", err)
}
}
func TestXinferenceUnsupportedMethodsReturnNoSuchMethod(t *testing.T) {
x := newXinferenceForTest("http://unused")
model := "qwen2.5-instruct"
if _, err := x.Embed(&model, []string{"x"}, &APIConfig{}, nil); err == nil || !strings.Contains(err.Error(), "no such method") {
t.Errorf("Embed: expected no such method, got %v", err)
}
if _, err := x.Rerank(&model, "q", []string{"d"}, &APIConfig{}, nil); err == nil || !strings.Contains(err.Error(), "no such method") {
t.Errorf("Rerank: expected no such method, got %v", err)
}
if _, err := x.Balance(&APIConfig{}); err == nil || !strings.Contains(err.Error(), "no such method") {
t.Errorf("Balance: expected no such method, got %v", err)
}
if _, err := x.TranscribeAudio(&model, nil, &APIConfig{}, nil); err == nil || !strings.Contains(err.Error(), "no such method") {
t.Errorf("TranscribeAudio: expected no such method, got %v", err)
}
if err := x.TranscribeAudioWithSender(&model, nil, &APIConfig{}, nil, nil); err == nil || !strings.Contains(err.Error(), "no such method") {
t.Errorf("TranscribeAudioWithSender: expected no such method, got %v", err)
}
if _, err := x.AudioSpeech(&model, nil, &APIConfig{}, nil); err == nil || !strings.Contains(err.Error(), "no such method") {
t.Errorf("AudioSpeech: expected no such method, got %v", err)
}
if err := x.AudioSpeechWithSender(&model, nil, &APIConfig{}, nil, nil); err == nil || !strings.Contains(err.Error(), "no such method") {
t.Errorf("AudioSpeechWithSender: expected no such method, got %v", err)
}
if _, err := x.OCRFile(&model, nil, nil, &APIConfig{}, nil); err == nil || !strings.Contains(err.Error(), "no such method") {
t.Errorf("OCRFile: expected no such method, got %v", err)
}
}