langchain_community.utilities.outline.OutlineAPIWrapper

class langchain_community.utilities.outline.OutlineAPIWrapper[source]

基类: BaseModel

OutlineAPI 的包装器。

此包装器将使用大纲API查询您的实例的文档。默认情况下,它将返回前k个结果的文档内容。它通过doc_content_chars_max限制文档内容。

通过解析和验证关键字参数中的输入数据来创建一个新的模型。

如果输入数据无法解析为有效的模型,将引发ValidationError。

参数 doc_content_chars_max : int = 4000
参数 load_all_available_meta : bool = False
参数 outline_api_key : Optional[str] = None
参数 outline_instance_url : Optional[str] = None
参数 outline_search_endpoint : str = '/api/documents.search'
参数 top_k_results : int = 3
run(query: str) List[Document][source]

运行 Outline 搜索并获取文档内容和元信息。

返回: 文档列表。

参数

query (str) –

返回类型

List[Document]