Skip to content

Commit

Permalink
Rename
Browse files Browse the repository at this point in the history
  • Loading branch information
Josh-XT committed Oct 27, 2023
1 parent 8aaaaf0 commit cbbef7a
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 56 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docker-image.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
uses: josh-xt/AGiXT/.github/workflows/operation-docker-build-publish.yml@main
with:
registry-dockerhub-enable: ${{ github.event_name != 'pull_request' }}
registry-repo-name: agixtchat
registry-repo-name: agixtinteractive
registry-readme: ./docs/README.md
tags: |
type=schedule
Expand Down
57 changes: 4 additions & 53 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AGiXT Chat
# AGiXT Interactive

[![GitHub](https://img.shields.io/badge/GitHub-AGiXT%20Core-blue?logo=github&style=plastic)](https://github.com/Josh-XT/AGiXT) [![GitHub](https://img.shields.io/badge/GitHub-AGiXT%20Hub-blue?logo=github&style=plastic)](https://github.com/AGiXT/hub) [![GitHub](https://img.shields.io/badge/GitHub-AGiXT%20NextJS%20Web%20UI-blue?logo=github&style=plastic)](https://github.com/AGiXT/nextjs)

Expand All @@ -11,68 +11,19 @@

[![Logo](https://josh-xt.github.io/AGiXT/images/AGiXT-gradient-flat.svg)](https://josh-xt.github.io/AGiXT/)

AGiXT Chat is a React component for a user facing chat interface for AGiXT.
AGiXT Interactive is a NextJS front end for AGiXT for interacting with agents.

## Run AGiXT Chat front end
## Run AGiXT Interactive front end

- If you don't already have AGiXT, [follow this link for instructions to set it up.](https://github.com/Josh-XT/AGiXT#quick-start-guide)
- After you have run the AGiXT back end, follow these instructions below:

```bash
git clone https://github.com/Josh-XT/agixtchat
cd agixtchat
npm install
npm run dev
docker run -it --rm -p 3000:3000 -e NEXT_PUBLIC_API_URI=http://localhost:7437 joshxt/agixtinteractive
```

Access at <http://localhost:3000>

## Use as a React Component

```javascript
import AGiXTChat from "../components/AGiXTChat";

export default function Chat({
AGiXTServer = "http://localhost:7437",
agentName = "gpt4free",
insightAgent = "gpt4free",
conversationName = "Test",
setConversationName = () => {},
showConversationBar = true,
dark = true,
fileUploadEnabled = false,
mode = "prompt",
promptName = "Chat",
promptCategory = "Default",
selectedChain = "Postgres Chat",
chainArgs = {},
useSelectedAgent = true,
}) {
return (
<AGiXTChat
baseUri={AGiXTServer} // Base URI to the AGiXT server
agentName={agentName} // Agent name
insightAgent={insightAgent} // Insight agent name to use a different agent for insights, leave blank to use the same agent
conversationName={conversationName} // Conversation name
setConversationName={setConversationName} // Function to set the conversation name
// UI Options
showConversationBar={showConversationBar} // Show the conversation selection bar to create, delete, and export conversations
dark={dark} // Set dark mode by default
enableFileUpload={fileUploadEnabled} // Enable file upload button, disabled by default.
// Modes are prompt or chain
mode={mode}
// prompt mode - Set promptName and promptCategory
promptName={promptName} // Name of the prompt to use
promptCategory={promptCategory} // Category of the prompt to use
// chain mode - Set chain name and chain args
selectedChain={selectedChain} // Chain name
chainArgs={chainArgs} // Chain arg overrides, unnecessary if you don't need to override any args.
useSelectedAgent={useSelectedAgent} // Will force the selected agent to run all chain steps rather than the agents defined in the chain
/>
);
}
```

## History

![Star History Chart](https://api.star-history.com/svg?repos=Josh-XT/AGiXT&type=Dat)
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "agixtchats",
"name": "agixtinteractive",
"version": "0.0.1",
"private": true,
"scripts": {
Expand Down Expand Up @@ -39,4 +39,4 @@
"ts-loader": "^9.4.4",
"typescript": "^5.2.2"
}
}
}

0 comments on commit cbbef7a

Please sign in to comment.