Appearance
其他接口
重排序、内容审核及实时连接等接口。
所有路径相对于当前 API 站点域名。认证方式参见 认证与访问地址。
文档重排序
POST /v1/rerank
根据查询对文档列表进行相关性重排序
分类： 重排序(Rerank)
请求体
请求类型：application/json（必填）
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | |
query | string | 是 | 查询文本 |
documents | string / object[] | 是 | 要重排序的文档列表 |
top_n | integer | 否 | 返回前 N 个结果 |
return_documents | boolean | 否 |
响应
| 状态码 | 说明 |
|---|---|
200 | 成功重排序 |
内容审核
POST /v1/moderations
检查文本内容是否违反使用政策
分类： Moderations
请求体
请求类型：application/json（必填）
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
input | string / string[] | 是 | |
model | string | 否 |
响应
| 状态码 | 说明 |
|---|---|
200 | 成功审核 |
实时 WebSocket 连接
GET /v1/realtime
建立 WebSocket 连接用于实时对话。 注意: 这是一个 WebSocket 端点，需要使用 WebSocket 协议连接。 连接 URL 示例: wss://api.example.com/v1/realtime?model=gpt-realtime-2.1
分类： Realtime
路径与查询参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
model | query | string | 否 | 要使用的模型 |
响应
| 状态码 | 说明 |
|---|---|
101 | WebSocket 协议切换 |
400 | 请求错误 |