update docs

huggingface · Jul 15, 2024 · 9e22816 · 9e22816
1 parent 53ad84d
commit 9e22816
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 146 deletions.
diff --git a/docs/openapi.json b/docs/openapi.json
@@ -492,12 +492,12 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/CompletionFinal"
+                  "$ref": "#/components/schemas/Completion"
                 }
               },
               "text/event-stream": {
                 "schema": {
-                  "$ref": "#/components/schemas/Chunk"
+                  "$ref": "#/components/schemas/CompletionCompleteChunk"
                 }
               }
             }
@@ -809,6 +809,7 @@
       "ChatRequest": {
         "type": "object",
         "required": [
+          "model",
           "messages"
         ],
         "properties": {
@@ -853,8 +854,7 @@
           "model": {
             "type": "string",
             "description": "[UNUSED] ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.",
-            "example": "mistralai/Mistral-7B-Instruct-v0.2",
-            "nullable": true
+            "example": "mistralai/Mistral-7B-Instruct-v0.2"
           },
           "n": {
             "type": "integer",
@@ -1116,6 +1116,7 @@
       "CompletionRequest": {
         "type": "object",
         "required": [
+          "model",
           "prompt"
         ],
         "properties": {
@@ -1137,8 +1138,7 @@
           "model": {
             "type": "string",
             "description": "UNUSED\nID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.",
-            "example": "mistralai/Mistral-7B-Instruct-v0.2",
-            "nullable": true
+            "example": "mistralai/Mistral-7B-Instruct-v0.2"
           },
           "prompt": {
             "$ref": "#/components/schemas/Prompt"
@@ -1324,17 +1324,6 @@
           }
         }
       },
-      "FunctionName": {
-        "type": "object",
-        "required": [
-          "name"
-        ],
-        "properties": {
-          "name": {
-            "type": "string"
-          }
-        }
-      },
       "GenerateParameters": {
         "type": "object",
         "properties": {
@@ -1719,72 +1708,6 @@
           }
         }
       },
-      "MessageChunk": {
-        "oneOf": [
-          {
-            "type": "object",
-            "required": [
-              "text",
-              "type"
-            ],
-            "properties": {
-              "text": {
-                "type": "string"
-              },
-              "type": {
-                "type": "string",
-                "enum": [
-                  "text"
-                ]
-              }
-            }
-          },
-          {
-            "type": "object",
-            "required": [
-              "image_url",
-              "type"
-            ],
-            "properties": {
-              "image_url": {
-                "$ref": "#/components/schemas/Url"
-              },
-              "type": {
-                "type": "string",
-                "enum": [
-                  "image_url"
-                ]
-              }
-            }
-          }
-        ],
-        "discriminator": {
-          "propertyName": "type"
-        }
-      },
-      "MessageContent": {
-        "oneOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/MessageChunk"
-            }
-          }
-        ]
-      },
-      "OutputMessage": {
-        "oneOf": [
-          {
-            "$ref": "#/components/schemas/TextMessage"
-          },
-          {
-            "$ref": "#/components/schemas/ToolCallMessage"
-          }
-        ]
-      },
       "PrefillToken": {
         "type": "object",
         "required": [
@@ -1911,23 +1834,6 @@
           }
         }
       },
-      "TextMessage": {
-        "type": "object",
-        "required": [
-          "role",
-          "content"
-        ],
-        "properties": {
-          "content": {
-            "type": "string",
-            "example": "My name is David and I"
-          },
-          "role": {
-            "type": "string",
-            "example": "user"
-          }
-        }
-      },
       "Token": {
         "type": "object",
         "required": [
@@ -2000,41 +1906,6 @@
           }
         }
       },
-      "ToolCallDelta": {
-        "type": "object",
-        "required": [
-          "role",
-          "tool_calls"
-        ],
-        "properties": {
-          "role": {
-            "type": "string",
-            "example": "assistant"
-          },
-          "tool_calls": {
-            "$ref": "#/components/schemas/DeltaToolCall"
-          }
-        }
-      },
-      "ToolCallMessage": {
-        "type": "object",
-        "required": [
-          "role",
-          "tool_calls"
-        ],
-        "properties": {
-          "role": {
-            "type": "string",
-            "example": "assistant"
-          },
-          "tool_calls": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/ToolCall"
-            }
-          }
-        }
-      },
       "ToolType": {
         "oneOf": [
           {
@@ -2058,17 +1929,6 @@
           }
         ]
       },
-      "Url": {
-        "type": "object",
-        "required": [
-          "url"
-        ],
-        "properties": {
-          "url": {
-            "type": "string"
-          }
-        }
-      },
       "Usage": {
         "type": "object",
         "required": [

diff --git a/docs/source/basic_tutorials/launcher.md b/docs/source/basic_tutorials/launcher.md
@@ -424,6 +424,22 @@ Options:
           
           [env: LORA_ADAPTERS=]
 
+```
+## DISABLE_USAGE_STATS
+```shell
+      --disable-usage-stats
+          Disable sending of all usage statistics
+          
+          [env: DISABLE_USAGE_STATS=]
+
+```
+## DISABLE_CRASH_REPORTS
+```shell
+      --disable-crash-reports
+          Disable sending of crash reports, but allow anonymous usage statistics
+          
+          [env: DISABLE_CRASH_REPORTS=]
+
 ```
 ## HELP
 ```shell