langchain_community.document_loaders.yuque.YuqueLoader

class langchain_community.document_loaders.yuque.YuqueLoader(access_token: str, api_url: str = 'https://www.yuque.com')[source]

从`语雀`加载文档。

使用语雀的access_token和api_url进行初始化。

参数:

access_token: 个人访问令牌 - 请参阅https://www.yuque.com/settings/tokens。 api_url: 语雀API的url。

Attributes

headers

Methods

__init__(access_token[, api_url])

使用语雀的access_token和api_url进行初始化。

alazy_load()

一个用于文档的惰性加载器。

aload()

将数据加载到文档对象中。

get_books(user_id)

get_document(book_id, document_id)

get_document_ids(book_id)

get_documents()

get_user_id()

http_get(url)

lazy_load()

一个用于文档的惰性加载器。

load()

从`语雀`加载文档。

load_and_split([text_splitter])

加载文档并分割成块。块作为文档返回。

parse_document(document)

parse_document_body(body)

Parameters

  • access_token (str) –

  • api_url (str) –

__init__(access_token: str, api_url: str = 'https://www.yuque.com')[source]

使用语雀的access_token和api_url进行初始化。

参数:

access_token: 个人访问令牌 - 请参阅https://www.yuque.com/settings/tokens。 api_url: 语雀API的url。

Parameters

  • access_token (str) –

  • api_url (str) –

async alazy_load() → AsyncIterator[Document]

一个用于文档的惰性加载器。

Return type

AsyncIterator[Document]

async aload() → List[Document]

将数据加载到文档对象中。

Return type

List[Document]

get_books(user_id: int) → List[Dict][source]
Parameters

user_id (int) –

Return type

List[Dict]

get_document(book_id: int, document_id: int) → Dict[source]
Parameters

  • book_id (int) –

  • document_id (int) –

Return type

Dict

get_document_ids(book_id: int) → List[int][source]
Parameters

book_id (int) –

Return type

List[int]

get_documents() → Iterator[Document][source]
Return type

Iterator[Document]

get_user_id() → int[source]
Return type

int

http_get(url: str) → Dict[source]
Parameters

url (str) –

Return type

Dict

lazy_load() → Iterator[Document]

一个用于文档的惰性加载器。

Return type

Iterator[Document]

load() → List[Document][source]

从`语雀`加载文档。

Return type

List[Document]

load_and_split(text_splitter: Optional[TextSplitter] = None) → List[Document]

加载文档并分割成块。块作为文档返回。

不要覆盖此方法。应该被视为已弃用！

参数：
text_splitter: 用于分割文档的TextSplitter实例。

默认为RecursiveCharacterTextSplitter。

返回：

文档列表。

Parameters

text_splitter (Optional[TextSplitter]) –

Return type

List[Document]

parse_document(document: Dict) → Document[source]
Parameters

document (Dict) –

Return type

Document

static parse_document_body(body: str) → str[source]
Parameters

body (str) –

Return type

str

Examples using YuqueLoader