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
52 lines
1.4 KiB
Plaintext
52 lines
1.4 KiB
Plaintext
---
|
|
title: DALL-E Tool
|
|
description: The `DallETool` is a powerful tool designed for generating images from textual descriptions.
|
|
icon: image
|
|
mode: "wide"
|
|
---
|
|
|
|
# `DallETool`
|
|
|
|
## Description
|
|
|
|
This tool is used to give the Agent the ability to generate images using the DALL-E model. It is a transformer-based model that generates images from textual descriptions.
|
|
This tool allows the Agent to generate images based on the text input provided by the user.
|
|
|
|
## Installation
|
|
|
|
Install the crewai_tools package
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
## Example
|
|
|
|
Remember that when using this tool, the text must be generated by the Agent itself. The text must be a description of the image you want to generate.
|
|
|
|
```python Code
|
|
from crewai_tools import DallETool
|
|
|
|
Agent(
|
|
...
|
|
tools=[DallETool()],
|
|
)
|
|
```
|
|
|
|
If needed you can also tweak the parameters of the DALL-E model by passing them as arguments to the `DallETool` class. For example:
|
|
|
|
```python Code
|
|
from crewai_tools import DallETool
|
|
|
|
dalle_tool = DallETool(model="dall-e-3",
|
|
size="1024x1024",
|
|
quality="standard",
|
|
n=1)
|
|
|
|
Agent(
|
|
...
|
|
tools=[dalle_tool]
|
|
)
|
|
```
|
|
|
|
The parameters are based on the `client.images.generate` method from the OpenAI API. For more information on the parameters,
|
|
please refer to the [OpenAI API documentation](https://platform.openai.com/docs/guides/images/introduction?lang=python). |