Files
opnform-host-nginx/api/app/Service/AI/Prompts/Prompt.php
Chirag Chhatrala aa5c1acf3a Decouple title from title block (#696)
* Decouple title from title block

* fix lint

* remove dry run for FormTitleMigration

* Skip form title migration for forms with hidden titles

* Refactor AI Form Generation with Dedicated Prompt Services

- Extract AI form generation logic from GenerateTemplate command into dedicated prompt service classes
- Update GenerateAiForm job to use new prompt generation services
- Improve GptCompleter with more robust error handling and token tracking
- Add error field to AiFormCompletion model for better error logging
- Simplify command signature from 'ai:make-form-template' to 'form:generate'

* Consolidate Template Metadata Generation with Unified Prompt Service

- Create GenerateTemplateMetadataPrompt to centralize template metadata generation
- Update GenerateTemplate command to use new consolidated metadata generation approach
- Enhance GptCompleter to support strict JSON schema validation
- Increase form prompt max length to support more complex form descriptions
- Refactor form generation to simplify metadata extraction and processing

* Implement Form Mode Strategy for Flexible Form Rendering

- Introduce FormModeStrategy to centralize form rendering logic
- Add support for different form modes: LIVE, PREVIEW, TEST, EDIT, PREFILL
- Refactor components to use mode-based rendering strategy
- Remove legacy boolean props like adminPreview and creating
- Enhance form component flexibility and reusability

* Refine Form Mode Strategy Display Behavior

- Update FormModeStrategy to hide hidden fields in PREVIEW mode
- Add FormMode getter in UrlFormPrefill component for mode-specific rendering
- Clarify mode-specific validation and display logic in form strategies

* Enhance Form Template Generation with Advanced Field Options

- Update GenerateTemplate command to use front_url for template URL output
- Expand GenerateFormPrompt with comprehensive field configuration options
- Add support for advanced field types: date with time, toggle switches, radio/checkbox selections
- Introduce field width configuration and HTML formatting for text elements
- Re-enable select, multi-select, and matrix field type definitions with enhanced configurations

* Remove Deprecated Template Metadata Generation Services

- Delete multiple AI prompt services related to template metadata generation
- Simplify GenerateTemplate command to use default values instead of complex metadata generation
- Remove GenerateTemplateMetadataPrompt and related classes like GenerateTemplateDescriptionPrompt, GenerateTemplateImageKeywordsPrompt, etc.
- Update form template generation to use basic fallback metadata generation approach

* Restore GenerateTemplateMetadataPrompt for Comprehensive Template Generation

- Reintroduce GenerateTemplateMetadataPrompt to replace default metadata generation
- Update GenerateTemplate command to use consolidated metadata generation approach
- Extract detailed metadata components including title, description, industries, and image search query
- Improve template generation with more dynamic and AI-generated metadata

* Refactor Template Preview Section Layout

- Remove unnecessary nested div in template preview section
- Simplify HTML structure for the template preview component
- Maintain existing styling and functionality while improving code readability

* Refactor Constructor and Code Formatting in AI Form Generation and Prompt Classes

- Updated the constructor in GenerateAiForm.php to use a block structure for improved readability and consistency.
- Added a blank line in the Prompt.php file to enhance code formatting and maintain consistency with PHP coding standards.
- Modified the migration file to use a more concise class declaration syntax, improving clarity.

These changes aim to enhance code readability and maintainability across the affected files.

---------

Co-authored-by: Julien Nahum <julien@nahum.net>
2025-03-21 16:59:18 +01:00

147 lines
3.6 KiB
PHP

<?php
namespace App\Service\AI\Prompts;
use App\Service\OpenAi\GptCompleter;
use Illuminate\Support\Facades\Log;
use ReflectionClass;
use ReflectionProperty;
abstract class Prompt
{
protected GptCompleter $completer;
protected ?array $jsonSchema = null;
protected float $temperature = 0.7;
protected int $maxTokens = 4096;
protected string $model = 'gpt-4o';
protected bool $useStreaming = false;
/**
* Static method to create and execute a prompt in one step
*
* @param array $args Arguments to pass to the prompt constructor
* @return mixed The result of executing the prompt
*/
public static function run(...$args): mixed
{
$reflection = new ReflectionClass(static::class);
$instance = $reflection->newInstanceArgs($args);
return $instance->execute();
}
public function __construct()
{
$this->completer = new GptCompleter(null, 2, $this->model);
}
protected function initialize(): void
{
if ($this->jsonSchema) {
$this->completer->setJsonSchema($this->jsonSchema);
}
if ($this->getSystemMessage()) {
$this->completer->setSystemMessage($this->getSystemMessage());
}
if ($this->useStreaming) {
$this->completer->useStreaming();
}
}
/**
* Override this method to set a custom system message
*/
protected function getSystemMessage(): ?string
{
return null;
}
/**
* Must return the prompt template with placeholders
*/
abstract protected function getPromptTemplate(): string;
public function getCompleter(): GptCompleter
{
return $this->completer;
}
public function execute(): mixed
{
$this->initialize();
$prompt = $this->buildPrompt();
try {
$this->completer->completeChat(
[['role' => 'user', 'content' => $prompt]],
$this->maxTokens,
$this->temperature
);
return $this->jsonSchema ? $this->completer->getArray() : $this->completer->getString();
} catch (\Exception $e) {
Log::error('Error while executing prompt', [
'exception' => $e,
'prompt' => $prompt,
'json_schema' => $this->jsonSchema ?? null
]);
throw $e;
}
}
protected function buildPrompt(): string
{
$template = $this->getPromptTemplate();
$variables = $this->getPromptVariables();
return strtr($template, $variables);
}
protected function getPromptVariables(): array
{
$variables = [];
$reflection = new ReflectionClass($this);
foreach ($reflection->getProperties(ReflectionProperty::IS_PUBLIC) as $property) {
$name = $property->getName();
$value = $property->getValue($this);
if (is_scalar($value)) {
$variables['{' . $name . '}'] = (string) $value;
}
}
return $variables;
}
public function setTemperature(float $temperature): self
{
$this->temperature = $temperature;
return $this;
}
public function setMaxTokens(int $maxTokens): self
{
$this->maxTokens = $maxTokens;
return $this;
}
public function setGptCompleter(GptCompleter $completer): self
{
$this->completer = $completer;
return $this;
}
public function useStreaming(): self
{
$this->useStreaming = true;
return $this;
}
}