OutlineAPIWrapper

class langchain_community.utilities.outline.OutlineAPIWrapper

Bases: BaseModel

Wrapper around OutlineAPI.

This wrapper will use the Outline API to query the documents of your instance. By default it will return the document content of the top-k results. It limits the document content by doc_content_chars_max.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

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]

Run Outline search and get the document content plus the meta information.

Returns: a list of documents.

Parameters:

query (str)

Return type:

List[Document]