ContextQMD
Back to Weknora

API 参考：模型与初始化

website-docs/04-api/02-api-model-system.md

0.7.213.8 KB
Original Source

API 参考：模型与初始化

路由注册：internal/router/router.go 的 RegisterModelRoutes、RegisterInitializationRoutes、RegisterEvaluationRoutes、RegisterWeKnoraCloudRoutes。Handler：internal/handler/model.go、internal/handler/model_credentials.go、internal/handler/initialization.go、internal/handler/evaluation.go、internal/handler/weknoracloud.go。

系统信息与系统管理（/system、/system/admin）接口见系统与平台管理。

模型（/api/v1/models）

API key：manage_models 或 full-access。

GET /api/v1/models/providers

用途：模型厂商列表。权限：Viewer+。查询参数：model_type（可选：chat/embedding/rerank/vllm/asr）。Handler: internal/handler/model.go

响应：200 {"success":true,"data":[{value,label,description,defaultUrls,modelTypes}]}

bash
curl "$BASE/api/v1/models/providers?model_type=chat" -H "Authorization: Bearer $TOKEN"

POST /api/v1/models

用途：创建模型。权限：Admin+。

字段类型必填说明
namestring是（binding:"required"）模型名
display_namestring否显示名
typestring是（binding:"required"）模型类型
sourcestring是（binding:"required"）来源（local/remote…）
descriptionstring否描述
parametersobject是（binding:"required"）连接参数（base_url 等；密钥经 credentials 子资源管理）

响应：201 {"success":true,"data":{ModelResponse}}（id,name,type,source,parameters,is_default,is_builtin,status,credentials,...）

bash
curl -X POST $BASE/api/v1/models -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' \
  -d '{"name":"gpt-4o-mini","type":"chat","source":"remote","parameters":{"base_url":"https://api.openai.com/v1"}}'

GET /api/v1/models

用途：模型列表。权限：Viewer+。

响应：200 {"success":true,"data":[ModelResponse]}

bash
curl $BASE/api/v1/models -H "Authorization: Bearer $TOKEN"

GET /api/v1/models/:id

用途：模型详情。权限：Viewer+。

响应：200 {"success":true,"data":{ModelResponse}}

bash
curl $BASE/api/v1/models/m-1 -H "Authorization: Bearer $TOKEN"

POST /api/v1/models/:id/debug

用途：调试已保存模型（发起真实上游调用，产生费用）。权限：Admin+。form-data 字段：input（≤64KB）、options（JSON 编码调试选项）、documents（JSON 数组，≤100 条）、file（可选）。

响应：200 {"success":true,"data":{"ok",elapsed_ms,request,raw_response,observations,error}}

bash
curl -X POST $BASE/api/v1/models/m-1/debug -H "Authorization: Bearer $TOKEN" -F 'input=你好'

PUT /api/v1/models/:id

用途：更新模型（内置模型由服务层限定 SystemAdmin）。权限：Admin+ 或 SystemAdmin（AdminOrSystemAdmin）。请求体：name、display_name（指针）、description、parameters（保留已存密钥）、source、type（均可选）。

响应：200 {"success":true,"data":{ModelResponse}}

bash
curl -X PUT $BASE/api/v1/models/m-1 -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"display_name":"GPT-4o mini"}'

DELETE /api/v1/models/:id

用途：删除模型。权限：Admin+。

响应：200 {"success":true,"message":"Model deleted"}

bash
curl -X DELETE $BASE/api/v1/models/m-1 -H "Authorization: Bearer $TOKEN"

PUT /api/v1/models/:id/credentials

用途：设置模型密钥（密钥不经主 PUT 传输）。权限：Admin+ 或 SystemAdmin。Handler: internal/handler/model_credentials.go

字段类型必填说明
api_key*string否新 API Key
app_secret*string否新 App Secret（两者均省略时仅返回状态）

响应：200 {"success":true,"data":{"fields":{"api_key":{"configured":bool},"app_secret":{"configured":bool}}}}

bash
curl -X PUT $BASE/api/v1/models/m-1/credentials -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"api_key":"sk-..."}'

DELETE /api/v1/models/:id/credentials/:field

用途：删除某个密钥字段（api_key 或 app_secret）。权限：Admin+ 或 SystemAdmin。

响应：204 No Content

bash
curl -X DELETE $BASE/api/v1/models/m-1/credentials/api_key -H "Authorization: Bearer $TOKEN"

WeKnoraCloud

Handler: internal/handler/weknoracloud.go。API key：manage_models/full。

