Imogen Priority Queue

[transfaeries]

To discuss and implement a paid priority queue for imogen.

I will write a possible spec for how it could work, and we can discuss it.

Will be resolved by PR #76

┆Issue is synchronized with this Asana task by Unito

[transfaeries]

I think we should discuss things that will pertain to the code here, including the docstrings that will make up the responses to the help command, as well as the automated messages from imogen.

[transfaeries]

This is what a theoretical manpage for Imogen might look like. If approved I would like us to write code so that Imogen works in the way described. I will add Suggested DocStrings, replies, and automated messages in a further comment.

Usage:
/imagine [style] {prompt}
Have Imogen generate an image for you based on {prompt}

Adding a style influences the style of the final picture. Available styles include
-dark_fantasy
-fantasy
-festive
-hd
-imagine,
-list_queue,
-mythical,
-paint,
-pastel,
-psychic,
-steampunk,
-synthwave,
-ukiyo,
-vibrant

Priority Queue

You can pay Imogen to have your requests be prioritised. To pay for the priority queue DM Imogen and attach a payment. 1 Mob gets you 5 priority requests. You can request an imagen for the priority queue with the /priority command

Available Commands

/balance
returns your Imogen balance for priority requests

/canceltip
cancels registering the next payment as a tip

/credit
marks next transaction as adding to the user's balance (default behaviour for payments)

/fast
I need Sylvie to explain this one to me

/help
Display the Help text

/help style
lists available styles you can use with /imagine.

/help [commmand]
Explain Specific Command

/imagine [style] {prompt}
Generates an image based on your prompt. Request is handled in the free queue, every free request is addressed and generated sequentially.

/paint [style] {prompt}
Generate an image using the WikiArt database and your prompt, generates painting-like images. Requests handled on the Free queue.

/priority [style] {prompt} .
Like /imagine but places your request on a priority queue. Priority items get dedicated workers when available and bypass the free queue.

/priority-paint [style] {prompt}
Like /paint but places your request on the priority queue. Priority items get dedicated workers when available and bypass the free queue.

/quick
I need Sylvie to explain this one to me

/tip
Mark Next Transaction as Tip. Only usable in DMs. /canceltip cancels registering the next payment as a tip.

/status
Displays Imogen's status

Advaced Techniques

Starting Image:
Imogen can generate your image based on a starting image. Attach an image and use one of the generative commands "/imagine /paint /priority /priority-paint" and Imogen will generate an image based on your prompt and the starting image.

Videos:
You can give imogen multiple prompts separated by "//" and Imogen will generate a video that transitions between the prompts. Will take longer than a regular /imagine.
Example:
/imagine Jane // Cake

Distort:
You can combine the starting image and the video functionality to make images that dissolve into imoges.
Attach an image and use one of the generative commands starting with Slash.
with image attached /imagine // Cake

[transfaeries]

Priority Workflow

When you send imogen a payment that has not been earmarked as a tip. Imogen DMs the payer:

"Imogen has received a payment from you for $X mob. Your current balance is: $Y mob."

When it is a tip:
"Imogen has received a tip from you for $X mob. Thank you for contributing to Imogen's development <3"

/balance
In a group:
"To make use of Imogen's paid features, please message Imogen directly."

In a DM:
"Your current Imogen balance is $Y mob"

/credit

In a group:
"To make use of Imogen's paid features, please message Imogen directly."

In a DM:
"Next transaction will credit your Imogen account. With imogen credit you can place requests on the priority queue, by using the /priority or the /priority-paint commands It currently costs 0.2 mob to request a priority image. Use /balance to see your balance. Use /signalpay for instructions on how to send payments with signal"

/tip
In a group:
"To send imogen a tip, please message Imogen directly. Imogen shares tips with collaborators! If you like an Imogen Imoge, leave a reaction on it. When an Imoge gets multiple reactions, the person who prompted the Imoge will be awarded a tip (currently 0.1 MOB). "

In a DM:
"The next transaction will be marked as a tip and won't credit your Imogen Balance. Thank you for supporting Imogen. /canceltip cancel's sending a tip. Use /signalpay for instructions on how to send payments with signal"

(note, the tip command should autocancel in 10 minutes)

/signalpay
In a group:
"To make use of Imogen's paid features, please message Imogen directly.""

In a DM:
"You can use Signal Payments to tip imogen and make use of the priority features.
To attach a payment, do the following in a direct message:
-Hit the Plus Sign
-Select "Payment"

You will receive a message from Imogen with your balance.

Using /tip before sending a Payment marks your patment as a tip and won't credit your balance. Use /canceltip to cancel sending of a tip.

If you don't have Payments activated follow these instructions to activate it.

1. Update Signal app: https://signal.org/install/
2. Open Signal, tap on the icon in the top left for Settings. If you don’t see Payments, reboot your phone. It can take a few hours.
3. Tap Payments and Activate Payments"

/canceltip
In a group:
"To make use of Imogen's paid features, please message Imogen directly."

In DM, with pending tip:
"Tip has been cancelled. Next transaction will credit your Imogen balance"

In DM, without pending tip.
"No tip had been initiated. Use /tip to mark next transaction as a tip. If you sent a tip in error, please contact an administrator"

/priority

With Credit:
"Request received and being processed with priority. Your credit has been deducted by 0.2 mob."

Also DM user:
"Priority credit used, current balance $Y mob"

Without credit:
"You have no credit to submit priority requests. Please message Imogen and use the /credit command to add credit for priority features"

When an user uses imagine or paint command for the free queue:
"Request received and added to the free queue. Place in line: #$place"

[transfaeries]

Imogen's automated messages:

"If you like Imogen's art, you can show your support by donating within Signal Payments.
Send Imogen a direct message with the command "/help tip" for donation instructions. Every time she creates an image, it costs $0.09
Imogen shares tips with collaborators! If you like an Imogen Imoge, react ❤️ t️o it. When an Imoge gets multiple reactions, the person who prompted the Imoge will be awarded a tip (currently 0.1 MOB)."

"Want to skip the line? Imogen offers a priority queue for a cost of 0.02 mob per image. To add priority credit to your account, send Imogen a direct message with the command "/credit". If you already have credit you can submit a priority requests with the command "/priority" "

"Check out Imogen on GitHub to learn how to make use of all her features, as well as contributing to the project:
https://github.com/mobilecoinofficial/forest/tree/main/imogen"

[transfaeries]

we need new messages for certain things. The "slow down" message needs to be replaced and I think there were some others that Sylvie wanted replaced or improved.

[transfaeries]

Rate Limit

You currently have the maximum number of free requests in the queue (6), to request another image please wait for one of your requests to clear or add credit to your Imogen balance. DM Imogen with /balance to see your balance and learn how to add credit.