GenAI.Records.Directive (GenAI Core v0.2.0)
Records used by for directive processing.
Link to this section Summary
Types
Optional lambda method to adjust setting value before setting in inference request.
alias to inject param as when building model request.
Concrete Entry Value.
Reference to a data generator entry.
Default value is only used for required settings if not provided.
Supported Parameter Record.
Reference to a message list.
Reference to a model entry.
Reference to a model-specific setting entry.
Reference to a monitor entry.
Reference to an option entry.
input key for param: value pulled from effective settings
type of supported parm
Reference to a provider-specific setting entry.
allowed range of values for param
flag if field is required
Reference to a safety setting entry.
Optional lambda method to check (model, setting, settings, session, context, options) to determine if setting is valid/supported.
Reference to a setting entry.
Reference to a stack entry.
Reference to a tool entry.
Link to this section Types
adjuster()
@type adjuster() :: term()
Optional lambda method to adjust setting value before setting in inference request.
as()
@type as() :: term()
alias to inject param as when building model request.
concrete_value()
@type concrete_value() :: {:concrete_value, value :: any()}
Concrete Entry Value.
data_generator_entry()
@type data_generator_entry() :: {:data_generator_entry, generator :: any()}
Reference to a data generator entry.
default()
@type default() :: number()
Default value is only used for required settings if not provided.
hyper_param()
@type hyper_param() :: {:hyper_param, name :: param(), type :: param_type(), as :: as(), required :: required(), sentinel :: sentinel(), adjuster :: adjuster(), min :: number() | :infnity, max :: number() | :infinity, default :: number()}
Supported Parameter Record.
message_entry()
@type message_entry() :: {:message_entry, msg :: any()}
Reference to a message list.
model_entry()
@type model_entry() :: {:model_entry}
Reference to a model entry.
model_setting_entry()
Reference to a model-specific setting entry.
monitor_entry()
@type monitor_entry() :: {:monitor_entry, monitor :: any()}
Reference to a monitor entry.
option_entry()
@type option_entry() :: {:option_entry, option :: any()}
Reference to an option entry.
param()
@type param() :: term()
input key for param: value pulled from effective settings
param_type()
@type param_type() :: :float | :int | :bool | :string | :list | :map
type of supported parm
provider_setting_entry()
Reference to a provider-specific setting entry.
range()
@type range() :: term()
allowed range of values for param
required()
@type required() :: boolean()
flag if field is required
safety_setting_entry()
@type safety_setting_entry() :: {:safety_setting_entry, category :: any()}
Reference to a safety setting entry.
sentinel()
@type sentinel() :: term()
Optional lambda method to check (model, setting, settings, session, context, options) to determine if setting is valid/supported.
setting_entry()
@type setting_entry() :: {:setting_entry, setting :: any()}
Reference to a setting entry.
stack_entry()
@type stack_entry() :: {:stack_entry, element :: any()}
Reference to a stack entry.
tool_entry()
@type tool_entry() :: {:tool_entry, tool :: any()}
Reference to a tool entry.