Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

6.6 KB
Raw Blame
package models

import (
	"bytes"
	"context"
	"encoding/json"
	"fmt"
	"io"
	"net"
	"net/http"
	"ragflow/internal/common"
	"strings"
)

// BuiltinModel implements ModelDriver for Builtin (local embedding models via TEI)
type BuiltinModel struct {
	baseURL    string
	model      string
	httpClient *http.Client
}

// NewBuiltinModel creates a new Builtin model instance
func NewBuiltinModel(baseURL, model string) *BuiltinModel {
	if baseURL == "" {
		host := getEnv(common.EnvTEIHost, "tei")
		baseURL = getEnv(common.EnvTEIBaseURL, "http://"+net.JoinHostPort(host, "80"))
	}

	return &BuiltinModel{
		baseURL:    baseURL,
		model:      model,
		httpClient: common.GetSchemeSafeHTTPClient(),
	}
}

func (b *BuiltinModel) Name() string {
	return "builtin"
}

func (b *BuiltinModel) NewInstance(baseURL map[string]string) ModelDriver {
	return &BuiltinModel{
		baseURL: b.baseURL,
		model:   b.model,
	}
}

func (b *BuiltinModel) ChatWithMessages(ctx context.Context, modelName string, messages []Message, apiConfig *APIConfig, chatModelConfig *ChatConfig, modelUsage *common.ModelUsage) (*ChatResponse, error) {
	return nil, fmt.Errorf("builtin model does not support chat")
}

func (b *BuiltinModel) ChatStreamlyWithSender(ctx context.Context, modelName string, messages []Message, apiConfig *APIConfig, modelConfig *ChatConfig, modelUsage *common.ModelUsage, sender func(*string, *string) error) error {
	return fmt.Errorf("builtin model does not support chat")
}

// Embed sends texts to a TEI (Text Embeddings Inference) server and returns embeddings
func (b *BuiltinModel) Embed(ctx context.Context, modelName *string, request EmbedRequest, apiConfig *APIConfig, embeddingConfig *EmbeddingConfig, modelUsage *common.ModelUsage) ([]EmbeddingData, error) {
	if len(request.Texts) == 0 {
		return []EmbeddingData{}, nil
	}

	url := fmt.Sprintf("%s/embed", b.baseURL)

	reqBody := map[string]interface{}{
		"inputs": request.Texts,
	}

	// Add dimension if specified
	if embeddingConfig != nil && embeddingConfig.Dimension > 0 {
		reqBody["dimensions"] = embeddingConfig.Dimension
	}

	jsonData, err := json.Marshal(reqBody)
	if err != nil {
		return nil, fmt.Errorf("failed to marshal request: %w", err)
	}

	req, err := http.NewRequestWithContext(ctx, "POST", url, bytes.NewBuffer(jsonData))
	if err != nil {
		return nil, err
	}

	req.Header.Set("Content-Type", "application/json")
	// Note: TEI server typically doesn't require auth for local deployments

	resp, err := b.httpClient.Do(req)
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

	body, err := io.ReadAll(resp.Body)
	if err != nil {
		return nil, err
	}

	if resp.StatusCode != http.StatusOK {
		return nil, fmt.Errorf("builtin embeddings API error: status %d, body: %s", resp.StatusCode, string(body))
	}

	// TEI returns a simple array of embeddings by default
	var embeddings [][]float64
	if err = json.Unmarshal(body, &embeddings); err != nil {
		return nil, fmt.Errorf("failed to parse TEI response: %w, body: %s", err, string(body))
	}

	result := make([]EmbeddingData, len(embeddings))
	for i, emb := range embeddings {
		result[i] = EmbeddingData{
			Embedding: emb,
			Index:     i,
		}
	}

	return result, nil
}

