Tms-llm-kit NPM

tms-llm-kit以langchain为基础，实现了基于文件、wikijs、mongodb等语料源建立和使用向量数据库的功能。

将文本资料加载到向量数据库中，可以实现语义搜索功能。资料中的内容向量化后用于语义搜索，元数据用于关键字匹配连接其他相关的数据。因此，加载资料时需要指定哪些部分是内容，哪些部分是元数据。语言大模型的向量空间是专有的，使用哪个大模型就要用它提供的接口做向量化。向量化接口有长度限制，执行向量计算前要将分档拆分为适当的大小。

讯飞星火向量接口：

文本长度不超过 256 个字符，超过会只截取前 256 个字符进行向量化

百度文心输入文本以获取 embeddings。说明：

（1）文本数量不超过 16
（2）每个文本长度不超过 384 个 token
（3）输入文本不能为空，如果为空会报错

目前，支持加载的资料包括：csv 格式文件，json 格式文件和 wikijs 在线接口，mongodb 的集合。

目前，向量数据库使用hnswlib。它是个轻量级的内存数据库，数据持久化在本地文件。

考虑到数据安全要求，用户有些数据不希望发送给大模型。针对这种情况，支持将加载的资料分为向量化和非向量化两部分分别存储。非向量化的数据不会调用大模型的向量化接口，只是转换为标准文档格式存储。

构造好向量数据库后，就可以实现语义检索。目前支持：

方式一：输入文本，按照语义从数据库中检索匹配的文档并返回文档。
方式二：输入文本，按照语义从数据库中检索匹配的文档，将检索的文档作为提示内容传给大模型，由大模型生成回复内容。
方式三：输入文本，按照语义从数据库中检索匹配的文档，根据文档的元数据，再从关联文档库中按元数据检索。
方式四：直接输入元数据，从文档库中匹配文档。

在Q&A的场景中，如果需要根据用户的输入，从某个文档中，例如：用户手册，直接匹配答案，那么就使用方式一。

方式一有个缺陷，因为文档加载时需要根据大模型向量化接口的限制控制文本块的大小，所以向量对应的文本块不能保证是完整的段落，不适合直接作为回复，这种情况可以使用方式二，让语言大模型基于检索的内容生成更自然的答案。

如果，原始的资料问题和答案是分开，且需要给用户返回标准的答案，那么就采用方式三。

注意：当前版本的主要目的是进行技术和功能的验证，用于生产还需要考虑数据安全、性能、可维护性等问题。

编译

pnpm i
pnpm build

连接语言大模型

新建.env文件，指定语言大模型参数，目前支持百度文心和讯飞星火。

# 百度文心
BAIDUWENXIN_APP_ID=
BAIDUWENXIN_API_KEY=
BAIDUWENXIN_SECRET_KEY=
# 讯飞星火
XUNFEISPARK_APP_ID=
XUNFEISPARK_SECRET_KEY=
XUNFEISPARK_API_KEY=
# wikijs
WIKIJS_API_KEY=

指定字段名称

tms-llm-kit内部用jsonpointer格式指定字段名称。如果输入的字段名不是以/开头，自动添加/。

示例 json 数据

{
  "foo": ["bar", "baz"],
  "": 0,
  "a/b": 1,
  "c%d": 2,
  "e^f": 3,
  "g|h": 4,
  "i\\j": 5,
  "k\"l": 6,
  " ": 7,
  "m~n": 8
}

通 jsonpointer 获取值

""           // the whole document
"/foo"       ["bar", "baz"]
"/foo/0"     "bar"
"/"          0
"/a~1b"      1
"/c%d"       2
"/e^f"       3
"/g|h"       4
"/i\\j"      5
"/k\"l"      6
"/ "         7
"/m~0n"      8

参考：

https://datatracker.ietf.org/doc/html/rfc6901

资料加载

基于资料构造向量数据库的基本过程如下：

flowchart TD
A((开始))
Z((结束))

S1[加载文档]
S2[拆分文档]
S3[文档块向量化]
S4[构造向量数据库]
S5[保存到本地]
A --> S1
S1 --> S2
S2 --> S3
S3 --> S4
S4 --> S5
S5 --> Z