POST /api/v1/weknoracloud/credentials

用途：保存 WeKnoraCloud SaaS 凭证。权限：Admin+。请求体：{"app_id":"...","app_secret":"..."}（均 binding:"required"）。

响应：200 {"success":true,"message":"凭证保存成功"}

bash
curl -X POST $BASE/api/v1/weknoracloud/credentials -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"app_id":"app","app_secret":"secret"}'

GET /api/v1/models/weknoracloud/status

用途：WeKnoraCloud 就绪状态探测。权限：Viewer+。

响应：200 服务状态对象。

bash
curl $BASE/api/v1/models/weknoracloud/status -H "Authorization: Bearer $TOKEN"

初始化（/api/v1/initialization）

Handler: internal/handler/initialization.go。KB 配置类：API key manage_kbs（写）/retrieve（读）；模型检测类：manage_models（均可 full-access）。

GET /api/v1/initialization/config/:kbId

用途：读取 KB 当前模型/解析配置。权限：Viewer+，KB read。

响应：200 {"success":true,"data":{"hasFiles",llm,embedding,rerank,multimodal,documentSplitting,nodeExtract,questionGeneration}}

bash
curl $BASE/api/v1/initialization/config/kb-1 -H "Authorization: Bearer $TOKEN"

POST /api/v1/initialization/initialize/:kbId

用途：初始化 KB 的模型与解析配置（首次配置向导）。权限：KB 创建者 OR Admin+，KB write。

主要字段（InitializationRequest）：

字段类型必填说明
llm.source / llm.modelNamestring是LLM 来源与模型名
llm.baseUrl / llm.apiKeystring否连接参数
embedding.source / embedding.modelNamestring是Embedding 模型
embedding.baseUrl / embedding.apiKey / embedding.dimension—否连接与维度
rerank.enabled + rerank.modelName/baseUrl/apiKey—否Rerank 配置
multimodal.enabled + multimodal.vlm.* + multimodal.storageType + `multimodal.cos.*minio.*`—否
documentSplitting.chunkSize / separatorsint / []string是分块配置
documentSplitting.chunkOverlapint否重叠
nodeExtract.*—否图谱抽取（enabled/text/tags/nodes/relations）
questionGeneration.*—否问题生成（enabled/questionCount）

响应：200 {"success":true,"message":"知识库配置更新成功","data":{"models":[Model],"knowledge_base":{KnowledgeBase}}}

bash
curl -X POST $BASE/api/v1/initialization/initialize/kb-1 -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"llm":{"source":"remote","modelName":"gpt-4o-mini"},"embedding":{"source":"remote","modelName":"text-embedding-3-small"},"documentSplitting":{"chunkSize":512,"separators":["\n\n"]}}'

PUT /api/v1/initialization/config/:kbId

用途：更新 KB 模型/分块配置（KBModelConfigRequest：llmModelId 必填，embeddingModelId、vlm_config、asr_config、documentSplitting.*、multimodal.enabled、storageProvider、storageBackendId、nodeExtract.*、questionGeneration.* 可选）。权限：KB 创建者 OR Admin+，KB write。

响应：200 {"success":true,"message":"配置更新成功"}

bash
curl -X PUT $BASE/api/v1/initialization/config/kb-1 -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"llmModelId":"m-1","embeddingModelId":"m-2"}'

GET /api/v1/initialization/ollama/status

用途：Ollama 可用性探测。权限：Viewer+。

响应：200 {"success":true,"data":{"available","version","baseUrl","error"}}

bash
curl $BASE/api/v1/initialization/ollama/status -H "Authorization: Bearer $TOKEN"

GET /api/v1/initialization/ollama/models

用途：列出本地 Ollama 模型。权限：Viewer+。

响应：200 {"success":true,"data":{"models":[...]}}

bash
curl $BASE/api/v1/initialization/ollama/models -H "Authorization: Bearer $TOKEN"

POST /api/v1/initialization/ollama/models/check

用途：批量检查模型是否已存在。权限：Admin+。请求体：{"models":["llama3"]}（binding:"required"）。

响应：200 {"success":true,"data":{"models":{"llama3":true}}}

bash
curl -X POST $BASE/api/v1/initialization/ollama/models/check -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"models":["llama3"]}'

POST /api/v1/initialization/ollama/models/download

用途：拉取 Ollama 模型（异步任务）。权限：Admin+。请求体：{"modelName":"llama3"}（binding:"required"）。

响应：200 {"success":true,"data":{"taskId","modelName","status","progress"}}

