huggingface/text-generation-inference
5
0
Fork 0
mirror of https://github.com/huggingface/text-generation-inference.git synced 2025-09-09 03:14:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Attempt to fix API doc check failure

Browse Source 
Add `error_type` where missing.
This commit is contained in:
Daniël de Kok 2025-08-29 08:56:10 +00:00
parent 047074978c
commit 76506c4ab7
2 changed files with 60 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
docs/openapi.json
View File

@ -57,7 +57,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Input validation error" "error": "Input validation error",
"error_type": "validation"
} }
} }
} }
@ -70,7 +71,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Request failed during generation" "error": "Request failed during generation",
"error_type": "generation"
} }
} }
} }
@ -83,7 +85,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Model is overloaded" "error": "Model is overloaded",
"error_type": "overloaded"
} }
} }
} }
@ -96,7 +99,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Incomplete generation" "error": "Incomplete generation",
"error_type": "incomplete_generation"
} }
} }
} }
@ -181,7 +185,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Input validation error" "error": "Input validation error",
"error_type": "validation"
} }
} }
} }
@ -194,7 +199,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Request failed during generation" "error": "Request failed during generation",
"error_type": "generation"
} }
} }
} }
@ -207,7 +213,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Model is overloaded" "error": "Model is overloaded",
"error_type": "overloaded"
} }
} }
} }
@ -220,7 +227,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Incomplete generation" "error": "Incomplete generation",
"error_type": "incomplete_generation"
} }
} }
} }
@ -264,7 +272,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Input validation error" "error": "Input validation error",
"error_type": "validation"
} }
} }
} }
@ -277,7 +286,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Request failed during generation" "error": "Request failed during generation",
"error_type": "generation"
} }
} }
} }
@ -290,7 +300,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Model is overloaded" "error": "Model is overloaded",
"error_type": "overloaded"
} }
} }
} }
@ -303,7 +314,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Incomplete generation" "error": "Incomplete generation",
"error_type": "incomplete_generation"
} }
} }
} }
@ -558,7 +570,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Input validation error" "error": "Input validation error",
"error_type": "validation"
} }
} }
} }
@ -571,7 +584,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Request failed during generation" "error": "Request failed during generation",
"error_type": "generation"
} }
} }
} }
@ -584,7 +598,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Model is overloaded" "error": "Model is overloaded",
"error_type": "overloaded"
} }
} }
} }
@ -597,7 +612,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Incomplete generation" "error": "Incomplete generation",
"error_type": "incomplete_generation"
} }
} }
} }
@ -646,7 +662,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Input validation error" "error": "Input validation error",
"error_type": "validation"
} }
} }
} }
@ -659,7 +676,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Request failed during generation" "error": "Request failed during generation",
"error_type": "generation"
} }
} }
} }
@ -672,7 +690,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Model is overloaded" "error": "Model is overloaded",
"error_type": "overloaded"
} }
} }
} }
@ -685,7 +704,8 @@
"$ref": "#/components/schemas/ErrorResponse" "$ref": "#/components/schemas/ErrorResponse"
}, },
"example": { "example": {
"error": "Incomplete generation" "error": "Incomplete generation",
"error_type": "incomplete_generation"
} }
} }
} }

40
router/src/server.rs
View File

