Add File
This commit is contained in:
80
docs/en/intro/getting-started.md
Normal file
80
docs/en/intro/getting-started.md
Normal file
@@ -0,0 +1,80 @@
|
|||||||
|
# Quickstart
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
Before you begin, ensure you are:
|
||||||
|
|
||||||
|
- Familiar with Java environment setup and development
|
||||||
|
- Familiar with Java build tools like Maven
|
||||||
|
|
||||||
|
> Note: Your environment must be Java 8 or higher.
|
||||||
|
|
||||||
|
## Hello World
|
||||||
|
|
||||||
|
**Step 1: Create a Java project and add the Maven dependency:**
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.agentsflex</groupId>
|
||||||
|
<artifactId>agents-flex-bom</artifactId>
|
||||||
|
<version>1.0.0-rc.10</version>
|
||||||
|
</dependency>
|
||||||
|
```
|
||||||
|
|
||||||
|
Or use Gradle:
|
||||||
|
|
||||||
|
```java
|
||||||
|
implementation 'com.agentsflex:agents-flex-bom:1.0.0-rc.10'
|
||||||
|
```
|
||||||
|
|
||||||
|
**Step 2: Create a Java class with a `main` method:**
|
||||||
|
|
||||||
|
```java
|
||||||
|
public class Main {
|
||||||
|
public static void main(String[] args) {
|
||||||
|
OpenAILlmConfig config = new OpenAILlmConfig();
|
||||||
|
config.setApiKey("sk-rts5NF6n*******");
|
||||||
|
|
||||||
|
Llm llm = new OpenAILlm(config);
|
||||||
|
String response = llm.chat("What is your name?");
|
||||||
|
|
||||||
|
System.out.println(response);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Simplify LLM object creation using `OpenAILlm.of`:
|
||||||
|
|
||||||
|
|
||||||
|
```java
|
||||||
|
public class Main {
|
||||||
|
public static void main(String[] args) {
|
||||||
|
Llm llm = new OpenAILlm.of("sk-rts5NF6n*******");
|
||||||
|
String response = llm.chat("what is your name?");
|
||||||
|
|
||||||
|
System.out.println(response);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Streaming Conversation
|
||||||
|
|
||||||
|
Streaming Conversation requires calling the `chatStream` method, and passing the prompt with `StreamResponseListener` object, as shown in the code below:
|
||||||
|
|
||||||
|
```java
|
||||||
|
public class Main {
|
||||||
|
public static void main(String[] args) {
|
||||||
|
Llm llm = new OpenAILlm.of("sk-rts5NF6n*******");
|
||||||
|
|
||||||
|
llm.chatStream("what is your name?", new StreamResponseListener<AiMessageResponse, AiMessage>() {
|
||||||
|
@Override
|
||||||
|
public void onMessage(ChatContext context, AiMessageResponse response) {
|
||||||
|
System.out.println(">>>> " + response.getMessage().getContent());
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
System.out.println(response);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user