mirror of
https://github.com/crewAIInc/crewAI.git
synced 2025-12-19 22:08:31 +00:00
Compare commits
4 Commits
docs/fix-d
...
docs-tools
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8d60569b82 | ||
|
|
2482c7ab68 | ||
|
|
7fdabda97e | ||
|
|
7306414de7 |
116
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
116
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,116 @@
|
|||||||
|
name: Bug report
|
||||||
|
description: Create a report to help us improve CrewAI
|
||||||
|
title: "[BUG]"
|
||||||
|
labels: ["bug"]
|
||||||
|
assignees: []
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Description
|
||||||
|
description: Provide a clear and concise description of what the bug is.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: steps-to-reproduce
|
||||||
|
attributes:
|
||||||
|
label: Steps to Reproduce
|
||||||
|
description: Provide a step-by-step process to reproduce the behavior.
|
||||||
|
placeholder: |
|
||||||
|
1. Go to '...'
|
||||||
|
2. Click on '....'
|
||||||
|
3. Scroll down to '....'
|
||||||
|
4. See error
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: expected-behavior
|
||||||
|
attributes:
|
||||||
|
label: Expected behavior
|
||||||
|
description: A clear and concise description of what you expected to happen.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: screenshots-code
|
||||||
|
attributes:
|
||||||
|
label: Screenshots/Code snippets
|
||||||
|
description: If applicable, add screenshots or code snippets to help explain your problem.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: dropdown
|
||||||
|
id: os
|
||||||
|
attributes:
|
||||||
|
label: Operating System
|
||||||
|
description: Select the operating system you're using
|
||||||
|
options:
|
||||||
|
- Ubuntu 20.04
|
||||||
|
- Ubuntu 22.04
|
||||||
|
- Ubuntu 24.04
|
||||||
|
- macOS Catalina
|
||||||
|
- macOS Big Sur
|
||||||
|
- macOS Monterey
|
||||||
|
- macOS Ventura
|
||||||
|
- macOS Sonoma
|
||||||
|
- Windows 10
|
||||||
|
- Windows 11
|
||||||
|
- Other (specify in additional context)
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: dropdown
|
||||||
|
id: python-version
|
||||||
|
attributes:
|
||||||
|
label: Python Version
|
||||||
|
description: Version of Python your Crew is running on
|
||||||
|
options:
|
||||||
|
- '3.10'
|
||||||
|
- '3.11'
|
||||||
|
- '3.12'
|
||||||
|
- '3.13'
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: crewai-version
|
||||||
|
attributes:
|
||||||
|
label: crewAI Version
|
||||||
|
description: What version of CrewAI are you using
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: crewai-tools-version
|
||||||
|
attributes:
|
||||||
|
label: crewAI Tools Version
|
||||||
|
description: What version of CrewAI Tools are you using
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: dropdown
|
||||||
|
id: virtual-environment
|
||||||
|
attributes:
|
||||||
|
label: Virtual Environment
|
||||||
|
description: What Virtual Environment are you running your crew in.
|
||||||
|
options:
|
||||||
|
- Venv
|
||||||
|
- Conda
|
||||||
|
- Poetry
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: evidence
|
||||||
|
attributes:
|
||||||
|
label: Evidence
|
||||||
|
description: Include relevant information, logs or error messages. These can be screenshots.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: possible-solution
|
||||||
|
attributes:
|
||||||
|
label: Possible Solution
|
||||||
|
description: Have a solution in mind? Please suggest it here, or write "None".
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: additional-context
|
||||||
|
attributes:
|
||||||
|
label: Additional context
|
||||||
|
description: Add any other context about the problem here.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
0
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
0
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
65
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
65
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
name: Feature request
|
||||||
|
description: Suggest a new feature for CrewAI
|
||||||
|
title: "[FEATURE]"
|
||||||
|
labels: ["feature-request"]
|
||||||
|
assignees: []
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for taking the time to fill out this feature request!
|
||||||
|
- type: dropdown
|
||||||
|
id: feature-area
|
||||||
|
attributes:
|
||||||
|
label: Feature Area
|
||||||
|
description: Which area of CrewAI does this feature primarily relate to?
|
||||||
|
options:
|
||||||
|
- Core functionality
|
||||||
|
- Agent capabilities
|
||||||
|
- Task management
|
||||||
|
- Integration with external tools
|
||||||
|
- Performance optimization
|
||||||
|
- Documentation
|
||||||
|
- Other (please specify in additional context)
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: problem
|
||||||
|
attributes:
|
||||||
|
label: Is your feature request related to a an existing bug? Please link it here.
|
||||||
|
description: A link to the bug or NA if not related to an existing bug.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: solution
|
||||||
|
attributes:
|
||||||
|
label: Describe the solution you'd like
|
||||||
|
description: A clear and concise description of what you want to happen.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: alternatives
|
||||||
|
attributes:
|
||||||
|
label: Describe alternatives you've considered
|
||||||
|
description: A clear and concise description of any alternative solutions or features you've considered.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: context
|
||||||
|
attributes:
|
||||||
|
label: Additional context
|
||||||
|
description: Add any other context, screenshots, or examples about the feature request here.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: dropdown
|
||||||
|
id: willingness-to-contribute
|
||||||
|
attributes:
|
||||||
|
label: Willingness to Contribute
|
||||||
|
description: Would you be willing to contribute to the implementation of this feature?
|
||||||
|
options:
|
||||||
|
- Yes, I'd be happy to submit a pull request
|
||||||
|
- I could provide more detailed specifications
|
||||||
|
- I can test the feature once it's implemented
|
||||||
|
- No, I'm just suggesting the idea
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
@@ -154,15 +154,15 @@ email_summarizer_task:
|
|||||||
Use the annotations to properly reference the agent and task in the crew.py file.
|
Use the annotations to properly reference the agent and task in the crew.py file.
|
||||||
|
|
||||||
### Annotations include:
|
### Annotations include:
|
||||||
* @agent
|
* [@agent](https://github.com/crewAIInc/crewAI/blob/97d7bfb52ad49a9f04db360e1b6612d98c91971e/src/crewai/project/annotations.py#L17)
|
||||||
* @task
|
* [@task](https://github.com/crewAIInc/crewAI/blob/97d7bfb52ad49a9f04db360e1b6612d98c91971e/src/crewai/project/annotations.py#L4)
|
||||||
* @crew
|
* [@crew](https://github.com/crewAIInc/crewAI/blob/97d7bfb52ad49a9f04db360e1b6612d98c91971e/src/crewai/project/annotations.py#L69)
|
||||||
* @llm
|
* [@llm](https://github.com/crewAIInc/crewAI/blob/97d7bfb52ad49a9f04db360e1b6612d98c91971e/src/crewai/project/annotations.py#L23)
|
||||||
* @tool
|
* [@tool](https://github.com/crewAIInc/crewAI/blob/97d7bfb52ad49a9f04db360e1b6612d98c91971e/src/crewai/project/annotations.py#L39)
|
||||||
* @callback
|
* [@callback](https://github.com/crewAIInc/crewAI/blob/97d7bfb52ad49a9f04db360e1b6612d98c91971e/src/crewai/project/annotations.py#L44)
|
||||||
* @output_json
|
* [@output_json](https://github.com/crewAIInc/crewAI/blob/97d7bfb52ad49a9f04db360e1b6612d98c91971e/src/crewai/project/annotations.py#L29)
|
||||||
* @output_pydantic
|
* [@output_pydantic](https://github.com/crewAIInc/crewAI/blob/97d7bfb52ad49a9f04db360e1b6612d98c91971e/src/crewai/project/annotations.py#L34)
|
||||||
* @cache_handler
|
* [@cache_handler](https://github.com/crewAIInc/crewAI/blob/97d7bfb52ad49a9f04db360e1b6612d98c91971e/src/crewai/project/annotations.py#L49)
|
||||||
|
|
||||||
crew.py
|
crew.py
|
||||||
```py
|
```py
|
||||||
|
|||||||
@@ -4,6 +4,8 @@
|
|||||||
|
|
||||||
This tool is used to extract text from images. When passed to the agent it will extract the text from the image and then use it to generate a response, report or any other output. The URL or the PATH of the image should be passed to the Agent.
|
This tool is used to extract text from images. When passed to the agent it will extract the text from the image and then use it to generate a response, report or any other output. The URL or the PATH of the image should be passed to the Agent.
|
||||||
|
|
||||||
|
Supported filetypes are JPG, PNG, WEBP and GIF
|
||||||
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
Install the crewai_tools package
|
Install the crewai_tools package
|
||||||
@@ -18,7 +20,7 @@ In order to use the VisionTool, the OpenAI API key should be set in the environm
|
|||||||
```python
|
```python
|
||||||
from crewai_tools import VisionTool
|
from crewai_tools import VisionTool
|
||||||
|
|
||||||
vision_tool = VisionTool()
|
vision_tool = VisionTool(image_path_url="/path/to/your/local/image.jpg")
|
||||||
|
|
||||||
@agent
|
@agent
|
||||||
def researcher(self) -> Agent:
|
def researcher(self) -> Agent:
|
||||||
|
|||||||
Reference in New Issue
Block a user