执行如下命令加载文件，并生成向量数据库。

`csv`文件，字段`q`和字段`a`都执行向量化，可通过语义检索；字段`id`作为元数据。

DEBUG=* node ./dist/build --type csv --file ./sample/data01-faq.csv --as-vec q a --as-meta id --store ./store/data01-faq-wx --model baiduwenxin

DEBUG=* node ./dist/build --type csv --file ./sample/data01-faq.csv --as-vec q a --as-meta id --store ./store/data01-faq-xf --model xunfeispark

`json`文件，字段`q`和字段`a`都执行向量化，可通过语义检索；字段`id`作为元数据。

DEBUG=* node ./dist/build --type json --file ./sample/data02-faq.json --as-vec q,a --as-meta id --store ./store/data02-faq-wx --model baiduwenxin

DEBUG=* node ./dist/build --type json --file ./sample/data02-faq.json --as-vec q a --as-meta id --store ./store/data02-faq-xf --model xunfeispark

`csv`文件，字段`q`执行向量化，可通过语义检索；字段`a`直接保存为文档，仅可通过元数据检索；字段`id`作为元数据。

DEBUG=* node ./dist/build --type csv --file ./sample/data01-faq.csv --as-vec q --as-assoc a --as-meta id --store ./store/data01-faq-assoc-wx --model baiduwenxin

DEBUG=* node ./dist/build --type csv --file ./sample/data01-faq.csv --as-vec q --as-assoc a --as-meta id --store ./store/data01-faq-assoc-xf --model xunfeispark

`json`文件，字段`q`执行向量化，可通过语义检索；字段`a`直接保存为文档，仅可通过元数据检索；字段`id`作为元数据。

DEBUG=* node ./dist/build --type json --file ./sample/data02-faq.json --as-vec q --as-assoc a --as-meta id --store ./store/data02-faq-assoc-wx --model baiduwenxin

DEBUG=* node ./dist/build --type json --file ./sample/data02-faq.json --as-vec q --as-assoc a --as-meta id --store ./store/data02-faq-assoc-xf --model xunfeispark

从`mongodb`加载

DEBUG=* node ./dist/build --type mongodb --url 'mongodb://root:root@localhost:27017' --db-name llmqadb --cl-name llmqa --as-meta _id --as-vec question answer --model baiduwenxin --store ./store/mongodb-wx

DEBUG=* node ./dist/build --type mongodb --url 'mongodb://root:root@localhost:27017' --db-name llmqadb --cl-name llmqa --as-meta _id --as-vec question answer --model xunfeispark --store ./store/mongodb-xf

从`wikijs`加载，不支持非向量化文档。

DEBUG=* node ./dist/build --type wikijs --url 'http://localhost:8444/graphql' --store ./store/wikijs-wx --model baiduwenxin

DEBUG=* node ./dist/build --type wikijs --url 'http://localhost:8444/graphql' --store ./store/wikijs-xf --model xunfeispark

wikijs单篇文档包含的字段，若不指定asVec和asMeta参数，content作为向量字段，id作为元数据字段。

{
  "id": 3,
  "path": "xxx",
  "title": "xxx",
  "description": "",
  "createdAt": "2023-03-26T01:39:30.881Z",
  "updatedAt": "2023-03-26T01:39:34.253Z",
  "content": "xxx"
}

参考：

https://docs.requarks.io/dev/api

从`tms-mongodb-web`加载

DEBUG=* node ./dist/build --type tmw --url 'http://localhost:6030/api/admin/document/list?db=e2e5gmx&cl=dialog_script' --as-meta _id name --as-vec title remark --model baiduwenxin --store ./store/tmw-wx

需要用环境变量TMW_ACCESS_TOKEN，指定 API 的访问令牌。

命令使用的参数如下

