From f397ae22e68d948f96b12e8aef5545fb6cc612b5 Mon Sep 17 00:00:00 2001 From: mudler <2420543+mudler@users.noreply.github.com> Date: Thu, 14 Nov 2024 20:03:15 +0000 Subject: [PATCH] feat(swagger): update swagger Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- swagger/docs.go | 90 +++++++++++++++++++++++++++++++++++++------- swagger/swagger.json | 90 +++++++++++++++++++++++++++++++++++++------- swagger/swagger.yaml | 57 +++++++++++++++++++++++----- 3 files changed, 200 insertions(+), 37 deletions(-) diff --git a/swagger/docs.go b/swagger/docs.go index 284656bf1346..afdeb03d9886 100644 --- a/swagger/docs.go +++ b/swagger/docs.go @@ -279,6 +279,25 @@ const docTemplate = `{ } } }, + "/tokenMetrics": { + "get": { + "consumes": [ + "application/json" + ], + "produces": [ + "audio/x-wav" + ], + "summary": "Get TokenMetrics for Active Slot.", + "responses": { + "200": { + "description": "generated audio/wav file", + "schema": { + "type": "string" + } + } + } + } + }, "/tts": { "post": { "consumes": [ @@ -723,6 +742,38 @@ const docTemplate = `{ } } } + }, + "/v1/tokenMetrics": { + "get": { + "consumes": [ + "application/json" + ], + "produces": [ + "audio/x-wav" + ], + "summary": "Get TokenMetrics for Active Slot.", + "responses": { + "200": { + "description": "generated audio/wav file", + "schema": { + "type": "string" + } + } + } + } + }, + "/v1/tokenize": { + "post": { + "summary": "Tokenize the input.", + "responses": { + "200": { + "description": "Response", + "schema": { + "$ref": "#/definitions/schema.TokenizeResponse" + } + } + } + } } }, "definitions": { @@ -972,14 +1023,6 @@ const docTemplate = `{ } } }, - "model.Model": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - }, "openai.Assistant": { "type": "object", "properties": { @@ -1682,6 +1725,14 @@ const docTemplate = `{ } } }, + "schema.SysInfoModel": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + }, "schema.SystemInformationResponse": { "type": "object", "properties": { @@ -1694,7 +1745,7 @@ const docTemplate = `{ "loaded_models": { "type": "array", "items": { - "$ref": "#/definitions/model.Model" + "$ref": "#/definitions/schema.SysInfoModel" } } } @@ -1718,14 +1769,25 @@ const docTemplate = `{ "description": "model name or full path", "type": "string" }, - "voice": { - "description": "voice audio file or speaker id", + "response_format": { + "description": "(optional) output format", "type": "string" }, - "response_format": { - "description": "(optional) output format of generated audio file, defaults to wav, accept wav, mp3, flac, aac, opus", + "voice": { + "description": "voice audio file or speaker id", "type": "string" - }, + } + } + }, + "schema.TokenizeResponse": { + "type": "object", + "properties": { + "tokens": { + "type": "array", + "items": { + "type": "integer" + } + } } }, "schema.ToolCall": { diff --git a/swagger/swagger.json b/swagger/swagger.json index 3ec82878525b..f3cfd2cad2c6 100644 --- a/swagger/swagger.json +++ b/swagger/swagger.json @@ -272,6 +272,25 @@ } } }, + "/tokenMetrics": { + "get": { + "consumes": [ + "application/json" + ], + "produces": [ + "audio/x-wav" + ], + "summary": "Get TokenMetrics for Active Slot.", + "responses": { + "200": { + "description": "generated audio/wav file", + "schema": { + "type": "string" + } + } + } + } + }, "/tts": { "post": { "consumes": [ @@ -716,6 +735,38 @@ } } } + }, + "/v1/tokenMetrics": { + "get": { + "consumes": [ + "application/json" + ], + "produces": [ + "audio/x-wav" + ], + "summary": "Get TokenMetrics for Active Slot.", + "responses": { + "200": { + "description": "generated audio/wav file", + "schema": { + "type": "string" + } + } + } + } + }, + "/v1/tokenize": { + "post": { + "summary": "Tokenize the input.", + "responses": { + "200": { + "description": "Response", + "schema": { + "$ref": "#/definitions/schema.TokenizeResponse" + } + } + } + } } }, "definitions": { @@ -965,14 +1016,6 @@ } } }, - "model.Model": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - }, "openai.Assistant": { "type": "object", "properties": { @@ -1675,6 +1718,14 @@ } } }, + "schema.SysInfoModel": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + }, "schema.SystemInformationResponse": { "type": "object", "properties": { @@ -1687,7 +1738,7 @@ "loaded_models": { "type": "array", "items": { - "$ref": "#/definitions/model.Model" + "$ref": "#/definitions/schema.SysInfoModel" } } } @@ -1711,16 +1762,27 @@ "description": "model name or full path", "type": "string" }, - "voice": { - "description": "voice audio file or speaker id", + "response_format": { + "description": "(optional) output format", "type": "string" }, - "response_format": { - "description": "(optional) output format of generated audio file, defaults to wav, accept wav, mp3, flac, aac, opus", + "voice": { + "description": "voice audio file or speaker id", "type": "string" } } }, + "schema.TokenizeResponse": { + "type": "object", + "properties": { + "tokens": { + "type": "array", + "items": { + "type": "integer" + } + } + } + }, "schema.ToolCall": { "type": "object", "properties": { @@ -1746,4 +1808,4 @@ "in": "header" } } -} +} \ No newline at end of file diff --git a/swagger/swagger.yaml b/swagger/swagger.yaml index af6055a12ab0..840a7ddaa729 100644 --- a/swagger/swagger.yaml +++ b/swagger/swagger.yaml @@ -168,11 +168,6 @@ definitions: type: string type: array type: object - model.Model: - properties: - id: - type: string - type: object openai.Assistant: properties: created: @@ -651,6 +646,11 @@ definitions: $ref: '#/definitions/p2p.NodeData' type: array type: object + schema.SysInfoModel: + properties: + id: + type: string + type: object schema.SystemInformationResponse: properties: backends: @@ -659,7 +659,7 @@ definitions: type: array loaded_models: items: - $ref: '#/definitions/model.Model' + $ref: '#/definitions/schema.SysInfoModel' type: array type: object schema.TTSRequest: @@ -676,12 +676,19 @@ definitions: model: description: model name or full path type: string + response_format: + description: (optional) output format + type: string voice: description: voice audio file or speaker id type: string - response_format: - description: (optional) output format of generated audio file, defaults to wav, accept wav, mp3, flac, aac, opus - type: string + type: object + schema.TokenizeResponse: + properties: + tokens: + items: + type: integer + type: array type: object schema.ToolCall: properties: @@ -867,6 +874,18 @@ paths: schema: $ref: '#/definitions/schema.SystemInformationResponse' summary: Show the LocalAI instance information + /tokenMetrics: + get: + consumes: + - application/json + produces: + - audio/x-wav + responses: + "200": + description: generated audio/wav file + schema: + type: string + summary: Get TokenMetrics for Active Slot. /tts: post: consumes: @@ -1149,6 +1168,26 @@ paths: schema: type: string summary: Generates audio from the input text. + /v1/tokenMetrics: + get: + consumes: + - application/json + produces: + - audio/x-wav + responses: + "200": + description: generated audio/wav file + schema: + type: string + summary: Get TokenMetrics for Active Slot. + /v1/tokenize: + post: + responses: + "200": + description: Response + schema: + $ref: '#/definitions/schema.TokenizeResponse' + summary: Tokenize the input. securityDefinitions: BearerAuth: in: header