Store Customization > Update products with AI generated content (https://github.com/woocommerce/woocommerce-blocks/pull/11155)
* Introduce the ProductUpdater class. * Update the image assignment for the default products content. * Update the default products content. * Introduce the generate_content and get_placeholder_products methods. * Update the get_placeholder_products method and introduce the new create_new_product method. * Verify the hash of the product content and compare it with the hash of the ai generated content to ensure we wont override products modified by the store owner. * Add docblocks and update the structure for the ProductUpdater class. * Pass the vertical images as a param for the PatternUpdater and the ProductUpdater. * Update the provided variable to the PatternUpdater class. * Update the ProductUpdater class to include the requirements for usage of the media_sideload_image method outside the wp-admin area (via API) and other adjustments to the products generation and hashes * remove unnecessary calls to post/product images. * Update the loop for generating products. * Further adjustments to the Product Updater. * Provide the business_description as a param for the generate_content ProductUpdates * Update the default timeout for the AI connection; update the path to the default image. Add a limit of 6 when quering the total products created by the store owner. * Add new neutral placeholder images for products and patterns. * Update the prompt and the logic for the placeholder images. * Remove placeholder images. * Increase max execution time * Update the products query. * Move the media_sideload_image function dependencies to outside of the loop and add comment. * Update text content. * Address code review. * bail early if no business description provided. * Add an extra safety check in case of query errors. * Address CR.
This commit is contained in:
Patricia Hillebrandt
GitHub
parent
65b093309f
commit
70a379a2d6
|
|
@ -3,6 +3,7 @@ namespace Automattic\WooCommerce\Blocks;
|
|||
|
||||
use Automattic\WooCommerce\Blocks\Domain\Package;
|
||||
use Automattic\WooCommerce\Blocks\Patterns\PatternUpdater;
|
||||
use Automattic\WooCommerce\Blocks\Patterns\ProductUpdater;
|
||||
use Automattic\WooCommerce\Blocks\Verticals\Client;
|
||||
use Automattic\WooCommerce\Blocks\Verticals\VerticalsSelector;
|
||||
|
||||
|
|
@ -249,8 +250,10 @@ class BlockPatterns {
|
|||
return $vertical_id;
|
||||
}
|
||||
|
||||
$vertical_images = ( new Client() )->get_vertical_images( $vertical_id );
|
||||
$business_description = get_option( VerticalsSelector::STORE_DESCRIPTION_OPTION_KEY );
|
||||
|
||||
return ( new PatternUpdater() )->create_patterns_content( $vertical_id, new Client(), $business_description );
|
||||
( new PatternUpdater() )->generate_content( $vertical_images, $business_description );
|
||||
( new ProductUpdater() )->generate_content( $vertical_images, $business_description );
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -33,19 +33,12 @@ class PatternUpdater {
|
|||
/**
|
||||
* Creates the patterns content for the given vertical.
|
||||
*
|
||||
* @param int $vertical_id The vertical id.
|
||||
* @param Client $verticals_api_client The verticals API client.
|
||||
* @param array|WP_Error $vertical_images The array of vertical images.
|
||||
* @param string $business_description The business description.
|
||||
*
|
||||
* @return bool|WP_Error
|
||||
*/
|
||||
public function create_patterns_content( $vertical_id, $verticals_api_client, $business_description = '' ) {
|
||||
if ( ! is_int( $vertical_id ) ) {
|
||||
return new WP_Error( 'invalid_vertical_id', __( 'The vertical id is invalid.', 'woo-gutenberg-products-block' ) );
|
||||
}
|
||||
|
||||
$vertical_images = $verticals_api_client->get_vertical_images( $vertical_id );
|
||||
|
||||
public function generate_content( $vertical_images, $business_description ) {
|
||||
if ( is_wp_error( $vertical_images ) ) {
|
||||
return $vertical_images;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,379 @@
|
|||
<?php
|
||||
|
||||
namespace Automattic\WooCommerce\Blocks\Patterns;
|
||||
|
||||
/**
|
||||
* Pattern Images class.
|
||||
*/
|
||||
class ProductUpdater {
|
||||
|
||||
/**
|
||||
* Generate AI content and assign AI-managed images to Products.
|
||||
*
|
||||
* @param array $vertical_images The vertical images.
|
||||
* @param string $business_description The business description.
|
||||
*
|
||||
* @return bool|\WP_Error True if the content was generated successfully, WP_Error otherwise.
|
||||
*/
|
||||
public function generate_content( $vertical_images, $business_description ) {
|
||||
if ( empty( $business_description ) ) {
|
||||
return new \WP_Error( 'missing_business_description', __( 'No business description provided for generating AI content.', 'woo-gutenberg-products-block' ) );
|
||||
}
|
||||
|
||||
$last_business_description = get_option( 'last_business_description_with_ai_content_generated' );
|
||||
|
||||
if ( $last_business_description === $business_description ) {
|
||||
if ( is_string( $business_description ) && is_string( $last_business_description ) ) {
|
||||
return true;
|
||||
} else {
|
||||
return new \WP_Error( 'business_description_not_found', __( 'No business description provided for generating AI content.', 'woo-gutenberg-products-block' ) );
|
||||
}
|
||||
}
|
||||
|
||||
$real_products = $this->fetch_product_ids();
|
||||
|
||||
if ( is_array( $real_products ) && count( $real_products ) > 0 ) {
|
||||
return true;
|
||||
}
|
||||
|
||||
$dummy_products = $this->fetch_product_ids( 'dummy' );
|
||||
|
||||
if ( ! is_array( $dummy_products ) ) {
|
||||
return new \WP_Error( 'failed_to_fetch_dummy_products', __( 'Failed to fetch dummy products.', 'woo-gutenberg-products-block' ) );
|
||||
}
|
||||
|
||||
$dummy_products_count = count( $dummy_products );
|
||||
$expected_dummy_products_count = 6;
|
||||
$products_to_create = max( 0, $expected_dummy_products_count - $dummy_products_count );
|
||||
|
||||
while ( $products_to_create > 0 ) {
|
||||
$this->create_new_product();
|
||||
$products_to_create--;
|
||||
}
|
||||
|
||||
// Identify dummy products that need to have their content updated.
|
||||
$dummy_products_ids = $this->fetch_product_ids( 'dummy' );
|
||||
|
||||
if ( ! is_array( $dummy_products_ids ) ) {
|
||||
return new \WP_Error( 'failed_to_fetch_dummy_products', __( 'Failed to fetch dummy products.', 'woo-gutenberg-products-block' ) );
|
||||
}
|
||||
|
||||
$dummy_products = array_map(
|
||||
function ( $product ) {
|
||||
return wc_get_product( $product->ID );
|
||||
},
|
||||
$dummy_products_ids
|
||||
);
|
||||
|
||||
$dummy_products_to_update = [];
|
||||
foreach ( $dummy_products as $dummy_product ) {
|
||||
$current_product_hash = $this->get_hash_for_product( $dummy_product );
|
||||
$ai_modified_product_hash = $this->get_hash_for_ai_modified_product( $dummy_product );
|
||||
|
||||
$date_created = $dummy_product->get_date_created()->date( 'Y-m-d H:i:s' );
|
||||
$date_modified = $dummy_product->get_date_modified()->date( 'Y-m-d H:i:s' );
|
||||
|
||||
$timestamp_created = strtotime( $date_created );
|
||||
$timestamp_modified = strtotime( $date_modified );
|
||||
|
||||
$dummy_product_not_modified = abs( $timestamp_modified - $timestamp_created ) < 60;
|
||||
|
||||
if ( $current_product_hash === $ai_modified_product_hash || $dummy_product_not_modified ) {
|
||||
$dummy_products_to_update[] = $dummy_product;
|
||||
}
|
||||
}
|
||||
|
||||
if ( empty( $dummy_products_to_update ) ) {
|
||||
return true;
|
||||
}
|
||||
|
||||
$ai_selected_products_images = $this->get_images_information( $vertical_images );
|
||||
$products_information_list = $this->assign_ai_selected_images_to_dummy_products_information_list( $ai_selected_products_images );
|
||||
|
||||
$responses = $this->generate_product_content( $products_information_list );
|
||||
|
||||
foreach ( $responses as $key => $response ) {
|
||||
if ( is_wp_error( $response ) ) {
|
||||
return $response;
|
||||
}
|
||||
|
||||
if ( empty( $response ) ) {
|
||||
return new \WP_Error( 'empty_response', __( 'The response from the AI service was empty.', 'woo-gutenberg-products-block' ) );
|
||||
}
|
||||
|
||||
if ( ! isset( $response['completion'] ) ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$product_content = json_decode( $response['completion'], true );
|
||||
|
||||
if ( is_null( $product_content ) ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// This is required to allow the usage of the media_sideload_image function outside the context of /wp-admin/.
|
||||
// See https://developer.wordpress.org/reference/functions/media_sideload_image/ for more details.
|
||||
require_once ABSPATH . 'wp-admin/includes/media.php';
|
||||
require_once ABSPATH . 'wp-admin/includes/file.php';
|
||||
require_once ABSPATH . 'wp-admin/includes/image.php';
|
||||
|
||||
$i = 0;
|
||||
foreach ( $dummy_products_to_update as $dummy_product ) {
|
||||
$this->update_product_content( $dummy_product, $product_content[ $i ] );
|
||||
++$i;
|
||||
}
|
||||
}
|
||||
|
||||
$update_option = update_option( 'last_business_description_with_ai_content_generated', $business_description );
|
||||
|
||||
if ( ! $update_option ) {
|
||||
return new \WP_Error( 'update_option_failed', __( 'The option last_business_description_with_ai_content_generated could not be updated.', 'woo-gutenberg-products-block' ) );
|
||||
}
|
||||
|
||||
return $update_option;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new product and assigns the _headstart_post meta to it.
|
||||
*
|
||||
* @return bool|int
|
||||
*/
|
||||
public function create_new_product() {
|
||||
$product = new \WC_Product();
|
||||
$random_price = wp_rand( 5, 50 );
|
||||
|
||||
$product->set_name( 'My Awesome Product' );
|
||||
$product->set_status( 'publish' );
|
||||
$product->set_description( 'Product description' );
|
||||
$product->set_price( $random_price );
|
||||
$product->set_regular_price( $random_price );
|
||||
|
||||
$saved_product = $product->save();
|
||||
|
||||
return update_post_meta( $saved_product, '_headstart_post', true );
|
||||
}
|
||||
|
||||
/**
|
||||
* Return all existing products that have the _headstart_post meta assigned to them.
|
||||
*
|
||||
* @param string $type The type of products to fetch.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function fetch_product_ids( $type = 'user_created' ) {
|
||||
global $wpdb;
|
||||
|
||||
if ( 'user_created' === $type ) {
|
||||
return $wpdb->get_results( $wpdb->prepare( "SELECT ID FROM {$wpdb->posts} WHERE ID NOT IN ( SELECT p.ID FROM {$wpdb->posts} p JOIN {$wpdb->postmeta} pm ON p.ID = pm.post_id WHERE pm.meta_key = %s AND p.post_type = 'product' AND p.post_status = 'publish' ) AND post_type = 'product' AND post_status = 'publish' LIMIT 6", '_headstart_post' ) );
|
||||
}
|
||||
|
||||
return $wpdb->get_results( $wpdb->prepare( "SELECT p.ID FROM {$wpdb->posts} p JOIN {$wpdb->postmeta} pm ON p.ID = pm.post_id WHERE pm.meta_key = %s AND p.post_type = 'product' AND p.post_status = 'publish'", '_headstart_post' ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the hash for a product based on its name, description and image_id.
|
||||
*
|
||||
* @param \WC_Product $product The product.
|
||||
*
|
||||
* @return false|string
|
||||
*/
|
||||
public function get_hash_for_product( $product ) {
|
||||
if ( ! $product instanceof \WC_Product ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return md5( $product->get_name() . $product->get_description() . $product->get_image_id() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the hash for a product that had its content AI-generated.
|
||||
*
|
||||
* @param \WC_Product $product The product.
|
||||
*
|
||||
* @return false|mixed
|
||||
*/
|
||||
public function get_hash_for_ai_modified_product( $product ) {
|
||||
if ( ! $product instanceof \WC_Product ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return get_post_meta( $product->get_id(), '_ai_generated_content', true );
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a hash with the AI-generated content and save it as a meta for the product.
|
||||
*
|
||||
* @param \WC_Product $product The product.
|
||||
*
|
||||
* @return bool|int
|
||||
*/
|
||||
public function create_hash_for_ai_modified_product( $product ) {
|
||||
if ( ! $product instanceof \WC_Product ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$content = $this->get_hash_for_product( $product );
|
||||
|
||||
return update_post_meta( $product->get_id(), '_ai_generated_content', $content );
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the product content with the AI-generated content.
|
||||
*
|
||||
* @param \WC_Product $product The product.
|
||||
* @param array $ai_generated_product_content The AI-generated content.
|
||||
*
|
||||
* @return string|void
|
||||
*/
|
||||
public function update_product_content( $product, $ai_generated_product_content ) {
|
||||
if ( ! $product instanceof \WC_Product ) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ( ! isset( $ai_generated_product_content['image']['src'] ) || ! isset( $ai_generated_product_content['image']['alt'] ) || ! isset( $ai_generated_product_content['title'] ) || ! isset( $ai_generated_product_content['description'] ) ) {
|
||||
return;
|
||||
}
|
||||
// Since the media_sideload_image function can take longer to complete
|
||||
// the process of downloading the external image and uploading it
|
||||
// to the media library, we need to ensure the request doesn't timeout.
|
||||
set_time_limit( 60 );
|
||||
|
||||
$product_image_id = media_sideload_image( $ai_generated_product_content['image']['src'], $product->get_id(), $ai_generated_product_content['image']['alt'], 'id' );
|
||||
|
||||
if ( is_wp_error( $product_image_id ) ) {
|
||||
return $product_image_id->get_error_message();
|
||||
}
|
||||
|
||||
$product->set_name( $ai_generated_product_content['title'] );
|
||||
$product->set_description( $ai_generated_product_content['description'] );
|
||||
$product->set_image_id( $product_image_id );
|
||||
|
||||
$product->save();
|
||||
|
||||
$this->create_hash_for_ai_modified_product( $product );
|
||||
}
|
||||
|
||||
/**
|
||||
* Assigns the default content for the products.
|
||||
*
|
||||
* @param array $ai_selected_products_images The images information.
|
||||
*
|
||||
* @return array[]
|
||||
*/
|
||||
public function assign_ai_selected_images_to_dummy_products_information_list( $ai_selected_products_images ) {
|
||||
$default_image = [
|
||||
'src' => esc_url( plugins_url( 'woocommerce-blocks/images/block-placeholders/product-image-gallery.svg' ) ),
|
||||
'alt' => 'The placeholder for a product image.',
|
||||
];
|
||||
|
||||
return [
|
||||
[
|
||||
'title' => 'A product title',
|
||||
'description' => 'A product description',
|
||||
'image' => $ai_selected_products_images[0] ?? $default_image,
|
||||
],
|
||||
[
|
||||
'title' => 'A product title',
|
||||
'description' => 'A product description',
|
||||
'image' => $ai_selected_products_images[1] ?? $default_image,
|
||||
],
|
||||
[
|
||||
'title' => 'A product title',
|
||||
'description' => 'A product description',
|
||||
'image' => $ai_selected_products_images[2] ?? $default_image,
|
||||
],
|
||||
[
|
||||
'title' => 'A product title',
|
||||
'description' => 'A product description',
|
||||
'image' => $ai_selected_products_images[3] ?? $default_image,
|
||||
],
|
||||
[
|
||||
'title' => 'A product title',
|
||||
'description' => 'A product description',
|
||||
'image' => $ai_selected_products_images[4] ?? $default_image,
|
||||
],
|
||||
[
|
||||
'title' => 'A product title',
|
||||
'description' => 'A product description',
|
||||
'image' => $ai_selected_products_images[5] ?? $default_image,
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the images information.
|
||||
*
|
||||
* @param array $vertical_images The vertical images.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function get_images_information( $vertical_images ) {
|
||||
if ( is_wp_error( $vertical_images ) ) {
|
||||
return [
|
||||
'src' => esc_url( 'images/block-placeholders/product-image-gallery.svg' ),
|
||||
'alt' => 'The placeholder for a product image.',
|
||||
];
|
||||
}
|
||||
|
||||
$count = 0;
|
||||
$placeholder_images = [];
|
||||
foreach ( $vertical_images as $vertical_image ) {
|
||||
if ( $count >= 6 ) {
|
||||
break;
|
||||
}
|
||||
|
||||
if ( isset( $vertical_image['meta']['pexels_object']['src']['large'] ) ) {
|
||||
$src = $vertical_image['meta']['pexels_object']['src']['large'];
|
||||
$alt = $vertical_image['meta']['pexels_object']['alt'] ?? 'The placeholder for a product image.';
|
||||
} elseif ( isset( $vertical_image['guid'] ) ) {
|
||||
$src = $vertical_image['guid'];
|
||||
$alt = $vertical_image['meta']['pexels_object']['alt'] ?? 'The placeholder for a product image.';
|
||||
} else {
|
||||
$src = 'images/pattern-placeholders/white-texture-floor-wall-gray-tile.jpg';
|
||||
$alt = 'The placeholder for a product image.';
|
||||
}
|
||||
|
||||
$placeholder_images[] = [
|
||||
'src' => esc_url( $src ),
|
||||
'alt' => esc_attr( $alt ),
|
||||
];
|
||||
|
||||
++ $count;
|
||||
}
|
||||
|
||||
return $placeholder_images;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate the product content.
|
||||
*
|
||||
* @param array $products_default_content The default content for the products.
|
||||
*
|
||||
* @return array|int|string|\WP_Error
|
||||
*/
|
||||
public function generate_product_content( $products_default_content ) {
|
||||
$ai_connection = new \Automattic\WooCommerce\Blocks\AI\Connection();
|
||||
|
||||
$site_id = $ai_connection->get_site_id();
|
||||
|
||||
if ( is_wp_error( $site_id ) ) {
|
||||
return $site_id;
|
||||
}
|
||||
|
||||
$token = $ai_connection->get_jwt_token( $site_id );
|
||||
|
||||
if ( is_wp_error( $token ) ) {
|
||||
return $token;
|
||||
}
|
||||
|
||||
$store_description = get_option( 'woo_ai_describe_store_description' );
|
||||
|
||||
if ( ! $store_description ) {
|
||||
return new \WP_Error( 'missing_store_description', __( 'The store description is required to generate the content for your site.', 'woo-gutenberg-products-block' ) );
|
||||
}
|
||||
|
||||
$prompt = [ sprintf( 'Given the following store description: "%1s" and the assigned value for the alt property in the json bellow, generate new titles and descriptions for each one of the products listed bellow and assign them as the new values for the json: %2s. Each one of the titles should be unique and no numbers are allowed. The response should be only a JSON string, with no intro or explanations.', $store_description, wp_json_encode( $products_default_content ) ) ];
|
||||
|
||||
return $ai_connection->fetch_ai_responses( $token, $prompt, 60 );
|
||||
}
|
||||
}
|
||||
|
|
@ -3,6 +3,7 @@
|
|||
namespace Automattic\WooCommerce\StoreApi\Routes\V1;
|
||||
|
||||
use Automattic\WooCommerce\Blocks\Patterns\PatternUpdater;
|
||||
use Automattic\WooCommerce\Blocks\Patterns\ProductUpdater;
|
||||
use Automattic\WooCommerce\Blocks\Verticals\Client;
|
||||
use Automattic\WooCommerce\Blocks\Verticals\VerticalsSelector;
|
||||
use Automattic\WooCommerce\StoreApi\Exceptions\RouteException;
|
||||
|
|
@ -104,13 +105,24 @@ class Patterns extends AbstractRoute {
|
|||
$business_description = sanitize_text_field( wp_unslash( $request['business_description'] ) );
|
||||
$vertical_id = ( new VerticalsSelector() )->get_vertical_id( $business_description );
|
||||
|
||||
if ( empty( $business_description ) ) {
|
||||
$business_description = get_option( 'woo_ai_describe_store_description' );
|
||||
}
|
||||
|
||||
if ( is_wp_error( $vertical_id ) ) {
|
||||
$response = $this->error_to_response( $vertical_id );
|
||||
} else {
|
||||
$populate_images = ( new PatternUpdater() )->create_patterns_content( $vertical_id, new Client(), $business_description );
|
||||
$vertical_images = ( new Client() )->get_vertical_images( $vertical_id );
|
||||
$populate_patterns = ( new PatternUpdater() )->generate_content( $vertical_images, $business_description );
|
||||
|
||||
if ( is_wp_error( $populate_images ) ) {
|
||||
$response = $this->error_to_response( $populate_images );
|
||||
if ( is_wp_error( $populate_patterns ) ) {
|
||||
$response = $this->error_to_response( $populate_patterns );
|
||||
}
|
||||
|
||||
$populate_products = ( new ProductUpdater() )->generate_content( $vertical_images, $business_description );
|
||||
|
||||
if ( is_wp_error( $populate_products ) ) {
|
||||
$response = $this->error_to_response( $populate_products );
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue