phoenix/litellm-mirror
0
0
Fork 1
mirror of https://github.com/BerriAI/litellm.git synced 2025-04-26 19:24:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs - update /health docs to show correct info

Browse source
This commit is contained in:
Ishaan Jaff 2024-09-02 08:54:14 -07:00
parent 6375affeea
commit 5c0480114e
1 changed files with 13 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/my-website/docs/proxy/health.md
View file

@ -10,7 +10,12 @@ The proxy exposes:
## `/health` ## `/health`
#### Request #### Request
Make a GET Request to `/health` on the proxy Make a GET Request to `/health` on the proxy
:::info
**This endpoint makes an LLM API call to each model to check if it is healthy.**
:::
```shell ```shell
curl --location 'http://0.0.0.0:4000/health' -H "Authorization: Bearer sk-1234" curl --location 'http://0.0.0.0:4000/health' -H "Authorization: Bearer sk-1234"
``` ```
@ -150,7 +155,13 @@ Expected Response
## Background Health Checks ## Background Health Checks
You can enable model health checks being run in the background, to prevent each model from being queried too frequently via `/health`. You can enable model health checks being run in the background, to prevent each model from being queried too frequently via `/health`.
:::info
**This makes an LLM API call to each model to check if it is healthy.**
:::
Here's how to use it: Here's how to use it:
1. in the config.yaml add: 1. in the config.yaml add: