diff --git a/README.md b/README.md index 5028efd..64dd781 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ This powerful functionality is made possible through [jupyter-nbmodel-client](ht > [!WARNING] > > jupyter-nbmodel-client and jupyter-kernel-client are experimental and under active development. -> Unexpected behavior such as ["Panic Exception"](https://github.com/datalayer/jupyter-nbmodel-client/issues/12) may occur, due to potential issue generated by 3rd party projects. +> Unexpected behavior may occur, due to potential issue generated by 3rd party projects. ## Usage @@ -83,7 +83,7 @@ AZURE_OPENAI_API_KEY="..." EOF ``` -To use the Jupyter AI Agent, an easy way is to launch a CLI (update the Azure deployment based on your setup). +To use the Jupyter AI Agent, an easy way is to launch a CLI (update the Azure deployment name based on your setup). ```bash # Prompt agent example. diff --git a/docs/docs/agents/explain_error/index.mdx b/docs/docs/agents/explain_error/index.mdx index a51e006..bbc6a36 100644 --- a/docs/docs/agents/explain_error/index.mdx +++ b/docs/docs/agents/explain_error/index.mdx @@ -1,6 +1,6 @@ # Explain Error Agent -The Explain Error Agent explains the first error encountered in a notebook. It leverages AI models to explain the error in the code cell, providing insights into the error and potential solutions by adding new cells. This is a great Agent to support the following use cases: +The Explain Error Agent explains an error encountered in a notebook. It leverages AI models to explain the error in the code cell, providing insights into the error and potential solutions by adding new cells. This is a great Agent to support the following use cases: - Error Explanation: Explain the error encountered in the code cell. - Error Resolution: Provide potential solutions to resolve the error. @@ -21,3 +21,4 @@ jupyter-ai-agent explain-error \ - `--token`: JupyterLab token. - `--azure-ai-deployment-name`: Azure AI model deployment name. - `--path`: Notebook to modify path. +- `--current-cell-index`: Optional flag to provide the index of the cell where the error is encountered. If not provided, the error considered is the first one in the notebook. diff --git a/docs/docs/agents/prompt/index.mdx b/docs/docs/agents/prompt/index.mdx index 8076f96..635a366 100644 --- a/docs/docs/agents/prompt/index.mdx +++ b/docs/docs/agents/prompt/index.mdx @@ -27,3 +27,4 @@ The Prompt Agent can be configured with the following parameters: - `--path`: Notebook to modify path. - `--input`: Natural language input. - `--full-context`: Optional flag to provide the full notebook context i.e. notebook content to the AI model (default: False). +- `--current-cell-index`: Optional flag to provide the index of the cell where the prompt is asked. diff --git a/docs/docs/models/azure/index.mdx b/docs/docs/models/azure/index.mdx index b7f5090..3dc178d 100644 --- a/docs/docs/models/azure/index.mdx +++ b/docs/docs/models/azure/index.mdx @@ -1,6 +1,4 @@ -# Azure - -## Azure OpenAI +# Azure OpenAI Jupyter AI Agent supports models from [Azure OpenAI](https://azure.microsoft.com/en-us/products/ai-services/openai-service). diff --git a/docs/docs/tools/index.mdx b/docs/docs/tools/index.mdx index b7d178b..9349e74 100644 --- a/docs/docs/tools/index.mdx +++ b/docs/docs/tools/index.mdx @@ -2,16 +2,15 @@ The Current Tools are listed here. -- **Add Code Cell** - Dynamically add new code cells to the notebook. -- **Add Markdown Cell** - Insert markdown cells to structure and document notebooks effectively. -- **Execute Code Cell** - Run code within specific cells, providing instant results. +- **Add and Execute Code Cell** - Add a new code cell at the end of the notebook and execute it. +- **Add Markdown Cell** - Add a new markdown cell at the end of the notebook. +- **Insert and Execute Code Cell** - Insert a new code cell at a specific position in the notebook and execute it. +- **Insert Markdown Cell** - Insert a new markdown cell at a specific position in the notebook. :::note -We are implementing more Tools. +We are implementing more Tools. For example: - **Modify Code Cell** - Edit existing code cells to fix errors or improve code quality. -- **Add Code Cell at a specific position** - Insert code cells at a specific location in the notebook. -- **Add Markdown Cell at a specific position** - Insert markdown cells at a specific location in the notebook. - +- **Modify Markdown Cell** - Edit existing markdown cells to improve documentation quality. ::: diff --git a/docs/docs/use-cases/index.mdx b/docs/docs/use-cases/index.mdx index bcbe7c8..e5c0849 100644 --- a/docs/docs/use-cases/index.mdx +++ b/docs/docs/use-cases/index.mdx @@ -4,9 +4,8 @@ The available [Agents](/docs/agents) support following use cases. - **Automated Data Analysis** - Generate and execute Python scripts to analyze data, create visualizations, or preprocess datasets. - **Error Debugging** - Identify and explain errors in code execution, with actionable suggestions to fix them. -- **Notebook Refactoring** - Automatically optimize code structure, improve readability, or add detailed documentation. -We are building new Agents to support more use cases. +We are working on UI to easily interact with the Agents and plan on building new Agents to support more use cases. - **Creating a UI for Chatting with the Agent in JupyterLab** - Developing an interactive interface within JupyterLab where users can directly communicate with the Jupyter AI Agent, issuing commands and receiving real-time responses