ai metadata plugin

Plugin description

The ai-metadata plugin enables the integration of OpenAIs ChatGPT into a fylr instance by automatically filling object type fields. Custom prompts can be configured and mapped to fylr object types through metadata mappings. The generated output is written directly to objects during their creation.

Datamodel requirements

To successfully use the ai-metadata plugin to describe your instances content, your Object Type needs to have

• a file field: the source image for ChatGPT to describe

• text fields or lists: (multilingual) text fields to map ChatGPTs output to

Installation

Move to your fylr instances Plugin Manager to install the ai-metadata plugin by finding the -Icons in the bottom of the plugin list and clicking the plus symbol.

While installing enabling the plugin is the default behavior. You can enable or disable the plugin anytime, active configuration will be preserved until enabled again.

Configuration

After installing and activating the plugin, select it in the plugin list.

Configure the plugin in the "General Tab" by adding an API Key

Creating the ChatGPT prompts

Inside the plugin managers config tab, create one or more named prompts by clicking .

The available inputs are mandatory.

Choosing the Output Type

• Single line text

  • maps toSingle Line & Multi Line Text, Simple Text (String)

• Single line text (multilingual)

  • maps to Single Line & Multiline Text (multilingual)

• List text

  • maps toSingle Line & Multi Line Text, Simple Text (String) in a nested field.

• List text (multilingual)

  • maps to Single Line & Multiline Text (multilingual) in a nested field.

Examples

Each named list entry in the Plugin Managers configuration tab of the ai-metadata plugin becomes available in the Metadata Mapping section of fylr.

As a start, you can upload the displayed configuration and modify as needed.

Creating the Metadata Mapping

Navigate to "Metadata Mappings" in the configuration.

Create a new IMPORT Mapping by finding the -Icons in the bottom of the available Mappings and clicking the plus symbol, selecting IMPORT.

If the plugin is enabled and a prompt is configured in the previous step, you should now see the section “ChatGPT Metadata” listing your created prompts.

Per default all Object Types are listed, in the below example, only the fields for the selected Object Type are shown because the object type limits the mapping to be used on OT "ChatGPT Object"

To map the available fields to the created prompts, drag and drop the individual fields onto your created mapping. Right click a mapping to remove.

Reload the frontend to make the mapping available for upload dialogs and record creation.

Usage while creating records

When creating a new record, select the metadata mapping that includes your prompt configuration.

The mapping can be used

• during upload via the plus icon

When clicking Next, you will see the Metadata Mapping being applied with a progress indicator.

In the next view, see the prompt results arranged into your fields.

After saving, the records will be accessible just like any other record.

Usage with Background Tasks

To run the ai-metadata plugin in background tasks, follow these steps:

Create and Configure the Task

1. Open the Background Tasks section in the header bar of your fylr instance.

1. Create a new task by using the -Icon and selecting the module Metadata

2. Define the schedule:

• Manual time (default: now)

• Scheduled time (future execution)

Task Parameters

Configure the mapping

Creating a search result to apply the mapping to

For the task to have records to apply the mapping to, configure a search that finds the records you want to be filled by ChatGPT (selection of records / the entire search result).

If the found records have no values in their fields yet, the Override Values checkbox might not be required.

After the created tasks next scheduled job has finished (now or later, depending on the amount of records to be mapped), confirm the changes made in the tasks log and the record itself.