Версия: 6.x
burger close
Класс AbstractField
Граф наследования:AbstractField:
HtmlField StringField TextField

Подробное описание

Базовый класс для поля(свойства), которое будет автоматически заполняться с помощью ИИ Каждый объект одного поля способен сформировать промпт и обработать результат Запрос автоматически дополняется, характерными для типа поля уточнениями в запрсое

Открытые члены

 __construct (protected AbstractTransformer $transformer, protected string $field_name, protected string $title, array $options=[])
 
 getTypeTitle ()
 
 getOrmProperty ()
 
 setMaxLength ($max_length)
 
 setEnable ($bool)
 
 setPrompt (Prompt $prompt)
 
 getPrompt ()
 
 getEnable ()
 
 getMaxLength ()
 
 getPromptText ()
 
 makeCompletionRequest ($statistic_params=[])
 
 getFieldName ()
 
 getTitle ()
 
 getSystemPrompt ()
 
 getPrompts ($cache=true)
 
 addFieldAttributes (AbstractObject $orm_object)
 
 getSettingFormObject ()
 

Поля данных

const SYSTEM_PROMPT_BASE = 'base'
 
const SYSTEM_PROMPT_FORMAT = 'format'
 

Защищенные члены

 getFilterResultGenerator (\Traversable $source_stream)
 
 getSystemPromptParts ()
 

Конструктор(ы)

__construct ( protected AbstractTransformer  $transformer,
protected string  $field_name,
protected string  $title,
array  $options = [] 
)

Конструктор

Аргументы
AbstractTransformer$transformerОбъект, который отвечает за транформацию какого-либо объекта (Товар, Статья, ...)
string$field_nameИмя поля у трансформируемого объекта
string$titleНазвание поля у трансформируемого объекта
array$optionsДополнительные параметры. Будут устанавливаться с помощью методов setКЛЮЧ(ЗНАЧЕНИЕ)
Исключения
Exception

Методы

addFieldAttributes ( AbstractObject  $orm_object)

Добавляет атрибуты к полю ORM-объекта, необходимые для активации возможностей в административной панели

Аргументы
AbstractObject$orm_object
Возвращает
void
getEnable ( )

Возвращает, нужно ли генерировать данное поле для всего объекта

Возвращает
bool
getFieldName ( )

Возвращает имя поля

Возвращает
string
getFilterResultGenerator ( \Traversable  $source_stream)
protected

Возвращает генератор, который может предварительно обрабатывать полученный исходный поток данных

Аргументы
\Traversable$source_stream
Возвращает
getMaxLength ( )

Возвращает максимально возможную длину значения в поле

Возвращает
integer
getOrmProperty ( )
abstract

Возвращает объект свойства ORM объекта, с помощью которого можно отобразить форму с генерируемым значением

Возвращает
AbstractType
getPrompt ( )

Возвращает конкретный prompt ID, который нужно использовать в запросах к ИИ. Если промпт явно не задан, то будет использован первый в списке для данного поля

Возвращает
Prompt
getPrompts (   $cache = true)

Возвращает список, связанных с данным полем промптов

Аргументы
bool$cache= true
Возвращает
Prompt[]
getPromptText ( )

Возвращает запрос на заполнение данного поля для ИИ. Данный метод может добавлять какие-либо уточнения к запросу, задаваемому пользователем

Возвращает
string
getSettingFormObject ( )

Возвращает объект, содержащий форму настроек для диалога массового заполнения полей объектов

Возвращает
FormObject
getSystemPrompt ( )
final

Возвращает единую строку системного текста

Возвращает
string
getSystemPromptParts ( )
protected

Возвращает массив кусков сисистемного промпта, в котором должен быть описан контекст и формат возвращаемых данных. Данный массив будет объединен в единый текст.

Возвращает
array
getTitle ( )

Возвращает название поля

Возвращает
string
getTypeTitle ( )
abstract

Возвращает строковое название типа

Возвращает
string
makeCompletionRequest (   $statistic_params = [])

Выполняет запрос к ИИ и возвращает результат в виде стрима

Возвращает
setEnable (   $bool)

Устанавливает, нужно ли генерировать данное поле для всего объекта

Аргументы
bool$boolЕсли true, то включено, если false - выключено
Возвращает
$this
setMaxLength (   $max_length)

Устанавливает максимальную длину значения

Аргументы
integer$max_length
Возвращает
$this
setPrompt ( Prompt  $prompt)

Устанавливает конкретный prompt ID, который нужно использовать в запросах к ИИ

Аргументы
Prompt$id
Возвращает
$this

Поля

const SYSTEM_PROMPT_BASE = 'base'
const SYSTEM_PROMPT_FORMAT = 'format'