From a2a0c38144a91a731d073705c83f268a30dbd849 Mon Sep 17 00:00:00 2001 From: hieu-jan <150573299+hieu-jan@users.noreply.github.com> Date: Tue, 28 Nov 2023 05:57:13 +0900 Subject: [PATCH] docs: finalize labeling models --- docs/openapi/jan.yaml | 75 ++++++++++++++++++++++++---------- docs/openapi/specs/models.yaml | 34 +++++++-------- 2 files changed, 70 insertions(+), 39 deletions(-) diff --git a/docs/openapi/jan.yaml b/docs/openapi/jan.yaml index 84274cfb80..2a04467ded 100644 --- a/docs/openapi/jan.yaml +++ b/docs/openapi/jan.yaml @@ -52,8 +52,12 @@ paths: tags: - Models - summary: List Models - description: Lists the currently available models, and provides basic information about each one such as the owner and availability. + summary: List models + description: | + + + Lists the currently available models, and provides basic information about each one such as the owner and availability. + responses: "200": description: OK @@ -69,8 +73,11 @@ paths: operationId: downloadModel tags: - Models - summary: Download Model - description: Download a model. + summary: Download model + description: | + Jan + + Download a model. responses: "200": description: OK @@ -84,20 +91,26 @@ paths: curl -X POST https://localhost:1337/v1/models /models/{model_id}: get: - operationId: getModel + operationId: retrieveModel tags: - Models - summary: Get Model - description: Get a model instance, providing basic information about the model such as the owner and permissioning. + summary: Retrieve model + description: | + + + Get a model instance, providing basic information about the model such as the owner and permissioning. parameters: - in: path - name: source_url + name: model_id required: true schema: type: string # ideally this will be an actual ID, so this will always work from browser - example: https://huggingface.com/thebloke/example.gguf - description: The ID of the model to use for this request + example: zephyr-7b + description: | + The ID of the model to use for this request + + OpenAI compatible responses: "200": description: OK @@ -113,8 +126,11 @@ paths: operationId: deleteModel tags: - Models - summary: Delete Model - description: Delete a model. + summary: Delete model + description: | + + + Delete a model. parameters: - in: path name: model @@ -122,7 +138,10 @@ paths: schema: type: string example: zephyr-7b - description: The model to delete + description: | + The model to delete + + OpenAI compatible responses: "200": description: OK @@ -139,8 +158,11 @@ paths: operationId: startModel tags: - Models - summary: Start Model - description: Starts an imported model. Loads the model into V/RAM. + summary: Start model + description: | + Jan + + Starts an imported model. Loads the model into V/RAM. parameters: - in: path name: model @@ -149,7 +171,8 @@ paths: type: string # ideally this will be an actual ID, so this will always work from browser example: zephyr-7b - description: The ID of the model to use for this request + description: | + The ID of the model to use for this request responses: "200": description: OK @@ -166,8 +189,11 @@ paths: operationId: stopModel tags: - Models - summary: Stop Model - description: Stop an imported model. + summary: Stop model + description: | + Jan + + Stop an imported model. parameters: - in: path name: model @@ -437,7 +463,7 @@ paths: operationId: listMessages tags: - Messages - summary: List messaages + summary: List messages description: Retrieves all messages from the given thread. parameters: - in: path @@ -564,7 +590,7 @@ paths: 'read:pets': read your pets description: | - + Returns a list of message files. @@ -588,7 +614,7 @@ paths: description: | The ID of the message whose files are to be listed. - Open.AI Compatible + OpenAI compatible responses: "200": description: List of files retrieved successfully @@ -648,7 +674,12 @@ x-webhooks: ModelObject: post: summary: The model object - description: Information about a model in the systems + description: | + + + Describe a model offering that can be used with the API. + + operationId: ModelObject tags: - Models diff --git a/docs/openapi/specs/models.yaml b/docs/openapi/specs/models.yaml index 6f136d30e3..b4a5937b91 100644 --- a/docs/openapi/specs/models.yaml +++ b/docs/openapi/specs/models.yaml @@ -117,26 +117,33 @@ components: properties: id: type: string - description: "The identifier of the model." + description: | + "The identifier of the model." + + OpenAI compatible example: "zephyr-7b" object: type: string - description: "The type of the object, indicating it's a model." + description: | + "The type of the object, indicating it's a model." + + OpenAI compatible default: "model" created: type: integer format: int64 - description: "Unix timestamp representing the creation time of the model." + description: | + "Unix timestamp representing the creation time of the model." + + OpenAI compatible example: "1253935178" owned_by: type: string - description: "The entity that owns the model." + description: | + "The entity that owns the model." + + OpenAI compatible example: "_" - required: - - id - - object - - created - - owned_by GetModelResponse: type: object @@ -253,10 +260,7 @@ components: type: boolean description: "Indicates whether the model was successfully deleted." example: true - required: - - id - - object - - deleted + StartModelResponse: type: object @@ -313,8 +317,4 @@ components: type: string description: "The current state of the model after the start operation." example: "downloaded" - required: - - id - - object - - state