OutlineAPIWrapper

class langchain_community.utilities.outline.OutlineAPIWrapper

基础类：BaseModel

围绕OutlineAPI的封装。

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

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

如果输入数据无法验证以形成有效模型，则引发 [ValidationError][pydantic_core.ValidationError]。

self 被显式地设为仅位置参数，以允许 self 作为字段名称。

param doc_content_chars_max: int = 4000

param load_all_available_meta: bool = False

param outline_api_key: str | None = None

param outline_instance_url: str | None = None

param outline_search_endpoint: str = '/api/documents.search'

param top_k_results: int = 3

run(query: str) → List[Document]

运行大纲搜索并获取文档内容及元信息。

返回：一个文档列表。

Parameters:

query (str)

Return type:

列表[文档]