参数	说明	类型	默认值
type	数据类型，支持：json，csv，wikijs，mongodb。		无
file	要加载的文件路径，适用于 json 和 csv。		无
url	wikijs 的 api 地址。mongodb 的连接地址。		无
as-vec	输入数据中作为向量处理的字段。	数组
as-meta	输入数据中作为元数据处理的字段。	数组
as-assoc	输入数据中作为关联文档处理的字段。仅在`type`是`json`和`csv`时有效。	数组
store	生成的向量数据库存储路径。		无
model	使用的语言大模型。		无

字段：csv 文件中的列，json 对象的字段路径。

检索数据

根据输入的文本（text）和元数据过滤条件（filter）(可不写)，返回匹配的文档。

DEBUG=* node ./dist/retrieve --store ./store/data01-faq-xf --perset vector-doc --text 风险 --filter '{"/_pageContentSource":"/q"}'

[
  {
    "pageContent": "语言大模型有哪些风险",
    "metadata": {
      "source": "./sample/data01-faq.csv",
      "_pageContentSource": "/q",
      "id": "7",
      "loc": {
        "lines": {
          "from": 1,
          "to": 1
        }
      }
    }
  }
]

使用num-retrieve参数控制返回结果的数量

DEBUG=* node ./dist/retrieve --store ./store/data01-faq-assoc-xf --perset vector-doc --text 风险 --num-retrieve 3

[
  {
    "pageContent": "语言大模型有哪些风险",
    "metadata": {
      "source": "./sample/data01-faq.csv",
      "id": "7",
      "_pageContentSource": "/q",
      "loc": {
        "lines": {
          "from": 1,
          "to": 1
        }
      }
    }
  },
  {
    "pageContent": "大模型中的微调是什么",
    "metadata": {
      "source": "./sample/data01-faq.csv",
      "id": "11",
      "_pageContentSource": "/q",
      "loc": {
        "lines": {
          "from": 1,
          "to": 1
        }
      }
    }
  },
  {
    "pageContent": "语言大模型有以下局限性",
    "metadata": {
      "source": "./sample/data01-faq.csv",
      "id": "4",
      "_pageContentSource": "/q",
      "loc": {
        "lines": {
          "from": 1,
          "to": 1
        }
      }
    }
  }
]

先根据输入的文本（text）和过滤条件（filter）搜索相似的文档，再用文档的元数据（assoc-match）在非向量库中进行元数据搜索。

DEBUG=* node ./dist/retrieve --store ./store/data01-faq-assoc-xf --perset assoc-doc --text 风险 --filter '{"/_pageContentSource":"/q"}' --assoc-match '/id' --num-retrieve 3

[
  {
    "metadata": {
      "id": "7",
      "a": "生成文本的单调性或重复性问题。对于某些语言的处理能力有限。对于某些复杂语言问题的处理能力有限。对于某些特定领域或专业知识的处理能力有限。存在数据泄露和隐私安全问题。"
    }
  },
  {
    "metadata": {
      "id": "11",
      "a": "大模型的微调是指针对特定任务对预训练的大模型进行微小调整。它是使用少量目标领域的样本数据进行训练，以优化模型在特定任务上的性能。微调的目的是使大模型适应特定任务和数据分布，以提高模型的表现。通过微调，我们可以利用现有的模型能力来解决具体的任务。"
    }
  },
  {
    "metadata": {
      "id": "4",
      "a": "对于某些特定领域或专业知识的处理能力有限。可能会出现生成文本的单调性或重复性问题。对于某些语言的处理能力有限。对于某些复杂语言问题的处理能力有限。"
    }
  }
]

使用as-doc参数指定作为文档内容的字段

DEBUG=* node ./dist/retrieve --store ./store/data01-faq-assoc-xf --perset assoc-doc --text 风险 --filter '{"/_pageContentSource":"/q"}' --assoc-match id --as-doc a --num-retrieve 3

