Add SQL Chain for README.md and QuickStart

CrazyForks · Jun 6, 2023 · 3afea76 · 3afea76
1 parent 71af523
commit 3afea76
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -84,6 +84,7 @@ Up until now, we’ve worked with the PromptTemplate and LLM primitives by thems
 
 A chain in LangChain is made up of links, which can be either primitives like LLMs or other chains.
 
+#### 2.5.1 LLM Chain
 The most core type of chain is an LLMChain, which consists of a PromptTemplate and an LLM.
 ```java
 OpenAI llm = OpenAI.builder()
@@ -100,7 +101,22 @@ System.out.println(chain.run("colorful socks"));
 ```shell
 \n\nSocktastic!
 ```
-There we go! There’s the first chain - an LLM Chain. This is one of the simpler types of chains, but understanding how it works will set you up well for working with more complex chains.
+#### 2.5.2 SQL Chain
+This example demonstrates the use of the SQLDatabaseChain for answering questions over a database.
+```java
+SQLDatabase database = SQLDatabase.fromUri("jdbc:mysql://127.0.0.1:3306/demo", "root", "123456");
+
+BaseLanguageModel llm = OpenAI.builder()
+        .temperature(0)
+        .build()
+        .init();
+
+Chain chain = SQLDatabaseChain.fromLLM(llm, database);
+System.out.println(chain.run("How many students are there?"));
+```
+```shell
+There are 6 students.
+```
 
 ## 3. Run Test Cases from Source
 ```

diff --git a/langchain-core/src/test/java/com/hw/langchain/QuickStart.java b/langchain-core/src/test/java/com/hw/langchain/QuickStart.java
@@ -18,11 +18,14 @@
 
 package com.hw.langchain;
 
+import com.hw.langchain.base.language.BaseLanguageModel;
 import com.hw.langchain.chains.base.Chain;
 import com.hw.langchain.chains.llm.LLMChain;
+import com.hw.langchain.chains.sql.database.base.SQLDatabaseChain;
 import com.hw.langchain.llms.openai.OpenAI;
 import com.hw.langchain.prompts.prompt.PromptTemplate;
 
+import com.hw.langchain.sql.database.SQLDatabase;
 import lombok.experimental.UtilityClass;
 
 import java.util.List;
@@ -67,9 +70,22 @@ private void llmChain() {
         System.out.println(chain.run("colorful socks"));
     }
 
+    private void sqlChain() {
+        SQLDatabase database = SQLDatabase.fromUri("jdbc:mysql://127.0.0.1:3306/demo", "root", "123456");
+
+        BaseLanguageModel llm = OpenAI.builder()
+                .temperature(0)
+                .build()
+                .init();
+
+        Chain chain = SQLDatabaseChain.fromLLM(llm, database);
+        System.out.println(chain.run("How many students are there?"));
+    }
+
     public static void main(String[] args) {
         llm();
         promptTemplate();
         llmChain();
+        sqlChain();
     }
 }
diff --git a/scripts/mysql/data.sql b/scripts/mysql/data.sql
@@ -0,0 +1,12 @@
+INSERT INTO demo.students (id, name, score, teacher_note) VALUES (1, 'Alex', 100, 'Alex did perfectly every day in the class.');
+INSERT INTO demo.students (id, name, score, teacher_note) VALUES (2, 'Alice', 70, 'Alice needs a lot of improvements.');
+INSERT INTO demo.students (id, name, score, teacher_note) VALUES (3, 'Jack', 75, 'Event it is not the best, Jack has already improved.');
+INSERT INTO demo.students (id, name, score, teacher_note) VALUES (4, 'Ophelia', 0, 'Unfortunately, Ophelia missed the test.');
+INSERT INTO demo.students (id, name, score, teacher_note) VALUES (5, 'Zack', 60, 'Zack needs to do better.');
+INSERT INTO demo.students (id, name, score, teacher_note) VALUES (6, 'HamaWhite', 95, 'Keep going.');
+
+INSERT INTO demo.parents (id, student_name, parent_name, parent_mobile) VALUES (1, 'Alex', 'Barry', '088121');
+INSERT INTO demo.parents (id, student_name, parent_name, parent_mobile) VALUES (2, 'Alice', 'Jessica', '088122');
+INSERT INTO demo.parents (id, student_name, parent_name, parent_mobile) VALUES (3, 'Jack', 'Simon', '088123');
+INSERT INTO demo.parents (id, student_name, parent_name, parent_mobile) VALUES (5, 'Ophelia', 'Tracy', '088124');
+INSERT INTO demo.parents (id, student_name, parent_name, parent_mobile) VALUES (6, 'HamaWhite', 'Harper', '088125');
diff --git a/scripts/mysql/schema.sql b/scripts/mysql/schema.sql
@@ -0,0 +1,20 @@
+CREATE TABLE `students`
+(
+    `id`           int(11)      DEFAULT NULL,
+    `name`         varchar(64)  DEFAULT NULL,
+    `score`        int(11)      DEFAULT NULL COMMENT 'math score',
+    `teacher_note` varchar(256) DEFAULT NULL
+) COMMENT ='student score table';
+
+
+CREATE TABLE `parents`
+(
+    `id`            int(11)     DEFAULT NULL,
+    `student_name`  varchar(64) DEFAULT NULL,
+    `parent_name`   varchar(64) DEFAULT NULL,
+    `parent_mobile` varchar(16) DEFAULT NULL
+);
+
+
+
+