Files
AntSK/README.en.md
2024-02-07 22:30:39 +08:00

174 lines
4.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# AntSK
## Based on AI knowledge base/agent created by Net8+AntBlazor+SemanticKernel
## Core functions
-* * Semantic Kernel * *: It uses advanced natural language processing technology to accurately understand, process and respond to complex semantic queries, and provides users with accurate information retrieval and recommendation services.
-* * Kernel Memory * *: It has the ability to continuously learn and store knowledge points. AntSK has a long-term memory function to accumulate experience and provide a more personalized interactive experience.
-* * Knowledge base * *: Knowledge base documents can be created by importing knowledge base documents (Word, PDF, Excel, Txt, Markdown, Json, PPT) and other forms.
-* * API plug-in system * *: an open API plug-in system that allows third-party developers or service providers to easily integrate their services into AntSK and continuously enhance application functions.
-* * Online search * *: AntSK can obtain the latest information in real time to ensure that the information received by users is always the most timely and relevant.
-* * GPTs generation * *: This platform supports the creation of personalized GPT models and attempts to build your own GPT models.
-* * API interface publishing * *: internal functions are provided externally in the form of API, so that developers can easily translate Xzy AntSK KnowledgeBase is integrated into other applications to enhance application intelligence.
## Application scenarios
AntSK is applicable to a variety of business scenarios, such as:
-Enterprise level knowledge management system
-Automatic customer service and chat robot
-Enterprise Search Engine
-Personalized recommendation system
-Intelligent assisted writing
-Education and online learning platform
-Other interesting AI Apps
## Function example
First, you need to create a knowledge base
! [Knowledge base] https://github.com/xuzeyu91/AntSK/blob/main/images/%E7%9F%A5%E8%AF%86%E5%BA%93.png
In the knowledge base, you can use documents or urls to import
! [Knowledge base details] https://github.com/xuzeyu91/AntSK/blob/main/images/%E7%9F%A5%E8%AF%86%E5%BA%93%E8%AF%A6%E6%83%85.png
Click View to view the document slicing of the knowledge base
! [Document Slice] https://github.com/xuzeyu91/AntSK/blob/main/images/%E6%96%87%E6%A1%A3%E5%88%87%E7%89%87.png
Then we need to create applications, which can create dialog applications and knowledge bases.
! [Application] https://github.com/xuzeyu91/AntSK/blob/main/images/%E5%BA%94%E7%94%A8.png
The application of knowledge base needs to select the existing knowledge base, which can be multiple
! [Application Configuration] https://github.com/xuzeyu91/AntSK/blob/main/images/%E5%BA%94%E7%94%A8%E9%85%8D%E7%BD%AE.png
Then you can ask questions about the knowledge base documents in the dialogue
! [Q&A] https://github.com/xuzeyu91/AntSK/blob/main/images/%E9%97%AE%E7%AD%94.png
In addition, we can also create dialogue applications, and configure prompt word templates in corresponding applications
! [Conversation application] https://github.com/xuzeyu91/AntSK/blob/main/images/%E7%AE%80%E5%8D%95%E5%AF%B9%E8%AF%9D.png
Let's see the effect
! [Conversation effect] https://github.com/xuzeyu91/AntSK/blob/main/images/%E5%AF%B9%E8%AF%9D%E6%95%88%E6%9E%9C.png
## How do I get started?
Here I use Postgres as data storage and vector storage, because both the Semantic Kernel and Kernel Memory support it. Of course, you can switch to other ones.
The model supports openai by default. If you need to use azure openai and need to adjust the dependency injection of SK, you can also use one api for integration.
The following configuration files need to be configured
```
"ConnectionStrings":{
"Postgres": "Host=; Port=; Database=antsk; Username=; Password="
},
"OpenAIOption":{
"EndPoint": "",
"Key": "",
"Model": "",
"Embedding Model": """""
},
Postgres:{
"ConnectionString": "Host=; Port=; Database=antsk; Username=; Password=",
"TableNamePrefix": "km -"
}
```
I use CodeFirst mode. As long as the database link is configured, the table structure is automatically created
To learn more or start using * * AntSK * *, you can follow my public account and join the exchange group.
## Contact me
If you have any questions or suggestions, please follow my public account through the following ways, and send a message to me. We also have an exchange group, which can send messages such as joining the group, and then I will bring you into the exchange group
! [Official account] https://github.com/xuzeyu91/Avalonia-Assistant/blob/main/img/gzh.jpg
---
We appreciate your interest in * * AntSK * * and look forward to working with you to create an intelligent future!