[
  {
    "pageContent": "生成文本的单调性或重复性问题。对于某些语言的处理能力有限。对于某些复杂语言问题的处理能力有限。对于某些特定领域或专业知识的处理能力有限。存在数据泄露和隐私安全问题。",
    "metadata": {
      "id": "7",
      "_pageContentSource": "/a"
    }
  },
  {
    "pageContent": "大模型的微调是指针对特定任务对预训练的大模型进行微小调整。它是使用少量目标领域的样本数据进行训练，以优化模型在特定任务上的性能。微调的目的是使大模型适应特定任务和数据分布，以提高模型的表现。通过微调，我们可以利用现有的模型能力来解决具体的任务。",
    "metadata": {
      "id": "11",
      "_pageContentSource": "/a"
    }
  },
  {
    "pageContent": "对于某些特定领域或专业知识的处理能力有限。可能会出现生成文本的单调性或重复性问题。对于某些语言的处理能力有限。对于某些复杂语言问题的处理能力有限。",
    "metadata": {
      "id": "4",
      "_pageContentSource": "/a"
    }
  }
]

将检索到的文本作为素材提供给大模型生成答案。

DEBUG=* node ./dist/retrieve --store ./store/data01-faq-xf --perset feed-llm --text 风险

[
  {
    "pageContent": "风险：\n\n1. 语言模型可能存在偏见，导致其输出的结果存在偏见，从而影响用户的体验。\n2. 语言模型可能存在错误，导致其输出的结果存在错误，从而影响用户的体验。\n3. 语言模型可能存在安全问题，导致其输出的结果存在安全问题，从而影响用户的体验。",
    "metadata": {}
  }
]

根据指定的元数据过滤条件（filter），在向量化文档库中搜索，返回匹配的文档。

DEBUG=* node ./dist/retrieve --store ./store/data01-faq-xf --perset meta-vector-doc --filter '{"/id":"1"}'

[
  {
    "pageContent": "什么是语言大模型",
    "metadata": {
      "source": "./sample/data01-faq.csv",
      "id": "1",
      "_pageContentSource": "/q",
      "loc": {
        "lines": {
          "from": 1,
          "to": 1
        }
      }
    }
  },
  {
    "pageContent": "语言大模型是一种基于深度学习技术的人工智能模型，它可以自动从大量文本数据中学习语言规律，并生成类似人类的自然语言文本。",
    "metadata": {
      "source": "./sample/data01-faq.csv",
      "id": "1",
      "_pageContentSource": "/a",
      "loc": {
        "lines": {
          "from": 1,
          "to": 1
        }
      }
    }
  }
]

根据指定的元数据过滤条件（filter），在非向量化文档库中搜索，返回匹配的文档。

 DEBUG=* node ./dist/retrieve --store ./store/data01-faq-assoc-xf --perset meta-assoc-doc --filter '{"/id":"1"}'

[
  {
    "pageContent": "语言大模型是一种基于深度学习技术的人工智能模型，它可以自动从大量文本数据中学习语言规律，并生成类似人类的自然语言文本。",
    "metadata": {
      "source": "./sample/data01-faq.csv",
      "id": "1",
      "_pageContentSource": "/a"
    }
  }
]

参数	说明	类型	默认值
store	向量数据目录地址或者 mongodb 数据库的连接地址。	文本	无
perset	预定义的检索方式。	文本	无
text	检索条件。	文本	无
filter	文档过滤条件。JSON 格式的字符串。`jsonpointer`表示属性名和等于值的 JSON 对象。	JSON	无
assoc-match	关联文档匹配字段。	数组	无
assoc-filter	关联文档过滤条件。JSON 格式的字符串。	JSON	无
as-doc	原始数据中作为文档处理的字段。只支持根字段名。	数组
retrieve-object	返回关联文档的对象。包含的字段由 as-doc 指定。	boolean
as-meta	原始数据中作为元数据处理的字段。	数组
mongo	仅在`store`为 mongodb 数据库时，下列参数有效。
db	存储索引数据的 mongodb 数据库名称。	文本
cl	存储索引数据的 mongodb 集合名称。	文本
doc-store	存储文档数据的 mongodb 连接地址。	文本
doc-db	存储文档数据的 mongodb 数据库名称。	文本
doc-cl	存储文档数据的 mongodb 集合名称。	文本

注意：检索命令的参数中表示字段的地方，都用jsonpointer格式表示，例如：/_pageContentSource。

参考：https://www.npmjs.com/package/jsonpointer

