Ango Hub Docs
Open Ango HubContact iMerit
  • Ango Hub Documentation
  • Video Guides
  • Changelog
  • FAQs & Troubleshooting
  • All Keyboard and Mouse Shortcuts
  • Core Concepts
    • Assets
    • Attachments
    • Batches
    • Benchmarks
    • Category Schema (Ontologies)
    • Frame Interpolation
    • Geofencing
    • Idle Time Detection & Time Tracking
    • Instructions
    • Issues
      • Issue Error Codes
    • Label Validation
    • Labeler Performance
    • Labeling
    • Labeling Queue
    • Multiple Classification
    • Notifications
    • Organizations
    • Projects
    • Requeuing
    • Reviewing
    • Review Queue
    • Skipping
    • Stage History
    • Tasks
    • Usage
    • User Roles
    • Workflow
      • Complete
      • Consensus
      • Hold
      • Label
      • Logic
      • Plugin
      • Review
      • Start
      • Webhook
  • Labeling
    • Managing Users in Projects
      • Profile Page
    • Managing the Project Ontology
    • Labeling Editor Interface
      • Audio Labeling Editor
      • Image Labeling Editor
      • Video Labeling Editor
      • DICOM Labeling Editor
      • Medical Labeling Editor
        • 3D Bounding Box
        • Fill Between Slices
        • Island Tools
        • Line (Tape Measure)
        • Smoothing
      • PDF Labeling Editor
      • Text (NER) Labeling Editor
      • LLM Chat Labeling Editor
      • Markdown Labeling Editor
      • 3D Multi-Sensor Fusion Labeling Editor
    • Labeling Classes
      • Tools
        • Bounding Box
        • Brush
        • Entity
        • Message
        • Nested Classifications
        • PCT
        • PDF Tool
        • Point
        • Polygon
        • Polyline
        • Rotated Bounding Box
        • Segmentation
        • Spline
        • Voxel Brush
      • Classification
        • Checkbox
        • Multiple Dropdown
        • Radio
        • Rank
        • Single Dropdown
        • Text
        • Tree Dropdown Tools (Single and Multiple Selection)
      • Relation
        • Single Relation
        • Group Relation
    • Magnetic Lasso
    • Performance & Compatibility Considerations
  • Data
    • Data in Ango Hub
      • Embedding Private Bucket Files in MD Assets
    • Importing Assets
      • Asset Builder
      • Bundled Assets
        • Importing Multiple Images as One Multi-Page Asset
        • Importing Multiple Single-Frame DICOM Files as One Multi-Page Asset
        • Importing multiple DICOM files to be annotated and displayed at once
        • Importing Multiple Single-Frame DICOM Files as a DICOM Series
        • Importing Multiple Markdown Files as One Multi-Page Asset
      • File Explorer
      • Supported Asset File Types & Codecs
      • Importing Cloud (Remote) Assets
      • Importing From Local Machine
      • Creating and Importing LLM Chat Assets
      • Importing Data in the 3D Multi-Sensor Fusion Labeling Tool
      • Bulk Importing Markdown/HTML Assets
      • Importing Attachments during Asset Import
      • Importing Annotations during Asset Import
      • contextData: Adding Extra Data to Assets
      • Importing Reference Images as Overlay
      • Importing Reference Medical Data During Asset Import
    • Importing and Exporting Annotations
      • Importing Annotations
        • Ango Import Format
        • Importing Brush Traces
        • Importing NRRD Annotations
      • Exporting Annotations
        • Ango Export Format
          • Asset
            • Task
              • Tools
              • Classifications
              • Relations
          • Stage History
    • Adding and Managing LLMs
    • Storages
      • Set up a storage integration with Azure
      • Set up a storage integration with AWS S3
      • Set up a storage integration with MinIO and S3-compatible custom storage services
      • Set up a storage integration with GCP (Google Cloud Platform)
      • Set up CORS
      • Validating Storage Integrations
    • Purging Data from Ango Hub
  • Plugins
    • Overview of Plugins in Ango Hub
      • Installing Plugins
      • Plugin Setting Presets
      • Monitoring Plugin Progress
    • First-Party Plugins
      • Ango Export Converter Plugins
      • Asset Converter Plugins
      • Ango to Mask Converter
      • Batch Assignment
      • ChatGPT
      • Column-Agnostic Markdown Generator
      • CSV Export for Classification
      • DALL-E
      • DALL-E (Model Plugin)
      • File Explorer Plugin
      • General Object Detector
      • General Object Segmenter
      • Markdown Generator
      • One-Click Segmentation
      • Open World Object Detection
      • Optical Character Recognition
      • TPT Export
      • YOLO | Instance Segmentation
      • YOLO | Pose Estimation
      • YOLO | Object Detection
      • YOLO | Image Classification
    • Plugin Developer Documentation
      • Export Plugins
      • Batch Model Plugins
      • Model Plugins
      • File Explorer Plugins
      • Markdown Generator Plugins
      • Plugin Logger
      • [WIP] Deploying your Plugin
      • Plugin 'Host' Information
  • SDK
    • SDK Documentation
      • Project Level SDK Functions
        • add_members_to_project
        • assign_batches
        • assign_task
        • create_attachment
        • create_batch
        • create_issue
        • create_label_set
        • create_project
        • delete_issue
        • export
        • exportV3
        • get_assets
        • get_batches
        • get_issues
        • get_metrics
        • get_project
        • get_project_performance
        • get_task
        • get_tasks
        • get_task_history
        • import_labels
        • list_projects
        • requeue_tasks
        • rerun_webhook
        • update_workflow_stages
        • upload_files
        • upload_files_cloud
        • upload_files_with_asset_builder
        • upload_chat_assets
      • Organization Level SDK Functions
        • create_storage
        • delete_organization_invites
        • delete_organization_members
        • delete_storage
        • get_organization_invites
        • get_organization_members
        • get_storages
        • invite_members_to_org
        • update_organization_members_role
    • SDK - Useful Snippets
    • SDK Changelog
  • API
    • API Documentation
  • How-To
    • Add Members
      • Add multiple users to a project
    • Annotate
      • Annotate 3D Point Cloud Files on Ango Hub
      • Perform targeted OCR on images
    • Export Data
      • Automatically send Ango Hub Webhook contents to Google Sheets, Email, Slack, and more with Zapier
      • Download a JSON of your project ontology
      • Download DICOM Segmentation Masks
      • Download your annotations in the COCO, KITTI, or YOLO format
      • Download your Segmentation Masks
      • Get your export as separate JSON files for each asset
    • Manage a Project
      • Get your API Key
      • Get your Organization ID
      • Mute your notifications
      • Open an asset provided the Asset ID
      • Pre-label assets
      • Share a filtered view of the Tasks table with others
      • Transfer project ontologies between projects
      • Transfer project workflows between projects
    • Perform Model Evaluation on Ango Hub
  • Troubleshooting
    • I get a "0 Tasks Labeled" alert when trying to pre-label tasks
    • I get a 'The data couldn't be loaded properly' error when opening certain assets
    • I get a "Unknown Classification" warning when opening a task
  • Feature Availability Status for projects of the 3D Multi-Sensor Fusion type
  • Comparison between QuickServe and Ango Hub
  • Changes from Ango Hub Legacy
  • Video V2 Breaking Changes and Transition
  • Data Access, Storage, and Security
  • Two-Factor Authentication
  • Single Sign-On (SSO) Support
  • Customer Support
  • Ango Hub Status Page
