Reorder the parameters in the FastAPI documentation

This commit is contained in:
oobabooga 2023-11-06 09:55:36 -08:00
parent 0ed6a17ed4
commit 4a45dc4041

View file

@ -7,13 +7,9 @@ from pydantic import BaseModel, Field
class GenerationOptions(BaseModel): class GenerationOptions(BaseModel):
preset: str | None = None preset: str | None = None
temperature: float = 1
top_p: float = 1
min_p: float = 0 min_p: float = 0
top_k: int = 0 top_k: int = 0
repetition_penalty: float = 1 repetition_penalty: float = 1
presence_penalty: float = 0
frequency_penalty: float = 0
repetition_penalty_range: int = 0 repetition_penalty_range: int = 0
typical_p: float = 1 typical_p: float = 1
tfs: float = 1 tfs: float = 1
@ -45,7 +41,7 @@ class GenerationOptions(BaseModel):
grammar_string: str = "" grammar_string: str = ""
class CompletionRequest(GenerationOptions): class CompletionRequestParams(BaseModel):
model: str | None = None model: str | None = None
prompt: str | List[str] prompt: str | List[str]
best_of: int | None = 1 best_of: int | None = 1
@ -64,6 +60,10 @@ class CompletionRequest(GenerationOptions):
user: str | None = None user: str | None = None
class CompletionRequest(GenerationOptions, CompletionRequestParams):
pass
class CompletionResponse(BaseModel): class CompletionResponse(BaseModel):
id: str id: str
choices: List[dict] choices: List[dict]
@ -73,7 +73,7 @@ class CompletionResponse(BaseModel):
usage: dict usage: dict
class ChatCompletionRequest(GenerationOptions): class ChatCompletionRequestParams(BaseModel):
messages: List[dict] messages: List[dict]
model: str | None = None model: str | None = None
frequency_penalty: float | None = 0 frequency_penalty: float | None = 0
@ -108,6 +108,10 @@ class ChatCompletionRequest(GenerationOptions):
continue_: bool = Field(default=False, description="Makes the last bot message in the history be continued instead of starting a new message.") continue_: bool = Field(default=False, description="Makes the last bot message in the history be continued instead of starting a new message.")
class ChatCompletionRequest(GenerationOptions, ChatCompletionRequestParams):
pass
class ChatCompletionResponse(BaseModel): class ChatCompletionResponse(BaseModel):
id: str id: str
choices: List[dict] choices: List[dict]