句子 Insight

获取文档详情

GET

/openapi/knowledge-base/doc/get

可以通过这个接口获取对应数据库中文档的详情信息，返回的内容会比列表接口稍微多一些

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

knowledgeBaseId

string

知识库ID

可选

docId

string

文档ID

可选

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

必需

data

object

必需

docId

integer

文档ID

必需

name

string

文档名

必需

文档的名字

extension

string

后缀名

必需

后缀名，如果是通过api或者界面手动创建，则这个值为manual，仅这种后缀名的文档支持通过接口添加更新删除片段数据

docUrl

string

文档url

必需

仅当文档是通过界面上传的方式创建的时候存在，如果文档是通过api或者手动创建的这，则这个值为空

size

string

文档大小

必需

仅当文档是通过界面上传的方式创建的时候存在，其他情况下为0

paragraphCount

integer

段落数

必需

该文档包含的段落数量

status

string

状态

必需

状态，ready，processing。processing代表当前文档正在进行向量化处理

createDate

string

创建时间

必需

updateDate

string

更新时间

必需

示例

{
  "code": 0,
  "data": {
    "docId": 0,
    "name": "string",
    "extension": "string",
    "docUrl": "string",
    "size": "string",
    "paragraphCount": 0,
    "status": "string",
    "createDate": "string",
    "updateDate": "string"
  }
}

获取文档列表

创建文档