Powered by GitBook
On this page
  • Installation
  • Setup
  • Integrating DALL-E (Model Plugin) into the project workflow
  • Configuration JSON Settings
  • Using DALL-E (Model Plugin) from the labeling editor (Ango Hub Version 3.8.2+)
  • Passing the Entire Asset as Prompt
  • Passing Selected Text as a Prompt
  • Passing a text annotation as prompt
  • Running DALL-E (Model Plugin)
  1. Plugins
  2. First-Party Plugins

DALL-E (Model Plugin)

PreviousDALL-ENextFile Explorer Plugin

Last updated 1 year ago

If you do not provide your own OpenAI API key, the DALL-E (Model Plugin) plugin is subject to the following global rate limits throughout Ango Hub:

  • Requests per Minute: 5

Please be mindful of the above global limits when running the DALL-E (Model Plugin) plugin without your own API key.

The DALL-E (Model Plugin) plugin allows you to generate images. The generated images will appear as attachment to the asset where they were run.

As part of the prompt sent to DALL-E (Model Plugin), you may choose to send the entire text of the asset if the asset is text, the text that was highlighted as part of an entity annotation, or custom text written by a user into a Text classification box.

Installation

From the Plugin Directory, search for DALL-E (Model Plugin) and install the plugin to your organization. More information on installing plugins can be found in the page.

