diff --git a/docs/api/aider.md b/docs/api/aider.md index 8f71002..506266a 100644 --- a/docs/api/aider.md +++ b/docs/api/aider.md @@ -1,11 +1,15 @@ # Aider -You can follow these instructions to use your AI-VERDE API Key after Aider, self-described "AI pair programming in your terminal". More information on installing and using Aider can be found here, https://aider.chat. +You can follow these instructions to use your AI-VERDE API Key after Aider, self-described "AI pair programming in your terminal". More information on installing and using Aider can be found here, [Aider website](https://aider.chat). ## Prerequisites -1. Obtain your AI-VERDE API Key. Instructions can be found here, https://aiverde-docs.cyverse.ai/api/api-token/. -2. Note the model(s) you want to configure for Claude Code. Instructions can be found here, https://aiverde-docs.cyverse.ai/api/api-key-models/. -3. Install Aider. Instructions can be found here, https://aider.chat/#getting-started. -4. The remaining instructions assume you have an open terminal on a Linux system with Aider. +1. **AI-VERDE API Key** + - Obtain your key by following the [API Token guide](https://aiverde-docs.cyverse.ai/api/api-token/). +2. **Model Information** + - Identify the model(s) you plan to use by reviewing the [AI-VERDE Model Documentation](https://aiverde-docs.cyverse.ai/api/api-key-models/). +3. **Install Aider** + - Follow the official [Aider installation instructions](https://aider.chat/#getting-started/). +4. **Terminal Access** + - These instructions assume you have a terminal open on a Linux system with Aider installed. ## 1. Configuring Aider @@ -16,10 +20,13 @@ openai-api-base: https://llm-api.cyverse.ai/v1 model: openai/insert-default-model ``` 2. Replace `insert-your-aiverde-api-key` with AI-VERDE API Key. -3. Replace the text `insert-default-model` with the AI-VERDE model. For example, to use `phi4`, the model field would be set to `openai/phi4` or if you were using `nrp/phi4` model, the model field would be set to `openai/nrp/phi4`. +3. Replace the text `insert-default-model` with the AI-VERDE model. + Example how the model feild would be set: + - For the phi4 model → model: openai/phi4 + - For the nrp/phi4 model → model: openai/nrp/phi4 !!! Note - This is the minimal configuration needed to use Aider. If you want to set other configuration for any models, you add a `$HOME/.aider.model.metadata.json` file. Instructions on the configuration values that can be set in this file can be found here, https://aider.chat/docs/config/adv-model-settings.html. + This is the minimal configuration needed to connect Aider. If you want to set other configuration for any models, you add a `$HOME/.aider.model.metadata.json` file. Instructions on the configuration values that can be set in this file can be found at [aider model settings](https://aider.chat/docs/config/adv-model-settings.html). ## 2. Running Aider Run Aider with the following command: @@ -31,5 +38,4 @@ aider !!! Note You may get additional prompts if you're not in a git repo and if you have not configured your model further (see note above). You can also run aider with `aider --no-show-model-warnings` if you prefer to ignore model warnings -If you are successful entering Aider, congratulations! - +If you are successful entering Aider, congratulations! \ No newline at end of file diff --git a/docs/api/api-key-claude.md b/docs/api/api-key-claude.md index 876a7d5..e91a90f 100644 --- a/docs/api/api-key-claude.md +++ b/docs/api/api-key-claude.md @@ -1,17 +1,19 @@ # Claude Code (using Anthropic Models) -You can follow these instructions to use your VERDE API Key after installing Claude Code. More information on using Claude Code can be found here, https://docs.anthropic.com/en/docs/intro. +This guide explains how to connect Claude Code with your AI-VERDE API Key to access Anthropic models through CyVerse. + +Follow the steps below after installing Claude Code to configure your connection. For more details on Claude Code features and usage, visit the [Anthropic documentation](https://docs.anthropic.com/en/docs/intro). !!! Note - These instructions assume you are using a space that is connected to Anthropic models. If you need access to Claude Code using a non-Anthropic model, then use the instructions for Claude Code Router. + Use this setup if your workspace supports **Anthropic LLMs** (like Claude 3 Sonnet or Opus). If your workspace uses **non-Anthropic models** (such as OpenAI, Gemini, or other providers), follow the [Claude Code Router setup](claude-code-router.md). ## Prerequisites -1. Your VERDE course or team must be configured to use Anthropic models (see instructor or team lead) -2. Obtain your VERDE API Key. [Instructions can be found here](api-token.md) -3. Install Claude Code. Instructions can be found here, https://www.anthropic.com/claude-code/ -4. The remaining instructions assume you have an open terminal on system with Claude Code and bash installed. +1. Your VERDE course or team must be configured to use Anthropic models (see instructor or team lead) +2. Obtain your VERDE API Key follow the [AI-VERDE API Token Guide](api-token.md) +3. Install Claude Code. Instructions can be found here, [Anthropic’s website](https://www.anthropic.com/claude-code/). +4. A terminal (bash) open on a system where Claude Code is installed. ## 1. Setting up the necessary environment variables @@ -23,11 +25,12 @@ export ANTHROPIC_BASE_URL="https://llm-api.cyverse.ai" export ANTHROPIC_API_KEY="insert-VERDE-API-Key-here" export ANTHROPIC_MODEL="anthropic/claude-sonnet-4" ``` -Note, the `ANTHROPIC_MODEL` can be set to any available Anthropic model. Information about available models can be found here, https://docs.anthropic.com/en/docs/about-claude/models/overview -## 2. Start Claude Code +Note, the `ANTHROPIC_MODEL` can be set to any available Anthropic model. Information about available models can be found here, [Anthropic documentation](https://docs.anthropic.com/en/docs/about-claude/models/overview). + +## 2. Launch Claude Code -You can then run Claude Code. +After setting your environment variables, start Claude Code by entering: ``` claude ``` diff --git a/docs/api/api-key-models.md b/docs/api/api-key-models.md index 017ba73..95c34af 100644 --- a/docs/api/api-key-models.md +++ b/docs/api/api-key-models.md @@ -1,37 +1,58 @@ # Getting a List of Models -There are three ways to obtain a list models: +This page explains how to find which AI models are available to you in **AI-VERDE**. +You can view your models directly in the application or through a simple command-line request using your API Key. -1. Go to [this page](../models-current.md) to view the list of CyVerse models. This list does not include models from external inference services e.g., Jetstream2. -2. Viewing your models in the Course Details -3. Using your API Key to view your models +## Ways to View Available Models -## Viewing your models in the Course Details +1. **From the Models Page** – Visit [this page](../models-current.md) to see the list of CyVerse models. + > *Note:* This list only includes CyVerse-hosted models. External models (e.g., Jetstream2) are not shown. -Your available models will be visible in the AI-VERDE application. These are the steps: +2. **From Your Course Details** – View your available models directly in your AI-VERDE course. -1. Go to https://chat.cyverse.ai -2. After successfully logging in, click on the Details button of your course -3. Click on the "API Key" tab -4. The "Available Models" section will list all the models your course has access to +3. **Using Your API Key** – Retrieve a detailed list of models through the command line. -## Using your API Key to view your models -After obtaining your API Key from your course/team, you can obtain a detailed list of available models using curl: +## Viewing Models in the Course Details -``` -curl -s -L "https://llm-api.cyverse.ai/v1/models" -H "Authorization: Bearer $OPENAI_API_KEY" -H 'Content-Type: application/json' -``` +1. Go to [https://chat.cyverse.ai](https://chat.cyverse.ai) +2. Log in with your CyVerse credentials +3. Click "Details" on your course +4. Select the "API Key" tab +5. The "Available Models" section will display all models your course can access -Alternatively, you can use `jq` or python's json module to view the output in a more human readable format. -Option 1: If you have `jq` installed: -``` -curl -s -L "https://llm-api.cyverse.ai/v1/models" -H "Authorization: Bearer $OPENAI_API_KEY" -H 'Content-Type: application/json'|jq -``` +## Viewing Models Using Your API Key -Option 2: If you have python's json module installed: +After obtaining your "API Key" from your course or team, you can run the following command in your terminal to request a list of all models available to you. +This command uses `curl` to securely connect to the CyVerse API and return your model list in JSON format: + +```bash +curl -s -L "https://llm-api.cyverse.ai/v1/models" \ +-H "Authorization: Bearer $OPENAI_API_KEY" \ +-H 'Content-Type: application/json' ``` -curl -s -L "https://llm-api.cyverse.ai/v1/models" -H "Authorization: Bearer $OPENAI_API_KEY" |python -m json.tool + + +The response from the API is returned in JSON format, which can appear as a single long block of text. To make it easier to read, you can format the output using tools like `jq` or Python’s built-in `json` module. + + +**Option 1: Using `jq`** + +If you have the `jq` command-line tool installed, it will organize the JSON output into a clean, readable structure: + +```bash +curl -s -L "https://llm-api.cyverse.ai/v1/models" \ +-H "Authorization: Bearer $OPENAI_API_KEY" \ +-H 'Content-Type: application/json' | jq ``` +**Option 2: Using Python’s Built-in JSON Module** + +If you have Python installed, you can use its built-in JSON parser to format the output neatly: + +```bash +curl -s -L "https://llm-api.cyverse.ai/v1/models" \ +-H "Authorization: Bearer $OPENAI_API_KEY" \ +| python -m json.tool +``` \ No newline at end of file diff --git a/docs/api/api-token-continue.md b/docs/api/api-token-continue.md new file mode 100644 index 0000000..ea08abe --- /dev/null +++ b/docs/api/api-token-continue.md @@ -0,0 +1,81 @@ +# Using AI-VERDE with Continue.dev (VS Code Extension) + +Continue.dev is an open-source coding assistant for Visual Studio Code that provides inline AI help for code completion, refactoring, and documentation. By connecting it to AI-VERDE, you can securely use CyVerse-hosted and course-approved models without exposing your code to external services. + + +## Prerequisites + +Before getting started, make sure you have: + +1. **AI-VERDE API Key** + - Obtain your key by following the [AI-VERDE API Token Guide](../api/api-token.md). + +2. **Model Information** + - View available models and their names in the [AI-VERDE Model Documentation](../api/api-key-models.md). + +3. **Visual Studio Code Installed** + - Download and install VS Code from the [VS Code website](https://code.visualstudio.com/). + +4. **Continue.dev Extension Installed** + - In VS Code, open the Extensions tab (`Ctrl+Shift+X` or `Cmd+Shift+X`), search for “Continue”, and click Install. + - For more details, visit the [Continue.dev website](https://continue.dev/). + + +## 1. Sign In and Access Continue + +1. Open Visual Studio Code. +2. In the sidebar, click on the Continue icon to open the panel. +3. If prompted, sign in with your Continue account (you can use GitHub, Google, or create a free account). +4. Once signed in, you’ll see the Continue chat interface and a Model tab. + + +## 2. Add AI-VERDE as a Model Provider + +You can connect your AI-VERDE API Key directly from the [Continue.dev website](https://continue.dev/). + +1. In the Continue sidebar, click the Model tab. +2. Scroll down to the bottom and click “Create Model”. +3. In the popup, use this as an example: + +```bash + name: AI-Verde +version: 1.0.0 +schema: v1 + +models: + - name: AI-Verde GPT-4o-mini + provider: openai + model: litellm_proxy/[MODEL NAME] + apiBase: https://llm-api.cyverse.ai/v1 #add this + apiKey: ${{ inputs.[AI-VERDE API KEY] }} + roles: + - chat +``` + +1. Click "Save". +2. Your new AI-VERDE model will appear in the model list in VS Code extenstion. + +> **Tip:** You can add multiple AI-VERDE models if your course provides access to different ones. For example, a general model and a coding-focused model. + + +## 3. (Optional) Configure via JSON File + +You can also edit the Continue configuration file manually for advanced customization. + +1. Open the Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`). +2. Type “Continue: Open Config File” and press "Enter". +3. Add or replace your configuration with the example below: + +```json +{ + "models": [ + { + "title": "AI-VERDE GPT-4o-mini", + "model": "litellm_proxy/[MODEL NAME]", + "provider": "openai", + "apiBase": "https://llm-api.cyverse.ai/v1", + "apiKey": "[AI_VERDE_API_KEY]" + } + ] +} +``` \ No newline at end of file diff --git a/docs/api/api-token-gradio.md b/docs/api/api-token-gradio.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/api/api-token-jupyter.md b/docs/api/api-token-jupyter.md index 9a5fc3c..b537384 100644 --- a/docs/api/api-token-jupyter.md +++ b/docs/api/api-token-jupyter.md @@ -1 +1,79 @@ -# Examples of using your AI-VERDE API Token in Jupyter \ No newline at end of file +# Examples of using your AI-VERDE API Token in Jupyter +This guide explains how to set up and use your AI-VERDE API Key inside Jupyter Notebook Once configured, you can send prompts, run code, and receive AI responses directly within your notebook. + +## Prerequisites + +1. **AI-VERDE API Key** + - Obtain your key by following the [AI-VERDE API Token Guide](https://aiverde-docs.cyverse.ai/api/api-token/). + +2. **Model Information** + - View available models and their names in the [AI-VERDE Model Documentation](../api/api-key-models.md). + +3. **Jupyter Installed** + - For intstalling Jupyter, visit [Jupyter Installation Website](https://jupyter.org/install). + +## 1. Open Jupyter Notebook + +After installing Jupyter, start it by running this command in your terminal: +```bash +jupyter notebook +``` + +## Add Your AI-VERDE API KEY + +**Option 1** — Save It to Your System +This keeps your key private and reusable. + +```bash +export AIVERDE_API_KEY="your_api_key_here" +``` + +**Option 2** — Enter It Inside the Notebook +If you prefer to enter it manually each time, use this in a new cell: + +```bash +import os, getpass + +if not os.getenv("AIVERDE_API_KEY"): + os.environ["AIVERDE_API_KEY"] = getpass.getpass("Enter your AI-VERDE API Key: ") +``` +## Test the Connection +Now, let’s make sure your API key works. If everything works, you’ll see a list of available models. +```bash +import os, requests, json + +API_URL = "https://llm-api.cyverse.ai/v1/models" +api_key = os.getenv("AIVERDE_API_KEY") + +headers = {"Authorization": f"Bearer {api_key}"} +response = requests.get(API_URL, headers=headers) + +print("Status Code:", response.status_code) +print(json.dumps(response.json(), indent=2)) +``` + +## Send a Test Prompt to AI-VERDE +Use one of your models to send a message and enter your model ID + +```bash +import os, requests, json + +API_URL = "https://llm-api.cyverse.ai/v1/" +api_key = os.getenv("AIVERDE_API_KEY") + +headers = { + "Authorization": f"Bearer {api_key}", + "Content-Type": "application/json" +} +data = { + "model": "litellm_proxy/[MODEL NAME]", # Replace with your model ID + "messages": [ + {"role": "user", "content": "Hello AI-VERDE! What can you do?"} + ] +} +response = requests.post(API_URL, headers=headers, json=data) +result = response.json() + +# Display the model's response +print(result["choices"][0]["message"]["content"]) +``` \ No newline at end of file diff --git a/docs/api/api-token-langchain.md b/docs/api/api-token-langchain.md index a1a35b3..ec34ef1 100644 --- a/docs/api/api-token-langchain.md +++ b/docs/api/api-token-langchain.md @@ -1,20 +1,32 @@ # Using your AI-VERDE API key to integrate with LangChain -## 1. Install LangChain python libraries -```bash -pip install langchain_community +## 1. Install LangChain Python Libraries + +To begin integrating AI-VERDE with LangChain, install the required Python package: + +```bash +pip install langchain_community ``` ## 2. Obtain variables to integrate AI-VERDE with LangChain -Obtaining your AI-VERDE API key is outlined [here](/api/api-token/). +You will need your AI-VERDE API Key to connect LangChain to the CyVerse API. +**AI-VERDE API Key and API URL** + - Obtain your credentials by following the [AI-VERDE API Token Guide](api-token.md). -You can obtain a list of the models you have access to with the following command; denoted by "id": +Once you have your key, you can view the models you have access to (identified by their `id`) with the following command: ```bash -curl -s -L "https://llm-api.cyverse.ai/v1/models" -H "Authorization: Bearer [AI-VERDE API KEY]" -H 'Content-Type: application/json'|jq +curl -s -L "https://llm-api.cyverse.ai/v1/models" \ +-H "Authorization: Bearer [AI-VERDE API KEY]" \ +-H 'Content-Type: application/json' | jq ``` ## 3. Create python scripts +You can now connect AI-VERDE to LangChain using the following Python example. +Before running the script, make sure to: +- Replace `[MODEL NAME]` with one of your available model IDs. +- Replace `[AI-VERDE API KEY]` with your personal API key + ```python from langchain_community.chat_models import ChatLiteLLM @@ -27,7 +39,7 @@ print (llm.invoke("Hello, world!")) ``` -Alternatively, you can include the API key as an environment variable or secret to avoid storing it in plain text: +To keep your API key secure, you can store it as an `environment variable` instead of typing it directly into your script. This ensures your credentials remain private if you share or upload your code. ```python import getpass diff --git a/docs/api/api-token-llamaindex.md b/docs/api/api-token-llamaindex.md index 788cb45..be70dfd 100644 --- a/docs/api/api-token-llamaindex.md +++ b/docs/api/api-token-llamaindex.md @@ -1,21 +1,34 @@ # Using your AI-VERDE API key to integrate with LlamaIndex ## 1. Install LlamaIndex libraries +Install the required Python packages for LlamaIndex and LiteLLM integration: ```bash pip install llama-index-core llama-index-llms-litellm ``` ## 2. Obtain variables to integrate AI-VERDE with LangChain -Obtaining your AI-VERDE API key is outlined [here](/api/api-token.md). +You’ll need your AI-VERDE API key and model ID to connect to the API. Instructions for obtaining them are available here: +**AI-VERDE API Key and API URL** + - Obtain your credentials by following the [AI-VERDE API Token Guide](api-token.md). -You can obtain a list of the models you have access to with the following command; denoted by "id": +**Model Information** + - Review the models you plan to use in the [AI-VERDE Model Documentation](api-key-models.md). + +Once you have your key, you can view the models you have access to (identified by their `id`) with the following command: ```bash -curl -s -L "https://llm-api.cyverse.ai/v1/models" -H "Authorization: Bearer [AI-VERDE API KEY]" -H 'Content-Type: application/json'|jq +curl -s -L "https://llm-api.cyverse.ai/v1/models" \ +-H "Authorization: Bearer [AI-VERDE API KEY]" \ +-H 'Content-Type: application/json' | jq ``` ## 3. Write python scripts +Below is a Python example to test your connection to AI-VERDE using LlamaIndex. +Before running the script, make sure to: +- Replace `[MODEL NAME]` with one of your available model IDs. +- Replace `[AI-VERDE API KEY]` with your personal API key + ```python from llama_index.llms.litellm import LiteLLM from llama_index.core.llms import ChatMessage @@ -31,7 +44,7 @@ response = llm.chat([message]) print(response) ``` -Alternatively, you can include the API key as an environment variable or secret to avoid storing it in plain text: +To keep your API key secure, you can store it as an `environment variable` instead of typing it directly into your script. This ensures your credentials remain private if you share or upload your code. ```python import getpass diff --git a/docs/api/api-token-vscode.md b/docs/api/api-token-vscode.md index 1b09c96..8b2ae10 100644 --- a/docs/api/api-token-vscode.md +++ b/docs/api/api-token-vscode.md @@ -9,13 +9,13 @@ Within the extension marketplace, a simple search for OpenAI yields the desired extension. ![extension](../assets/vscode_extension_openai.png) ---- + ### 2. Configure the extension Once installed, a red bar with a "failed authentication" error will appear: ![redBar](../assets/vscode_openai_redbar.png) ---- + Selecting this red bar will bring out a new menu. In case you need to access this menu again, pressing the bar again will bring it up. In the new menu, select "custom" among the dropdown list diff --git a/docs/api/chatboxai.md b/docs/api/chatboxai.md index 3625eef..7b84ecd 100644 --- a/docs/api/chatboxai.md +++ b/docs/api/chatboxai.md @@ -1,48 +1,72 @@ # Chatbox AI -Chatbox AI is a desktop application that works on Windows, MacOS, Android, iOS, Web, and Linux. These instructions should apply for both Windows and MacOS versions with some variations between the two platforms. +Chatbox AI is a cross-platform desktop and mobile application that allows you to interact with AI-VERDE models through an intuitive chat interface. It runs on **Windows, macOS, Linux, Android, iOS, and Web**. + +This will guide you through connecting your AI-VERDE API Key, configuring your models, and starting your first conversation. ## Prerequisites -1. Obtain your AI-VERDE API Key and API URL. [Instructions can be found here](api-token.md). -2. Note the model(s) you want to configure for Claude Code. [Instructions can be found here](api-key-models.md). -3. Install Chatbox AI by visiting this page: https://chatboxai.app/en#download. -4. The remaining instructions Chatbox AI installed. + +1. **AI-VERDE API Key and API URL** + - Obtain your credentials by following the [AI-VERDE API Token Guide](api-token.md). + +2. **Model Information** + - Review the models you plan to use in the [AI-VERDE Model Documentation](api-key-models.md). + +3. **Chatbox AI Installation** + - Download the installer for your operating system from the [Chatbox AI Download Page](https://chatboxai.app/en#download). + +4. **Terminal or Application Access** + - These instructions assume **Chatbox AI** is already installed and accessible on your system. + ## 1. Configure AI-VERDE in Chatbox AI -For these steps, you can refer to the screenshot below +Follow these steps to connect Chatbox AI with your AI-VERDE account: 1. Launch Chatbox AI -2. Click on Settings -3. Click on Model Provider -4. Click the "+ Add" button
-![chatbox ai](../assets/chatboxai01.png){: style="width:95%"}
-5. Enter "ai-verde" in the Name field -6. Leave API Mode to "OpenAI API Compatible" -7. Click Add button
-![chatbox ai](../assets/chatboxai02.png){: style="width:80%"}
-You should then be shown the ai-verde configuration panel on the right. -8. Enter (or paste) your AI-VERDE Key in the API Key field -9. Enter (or paste) the AI-VERDE API URL in the API Host field -![chatbox ai](../assets/chatboxai03.png){: style="width:80%"} -10. In the model section, click on the "New" button, and a new model dialog box will be shown -11. Enter the model in "Model ID" field -12. In the capabilities, click on the capabilities if you know the model supports vision, reasoning, or tool use. - !!! Note - Capabilities for a model can be modified at a later time. -13. Click on the "Save" button
-![chatbox ai](../assets/chatboxai04.png){: style="width:80%"}
-14. You can repeat steps 10-13 to add additional models -15. Optionally, after adding one or more models, you can click on the "Check" button to test the connection to AI-VERDE - - -Now you're ready to begin chatting! - -## 2. Using Chatbox AI with configured models - -1. At any time, you can click on the "New Chat" button or click on a previous conversation on the left panel -2. Select the model for this chat session, if necessary
-![chatbox ai](../assets/chatboxai05.png){: style="width:95%"}
-3. Enter your request in the chat textbox to begin chatting with the model - -There is a lot of functionality provided by Chatbox AI (as with many other chat interfaces). Feel free to explore! \ No newline at end of file +2. Click "Settings" in the sidebar or top menu +3. Select "Model Provider" +4. Click "+ Add" button +   + ![chatbox ai](../assets/chatboxai01.png){: style="width:95%"} +   +5. In the Name field, enter "AI-VERDE" +6. Leave API Mode set to "OpenAI API Compatible" +7. Click "Add" +   + ![chatbox ai](../assets/chatboxai02.png){: style="width:80%"} +   +You should now see the AI-VERDE configuration panel on the right. +1. Enter (or paste) your AI-VERDE API Key into the API Key field +2. Enter (or paste) your AI-VERDE API URL into the API Host field +   + ![chatbox ai](../assets/chatboxai03.png){: style="width:80%"} +   +3. In the Model section, click "New" to open a new model dialog +4. Enter the "Model ID" (this corresponds to the `"id"` value from your model list) +5. Under capabilities, select options such as *Vision*, *Reasoning*, or *Tool Use* if your model supports them. Note: *Capabilities for a model can be modified later.* +6. Click "Save" +   + ![chatbox ai](../assets/chatboxai04.png){: style="width:80%"} +   +7. (Optional) Repeat steps 10–13 to add additional models +8. Click "Check" to test your connection to AI-VERDE + +If the test passes, your setup is complete — you’re ready to chat! + +## 2. Using Chatbox AI with Configured Models + +Once your models are set up, chatting is simple: + +1. Click "New Chat" or select a past conversation from the left panel +2. Choose the model you want to use for this chat session +   + ![chatbox ai](../assets/chatboxai05.png){: style="width:95%"} +   +3. Type your question or request in the chat box and press "Enter". + +That’s it! You’re now chatting directly with your configured AI-VERDE model. + +### Explore More + +Chatbox AI includes many advanced features — conversation history, model switching, plugin support, and more. Feel free to explore the interface and discover what works best for your workflow. \ No newline at end of file diff --git a/docs/api/claude-code-router.md b/docs/api/claude-code-router.md index ffdb661..18c859e 100644 --- a/docs/api/claude-code-router.md +++ b/docs/api/claude-code-router.md @@ -1,32 +1,48 @@ # Claude Code Router (using non-Anthropic Models) -You can follow these instructions to use your AI-VERDE API Key after installing Claude Code and Claude Code Router. More information on installing and using Claude Code Router can be found here, https://github.com/musistudio/claude-code-router. +This guide explains how to connect Claude Code with AI-VERDE using the Claude Code Router. By linking your AI-VERDE API key and model, you can route requests from Claude Code to non-Anthropic models through AI-VERDE. + +For more details on installation and usage, see the [Claude Code Router GitHub page](https://github.com/musistudio/claude-code-router). ## Prerequisites -1. Obtain your VERDE API Key. Instructions can be found here, https://aiverde-docs.cyverse.ai/api/api-token/ -2. Note the model(s) you want to configure for Claude Code. Instructions can be found here, https://aiverde-docs.cyverse.ai/api/api-key-models/. -3. Install Claude Code. Instructions can be found here, https://www.anthropic.com/claude-code/ -4. Install Claude Code Router. Instructions can be found here, https://github.com/musistudio/claude-code-router -5. The remaining instructions assume you have an open terminal on system with Claude Code and bash installed. + +1. **AI-VERDE API Key** + - Obtain your key by following the [AI-VERDE API Token Guide](https://aiverde-docs.cyverse.ai/api/api-token/). + +2. **Model Information** + - Identify the model(s) you plan to configure by reviewing the [AI-VERDE Model Documentation](https://aiverde-docs.cyverse.ai/api/api-key-models/). + +3. **Claude Code Installed** + - Follow the [Claude Code Installation Instructions](https://www.anthropic.com/claude-code/). + +4. **Claude Code Router Installed** + - Install the router by following the [Claude Code Router Setup Guide](https://github.com/musistudio/claude-code-router). + +5. **Terminal Access** + - Ensure you are using a terminal with Claude Code and bash available. ## 1. Starting Claude Code Router This step should only be needed the first time you use Claude Code Router. - In a terminal, enter the command `ccr start` ``` $ ccr start ``` ## 2. Configuring Claude Code Router -After running `ccr code`, you will be prompted to enter the minimum configuration to start Claude Code Router. Use the following table for guidance on the values: +After starting the router, run: +``` +ccr code +``` +You will be prompted to enter configuration details. +Use the table below as a reference for what to enter in each field: | Field | Value or Instructions | Notes | | ------| --------------------- | ----- | -| Provider Name | `ai-verde` | any string works | -| Provider API KEY | enter your AI-VERDE API key | | -| Provider URL | `https://llm-api.cyverse.ai/v1/chat/completions` | | +| Provider Name | `ai-verde` | any name works | +| Provider API KEY | enter your AI-VERDE API key | copy from your account | +| Provider URL | `https://llm-api.cyverse.ai/v1/chat/completions` |default AI-VERDE API endpoint.| | MODEL Name | `` | replace `` with the model you'd like to use | -After entering the MODEL name, you should see text similar to the following: +After entering your model information, you should see output similar to: ``` Loaded JSON config from: /root/.claude-code-router/config.json register transformer: Anthropic (endpoint: /v1/messages) @@ -39,7 +55,7 @@ providerConfig: ai-verde undefined ai-verde provider registered 🚀 LLMs API server listening on http://127.0.0.1:3456 ``` -Press `ctrl-c` so that you can run Claude Code with Claude Code Router. +Once you see the message confirming registration, press `Ctrl + C` to stop the process before running Claude Code with Claude Code Router. ## 3. Running Claude Code Router Running Claude Code with Claude Code Router with the following command: @@ -48,7 +64,11 @@ Running Claude Code with Claude Code Router with the following command: ccr code ``` -If you are successful entering Claude Code, congratulations! To use Claude Code with the same settings, you will need to run `ccr code` every time. +If successful, you’ll enter Claude Code with your AI-VERDE configuration active. To use the same setup again, simply run `ccr code` each time you start a new session. ## Updating Claude Code Router configuration -At some point, you may want to add other models or add or update configuration options. To do so, you can edit the configuration file found in `~/.claude-code-router/config.json` +You can update your configuration at any time — for example, to add new models or change API settings. To edit your setup manually, open the configuration file located at: +```bash +~/.claude-code-router/config.json` +``` +Make your desired changes, save, and restart Claude Code Router to apply the updates. \ No newline at end of file diff --git a/docs/api/index.md b/docs/api/index.md index 344370b..fb433f4 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,3 +1,8 @@ # Introduction to AI-VERDE API -This section contains documentation on how to use AI-VERDE API and API keys in code and with clients. \ No newline at end of file +The **AI-VERDE API** provides secure, programmatic access to CyVerse’s AI models and tools. This section explains how to authenticate with your API key, connect through client libraries, and integrate AI-VERDE into your code or applications. + +This guide covers: +- How to get your API key +- Viewing available models +- Connecting AI-VERDE to popular frameworks like LangChain and LlamaIndex diff --git a/docs/api/openwebui.md b/docs/api/openwebui.md new file mode 100644 index 0000000..dd97ffa --- /dev/null +++ b/docs/api/openwebui.md @@ -0,0 +1,59 @@ +# Using OpenWebUI with AI-VERDE + +This guide introduces how to use OpenWebUI through the AI-VERDE platform with a focus these features: + +- Quickly switching between AI models +- Organizing work in personal or shared workspaces +- Collaborating with course teammates through chat sharing + +OpenWebUI is a browser-based interface for interacting with AI models available in your course. For more information vist [OpenWebUI documentation](https://docs.openwebui.com/). + + +## 1. Launch OpenWebUI + +- On the top-right corner of the AI-VERDE navigation bar, click "OpenWebUI". +- The interface will open in a new browser tab once your signed in. +- You should now see the chat window and model selection bar at the top. + + + +## 2. Switch Between Models + +- At the top of the chat interface, choose from the list of AI models available to your course. +- Each model supports different capabilities (e.g., language reasoning, coding, image interpretation). +- You can switch models at any time — OpenWebUI will retain the chat history and continue the conversation with the newly selected model. + +> **Note:** +> +> - For side-by-side comparison, some configurations allow choosing two models to respond to the same prompt. Use this to compare responses and select the best result. +> - Some models support file or image input, while others may only process text. Upload support depends on the selected model. + + +## 3. Create a Workspace + +OpenWebUI you to organize conversations into workspaces to separate topics or projects. To create a new workspace: + +1. In the left sidebar, click the Workspace dropdown. +2. Select “New Workspace”. +3. Give your workspace a name (e.g., “Lab Summary” or “Final Project Notes”). +4. You can toggle visibility settings and choose to share the workspace with groups connected to your course. + +You can switch between workspaces at any time, and each will preserve its own chat history. + + +## 4. Share Chats with Your Course Team + +You can collaborate by sharing your chats with others in your AI-VERDE course. To share a conversation: + +1. Click "More" on the side of the chat thread. +2. Then “Share” or “Download” icon near the side of the chat. +3. Choose to either: + - Copy a shareable link, or + - Download the chat as a file (JSON or TXT). + + +## 5. Start Chatting + +With a selected a model and workspace: + +- Type your prompt into the chat box and press Enter.The response will appear directly below. You can switch models mid-conversation or return to previous chats in the history panel. \ No newline at end of file diff --git a/docs/instructors/creating-a-course.md b/docs/instructors/creating-a-course.md new file mode 100644 index 0000000..954c7bc --- /dev/null +++ b/docs/instructors/creating-a-course.md @@ -0,0 +1,42 @@ +# Creating a Course in AI-VERDE + +Instructors do **not** create courses directly in AI-VERDE. +Instead, courses are created by the CyVerse support team after you submit your course information. + + +## 1. Fill Out the Course Setup Form +- Complete the [Course Setup Form](https://docs.google.com/forms/d/e/1FAIpQLSdkwrUP7uJSfUeWsl4a2jWQH_wA-bKLJbqIX0nNWLKNCMm5JQ/viewform). +- Provide details such as: + - Student names and emails + - Teaching assistants (TAs) + - Co-instructors + + +## 2. Upload Your Course Roster +- Prepare a `.CSV` file with the following: + - Student names and emails + - Teaching assistants (TAs) + - Co-instructors +- Need a template? [Download the .CSV template](https://docs.google.com/spreadsheets/d/1VgIASIX9rRSHWXp2O89PZSLf0sSaUz1y9MHUSMsoMzY/edit?gid=0#gid=0). + +Attach this file when submitting the form. + + +## 3. What Happens Next +Once you submit the form: +- **CyVerse staff** will create your course in AI-VERDE. +- Students, TAs, and co-instructors from your CSV will be enrolled automatically. +- Your course will appear in the **AI-VERDE dashboard** within **48 hours**. + + + +## 4. Troubleshooting +- **Course not showing up?** → Wait up to 48 hours. If still missing, email: ai-verde-support@cyverse.org. +- **Roster errors?** → Double-check your CSV format and resubmit. +- **Need to add or remove members after your course is created?** → You can manage enrollment changes after the course is created + + +## Contact and Feedback +If you are happy with AI-VERDE, we’d love your feedback! +Please send comments or critiques to: +mithunpaul@arizona.edu \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index b9f0498..6dfdc66 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -65,8 +65,8 @@ theme: # Page tree nav: + - Welcome: index.md - AI-VERDE Chat: - - Welcome: index.md - Getting Started: getting-started.md - Current CyVerse Models: models-current.md - Chat History: chat-history.md