Merge pull request #316 from ConstasJ/modify-readme

docs: 在README里添加关于端点的说明
This commit is contained in:
snaily
2025-08-31 00:24:53 +08:00
committed by GitHub
2 changed files with 12 additions and 0 deletions

View File

@@ -137,6 +137,8 @@ app/
### Gemini API Format (`/gemini/v1beta`)
This endpoint is directly forwarded to official Gemini API format endpoint, without advanced features.
* `GET /models`: List available Gemini models.
* `POST /models/{model_name}:generateContent`: Generate content.
* `POST /models/{model_name}:streamGenerateContent`: Stream content generation.
@@ -145,6 +147,8 @@ app/
#### Hugging Face (HF) Compatible
If you want to use advanced features, like fake streaming, please use this endpoint.
* `GET /hf/v1/models`: List models.
* `POST /hf/v1/chat/completions`: Chat completion.
* `POST /hf/v1/embeddings`: Create text embeddings.
@@ -152,6 +156,8 @@ app/
#### Standard OpenAI
This endpoint is directly forwarded to official OpenAI Compatible API format endpoint, without advanced features.
* `GET /openai/v1/models`: List models.
* `POST /openai/v1/chat/completions`: Chat completion (Recommended).
* `POST /openai/v1/embeddings`: Create text embeddings.

View File

@@ -138,6 +138,8 @@ app/
### Gemini API 格式 (`/gemini/v1beta`)
此端点将请求直接转发到官方 Gemini API 格式的端点,不包含高级功能。
* `GET /models`: 列出可用的 Gemini 模型。
* `POST /models/{model_name}:generateContent`: 生成内容。
* `POST /models/{model_name}:streamGenerateContent`: 流式生成内容。
@@ -146,6 +148,8 @@ app/
#### 兼容 huggingface (HF) 格式
如果您需要使用高级功能(例如假流式输出),请使用此端点。
* `GET /hf/v1/models`: 列出模型。
* `POST /hf/v1/chat/completions`: 聊天补全。
* `POST /hf/v1/embeddings`: 创建文本嵌入。
@@ -153,6 +157,8 @@ app/
#### 标准 OpenAI 格式
此端点直接转发至官方的 OpenAI 兼容 API 格式端点,不包含高级功能。
* `GET /openai/v1/models`: 列出模型。
* `POST /openai/v1/chat/completions`: 聊天补全 (推荐,速度更快,防截断)。
* `POST /openai/v1/embeddings`: 创建文本嵌入。