The name of the plugin is DALL-E (Model Plugin) and the creator of the plugin is onur (at) imerit.net.

Setup

Navigate to the project where you'd like to use ChatGPT.

Integrating DALL-E (Model Plugin) into the project workflow

If you'd like for DALL-E (Model Plugin) to automatically receive and process tasks, you may integrate it into your workflow.

From the Workflow tab in your project, drag a Plugin stage into the workflow view, and plug it where you'd like it to be. Then, click on the stage you've just placed and select "DALL-E (Model Plugin)" from the list of models available.

In the example above, DALL-E (Model Plugin) will receive tasks from the Start stage, process them, and send them out to a labeling stage. More info on the other settings in the plugin settings panel can be found below.

Configuration JSON Settings

Default Configuration:

{
  "openai_api_key": "default",
  "model_name": "dall-e-2",
  "get_prompt_from": "text-annotation",
  "image_size": "1024x1024"
}

openai_api_key: By default, the DALL-E plugin will use an OpenAI API key provided by iMerit, for testing purposes, limited to generating, globally, 5 images per minute. You may provide here your own OpenAI API key to remove these limits and utilize your own OpenAI API key.

model_name: When providing a custom OpenAI API key, you may indicate here the name of the model the API key is for. Currently, OpenAI provides dall-e-2 and dall-e-3.

Please ensure the OpenAI API key you provide belongs to the model you specify.

For example, providing an OpenAI API key for dall-e-2, and then selecting dall-e-3 as the model will cause the plugin not to work.

get_prompt_from: Where DALL-E should look for when it searches for the prompt. Options: text-annotation, entity-annotation, or full-text-asset. More information on prompting below.

image_size: Resolution of the image to generate. Recommended: 512x512.

Using DALL-E (Model Plugin) from the labeling editor (Ango Hub Version 3.8.2+)

You may run the DALL-E (Model Plugin) plugin to generate images directly from the labeling editor. After having added DALL-E (Model Plugin) to your organization, enter a project, and click on the "Plugins" icon on the top toolbar. The DALL-E (Model Plugin) plugin will be available in the dropdown.

Passing the Entire Asset as Prompt

In the Config JSON field, ensure the get_prompt_from property is set to full-text-asset.

The text of the asset will be passed as the prompt.

You may change the image_size property of the Config JSON to pick an image resolution.

Passing Selected Text as a Prompt

To pass the entire text of the asset as a prompt, first ensure that the asset is a .txt file.

Map DALL-E (Model Plugin)'s Prompt class to the class you'd like to pass as prompt to DALL-E (Model Plugin). Text highlighted in text assets with this class will be the prompt.

In the Config JSON field, ensure the get_prompt_from property is set to entity-annotation.

Passing a text annotation as prompt

Map DALL-E (Model Plugin)'s Prompt class to the class you'd like to pass as prompt to DALL-E (Model Plugin). Text typed in this text classification tool will be part of the prompt.

In the Config JSON field, ensure the get_prompt_from property is set to text-annotation.

Running DALL-E (Model Plugin)

If you have plugged DALL-E (Model Plugin) into your workflow, DALL-E (Model Plugin) will be activated every time a task is passed into its input plug.

Click on the DALL-E (Model Plugin) text to run the plugin with its default preset (if any, ). Otherwise, click on the three dots to the right to run the plugin with custom settings. The plugin settings dialog will appear. More info on the plugin settings that can be found in this dialog are below.

If you wish to run DALL-E (Model Plugin) directly from the labeling editor, follow the instructions .

You may check the progress of the conversion from the Plugin Sessions dialog. More information on checking plugin progress .

click here for more information on presets
here
in this section
Installing Plugins