Skip to content

Commit

Permalink
Merge pull request #140 from bioimage-io/alalulu8668-patch-3
Browse files Browse the repository at this point in the history
Update documentation
  • Loading branch information
alalulu8668 authored Jun 7, 2024
2 parents 74e3d44 + c229c99 commit 4a0ce24
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
6 changes: 6 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Thank you for your interest in contributing to the BioImage.IO Chatbot. Your con
The BioImage.IO Chatbot relies on a comprehensive knowledge base to provide accurate responses to user queries. We encourage contributions to expand this knowledge base by adding new databases, information, or resources. Whether you're a researcher, developer, or domain expert, your contributions can help improve the chatbot's functionality.

## Contribution Process
### Knowledge Base

You can contribute to the chatbot's knowledge base by adding new databases or information.

Expand All @@ -22,6 +23,11 @@ Follow these steps to contribute to the BioImage.IO Chatbot:

Remember that, in any step of the process you can contact us to look for feedback or assistance. We deeply appreciate your contribution!

### Develop Custom Extenstion

The BioImage.IO Chatbot offers a framework designed for easy extensibility, allowing developers to enrich its capabilities with custom extensions. Please check details on how to contribute to the chatbot by developing custom extension [`Developing Chatbot Extensions`](./development.md).


## Contact Us

If you have any questions, need assistance, or want to contribute to the chatbot's knowledge base, please don't hesitate to contact us via [Github issues](https://github.com/bioimage-io/bioimageio-chatbot/issues). Our team is here to help you get started and make valuable contributions.
5 changes: 1 addition & 4 deletions docs/technical-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@ The BioImage.IO Chatbot employs diverse methods to generate responses, currently

### Search BioImage Docs
This extension allows the chatbot to search information in a community-driven bioimage related knowledge base. With a specific query, the chatbot extracts essential elements from the user's question to fetch information from the relevant documentation.

![direct-response](./screenshots/search-bioimage-docs.png)
![direct-response](./screenshots/search-bioimage-docs.png)
*Figure 6. Search in Bioimage Knolwedge base documentation.*

### Search BioImage Information Index (biii.eu)
Expand All @@ -57,14 +56,12 @@ This extension allows the chatbot to search bioimage related topics and software

### Search Web
This extension allows the chatbot to search for information from the web. This extension is triggered while the chatbot realizes it can not find relevant information from the knowledge base.

![search-web](./screenshots/search-web.png)
*Figure 10. Search in the web.*


### BioImage Model Zoo
This mode is designed for queries requiring detailed model information or specific actions, generating and executing Python scripts for tailored solutions.

![script-gen-exe-retrieval](./screenshots/search-model-zoo.png)
*Figure 11. Scripting retrieval for complex queries.*

Expand Down

0 comments on commit 4a0ce24

Please sign in to comment.