bash
curl -X POST $BASE/api/v1/initialization/ollama/models/download -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"modelName":"llama3"}'

GET /api/v1/initialization/ollama/download/progress/:taskId

用途：下载任务进度。权限：Viewer+。

响应：200 {"success":true,"data":{id,modelName,status,progress,message,startTime,endTime}}

bash
curl $BASE/api/v1/initialization/ollama/download/progress/task-1 -H "Authorization: Bearer $TOKEN"

GET /api/v1/initialization/ollama/download/tasks

用途：全部下载任务列表。权限：Viewer+。

响应：200 {"success":true,"data":[DownloadTask]}

bash
curl $BASE/api/v1/initialization/ollama/download/tasks -H "Authorization: Bearer $TOKEN"

模型连通性检测（均 POST，权限 Admin+）

请求体统一为 ModelTestRequest：

字段类型必填说明
sourcestring否默认 remote
modelNamestring是模型名
baseUrl / apiKey / appSecretstring否连接参数
provider / interfaceTypestring否厂商/接口类型
dimensionint否embedding 维度
customHeaders / extraConfigmap否扩展
modelIdstring否从已存模型取密钥
端点用途响应 data
POST /api/v1/initialization/remote/checkLLM 远程连通性{available,message}
POST /api/v1/initialization/embedding/testEmbedding 测试{available,message,dimension}
POST /api/v1/initialization/rerank/checkRerank 测试{available,message}
POST /api/v1/initialization/asr/checkASR 测试{available,message}
bash
curl -X POST $BASE/api/v1/initialization/remote/check -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"modelName":"gpt-4o-mini","baseUrl":"https://api.openai.com/v1","apiKey":"sk-..."}'

POST /api/v1/initialization/multimodal/test

用途：多模态（VLM+图床）端到端测试。权限：Admin+。multipart 字段：image（必填）、vlm_model、vlm_base_url（必填）、vlm_api_key、vlm_interface_type、storage_type（cos|minio，必填）及对应 cos_*/minio_* 字段、chunk_size、chunk_overlap、separators。

响应：200 {"success":true,"data":{"success","caption","ocr","processing_time"}}

bash
curl -X POST $BASE/api/v1/initialization/multimodal/test -H "Authorization: Bearer $TOKEN" \
  -F '[email protected]' -F 'vlm_model=qwen-vl' -F 'vlm_base_url=http://x' -F 'storage_type=minio'

POST /api/v1/initialization/extract/text-relation

用途：文本图谱抽取测试。权限：Admin+。请求体：text（必填，≤5000 字符）、tags（必填，至少一个）、model_id（必填）。

响应：200 {"success":true,"data":{"nodes":[GraphNode],"relations":[GraphRelation]}}

bash
curl -X POST $BASE/api/v1/initialization/extract/text-relation -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"text":"小明在腾讯工作","tags":["人物","公司"],"model_id":"m-1"}'

POST /api/v1/initialization/extract/fabri-tag

用途：生成示例标签。权限：Admin+。无请求体。

响应：200 {"success":true,"data":{"tags":[...]}}

bash
curl -X POST $BASE/api/v1/initialization/extract/fabri-tag -H "Authorization: Bearer $TOKEN"

POST /api/v1/initialization/extract/fabri-text

用途：按标签生成示例文本。权限：Admin+。请求体：{"tags":[...],"model_id":"m-1"}（model_id 必填）。

响应：200 {"success":true,"data":{"text":"..."}}

bash
curl -X POST $BASE/api/v1/initialization/extract/fabri-text -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"model_id":"m-1","tags":["人物"]}'

评估（/api/v1/evaluation）

Handler: internal/handler/evaluation.go。API key：run_evaluations/full。

POST /api/v1/evaluation

用途：发起评估任务（驱动 LLM 调用，产生费用）。权限：Admin+。

字段类型必填说明
dataset_idstring否数据集 ID
knowledge_base_idstring否目标 KB
chat_idstring否对话模型 ID
rerank_idstring否Rerank 模型 ID

响应：200 {"success":true,"data":{评估任务}}

bash
curl -X POST $BASE/api/v1/evaluation -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"knowledge_base_id":"kb-1","chat_id":"m-1"}'

GET /api/v1/evaluation

用途：查询评估结果。权限：Viewer+。查询参数：task_id（必填）。

响应：200 {"success":true,"data":{评估结果}}

bash
curl "$BASE/api/v1/evaluation?task_id=task-1" -H "Authorization: Bearer $TOKEN"