Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AI Featured Image: support backend prompts #37668

Merged
merged 6 commits into from
Jun 3, 2024

Conversation

lhkowalski
Copy link
Contributor

@lhkowalski lhkowalski commented May 31, 2024

The frontend code change to implement backend prompts on the image generation. Test in pair with D150640-code.

Proposed changes:

  • Change the image generation hook to export the generic image generation function
  • Remove specific mentions to models on the AI Featured Image tool, so the model selection happens on the backend
  • With this change, the backend will select the model for the generation; the D150640-code change will use Dall-e-3 for Jetpack sites and Stable Diffusion for Simple sites

Notes:

  • the model detection for logging/tracking purposes is not perfect in this PR (it's using the cost of the request as a proxy, assuming each model has different costs). A better way would be to expose the "active model" or "default model" on the "ai-assistant-feature" endpoint, but this is a bigger change considering the timelime we have before the next release (need to add some code on the backend, as well as change the Jetpack here)
  • I kept the original prompts (and methods) for the Dall-e and Stable Diffusion generation on the hook so we can keep referring to it; there is always time for some clean up in the future

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

Testing on a Jetpack site:

  • Apply D150640-code to your sandbox and sandbox the public-api
  • Run this branch on your Jetpack testing site
  • Open the browser console and enable debug with localStorage.setItem( 'debug', '*' )
  • Go to the block editor and add some content
  • Trigger the featured image generation
  • On the console, confirm the event tracking shows the model as dall-e-3:
Screenshot 2024-06-02 at 11 22 53
  • Confirm the payload of the request does not mention the model of the generation, and contains the messages array:
{
    "feature": "featured-post-image",
    "size": "1792x1024",
    "responseFormat": "b64_json",
    "style": "photographic",
    "messages": [
        {
            "role": "jetpack-ai",
            "context": {
                "type": "featured-image-generation",
                "request": null,
                "content": "the content"
            }
        }
    ]
}
  • Confirm the image was generated by Dall-e-3
    • the image will "looks like Dall-e"
    • if you inspect the image, you will see the dimensions are 1792×1024
Screenshot 2024-06-02 at 11 22 53

Testing on a Simple site:

  • Apply D150640-code to your sandbox
  • After it, apply this branch on your sandbox using the jetpack-downloader command provided below
    • the tool will ask you to checkout trunk before applying it, type n to stay on the current branch
    • the tool will ask for another confirmation, to stay on the current branch, type y to stay on it
  • Sandbox the public-api and also your testing simple site
  • Open the browser console and enable debug with localStorage.setItem( 'debug', '*' )
  • Go to the block editor and add some content
  • Trigger the featured image generation
  • On the console, confirm the event tracking shows the model as stable-diffusion
Screenshot 2024-06-02 at 11 18 18
  • Confirm the payload of the request does not mention the model of the generation, and contains the messages array:
{
    "feature": "featured-post-image",
    "size": "1792x1024",
    "responseFormat": "b64_json",
    "style": "photographic",
    "messages": [
        {
            "role": "jetpack-ai",
            "context": {
                "type": "featured-image-generation",
                "request": null,
                "content": "the content"
            }
        }
    ]
}
  • Confirm the image was generated by Stable Diffusion
    • the image will "looks like Stable Diffusion"
    • if you inspect the image, you will see the dimensions are 1024x768
Screenshot 2024-06-02 at 11 18 18

@lhkowalski lhkowalski requested a review from a team May 31, 2024 20:10
@lhkowalski lhkowalski self-assigned this May 31, 2024
@github-actions github-actions bot added [Extension] AI Assistant Plugin [JS Package] AI Client [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress RNA labels May 31, 2024
Copy link
Contributor

github-actions bot commented May 31, 2024

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for July 2, 2024 (scheduled code freeze on June 24, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Copy link
Contributor

github-actions bot commented May 31, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the update/ai-featured-image-support-backend-prompts branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack update/ai-featured-image-support-backend-prompts
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@lhkowalski lhkowalski marked this pull request as ready for review May 31, 2024 20:11
vianasw
vianasw previously approved these changes Jun 3, 2024
Copy link
Contributor

@vianasw vianasw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codewise it looks good. I tested it with a simple site and a JN site and I haven't seen any regression compared to having the prompts on the frontend.

@lhkowalski lhkowalski enabled auto-merge (squash) June 3, 2024 18:04
Copy link
Contributor

@vianasw vianasw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

@lhkowalski lhkowalski merged commit 5383ad7 into trunk Jun 3, 2024
54 checks passed
@lhkowalski lhkowalski deleted the update/ai-featured-image-support-backend-prompts branch June 3, 2024 18:18
tbradsha pushed a commit that referenced this pull request Jun 3, 2024
* Export generic image generation method by parameters

* Change generation call to a generic one so the backend can decide which one to use

* Introduce activeModel cost and use it to infer the model name

* changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Extension] AI Assistant Plugin [JS Package] AI Client [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ RNA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants