update docs
This commit is contained in:
parent
c240bd7026
commit
e8a4c814af
1 changed files with 44 additions and 2 deletions
|
@ -556,9 +556,51 @@ Run with bash:
|
|||
bash chat.sh
|
||||
```
|
||||
|
||||
### API like OAI
|
||||
### API like OpenAI
|
||||
|
||||
The HTTP server supports OAI-like API
|
||||
The HTTP server supports OpenAI-like API
|
||||
|
||||
### API errors
|
||||
|
||||
Server returns error in the same format as OpenAI API: https://platform.openai.com/docs/guides/error-codes/api-errors
|
||||
|
||||
Example of an error:
|
||||
|
||||
```json
|
||||
{
|
||||
"error": {
|
||||
"code": 401,
|
||||
"message": "Invalid API Key",
|
||||
"type": "authentication_error"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Apart from error types supported by OpenAI, we also have custom types that are specific to functionalities of llama.cpp:
|
||||
|
||||
**When /metrics or /slots endpoint is disabled**
|
||||
|
||||
```json
|
||||
{
|
||||
"error": {
|
||||
"code": 501,
|
||||
"message": "This server does not support metrics endpoint.",
|
||||
"type": "not_supported_error"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**When the server receives invalid grammar via */completions endpoint**
|
||||
|
||||
```json
|
||||
{
|
||||
"error": {
|
||||
"code": 400,
|
||||
"message": "Failed to parse grammar",
|
||||
"type": "invalid_request_error"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Extending or building alternative Web Front End
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue