API 参考
测试与模型变更
管理并运行回归测试套件,或在套件上比较多个模型;在模型变更时读取等待您的系统运行的参考集任务,并提交其结果。
路由摘要和字段名称均以英文撰写,本页与文件中都是如此。
/api/v1/regression
GET /api/v1/regression/suites
The workspace's regression suites
认证
API 密钥
密钥作用域
regression:read应答
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_errorPOST /api/v1/regression/suites
Create a regression suite
认证
API 密钥
密钥作用域
regression:write请求体
name (必填) · description · provider · model · cases (必填)应答
201 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 402 regression_suite_limit_exceeded · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 429 · 500 internal_error · 503 service_unavailablePATCH /api/v1/regression/suites
Change a suite's name, description, provider or model
认证
API 密钥
密钥作用域
regression:write参数
suiteId (必填)请求体
name · description · provider · model应答
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 404 not_found · 429 · 500 internal_error · 503 service_unavailableDELETE /api/v1/regression/suites
Delete a suite and its runs
认证
API 密钥
密钥作用域
regression:write参数
suiteId (必填)应答
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 404 not_found · 429 · 500 internal_error · 503 service_unavailableGET /api/v1/regression/runs
The latest regression runs, newest first
认证
API 密钥
密钥作用域
regression:read参数
suiteId应答
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error · 503 service_unavailablePOST /api/v1/regression/runs
Run a suite, or compare 2 to 5 models on it
认证
API 密钥
密钥作用域
regression:write请求体
suiteId (必填) · provider · model · checkRunId · commitSha · pullNumber · repoFullName · models (必填)应答
202 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 404 not_found · 429 · 500 internal_error · 503 service_unavailableGET /api/v1/regression/runs/{id}
One run, with each case's result
认证
API 密钥
密钥作用域
regression:read参数
id (必填)应答
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 404 not_found · 429 · 500 internal_error · 503 service_unavailable/api/v1/reference-sets
GET /api/v1/reference-sets/pending
The reference-set runs waiting for your system (model change control)
认证
API 密钥
密钥作用域
usecases:read模块
在部署运行
FEATURE_MODEL_CHANGE_CONTROL 时提供。应答
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 409 capability_off · 429 · 500 internal_error · 501 feature_disabled · 503 service_unavailablePOST /api/v1/reference-sets/receipts
Post the results of a reference-set run your system ran
认证
API 密钥
密钥作用域
usecases:write模块
在部署运行
FEATURE_MODEL_CHANGE_CONTROL 时提供。请求体
runId (必填) · servedVersion · results (必填)应答
200 · 400 validation_failed, unknown_case, duplicate_case · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 404 run_not_found · 409 run_not_awaiting_client, capability_off · 429 · 500 internal_error · 501 feature_disabled · 503 service_unavailable