Spaces:

fiewolf1000
/

Cross-Encoder

Sleeping

App Files Files Community

fiewolf1000 commited on Sep 23, 2025

Commit

74e864a

verified ·

1 Parent(s): 25c0731

Update app.py

Browse files

Files changed (1) hide show

app.py +101 -8

app.py CHANGED Viewed

@@ -10,6 +10,7 @@ from fastapi.responses import MarkdownResponse  # 确保导入这行
 from pydantic import BaseModel
 from transformers import AutoTokenizer, AutoModelForSequenceClassification
 import torch
 # 【双重保障】设置 Hugging Face 缓存目录（与 Dockerfile 一致）
 os.environ["TRANSFORMERS_CACHE"] = "/tmp/huggingface_cache"
@@ -194,18 +195,110 @@ async def health_check():
 # ------------------- 新增：根路径（/）首页路由 -------------------
-@app.get("/", response_class=MarkdownResponse, description="API 首页（含调用指南）")
 async def home_page():
-    """根路径首页：展示 API 功能、调用示例、认证方式等"""
     return f"""
-# Cross-Encoder 重排序 API（兼容 GPT 格式）
-基于 `cross-encoder/ms-marco-MiniLM-L-6-v2` 模型，提供文本相关性排序服务，支持 GPT 标准 API 调用格式。
-## 核心功能
-- 输入「查询语句 + 候选文档列表」，返回按相关性降序排列的结果（含分数、排名）
-- 兼容 OpenAI 风格 API 格式，可直接用 OpenAI 库调用
-- 支持 API Key 认证，保障接口安全"""

 from pydantic import BaseModel
 from transformers import AutoTokenizer, AutoModelForSequenceClassification
 import torch
+from fastapi.responses import HTMLResponse  # 替换为 HTMLResponse
 # 【双重保障】设置 Hugging Face 缓存目录（与 Dockerfile 一致）
 os.environ["TRANSFORMERS_CACHE"] = "/tmp/huggingface_cache"
 # ------------------- 新增：根路径（/）首页路由 -------------------
+@app.get("/", response_class=HTMLResponse, description="API 首页（含调用指南）")
 async def home_page():
+    """根路径首页：用 HTML 渲染，避免 MarkdownResponse 依赖问题"""
+    current_time = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
     return f"""
+<!DOCTYPE html>
+<html lang="zh-CN">
+<head>
+    <meta charset="UTF-8">
+    <title>Cross-Encoder 重排序 API（兼容 GPT 格式）</title>
+    <style>
+        body {{ font-family: Arial, sans-serif; max-width: 1200px; margin: 0 auto; padding: 20px; }}
+        h1 {{ color: #2c3e50; border-bottom: 2px solid #3498db; padding-bottom: 10px; }}
+        h2 {{ color: #34495e; margin-top: 30px; }}
+        pre {{ background: #f8f9fa; padding: 15px; border-radius: 5px; border: 1px solid #e9ecef; overflow-x: auto; }}
+        table {{ border-collapse: collapse; width: 100%; margin: 20px 0; }}
+        th, td {{ border: 1px solid #e9ecef; padding: 12px; text-align: left; }}
+        th {{ background-color: #f1f5f9; }}
+        .note {{ color: #6c757d; font-size: 0.9em; }}
+    </style>
+</head>
+<body>
+    <h1>Cross-Encoder 重排序 API（兼容 GPT 格式）</h1>
+    <p>基于 <code>cross-encoder/ms-marco-MiniLM-L-6-v2</code> 模型，提供文本相关性排序服务，支持 GPT 标准 API 调用格式。</p>
+    <h2>核心功能</h2>
+    <ul>
+        <li>输入「查询语句 + 候选文档列表」，返回按相关性降序排列的结果（含分数、排名）</li>
+        <li>兼容 OpenAI 风格 API 格式，可直接用 OpenAI 库调用</li>
+        <li>支持 API Key 认证，保障接口安全</li>
+    </ul>
+    <h2>接口地址</h2>
+    <h3>重排序接口（兼容 GPT）</h3>
+    <ul>
+        <li><strong>URL</strong>: <code>{app.root_path}/v1/chat/completions</code></li>
+        <li><strong>方法</strong>: <code>POST</code></li>
+        <li><strong>认证</strong>: 需在 Header 中添加 <code>Authorization: Bearer &lt;你的 API Key&gt;</code>（API Key 在 Hugging Face Spaces 环境变量中配置）</li>
+    </ul>
+    <h2>调用示例（Python）</h2>
+    <pre><code>from openai import OpenAI
+# 配置客户端（指向当前 Space 地址）
+client = OpenAI(
+    api_key="your-api-key-here",  # 替换为你的 API Key
+    base_url="https://&lt;your-username&gt;-&lt;your-space-name&gt;.hf.space/v1"  # 替换为你的 Space URL
+)
+# 发送重排序请求
+response = client.chat.completions.create(
+    model="cross-encoder/ms-marco-MiniLM-L-6-v2",  # 固定模型名
+    messages=[
+        {{
+            "role": "user",
+            "content": "query: 什么是机器学习?; documents: 机器学习是AI的分支; Python是编程语言; 深度学习是机器学习的子集;"
+        }}
+    ],
+    top_k=2  # 可选，返回 Top 2 高相关文档
+)
+# 打印结果
+print(response.choices[0].message.content)</code></pre>
+    <h2>请求参数说明</h2>
+    <table>
+        <tr>
+            <th>参数</th>
+            <th>类型</th>
+            <th>说明</th>
+        </tr>
+        <tr>
+            <td><code>model</code></td>
+            <td>string</td>
+            <td>固定为 <code>cross-encoder/ms-marco-MiniLM-L-6-v2</code>，不可修改</td>
+        </tr>
+        <tr>
+            <td><code>messages</code></td>
+            <td>list</td>
+            <td>消息列表，最后一条必须是 <code>role: user</code> 的消息</td>
+        </tr>
+        <tr>
+            <td><code>messages[].content</code></td>
+            <td>string</td>
+            <td>格式：<code>query: [你的查询]; documents: [文档1]; [文档2]; ...</code>（文档用分号分隔）</td>
+        </tr>
+        <tr>
+            <td><code>top_k</code></td>
+            <td>int</td>
+            <td>可选，默认返回 Top 3 文档，范围 1~20</td>
+        </tr>
+    </table>
+    <h2>健康检查</h2>
+    <ul>
+        <li><strong>URL</strong>: <code>{app.root_path}/health</code></li>
+        <li><strong>方法</strong>: <code>GET</code></li>
+        <li><strong>说明</strong>: 无需认证，用于检查服务是否正常运行</li>
+    </ul>
+    <p class="note">页面生成时间: {current_time}</p>
+</body>
+</html>
+"""