如果指定了as-doc参数，那么，获得获取关联数据后，根据as-doc指定的字段提取数据，如果指定retrieve-object参数，那么由as-doc参数指定的字段构成pageContent的内容，以 JSON 格式的字符串作为结果；如果没有指定retrieve-object参数，那么，as-doc指定的每个字段作为独立的文档返回；如果没有指定as-doc参数，那么pageContent为空，如果指定了as-meta参数，as-meta指定的字段作为metadata返回，否则，整个数据作为metadata返回。

从`mongodb`检索关联数据

从mongodb数据库中检索关联文档，不指定参数as-doc，as-meta，retrieve-object参数

node ./dist/retrieve --store <...> --perset assoc-doc --text 风险 --assoc-match '_id'

[
  {
    "metadata": {
      "_id": "64fffae6375aa0cf0f71586f",
      "question": "语言大模型有哪些风险",
      "answer": "生成文本的单调性或重复性问题。对于某些语言的处理能力有限。对于某些复杂语言问题的处理能力有限。对于某些特定领域或专业知识的处理能力有限。存在数据泄露和隐私安全问题。",
      "TMW_CREATE_TIME": "2023-09-12 13:45:10"
    }
  }
]

指定了as-doc

node ./dist/retrieve --store  <...> --perset assoc-doc --text 风险 --assoc-match '_id' --as-doc 'answer'

[
  {
    "pageContent": "生成文本的单调性或重复性问题。对于某些语言的处理能力有限。对于某些复杂语言问题的处理能力有限。对于某些特定领域或专业知识的处理能力有限。存在数据泄露和隐私安全问题。",
    "metadata": {
      "_id": "64fffae6375aa0cf0f71586f",
      "question": "语言大模型有哪些风险",
      "TMW_CREATE_TIME": "2023-09-12 13:45:10",
      "_pageContentSource": "/answer"
    }
  }
]

指定了as-meta

node ./dist/retrieve --store  <...> --perset assoc-doc --text 风险 --assoc-match '_id' --as-meta question answer

[
  {
    "metadata": {
      "/question": "语言大模型有哪些风险",
      "/answer": "生成文本的单调性或重复性问题。对于某些语言的处理能力有限。对于某些复杂语言问题的处理能力有限。对于某些特定领域或专业知识的处理能力有限。存在数据泄露和隐私安全问题。"
    }
  }
]

指定了as-doc，as-meta

node ./dist/retrieve --store <xxx> --perset assoc-doc --text 风险 --assoc-match _id --as-doc answer --as-meta _id question

[
  {
    "pageContent": "生成文本的单调性或重复性问题。对于某些语言的处理能力有限。对于某些复杂语言问题的处理能力有限。对于某些特定领域或专业知识的处理能力有限。存在数据泄露和隐私安全问题。",
    "metadata": {
      "/_id": "64fffae6375aa0cf0f71586f",
      "/question": "语言大模型有哪些风险",
      "_pageContentSource": "/answer"
    }
  }
]

指定了as-doc，as-meta，retrieve-object

node ./dist/retrieve --store <xxx> --perset assoc-doc --text 风险 --assoc-match _id --as-doc answer --as-meta _id question --retrieve-object

[
  {
    "pageContent": "{\"/answer\":\"生成文本的单调性或重复性问题。对于某些语言的处理能力有限。对于某些复杂语言问题的处理能力有限。对于某些特定领域或专业知识的处理能力有限。存在数据泄露和隐私安全问题。\"}",
    "metadata": {
      "/_id": "64fffae6375aa0cf0f71586f",
      "/question": "语言大模型有哪些风险"
    }
  }
]

指定了as-doc，as-meta，retrieve-object，结果对象包含多个字段

node ./dist/retrieve --store <xxx> --perset assoc-doc --text 风险 --assoc-match _id --as-doc answer question --as-meta _id --retrieve-object

[
  {
    "pageContent": "{\"/answer\":\"生成文本的单调性或重复性问题。对于某些语言的处理能力有限。对于某些复杂语言问题的处理能力有限。对于某些特定领域或专业知识的处理能力有限。存在数据泄露和隐私安全问题。\",\"/question\":\"语言大模型有哪些风险\"}",
    "metadata": {
      "/_id": "64fffae6375aa0cf0f71586f"
    }
  }
]

