查询 Response 输入项

分页查询已保存 Response 的输入项。可读取的输入内容取决于模型服务。

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

调用前准备

  1. 在支持保存和取回的模型服务上创建 Response,并启用保存。

  2. 选择仍可访问、未删除且未过期的响应。

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

认证方式见 Genesis 凭据规则。

请求参数

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

不指定分页参数

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

读取第一页

curl --get \
  "https://token.moi.matrixorigin.cn/v1/responses/$RESPONSE_ID/input_items" \
  -H "Authorization: Bearer $GENESIS_ACCESS_TOKEN" \
  --data-urlencode 'limit=1' \
  --data-urlencode 'order=asc'

从模型服务读取下一页

当 has_more 为 true 时,将上一页的 last_id 保存为 $LAST_ITEM_ID,使用相同的排序读取下一页。has_more 为 false 时停止。

curl --get \
  "https://token.moi.matrixorigin.cn/v1/responses/$RESPONSE_ID/input_items" \
  -H "Authorization: Bearer $GENESIS_ACCESS_TOKEN" \
  --data-urlencode 'limit=1' \
  --data-urlencode 'order=asc' \
  --data-urlencode "after=$LAST_ITEM_ID"

路径参数

参数

类型

是否必填

说明

response_id

string

是

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

查询参数

参数

类型

是否必填

说明

limit

integer

否

本地记录使用 100 作为默认值,无效值或非正值也使用 100,最大值为 200。模型服务保存的记录由该服务分页。

order

string

否

asc 或 desc。查询本地记录时,先取升序结果,再按 desc 反转当前页,不从末尾开始分页。

after

string

否

查询模型服务保存的记录时,使用上一页的 last_id 续页。查询本地记录时,此参数不生效。

成功响应

{
  "data": [
    {
      "id": "item-example-1",
      "type": "message",
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Reply with OK."
        }
      ]
    }
  ],
  "first_id": "item-example-1",
  "last_id": "item-example-1",
  "has_more": true
}

字段

类型

说明

data

array of object

本页输入项。

data[].id

string

输入项 ID。只有模型服务保存的记录支持按该服务的游标规则续页。

data[].type

string

项类型,文本消息为 message。

data[].role

string

输入消息的角色。

data[].content

array of object

模型服务保存的完整输入可能包含内容块。本地保存的摘要不含此字段。

data[].content[].type

string

文本块类型 input_text。

data[].content[].text

string

模型服务保存的输入文本。本地仅保存摘要,无法取回原文。

first_id

string

本页第一项的标识。

last_id

string

本页最后一项的 ID。查询本地记录时,不能用此值续页。

has_more

boolean

模型服务保存的记录是否还有下一页。本地记录固定返回 false,即使结果受 limit 限制。

错误响应

响应不存在、已删除、已过期或当前凭据无法访问时,返回 HTTP 404。

  • 核对响应 ID,并使用创建响应时的账户和凭据。换用账户或凭据后,可能无法访问原有响应。

  • 使用服务账号时,即使响应由自身创建,也可能无法查询。

  • 使用服务账号 OAuth 令牌时,确认令牌有效且有权访问目标响应。

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

错误代码。

最后更新于