Skip to content

Commit

Permalink
Update dall-e readme
Browse files Browse the repository at this point in the history
  • Loading branch information
HanqingZ committed Jan 8, 2025
1 parent f575203 commit 237f818
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion tools/dalle/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,39 @@
# Dalle
# DALL-E

## Overview

DALL-E is an AI image generator developed by OpenAI that generates images based on text prompts. Dify has integrated the DALL-E tool, and the following are the steps to configure and use the DALL-E tool in Dify.

## Configure

### 1. Apply for Dall-E API Key

Please apply for an API Key on the OpenAI Platform.

### 2. Get Dall-E tools from Plugin Marketplace

The Dall-E tools could be found at the Plugin Marketplace, please install it first.

### 3. Fill in the configuration in Dify

On the Dify navigation page, click `Tools > DALL-E > Authorize` and fill in the API Key.

**Note:** Base URL and Organization ID are optional. The Organization IDs can be found on your Organization settings page.

![DALL-E Configuration](./_assets/dalle_1.PNG)

### 4. Use the tool

You can use the Dall-E tool in the following application types:

#### Chatflow / Workflow applications

![Chatflow/Workflow Application](./_assets/dalle_2.PNG)

Both Chatflow and Workflow applications support the DALL-E tool node. After adding it, you need to fill in the "Input Variables → Prompt" in the node with variables to reference the user's input prompt or the content generated by the previous node. Finally, use the variable to reference the image output by DALL-E in the "End" node.

#### Agent applications

![Agent Application](./_assets/dalle_3.PNG)

Add the Dall-E tool in the Agent application, then send a picture description in the dialog box to call the tool to generate an AI image.
Binary file added tools/dalle/_assets/dalle_1.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/dalle/_assets/dalle_2.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/dalle/_assets/dalle_3.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 237f818

Please sign in to comment.