从`wikijs`检索管理数据

以wikijs作为数据源时，assoc-match参数无效，目前，仅通过id字段进行匹配。

node ./dist/retrieve --store  <...> --perset assoc-doc --text 企业数字化 --as-doc content

指定了as-doc参数，控制输出的内容

[
  {
    "pageContent": "<...>",
    "metadata": {
      "id": 82,
      "path": "<...>",
      "title": "<...>",
      "description": "<...>",
      "createdAt": "2023-07-13T03:16:54.220Z",
      "updatedAt": "2023-07-13T03:47:03.086Z",
      "_pageContentSource": "/content"
    }
  }
]

指定了as-doc和as-meta参数，控制输出的内容

 node ./dist/retrieve --store  <...> --perset assoc-doc --text 企业数字化 --as-doc content --as-meta path

[
  {
    "pageContent": "<...>",
    "metadata": {
      "/path": "<...>",
      "_pageContentSource": "<...>"
    }
  }
]

as-doc参数指定了多个字段，retrieve-object参数控制结果作为对象返回（而不是 3 个独立的结果）。

node ./dist/retrieve --store <xxx> --perset assoc-doc --text 企业数字化 --assoc-match _id --as-doc title path content --retrieve-object

[
  {
    "pageContent": "{\"/title\":\"...\",\"/path\":\"...\",\"/content\":\"...\"}",
    "metadata": {
      "id": 82,
      "description": "",
      "createdAt": "2023-07-13T03:16:54.220Z",
      "updatedAt": "2023-07-13T03:47:03.086Z"
    }
  }
]

计算向量

node ./dist/embedding --model baiduwenxin --text 介绍语言大模型

作为包使用

构造向量数据库

import { buildFromMongo } =from 'tms-llm-kit'

检索数据

import { runPerset } from 'tms-llm-kit'

result = await runPerset(perset, config, question, modelName)

构造 docker 镜像

在项目根目录下执行

构造镜像

docker build -t jasony62/tms-llm-kit .

在容器中执行

docker run -it --rm --name tlk-test -v $PWD/.env:/usr/tms-llm-kit/.env -v $PWD/store:/usr/store jasony62/tms-llm-kit sh

langchain embedding vector database

@langchain/community @langchain/core commander d3-dsv debug dotenv hnswlib-node jsonpointer langchain mongodb ws

@everything-registry/sub-chunk-2953

0.0.5

2 months ago

0.0.2

7 months ago

0.0.1

7 months ago

编译

连接语言大模型

指定字段名称

资料加载

csv文件，字段q和字段a都执行向量化，可通过语义检索；字段id作为元数据。

json文件，字段q和字段a都执行向量化，可通过语义检索；字段id作为元数据。

csv文件，字段q执行向量化，可通过语义检索；字段a直接保存为文档，仅可通过元数据检索；字段id作为元数据。

json文件，字段q执行向量化，可通过语义检索；字段a直接保存为文档，仅可通过元数据检索；字段id作为元数据。

从mongodb加载

从wikijs加载，不支持非向量化文档。

从tms-mongodb-web加载

命令使用的参数如下

检索数据

从mongodb检索关联数据

从wikijs检索管理数据

计算向量

作为包使用

构造向量数据库

检索数据

构造 docker 镜像

`csv`文件，字段`q`和字段`a`都执行向量化，可通过语义检索；字段`id`作为元数据。

`json`文件，字段`q`和字段`a`都执行向量化，可通过语义检索；字段`id`作为元数据。

`csv`文件，字段`q`执行向量化，可通过语义检索；字段`a`直接保存为文档，仅可通过元数据检索；字段`id`作为元数据。

`json`文件，字段`q`执行向量化，可通过语义检索；字段`a`直接保存为文档，仅可通过元数据检索；字段`id`作为元数据。

从`mongodb`加载

从`wikijs`加载，不支持非向量化文档。

从`tms-mongodb-web`加载

从`mongodb`检索关联数据

从`wikijs`检索管理数据