Skip to content

Commit 599ce48

Browse files
felixarntzfelixarntz
committed
Add WP-CLI command wp ai-services generate-image to generate images via the command line.
1 parent 511571b commit 599ce48

File tree

1 file changed

+158
-5
lines changed

1 file changed

+158
-5
lines changed

‎includes/Services/CLI/AI_Services_Command.php

+158-5
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,15 @@
1111
use Felix_Arntz\AI_Services\Services\API\Enums\AI_Capability;
1212
use Felix_Arntz\AI_Services\Services\API\Helpers;
1313
use Felix_Arntz\AI_Services\Services\API\Types\Content;
14+
use Felix_Arntz\AI_Services\Services\API\Types\Image_Generation_Config;
15+
use Felix_Arntz\AI_Services\Services\API\Types\Parts\File_Data_Part;
16+
use Felix_Arntz\AI_Services\Services\API\Types\Parts\Inline_Data_Part;
1417
use Felix_Arntz\AI_Services\Services\API\Types\Parts\Text_Part;
1518
use Felix_Arntz\AI_Services\Services\API\Types\Text_Generation_Config;
1619
use Felix_Arntz\AI_Services\Services\API\Types\Tools;
1720
use Felix_Arntz\AI_Services\Services\Contracts\Generative_AI_Model;
1821
use Felix_Arntz\AI_Services\Services\Contracts\Generative_AI_Service;
22+
use Felix_Arntz\AI_Services\Services\Contracts\With_Image_Generation;
1923
use Felix_Arntz\AI_Services\Services\Contracts\With_Text_Generation;
2024
use Felix_Arntz\AI_Services\Services\Entities\Service_Entity;
2125
use Felix_Arntz\AI_Services\Services\Entities\Service_Entity_Query;
@@ -438,7 +442,7 @@ public function list_models( array $args, array $assoc_args ): void {
438442
public function generate_text( array $args, array $assoc_args ): void {
439443
list( $service_slug, $model_slug, $prompt ) = $this->parse_generate_positional_args( $args );
440444

441-
$model_params = $this->get_model_params( $model_slug, $assoc_args );
445+
$model_params = $this->get_text_model_params( $model_slug, $assoc_args );
442446

443447
$attachment_id = isset( $assoc_args['attachment-id'] ) ? (int) $assoc_args['attachment-id'] : 0;
444448

@@ -471,6 +475,71 @@ public function generate_text( array $args, array $assoc_args ): void {
471475
}
472476
}
473477

478+
/**
479+
* Generates an image using a generative model from an available AI service.
480+
*
481+
* Only authorized users with sufficient permissions can use this command.
482+
* Provide the `--user` argument to specify the user.
483+
*
484+
* ## OPTIONS
485+
*
486+
* [<service>]
487+
* : The service to use. Can be omitted to use any available service.
488+
*
489+
* [<model>]
490+
* : The model to use from the service. Can be omitted to use any suitable model from the service.
491+
*
492+
* <prompt>
493+
* : The text prompt to generate an image.
494+
*
495+
* [--feature=<feature>]
496+
* : Required. Unique identifier of the feature that the model will be used for.
497+
*
498+
* [--system-instruction=<system-instruction>]
499+
* : System instruction for the model.
500+
*
501+
* [--<field>=<value>]
502+
* : Model generation config arguments. For example, `--size=2048x2048`.
503+
*
504+
* ## EXAMPLES
505+
*
506+
* wp ai-services generate-image google "Photorealistic image of a French bulldog wearing sunglasses in the forest." --feature=my-cli-test --user=admin > img_output.txt
507+
* wp ai-services generate-image openai dall-e-3 "Photorealistic image of a French bulldog wearing sunglasses in the forest." --feature=cli-example --user=admin > img_output.txt
508+
* wp ai-services generate-image openai "Photorealistic image of a French bulldog wearing sunglasses in the forest." --feature=cli-example --response-type=file_data --user=admin
509+
*
510+
* @subcommand generate-image
511+
*
512+
* @since n.e.x.t
513+
*
514+
* @param mixed[] $args List of the positional arguments.
515+
* @param array<string, mixed> $assoc_args Map of the associative arguments and their values.
516+
*/
517+
public function generate_image( array $args, array $assoc_args ): void {
518+
list( $service_slug, $model_slug, $prompt ) = $this->parse_generate_positional_args( $args );
519+
520+
$model_params = $this->get_image_model_params( $model_slug, $assoc_args );
521+
522+
if ( $service_slug ) {
523+
$service_args = $service_slug;
524+
} elseif ( isset( $model_params['capabilities'] ) ) {
525+
$service_args = array( 'capabilities' => $model_params['capabilities'] );
526+
} else {
527+
$service_args = array();
528+
}
529+
530+
try {
531+
$service = $this->services_api->get_available_service( $service_args );
532+
} catch ( InvalidArgumentException $e ) {
533+
WP_CLI::error( html_entity_decode( $e->getMessage() ) );
534+
}
535+
536+
$model = $this->get_model( $service, $model_params );
537+
538+
$content = Helpers::text_to_content( $prompt );
539+
540+
$this->generate_image_using_model( $model, $content );
541+
}
542+
474543
/**
475544
* Parses the positional arguments for a generate command.
476545
*
@@ -595,15 +664,15 @@ private function get_model_sort_callback( string $orderby, string $order ): call
595664
}
596665

597666
/**
598-
* Gets the model parameters for the given model slug and associative arguments.
667+
* Gets the text generation model parameters for the given model slug and associative arguments.
599668
*
600669
* @since n.e.x.t
601670
*
602671
* @param string|null $model_slug The model slug.
603672
* @param array<string, mixed> $assoc_args Map of the associative arguments and their values.
604673
* @return array<string, mixed> The model parameters, to retrieve a model.
605674
*/
606-
private function get_model_params( ?string $model_slug, array $assoc_args ): array {
675+
private function get_text_model_params( ?string $model_slug, array $assoc_args ): array {
607676
// Assume any unknown arguments are generation configuration arguments.
608677
$generation_config_args = $assoc_args;
609678
$assoc_args = $this->parse_assoc_args(
@@ -644,6 +713,41 @@ private function get_model_params( ?string $model_slug, array $assoc_args ): arr
644713
);
645714
}
646715

716+
/**
717+
* Gets the image generation model parameters for the given model slug and associative arguments.
718+
*
719+
* @since n.e.x.t
720+
*
721+
* @param string|null $model_slug The model slug.
722+
* @param array<string, mixed> $assoc_args Map of the associative arguments and their values.
723+
* @return array<string, mixed> The model parameters, to retrieve a model.
724+
*/
725+
private function get_image_model_params( ?string $model_slug, array $assoc_args ): array {
726+
// Assume any unknown arguments are generation configuration arguments.
727+
$generation_config_args = $assoc_args;
728+
$assoc_args = $this->parse_assoc_args(
729+
$assoc_args,
730+
array(
731+
'feature' => '',
732+
'system-instruction' => '',
733+
),
734+
$this->formatter_args
735+
);
736+
$generation_config_args = $this->sanitize_generation_config_args(
737+
array_diff_key( $generation_config_args, $assoc_args )
738+
);
739+
740+
$capabilities = array( AI_Capability::IMAGE_GENERATION );
741+
742+
return array(
743+
'feature' => $assoc_args['feature'] ? $assoc_args['feature'] : null,
744+
'model' => $model_slug,
745+
'capabilities' => $capabilities,
746+
'generationConfig' => Image_Generation_Config::from_array( $generation_config_args ),
747+
'systemInstruction' => $assoc_args['system-instruction'] ? $assoc_args['system-instruction'] : null,
748+
);
749+
}
750+
647751
/**
648752
* Sanitizes the generation configuration arguments.
649753
*
@@ -719,7 +823,7 @@ private function generate_text_using_model( Generative_AI_Model $model, Content
719823
} catch ( Generative_AI_Exception $e ) {
720824
WP_CLI::error(
721825
sprintf(
722-
'Generating content with model %1$s failed: %2$s',
826+
'Generating text with model %1$s failed: %2$s',
723827
$model->get_model_slug(),
724828
html_entity_decode( $e->getMessage() )
725829
)
@@ -770,7 +874,7 @@ private function stream_generate_text_using_model( Generative_AI_Model $model, C
770874
} catch ( Generative_AI_Exception $e ) {
771875
WP_CLI::error(
772876
sprintf(
773-
'Generating content with model %1$s failed: %2$s',
877+
'Generating text with model %1$s failed: %2$s',
774878
$model->get_model_slug(),
775879
html_entity_decode( $e->getMessage() )
776880
)
@@ -801,6 +905,55 @@ private function stream_generate_text_using_model( Generative_AI_Model $model, C
801905
}
802906
}
803907

908+
/**
909+
* Generates an image using the given generative model and prints it.
910+
*
911+
* @since n.e.x.t
912+
*
913+
* @param Generative_AI_Model $model The model to use.
914+
* @param Content $content Prompt for the content to generate.
915+
*/
916+
private function generate_image_using_model( Generative_AI_Model $model, Content $content ): void {
917+
if ( ! $model instanceof With_Image_Generation ) {
918+
WP_CLI::error( 'The model does not support image generation.' );
919+
}
920+
921+
try {
922+
$candidates = $model->generate_image( $content );
923+
} catch ( Generative_AI_Exception $e ) {
924+
WP_CLI::error(
925+
sprintf(
926+
'Generating image with model %1$s failed: %2$s',
927+
$model->get_model_slug(),
928+
html_entity_decode( $e->getMessage() )
929+
)
930+
);
931+
} catch ( InvalidArgumentException $e ) {
932+
WP_CLI::error(
933+
sprintf(
934+
'Invalid content provided to model %1$s: %2$s',
935+
$model->get_model_slug(),
936+
html_entity_decode( $e->getMessage() )
937+
)
938+
);
939+
}
940+
941+
$contents = Helpers::get_candidate_contents( $candidates );
942+
foreach ( $contents as $content ) {
943+
// If the content is purely an image, print it directly, otherwise print the parts as structured JSON.
944+
$parts = $content->get_parts();
945+
if ( count( $parts ) === 1 && $parts->get( 0 ) instanceof Inline_Data_Part ) {
946+
WP_CLI::print_value( $parts->get( 0 )->get_base64_data(), array( 'format' => 'table' ) );
947+
continue;
948+
}
949+
if ( count( $parts ) === 1 && $parts->get( 0 ) instanceof File_Data_Part ) {
950+
WP_CLI::print_value( $parts->get( 0 )->get_file_uri(), array( 'format' => 'table' ) );
951+
continue;
952+
}
953+
WP_CLI::print_value( $parts->to_array(), array( 'format' => 'json' ) );
954+
}
955+
}
956+
804957
/**
805958
* Parses and validates the associative arguments.
806959
*

0 commit comments

Comments
 (0)