查询 Response

读取已保存的 Response。完整输出能否取回及保留时长取决于所选模型服务。

GET https://token.moi.matrixorigin.cn/v1/responses/$RESPONSE_ID

调用前准备

  1. 在支持保存和取回的模型服务上创建 Response,并开启保存。选择仍可访问、未删除且未过期的响应。

  2. 准备创建该响应时使用的个人访问令牌

请求示例

将示例中的 $GENESIS_ACCESS_TOKEN$RESPONSE_ID 分别替换为个人访问令牌和所选响应的 ID。

curl -X GET \
  "https://token.moi.matrixorigin.cn/v1/responses/$RESPONSE_ID" \
  -H "Authorization: Bearer $GENESIS_ACCESS_TOKEN"

路径参数

参数

类型

是否必填

说明

response_id

string

已保存 Response 的标识,取自创建响应返回的 id

成功响应

成功时返回保存的响应;完整内容取决于所选模型服务的保存能力。

{
  "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

输出项类型,例如 messagereasoning

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 总数。

错误响应

响应不存在、已删除、已过期或当前凭据无法访问时,返回 HTTP 404。确认响应 ID 和创建时使用的凭据。

{
  "error": {
    "message": "response state not found",
    "type": "response_state_not_found",
    "code": "response_state_not_found"
  }
}

字段

类型

说明

error

object

错误信息。

error.message

string

不可访问或不存在的响应说明。

error.type

string

错误类别。

error.code

string

错误代码。

后续操作

使用同一 id 查询 Response 输入项;不再需要保存的响应时,删除 Response

最后更新于