AxRefineOptions Generated TypeScript API reference. typescript api api/reference build/apidocs/TypeAlias.AxRefineOptions.md type AxRefineOptions

AxRefineOptions

TypeScript
type AxRefineOptions<IN, OUT> = object;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/refine.ts#L65

Type Parameters

Type Parameter
IN
OUT extends AxGenOut

Properties

failCount?

TypeScript
optional failCount: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/refine.ts#L70


feedbackAI?

TypeScript
optional feedbackAI: Readonly<AxAIService>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/refine.ts#L73


feedbackModelConfig?

TypeScript
optional feedbackModelConfig: Partial<AxModelConfig>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/refine.ts#L74


modelConfig?

TypeScript
optional modelConfig: Partial<AxModelConfig>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/refine.ts#L71


onAttempt()?

TypeScript
optional onAttempt: (attempt: Readonly<AxAttempt<IN, OUT>>) => void | Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/refine.ts#L77

Parameters

ParameterType
attemptReadonly<AxAttempt<IN, OUT>>

Returns

void | Promise<void>


programDescription?

TypeScript
optional programDescription: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/refine.ts#L76


rewardDescription?

TypeScript
optional rewardDescription: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/refine.ts#L75


rewardFn

TypeScript
rewardFn: AxRewardFn<IN, OUT>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/refine.ts#L68


rounds

TypeScript
rounds: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/refine.ts#L66


samplesPerRound?

TypeScript
optional samplesPerRound: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/refine.ts#L67


strategy?

TypeScript
optional strategy: AxRefineStrategy;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/refine.ts#L72


threshold?

TypeScript
optional threshold: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/refine.ts#L69

Docs