From bc361b8c55e991cb581079ac892c311a142770e9 Mon Sep 17 00:00:00 2001 From: Alvaro Bartolome <36760800+alvarobartt@users.noreply.github.com> Date: Fri, 29 Aug 2025 11:05:52 +0200 Subject: [PATCH] Update `docs/openapi.json` for v1.8.0 --- docs/openapi.json | 185 +++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 176 insertions(+), 9 deletions(-) diff --git a/docs/openapi.json b/docs/openapi.json index b6484887..ed63504c 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -10,7 +10,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" }, - "version": "1.7.1" + "version": "1.8.0" }, "paths": { "/decode": { @@ -41,6 +41,34 @@ } } }, + "400": { + "description": "Batch is empty", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "error": "Batch is empty", + "error_type": "empty" + } + } + } + }, + "413": { + "description": "Batch size error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "error": "Batch size error", + "error_type": "validation" + } + } + } + }, "422": { "description": "Tokenization error", "content": { @@ -49,8 +77,8 @@ "$ref": "#/components/schemas/ErrorResponse" }, "example": { - "message": "Tokenization error", - "type": "tokenizer" + "error": "Tokenization error", + "error_type": "tokenizer" } } } @@ -86,6 +114,20 @@ } } }, + "400": { + "description": "Batch is empty", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "error": "Batch is empty", + "error_type": "empty" + } + } + } + }, "413": { "description": "Batch size error", "content": { @@ -174,6 +216,20 @@ } } }, + "400": { + "description": "Batch is empty", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "error": "Batch is empty", + "error_type": "empty" + } + } + } + }, "413": { "description": "Batch size error", "content": { @@ -261,6 +317,20 @@ } } }, + "400": { + "description": "Batch is empty", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "error": "Batch is empty", + "error_type": "empty" + } + } + } + }, "413": { "description": "Batch size error", "content": { @@ -418,6 +488,20 @@ } } }, + "400": { + "description": "Batch is empty", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "error": "Batch is empty", + "error_type": "empty" + } + } + } + }, "413": { "description": "Batch size error", "content": { @@ -506,6 +590,20 @@ } } }, + "400": { + "description": "Batch is empty", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "error": "Batch is empty", + "error_type": "empty" + } + } + } + }, "413": { "description": "Batch size error", "content": { @@ -593,6 +691,20 @@ } } }, + "400": { + "description": "Batch is empty", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "error": "Batch is empty", + "error_type": "empty" + } + } + } + }, "413": { "description": "Batch size error", "content": { @@ -680,6 +792,34 @@ } } }, + "400": { + "description": "Batch is empty", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "error": "Batch is empty", + "error_type": "empty" + } + } + } + }, + "413": { + "description": "Batch size error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "error": "Batch size error", + "error_type": "validation" + } + } + } + }, "422": { "description": "Tokenization error", "content": { @@ -688,8 +828,8 @@ "$ref": "#/components/schemas/ErrorResponse" }, "example": { - "message": "Tokenization error", - "type": "tokenizer" + "error": "Tokenization error", + "error_type": "tokenizer" } } } @@ -725,6 +865,20 @@ } } }, + "400": { + "description": "Batch is empty", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAICompatErrorResponse" + }, + "example": { + "message": "Batch is empty", + "type": "empty" + } + } + } + }, "413": { "description": "Batch size error", "content": { @@ -900,6 +1054,14 @@ "inputs" ], "properties": { + "dimensions": { + "type": "integer", + "description": "The number of dimensions that the output embeddings should have. If not set, the original\nshape of the representation will be returned instead.", + "default": "null", + "example": "null", + "nullable": true, + "minimum": 0 + }, "inputs": { "$ref": "#/components/schemas/Input" }, @@ -1044,7 +1206,8 @@ "Backend", "Overloaded", "Validation", - "Tokenizer" + "Tokenizer", + "Empty" ] }, "Info": { @@ -1269,6 +1432,13 @@ "input" ], "properties": { + "dimensions": { + "type": "integer", + "default": "null", + "example": "null", + "nullable": true, + "minimum": 0 + }, "encoding_format": { "allOf": [ { @@ -1554,9 +1724,6 @@ }, "SimilarityParameters": { "type": "object", - "required": [ - "truncation_direction" - ], "properties": { "prompt_name": { "type": "string",