diff --git a/docs/openapi.json b/docs/openapi.json index 7ece1722..8ddaabac 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -210,13 +210,62 @@ }, "components": { "schemas": { + "BestOfSequence": { + "type": "object", + "required": [ + "generated_text", + "finish_reason", + "generated_tokens", + "prefill", + "tokens" + ], + "properties": { + "finish_reason": { + "$ref": "#/components/schemas/FinishReason" + }, + "generated_text": { + "type": "string", + "example": "test" + }, + "generated_tokens": { + "type": "integer", + "format": "int32", + "example": 1 + }, + "prefill": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PrefillToken" + } + }, + "seed": { + "type": "integer", + "format": "int64", + "example": 42 + }, + "tokens": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Token" + } + } + } + }, "Details": { "type": "object", "required": [ "finish_reason", - "generated_tokens" + "generated_tokens", + "prefill", + "tokens" ], "properties": { + "best_of_sequences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BestOfSequence" + } + }, "finish_reason": { "$ref": "#/components/schemas/FinishReason" }, @@ -247,11 +296,15 @@ "ErrorResponse": { "type": "object", "required": [ - "error" + "error", + "error_type" ], "properties": { "error": { "type": "string" + }, + "error_type": { + "type": "string" } } }, @@ -266,6 +319,13 @@ "GenerateParameters": { "type": "object", "properties": { + "best_of": { + "type": "integer", + "default": "null", + "example": 1, + "nullable": true, + "exclusiveMinimum": 0.0 + }, "details": { "type": "boolean", "default": "true" @@ -297,7 +357,11 @@ }, "seed": { "type": "integer", - "format": "int64" + "format": "int64", + "default": "null", + "example": "null", + "nullable": true, + "exclusiveMinimum": 0.0 }, "stop": { "type": "array", @@ -334,6 +398,15 @@ "maximum": 1.0, "exclusiveMinimum": 0.0 }, + "typical_p": { + "type": "number", + "format": "float", + "default": "null", + "example": 0.95, + "nullable": true, + "maximum": 1.0, + "exclusiveMinimum": 0.0 + }, "watermark": { "type": "boolean", "default": "false", diff --git a/router/src/server.rs b/router/src/server.rs index 0983feea..3b63ec8a 100644 --- a/router/src/server.rs +++ b/router/src/server.rs @@ -87,21 +87,21 @@ async fn health(infer: Extension) -> Result<(), (StatusCode, Json) -> String { prom_handle.render() @@ -463,36 +463,36 @@ pub async fn run( // OpenAPI documentation #[derive(OpenApi)] #[openapi( - paths( - generate, - generate_stream, - metrics, - ), - components( - schemas( - GenerateRequest, - GenerateParameters, - PrefillToken, - Token, - GenerateResponse, - BestOfSequence, - Details, - FinishReason, - StreamResponse, - StreamDetails, - ErrorResponse, - ) - ), - tags( - (name = "Text Generation Inference", description = "Hugging Face Text Generation Inference API") - ), - info( - title = "Text Generation Inference", - license( - name = "Apache 2.0", - url = "https://www.apache.org/licenses/LICENSE-2.0" - ) - ) + paths( + generate, + generate_stream, + metrics, + ), + components( + schemas( + GenerateRequest, + GenerateParameters, + PrefillToken, + Token, + GenerateResponse, + BestOfSequence, + Details, + FinishReason, + StreamResponse, + StreamDetails, + ErrorResponse, + ) + ), + tags( + (name = "Text Generation Inference", description = "Hugging Face Text Generation Inference API") + ), + info( + title = "Text Generation Inference", + license( + name = "Apache 2.0", + url = "https://www.apache.org/licenses/LICENSE-2.0" + ) + ) )] struct ApiDoc;