├── .idea
    └── .gitignore
├── README.md
├── LICENSE
├── pom.xml
└── src
    └── main
        └── java
            └── com
                └── hexadevlabs
                    └── gpt4allsample
                        └── Main.java


/.idea/.gitignore:
--------------------------------------------------------------------------------
1 | # Default ignored files
2 | /shelf/
3 | /workspace.xml
4 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # gpt4all-java-bindings-sample
2 | A sample project that uses GPT4ALL Java bindings.
3 | 
4 | This project depends on the latest released version the bindings package.
5 | 
6 | Update Main.java to set baseModelPath to location of your model files.
7 | 
8 | You may pass **llama**, **mpt**, **replit** as and argument but make you have the corresponding model file downloaded.
9 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2023 Felix Zaslavskiy
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <project xmlns="http://maven.apache.org/POM/4.0.0"
 3 |          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4 |          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 5 |     <modelVersion>4.0.0</modelVersion>
 6 | 
 7 |     <groupId>com.hexadevlabs</groupId>
 8 |     <artifactId>gpt4all-java-bindings-sample</artifactId>
 9 |     <version>1.0</version>
10 |     <packaging>jar</packaging>
11 | 
12 |     <properties>
13 |         <maven.compiler.source>11</maven.compiler.source>
14 |         <maven.compiler.target>11</maven.compiler.target>
15 |     </properties>
16 | 
17 |     <dependencies>
18 |         <dependency>
19 |             <groupId>com.hexadevlabs</groupId>
20 |             <artifactId>gpt4all-java-binding</artifactId>
21 |             <version>1.1.5</version>
22 |         </dependency>
23 |         <dependency>
24 |             <groupId>org.slf4j</groupId>
25 |             <artifactId>slf4j-simple</artifactId>
26 |             <version>1.7.36</version>
27 |         </dependency>
28 |     </dependencies>
29 |     <build>
30 |         <plugins>
31 |             <plugin>
32 |                 <groupId>org.apache.maven.plugins</groupId>
33 |                 <artifactId>maven-jar-plugin</artifactId>
34 |                 <version>3.3.0</version>
35 |                 <configuration>
36 |                     <archive>
37 |                         <manifest>
38 |                             <addClasspath>true</addClasspath>
39 |                             <mainClass>com.hexadevlabs.gpt4allsample.Main</mainClass>
40 |                         </manifest>
41 |                     </archive>
42 |                 </configuration>
43 |             </plugin>
44 |             <plugin>
45 |                 <groupId>org.apache.maven.plugins</groupId>
46 |                 <artifactId>maven-assembly-plugin</artifactId>
47 |                 <version>3.6.0</version>
48 |                 <configuration>
49 |                     <descriptorRefs>
50 |                         <descriptorRef>jar-with-dependencies</descriptorRef>
51 |                     </descriptorRefs>
52 |                         <archive>
53 |                             <manifest>
54 |                                 <mainClass>com.hexadevlabs.gpt4allsample.Main</mainClass>
55 |                             </manifest>
56 |                         </archive>
57 |                 </configuration>
58 |                 <executions>
59 |                     <execution>
60 |                         <id>make-assembly</id>
61 |                         <phase>package</phase>
62 |                         <goals>
63 |                             <goal>single</goal>
64 |                         </goals>
65 |                     </execution>
66 |                 </executions>
67 |             </plugin>
68 |         </plugins>
69 |     </build>
70 | </project>


--------------------------------------------------------------------------------
/src/main/java/com/hexadevlabs/gpt4allsample/Main.java:
--------------------------------------------------------------------------------
 1 | package com.hexadevlabs.gpt4allsample;
 2 | 
 3 | import com.hexadevlabs.gpt4all.LLModel;
 4 | 
 5 | import java.nio.file.Path;
 6 | import java.util.List;
 7 | import java.util.Map;
 8 | 
 9 | public class Main {
10 | 
11 |     public static void main(String[] args){
12 | 
13 |         // DIRECTION: Update the baseModelPath to the location of model files on your system.
14 | 
15 |         String modelFilePath = "ggml-gpt4all-j-v1.3-groovy.bin";
16 | 
17 |         String osName = System.getProperty("os.name").toLowerCase();
18 |         boolean isWindows = osName.startsWith("windows");
19 |         boolean isMac = osName.startsWith("mac os x");
20 |         boolean isLinux = osName.startsWith("linux");
21 | 
22 |         String baseModelPath = null;
23 |         if(isWindows){
24 |             baseModelPath ="C:\\Users\\felix\\AppData\\Local\\nomic.ai\\GPT4All\\";
25 |         } else if(isLinux){
26 |             baseModelPath = "/mnt/c/Users/felix/AppData/Local/nomic.ai/GPT4All/";
27 |         } else if(isMac) {
28 |             baseModelPath = "/Users/fzaslavs/Library/Application Support/nomic.ai/GPT4All/";
29 |         }
30 | 
31 | 
32 |         // Optionally in case override to location of shared libraries is necessary
33 |         //LLModel.LIBRARY_SEARCH_PATH = "C:\\Users\\felix\\gpt4all\\lib\\";
34 | 
35 |         if(args.length>0){
36 |             switch (args[0]) {
37 |                 case "mpt":
38 |                     modelFilePath = "ggml-mpt-7b-instruct.bin";
39 |                     break;
40 |                 case "llama":
41 |                     modelFilePath = "ggml-vicuna-7b-1.1-q4_2.bin";
42 |                     break;
43 |                 case "replit":
44 |                     modelFilePath = "ggml-replit-code-v1-3b.bin";
45 |                     break;
46 |                 case "falcon":
47 |                     modelFilePath = "ggml-model-gpt4all-falcon-q4_0.bin";
48 |                     break;
49 |                 case "orca":
50 |                     modelFilePath= "orca-mini-3b.ggmlv3.q4_0.bin";
51 |                     break;
52 |             }
53 |         }
54 | 
55 |         // Debut output format. In case you need it.
56 |         // LLModel.OUTPUT_DEBUG=true;
57 | 
58 |         Path modelPath = Path.of(baseModelPath + modelFilePath);
59 | 
60 |         try ( LLModel model = new LLModel(modelPath) ){
61 | 
62 |             LLModel.GenerationConfig config = LLModel.config()
63 |                     .withNPredict(4096).build();
64 | 
65 |             System.out.println("Using ChatCompletion api:\n");
66 |             // Using Chat Completion Template
67 |             model.chatCompletion(
68 |                     List.of(Map.of("role", "system", "content", "You are a helpful assistant"),
69 |                             Map.of("role", "user", "content", "Add 2+2")), config, true, true);
70 | 
71 |             System.out.println();
72 |             System.out.println();
73 |             System.out.println("Using Generate method:\n");
74 | 
75 |             // Using the Generate method.
76 |             // Note that you will have to provide the full prompt here yourself.
77 |             // Print to stdout.
78 |             String prompt = "You are a helpful assistant.  \n" +
79 |                             "Human: What is result of adding 2 and 2?\n" +
80 |                             "Assistant: ";
81 |             System.out.println(prompt);
82 |             model.generate(prompt, config, true);
83 | 
84 |         } catch (Exception e) {
85 |             throw new RuntimeException(e);
86 |         }
87 | 
88 |     }
89 | 
90 | }
91 | 


--------------------------------------------------------------------------------