You need to enable JavaScript to run this app.
导航
get_doc
最近更新时间:2024.11.22 12:03:55首次发布时间:2024.05.31 15:27:41

概述

get_doc 用于查看知识库下的某个文档的信息。

请求参数

参数

类型

是否必选

默认值

参数说明

project

string

default

知识库所属项目
即在【访问控制】-【资源管理】-【项目】中创建的项目

resource_id

string

--

知识库唯一 id
可选择直接传 resource_id,或同时传 name 和 project 作为知识库的唯一标识

doc_id

string

--

知识库下所要查看文档的 id

示例

请求参数

请先完成 SDK 初始化,再运行代码,详见初始化SDK

my_collection = viking_knowledgebase_service.get_collection("example")

doc = my_collection.get_doc("doc001")

返回值

Python 调用执行上面的任务,返回 Doc 实例。Doc 实例包含的属性如下表所示。

属性

类型

说明

collection_name

string

索引所属的 collection 名

doc_name

string

文档名字

doc_id

string

文档id

doc_type

string

文档类型

create_time

string

创建时间

added_by

string

文档添加人

update_time

string

文档更新时间

url

string

文档上传url路径

tos_path

string

文档上传tos路径

point_num

int

文档下知识点数量

status

string

文档状态

  • 0 表示处理完成
  • 1 表示处理失败
  • 5 表示删除中
  • 其他表示处理中

title

string

文档标题

source

string

文档上传来源

fields

list

字段列表