From 48c9c31440a805ab35654c8d09c0e960f7b5f2ff Mon Sep 17 00:00:00 2001
From: oobabooga <112222186+oobabooga@users.noreply.github.com>
Date: Tue, 7 Nov 2023 08:23:17 -0800
Subject: [PATCH] Document the "preset" option in the API

---
 extensions/openai/typing.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/extensions/openai/typing.py b/extensions/openai/typing.py
index d41fc8c1..c9a3b30a 100644
--- a/extensions/openai/typing.py
+++ b/extensions/openai/typing.py
@@ -6,7 +6,7 @@ from pydantic import BaseModel, Field
 
 
 class GenerationOptions(BaseModel):
-    preset: str | None = None
+    preset: str | None = Field(default=None, description="The name of a file under text-generation-webui/presets (without the .yaml extension). The sampling parameters that get overwritten by this option are the keys in the default_preset() function in modules/presets.py.")
     min_p: float = 0
     top_k: int = 0
     repetition_penalty: float = 1