From 71de0b37c78e063754c458f1953f27c0e75e6eb7 Mon Sep 17 00:00:00 2001 From: James Braza Date: Mon, 30 Dec 2024 15:10:49 -0500 Subject: [PATCH] Renamed headers to make it clear the agent isn't involved with direct Docs.aadd --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f45aa853..b1709334 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,8 @@ question answering, summarization, and contradiction detection. - [Bundled Settings](#bundled-settings) - [Rate Limits](#rate-limits) - [Library Usage](#library-usage) - - [`ask` manually](#ask-manually) - - [Adding Documents Manually](#adding-documents-manually) + - [Agentic Adding/Querying Documents](#agentic-addingquerying-documents) + - [Manual (No Agent) Adding/Querying Documents](#manual-no-agent-addingquerying-documents) - [Async](#async) - [Choosing Model](#choosing-model) - [Locally Hosted](#locally-hosted) @@ -303,7 +303,7 @@ answer_response = ask( Please see our [installation docs](#installation) for how to install the package from PyPI. -### `ask` manually +### Agentic Adding/Querying Documents The answer object has the following attributes: `formatted_answer`, `answer` (answer alone), `question` , and `context` (the summaries of passages found for answer). `ask` will use the `SearchPapers` tool, which will query a local index of files, you can specify this location via the `Settings` object: @@ -333,7 +333,7 @@ answer_response = await agent_query( The default agent will use an LLM based agent, but you can also specify a `"fake"` agent to use a hard coded call path of search -> gather evidence -> answer to reduce token usage. -### Adding Documents Manually +### Manual (No Agent) Adding/Querying Documents Normally via agent execution, the agent invokes the search tool, which adds documents to the `Docs` object for you behind the scenes.