Skip to content

Commit

Permalink
[Release] Docs Agent version 0.1.5
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
kyolee415 committed Nov 3, 2023
1 parent 47b8461 commit e69f828
Show file tree
Hide file tree
Showing 5 changed files with 521 additions and 538 deletions.
25 changes: 15 additions & 10 deletions demos/palm/python/docs-agent/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,30 @@
# Docs Agent

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

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

## Overview

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

The main goal of the Docs Agent project is:

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

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

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

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

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

![Docs Agent pre-processing flow](docs/images/docs-agent-pre-processing-01.png)

**Figure 7**. Docs Agent's pre-processing flow for various doc types.

## Issues identified

The following issues have been identified and need to be worked on:
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit e69f828

Please sign in to comment.