Files
ragflow/internal/entity/models/paddleocr.go
ghost b2053cc3c7 feat(go-models): add PPIO provider driver (#15099)
### What problem does this PR solve?

Closes #15089.

Adds PPIO support to the Go model-provider layer so PPIO instances can
be routed through the Go API server with the same OpenAI-compatible
chat, streaming, model listing, and connection-check flow used by other
SaaS providers.

### Type of change

- [x] New Feature (non-breaking change which adds functionality)

## Summary

- Added a PPIO Go model driver.
- Added the PPIO provider catalog and default OpenAI-compatible API URL.
- Registered PPIO in the model factory.
- Added focused provider and provider-manager tests.

## What changed

- Implemented chat completions, SSE streaming, ListModels, and
CheckConnection for PPIO.
- Covered request shape, stream termination, reasoning fallback, model
listing, custom base URLs, safe transport setup, unsupported methods,
and provider config loading.
- Kept the provider catalog aligned with the existing RAGFlow PPIO
factory model set.
- Cleaned up pre-existing Go model package validation blockers so the
scoped provider tests can run normally with vet enabled.

## Why

The existing Python/provider catalog path includes PPIO, but the Go
model-provider layer did not have a PPIO driver, so the Go API server
could not instantiate or use PPIO as requested in #15089.
2026-05-22 11:52:18 +08:00

301 lines
8.7 KiB
Go

package models
import (
"bufio"
"bytes"
"encoding/json"
"fmt"
"io"
"mime/multipart"
"net/http"
"strings"
"time"
)
type PaddleOCRModel struct {
BaseURL map[string]string
URLSuffix URLSuffix
httpClient *http.Client
}
func NewPaddleOCRModel(baseURL map[string]string, urlSuffix URLSuffix) *PaddleOCRModel {
return &PaddleOCRModel{
BaseURL: baseURL,
URLSuffix: urlSuffix,
httpClient: &http.Client{
Timeout: 120 * time.Second,
Transport: &http.Transport{
MaxIdleConns: 100,
MaxIdleConnsPerHost: 10,
IdleConnTimeout: 90 * time.Second,
DisableCompression: false,
},
},
}
}
func (p PaddleOCRModel) NewInstance(baseURL map[string]string) ModelDriver {
return &PaddleOCRModel{
BaseURL: baseURL,
URLSuffix: p.URLSuffix,
httpClient: &http.Client{
Timeout: 120 * time.Second,
Transport: &http.Transport{
MaxIdleConns: 100,
MaxIdleConnsPerHost: 10,
IdleConnTimeout: 90 * time.Second,
DisableCompression: false,
},
},
}
}
func (p *PaddleOCRModel) Name() string {
return "paddle_ocr"
}
func (p *PaddleOCRModel) ChatWithMessages(modelName string, messages []Message, apiConfig *APIConfig, chatModelConfig *ChatConfig) (*ChatResponse, error) {
return nil, fmt.Errorf("%s, no such method", p.Name())
}
func (p *PaddleOCRModel) ChatStreamlyWithSender(modelName string, messages []Message, apiConfig *APIConfig, modelConfig *ChatConfig, sender func(*string, *string) error) error {
return fmt.Errorf("%s, no such method", p.Name())
}
func (p *PaddleOCRModel) Embed(modelName *string, texts []string, apiConfig *APIConfig, embeddingConfig *EmbeddingConfig) ([]EmbeddingData, error) {
return nil, fmt.Errorf("%s, no such method", p.Name())
}
func (p *PaddleOCRModel) Rerank(modelName *string, query string, documents []string, apiConfig *APIConfig, rerankConfig *RerankConfig) (*RerankResponse, error) {
return nil, fmt.Errorf("%s, no such method", p.Name())
}
func (p *PaddleOCRModel) TranscribeAudio(modelName *string, file *string, apiConfig *APIConfig, asrConfig *ASRConfig) (*ASRResponse, error) {
return nil, fmt.Errorf("%s, no such method", p.Name())
}
func (p *PaddleOCRModel) TranscribeAudioWithSender(modelName *string, file *string, apiConfig *APIConfig, asrConfig *ASRConfig, sender func(*string, *string) error) error {
return fmt.Errorf("%s, no such method", p.Name())
}
func (p *PaddleOCRModel) AudioSpeech(modelName *string, audioContent *string, apiConfig *APIConfig, ttsConfig *TTSConfig) (*TTSResponse, error) {
return nil, fmt.Errorf("%s, no such method", p.Name())
}
func (p *PaddleOCRModel) AudioSpeechWithSender(modelName *string, audioContent *string, apiConfig *APIConfig, ttsConfig *TTSConfig, sender func(*string, *string) error) error {
return fmt.Errorf("%s, no such method", p.Name())
}
type paddleSubmitResponse struct {
Data struct {
JobId string `json:"jobId"`
} `json:"data"`
}
type paddlePollResponse struct {
Data struct {
State string `json:"state"`
ErrorMsg string `json:"errorMsg"`
ResultUrl struct {
JsonUrl string `json:"jsonUrl"`
} `json:"resultUrl"`
} `json:"data"`
}
type paddleJsonlLine struct {
Result struct {
LayoutParsingResults []struct {
Markdown struct {
Text string `json:"text"`
} `json:"markdown"`
} `json:"layoutParsingResults"`
} `json:"result"`
}
func (p *PaddleOCRModel) OCRFile(modelName *string, content []byte, fileURL *string, apiConfig *APIConfig, ocrConfig *OCRConfig) (*OCRFileResponse, error) {
if (content == nil || len(content) == 0) && (fileURL == nil || *fileURL == "") {
return nil, fmt.Errorf("content and fileURL cannot be both empty")
}
if apiConfig == nil || apiConfig.ApiKey == nil || *apiConfig.ApiKey == "" {
return nil, fmt.Errorf("api key is required")
}
var region = "default"
if apiConfig.Region != nil && *apiConfig.Region != "" {
region = *apiConfig.Region
}
url := fmt.Sprintf("%s/%s", p.BaseURL[region], p.URLSuffix.OCR)
optionalPayload := map[string]bool{
"useDocOrientationClassify": false,
"useDocUnwarping": false,
"useChartRecognition": false,
}
optBytes, _ := json.Marshal(optionalPayload)
var req *http.Request
var err error
if fileURL != nil && strings.HasPrefix(*fileURL, "http") {
reqData := map[string]interface{}{
"fileUrl": *fileURL,
"model": *modelName,
"optionalPayload": optionalPayload,
}
jsonData, err := json.Marshal(reqData)
if err != nil {
return nil, fmt.Errorf("failed to marshal json: %w", err)
}
req, err = http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
req.Header.Set("Content-Type", "application/json")
} else {
body := &bytes.Buffer{}
writer := multipart.NewWriter(body)
_ = writer.WriteField("model", *modelName)
_ = writer.WriteField("optionalPayload", string(optBytes))
part, err := writer.CreateFormFile("file", "document.pdf")
if err != nil {
return nil, fmt.Errorf("failed to create form file: %w", err)
}
part.Write(content)
writer.Close()
req, err = http.NewRequest("POST", url, body)
req.Header.Set("Content-Type", writer.FormDataContentType())
}
req.Header.Set("Authorization", fmt.Sprintf("bearer %s", *apiConfig.ApiKey))
resp, err := p.httpClient.Do(req)
if err != nil {
return nil, fmt.Errorf("failed to submit job: %w", err)
}
defer resp.Body.Close()
respBody, _ := io.ReadAll(resp.Body)
if resp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("submit job failed: %s", string(respBody))
}
var submitResp paddleSubmitResponse
if err := json.Unmarshal(respBody, &submitResp); err != nil {
return nil, fmt.Errorf("failed to parse submit response: %w", err)
}
jobId := submitResp.Data.JobId
if jobId == "" {
return nil, fmt.Errorf("failed to get jobId from response")
}
pollUrl := fmt.Sprintf("%s/%s", url, jobId)
var jsonlUrl string
for {
time.Sleep(3 * time.Second)
pollReq, _ := http.NewRequest("GET", pollUrl, nil)
pollReq.Header.Set("Authorization", fmt.Sprintf("bearer %s", *apiConfig.ApiKey))
pollResp, err := p.httpClient.Do(pollReq)
if err != nil {
return nil, fmt.Errorf("failed to poll job status: %w", err)
}
pollBody, _ := io.ReadAll(pollResp.Body)
pollResp.Body.Close()
if pollResp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("poll job failed: %s", string(pollBody))
}
var pollData paddlePollResponse
if err = json.Unmarshal(pollBody, &pollData); err != nil {
return nil, fmt.Errorf("failed to parse poll response: %w", err)
}
// end if 'done' or 'failed'
state := pollData.Data.State
if state == "done" {
jsonlUrl = pollData.Data.ResultUrl.JsonUrl
break
} else if state == "failed" {
return nil, fmt.Errorf("ocr job failed on server: %s", pollData.Data.ErrorMsg)
}
}
if jsonlUrl == "" {
return nil, fmt.Errorf("job done but jsonl url is empty")
}
resReq, err := http.NewRequest("GET", jsonlUrl, nil)
if err != nil {
return nil, fmt.Errorf("failed to create request for jsonl: %w", err)
}
resResp, err := p.httpClient.Do(resReq)
if err != nil {
return nil, fmt.Errorf("failed to download jsonl result: %w", err)
}
defer resResp.Body.Close()
if resResp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("failed to download jsonl, status: %d", resResp.StatusCode)
}
var fullMarkdown strings.Builder
scanner := bufio.NewScanner(resResp.Body)
for scanner.Scan() {
line := strings.TrimSpace(scanner.Text())
if line == "" {
continue
}
var lineData paddleJsonlLine
if err := json.Unmarshal([]byte(line), &lineData); err != nil {
continue
}
for _, layoutRes := range lineData.Result.LayoutParsingResults {
fullMarkdown.WriteString(layoutRes.Markdown.Text)
fullMarkdown.WriteString("\n\n")
}
}
if err = scanner.Err(); err != nil {
return nil, fmt.Errorf("error reading jsonl: %w", err)
}
extractedText := strings.TrimSpace(fullMarkdown.String())
return &OCRFileResponse{Text: &extractedText}, nil
}
func (p *PaddleOCRModel) ParseFile(modelName *string, content []byte, url *string, apiConfig *APIConfig, parseFileConfig *ParseFileConfig) (*ParseFileResponse, error) {
return nil, fmt.Errorf("%s, no such method", p.Name())
}
func (p *PaddleOCRModel) ListModels(apiConfig *APIConfig) ([]string, error) {
return nil, fmt.Errorf("%s, no such method", p.Name())
}
func (p *PaddleOCRModel) Balance(apiConfig *APIConfig) (map[string]interface{}, error) {
return nil, fmt.Errorf("%s, no such method", p.Name())
}
func (p *PaddleOCRModel) CheckConnection(apiConfig *APIConfig) error {
return fmt.Errorf("%s, no such method", p.Name())
}
func (p *PaddleOCRModel) ListTasks(apiConfig *APIConfig) ([]ListTaskStatus, error) {
return nil, fmt.Errorf("%s, no such method", p.Name())
}
func (p *PaddleOCRModel) ShowTask(taskID string, apiConfig *APIConfig) (*TaskResponse, error) {
return nil, fmt.Errorf("%s, no such method", p.Name())
}