Skip to content

Commit 6678542

Browse files
authored
[Release] Docs Agent version 0.1.5 (google#168)
* [Release] Docs Agent version 0.1.4 What's changed: - Bug fix: Update `docs_agent.py` to remove a no-longer-in-use error message variable. - Clean up the prompt format in Docs Agent - Context is added to prompts as Markdown - Remove extra new lines in context - Add extra new lines after the instruction and before the question in prompts. - Remove the warning message in the Chroma module, which as displayed when launching the chatbot. - Update the embeddings diagrams in the main `README` file. - Minor updates in the main `README` file. * [Release] Docs Agent version 0.1.5 What's changed: - Update the `poetry.lock` file to bump up the version of `werkzeug` - Update the introduction paragraph of the main `README` file. - Add a new diagram on Docs Agent's pre-processing flow of various doc types. - Update the `README` file in the `script` directory to include the diagram.
1 parent e0d216f commit 6678542

File tree

5 files changed

+521
-538
lines changed

5 files changed

+521
-538
lines changed

demos/palm/python/docs-agent/README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
11
# Docs Agent
22

33
The Docs Agent project enables [PaLM API][genai-doc-site] users to launch a chat application
4-
on a Linux-based host machine using their own set of documents as a source dataset.
4+
on a Linux host machine using their documents as a dataset.
55

6-
**Note**: If you're interested in setting up and launching the Docs Agent sample app on your
7-
host machine, see the [Set up Docs Agent][set-up-docs-agent] section below.
6+
**Note**: If you want to set up and launch the Docs Agent sample app on your host machine,
7+
check out the [Set up Docs Agent][set-up-docs-agent] section below.
88

99
## Overview
1010

11-
The Docs Agent sample app is being developed to demonstrate an AI-powered chatbot application
11+
The Docs Agent project is being developed to demonstrate an AI-powered chatbot application
1212
(including a backend server and web UI) that can answer questions specific to any product,
13-
service, or topic that has a great quantity of information available as documentation (which
14-
can be from various sources such as Markdown, HTML, Google Docs, chat conversations, etc.).
13+
service, or topic that has a large amount of information available in documentation (which
14+
can be from various sources such as Markdown, HTML, Google Docs, Gmail, PDF, etc.).
1515

1616
The main goal of the Docs Agent project is:
1717

18-
- You can supply your own set of documents to enable a PaLM 2 model to synthesize useful,
18+
- You can supply your own set of documents to enable a PaLM 2 model to generate useful,
1919
relevant, and accurate responses that are grounded on the documented information.
2020

2121
The Docs Agent sample app is designed to be easily set up and configured in a Linux environment
2222
and is required that you have access to Google’s [PaLM API][genai-doc-site].
2323

24-
Keep in mind that this approach is not to “fine-tune” an LLM (large language model)
25-
itself, but the Docs Agent sample app uses a mixture of prompt engineering and
26-
embeddings techniques on top of a publicly available LLM model such as PaLM 2.
24+
Keep in mind that this approach does not involve “fine-tuning” an LLM (large language model).
25+
Instead, the Docs Agent sample app uses a mixture of prompt engineering and embedding techniques,
26+
also known as Retrieval Augmented Generation (RAG), on top of a publicly available LLM model
27+
like PaLM 2.
2728

2829
![Docs Agent architecture](docs/images/docs-agent-architecture-01.png)
2930

@@ -310,6 +311,10 @@ The project includes Apps Script files that allow you to convert various sources
310311
use these Markdown files as additional input sources for Docs Agent. For more information, see the
311312
[`README`][apps-script-readme] file in the `apps_script` directory.
312313

314+
![Docs Agent pre-processing flow](docs/images/docs-agent-pre-processing-01.png)
315+
316+
**Figure 7**. Docs Agent's pre-processing flow for various doc types.
317+
313318
## Issues identified
314319

315320
The following issues have been identified and need to be worked on:
334 KB
Loading

0 commit comments

Comments
 (0)