mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-09 08:08:32 +00:00
1a1bb0ca3d
* docs(cli): document device-code login and config reset guidance; renumber sections * docs(cli): fix duplicate numbering (renumber Login/API Keys/Configuration sections) * docs: Fix webhook documentation to include meta dict in all webhook payloads - Add note explaining that meta objects from kickoff requests are included in all webhook payloads - Update webhook examples to show proper payload structure including meta field - Fix webhook examples to match actual API implementation - Apply changes to English, Korean, and Portuguese documentation Resolves the documentation gap where meta dict passing to webhooks was not documented despite being implemented in the API. * WIP: CrewAI docs theme, changelog, GEO, localization * docs(cli): fix merge markers; ensure mode: "wide"; convert ASCII tables to Markdown (en/pt-BR/ko) * docs: add group icons across locales; split Automation/Integrations; update tools overviews and links
85 lines
3.5 KiB
Plaintext
85 lines
3.5 KiB
Plaintext
---
|
|
title: Github Search
|
|
description: O `GithubSearchTool` foi desenvolvido para pesquisar sites e convertê-los em markdown limpo ou dados estruturados.
|
|
icon: github
|
|
mode: "wide"
|
|
---
|
|
|
|
# `GithubSearchTool`
|
|
|
|
<Note>
|
|
Ainda estamos trabalhando para melhorar as ferramentas, portanto pode haver comportamentos inesperados ou mudanças no futuro.
|
|
</Note>
|
|
|
|
## Descrição
|
|
|
|
O GithubSearchTool é uma ferramenta de Recuperação Aprimorada por Geração (RAG) especificamente projetada para realizar buscas semânticas em repositórios GitHub. Utilizando funcionalidades avançadas de busca semântica, ele examina códigos, pull requests, issues e repositórios, tornando-se uma ferramenta essencial para desenvolvedores, pesquisadores ou qualquer pessoa que precise de informações precisas do GitHub.
|
|
|
|
## Instalação
|
|
|
|
Para usar o GithubSearchTool, primeiro certifique-se de que o pacote crewai_tools está instalado em seu ambiente Python:
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
Esse comando instala o pacote necessário para rodar o GithubSearchTool juntamente com outras ferramentas incluídas no pacote crewai_tools.
|
|
|
|
## Exemplo
|
|
|
|
Veja como você pode usar o GithubSearchTool para realizar buscas semânticas dentro de um repositório GitHub:
|
|
|
|
```python Code
|
|
from crewai_tools import GithubSearchTool
|
|
|
|
# Inicialize a ferramenta para buscas semânticas em um repositório GitHub específico
|
|
tool = GithubSearchTool(
|
|
github_repo='https://github.com/example/repo',
|
|
gh_token='your_github_personal_access_token',
|
|
content_types=['code', 'issue'] # Opções: code, repo, pr, issue
|
|
)
|
|
|
|
# OU
|
|
|
|
# Inicialize a ferramenta para buscas semânticas em um repositório GitHub específico, permitindo que o agente pesquise em qualquer repositório caso tome conhecimento durante a execução
|
|
tool = GithubSearchTool(
|
|
gh_token='your_github_personal_access_token',
|
|
content_types=['code', 'issue'] # Opções: code, repo, pr, issue
|
|
)
|
|
```
|
|
|
|
## Argumentos
|
|
|
|
- `github_repo` : A URL do repositório GitHub onde a busca será realizada. Este é um campo obrigatório e especifica o repositório alvo para sua pesquisa.
|
|
- `gh_token` : Seu Personal Access Token (PAT) do GitHub necessário para autenticação. Você pode criar um nas configurações da sua conta GitHub em Developer Settings > Personal Access Tokens.
|
|
- `content_types` : Especifica os tipos de conteúdo a serem incluídos na busca. É necessário fornecer uma lista dos tipos de conteúdo das seguintes opções: `code` para pesquisar dentro do código,
|
|
`repo` para pesquisar nas informações gerais do repositório, `pr` para pesquisar em pull requests, e `issue` para pesquisar nas issues.
|
|
Este campo é obrigatório e permite adaptar a busca para tipos específicos de conteúdo dentro do repositório GitHub.
|
|
|
|
## Modelo e embeddings personalizados
|
|
|
|
Por padrão, a ferramenta utiliza o OpenAI tanto para embeddings quanto para sumarização. Para personalizar o modelo, você pode usar um dicionário de configuração como no exemplo:
|
|
|
|
```python Code
|
|
tool = GithubSearchTool(
|
|
config=dict(
|
|
llm=dict(
|
|
provider="ollama", # ou google, openai, anthropic, llama2, ...
|
|
config=dict(
|
|
model="llama2",
|
|
# temperature=0.5,
|
|
# top_p=1,
|
|
# stream=true,
|
|
),
|
|
),
|
|
embedder=dict(
|
|
provider="google", # ou openai, ollama, ...
|
|
config=dict(
|
|
model="models/embedding-001",
|
|
task_type="retrieval_document",
|
|
# title="Embeddings",
|
|
),
|
|
),
|
|
)
|
|
)
|
|
``` |