Flutter插件dvdb的介绍与使用指南

在本指南中，我们将探讨如何在Flutter应用中使用DVDB插件。DVDB是一个轻量级的矢量数据库插件，可以本地存储用户数据，并且支持Android和iOS平台。

为什么创建DVDB？

我们来自Fast Code AI，正在开发一个需要在设备上创建隐私保护型矢量数据库的应用。经过调研，我们发现SVDB（SVDB：适用于iOS设备的矢量数据库）能够很好地满足我们的需求。然而，我们需要一个同样适用于Android设备的矢量数据库。遗憾的是，我们没有找到适用于Android设备的矢量数据库。因此，我们决定创建一个统一的矢量数据库，既可以在Android也可以在iOS设备上运行。在本项目中，我们使用Dart语言实现了一个矢量数据库，可以在Flutter应用中使用。

DVDB亮点 ✨

• 隐私优先：用户的私人数据不会离开设备，也不会存储在我们的服务器上。你拥有你的数据和嵌入。
• 无需服务器：DVDB在设备上本地运行，零延迟，无需服务器维护！
• 支持OpenAI嵌入：只需几行代码即可将OpenAI嵌入添加到DVDB中。
• 自定义嵌入：你可以创建自己的嵌入并添加到DVDB中，而不是使用OpenAI嵌入。
• 多平台支持：无论你是Android团队还是iOS团队，DVDB都支持两种平台，使应用程序开发变得更加轻松。

启动你的DVDB之旅 🚀

安装Flutter

1. 步骤1：从官方网站下载并安装Flutter SDK。
2. 步骤2：使用你喜欢的IDE设置开发环境，并安装Dart插件。
3. 步骤3：在终端中运行flutter doctor以确保一切配置正确。

安装我们的DVDB

1. 步骤4：运行git clone https://github.com/FastCodeAI/DVDB.git。

DVDB快速启动：魔法几分钟！ 🎩✨

在设置了代码库之后，就可以开始使用DVDB了！查看examples/vector_db_example.dart文件以了解DVDB的工作原理。在命令行中运行以下脚本：

dart example/vector_db_example.dart

如果你想在你的Flutter项目中使用DVDB，只需在pubspec.yaml文件中添加以下依赖项并开始使用：

dependencies:
  DVDB:
    path: ./path_to_dvdb_folder/DVDB/

探索更多关于DVDB 🔍

性能基准测试结果

下表展示了SVDB与DVDB在iPhone 14上的性能对比结果。

插入n个文档

搜索

下表展示了DVDB在Android手机上的性能基准测试结果。

插入n个文档

搜索

示例代码

import 'dart:typed_data';
import 'package:dvdb/dvdb.dart';
import 'dart:convert';
import 'package:http/http.dart' as http;

const String openaiApiKey = 'sk-your_api_key'; // 替换为你的OpenAI API密钥
const String openaiUrl = 'https://api.openai.com/v1/embeddings';

void main() async {
  var headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer $openaiApiKey'
  };

  var collection = DVDB().collection("Test");
   
  var texts = ['cat', 'dog', 'lion'];

  for (var text in texts) {
    try {
      var requestBody = jsonEncode({
        'input': text,
        'model': 'text-embedding-ada-002'
      });

      var response = await http.post(Uri.parse(openaiUrl), headers: headers, body: requestBody);

      if (response.statusCode == 200) {
        var jsonResponse = jsonDecode(response.body);
        Float64List embedding = jsonResponse['data'][0]['embedding'];
        print('Response from OpenAI: ${embedding.runtimeType}');
        collection.addDocument(null, text, embedding);
      } 
      else {
        print('Request failed with status: ${response.statusCode}.');
        print('Response body: ${response.body}');
      }
    } 
    catch(e) {
      print('An error occurred: $e');
    }
  }

  try {
    var requestBody = jsonEncode({
      'input': 'tiger',
      'model': 'text-embedding-ada-002'
    });

    var response = await http.post(Uri.parse(openaiUrl), headers: headers, body: requestBody);
    if (response.statusCode == 200) {
      var jsonResponse = jsonDecode(response.body);
      Float64List embedding = jsonResponse['data'][0]['embedding'];

      final query = collection.search(embedding, numResults: 1);

      query.forEach((element) {
      
        print("${element.score} || ${element.text}");
      });
    }
    else {
      print('Request failed with status: ${response.statusCode}.');
      print('Response body: ${response.body}');
    }
  }
  catch(e){
    print(e);
  }
}