From 5c0480114ebb3b4457768c16c70a875b64b95ea4 Mon Sep 17 00:00:00 2001 From: Ishaan Jaff Date: Mon, 2 Sep 2024 08:54:14 -0700 Subject: [PATCH] docs - update /health docs to show correct info --- docs/my-website/docs/proxy/health.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/my-website/docs/proxy/health.md b/docs/my-website/docs/proxy/health.md index 35dced84c9..334c32cfd2 100644 --- a/docs/my-website/docs/proxy/health.md +++ b/docs/my-website/docs/proxy/health.md @@ -10,7 +10,12 @@ The proxy exposes: ## `/health` #### 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 curl --location 'http://0.0.0.0:4000/health' -H "Authorization: Bearer sk-1234" ``` @@ -150,7 +155,13 @@ Expected Response ## 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: 1. in the config.yaml add: