From e3ebeb9ddef6d44aee339f982cb8c084ccf05c6a Mon Sep 17 00:00:00 2001 From: chowderhead Date: Sat, 30 Mar 2024 11:56:34 -0300 Subject: [PATCH] Update GitHubSearchTool.md (#390) Import statement has a lower case h --- docs/tools/GitHubSearchTool.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/tools/GitHubSearchTool.md b/docs/tools/GitHubSearchTool.md index 75e42db64..6751da598 100644 --- a/docs/tools/GitHubSearchTool.md +++ b/docs/tools/GitHubSearchTool.md @@ -1,27 +1,27 @@ -# GitHubSearchTool +# GithubSearchTool !!! note "Experimental" We are still working on improving tools, so there might be unexpected behavior or changes in the future. ## Description -The GitHubSearchTool is a Read, Append, and Generate (RAG) tool specifically designed for conducting semantic searches within GitHub repositories. Utilizing advanced semantic search capabilities, it sifts through code, pull requests, issues, and repositories, making it an essential tool for developers, researchers, or anyone in need of precise information from GitHub. +The GithubSearchTool is a Read, Append, and Generate (RAG) tool specifically designed for conducting semantic searches within GitHub repositories. Utilizing advanced semantic search capabilities, it sifts through code, pull requests, issues, and repositories, making it an essential tool for developers, researchers, or anyone in need of precise information from GitHub. ## Installation -To use the GitHubSearchTool, first ensure the crewai_tools package is installed in your Python environment: +To use the GithubSearchTool, first ensure the crewai_tools package is installed in your Python environment: ```shell pip install 'crewai[tools]' ``` -This command installs the necessary package to run the GitHubSearchTool along with any other tools included in the crewai_tools package. +This command installs the necessary package to run the GithubSearchTool along with any other tools included in the crewai_tools package. ## Example -Here’s how you can use the GitHubSearchTool to perform semantic searches within a GitHub repository: +Here’s how you can use the GithubSearchTool to perform semantic searches within a GitHub repository: ```python -from crewai_tools import GitHubSearchTool +from crewai_tools import GithubSearchTool # Initialize the tool for semantic searches within a specific GitHub repository -tool = GitHubSearchTool( +tool = GithubSearchTool( github_repo='https://github.com/example/repo', content_types=['code', 'issue'] # Options: code, repo, pr, issue ) @@ -29,7 +29,7 @@ tool = GitHubSearchTool( # OR # Initialize the tool for semantic searches within a specific GitHub repository, so the agent can search any repository if it learns about during its execution -tool = GitHubSearchTool( +tool = GithubSearchTool( content_types=['code', 'issue'] # Options: code, repo, pr, issue ) ``` @@ -43,7 +43,7 @@ tool = GitHubSearchTool( By default, the tool uses OpenAI for both embeddings and summarization. To customize the model, you can use a config dictionary as follows: ```python -tool = GitHubSearchTool( +tool = GithubSearchTool( config=dict( llm=dict( provider="ollama", # or google, openai, anthropic, llama2, ...