API: Add alias names to field descriptions

Helps with understanding API aliases. These aliases should not be used but are helpful for developers who want frontend compat. Signed-off-by: kingbri <[email protected]>
theroyallab · Jan 9, 2024 · 7a29664 · 7a29664
1 parent 1dbebd4
commit 7a29664
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/OAI/types/common.py b/OAI/types/common.py
@@ -78,7 +78,9 @@ class CommonCompletionRequest(BaseModel):
 
     # Aliased variables
     typical: Optional[float] = Field(
-        default=1.0, validation_alias=AliasChoices("typical", "typical_p")
+        default=1.0,
+        validation_alias=AliasChoices("typical", "typical_p"),
+        description="Aliases: typical_p",
     )
 
     penalty_range: Optional[int] = Field(
@@ -88,10 +90,13 @@ class CommonCompletionRequest(BaseModel):
             "repetition_range",
             "repetition_penalty_range",
         ),
+        description="Aliases: repetition_range, repetition_penalty_range",
     )
 
     cfg_scale: Optional[float] = Field(
-        default=1.0, validation_alias=AliasChoices("cfg_scale", "guidance_scale")
+        default=1.0,
+        validation_alias=AliasChoices("cfg_scale", "guidance_scale"),
+        description="Aliases: guidance_scale",
     )
 
     def to_gen_params(self):