创建 Response

提交输入并生成 Response,从输出项中读取生成文本。

POST https://token.moi.matrixorigin.cn/v1/responses

调用前准备

  1. 准备个人访问令牌或服务账号 API Key。创建方法见管理 Genesis 访问凭据。

  2. 通过查询可调用模型,选择 capabilities 包含 responses 的模型。

认证方式见 Genesis 凭据规则。

请求体

将示例中的 $GENESIS_ACCESS_TOKEN、$MODEL_ID 替换为实际值。

curl -X POST \
  "https://token.moi.matrixorigin.cn/v1/responses" \
  -H "Authorization: Bearer $GENESIS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "'"$MODEL_ID"'",
  "input": "Reply with OK.",
  "store": false,
  "max_output_tokens": 256
}'

参数

类型

是否必填

说明

model

string

是

所选模型的 ID,取自模型查询结果中的 data[].id。

input

string 或 array of object

是

文本输入,或按顺序提交的文本消息。

input[].role

string

消息数组中必填

消息角色,示例使用 user。

input[].content

string 或 array of object

消息数组中必填

消息文本或输入文本块。

input[].content[].type

string

文本块中必填

输入文本块使用 input_text。

input[].content[].text

string

文本块中必填

输入文本。

store

boolean

否

是否保存 Response。示例显式关闭保存。使用个人访问令牌且所选模型服务支持保存时,可设为 true 后查询或删除。

max_output_tokens

integer

否

输出 Token 上限。推理模型的预算可包含推理 Token。

instructions

string

否

本次生成的附加指令。

temperature

number

否

采样温度,仅在所选模型支持时设置。

top_p

number

否

核采样参数,仅在所选模型支持时设置。

stream

boolean

否

设为 true 请求 Responses SSE 事件。启用保存时不能同时启用流式输出。

服务账号启用 store=true 后,可能仍无法读取已保存的响应。使用 previous_response_id 或 conversation 继续对话时,也可能因权限不足而失败。

需要保存响应或继续对话时,先确认服务账号具有所需权限。store=false 只关闭保存,无法解决响应访问权限不足的问题。

成功响应

{
  "id": "resp-example",
  "object": "response",
  "status": "completed",
  "model": "MODEL_ID",
  "output": [
    {
      "type": "message",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "OK"
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 12,
    "output_tokens": 1,
    "total_tokens": 13
  }
}

字段

类型

说明

id

string

Response 标识。保存后可用于查询和删除。

object

string

对象类型 response。

status

string

生成状态,例如 completed。应结合状态判断输出是否完整。

model

string

处理请求的模型。

output

array of object

输出项,文本消息可能位于推理项之后。

output[].type

string

输出项类型,例如 message 或 reasoning。

output[].role

string

消息输出项的角色。

output[].content

array of object

消息输出项的内容块。

output[].content[].type

string

生成文本块使用 output_text。

output[].content[].text

string

生成文本。

output[].summary

array of object

推理输出项返回的摘要,存在时读取。

output[].summary[].type

string

摘要块类型,例如 summary_text。

output[].summary[].text

string

摘要文本。

usage

object

本次调用的 Token 用量。

usage.input_tokens

integer

输入 Token 数。

usage.output_tokens

integer

输出 Token 数。

usage.total_tokens

integer

Token 总数。

错误响应

缺少必填模型 ID 时返回 HTTP 400。补充模型 ID 后重新提交。

{
  "error": {
    "message": "missing required parameter: model",
    "type": "invalid_request",
    "code": "invalid_request"
  }
}

字段

类型

说明

error

object

错误信息。

error.message

string

错误原因。示例表示缺少模型 ID。

error.type

string

错误类别,模型服务返回时可能省略。

error.code

string 或 null

错误代码,模型服务返回时可能省略。

最后更新于