func (b *BuiltinModel) Rerank(ctx context.Context, modelName *string, request RerankRequest, apiConfig *APIConfig, rerankConfig *RerankConfig, modelUsage *common.ModelUsage) (*RerankResponse, error) {
	return nil, fmt.Errorf("builtin model does not support rerank")
}

func (b *BuiltinModel) TranscribeAudio(ctx context.Context, modelName *string, file *string, apiConfig *APIConfig, asrConfig *ASRConfig, modelUsage *common.ModelUsage) (*ASRResponse, error) {
	return nil, fmt.Errorf("builtin model does not support transcription")
}

func (b *BuiltinModel) TranscribeAudioWithSender(ctx context.Context, modelName *string, file *string, apiConfig *APIConfig, asrConfig *ASRConfig, modelUsage *common.ModelUsage, sender func(*string, *string) error) error {
	return fmt.Errorf("builtin model does not support transcription")
}

func (b *BuiltinModel) AudioSpeech(ctx context.Context, modelName *string, audioContent *string, apiConfig *APIConfig, ttsConfig *TTSConfig, modelUsage *common.ModelUsage) (*TTSResponse, error) {
	return nil, fmt.Errorf("builtin model does not support TTS")
}

func (b *BuiltinModel) AudioSpeechWithSender(ctx context.Context, modelName *string, audioContent *string, apiConfig *APIConfig, ttsConfig *TTSConfig, modelUsage *common.ModelUsage, sender func(*string, *string) error) error {
	return fmt.Errorf("builtin model does not support TTS")
}

func (b *BuiltinModel) OCRFile(ctx context.Context, modelName *string, content []byte, url *string, apiConfig *APIConfig, ocrConfig *OCRConfig, modelUsage *common.ModelUsage) (*OCRFileResponse, error) {
	return nil, fmt.Errorf("builtin model does not support OCR")
}

func (b *BuiltinModel) ParseFile(ctx context.Context, modelName *string, content []byte, url *string, apiConfig *APIConfig, parseFileConfig *ParseFileConfig, modelUsage *common.ModelUsage) (*ParseFileResponse, error) {
	return nil, fmt.Errorf("builtin model does not support parse file")
}

func (b *BuiltinModel) ListModels(ctx context.Context, apiConfig *APIConfig) ([]ListModelResponse, error) {
	return []ListModelResponse{
		{
			Name: b.model,
		},
	}, nil
}

func (b *BuiltinModel) Balance(ctx context.Context, apiConfig *APIConfig) (map[string]interface{}, error) {
	return nil, fmt.Errorf("builtin model does not support balance")
}

func (b *BuiltinModel) CheckConnection(ctx context.Context, apiConfig *APIConfig) error {
	// Try to get model info to verify connection
	_, err := b.Embed(ctx, nil, EmbedRequest{Texts: []string{"test"}}, apiConfig, nil, nil)
	return err
}

func (b *BuiltinModel) ListTasks(ctx context.Context, apiConfig *APIConfig) ([]ListTaskStatus, error) {
	return nil, fmt.Errorf("builtin model does not support tasks")
}

func (b *BuiltinModel) ShowTask(ctx context.Context, taskID string, apiConfig *APIConfig) (*TaskResponse, error) {
	return nil, fmt.Errorf("builtin model does not support tasks")
}

func (b *BuiltinModel) Decide(ctx context.Context, modelName *string, request *DecideRequest, apiConfig *APIConfig, modelUsage *common.ModelUsage) (*DecideResponse, error) {
	return nil, fmt.Errorf("builtin model does not support decide")
}

// GetBuiltinEmbeddingModel returns a Builtin model driver for the given model name
func GetBuiltinEmbeddingModel(modelName string) ModelDriver {
	return NewBuiltinModel("", modelName)
}

// getEnv is a helper to get environment variable with default
func getEnv(key, defaultValue string) string {
	if value := strings.TrimSpace(strings.Replace(common.GetEnv(key), "\\", "/", -1)); value != "" {
		return value
	}
	return defaultValue
}