You need to enable JavaScript to run this app.
导航
机器学习平台
  • 文档首页
    • /
  • 机器学习平台

info

最近更新时间：2024.04.16 13:11:58

首次发布时间：2024.03.27 17:09:23

我的收藏

概述

/api/knowledge/doc/info 接口用于查看知识库下的某个文档的信息。

前提条件

完成“对接指南“页面的注册账号、实名认证、AK/SK 密钥获取和签名获取后，可调用 API 接口实现知识库信息更新的功能。

请求接口

URI

http://api-knowledgebase.ml_platform.cn-beijing.volces.com/api/knowledge/doc/info

统一资源标识符

请求方法

POST

客户端对向量数据库服务器请求的操作类型

请求头

Content-Type: application/json

请求消息类型

Authorization: HMAC-SHA256 ***

鉴权

请求参数

参数

类型

是否必选

默认值

参数说明

collection_name

string

是

知识库的名字。

doc_id

string

是

文档id。

响应消息

参数

参数说明

code

状态码

message

返回信息

request_id

标识每个请求的唯一标识符

data

返回的详细信息
{
"collection_name"：知识库的名字
"doc_name"：文档名称
"doc_id"：文档id
"add_type"：文档的导入方式
"doc_type"：文档的类型
"create_time"：文档的上传时间
"added_by"：文档的上传者
"update_time"：文档的更新时间
"url"：文档的下载链接（add_type为url时会带有这个字段）
"tos_path"：文档所在的tos目录（add_type为tos时会带有这个字段）
"meta"：文档的meta信息
"point_num"：文档提取出的point数量
"status"：{
"process_status"：文档的处理状态 // 0表示处理完成，1表示处理失败，5表示删除中，其他表示处理中
"failed_code"：文档处理失败的错误码 // 见下方说明
}
}

failed_code说明：

failed_code

含义

备注

10001

文档下载超时

可能是网速或者资源限制

10002

文档下载失败

提供的下载链接可能不可用

30001

文档超过大小限制

减少文档大小

40004

文档生成的chunk数量过多，超过了10000

调整文档内容或减少文档大小

45002

文档的页数过多，超过200页

减少文档的页数

other

其他未知错误

请联系系统管理员或oncall

状态码说明

状态码

http状态码

返回信息

状态码说明

0

200

success

成功

1000001

401

unauthorized

鉴权失败

1000002

403

no permission

权限不足

1000003

400

invalid request：%s

非法参数

1000005

400

collection not exist

collection不存在

1001001

400

doc not exist

doc不存在

完整示例

请求消息

curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: HMAC-SHA256 ***' \
  http://api-knowledgebase.ml_platform.cn-beijing.volces.com/api/knowledge/collection/update \
  -d '{
    "collection_name": "test_collection_name"，
    "doc_id": "test123"
}'

响应消息

执行成功返回：

HTTP/1.1 200 OK
Content-Length: 43
Content-Type: application/json
 
{
    "code":0,
    "data":{
        "collection_name": "test_collection_name",
        "doc_name": "张某某盗窃案",
        "doc_id": "test0123",
        "add_type": "url",
        "doc_type": "pdf",
        "create_time": 1711367027047,
        "added_by": "xiejianqiao.1027@bytedance.com",
        "update_time": 1711367030802,
        "url": "https://fwh-my-test-bucket.tos-cn-beijing.volces.com/%E6%96%B0%E6%A9%99%E7%A7%91%E6%8A%80/%E5%91%A8%E6%9D%A8%E7%9B%97%E7%AA%83%E6%A1%88.pdf?X-Tos-Algorithm=TOS4-HMAC-SHA256\u0026X-Tos-Content-Sha256=UNSIGNED-PAYLOAD\u0026X-Tos-Credential=AKTP0UZNtgnE7Lfth5eB2z0Z9qy2gyewikK9nbStjHp0OY%2F20240325%2Fcn-beijing%2Ftos%2Frequest\u0026X-Tos-Date=20240325T114024Z\u0026X-Tos-Expires=3600\u0026X-Tos-SignedHeaders=host\u0026X-Tos-Security-Token=nCgdqdEROend3.ChsKBzNzX056d3cSEGBgA9av-UtVs7ClfMkXS4oQk8WFsAYYo-GFsAYgle7V6QcoAjCSkLEJOhx6aGFpeXVqaWEuMDMyMkBieXRlZGFuY2UuY29tQgN0b3NSHHpoYWl5dWppYS4wMzIyQGJ5dGVkYW5jZS5jb21YBGAB.Nur_XCwZ_1LHmSsfeWGjDUn8SEOo3c6op5hx3lUgLZuxtHN_sqs-Kd0KbKw-51CT6wXKQo3AbmidScqVTu6gLQ\u0026X-Tos-Signature=5c3dff2f8cd67daae99476d54188033cc32932d87f1ff85f4f1afd5862fa35cd",
        "point_num": 53,
        "status" :{
            "process_status":0
        }
    },
    "message":"success",
    "request_id":"02171136054666600000000000000000000ffff0a0060163f95e1"
}

执行失败返回：

HTTP/1.1 400 OK
Content-Length: 43
Content-Type: application/json
 
{"code":1000003, "message":"invalid request：%s", "request_id": "021695029757920fd001de6666600000000000000000002569b8f"}