<< Click to Display Table of Contents >> Navigation:  3. Script Language > AI - Artificial Intelligence Commands > AIX. - Grok / X - API > !Response Behavior Settings > AIX - Artificial Intelligence and X Platform Utility

---

MiniRobotLanguage (MRL)

 

AIX.Get FrequencyPenalty
Retrieve the Current Frequency Penalty Value

 

Intention

 

Get FrequencyPenalty Command: Check Repetition Control
 
The Get FrequencyPenalty command retrieves the current penalty value used to control word repetition in AI-generated responses.

This allows users to verify the setting’s impact.

It’s part of the AIX - Grok / X - API suite.

 

What is the Get FrequencyPenalty Command?

 

The Get FrequencyPenalty command returns the current value of the frequency penalty setting, likely stored in a global variable (e.g., AIX_FrequencyPenalty), which affects word repetition in responses.

The value typically ranges from 0.0 (no penalty) to 2.0 (high penalty), set by AIX.Set FrequencyPenalty.

 

Why Do You Need It?

 

Retrieving the frequency penalty is useful for:

•Verification: Confirms the current repetition control setting.

•Adjustment: Allows fine-tuning based on output analysis.

•Debugging: Identifies issues with repetition behavior.

 

How to Use the Get FrequencyPenalty Command?

 

Use the command to retrieve the current frequency penalty after setting it with AIX.Set FrequencyPenalty.

Store the result in a variable to use in conditional logic or display it before executing AIX.Ask or AIX.AskVision.

 

Example Usage

 

AIX.Set FrequencyPenalty|1.0

AIX.Get FrequencyPenalty|$$PENALTY

DBP.Current frequency penalty: $$PENALTY

AIX.Ask|""Generate a diverse paragraph""

 

This example sets a penalty, retrieves it, displays the value, and generates a response.

 

Illustration

 

┌────────────────────┐

│ Get Frequency      │

├────────────────────┤

│ Input: Global Var  │

│ Process: Retrieve  │

│ Output: Value      │

└────────────────────┘

A visual of retrieving the current frequency penalty value.

 

Syntax

 

AIX.Get FrequencyPenalty|$$variable

AIX_Get_FrequencyPenalty|$$variable

 

Parameter Explanation

 

$$variable - (Required) A variable (e.g., $$PENALTY) of type DOUBLE where the current frequency penalty value will be stored.

 

Remarks

 

- The value is set by AIX.Set FrequencyPenalty and applied to AIX.Ask and AIX.AskVision.

- The default value is 0.0 if not explicitly set.

 

Limitations

 

- Reflects only the current setting; does not indicate its effect on the last response.

- May not reflect API-level enforcement if the value is ignored or overridden.

 

See also:

 

• AIX.Set FrequencyPenalty

• AIX.Ask

• AIX.AskVision

• Model Configuration and Tools