📖 docs: integrations/agent_toolkits (#9333)

Note: There are no changes in the file names!

- The group name on the main navbar changed: `Agent toolkits` -> `Agents
& Toolkits`. Examples here are the mix of the Agent and Toolkit examples
because Agents and Toolkits in examples are always used together.
- Titles changed: removed "Agent" and "Toolkit" suffixes. The reason is
the same.
- Formatting: mostly cleaning the header structure, so it could be
better on the right-side navbar.

Main navbar is looking much cleaner now.
This commit is contained in:
Leonid Ganeline
2023-08-23 23:17:47 -07:00
committed by GitHub
parent c19888c12c
commit b048236c1a
22 changed files with 248 additions and 267 deletions

View File

@@ -4,9 +4,10 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Github Toolkit\n",
"# Github\n",
"\n",
"The Github toolkit contains tools that enable an LLM agent to interact with a github repository. The tools are a wrapper for the [PyGitHub](https://github.com/PyGithub/PyGithub) library. \n",
"The `Github` toolkit contains tools that enable an LLM agent to interact with a github repository. \n",
"The tool is a wrapper for the [PyGitHub](https://github.com/PyGithub/PyGithub) library. \n",
"\n",
"## Quickstart\n",
"1. Install the pygithub library\n",
@@ -38,7 +39,14 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## 1. Install the pygithub library"
"## Setup"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### 1. Install the `pygithub` library "
]
},
{
@@ -58,7 +66,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## 2. Create a Github App\n",
"### 2. Create a Github App\n",
"\n",
"[Follow the instructions here](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) to create and register a Github app. Make sure your app has the following [repository permissions:](https://docs.github.com/en/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28)\n",
"* Commit statuses (read only)\n",
@@ -71,7 +79,7 @@
"\n",
"Once the app has been registered, add it to the repository you wish the bot to act upon.\n",
"\n",
"## 3. Set Environmental Variables\n",
"### 3. Set Environmental Variables\n",
"\n",
"Before initializing your agent, the following environmental variables need to be set:\n",
"\n",
@@ -86,7 +94,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Example Usage- Simple Agent"
"## Example: Simple Agent"
]
},
{
@@ -212,7 +220,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Example Usage- Advanced Agent\n",
"## Example: Advanced Agent\n",
"\n",
"If your agent does not need to use all 8 tools, you can build tools individually to use. For this example, we'll make an agent that does not use the create_file, delete_file or create_pull_request tools, but can also use duckduckgo-search."
]
@@ -375,9 +383,9 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.16"
"version": "3.10.12"
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}