面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/case-platform-v1-seed-badcase-report-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

上报大语言模型效果问题

POST https://ark.cn-beijing.volcengineapi.com/?Action=CasePlatformV1SeedBadcaseReport&Version=2024-01-01

本接口用于上报 Seed 系列大语言模型的效果问题。每条提交的 case 需携带原始的模型请求与响应,受理后返回 Instance ID,可用于查询处理结果。本接口同时支持通过 Access Key 和方舟 API Key 两种方式鉴权。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • 【推荐】API Key 鉴权,请在 API Key 管理 页面,获取长效 API Key。
  • 【可选】Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。

请求参数#

Body 参数#

Cases object[] 必选  |  Case 数组

待上报的 badcase 列表。

每条 item 需要携带原始的 Chat / Responses 接口请求体。

同时需要提供 Response(原始非流式响应体)或 StreamChunks(流式响应分片数组)二者之一,两者互斥。

ApiType string 必选  |  接口类型

Cases.ApiType

本条 case 对应的接口类型。

  • chat:Chat Completions API。
  • responses:Responses API。
Feedback string 必选  |  问题描述

Cases.Feedback

效果问题的文字描述。

Request object 必选  |  原始请求体

Cases.Request

发给模型的原始请求体,需按 Chat / Responses API 规范原样保存。

BadcaseType string[]  |  问题类型

Cases.BadcaseType

问题类型标识列表。可用词表由 CasePlatformV1TccGetBadcaseTypeList 接口维护。

ContactInfo string  |  联系方式

Cases.ContactInfo

上报人联系方式,支持电子邮箱地址或电话号码。

Response object  |  原始非流式响应

Cases.Response

原始非流式响应体。与 StreamChunks 互斥,必须且只能提供其一。

StreamChunks object[]  |  流式响应分片

Cases.StreamChunks

原始流式响应分片数组,按到达顺序排列。与 Response 互斥,必须且只能提供其一。

Source string 默认值 customer  |  反馈来源

反馈来源标识。省略或传 null 时使用默认来源。

  • huosu:火速助手
  • huoshan:火山助手
  • qianzhi:钳知
  • customer:客户提交

传入其他值会被拒绝。

响应参数#

Total integer  |  case 总数

本次提交的 case 总数。

Accepted object[]  |  受理列表

校验通过且已受理的 case 列表。

ApiType string  |  接口类型

Accepted.ApiType

该条 case 对应的接口类型。

  • chat:Chat Completions API。
  • responses:Responses API。
Index integer  |  下标

Accepted.Index

对应提交的 Cases 数组中的下标,从 0 开始。

InstanceId string  |  Case ID

Accepted.InstanceId

平台分配的 instance id,可用它调用查询接口获取处理结果。

Model string  |  模型名称

Accepted.Model

从响应体中解析出的模型名称。

SubmitTime string  |  受理时间

Accepted.SubmitTime

受理时间,ISO 8601 格式的 UTC 时间。

Rejected object[]  |  拒绝列表

校验失败且未受理的 case 列表。

Code integer  |  错误码

Rejected.Code

该条 case 的错误码,含义参见错误码章节。

Index integer  |  下标

Rejected.Index

对应提交的 Cases 数组中的下标,从 0 开始。

Message string  |  拒绝原因

Rejected.Message

拒绝原因的可读说明。