mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-05-20 16:26:42 +08:00
93d3deb5e4
## What Fixes #12409. Implements admin CLI support for: - `list vars;` - `show var <name-or-prefix>;` - `set var <name> <value>;` ## Changes - Wire Go CLI variable commands to the admin API. - Support integer and quoted string values in `SET VAR`. - Return variable rows as `data_type`, `name`, `setting_type`, and `value`. - Add exact-name lookup with prefix fallback for `SHOW VAR`. - Validate values by stored data type: `string`, `integer`, `bool`, and `json`. - Keep the legacy Python admin CLI/server behavior aligned. - Update admin CLI docs and add focused tests. ## Verification - `go test -count=1 ./internal/cli` - `python3.12 -m py_compile admin/server/services.py admin/server/routes.py api/db/services/system_settings_service.py admin/client/parser.py admin/client/ragflow_client.py` - Python admin CLI parser smoke test for `SET VAR`, quoted values, `SHOW VAR`, and `LIST VARS`. - Attempted `./run_go_tests.sh`; local environment is missing native tokenizer/linker artifacts: - `internal/cpp/cmake-build-release/librag_tokenizer_c_api.a` - `-lstdc++` Co-authored-by: Jin Hai <haijin.chn@gmail.com>
490 lines
12 KiB
Go
490 lines
12 KiB
Go
//
|
|
// Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
package cli
|
|
|
|
import "fmt"
|
|
|
|
type ResponseIf interface {
|
|
Type() string
|
|
PrintOut()
|
|
TimeCost() float64
|
|
SetOutputFormat(format OutputFormat)
|
|
}
|
|
|
|
type CommonResponse struct {
|
|
Code int `json:"code"`
|
|
Data []map[string]interface{} `json:"data"`
|
|
Message string `json:"message"`
|
|
Duration float64
|
|
OutputFormat OutputFormat
|
|
}
|
|
|
|
func (r *CommonResponse) Type() string {
|
|
return "common"
|
|
}
|
|
|
|
func (r *CommonResponse) TimeCost() float64 {
|
|
return r.Duration
|
|
}
|
|
|
|
func (r *CommonResponse) SetOutputFormat(format OutputFormat) {
|
|
r.OutputFormat = format
|
|
}
|
|
|
|
func (r *CommonResponse) PrintOut() {
|
|
if r.Code == 0 {
|
|
PrintTableSimpleByFormat(r.Data, r.OutputFormat)
|
|
} else {
|
|
fmt.Println("ERROR")
|
|
fmt.Printf("%d, %s\n", r.Code, r.Message)
|
|
}
|
|
}
|
|
|
|
type CommonDataResponse struct {
|
|
Code int `json:"code"`
|
|
Data map[string]interface{} `json:"data"`
|
|
Message string `json:"message"`
|
|
Duration float64
|
|
OutputFormat OutputFormat
|
|
}
|
|
|
|
func (r *CommonDataResponse) Type() string {
|
|
return "show"
|
|
}
|
|
|
|
func (r *CommonDataResponse) TimeCost() float64 {
|
|
return r.Duration
|
|
}
|
|
|
|
func (r *CommonDataResponse) SetOutputFormat(format OutputFormat) {
|
|
r.OutputFormat = format
|
|
}
|
|
|
|
func (r *CommonDataResponse) PrintOut() {
|
|
if r.Code == 0 {
|
|
table := make([]map[string]interface{}, 0)
|
|
table = append(table, r.Data)
|
|
PrintTableSimpleByFormat(table, r.OutputFormat)
|
|
} else {
|
|
fmt.Println("ERROR")
|
|
fmt.Printf("%d, %s\n", r.Code, r.Message)
|
|
}
|
|
}
|
|
|
|
type ListDocumentsResponse struct {
|
|
Code int `json:"code"`
|
|
Data map[string]interface{} `json:"data"`
|
|
Message string `json:"message"`
|
|
Duration float64
|
|
OutputFormat OutputFormat
|
|
}
|
|
|
|
func (r *ListDocumentsResponse) Type() string {
|
|
return "list_documents"
|
|
}
|
|
|
|
func (r *ListDocumentsResponse) TimeCost() float64 {
|
|
return r.Duration
|
|
}
|
|
|
|
func (r *ListDocumentsResponse) SetOutputFormat(format OutputFormat) {
|
|
r.OutputFormat = format
|
|
}
|
|
|
|
func (r *ListDocumentsResponse) PrintOut() {
|
|
if r.Code == 0 {
|
|
total := r.Data["total"].(float64)
|
|
fmt.Printf("Total: %0.0f\n", total)
|
|
docs := r.Data["docs"].([]interface{})
|
|
table := make([]map[string]interface{}, 0)
|
|
for _, doc := range docs {
|
|
table = append(table, doc.(map[string]interface{}))
|
|
}
|
|
PrintTableSimpleByFormat(table, r.OutputFormat)
|
|
} else {
|
|
fmt.Println("ERROR")
|
|
fmt.Printf("%d, %s\n", r.Code, r.Message)
|
|
}
|
|
}
|
|
|
|
type SimpleResponse struct {
|
|
Code int `json:"code"`
|
|
Message string `json:"message"`
|
|
Duration float64
|
|
OutputFormat OutputFormat
|
|
}
|
|
|
|
func (r *SimpleResponse) Type() string {
|
|
return "simple"
|
|
}
|
|
|
|
func (r *SimpleResponse) TimeCost() float64 {
|
|
return r.Duration
|
|
}
|
|
|
|
func (r *SimpleResponse) SetOutputFormat(format OutputFormat) {
|
|
r.OutputFormat = format
|
|
}
|
|
|
|
func (r *SimpleResponse) PrintOut() {
|
|
if r.Code == 0 {
|
|
fmt.Println("SUCCESS")
|
|
} else {
|
|
fmt.Println("ERROR")
|
|
fmt.Printf("%d, %s\n", r.Code, r.Message)
|
|
}
|
|
}
|
|
|
|
type MessageResponse struct {
|
|
Code int `json:"code"`
|
|
Message string `json:"message"`
|
|
Duration float64
|
|
OutputFormat OutputFormat
|
|
}
|
|
|
|
func (r *MessageResponse) Type() string {
|
|
return "message"
|
|
}
|
|
|
|
func (r *MessageResponse) TimeCost() float64 {
|
|
return r.Duration
|
|
}
|
|
|
|
func (r *MessageResponse) SetOutputFormat(format OutputFormat) {
|
|
r.OutputFormat = format
|
|
}
|
|
|
|
func (r *MessageResponse) PrintOut() {
|
|
if r.Code == 0 {
|
|
fmt.Println(r.Message)
|
|
} else {
|
|
fmt.Println("ERROR")
|
|
fmt.Printf("%d, %s\n", r.Code, r.Message)
|
|
}
|
|
}
|
|
|
|
type NonStreamResponse struct {
|
|
Code int `json:"code"`
|
|
ReasoningContent string `json:"reasoning_content"`
|
|
Answer string `json:"answer"`
|
|
Message string `json:"message"`
|
|
Duration float64
|
|
OutputFormat OutputFormat
|
|
}
|
|
|
|
func (r *NonStreamResponse) Type() string {
|
|
return "non_stream_message"
|
|
}
|
|
|
|
func (r *NonStreamResponse) TimeCost() float64 {
|
|
return r.Duration
|
|
}
|
|
|
|
func (r *NonStreamResponse) SetOutputFormat(format OutputFormat) {
|
|
r.OutputFormat = format
|
|
}
|
|
|
|
func (r *NonStreamResponse) PrintOut() {
|
|
if r.Code == 0 {
|
|
if r.ReasoningContent != "" {
|
|
fmt.Printf("Thinking: %s\n", r.ReasoningContent)
|
|
}
|
|
fmt.Printf("Answer: %s\n", r.Answer)
|
|
fmt.Printf("Time: %f\n", r.Duration)
|
|
} else {
|
|
fmt.Println("ERROR")
|
|
fmt.Printf("%d, %s\n", r.Code, r.Message)
|
|
}
|
|
}
|
|
|
|
type StreamMessageResponse struct {
|
|
Code int `json:"code"`
|
|
Message string `json:"message"`
|
|
Duration float64
|
|
OutputFormat OutputFormat
|
|
}
|
|
|
|
func (r *StreamMessageResponse) Type() string {
|
|
return "stream_message"
|
|
}
|
|
|
|
func (r *StreamMessageResponse) TimeCost() float64 {
|
|
return r.Duration
|
|
}
|
|
|
|
func (r *StreamMessageResponse) SetOutputFormat(format OutputFormat) {
|
|
r.OutputFormat = format
|
|
}
|
|
|
|
func (r *StreamMessageResponse) PrintOut() {
|
|
if r.Code == 0 {
|
|
fmt.Printf("Time: %f\n", r.Duration)
|
|
} else {
|
|
fmt.Println("ERROR")
|
|
fmt.Printf("%d, %s\n", r.Code, r.Message)
|
|
}
|
|
}
|
|
|
|
type RegisterResponse struct {
|
|
Code int `json:"code"`
|
|
Message string `json:"message"`
|
|
Duration float64
|
|
OutputFormat OutputFormat
|
|
}
|
|
|
|
func (r *RegisterResponse) Type() string {
|
|
return "register"
|
|
}
|
|
|
|
func (r *RegisterResponse) TimeCost() float64 {
|
|
return r.Duration
|
|
}
|
|
|
|
func (r *RegisterResponse) SetOutputFormat(format OutputFormat) {
|
|
r.OutputFormat = format
|
|
}
|
|
|
|
func (r *RegisterResponse) PrintOut() {
|
|
if r.Code == 0 {
|
|
fmt.Println("Register successfully")
|
|
} else {
|
|
fmt.Println("ERROR")
|
|
fmt.Printf("%d, %s\n", r.Code, r.Message)
|
|
}
|
|
}
|
|
|
|
type BenchmarkResponse struct {
|
|
Code int `json:"code"`
|
|
Duration float64 `json:"duration"`
|
|
SuccessCount int `json:"success_count"`
|
|
FailureCount int `json:"failure_count"`
|
|
Concurrency int
|
|
OutputFormat OutputFormat
|
|
}
|
|
|
|
func (r *BenchmarkResponse) Type() string {
|
|
return "benchmark"
|
|
}
|
|
|
|
func (r *BenchmarkResponse) SetOutputFormat(format OutputFormat) {
|
|
r.OutputFormat = format
|
|
}
|
|
|
|
func (r *BenchmarkResponse) PrintOut() {
|
|
if r.Code != 0 {
|
|
fmt.Printf("ERROR, Code: %d\n", r.Code)
|
|
return
|
|
}
|
|
|
|
iterations := r.SuccessCount + r.FailureCount
|
|
if r.Concurrency == 1 {
|
|
if iterations == 1 {
|
|
fmt.Printf("Latency: %fs\n", r.Duration)
|
|
} else {
|
|
fmt.Printf("Latency: %fs, QPS: %.1f, SUCCESS: %d, FAILURE: %d\n", r.Duration, float64(iterations)/r.Duration, r.SuccessCount, r.FailureCount)
|
|
}
|
|
} else {
|
|
fmt.Printf("Concurrency: %d, Latency: %fs, QPS: %.1f, SUCCESS: %d, FAILURE: %d\n", r.Concurrency, r.Duration, float64(iterations)/r.Duration, r.SuccessCount, r.FailureCount)
|
|
}
|
|
}
|
|
|
|
func (r *BenchmarkResponse) TimeCost() float64 {
|
|
return r.Duration
|
|
}
|
|
|
|
type KeyValueResponse struct {
|
|
Code int `json:"code"`
|
|
Key string `json:"key"`
|
|
Value string `json:"data"`
|
|
Duration float64
|
|
OutputFormat OutputFormat
|
|
}
|
|
|
|
func (r *KeyValueResponse) Type() string {
|
|
return "data"
|
|
}
|
|
|
|
func (r *KeyValueResponse) TimeCost() float64 {
|
|
return r.Duration
|
|
}
|
|
|
|
func (r *KeyValueResponse) SetOutputFormat(format OutputFormat) {
|
|
r.OutputFormat = format
|
|
}
|
|
|
|
func (r *KeyValueResponse) PrintOut() {
|
|
if r.Code == 0 {
|
|
table := make([]map[string]interface{}, 0)
|
|
// insert r.key and r.value into table
|
|
table = append(table, map[string]interface{}{
|
|
"key": r.Key,
|
|
"value": r.Value,
|
|
})
|
|
PrintTableSimpleByFormat(table, r.OutputFormat)
|
|
} else {
|
|
fmt.Println("ERROR")
|
|
fmt.Printf("%d\n", r.Code)
|
|
}
|
|
}
|
|
|
|
type EmbeddingData struct {
|
|
Index int `json:"index"`
|
|
Embedding []float64 `json:"embedding"`
|
|
}
|
|
|
|
type EmbeddingsResponse struct {
|
|
Code int `json:"code"`
|
|
Data []EmbeddingData `json:"data"`
|
|
Message string `json:"message"`
|
|
Duration float64
|
|
OutputFormat OutputFormat
|
|
}
|
|
|
|
func (r *EmbeddingsResponse) Type() string {
|
|
return "common"
|
|
}
|
|
|
|
func (r *EmbeddingsResponse) TimeCost() float64 {
|
|
return r.Duration
|
|
}
|
|
|
|
func (r *EmbeddingsResponse) SetOutputFormat(format OutputFormat) {
|
|
r.OutputFormat = format
|
|
}
|
|
|
|
func (r *EmbeddingsResponse) PrintOut() {
|
|
var data []map[string]interface{}
|
|
for _, embedding := range r.Data {
|
|
data = append(data, map[string]interface{}{
|
|
"index": formatValue(embedding.Index),
|
|
"dimension": len(embedding.Embedding),
|
|
})
|
|
}
|
|
|
|
if r.Code == 0 {
|
|
PrintTableSimpleByFormat(data, r.OutputFormat)
|
|
} else {
|
|
fmt.Println("ERROR")
|
|
fmt.Printf("%d, %s\n", r.Code, r.Message)
|
|
}
|
|
}
|
|
|
|
type SegmentResponse struct {
|
|
Segments []map[string]interface{} `json:"segments"`
|
|
}
|
|
|
|
type TaskResponse struct {
|
|
Code int `json:"code"`
|
|
Data map[string]interface{} `json:"data"`
|
|
Message string `json:"message"`
|
|
Duration float64
|
|
OutputFormat OutputFormat
|
|
}
|
|
|
|
func (r *TaskResponse) Type() string {
|
|
return "task"
|
|
}
|
|
|
|
func (r *TaskResponse) TimeCost() float64 {
|
|
return r.Duration
|
|
}
|
|
|
|
func (r *TaskResponse) SetOutputFormat(format OutputFormat) {
|
|
r.OutputFormat = format
|
|
}
|
|
|
|
func (r *TaskResponse) PrintOut() {
|
|
if r.Code == 0 {
|
|
segmentsRaw := r.Data["segments"].([]interface{})
|
|
segments := make([]map[string]interface{}, len(segmentsRaw))
|
|
for i, v := range segmentsRaw {
|
|
segments[i] = v.(map[string]interface{})
|
|
}
|
|
PrintTableSimpleByFormat(segments, r.OutputFormat)
|
|
} else {
|
|
fmt.Println("ERROR")
|
|
fmt.Printf("%d, %s\n", r.Code, r.Message)
|
|
}
|
|
}
|
|
|
|
// ==================== ContextEngine Commands ====================
|
|
|
|
// ContextListResponse represents the response for ls command
|
|
type ContextListResponse struct {
|
|
Code int `json:"code"`
|
|
Data []map[string]interface{} `json:"data"`
|
|
Message string `json:"message"`
|
|
Duration float64
|
|
OutputFormat OutputFormat
|
|
}
|
|
|
|
func (r *ContextListResponse) Type() string { return "ce_ls" }
|
|
func (r *ContextListResponse) TimeCost() float64 { return r.Duration }
|
|
func (r *ContextListResponse) SetOutputFormat(format OutputFormat) { r.OutputFormat = format }
|
|
func (r *ContextListResponse) PrintOut() {
|
|
if r.Code == 0 {
|
|
PrintTableSimpleByFormat(r.Data, r.OutputFormat)
|
|
} else {
|
|
fmt.Println("ERROR")
|
|
fmt.Printf("%d, %s\n", r.Code, r.Message)
|
|
}
|
|
}
|
|
|
|
// ContextSearchResponse represents the response for search command
|
|
type ContextSearchResponse struct {
|
|
Code int `json:"code"`
|
|
Data []map[string]interface{} `json:"data"`
|
|
Total int `json:"total"`
|
|
Message string `json:"message"`
|
|
Duration float64
|
|
OutputFormat OutputFormat
|
|
}
|
|
|
|
func (r *ContextSearchResponse) Type() string { return "ce_search" }
|
|
func (r *ContextSearchResponse) TimeCost() float64 { return r.Duration }
|
|
func (r *ContextSearchResponse) SetOutputFormat(format OutputFormat) { r.OutputFormat = format }
|
|
func (r *ContextSearchResponse) PrintOut() {
|
|
if r.Code == 0 {
|
|
fmt.Printf("Found %d results:\n", r.Total)
|
|
PrintTableSimpleByFormat(r.Data, r.OutputFormat)
|
|
} else {
|
|
fmt.Println("ERROR")
|
|
fmt.Printf("%d, %s\n", r.Code, r.Message)
|
|
}
|
|
}
|
|
|
|
// ContextCatResponse represents the response for cat command
|
|
type ContextCatResponse struct {
|
|
Code int `json:"code"`
|
|
Content string `json:"content"`
|
|
Message string `json:"message"`
|
|
Duration float64
|
|
OutputFormat OutputFormat
|
|
}
|
|
|
|
func (r *ContextCatResponse) Type() string { return "ce_cat" }
|
|
func (r *ContextCatResponse) TimeCost() float64 { return r.Duration }
|
|
func (r *ContextCatResponse) SetOutputFormat(format OutputFormat) { r.OutputFormat = format }
|
|
func (r *ContextCatResponse) PrintOut() {
|
|
if r.Code == 0 {
|
|
fmt.Println(r.Content)
|
|
} else {
|
|
fmt.Println("ERROR")
|
|
fmt.Printf("%d, %s\n", r.Code, r.Message)
|
|
}
|
|
}
|