Skip to content

Commit 343a47f

Browse files
renaming AgentIQ to AIQToolKit
1 parent d188c1f commit 343a47f

File tree

11 files changed

+29
-29
lines changed

11 files changed

+29
-29
lines changed

.env

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
NEXT_PUBLIC_WORKFLOW=AgentIQ
1+
NEXT_PUBLIC_WORKFLOW=AIQToolKit
22
NEXT_PUBLIC_WEBSOCKET_CHAT_COMPLETION_URL=ws://127.0.0.1:8000/websocket
33
NEXT_PUBLIC_HTTP_CHAT_COMPLETION_URL=http://127.0.0.1:8000/chat/stream
44
NEXT_PUBLIC_WEB_SOCKET_DEFAULT_ON=false

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing Guidelines
22

3-
**Welcome to AgentIQ-UI**
3+
**Welcome to AIQToolKit-UI**
44

55
We appreciate your interest in contributing to our project.
66

@@ -22,8 +22,8 @@ We welcome the following types of contributions:
2222
To get started, fork the project on GitHub and clone it locally on your machine. Then, create a new branch to work on your changes.
2323

2424
```bash
25-
git clone https://github.com/NVIDIA/AgentIQ-UI.git
26-
cd AgentIQ-UI
25+
git clone https://github.com/NVIDIA/AIQToolKit-UI.git
26+
cd AIQToolKit-UI
2727
git checkout -b my-branch-name
2828
```
2929

LICENSE-3rd-party.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
AGENTIQ-UI Third-Party Licenses
1+
AIQToolKit-UI Third-Party Licenses
22
=================================
33

44
This file contains third-party license information for software packages used in this project.

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# AgentIQ - UI
1+
# AIQToolKit - UI
22

