mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-22 06:18:14 +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: CSV RAG Search
|
||||
description: The `CSVSearchTool` is a powerful RAG (Retrieval-Augmented Generation) tool designed for semantic searches within a CSV file's content.
|
||||
icon: file-csv
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `CSVSearchTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Directory Read
|
||||
description: The `DirectoryReadTool` is a powerful utility designed to provide a comprehensive listing of directory contents.
|
||||
icon: folder-tree
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `DirectoryReadTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Directory RAG Search
|
||||
description: The `DirectorySearchTool` is a powerful RAG (Retrieval-Augmented Generation) tool designed for semantic searches within a directory's content.
|
||||
icon: address-book
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `DirectorySearchTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: DOCX RAG Search
|
||||
description: The `DOCXSearchTool` is a RAG tool designed for semantic searching within DOCX documents.
|
||||
icon: file-word
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `DOCXSearchTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: File Read
|
||||
description: The `FileReadTool` is designed to read files from the local file system.
|
||||
icon: folders
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: File Write
|
||||
description: The `FileWriterTool` is designed to write content to files.
|
||||
icon: file-pen
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `FileWriterTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: JSON RAG Search
|
||||
description: The `JSONSearchTool` is designed to search JSON files and return the most relevant results.
|
||||
icon: file-code
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `JSONSearchTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: MDX RAG Search
|
||||
description: The `MDXSearchTool` is designed to search MDX files and return the most relevant results.
|
||||
icon: markdown
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `MDXSearchTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: OCR Tool
|
||||
description: The `OCRTool` extracts text from local images or image URLs using an LLM with vision.
|
||||
icon: image
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `OCRTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: "Overview"
|
||||
description: "Read, write, and search through various file formats with CrewAI's document processing tools"
|
||||
icon: "face-smile"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
These tools enable your agents to work with various file formats and document types. From reading PDFs to processing JSON data, these tools handle all your document processing needs.
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: PDF Text Writing Tool
|
||||
description: The `PDFTextWritingTool` writes text to specific positions in a PDF, supporting custom fonts.
|
||||
icon: file-pdf
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `PDFTextWritingTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: PDF RAG Search
|
||||
description: The `PDFSearchTool` is designed to search PDF files and return the most relevant results.
|
||||
icon: file-pdf
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `PDFSearchTool`
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: TXT RAG Search
|
||||
description: The `TXTSearchTool` is designed to perform a RAG (Retrieval-Augmented Generation) search within the content of a text file.
|
||||
icon: file-lines
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: XML RAG Search
|
||||
description: The `XMLSearchTool` is designed to perform a RAG (Retrieval-Augmented Generation) search within the content of a XML file.
|
||||
icon: file-xml
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `XMLSearchTool`
|
||||
|
||||
Reference in New Issue
Block a user