@ -113,13 +113,13 @@ content(
("text/event-stream" = StreamResponse), ("text/event-stream" = StreamResponse),
)), )),
(status = 424, description = "Generation Error", body = ErrorResponse, (status = 424, description = "Generation Error", body = ErrorResponse,
example = json ! ({"error": "Request failed during generation"})), example = json ! ({"error": "Request failed during generation", "error_type": "generation"})),
(status = 429, description = "Model is overloaded", body = ErrorResponse, (status = 429, description = "Model is overloaded", body = ErrorResponse,
example = json ! ({"error": "Model is overloaded"})), example = json ! ({"error": "Model is overloaded", "error_type": "overloaded"})),
(status = 422, description = "Input validation error", body = ErrorResponse, (status = 422, description = "Input validation error", body = ErrorResponse,
example = json ! ({"error": "Input validation error"})), example = json ! ({"error": "Input validation error", "error_type": "validation"})),
(status = 500, description = "Incomplete generation", body = ErrorResponse, (status = 500, description = "Incomplete generation", body = ErrorResponse,
example = json ! ({"error": "Incomplete generation"})), example = json ! ({"error": "Incomplete generation", "error_type": "incomplete_generation"})),
) )
)] )]
#[instrument(skip(infer, req))] #[instrument(skip(infer, req))]
@ -249,13 +249,13 @@ request_body = GenerateRequest,
responses( responses(
(status = 200, description = "Generated Text", body = GenerateResponse), (status = 200, description = "Generated Text", body = GenerateResponse),
(status = 424, description = "Generation Error", body = ErrorResponse, (status = 424, description = "Generation Error", body = ErrorResponse,
example = json ! ({"error": "Request failed during generation"})), example = json ! ({"error": "Request failed during generation", "error_type": "generation"})),
(status = 429, description = "Model is overloaded", body = ErrorResponse, (status = 429, description = "Model is overloaded", body = ErrorResponse,
example = json ! ({"error": "Model is overloaded"})), example = json ! ({"error": "Model is overloaded", "error_type": "overloaded"})),
(status = 422, description = "Input validation error", body = ErrorResponse, (status = 422, description = "Input validation error", body = ErrorResponse,
example = json ! ({"error": "Input validation error"})), example = json ! ({"error": "Input validation error", "error_type": "validation"})),
(status = 500, description = "Incomplete generation", body = ErrorResponse, (status = 500, description = "Incomplete generation", body = ErrorResponse,
example = json ! ({"error": "Incomplete generation"})), example = json ! ({"error": "Incomplete generation", "error_type": "incomplete_generation"})),
) )
)] )]
#[instrument( #[instrument(
@ -448,16 +448,16 @@ responses(
(status = 200, description = "Generated Text", body = StreamResponse, (status = 200, description = "Generated Text", body = StreamResponse,
content_type = "text/event-stream"), content_type = "text/event-stream"),
(status = 424, description = "Generation Error", body = ErrorResponse, (status = 424, description = "Generation Error", body = ErrorResponse,
example = json ! ({"error": "Request failed during generation"}), example = json ! ({"error": "Request failed during generation", "error_type": "generation"}),
content_type = "text/event-stream"), content_type = "text/event-stream"),
(status = 429, description = "Model is overloaded", body = ErrorResponse, (status = 429, description = "Model is overloaded", body = ErrorResponse,
example = json ! ({"error": "Model is overloaded"}), example = json ! ({"error": "Model is overloaded", "error_type": "overloaded"}),
content_type = "text/event-stream"), content_type = "text/event-stream"),
(status = 422, description = "Input validation error", body = ErrorResponse, (status = 422, description = "Input validation error", body = ErrorResponse,
example = json ! ({"error": "Input validation error"}), example = json ! ({"error": "Input validation error", "error_type": "validation"}),
content_type = "text/event-stream"), content_type = "text/event-stream"),
(status = 500, description = "Incomplete generation", body = ErrorResponse, (status = 500, description = "Incomplete generation", body = ErrorResponse,
example = json ! ({"error": "Incomplete generation"}), example = json ! ({"error": "Incomplete generation", "error_type": "incomplete_generation"}),
content_type = "text/event-stream"), content_type = "text/event-stream"),
) )
)] )]
@ -691,13 +691,13 @@ content(
("text/event-stream" = Chunk), ("text/event-stream" = Chunk),
)), )),
(status = 424, description = "Generation Error", body = ErrorResponse, (status = 424, description = "Generation Error", body = ErrorResponse,
example = json ! ({"error": "Request failed during generation"})), example = json ! ({"error": "Request failed during generation", "error_type": "generation"})),
(status = 429, description = "Model is overloaded", body = ErrorResponse, (status = 429, description = "Model is overloaded", body = ErrorResponse,
example = json ! ({"error": "Model is overloaded"})), example = json ! ({"error": "Model is overloaded", "error_type": "overloaded"})),
(status = 422, description = "Input validation error", body = ErrorResponse, (status = 422, description = "Input validation error", body = ErrorResponse,
example = json ! ({"error": "Input validation error"})), example = json ! ({"error": "Input validation error", "error_type": "validation"})),
(status = 500, description = "Incomplete generation", body = ErrorResponse, (status = 500, description = "Incomplete generation", body = ErrorResponse,
example = json ! ({"error": "Incomplete generation"})), example = json ! ({"error": "Incomplete generation", "error_type": "incomplete_generation"})),
) )
)] )]
#[instrument( #[instrument(
@ -1144,13 +1144,13 @@ content(
("text/event-stream" = ChatCompletionChunk), ("text/event-stream" = ChatCompletionChunk),
)), )),
(status = 424, description = "Generation Error", body = ErrorResponse, (status = 424, description = "Generation Error", body = ErrorResponse,
example = json ! ({"error": "Request failed during generation"})), example = json ! ({"error": "Request failed during generation", "error_type": "generation"})),
(status = 429, description = "Model is overloaded", body = ErrorResponse, (status = 429, description = "Model is overloaded", body = ErrorResponse,
example = json ! ({"error": "Model is overloaded"})), example = json ! ({"error": "Model is overloaded", "error_type": "overloaded"})),
(status = 422, description = "Input validation error", body = ErrorResponse, (status = 422, description = "Input validation error", body = ErrorResponse,
example = json ! ({"error": "Input validation error"})), example = json ! ({"error": "Input validation error", "error_type": "validation"})),
(status = 500, description = "Incomplete generation", body = ErrorResponse, (status = 500, description = "Incomplete generation", body = ErrorResponse,
example = json ! ({"error": "Incomplete generation"})), example = json ! ({"error": "Incomplete generation", "error_type": "incomplete_generation"})),
) )
)] )]
#[instrument( #[instrument(