From 918354f4a43898bad54137606ee5005277c72f35 Mon Sep 17 00:00:00 2001
From: Moutasem Akkad <39648266+moutasemalakkad@users.noreply.github.com>
Date: Fri, 21 Jun 2024 15:35:32 -0700
Subject: [PATCH] added openai api prereq credits to prevent limit rate error
 (#136)

* added openai api prereq credits to prevent limit rate error

* added the bulk of openai usage to the bottom of the readme doc

* added to index.md
---
 README.md     | 13 +++++++++++++
 docs/index.md | 13 +++++++++++++
 2 files changed, 26 insertions(+)

diff --git a/README.md b/README.md
index 4e0eefba..b0248d6c 100644
--- a/README.md
+++ b/README.md
@@ -40,6 +40,9 @@ using Azure OpenAI please see the Azure setup section):
 export OPENAI_API_KEY="your-api-key"
 ```
 
+### Important Note on API Usage
+Please be aware that using the API in this project requires you to have API credits (minimum of five US dollars). This is different from the OpenAI subscription used in this chatbot. If you don't have credit, further information can be found [here](https://github.com/moutasemalakkad/vision-agent/blob/57e50b59e39fde7d943d534a8bf83c5ff6281562/README.md#L215-L216)
+
 ### Vision Agent
 #### Basic Usage
 You can interact with the agent as you would with any LLM or LMM model:
@@ -208,3 +211,13 @@ You can then run Vision Agent using the Azure OpenAI models:
 import vision_agent as va
 agent = va.agent.AzureVisionAgent()
 ```
+******************************************************************************************************************************
+#### To get started with API credits:
+
+1. Visit the[OpenAI API platform](https://beta.openai.com/signup/) to sign up for an API key.
+2. Follow the instructions to purchase and manage your API credits.
+3. Ensure your API key is correctly configured in your project settings.
+
+Failure to have sufficient API credits may result in limited or no functionality for the features that rely on the OpenAI API.
+
+For more details on managing your API usage and credits, please refer to the OpenAI API documentation.
diff --git a/docs/index.md b/docs/index.md
index 34875b57..364b5182 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -32,6 +32,9 @@ using Azure OpenAI please see the Azure setup section):
 export OPENAI_API_KEY="your-api-key"
 ```
 
+### Important Note on API Usage
+Please be aware that using the API in this project requires you to have API credits (minimum of five US dollars). This is different from the OpenAI subscription used in this chatbot. If you don't have credit, further information can be found [here](https://github.com/moutasemalakkad/vision-agent/blob/f491252f3477103b7f517c45e6dea2f9d9f7abc4/docs/index.md#L207)
+
 ### Vision Agent
 #### Basic Usage
 You can interact with the agent as you would with any LLM or LMM model:
@@ -200,3 +203,13 @@ You can then run Vision Agent using the Azure OpenAI models:
 import vision_agent as va
 agent = va.agent.AzureVisionAgent()
 ```
+******************************************************************************************************************************
+#### To get started with API credits:
+
+1. Visit the[OpenAI API platform](https://beta.openai.com/signup/) to sign up for an API key.
+2. Follow the instructions to purchase and manage your API credits.
+3. Ensure your API key is correctly configured in your project settings.
+
+Failure to have sufficient API credits may result in limited or no functionality for the features that rely on the OpenAI API.
+
+For more details on managing your API usage and credits, please refer to the OpenAI API documentation.