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

@type adjuster() :: term()

Optional lambda method to adjust setting value before setting in inference request.

@type as() :: term()

alias to inject param as when building model request.

Link to this type

concrete_value()

@type concrete_value() :: {:concrete_value, value :: any()}

Concrete Entry Value.

Link to this type

data_generator_entry()

@type data_generator_entry() :: {:data_generator_entry, generator :: any()}

Reference to a data generator entry.

@type default() :: number()

Default value is only used for required settings if not provided.

Link to this type

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.

Link to this type

message_entry()

@type message_entry() :: {:message_entry, msg :: any()}

Reference to a message list.

Link to this type

model_entry()

@type model_entry() :: {:model_entry}

Reference to a model entry.

Link to this type

model_setting_entry()

@type model_setting_entry() ::
  {:model_setting_entry, model :: any(), setting :: any()}

Reference to a model-specific setting entry.

Link to this type

monitor_entry()

@type monitor_entry() :: {:monitor_entry, monitor :: any()}

Reference to a monitor entry.

Link to this type

option_entry()

@type option_entry() :: {:option_entry, option :: any()}

Reference to an option entry.

@type param() :: term()

input key for param: value pulled from effective settings

Link to this type

param_type()

@type param_type() :: :float | :int | :bool | :string | :list | :map

type of supported parm

Link to this type

provider_setting_entry()

@type provider_setting_entry() ::
  {:provider_setting_entry, provider :: any(), setting :: any()}

Reference to a provider-specific setting entry.

@type range() :: term()

allowed range of values for param

@type required() :: boolean()

flag if field is required

Link to this type

safety_setting_entry()

@type safety_setting_entry() :: {:safety_setting_entry, category :: any()}

Reference to a safety setting entry.

@type sentinel() :: term()

Optional lambda method to check (model, setting, settings, session, context, options) to determine if setting is valid/supported.

Link to this type

setting_entry()

@type setting_entry() :: {:setting_entry, setting :: any()}

Reference to a setting entry.

Link to this type

stack_entry()

@type stack_entry() :: {:stack_entry, element :: any()}

Reference to a stack entry.

Link to this type

tool_entry()

@type tool_entry() :: {:tool_entry, tool :: any()}

Reference to a tool entry.

Link to this section Functions

Link to this macro

concrete_value(args \\ [])

(macro)
Link to this macro

concrete_value(record, args)

(macro)
Link to this macro

data_generator_entry(args \\ [])

(macro)
Link to this macro

data_generator_entry(record, args)

(macro)
Link to this macro

hyper_param(args \\ [])

(macro)
Link to this macro

hyper_param(record, args)

(macro)
Link to this macro

message_entry(args \\ [])

(macro)
Link to this macro

message_entry(record, args)

(macro)
Link to this macro

model_entry(args \\ [])

(macro)
Link to this macro

model_entry(record, args)

(macro)
Link to this macro

model_setting_entry(args \\ [])

(macro)
Link to this macro

model_setting_entry(record, args)

(macro)
Link to this macro

monitor_entry(args \\ [])

(macro)
Link to this macro

monitor_entry(record, args)

(macro)
Link to this macro

option_entry(args \\ [])

(macro)
Link to this macro

option_entry(record, args)

(macro)
Link to this macro

provider_setting_entry(args \\ [])

(macro)
Link to this macro

provider_setting_entry(record, args)

(macro)
Link to this macro

safety_setting_entry(args \\ [])

(macro)
Link to this macro

safety_setting_entry(record, args)

(macro)
Link to this macro

setting_entry(args \\ [])

(macro)
Link to this macro

setting_entry(record, args)

(macro)
Link to this macro

stack_entry(args \\ [])

(macro)
Link to this macro

stack_entry(record, args)

(macro)
Link to this macro

tool_entry(args \\ [])

(macro)
Link to this macro

tool_entry(record, args)

(macro)