DocumentLookup

class lumen.ai.tools.DocumentLookup(*, min_similarity, n, vector_store, llm, memory, prompts, template_overrides, purpose, name)

The DocumentLookup tool creates a vector store of all available documents and responds with a list of the most relevant documents given the user query. Always use this for more context.

---

Parameters

min_similarity

type: Number
default: 0.1
bounds: None
The minimum similarity to include a document.

n

type: int
default: 3
bounds: (0, None)
The number of document results to return.

vector_store

type: lumen.ai.vector_store.VectorStore
default: None
Vector store object which is queried to provide additional contextbefore responding.

---

Methods

async DocumentLookup.requirements(messages: list[Message]) → list[str]

async DocumentLookup.respond(messages: list[Message], **kwargs: Any) → str

Responds to the provided messages.