33
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
4-
[![AgentIQ](https://img.shields.io/badge/AgentIQ-Frontend-green)](https://github.com/NVIDIA/AgentIQ)
4+
[![AIQToolKit](https://img.shields.io/badge/AIQToolKit-Frontend-green)](https://github.com/NVIDIA/AIQToolKit)
55

6-
This is the official frontend user interface component for [AgentIQ](https://github.com/NVIDIA/AgentIQ), an open-source library for building AI agents and workflows.
6+
This is the official frontend user interface component for [AIQToolKit](https://github.com/NVIDIA/AIQToolKit), an open-source library for building AI agents and workflows.
77

88
This project builds upon the work of:
99
- [chatbot-ui](https://github.com/mckaywrigley/chatbot-ui) by Mckay Wrigley
@@ -20,7 +20,7 @@ This project builds upon the work of:
2020
## Getting Started
2121

2222
### Prerequisites
23-
- [AgentIQ](https://github.com/NVIDIA/AgentIQ) installed and configured
23+
- [AIQToolKit](https://github.com/NVIDIA/AIQToolKit) installed and configured
2424
- Git
2525
- Node.js (v18 or higher)
2626
- npm or Docker
@@ -29,8 +29,8 @@ This project builds upon the work of:
2929

3030
Clone the repository:
3131
```bash
32-
git clone [email protected]:NVIDIA/AgentIQ-UI.git
33-
cd AgentIQ-UI
32+
git clone [email protected]:NVIDIA/AIQToolKit-UI.git
33+
cd AIQToolKit-UI
3434
```
3535

3636
Install dependencies:
@@ -49,22 +49,22 @@ The application will be available at `http://localhost:3000`
4949
#### Docker Deployment
5050
```bash
5151
# Build the Docker image
52-
docker build -t agentiq-ui .
52+
docker build -t AIQToolKit-UI .
5353

5454
# Run the container with environment variables from .env
5555
# Ensure the .env file is present before running this command.
5656
# Skip --env-file .env if no overrides are needed.
57-
docker run --env-file .env -p 3000:3000 agentiq-ui
57+
docker run --env-file .env -p 3000:3000 AIQToolKit-UI
5858
```
5959

60-
![AgentIQ Web User Interface](public/screenshots/ui_home_page.png)
60+
![AIQToolKit Web User Interface](public/screenshots/ui_home_page.png)
6161

6262
## Configuration
6363

6464
### HTTP API Connection
6565
Settings can be configured by selecting the `Settings` icon located on the bottom left corner of the home page.
6666

67-
![AgentIQ Web UI Settings](public/screenshots/ui_generate_example_settings.png)
67+
![AIQToolKit Web UI Settings](public/screenshots/ui_generate_example_settings.png)
6868

6969
### Settings Options
7070
NOTE: Most of the time, you will want to select /chat/stream for intermediate results streaming.
@@ -75,16 +75,16 @@ NOTE: Most of the time, you will want to select /chat/stream for intermediate re
7575
- /generate/stream - Streaming response generation
7676
- /chat - Single response chat completion
7777
- /chat/stream - Streaming chat completion
78-
- `WebSocket URL for Completion`: WebSocket URL to connect to running AgentIQ server
78+
- `WebSocket URL for Completion`: WebSocket URL to connect to running AIQToolKit server
7979
- `WebSocket Schema`: Workflow schema type over WebSocket connection
8080

8181
## Usage Examples
8282

8383
### Simple Calculator Example
8484

8585
#### Setup and Configuration
86-
1. Set up [AgentIQ](https://github.com/NVIDIA/AgentIQ/blob/main/docs/source/1_intro/getting_started.md)
87-
2. Start workflow by following the [Simple Calculator Example](https://github.com/NVIDIA/AgentIQ/blob/main/examples/simple_calculator/README.md)
86+
1. Set up [AIQToolKit](https://github.com/NVIDIA/AIQToolKit/blob/main/docs/source/1_intro/getting_started.md)
87+
2. Start workflow by following the [Simple Calculator Example](https://github.com/NVIDIA/AIQToolKit/blob/main/examples/simple_calculator/README.md)
8888
```bash
8989
aiq serve --config_file=examples/simple_calculator/configs/config.yml
9090
```
@@ -95,21 +95,21 @@ Interact with the chat interface by prompting the agent with the message:
9595
Is 4 + 4 greater than the current hour of the day?
9696
```
9797

98-
![AgentIQ Web UI Workflow Result](public/screenshots/ui_generate_example.png)
98+
![AIQToolKit Web UI Workflow Result](public/screenshots/ui_generate_example.png)
9999

100100
### Human In The Loop (HITL) Example
101101

102102
#### Setup and Configuration
103-
1. Set up [AgentIQ](https://github.com/NVIDIA/AgentIQ/blob/main/docs/source/1_intro/getting_started.md)
104-
2. Start workflow by following the [HITL Example](https://github.com/NVIDIA/AgentIQ/blob/main/examples/simple_human_in_the_loop/README.md)
103+
1. Set up [AIQToolKit](https://github.com/NVIDIA/AIQToolKit/blob/main/docs/source/1_intro/getting_started.md)
104+
2. Start workflow by following the [HITL Example](https://github.com/NVIDIA/AIQToolKit/blob/main/examples/simple_human_in_the_loop/README.md)
105105
```bash
106106
aiq serve --config_file=examples/simple_human_in_the_loop/configs/config.yml
107107
```
108108

109109
#### Configuring HITL Settings
110110
Enable WebSocket mode in the settings panel for bidirectional real-time communication between the client and server.
111111

112-
![AgentIQ Web UI HITL Settings](public/screenshots/hitl_settings.png)
112+
![AIQToolKit Web UI HITL Settings](public/screenshots/hitl_settings.png)
113113

114114
#### Example Conversation
115115
1. Send the following prompt:
@@ -119,16 +119,16 @@ Can you process my input and display the result for the given prompt: How are yo
119119

120120
2. Enter your response when prompted:
121121

122-
![AgentIQ Web UI HITL Prompt](public/screenshots/hitl_prompt.png)
122+
![AIQToolKit Web UI HITL Prompt](public/screenshots/hitl_prompt.png)
123123

124124
3. Monitor the result:
125125

126-
![AgentIQ Web UI HITL Prompt](public/screenshots/hitl_result.png)
126+
![AIQToolKit Web UI HITL Prompt](public/screenshots/hitl_result.png)
127127

128128
## API Integration
129129

130130
### Server Communication
131-
The UI supports both HTTP requests (OpenAI compatible) and WebSocket connections for server communication. For detailed information about WebSocket messaging integration, please refer to the [WebSocket Documentation](https://github.com/NVIDIA/AgentIQ/blob/main/docs/5_advanced/websockets.md) in the AgentIQ documentation.
131+
The UI supports both HTTP requests (OpenAI compatible) and WebSocket connections for server communication. For detailed information about WebSocket messaging integration, please refer to the [WebSocket Documentation](https://github.com/NVIDIA/AIQToolKit/blob/main/docs/5_advanced/websockets.md) in the AIQToolKit documentation.
132132

133133

134134

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "agentiq-ui",
2+
"name": "AIQToolKit-ui",
33
"version": "0.1.0",
44
"private": true,
55
"scripts": {

pages/_document.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export default function Document(props: Props) {
1212
<Html lang={currentLocale}>
1313
<Head>
1414
<meta name="apple-mobile-web-app-capable" content="yes" />
15-
<meta name="apple-mobile-web-app-title" content="AgentIQ"></meta>
15+
<meta name="apple-mobile-web-app-title" content="AIQToolKit-UI"></meta>
1616
</Head>
1717
<body>
1818
<Main />

pages/api/home/home.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ const Home = (props: any) => {
4242
initialState,
4343
});
4444

45-
let workflow = 'AgentIQ';
45+
let workflow = 'AIQToolKit';
4646

4747
const {
4848
state: {

public/screenshots/hitl_result.png

-335 KB
Binary file not shown.
43.6 KB
Loading
-160 KB
Loading

0 commit comments

Comments
 (0)