You need to enable JavaScript to run this app.
导航
get_collection
最近更新时间:2024.06.13 16:53:43首次发布时间:2024.05.31 15:28:57

概述

get_collection用于查询已有的指定知识库Collection的详细信息。

请求参数

参数

类型

是否必选

默认值

参数说明

collection_name

string

指定查询的 Collection 名称。

  • 只能使用英文字母、数字、下划线_,并以英文字母开头,不能为空。
  • 长度要求:[1, 128]。
  • Collection 名称不能重复。

project

string

default

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

resource_id

string

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

示例

请求参数
my_collection = viking_knowledgebase_service.get_collection("example")

返回值

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

属性

类型

说明

collection_name

string

collection名字

description

string

描述

doc_num

int

知识库下文档数量

create_time

string

创建时间

update_time

string

更新时间

creator

string

创建人

pipeline_list

string

知识库下pipeline列表

preprocessing

string

文档预处理配置

fields

list

字段列表

project

string

所在project的name

resource_id

string

唯一资源id