From 4e3700debd59b090d8e6a89e2eb66dd8629c89d4 Mon Sep 17 00:00:00 2001
From: Shivani Modi <shivanimodi16@gmail.com>
Date: Fri, 2 Feb 2024 19:31:59 -0800
Subject: [PATCH] doc: Updating konko jupyter notebook documentation (#10424)
Updating konko doc
Co-authored-by: Shivani Modi <shivanimodi@Shivanis-MacBook-Pro.local>
---
docs/examples/llm/konko.ipynb | 34 ++++++++++++++++++++--------------
1 file changed, 20 insertions(+), 14 deletions(-)
diff --git a/docs/examples/llm/konko.ipynb b/docs/examples/llm/konko.ipynb
index 69fca130cc..cf61f0d2b8 100644
--- a/docs/examples/llm/konko.ipynb
+++ b/docs/examples/llm/konko.ipynb
@@ -25,27 +25,33 @@
"source": [
"If you're opening this Notebook on colab, you will probably need to install LlamaIndex 🦙.\n",
"\n",
- ">[Konko](https://www.konko.ai/) API is a fully managed Web API designed to help application developers:\n",
+ "All functionality related to Konko\n",
"\n",
- "Konko API is a fully managed API designed to help application developers:\n",
+ ">[Konko AI](https://www.konko.ai/) provides a fully managed API to help application developers\n",
"\n",
- "1. Select the right LLM(s) for their application\n",
- "2. Prototype with various open-source and proprietary LLMs\n",
- "3. Access Fine Tuning for open-source LLMs to get industry-leading performance at a fraction of the cost\n",
- "4. Setup low-cost production APIs according to security, privacy, throughput, latency SLAs without infrastructure set-up or administration using Konko AI's SOC 2 compliant, multi-cloud infrastructure\n",
+ ">1. **Select** the right open source or proprietary LLMs for their application\n",
+ ">2. **Build** applications faster with integrations to leading application frameworks and fully managed APIs\n",
+ ">3. **Fine tune** smaller open-source LLMs to achieve industry-leading performance at a fraction of the cost\n",
+ ">4. **Deploy production-scale APIs** that meet security, privacy, throughput, and latency SLAs without infrastructure set-up or administration using Konko AI's SOC 2 compliant, multi-cloud infrastructure\n",
"\n",
- "### Steps to Access Models\n",
- "1. **Explore Available Models:** Start by browsing through the [available models](https://docs.konko.ai/docs/list-of-models) on Konko. Each model caters to different use cases and capabilities.\n",
+ "## Installation and Setup\n",
"\n",
- "2. **Identify Suitable Endpoints:** Determine which [endpoint](https://docs.konko.ai/docs/list-of-models#list-of-available-models) (ChatCompletion or Completion) supports your selected model.\n",
+ "1. Sign in to our web app to [create an API key](https://platform.konko.ai/settings/api-keys) to access models via our endpoints for [chat completions](https://docs.konko.ai/reference/post-chat-completions) and [completions](https://docs.konko.ai/reference/post-completions).\n",
+ "2. Enable a Python3.8+ environment\n",
+ "3. Install the SDK\n",
"\n",
- "3. **Selecting a Model:** [Choose a model](https://docs.konko.ai/docs/list-of-models#list-of-available-models) based on its metadata and how well it fits your use case.\n",
+ "```bash\n",
+ "pip install konko\n",
+ "```\n",
"\n",
- "4. **Prompting Guidelines:** Once a model is selected, refer to the [prompting guidelines](https://docs.konko.ai/docs/prompting) to effectively communicate with it.\n",
+ "4. Set API Keys as environment variables(`KONKO_API_KEY`,`OPENAI_API_KEY`)\n",
"\n",
- "5. **Using the API:** Finally, use the appropriate Konko [API endpoint](https://docs.konko.ai/docs/quickstart-for-completion-and-chat-completion-endpoint) to call the model and receive responses.\n",
+ "```bash\n",
+ "export KONKO_API_KEY={your_KONKO_API_KEY_here}\n",
+ "export OPENAI_API_KEY={your_OPENAI_API_KEY_here} #Optional\n",
+ "```\n",
"\n",
- "To run this notebook, you'll need Konko API key. You can create one by signing up on [Konko](https://www.konko.ai/).\n",
+ "Please see [the Konko docs](https://docs.konko.ai/docs/getting-started) for more details.\n",
"\n",
"This example goes over how to use LlamaIndex to interact with `Konko` ChatCompletion [models](https://docs.konko.ai/docs/list-of-models#konko-hosted-models-for-chatcompletion) and Completion [models](https://docs.konko.ai/docs/list-of-models#konko-hosted-models-for-completion)\n",
"\n"
@@ -127,7 +133,7 @@
"metadata": {},
"source": [
"## Call `chat` with OpenAI Models\n",
- "You need to either set env var `OPENAI_API_KEY`"
+ "You need to set env var `OPENAI_API_KEY`"
]
},
{
--
GitLab