New Guide Article : "Microbots : Introduction, Installation Guide and Creating Your First MicroBot" and structural changes in blog#132
Conversation
shivashanmugam
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #132 +/- ##
==========================================
+ Coverage 64.95% 65.04% +0.08%
==========================================
Files 34 34
Lines 2374 2380 +6
==========================================
+ Hits 1542 1548 +6
Misses 832 832
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
|
||
| 1. **Created a Docker container** with the `code` folder mounted using the appropriate permissions. | ||
| 2. **Sent your task** to the LLM along with a system prompt tailored to the bot type. | ||
| 3. **Executed commands** inside the container as directed by the LLM (e.g., `cat`, `grep`, `sed`). |
There was a problem hiding this comment.
Please import logging and set logging config to print INFO log in the LogAnalysisBot.py. So, user can see the individual command the LLM runs. Also, you can point them how to read the logs with some examples here.
There was a problem hiding this comment.
Enabled logging info in code and added the full log output when user is interested to see
There was a problem hiding this comment.
Can you please check whether the relevant code is pushed to GitHub. Because I cannot see the explanation text and full log between python log_analysis_bot.py command and output snippet.
There was a problem hiding this comment.
I have not added the full log of python log_analysis_bot.py as log files are excluded. I have added a article about the what each section of the log conveys to the user. I hope this is what you are expecting.
.
| |----------|------|----------|-------------| | ||
| | `model` | `str` | Yes | The LLM to use, in the format `<provider>/<model_name>`. Supported providers include `azure-openai`, `anthropic`, and `ollama`. | | ||
| | `folder_to_mount` | `str` | Yes | Path to the local folder the bot can access. For `LogAnalysisBot`, this is mounted as **read-only** inside the Docker container so the bot can read source files but never modify them. | | ||
| | `environment` | `any` | No | A custom execution environment. Defaults to a `LocalDockerEnvironment` if not provided. | |
There was a problem hiding this comment.
You don't need to mention all the possible arguments here. Please explain only those arguments. In parallel, you can generate an auto documentation and link to the class definition of LogAnalysisBot.
There was a problem hiding this comment.
Added references to LogAnalysisBot Class
There was a problem hiding this comment.
Currently, the explanation is very minimal (at section-3 of "Create your first microbot project)". Please add explanation about the api calls and their arguments (only those are there in the example). Also, the API reference page links is missing.
| ``` | ||
| Prints the bot's root-cause analysis. | ||
|
|
||
| The `my_bot.run()` method returns a `BotRunResult` object with the following fields: |
There was a problem hiding this comment.
BotRunResult should be a link to the BotRunResult class documentation. In python document generation is easier. That document you should create and make corresponding link.
There was a problem hiding this comment.
Added references to "BotRunResult
There was a problem hiding this comment.
This BotRunResult explanation and API reference linkage is missing
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <copilot@github.com>
…com/microsoft/microbots into siva/getting-started-with-microbots
There was a problem hiding this comment.
Please remove logs from being checked-in
There was a problem hiding this comment.
Removed the log files
|
|
||
| 1. **Created a Docker container** with the `code` folder mounted using the appropriate permissions. | ||
| 2. **Sent your task** to the LLM along with a system prompt tailored to the bot type. | ||
| 3. **Executed commands** inside the container as directed by the LLM (e.g., `cat`, `grep`, `sed`). |
There was a problem hiding this comment.
Can you please check whether the relevant code is pushed to GitHub. Because I cannot see the explanation text and full log between python log_analysis_bot.py command and output snippet.
| |----------|------|----------|-------------| | ||
| | `model` | `str` | Yes | The LLM to use, in the format `<provider>/<model_name>`. Supported providers include `azure-openai`, `anthropic`, and `ollama`. | | ||
| | `folder_to_mount` | `str` | Yes | Path to the local folder the bot can access. For `LogAnalysisBot`, this is mounted as **read-only** inside the Docker container so the bot can read source files but never modify them. | | ||
| | `environment` | `any` | No | A custom execution environment. Defaults to a `LocalDockerEnvironment` if not provided. | |
There was a problem hiding this comment.
Currently, the explanation is very minimal (at section-3 of "Create your first microbot project)". Please add explanation about the api calls and their arguments (only those are there in the example). Also, the API reference page links is missing.
| ``` | ||
| Prints the bot's root-cause analysis. | ||
|
|
||
| The `my_bot.run()` method returns a `BotRunResult` object with the following fields: |
There was a problem hiding this comment.
This BotRunResult explanation and API reference linkage is missing
3 participants
Changes with this PR
Bots. Tools,
From : microbots/copilot-bot/
To : microbots/advanced/bots/copilot-bot/
From : microbots/blog/guides/tesseract_ocr_tool_use/
To : microbots/advanced/tools/tesseract_ocr_tool_use/
From : /microbots/authentication/
To : microbots/advanced/authentication/