Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kezhenxu94/chatgpt-java
ChatGPT SDK for Java, CLI, GitHub Actions, demo, etc.
https://github.com/kezhenxu94/chatgpt-java
chatgpt chatgpt-api chatgpt-bot chatgpt-cli chatgpt-github-action chatgpt-java chatgpt-sdk java
Last synced: 20 days ago
JSON representation
ChatGPT SDK for Java, CLI, GitHub Actions, demo, etc.
- Host: GitHub
- URL: https://github.com/kezhenxu94/chatgpt-java
- Owner: kezhenxu94
- License: apache-2.0
- Created: 2023-03-04T15:36:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-29T02:11:13.000Z (10 months ago)
- Last Synced: 2024-04-14T09:58:32.777Z (7 months ago)
- Topics: chatgpt, chatgpt-api, chatgpt-bot, chatgpt-cli, chatgpt-github-action, chatgpt-java, chatgpt-sdk, java
- Language: Java
- Homepage:
- Size: 156 KB
- Stars: 23
- Watchers: 2
- Forks: 6
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TL;DR;
[Chat with ChatGPT Now](https://github.com/kezhenxu94/chatgpt-java/issues/new?assignees=&labels=question&template=q--.md&title=Q%3A+).
# ChatGPT Java SDK
## Add the dependency
### Maven
```xml
io.github.kezhenxu94
chatgpt-java-sdk
${chatgpt-java.version}
```
### Gradle
```groovy
implementation 'io.github.kezhenxu94:chatgpt-java-sdk:${chatgpt-java.version}'
```
## Usage
```java
public class ChatGPTTest {
public static void main(String[] args) throws IOException, InterruptedException {
final var chatGPT = ChatGPT
.builder()
.dataPath(Files.createTempDirectory("chatgpt")) // Persist the chat history to a data path
.build();
// Start a new conversation
final var conversation = chatGPT.newConversation();
System.out.println(conversation.ask("What's your name?").content());
// Output: I'm an AI language model developed by OpenAI, and I don't have a name. What can I help you with today?
System.out.println(conversation.ask("What did I ask you?").content());
// Output: You asked for my name.
conversation.save(); // Save the history manually, conversations are saved on shutdown by default.
final var conversation2 = chatGPT.newConversation("You are a software engineer.");
System.out.println(conversation2.ask("What's your job?").content());
System.out.println(conversation2.ask("What's your day to day work?").content());
// Load a conversation by the ID
final var conversation3 = chatGPT.loadConversation(conversation.id());
conversation3.ask("What did I ask you?");
// Should print the same as the first conversation
}
}
```
A demo usage of ChatGPT Java SDK is the [ChatGPT CLI](#chatgpt-cli), built with Spring Shell and Graalvm.
# ChatGPT CLI
> Who on earth would want to use CLI to interact with ChatGPT? Developers!
## Prerequisites
An API key from OpenAI platform is required before using the CLI, head
to [OpenAI Account](https://platform.openai.com/account/api-keys) to create one.
```shell
export CHATGPT_API_KEY=
```
## Download the CLI
Head to [Releases](https://github.com/kezhenxu94/chatgpt-java/releases) to download the CLI according to your os.
```shell
sudo install chatgpt-cli.macos /usr/local/bin/chatgpt
```
## Running the CLI in Docker
```shell
docker run -it --rm -e CHATGPT_API_KEY kezhenxu94/chatgpt-cli
```
## Usage
### Conversation (Interactive Mode)
`chatgpt-cli` by default runs in interactive mode and the questions in one session is a conversation, so ChatGPT
remembers
your previous questions inside a single conversation, you can use `ask` command to ask ChatGPT any question:
```shell
chatgpt
> ask --question 'What is your name?'
```
Or you can omit `--question` and simply:
```shell
chatgpt
> ask "What is your name?"
> ask "What did I ask you?"
# should reply something like "You asked for my name."
```
But don't forget to quote the question if it contains spaces.
### One-shot (Non-Interactive Mode)
If you want to ask ChatGPT a one-shot question, you can pass the `ask` command and the question directly, so ChatGPT
will
exit after it replies your questions:
```shell
chatgpt ask "What is your name?"
```
# ChatGPT GitHub Action
## Add OpenAI API Key Secret
Add your OpenAI API key as a secret to your repository.
Go to `https://github.com///settings/secrets/actions`, create "New repository secret" with the
name `OPENAI_KEY` and your API key as the value.
## Usage
```yaml
- name: Setup ChatGPT
uses: kezhenxu94/chatgpt-java/[email protected]
- name: Answer the question
env:
CHATGPT_API_KEY: ${{ secrets.OPENAI_KEY }}
run: |
chatgpt ask "What is your name?"
```