应用归因
应用归因允许开发者将其 API 使用与其应用程序关联,在 OpenRoute 的公共排名和详细分析中实现可见性。通过在请求中包含简单的头部信息,您的应用可以出现在我们的排行榜中,并获得对模型使用模式的洞察。
应用归因的优势
当您正确归因应用使用时,您可以获得:
- 公共应用排名:您的应用出现在 OpenRoute 的公共排名中,包含每日、每周和每月排行榜
- 模型应用标签:您的应用在单个模型页面上展示,显示哪些应用最常使用每个模型
- 详细分析:访问全面的分析,显示您应用的模型使用情况、token 消耗和使用模式
- 专业可见性:向 OpenRoute 开发者社区展示您的应用
归因头部
OpenRoute 通过两个可选的 HTTP 头部跟踪应用归因:
HTTP-Referer
HTTP-Referer
头部标识您应用的 URL,用作排名的主要标识符。
X-Title
X-Title
头部设置或修改您应用在排名和分析中的显示名称。
两个头部都是可选的,但包含它们可以启用所有归因功能。使用 localhost URL 的应用必须包含标题才能被跟踪。
实现示例
from openai import OpenAI
client = OpenAI(
base_url="https://www.openroute.cn/api/v1",
api_key="<OPENROUTE_API_KEY>",
)
completion = client.chat.completions.create(
extra_headers={
"HTTP-Referer": "https://myapp.com", # 您的应用 URL
"X-Title": "我的 AI 助手", # 您的应用显示名称
},
model="openai/gpt-4o",
messages=[
{
"role": "user",
"content": "你好,世界!"
}
]
)
import OpenAI from 'openai';
const openai = new OpenAI({
baseURL: 'https://www.openroute.cn/api/v1',
apiKey: '<OPENROUTE_API_KEY>',
defaultHeaders: {
'HTTP-Referer': 'https://myapp.com', // 您的应用 URL
'X-Title': '我的 AI 助手', // 您的应用显示名称
},
});
async function main() {
const completion = await openai.chat.completions.create({
model: 'openai/gpt-4o',
messages: [
{
role: 'user',
content: '你好,世界!',
},
],
});
console.log(completion.choices[0].message);
}
main();
import requests
import json
response = requests.post(
url="https://www.openroute.cn/api/v1/chat/completions",
headers={
"Authorization": "Bearer <OPENROUTE_API_KEY>",
"HTTP-Referer": "https://myapp.com", # 您的应用 URL
"X-Title": "我的 AI 助手", # 您的应用显示名称
"Content-Type": "application/json",
},
data=json.dumps({
"model": "openai/gpt-4o",
"messages": [
{
"role": "user",
"content": "你好,世界!"
}
]
})
)
fetch('https://www.openroute.cn/api/v1/chat/completions', {
method: 'POST',
headers: {
Authorization: 'Bearer <OPENROUTE_API_KEY>',
'HTTP-Referer': 'https://myapp.com', // 您的应用 URL
'X-Title': '我的 AI 助手', // 您的应用显示名称
'Content-Type': 'application/json',
},
body: JSON.stringify({
model: 'openai/gpt-4o',
messages: [
{
role: 'user',
content: '你好,世界!',
},
],
}),
});
curl https://www.openroute.cn/api/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENROUTE_API_KEY" \
-H "HTTP-Referer: https://myapp.com" \
-H "X-Title: 我的 AI 助手" \
-d '{
"model": "openai/gpt-4o",
"messages": [
{
"role": "user",
"content": "你好,世界!"
}
]
}'
您的应用出现的位置
应用排名
您的归因应用将出现在 OpenRoute 的主要排名页面 www.openroute.cn/rankings 上。排名显示:
- 顶级应用:按 token 使用量最大的公共应用
- 时间段:每日、每周和每月视图
- 使用指标:所有模型的 token 消耗总量
模型应用标签
在单个模型页面(例如,GPT-4o)上,您的应用将在"应用"标签中展示,显示:
- 顶级应用:最常使用该特定模型的应用
- 每周排名:基于使用情况每周更新
- 使用上下文:您的应用与使用相同模型的其他应用的比较
个人应用分析
一旦您的应用被跟踪,您可以访问 www.openroute.cn/apps?url=<your-app-url>
的详细分析,包括:
- 模型使用时间:显示您的应用使用哪些模型的图表
- Token 消耗:提示和完成 token 的详细分解
- 使用模式:了解您的应用 AI 使用趋势的历史数据
最佳实践
URL 要求
- 使用您应用的主要域名(例如,
https://myapp.com
) - 避免使用子域名,除非它们代表不同的应用
- 对于 localhost 开发,始终包含标题头部
标题指南
- 保持标题简洁和描述性
- 使用用户知道的应用实际名称
- 避免通用名称,如"AI 应用"或"聊天机器人"
隐私考虑
- 只有公共应用,即发送头部的应用,才会包含在排名中
- 归因头部不会暴露您请求的敏感信息
相关文档
Last updated on