Skip to content

Able to use settings as context settings #83

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Able to use settings as context settings #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aa8becc
Able to use settings as context settings
hylkest Oct 27, 2025
cfa97c7
Send contextkey with the function
hylkest Oct 27, 2025
4a1da83
Feedback
hylkest Nov 10, 2025
69e2155
Add support in vision endpoint
hylkest Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions core/components/modai/src/API/Prompt/Text.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ class Text extends API

public function post(ServerRequestInterface $request): void
{
$contextKey = null;

if (!$this->modx->hasPermission('modai_client_text')) {
throw APIException::unauthorized();
}
Expand Down Expand Up @@ -60,7 +62,7 @@ public function post(ServerRequestInterface $request): void
if (!$resource) {
throw new LexiconException('modai.error.no_resource_found');
}

$contextKey = $resource->get('context_key');
$content = $resource->getContent();

if (empty($content)) {
Expand All @@ -71,13 +73,13 @@ public function post(ServerRequestInterface $request): void
$systemInstructions = [];

$stream = intval(Settings::getTextSetting($this->modx, $field, 'stream', $namespace)) === 1;
$model = Settings::getTextSetting($this->modx, $field, 'model', $namespace);
$temperature = (float)Settings::getTextSetting($this->modx, $field, 'temperature', $namespace);
$maxTokens = (int)Settings::getTextSetting($this->modx, $field, 'max_tokens', $namespace);
$output = Settings::getTextSetting($this->modx, $field, 'base_output', $namespace, false);
$base = Settings::getTextSetting($this->modx, $field, 'base_prompt', $namespace, false);
$fieldPrompt = Settings::getTextSetting($this->modx, $field, 'prompt', $namespace);
$customOptions = Settings::getTextSetting($this->modx, $field, 'custom_options', $namespace, false);
$model = Settings::getTextSetting($this->modx, $field, 'model', $namespace, true, $contextKey);
$temperature = (float)Settings::getTextSetting($this->modx, $field, 'temperature', $namespace , true, $contextKey);
$maxTokens = (int)Settings::getTextSetting($this->modx, $field, 'max_tokens', $namespace, true, $contextKey);
$output = Settings::getTextSetting($this->modx, $field, 'base_output', $namespace, false, $contextKey);
$base = Settings::getTextSetting($this->modx, $field, 'base_prompt', $namespace, false, $contextKey);
$fieldPrompt = Settings::getTextSetting($this->modx, $field, 'prompt', $namespace, true, $contextKey);
$customOptions = Settings::getTextSetting($this->modx, $field, 'custom_options', $namespace, false, $contextKey);

if (!empty($output)) {
$systemInstructions[] = $output;
Expand Down
23 changes: 17 additions & 6 deletions core/components/modai/src/API/Prompt/Vision.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,35 +10,46 @@
use modAI\Settings;
use modAI\Utils;
use Psr\Http\Message\ServerRequestInterface;
use MODX\Revolution\modResource;

class Vision extends API
{
public function post(ServerRequestInterface $request): void
{
$contextKey = null;
if (!$this->modx->hasPermission('modai_client_vision')) {
throw APIException::unauthorized();
}

set_time_limit(0);

$data = $request->getParsedBody();

$field = Utils::getOption('field', $data);
$namespace = Utils::getOption('namespace', $data, 'modai');
$image = Utils::getOption('image', $data);
$prompt = Utils::getOption('prompt', $data);
$resourceId = Utils::getOption('resourceId', $data);

if (empty($image)) {
throw new LexiconException('modai.error.image_requried');
}

$stream = intval(Settings::getVisionSetting($this->modx, $field, 'stream', $namespace)) === 1;
$model = Settings::getVisionSetting($this->modx, $field, 'model', $namespace);
if (!empty($resourceId)) {
/** @var modResource $resource */
$resource = $this->modx->getObject('modResource', $resourceId);
if (!$resource) {
throw new LexiconException('modai.error.no_resource_found');
}
$contextKey = $resource->get('context_key');
}

$stream = intval(Settings::getVisionSetting($this->modx, $field, 'stream', $namespace, true, $contextKey)) === 1;
$model = Settings::getVisionSetting($this->modx, $field, 'model', $namespace, true, $contextKey);
if (empty($prompt)) {
$prompt = Settings::getVisionSetting($this->modx, $field, 'prompt', $namespace);
$prompt = Settings::getVisionSetting($this->modx, $field, 'prompt', $namespace, true, $contextKey);
}
$customOptions = Settings::getVisionSetting($this->modx, $field, 'custom_options', $namespace, false);
$maxTokens = (int)Settings::getVisionSetting($this->modx, $field, 'max_tokens', $namespace);
$customOptions = Settings::getVisionSetting($this->modx, $field, 'custom_options', $namespace, false, $contextKey);
$maxTokens = (int)Settings::getVisionSetting($this->modx, $field, 'max_tokens', $namespace, true, $contextKey);

$aiService = AIServiceFactory::new($model, $this->modx);
$result = $aiService->getVision(
Expand Down
31 changes: 20 additions & 11 deletions core/components/modai/src/Settings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,28 +25,37 @@ class Settings
* @param string $setting
* @return string|null
*/
private static function getOption(modX $modx, string $namespace, string $field, string $area, string $setting): ?string
private static function getOption(modX $modx, string $namespace, string $field, string $area, string $setting, ?string $contextKey = null): ?string
{
$handler = $modx;

if (!empty($contextKey)) {
$context = $modx->getContext($contextKey);
if ($context) {
$handler = $context;
}
}

if (!empty($field)) {
$value = $modx->getOption("#sys.$field.$area.$setting");
$value = $handler->getOption("#sys.$field.$area.$setting");
if ($value !== null && $value !== '') {
return $value;
}
}

$value = $modx->getOption("#sys.global.$area.$setting");
$value = $handler->getOption("#sys.global.$area.$setting");
if ($value !== null && $value !== '') {
return $value;
}

if (!empty($field)) {
$value = $modx->getOption("$namespace.$field.$area.$setting");
$value = $handler->getOption("$namespace.$field.$area.$setting");
if ($value !== null && $value !== '') {
return $value;
}
}

$value = $modx->getOption("$namespace.global.$area.$setting");
$value = $handler->getOption("$namespace.global.$area.$setting");
if ($value !== null && $value !== '') {
return $value;
}
Expand All @@ -56,13 +65,13 @@ private static function getOption(modX $modx, string $namespace, string $field,
}

if (!empty($field)) {
$value = $modx->getOption("modai.$field.$area.$setting");
$value = $handler->getOption("modai.$field.$area.$setting");
if ($value !== null && $value !== '') {
return $value;
}
}

$value = $modx->getOption("modai.global.$area.$setting");
$value = $handler->getOption("modai.global.$area.$setting");
if ($value !== null && $value !== '') {
return $value;
}
Expand All @@ -73,9 +82,9 @@ private static function getOption(modX $modx, string $namespace, string $field,
/**
* @throws RequiredSettingException
*/
public static function getTextSetting(modX $modx, string $field, string $setting, string $namespace = 'modai', bool $required = true): ?string
public static function getTextSetting(modX $modx, string $field, string $setting, string $namespace = 'modai', bool $required = true, ?string $contextKey = null): ?string
{
$value = self::getOption($modx, $namespace, $field, 'text', $setting);
$value = self::getOption($modx, $namespace, $field, 'text', $setting, $contextKey);

if ($required && ($value === null || $value === '')) {
throw new RequiredSettingException("modai.global.text.$setting");
Expand All @@ -101,9 +110,9 @@ public static function getImageSetting(modX $modx, string $field, string $settin
/**
* @throws RequiredSettingException
*/
public static function getVisionSetting(modX $modx, string $field, string $setting, string $namespace = 'modai', bool $required = true): ?string
public static function getVisionSetting(modX $modx, string $field, string $setting, string $namespace = 'modai', bool $required = true, ?string $contextKey = null): ?string
{
$value = self::getOption($modx, $namespace, $field, 'vision', $setting);
$value = self::getOption($modx, $namespace, $field, 'vision', $setting, $contextKey);

if ($required && ($value === null || $value === '')) {
throw new RequiredSettingException("modai.global.vision.$setting");
Expand Down