mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-05-01 07:13:00 +00:00
docs: Docs updates (#3459)
* 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
This commit is contained in:
@@ -2,6 +2,7 @@
|
||||
title: Arxiv Paper Tool
|
||||
description: The `ArxivPaperTool` searches arXiv for papers matching a query and optionally downloads PDFs.
|
||||
icon: box-archive
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `ArxivPaperTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Brave Search
|
||||
description: The `BraveSearchTool` is designed to search the internet using the Brave Search API.
|
||||
icon: searchengin
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `BraveSearchTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Code Docs RAG Search
|
||||
description: The `CodeDocsSearchTool` is a powerful RAG (Retrieval-Augmented Generation) tool designed for semantic searches within code documentation.
|
||||
icon: code
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `CodeDocsSearchTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Databricks SQL Query Tool
|
||||
description: The `DatabricksQueryTool` executes SQL queries against Databricks workspace tables.
|
||||
icon: trowel-bricks
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `DatabricksQueryTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: EXA Search Web Loader
|
||||
description: The `EXASearchTool` is designed to perform a semantic search for a specified query from a text's content across the internet.
|
||||
icon: globe-pointer
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `EXASearchTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Github Search
|
||||
description: The `GithubSearchTool` is designed to search websites and convert them into clean markdown or structured data.
|
||||
icon: github
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `GithubSearchTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Linkup Search Tool
|
||||
description: The `LinkupSearchTool` enables querying the Linkup API for contextual information.
|
||||
icon: link
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `LinkupSearchTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: "Overview"
|
||||
description: "Perform web searches, find repositories, and research information across the internet"
|
||||
icon: "face-smile"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
These tools enable your agents to search the web, research topics, and find information across various platforms including search engines, GitHub, and YouTube.
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: SerpApi Google Search Tool
|
||||
description: The `SerpApiGoogleSearchTool` performs Google searches using the SerpApi service.
|
||||
icon: google
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `SerpApiGoogleSearchTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: SerpApi Google Shopping Tool
|
||||
description: The `SerpApiGoogleShoppingTool` searches Google Shopping results using SerpApi.
|
||||
icon: cart-shopping
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `SerpApiGoogleShoppingTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Google Serper Search
|
||||
description: The `SerperDevTool` is designed to search the internet and return the most relevant results.
|
||||
icon: google
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `SerperDevTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: "Tavily Extractor Tool"
|
||||
description: "Extract structured content from web pages using the Tavily API"
|
||||
icon: square-poll-horizontal
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
The `TavilyExtractorTool` allows CrewAI agents to extract structured content from web pages using the Tavily API. It can process single URLs or lists of URLs and provides options for controlling the extraction depth and including images.
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: "Tavily Search Tool"
|
||||
description: "Perform comprehensive web searches using the Tavily Search API"
|
||||
icon: "magnifying-glass"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
The `TavilySearchTool` provides an interface to the Tavily Search API, enabling CrewAI agents to perform comprehensive web searches. It allows for specifying search depth, topics, time ranges, included/excluded domains, and whether to include direct answers, raw content, or images in the results.
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Website RAG Search
|
||||
description: The `WebsiteSearchTool` is designed to perform a RAG (Retrieval-Augmented Generation) search within the content of a website.
|
||||
icon: globe-stand
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `WebsiteSearchTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: YouTube Channel RAG Search
|
||||
description: The `YoutubeChannelSearchTool` is designed to perform a RAG (Retrieval-Augmented Generation) search within the content of a Youtube channel.
|
||||
icon: youtube
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `YoutubeChannelSearchTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: YouTube Video RAG Search
|
||||
description: The `YoutubeVideoSearchTool` is designed to perform a RAG (Retrieval-Augmented Generation) search within the content of a Youtube video.
|
||||
icon: youtube
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `YoutubeVideoSearchTool`
|
||||
|
||||
Reference in New Issue
Block a user