diff --git a/docs/en/tools/automation/composiotool.mdx b/docs/en/tools/automation/composiotool.mdx index b8edbc253..9613aeb19 100644 --- a/docs/en/tools/automation/composiotool.mdx +++ b/docs/en/tools/automation/composiotool.mdx @@ -18,77 +18,46 @@ Composio is an integration platform that allows you to connect your AI agents to To incorporate Composio tools into your project, follow the instructions below: ```shell -pip install composio-crewai +pip install composio composio-crewai pip install crewai ``` -After the installation is complete, either run `composio login` or export your composio API key as `COMPOSIO_API_KEY`. Get your Composio API key from [here](https://app.composio.dev) +After the installation is complete, set your Composio API key as `COMPOSIO_API_KEY`. Get your Composio API key from [here](https://platform.composio.dev) ## Example The following example demonstrates how to initialize the tool and execute a github action: -1. Initialize Composio toolset +1. Initialize Composio with CrewAI Provider ```python Code -from composio_crewai import ComposioToolSet, App, Action +from composio_crewai import ComposioProvider +from composio import Composio from crewai import Agent, Task, Crew -toolset = ComposioToolSet() +composio = Composio(provider=ComposioProvider()) ``` -2. Connect your GitHub account +2. Create a new Composio Session and retrieve the tools -```shell CLI -composio add github -``` -```python Code -request = toolset.initiate_connection(app=App.GITHUB) -print(f"Open this URL to authenticate: {request.redirectUrl}") +```python +session = composio.create( + user_id="your-user-id", + toolkits=["gmail", "github"] # optional, default is all toolkits +) +tools = session.tools() ``` +Read more about sessions and user management [here](https://docs.composio.dev/docs/configuring-sessions) -3. Get Tools +3. Authenticating users manually -- Retrieving all the tools from an app (not recommended for production): +Composio automatically authenticates the users during the agent chat session. However, you can also authenticate the user manually by calling the `authorize` method. ```python Code -tools = toolset.get_tools(apps=[App.GITHUB]) +connection_request = session.authorize("github") +print(f"Open this URL to authenticate: {connection_request.redirect_url}") ``` -- Filtering tools based on tags: -```python Code -tag = "users" - -filtered_action_enums = toolset.find_actions_by_tags( - App.GITHUB, - tags=[tag], -) - -tools = toolset.get_tools(actions=filtered_action_enums) -``` - -- Filtering tools based on use case: -```python Code -use_case = "Star a repository on GitHub" - -filtered_action_enums = toolset.find_actions_by_use_case( - App.GITHUB, use_case=use_case, advanced=False -) - -tools = toolset.get_tools(actions=filtered_action_enums) -``` -Set `advanced` to True to get actions for complex use cases - -- Using specific tools: - -In this demo, we will use the `GITHUB_STAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER` action from the GitHub app. -```python Code -tools = toolset.get_tools( - actions=[Action.GITHUB_STAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER] -) -``` -Learn more about filtering actions [here](https://docs.composio.dev/patterns/tools/use-tools/use-specific-actions) - 4. Define agent ```python Code @@ -116,4 +85,4 @@ crew = Crew(agents=[crewai_agent], tasks=[task]) crew.kickoff() ``` -* More detailed list of tools can be found [here](https://app.composio.dev) +* More detailed list of tools can be found [here](https://docs.composio.dev/toolkits) diff --git a/docs/ko/tools/automation/composiotool.mdx b/docs/ko/tools/automation/composiotool.mdx index 15c477e34..890360425 100644 --- a/docs/ko/tools/automation/composiotool.mdx +++ b/docs/ko/tools/automation/composiotool.mdx @@ -18,77 +18,46 @@ Composio는 AI 에이전트를 250개 이상의 도구와 연결할 수 있는 Composio 도구를 프로젝트에 통합하려면 아래 지침을 따르세요: ```shell -pip install composio-crewai +pip install composio composio-crewai pip install crewai ``` -설치가 완료된 후, `composio login`을 실행하거나 Composio API 키를 `COMPOSIO_API_KEY`로 export하세요. Composio API 키는 [여기](https://app.composio.dev)에서 받을 수 있습니다. +설치가 완료되면 Composio API 키를 `COMPOSIO_API_KEY`로 설정하세요. Composio API 키는 [여기](https://platform.composio.dev)에서 받을 수 있습니다. ## 예시 -다음 예시는 도구를 초기화하고 github action을 실행하는 방법을 보여줍니다: +다음 예시는 도구를 초기화하고 GitHub 액션을 실행하는 방법을 보여줍니다: -1. Composio 도구 세트 초기화 +1. CrewAI Provider와 함께 Composio 초기화 ```python Code -from composio_crewai import ComposioToolSet, App, Action +from composio_crewai import ComposioProvider +from composio import Composio from crewai import Agent, Task, Crew -toolset = ComposioToolSet() +composio = Composio(provider=ComposioProvider()) ``` -2. GitHub 계정 연결 +2. 새 Composio 세션을 만들고 도구 가져오기 -```shell CLI -composio add github -``` -```python Code -request = toolset.initiate_connection(app=App.GITHUB) -print(f"Open this URL to authenticate: {request.redirectUrl}") +```python +session = composio.create( + user_id="your-user-id", + toolkits=["gmail", "github"] # optional, default is all toolkits +) +tools = session.tools() ``` +세션 및 사용자 관리에 대한 자세한 내용은 [여기](https://docs.composio.dev/docs/configuring-sessions)를 참고하세요. -3. 도구 가져오기 +3. 사용자 수동 인증하기 -- 앱에서 모든 도구를 가져오기 (프로덕션 환경에서는 권장하지 않음): +Composio는 에이전트 채팅 세션 중에 사용자를 자동으로 인증합니다. 하지만 `authorize` 메서드를 호출해 사용자를 수동으로 인증할 수도 있습니다. ```python Code -tools = toolset.get_tools(apps=[App.GITHUB]) +connection_request = session.authorize("github") +print(f"Open this URL to authenticate: {connection_request.redirect_url}") ``` -- 태그를 기반으로 도구 필터링: -```python Code -tag = "users" - -filtered_action_enums = toolset.find_actions_by_tags( - App.GITHUB, - tags=[tag], -) - -tools = toolset.get_tools(actions=filtered_action_enums) -``` - -- 사용 사례를 기반으로 도구 필터링: -```python Code -use_case = "Star a repository on GitHub" - -filtered_action_enums = toolset.find_actions_by_use_case( - App.GITHUB, use_case=use_case, advanced=False -) - -tools = toolset.get_tools(actions=filtered_action_enums) -``` -`advanced`를 True로 설정하면 복잡한 사용 사례를 위한 액션을 가져올 수 있습니다 - -- 특정 도구 사용하기: - -이 데모에서는 GitHub 앱의 `GITHUB_STAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER` 액션을 사용합니다. -```python Code -tools = toolset.get_tools( - actions=[Action.GITHUB_STAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER] -) -``` -액션 필터링에 대해 더 자세한 내용을 보려면 [여기](https://docs.composio.dev/patterns/tools/use-tools/use-specific-actions)를 참고하세요. - 4. 에이전트 정의 ```python Code @@ -116,4 +85,4 @@ crew = Crew(agents=[crewai_agent], tasks=[task]) crew.kickoff() ``` -* 더욱 자세한 도구 리스트는 [여기](https://app.composio.dev)에서 확인하실 수 있습니다. \ No newline at end of file +* 더욱 자세한 도구 목록은 [여기](https://docs.composio.dev/toolkits)에서 확인할 수 있습니다. \ No newline at end of file diff --git a/docs/pt-BR/tools/automation/composiotool.mdx b/docs/pt-BR/tools/automation/composiotool.mdx index eb0db8578..60cce293a 100644 --- a/docs/pt-BR/tools/automation/composiotool.mdx +++ b/docs/pt-BR/tools/automation/composiotool.mdx @@ -11,84 +11,53 @@ mode: "wide" Composio é uma plataforma de integração que permite conectar seus agentes de IA a mais de 250 ferramentas. Os principais recursos incluem: - **Autenticação de Nível Empresarial**: Suporte integrado para OAuth, Chaves de API, JWT com atualização automática de token -- **Observabilidade Completa**: Logs detalhados de uso das ferramentas, registros de execução, e muito mais +- **Observabilidade Completa**: Logs detalhados de uso das ferramentas, carimbos de data/hora de execução e muito mais ## Instalação Para incorporar as ferramentas Composio em seu projeto, siga as instruções abaixo: ```shell -pip install composio-crewai +pip install composio composio-crewai pip install crewai ``` -Após a conclusão da instalação, execute `composio login` ou exporte sua chave de API do composio como `COMPOSIO_API_KEY`. Obtenha sua chave de API Composio [aqui](https://app.composio.dev) +Após concluir a instalação, defina sua chave de API do Composio como `COMPOSIO_API_KEY`. Obtenha sua chave de API do Composio [aqui](https://platform.composio.dev) ## Exemplo -O exemplo a seguir demonstra como inicializar a ferramenta e executar uma ação do github: +O exemplo a seguir demonstra como inicializar a ferramenta e executar uma ação do GitHub: -1. Inicialize o conjunto de ferramentas Composio +1. Inicialize o Composio com o Provider do CrewAI ```python Code -from composio_crewai import ComposioToolSet, App, Action +from composio_crewai import ComposioProvider +from composio import Composio from crewai import Agent, Task, Crew -toolset = ComposioToolSet() +composio = Composio(provider=ComposioProvider()) ``` -2. Conecte sua conta do GitHub +2. Crie uma nova sessão Composio e recupere as ferramentas -```shell CLI -composio add github -``` -```python Code -request = toolset.initiate_connection(app=App.GITHUB) -print(f"Open this URL to authenticate: {request.redirectUrl}") +```python +session = composio.create( + user_id="your-user-id", + toolkits=["gmail", "github"] # optional, default is all toolkits +) +tools = session.tools() ``` +Leia mais sobre sessões e gerenciamento de usuários [aqui](https://docs.composio.dev/docs/configuring-sessions) -3. Obtenha ferramentas +3. Autenticação manual dos usuários -- Recuperando todas as ferramentas de um app (não recomendado em produção): +O Composio autentica automaticamente os usuários durante a sessão de chat do agente. No entanto, você também pode autenticar o usuário manualmente chamando o método `authorize`. ```python Code -tools = toolset.get_tools(apps=[App.GITHUB]) +connection_request = session.authorize("github") +print(f"Open this URL to authenticate: {connection_request.redirect_url}") ``` -- Filtrando ferramentas com base em tags: -```python Code -tag = "users" - -filtered_action_enums = toolset.find_actions_by_tags( - App.GITHUB, - tags=[tag], -) - -tools = toolset.get_tools(actions=filtered_action_enums) -``` - -- Filtrando ferramentas com base no caso de uso: -```python Code -use_case = "Star a repository on GitHub" - -filtered_action_enums = toolset.find_actions_by_use_case( - App.GITHUB, use_case=use_case, advanced=False -) - -tools = toolset.get_tools(actions=filtered_action_enums) -``` -Defina `advanced` como True para obter ações para casos de uso complexos - -- Usando ferramentas específicas: - -Neste exemplo, usaremos a ação `GITHUB_STAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER` do app GitHub. -```python Code -tools = toolset.get_tools( - actions=[Action.GITHUB_STAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER] -) -``` -Saiba mais sobre como filtrar ações [aqui](https://docs.composio.dev/patterns/tools/use-tools/use-specific-actions) - 4. Defina o agente ```python Code @@ -116,4 +85,4 @@ crew = Crew(agents=[crewai_agent], tasks=[task]) crew.kickoff() ``` -* Uma lista mais detalhada de ferramentas pode ser encontrada [aqui](https://app.composio.dev) \ No newline at end of file +* Uma lista mais detalhada de ferramentas pode ser encontrada [aqui](https://docs.composio.dev/toolkits) \ No newline at end of file