From 53d441b3f549203ae50e40ebe829d45c190b8756 Mon Sep 17 00:00:00 2001 From: Gabe Date: Fri, 31 Oct 2025 11:25:43 +0800 Subject: [PATCH] doc: readme --- README.en.md | 15 +++++++++++++-- README.md | 15 +++++++++++++-- 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/README.en.md b/README.en.md index a367c9b..63e2e67 100644 --- a/README.en.md +++ b/README.en.md @@ -139,9 +139,20 @@ Personal Rules > Subscription Rules > Global Rules Among these, Global Rules have the lowest priority but are very important as they serve as the default rules. -### Local Ollama interface cannot be used +### API (Ollama, etc.) Test Failure -If encountering a 403 error, refer to: https://github.com/fishjar/kiss-translator/issues/174 +Common reasons for API test failures include: + +- Incorrect address: + - For example, `Ollama` has a native API address and an `Openai`-compatible address. This plugin currently supports the `Openai`-compatible address and does not support the `Ollama` native API address. +- The default `Prompt` needs to support `JSON` output, but some AI models do not: + - This can be addressed by using `Hook` or a custom API. + - For details, refer to: [Custom API Example Documentation](https://github.com/fishjar/kiss-translator/blob/master/custom-api_v2.md) +- Inconsistent parameters for some AI models + - For example, the parameters of the `Gemini` native API are highly inconsistent. Some model versions do not support certain parameters, leading to errors. + - In this case, you can modify the request body using a `Hook`, or replace it with `Gemini2` (an OpenAI-compatible address). +- The server restricts cross-origin access, returning a 403 error: + - For example, `Ollama` requires adding the environment variable `OLLAMA_ORIGINS=*` when starting. See: https://github.com/fishjar/kiss-translator/issues/174 ### Custom API doesn't work in Tampermonkey scripts diff --git a/README.md b/README.md index 4862e7c..7676870 100644 --- a/README.md +++ b/README.md @@ -135,9 +135,20 @@ 其中全局规则优先级最低，但非常重要，相当于兜底规则。 -### 本地的Ollama接口不能使用 +### 接口（Ollama等）测试失败 -如果出现403的情况，参考：https://github.com/fishjar/kiss-translator/issues/174 +一般接口测试失败常见有以下几种原因： + +- 地址填错了： + - 比如 `Ollama` 有原生接口地址和 `Openai` 兼容的地址，本插件目前统一支持 `Openai` 兼容的地址，不支持 `Ollama` 原生接口地址 +- 默认的 `Prompt` 需要支持 `JSON` 输出，但某些AI模型不支持： + - 此种情况可以通过 `Hook` 或自定义接口的方式来使用。 + - 详情参考： [自定义接口示例文档](https://github.com/fishjar/kiss-translator/blob/master/custom-api_v2.md) +- 某些AI模型的参数不一致 + - 比如 `Gemini` 原生接口参数非常不一致，部分版本的模型不支持某些参数会导致返回错误。 + - 此种情况可以通过 `Hook` 修改请求 `body` ,或者更换为 `Gemini2` (`Openai` 兼容的地址) +- 服务器跨域限制访问，返回403错误： + - 比如 `Ollama` 启动时须添加环境变量 `OLLAMA_ORIGINS=*`, 参考：https://github.com/fishjar/kiss-translator/issues/174 ### 填写的接口在油猴脚本不能使用