Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Release] Docs Agent version 0.1.6 #182

Merged
merged 6 commits into from
Dec 12, 2023
Merged

[Release] Docs Agent version 0.1.6 #182

merged 6 commits into from
Dec 12, 2023

Conversation

kyolee415
Copy link
Collaborator

Description of the change

  • Update the prompt condition to be more specific and follow
    best practices in prompting.
  • Enable the chatbot server to provide a custom condition string to
    the DocsAgent class.
  • Bug fix: Provide a custom condition when asking for 5 related
    questions to the PaLM model.
  • Add a new config variable to specify the log level to be "VERBOSE"
  • Improve the rendering of code text and code blocks on the chat app UI.
  • Rephrase the sentence that describes the page, section, and subsection
    structure of Markdown pages in the markdown_to_plain_text.py script.
  • Update the pre-processing diagram to fix a typo (appscripts to apps_script)

Motivation

A periodic pull request created to add new features and fix bugs in Docs Agent.

Type of change

Choose one: Bug fix

Checklist

  • [X ] I have performed a self-review of my code.
  • [X ] I have added detailed comments to my code where applicable.
  • [X ] I have verified that my change does not break existing code.
  • [X ] My PR is based on the latest changes of the main branch (if unsure, please run git pull --rebase upstream main).
  • [X ] I am familiar with the Google Style Guide for the language I have coded in.
  • [X ] I have read through the Contributing Guide and signed the Contributor License Agreement.

kyolee415 and others added 6 commits October 27, 2023 23:20
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.
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.
What's changed:

- Update the prompt condition to be more specific and follow
  best practices in prompting.
- Enable the chatbot server to provide a custom condition string to
  the DocsAgent class.
- Bug fix: Provide a custom condition when asking for 5 related
  questions to the PaLM model.
- Add a new config variable to specify the log level to be "VERBOSE"
- Improve the rendering of code text and code blocks on the chat app UI.
- Rephrase the sentence that describes the page, section, and subsection
  structure of Markdown pages in the `markdown_to_plain_text.py` script.
- Update the pre-processing diagram to fix a typo (`appscripts` to `apps_script`)
@github-actions github-actions bot added status:awaiting review PR awaiting review from a maintainer component:demos Update demos demos:docs-agent labels Dec 12, 2023
@kyolee415 kyolee415 merged commit 911720f into google:main Dec 12, 2023
3 checks passed
@github-actions github-actions bot removed the status:awaiting review PR awaiting review from a maintainer label Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants