From 1b346e01397dc34e0432cc03681e0158074e3ed4 Mon Sep 17 00:00:00 2001
From: Krrish Dholakia <krrishdholakia@gmail.com>
Date: Wed, 13 Sep 2023 18:15:27 -0700
Subject: [PATCH] update docs

---
 docs/my-website/docs/set_keys.md | 35 ++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/docs/my-website/docs/set_keys.md b/docs/my-website/docs/set_keys.md
index e70196511df..f5a39aabfcc 100644
--- a/docs/my-website/docs/set_keys.md
+++ b/docs/my-website/docs/set_keys.md
@@ -6,6 +6,10 @@ LiteLLM allows you to specify the following:
 * API Version
 * API Type
 
+Useful Helper functions: 
+* [`check_valid_key()`](#check_valid_key)
+* [`get_valid_models()`](#get_valid_models)
+
 You can set the API configs using:
 * Environment Variables
 * litellm variables `litellm.api_key`
@@ -114,3 +118,34 @@ messages = [{ "content": "Hello, how are you?","role": "user"}]
 response = completion("command-nightly", messages, api_version="2023-02-15")
 ```
 
+## Helper Functions
+
+### `check_valid_key()`
+
+Check if a user submitted a valid key for the model they're trying to call. 
+
+```
+key = "bad-key"
+response = check_valid_key(model="gpt-3.5-turbo", api_key=key)
+assert(response == False)
+```
+
+### `get_valid_models()`
+
+This helper reads the .env and returns a list of supported llms for user
+
+```
+old_environ = os.environ
+os.environ = {'OPENAI_API_KEY': 'temp'} # mock set only openai key in environ
+
+valid_models = get_valid_models()
+print(valid_models)
+
+# list of openai supported llms on litellm
+expected_models = litellm.open_ai_chat_completion_models + litellm.open_ai_text_completion_models
+
+assert(valid_models == expected_models)
+
+# reset replicate env key
+os.environ = old_environ
+```
\ No newline at end of file