langchain_community.document_loaders.trello
.TrelloLoader¶
- class langchain_community.document_loaders.trello.TrelloLoader(client: TrelloClient, board_name: str, *, include_card_name: bool = True, include_comments: bool = True, include_checklist: bool = True, card_filter: Literal['closed', 'open', 'all'] = 'all', extra_metadata: Tuple[str, ...] = ('due_date', 'labels', 'list', 'closed'))[source]¶
从`Trello`板加载卡片。
初始化Trello加载器。
- 参数:
client:Trello API客户端。 board_name:Trello板的名称。 include_card_name:是否在文档中包含卡片的名称。 include_comments:是否在文档中包含卡片的评论。 include_checklist:是否在文档中包含卡片的清单。 card_filter:卡片状态的过滤器。有效值为”closed”,”open”,”all”。 extra_metadata:要包含为文档元数据的附加元数据字段列表。有效值为”due_date”,”labels”,”list”,”closed”。
Methods
__init__
(client, board_name, *[, ...])初始化Trello加载器。
一个用于文档的惰性加载器。
aload
()将数据加载到文档对象中。
from_credentials
(board_name, *[, api_key, token])方便的构造函数,为您构建TrelloClient的初始化参数。
从指定的Trello板加载所有卡片。
load
()将数据加载到文档对象中。
load_and_split
([text_splitter])加载文档并分割成块。块作为文档返回。
- Parameters
client (TrelloClient) –
board_name (str) –
include_card_name (bool) –
include_comments (bool) –
include_checklist (bool) –
card_filter (Literal['closed', 'open', 'all']) –
extra_metadata (Tuple[str, ...]) –
- __init__(client: TrelloClient, board_name: str, *, include_card_name: bool = True, include_comments: bool = True, include_checklist: bool = True, card_filter: Literal['closed', 'open', 'all'] = 'all', extra_metadata: Tuple[str, ...] = ('due_date', 'labels', 'list', 'closed'))[source]¶
初始化Trello加载器。
- 参数:
client:Trello API客户端。 board_name:Trello板的名称。 include_card_name:是否在文档中包含卡片的名称。 include_comments:是否在文档中包含卡片的评论。 include_checklist:是否在文档中包含卡片的清单。 card_filter:卡片状态的过滤器。有效值为”closed”,”open”,”all”。 extra_metadata:要包含为文档元数据的附加元数据字段列表。有效值为”due_date”,”labels”,”list”,”closed”。
- Parameters
client (TrelloClient) –
board_name (str) –
include_card_name (bool) –
include_comments (bool) –
include_checklist (bool) –
card_filter (Literal['closed', 'open', 'all']) –
extra_metadata (Tuple[str, ...]) –
- classmethod from_credentials(board_name: str, *, api_key: Optional[str] = None, token: Optional[str] = None, **kwargs: Any) TrelloLoader [source]¶
方便的构造函数,为您构建TrelloClient的初始化参数。
- 参数:
board_name: Trello板的名称。 api_key: Trello API密钥。也可以指定为环境变量TRELLO_API_KEY。 token: Trello令牌。也可以指定为环境变量TRELLO_TOKEN。 include_card_name: 是否在文档中包含卡片的名称。 include_comments: 是否在文档中包含卡片的评论。 include_checklist: 是否在文档中包含卡片的清单。 card_filter: 卡片状态的过滤器。有效值为”closed”,”open”,”all”。 extra_metadata: 要包含为文档元数据的附加元数据字段列表。有效值为”due_date”,”labels”,”list”,”closed”。
- Parameters
board_name (str) –
api_key (Optional[str]) –
token (Optional[str]) –
kwargs (Any) –
- Return type
- lazy_load() Iterator[Document] [source]¶
从指定的Trello板加载所有卡片。
您可以使用可选参数过滤包括的卡片、元数据和文本。
- 返回:
一个文档列表,每个文档对应板上的一个卡片。
- Return type
Iterator[Document]
- load_and_split(text_splitter: Optional[TextSplitter] = None) List[Document] ¶
加载文档并分割成块。块作为文档返回。
不要覆盖此方法。应该被视为已弃用!
- 参数:
- text_splitter: 用于分割文档的TextSplitter实例。
默认为RecursiveCharacterTextSplitter。
- 返回:
文档列表。
- Parameters
text_splitter (Optional[TextSplitter]) –
- Return type
List[Document]