@dakshp1234/langchain-textsplitters 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/LICENSE +21 -0
- package/README.md +53 -0
- package/dist/index.cjs +12 -0
- package/dist/index.d.cts +3 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +3 -0
- package/dist/semantic_text_splitter.cjs +179 -0
- package/dist/semantic_text_splitter.cjs.map +1 -0
- package/dist/semantic_text_splitter.d.cts +44 -0
- package/dist/semantic_text_splitter.d.cts.map +1 -0
- package/dist/semantic_text_splitter.d.ts +44 -0
- package/dist/semantic_text_splitter.d.ts.map +1 -0
- package/dist/semantic_text_splitter.js +178 -0
- package/dist/semantic_text_splitter.js.map +1 -0
- package/dist/text_splitter.cjs +536 -0
- package/dist/text_splitter.cjs.map +1 -0
- package/dist/text_splitter.d.cts +82 -0
- package/dist/text_splitter.d.cts.map +1 -0
- package/dist/text_splitter.d.ts +82 -0
- package/dist/text_splitter.d.ts.map +1 -0
- package/dist/text_splitter.js +530 -0
- package/dist/text_splitter.js.map +1 -0
- package/package.json +65 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# @langchain/textsplitters
|
|
2
|
+
|
|
3
|
+
## 1.0.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [#9416](https://github.com/langchain-ai/langchainjs/pull/9416) [`0fe9beb`](https://github.com/langchain-ai/langchainjs/commit/0fe9bebee6710f719e47f913eec1ec4f638e4de4) Thanks [@hntrl](https://github.com/hntrl)! - fix 'moduleResultion: "node"' compatibility
|
|
8
|
+
|
|
9
|
+
## 1.0.0
|
|
10
|
+
|
|
11
|
+
This release updates the package for compatibility with LangChain v1.0. See the v1.0 [release notes](https://docs.langchain.com/oss/javascript/releases/langchain-v1) for details on what's new.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) LangChain, Inc.
|
|
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.
|
package/README.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# 🦜✂️ @langchain/textsplitters
|
|
2
|
+
|
|
3
|
+
This package contains various implementations of LangChain.js text splitters, most commonly used as part of retrieval-augmented generation (RAG) pipelines.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash npm2yarn
|
|
8
|
+
npm install @langchain/textsplitters @langchain/core
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Development
|
|
12
|
+
|
|
13
|
+
To develop the `@langchain/textsplitters` package, you'll need to follow these instructions:
|
|
14
|
+
|
|
15
|
+
### Install dependencies
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
pnpm install
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### Build the package
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
pnpm build
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Or from the repo root:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
pnpm build --filter @langchain/textsplitters
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Run tests
|
|
34
|
+
|
|
35
|
+
Test files should live within a `tests/` file in the `src/` folder. Unit tests should end in `.test.ts` and integration tests should
|
|
36
|
+
end in `.int.test.ts`:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
$ pnpm test
|
|
40
|
+
$ pnpm test:int
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Lint & Format
|
|
44
|
+
|
|
45
|
+
Run the linter & formatter to ensure your code is up to standard:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
pnpm lint && pnpm format
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Adding new entrypoints
|
|
52
|
+
|
|
53
|
+
If you add a new file to be exported, either import & re-export from `src/index.ts`, or add it to the `exports` field in the `package.json` file and run `pnpm build` to generate the new entrypoint.
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
+
const require_text_splitter = require("./text_splitter.cjs");
|
|
3
|
+
const require_semantic_text_splitter = require("./semantic_text_splitter.cjs");
|
|
4
|
+
exports.CharacterTextSplitter = require_text_splitter.CharacterTextSplitter;
|
|
5
|
+
exports.LatexTextSplitter = require_text_splitter.LatexTextSplitter;
|
|
6
|
+
exports.MarkdownTextSplitter = require_text_splitter.MarkdownTextSplitter;
|
|
7
|
+
exports.RecursiveCharacterTextSplitter = require_text_splitter.RecursiveCharacterTextSplitter;
|
|
8
|
+
exports.SemanticTextSplitter = require_semantic_text_splitter.SemanticTextSplitter;
|
|
9
|
+
exports.SupportedTextSplitterLanguages = require_text_splitter.SupportedTextSplitterLanguages;
|
|
10
|
+
exports.TextSplitter = require_text_splitter.TextSplitter;
|
|
11
|
+
exports.TokenTextSplitter = require_text_splitter.TokenTextSplitter;
|
|
12
|
+
exports.calculateCosineDistances = require_semantic_text_splitter.calculateCosineDistances;
|
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { CharacterTextSplitter, CharacterTextSplitterParams, LatexTextSplitter, LatexTextSplitterParams, MarkdownTextSplitter, MarkdownTextSplitterParams, RecursiveCharacterTextSplitter, RecursiveCharacterTextSplitterParams, SupportedTextSplitterLanguage, SupportedTextSplitterLanguages, TextSplitter, TextSplitterChunkHeaderOptions, TextSplitterParams, TokenTextSplitter, TokenTextSplitterParams } from "./text_splitter.cjs";
|
|
2
|
+
import { SemanticTextSplitter, SemanticTextSplitterParams, calculateCosineDistances } from "./semantic_text_splitter.cjs";
|
|
3
|
+
export { CharacterTextSplitter, CharacterTextSplitterParams, LatexTextSplitter, LatexTextSplitterParams, MarkdownTextSplitter, MarkdownTextSplitterParams, RecursiveCharacterTextSplitter, RecursiveCharacterTextSplitterParams, SemanticTextSplitter, SemanticTextSplitterParams, SupportedTextSplitterLanguage, SupportedTextSplitterLanguages, TextSplitter, TextSplitterChunkHeaderOptions, TextSplitterParams, TokenTextSplitter, TokenTextSplitterParams, calculateCosineDistances };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { CharacterTextSplitter, CharacterTextSplitterParams, LatexTextSplitter, LatexTextSplitterParams, MarkdownTextSplitter, MarkdownTextSplitterParams, RecursiveCharacterTextSplitter, RecursiveCharacterTextSplitterParams, SupportedTextSplitterLanguage, SupportedTextSplitterLanguages, TextSplitter, TextSplitterChunkHeaderOptions, TextSplitterParams, TokenTextSplitter, TokenTextSplitterParams } from "./text_splitter.js";
|
|
2
|
+
import { SemanticTextSplitter, SemanticTextSplitterParams, calculateCosineDistances } from "./semantic_text_splitter.js";
|
|
3
|
+
export { CharacterTextSplitter, CharacterTextSplitterParams, LatexTextSplitter, LatexTextSplitterParams, MarkdownTextSplitter, MarkdownTextSplitterParams, RecursiveCharacterTextSplitter, RecursiveCharacterTextSplitterParams, SemanticTextSplitter, SemanticTextSplitterParams, SupportedTextSplitterLanguage, SupportedTextSplitterLanguages, TextSplitter, TextSplitterChunkHeaderOptions, TextSplitterParams, TokenTextSplitter, TokenTextSplitterParams, calculateCosineDistances };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { CharacterTextSplitter, LatexTextSplitter, MarkdownTextSplitter, RecursiveCharacterTextSplitter, SupportedTextSplitterLanguages, TextSplitter, TokenTextSplitter } from "./text_splitter.js";
|
|
2
|
+
import { SemanticTextSplitter, calculateCosineDistances } from "./semantic_text_splitter.js";
|
|
3
|
+
export { CharacterTextSplitter, LatexTextSplitter, MarkdownTextSplitter, RecursiveCharacterTextSplitter, SemanticTextSplitter, SupportedTextSplitterLanguages, TextSplitter, TokenTextSplitter, calculateCosineDistances };
|
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
let _langchain_core_documents = require("@langchain/core/documents");
|
|
2
|
+
//#region src/semantic_text_splitter.ts
|
|
3
|
+
/**
|
|
4
|
+
* Experimental semantic text splitter based on semantic similarity.
|
|
5
|
+
*
|
|
6
|
+
* Inspired by Greg Kamradt's semantic chunking approach:
|
|
7
|
+
* https://github.com/FullStackRetrieval-com/RetrievalTutorials/blob/main/tutorials/LevelsOfTextSplitting/5_Levels_Of_Text_Splitting.ipynb
|
|
8
|
+
*/
|
|
9
|
+
function combineSentences(sentences, bufferSize = 1) {
|
|
10
|
+
for (let i = 0; i < sentences.length; i++) {
|
|
11
|
+
const sentence = sentences[i];
|
|
12
|
+
let combinedSentence = "";
|
|
13
|
+
for (let j = Math.max(0, i - bufferSize); j < i; j++) combinedSentence += sentences[j].sentence + " ";
|
|
14
|
+
combinedSentence += sentence.sentence;
|
|
15
|
+
for (let j = i + 1; j <= Math.min(sentences.length - 1, i + bufferSize); j++) combinedSentence += " " + sentences[j].sentence;
|
|
16
|
+
sentence.combinedSentence = combinedSentence.trim();
|
|
17
|
+
}
|
|
18
|
+
return sentences;
|
|
19
|
+
}
|
|
20
|
+
function cosineSimilarity(a, b) {
|
|
21
|
+
const dotProduct = a.reduce((sum, ai, i) => sum + ai * b[i], 0);
|
|
22
|
+
const magnitudeA = Math.sqrt(a.reduce((sum, ai) => sum + ai * ai, 0));
|
|
23
|
+
const magnitudeB = Math.sqrt(b.reduce((sum, bi) => sum + bi * bi, 0));
|
|
24
|
+
if (magnitudeA === 0 || magnitudeB === 0) return 0;
|
|
25
|
+
return dotProduct / (magnitudeA * magnitudeB);
|
|
26
|
+
}
|
|
27
|
+
function calculateCosineDistances(sentences) {
|
|
28
|
+
const distances = [];
|
|
29
|
+
for (let i = 0; i < sentences.length - 1; i++) {
|
|
30
|
+
const embeddingCurrent = sentences[i].combinedSentenceEmbedding;
|
|
31
|
+
const embeddingNext = sentences[i + 1].combinedSentenceEmbedding;
|
|
32
|
+
const distance = 1 - cosineSimilarity(embeddingCurrent, embeddingNext);
|
|
33
|
+
distances.push(distance);
|
|
34
|
+
}
|
|
35
|
+
return [distances, sentences];
|
|
36
|
+
}
|
|
37
|
+
const BREAKPOINT_DEFAULTS = {
|
|
38
|
+
percentile: 95,
|
|
39
|
+
standard_deviation: 3,
|
|
40
|
+
interquartile: 1.5,
|
|
41
|
+
gradient: 95
|
|
42
|
+
};
|
|
43
|
+
var SemanticTextSplitter = class extends _langchain_core_documents.BaseDocumentTransformer {
|
|
44
|
+
embeddings;
|
|
45
|
+
bufferSize;
|
|
46
|
+
addStartIndex;
|
|
47
|
+
breakpointThresholdType;
|
|
48
|
+
breakpointThresholdAmount;
|
|
49
|
+
numberOfChunks;
|
|
50
|
+
sentenceSplitRegex;
|
|
51
|
+
minChunkSize;
|
|
52
|
+
constructor(params) {
|
|
53
|
+
super();
|
|
54
|
+
this.embeddings = params.embeddings;
|
|
55
|
+
this.bufferSize = params.bufferSize ?? 1;
|
|
56
|
+
this.addStartIndex = params.addStartIndex ?? false;
|
|
57
|
+
this.breakpointThresholdType = params.breakpointThresholdType ?? "percentile";
|
|
58
|
+
this.numberOfChunks = params.numberOfChunks;
|
|
59
|
+
this.sentenceSplitRegex = params.sentenceSplitRegex ?? "(?<=[.?!])\\s+";
|
|
60
|
+
this.minChunkSize = params.minChunkSize;
|
|
61
|
+
if (params.breakpointThresholdAmount === void 0) this.breakpointThresholdAmount = BREAKPOINT_DEFAULTS[this.breakpointThresholdType];
|
|
62
|
+
else this.breakpointThresholdAmount = params.breakpointThresholdAmount;
|
|
63
|
+
}
|
|
64
|
+
calculateBreakpointThreshold(distances) {
|
|
65
|
+
if (this.breakpointThresholdType === "percentile") {
|
|
66
|
+
const sorted = [...distances].sort((a, b) => a - b);
|
|
67
|
+
const index = Math.ceil(this.breakpointThresholdAmount / 100 * sorted.length) - 1;
|
|
68
|
+
return [sorted[Math.max(0, index)], distances];
|
|
69
|
+
} else if (this.breakpointThresholdType === "standard_deviation") {
|
|
70
|
+
const mean = distances.reduce((sum, d) => sum + d, 0) / distances.length;
|
|
71
|
+
const variance = distances.reduce((sum, d) => sum + Math.pow(d - mean, 2), 0) / distances.length;
|
|
72
|
+
const stdDev = Math.sqrt(variance);
|
|
73
|
+
return [mean + this.breakpointThresholdAmount * stdDev, distances];
|
|
74
|
+
} else if (this.breakpointThresholdType === "interquartile") {
|
|
75
|
+
const sorted = [...distances].sort((a, b) => a - b);
|
|
76
|
+
const q1Index = Math.floor(.25 * sorted.length);
|
|
77
|
+
const q3Index = Math.floor(.75 * sorted.length);
|
|
78
|
+
const q1 = sorted[q1Index];
|
|
79
|
+
const iqr = sorted[q3Index] - q1;
|
|
80
|
+
return [distances.reduce((sum, d) => sum + d, 0) / distances.length + this.breakpointThresholdAmount * iqr, distances];
|
|
81
|
+
} else if (this.breakpointThresholdType === "gradient") {
|
|
82
|
+
const distanceGradient = [];
|
|
83
|
+
for (let i = 0; i < distances.length - 1; i++) distanceGradient.push(distances[i + 1] - distances[i]);
|
|
84
|
+
const sortedGradient = [...distanceGradient].sort((a, b) => a - b);
|
|
85
|
+
const index = Math.ceil(this.breakpointThresholdAmount / 100 * sortedGradient.length) - 1;
|
|
86
|
+
return [sortedGradient[Math.max(0, index)], distanceGradient];
|
|
87
|
+
} else throw new Error(`Got unexpected breakpointThresholdType: ${this.breakpointThresholdType}`);
|
|
88
|
+
}
|
|
89
|
+
thresholdFromClusters(distances) {
|
|
90
|
+
if (this.numberOfChunks === void 0) throw new Error("This should never be called if numberOfChunks is undefined.");
|
|
91
|
+
const x1 = distances.length;
|
|
92
|
+
const y1 = 0;
|
|
93
|
+
const x2 = 1;
|
|
94
|
+
const y2 = 100;
|
|
95
|
+
const x = Math.max(Math.min(this.numberOfChunks, x1), x2);
|
|
96
|
+
let y;
|
|
97
|
+
if (x2 === x1) y = y2;
|
|
98
|
+
else y = y1 + (y2 - y1) / (x2 - x1) * (x - x1);
|
|
99
|
+
y = Math.min(Math.max(y, 0), 100);
|
|
100
|
+
const sorted = [...distances].sort((a, b) => a - b);
|
|
101
|
+
const index = Math.ceil(y / 100 * sorted.length) - 1;
|
|
102
|
+
return sorted[Math.max(0, index)];
|
|
103
|
+
}
|
|
104
|
+
async calculateSentenceDistances(singleSentencesList) {
|
|
105
|
+
const sentencesWithCombined = combineSentences(singleSentencesList.map((sentence, index) => ({
|
|
106
|
+
sentence,
|
|
107
|
+
index
|
|
108
|
+
})), this.bufferSize);
|
|
109
|
+
const combinedSentences = sentencesWithCombined.map((s) => s.combinedSentence);
|
|
110
|
+
const embeddings = await this.embeddings.embedDocuments(combinedSentences);
|
|
111
|
+
for (let i = 0; i < sentencesWithCombined.length; i++) sentencesWithCombined[i].combinedSentenceEmbedding = embeddings[i];
|
|
112
|
+
return calculateCosineDistances(sentencesWithCombined);
|
|
113
|
+
}
|
|
114
|
+
getSingleSentencesList(text) {
|
|
115
|
+
return text.split(new RegExp(this.sentenceSplitRegex)).filter((sentence) => sentence.trim().length > 0);
|
|
116
|
+
}
|
|
117
|
+
async splitText(text) {
|
|
118
|
+
const singleSentencesList = this.getSingleSentencesList(text);
|
|
119
|
+
if (singleSentencesList.length === 1) return singleSentencesList;
|
|
120
|
+
if (this.breakpointThresholdType === "gradient" && singleSentencesList.length === 2) return singleSentencesList;
|
|
121
|
+
const [distances, sentences] = await this.calculateSentenceDistances(singleSentencesList);
|
|
122
|
+
let breakpointDistanceThreshold;
|
|
123
|
+
let breakpointArray;
|
|
124
|
+
if (this.numberOfChunks !== void 0) {
|
|
125
|
+
breakpointDistanceThreshold = this.thresholdFromClusters(distances);
|
|
126
|
+
breakpointArray = distances;
|
|
127
|
+
} else [breakpointDistanceThreshold, breakpointArray] = this.calculateBreakpointThreshold(distances);
|
|
128
|
+
const indicesAboveThresh = breakpointArray.map((x, i) => ({
|
|
129
|
+
value: x,
|
|
130
|
+
index: i
|
|
131
|
+
})).filter(({ value }) => value > breakpointDistanceThreshold).map(({ index }) => index);
|
|
132
|
+
const chunks = [];
|
|
133
|
+
let startIndex = 0;
|
|
134
|
+
for (const index of indicesAboveThresh) {
|
|
135
|
+
const endIndex = index;
|
|
136
|
+
const combinedText = sentences.slice(startIndex, endIndex + 1).map((d) => d.sentence).join(" ");
|
|
137
|
+
if (this.minChunkSize !== void 0 && combinedText.length < this.minChunkSize) continue;
|
|
138
|
+
chunks.push(combinedText);
|
|
139
|
+
startIndex = index + 1;
|
|
140
|
+
}
|
|
141
|
+
if (startIndex < sentences.length) {
|
|
142
|
+
const combinedText = sentences.slice(startIndex).map((d) => d.sentence).join(" ");
|
|
143
|
+
chunks.push(combinedText);
|
|
144
|
+
}
|
|
145
|
+
return chunks;
|
|
146
|
+
}
|
|
147
|
+
async createDocuments(texts, metadatas = []) {
|
|
148
|
+
const _metadatas = metadatas.length > 0 ? metadatas : texts.map(() => ({}));
|
|
149
|
+
const documents = [];
|
|
150
|
+
for (let i = 0; i < texts.length; i++) {
|
|
151
|
+
const text = texts[i];
|
|
152
|
+
let startIndex = 0;
|
|
153
|
+
for (const chunk of await this.splitText(text)) {
|
|
154
|
+
const metadata = { ..._metadatas[i] };
|
|
155
|
+
if (this.addStartIndex) metadata.start_index = startIndex;
|
|
156
|
+
const newDoc = new _langchain_core_documents.Document({
|
|
157
|
+
pageContent: chunk,
|
|
158
|
+
metadata
|
|
159
|
+
});
|
|
160
|
+
documents.push(newDoc);
|
|
161
|
+
startIndex += chunk.length;
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
return documents;
|
|
165
|
+
}
|
|
166
|
+
async splitDocuments(documents) {
|
|
167
|
+
const texts = documents.map((doc) => doc.pageContent);
|
|
168
|
+
const metadatas = documents.map((doc) => doc.metadata);
|
|
169
|
+
return this.createDocuments(texts, metadatas);
|
|
170
|
+
}
|
|
171
|
+
async transformDocuments(documents) {
|
|
172
|
+
return this.splitDocuments(documents);
|
|
173
|
+
}
|
|
174
|
+
};
|
|
175
|
+
//#endregion
|
|
176
|
+
exports.SemanticTextSplitter = SemanticTextSplitter;
|
|
177
|
+
exports.calculateCosineDistances = calculateCosineDistances;
|
|
178
|
+
|
|
179
|
+
//# sourceMappingURL=semantic_text_splitter.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"semantic_text_splitter.cjs","names":["BaseDocumentTransformer","Document"],"sources":["../src/semantic_text_splitter.ts"],"sourcesContent":["/**\r\n * Experimental semantic text splitter based on semantic similarity.\r\n * \r\n * Inspired by Greg Kamradt's semantic chunking approach:\r\n * https://github.com/FullStackRetrieval-com/RetrievalTutorials/blob/main/tutorials/LevelsOfTextSplitting/5_Levels_Of_Text_Splitting.ipynb\r\n */\r\nimport { Document, BaseDocumentTransformer } from \"@langchain/core/documents\";\r\nimport { Embeddings } from \"@langchain/core/embeddings\";\r\n\r\ninterface SentenceDict {\r\n sentence: string;\r\n index: number;\r\n combinedSentence?: string;\r\n combinedSentenceEmbedding?: number[];\r\n}\r\n\r\nfunction combineSentences(sentences: SentenceDict[], bufferSize: number = 1): SentenceDict[] {\r\n // Go through each sentence dict\r\n for (let i = 0; i < sentences.length; i++) {\r\n const sentence = sentences[i];\r\n \r\n // Create the combined sentence by combining the sentences within the buffer\r\n let combinedSentence = \"\";\r\n \r\n // Add sentences before the current one\r\n for (let j = Math.max(0, i - bufferSize); j < i; j++) {\r\n combinedSentence += sentences[j].sentence + \" \";\r\n }\r\n \r\n // Add the current sentence\r\n combinedSentence += sentence.sentence;\r\n \r\n // Add sentences after the current one\r\n for (let j = i + 1; j <= Math.min(sentences.length - 1, i + bufferSize); j++) {\r\n combinedSentence += \" \" + sentences[j].sentence;\r\n }\r\n \r\n // Assign the combined sentence to the dict\r\n sentence.combinedSentence = combinedSentence.trim();\r\n }\r\n \r\n return sentences;\r\n}\r\n\r\nfunction cosineSimilarity(a: number[], b: number[]): number {\r\n const dotProduct = a.reduce((sum, ai, i) => sum + ai * b[i], 0);\r\n const magnitudeA = Math.sqrt(a.reduce((sum, ai) => sum + ai * ai, 0));\r\n const magnitudeB = Math.sqrt(b.reduce((sum, bi) => sum + bi * bi, 0));\r\n \r\n if (magnitudeA === 0 || magnitudeB === 0) {\r\n return 0;\r\n }\r\n \r\n return dotProduct / (magnitudeA * magnitudeB);\r\n}\r\n\r\nexport function calculateCosineDistances(sentences: SentenceDict[]): [number[], SentenceDict[]] {\r\n const distances: number[] = [];\r\n \r\n for (let i = 0; i < sentences.length - 1; i++) {\r\n const embeddingCurrent = sentences[i].combinedSentenceEmbedding!;\r\n const embeddingNext = sentences[i + 1].combinedSentenceEmbedding!;\r\n \r\n // Calculate cosine similarity\r\n const similarity = cosineSimilarity(embeddingCurrent, embeddingNext);\r\n \r\n // Convert to cosine distance (1 - cosine similarity)\r\n const distance = 1 - similarity;\r\n distances.push(distance);\r\n }\r\n \r\n return [distances, sentences];\r\n}\r\n\r\ntype BreakpointThresholdType = \"percentile\" | \"standard_deviation\" | \"interquartile\" | \"gradient\";\r\n\r\nconst BREAKPOINT_DEFAULTS: Record<BreakpointThresholdType, number> = {\r\n percentile: 95,\r\n standard_deviation: 3,\r\n interquartile: 1.5,\r\n gradient: 95,\r\n};\r\n\r\nexport interface SemanticTextSplitterParams {\r\n embeddings: Embeddings;\r\n bufferSize?: number;\r\n addStartIndex?: boolean;\r\n breakpointThresholdType?: BreakpointThresholdType;\r\n breakpointThresholdAmount?: number;\r\n numberOfChunks?: number;\r\n sentenceSplitRegex?: string;\r\n minChunkSize?: number;\r\n}\r\n\r\nexport class SemanticTextSplitter extends BaseDocumentTransformer {\r\n private embeddings: Embeddings;\r\n private bufferSize: number;\r\n private addStartIndex: boolean;\r\n private breakpointThresholdType: BreakpointThresholdType;\r\n private breakpointThresholdAmount: number;\r\n private numberOfChunks?: number;\r\n private sentenceSplitRegex: string;\r\n private minChunkSize?: number;\r\n\r\n constructor(params: SemanticTextSplitterParams) {\r\n super();\r\n this.embeddings = params.embeddings;\r\n this.bufferSize = params.bufferSize ?? 1;\r\n this.addStartIndex = params.addStartIndex ?? false;\r\n this.breakpointThresholdType = params.breakpointThresholdType ?? \"percentile\";\r\n this.numberOfChunks = params.numberOfChunks;\r\n this.sentenceSplitRegex = params.sentenceSplitRegex ?? \"(?<=[.?!])\\\\s+\";\r\n this.minChunkSize = params.minChunkSize;\r\n \r\n if (params.breakpointThresholdAmount === undefined) {\r\n this.breakpointThresholdAmount = BREAKPOINT_DEFAULTS[this.breakpointThresholdType];\r\n } else {\r\n this.breakpointThresholdAmount = params.breakpointThresholdAmount;\r\n }\r\n }\r\n\r\n private calculateBreakpointThreshold(distances: number[]): [number, number[]] {\r\n if (this.breakpointThresholdType === \"percentile\") {\r\n const sorted = [...distances].sort((a, b) => a - b);\r\n const index = Math.ceil((this.breakpointThresholdAmount / 100) * sorted.length) - 1;\r\n return [sorted[Math.max(0, index)], distances];\r\n } else if (this.breakpointThresholdType === \"standard_deviation\") {\r\n const mean = distances.reduce((sum, d) => sum + d, 0) / distances.length;\r\n const variance = distances.reduce((sum, d) => sum + Math.pow(d - mean, 2), 0) / distances.length;\r\n const stdDev = Math.sqrt(variance);\r\n return [mean + this.breakpointThresholdAmount * stdDev, distances];\r\n } else if (this.breakpointThresholdType === \"interquartile\") {\r\n const sorted = [...distances].sort((a, b) => a - b);\r\n const q1Index = Math.floor(0.25 * sorted.length);\r\n const q3Index = Math.floor(0.75 * sorted.length);\r\n const q1 = sorted[q1Index];\r\n const q3 = sorted[q3Index];\r\n const iqr = q3 - q1;\r\n const mean = distances.reduce((sum, d) => sum + d, 0) / distances.length;\r\n return [mean + this.breakpointThresholdAmount * iqr, distances];\r\n } else if (this.breakpointThresholdType === \"gradient\") {\r\n const distanceGradient: number[] = [];\r\n for (let i = 0; i < distances.length - 1; i++) {\r\n distanceGradient.push(distances[i + 1] - distances[i]);\r\n }\r\n const sortedGradient = [...distanceGradient].sort((a, b) => a - b);\r\n const index = Math.ceil((this.breakpointThresholdAmount / 100) * sortedGradient.length) - 1;\r\n return [sortedGradient[Math.max(0, index)], distanceGradient];\r\n } else {\r\n throw new Error(`Got unexpected breakpointThresholdType: ${this.breakpointThresholdType}`);\r\n }\r\n }\r\n\r\n private thresholdFromClusters(distances: number[]): number {\r\n if (this.numberOfChunks === undefined) {\r\n throw new Error(\"This should never be called if numberOfChunks is undefined.\");\r\n }\r\n \r\n const x1 = distances.length;\r\n const y1 = 0.0;\r\n const x2 = 1.0;\r\n const y2 = 100.0;\r\n \r\n const x = Math.max(Math.min(this.numberOfChunks, x1), x2);\r\n \r\n let y: number;\r\n if (x2 === x1) {\r\n y = y2;\r\n } else {\r\n y = y1 + ((y2 - y1) / (x2 - x1)) * (x - x1);\r\n }\r\n \r\n y = Math.min(Math.max(y, 0), 100);\r\n \r\n const sorted = [...distances].sort((a, b) => a - b);\r\n const index = Math.ceil((y / 100) * sorted.length) - 1;\r\n return sorted[Math.max(0, index)];\r\n }\r\n\r\n private async calculateSentenceDistances(singleSentencesList: string[]): Promise<[number[], SentenceDict[]]> {\r\n const sentences: SentenceDict[] = singleSentencesList.map((sentence, index) => ({\r\n sentence,\r\n index,\r\n }));\r\n\r\n const sentencesWithCombined = combineSentences(sentences, this.bufferSize);\r\n \r\n const combinedSentences = sentencesWithCombined.map(s => s.combinedSentence!);\r\n const embeddings = await this.embeddings.embedDocuments(combinedSentences);\r\n \r\n for (let i = 0; i < sentencesWithCombined.length; i++) {\r\n sentencesWithCombined[i].combinedSentenceEmbedding = embeddings[i];\r\n }\r\n\r\n return calculateCosineDistances(sentencesWithCombined);\r\n }\r\n\r\n private getSingleSentencesList(text: string): string[] {\r\n return text.split(new RegExp(this.sentenceSplitRegex)).filter(sentence => sentence.trim().length > 0);\r\n }\r\n\r\n async splitText(text: string): Promise<string[]> {\r\n const singleSentencesList = this.getSingleSentencesList(text);\r\n\r\n if (singleSentencesList.length === 1) {\r\n return singleSentencesList;\r\n }\r\n\r\n if (this.breakpointThresholdType === \"gradient\" && singleSentencesList.length === 2) {\r\n return singleSentencesList;\r\n }\r\n\r\n const [distances, sentences] = await this.calculateSentenceDistances(singleSentencesList);\r\n\r\n let breakpointDistanceThreshold: number;\r\n let breakpointArray: number[];\r\n\r\n if (this.numberOfChunks !== undefined) {\r\n breakpointDistanceThreshold = this.thresholdFromClusters(distances);\r\n breakpointArray = distances;\r\n } else {\r\n [breakpointDistanceThreshold, breakpointArray] = this.calculateBreakpointThreshold(distances);\r\n }\r\n\r\n const indicesAboveThresh = breakpointArray\r\n .map((x, i) => ({ value: x, index: i }))\r\n .filter(({ value }) => value > breakpointDistanceThreshold)\r\n .map(({ index }) => index);\r\n\r\n const chunks: string[] = [];\r\n let startIndex = 0;\r\n\r\n for (const index of indicesAboveThresh) {\r\n const endIndex = index;\r\n const group = sentences.slice(startIndex, endIndex + 1);\r\n const combinedText = group.map((d: SentenceDict) => d.sentence).join(\" \");\r\n\r\n if (this.minChunkSize !== undefined && combinedText.length < this.minChunkSize) {\r\n continue;\r\n }\r\n \r\n chunks.push(combinedText);\r\n startIndex = index + 1;\r\n }\r\n\r\n if (startIndex < sentences.length) {\r\n const combinedText = sentences.slice(startIndex).map((d: SentenceDict) => d.sentence).join(\" \");\r\n chunks.push(combinedText);\r\n }\r\n\r\n return chunks;\r\n }\r\n\r\n async createDocuments(\r\n texts: string[],\r\n metadatas: Record<string, any>[] = []\r\n ): Promise<Document[]> {\r\n const _metadatas = metadatas.length > 0 ? metadatas : texts.map(() => (<Record<string, any>>{}));\r\n const documents: Document[] = [];\r\n \r\n for (let i = 0; i < texts.length; i++) {\r\n const text = texts[i];\r\n let startIndex = 0;\r\n \r\n for (const chunk of await this.splitText(text)) {\r\n const metadata = { ..._metadatas[i] };\r\n if (this.addStartIndex) {\r\n metadata.start_index = startIndex;\r\n }\r\n \r\n const newDoc = new Document({\r\n pageContent: chunk,\r\n metadata,\r\n });\r\n \r\n documents.push(newDoc);\r\n startIndex += chunk.length;\r\n }\r\n }\r\n \r\n return documents;\r\n }\r\n\r\n async splitDocuments(documents: Document[]): Promise<Document[]> {\r\n const texts = documents.map(doc => doc.pageContent);\r\n const metadatas = documents.map(doc => doc.metadata);\r\n return this.createDocuments(texts, metadatas);\r\n }\r\n\r\n async transformDocuments(documents: Document[]): Promise<Document[]> {\r\n return this.splitDocuments(documents);\r\n }\r\n}"],"mappings":";;;;;;;;AAgBA,SAAS,iBAAiB,WAA2B,aAAqB,GAAmB;AAE3F,MAAK,IAAI,IAAI,GAAG,IAAI,UAAU,QAAQ,KAAK;EACzC,MAAM,WAAW,UAAU;EAG3B,IAAI,mBAAmB;AAGvB,OAAK,IAAI,IAAI,KAAK,IAAI,GAAG,IAAI,WAAW,EAAE,IAAI,GAAG,IAC/C,qBAAoB,UAAU,GAAG,WAAW;AAI9C,sBAAoB,SAAS;AAG7B,OAAK,IAAI,IAAI,IAAI,GAAG,KAAK,KAAK,IAAI,UAAU,SAAS,GAAG,IAAI,WAAW,EAAE,IACvE,qBAAoB,MAAM,UAAU,GAAG;AAIzC,WAAS,mBAAmB,iBAAiB,MAAM;;AAGrD,QAAO;;AAGT,SAAS,iBAAiB,GAAa,GAAqB;CAC1D,MAAM,aAAa,EAAE,QAAQ,KAAK,IAAI,MAAM,MAAM,KAAK,EAAE,IAAI,EAAE;CAC/D,MAAM,aAAa,KAAK,KAAK,EAAE,QAAQ,KAAK,OAAO,MAAM,KAAK,IAAI,EAAE,CAAC;CACrE,MAAM,aAAa,KAAK,KAAK,EAAE,QAAQ,KAAK,OAAO,MAAM,KAAK,IAAI,EAAE,CAAC;AAErE,KAAI,eAAe,KAAK,eAAe,EACrC,QAAO;AAGT,QAAO,cAAc,aAAa;;AAGpC,SAAgB,yBAAyB,WAAuD;CAC9F,MAAM,YAAsB,EAAE;AAE9B,MAAK,IAAI,IAAI,GAAG,IAAI,UAAU,SAAS,GAAG,KAAK;EAC7C,MAAM,mBAAmB,UAAU,GAAG;EACtC,MAAM,gBAAgB,UAAU,IAAI,GAAG;EAMvC,MAAM,WAAW,IAHE,iBAAiB,kBAAkB,cAAc;AAIpE,YAAU,KAAK,SAAS;;AAG1B,QAAO,CAAC,WAAW,UAAU;;AAK/B,MAAM,sBAA+D;CACnE,YAAY;CACZ,oBAAoB;CACpB,eAAe;CACf,UAAU;CACX;AAaD,IAAa,uBAAb,cAA0CA,0BAAAA,wBAAwB;CAChE;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CAEA,YAAY,QAAoC;AAC9C,SAAO;AACP,OAAK,aAAa,OAAO;AACzB,OAAK,aAAa,OAAO,cAAc;AACvC,OAAK,gBAAgB,OAAO,iBAAiB;AAC7C,OAAK,0BAA0B,OAAO,2BAA2B;AACjE,OAAK,iBAAiB,OAAO;AAC7B,OAAK,qBAAqB,OAAO,sBAAsB;AACvD,OAAK,eAAe,OAAO;AAE3B,MAAI,OAAO,8BAA8B,KAAA,EACvC,MAAK,4BAA4B,oBAAoB,KAAK;MAE1D,MAAK,4BAA4B,OAAO;;CAI5C,6BAAqC,WAAyC;AAC5E,MAAI,KAAK,4BAA4B,cAAc;GACjD,MAAM,SAAS,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE;GACnD,MAAM,QAAQ,KAAK,KAAM,KAAK,4BAA4B,MAAO,OAAO,OAAO,GAAG;AAClF,UAAO,CAAC,OAAO,KAAK,IAAI,GAAG,MAAM,GAAG,UAAU;aACrC,KAAK,4BAA4B,sBAAsB;GAChE,MAAM,OAAO,UAAU,QAAQ,KAAK,MAAM,MAAM,GAAG,EAAE,GAAG,UAAU;GAClE,MAAM,WAAW,UAAU,QAAQ,KAAK,MAAM,MAAM,KAAK,IAAI,IAAI,MAAM,EAAE,EAAE,EAAE,GAAG,UAAU;GAC1F,MAAM,SAAS,KAAK,KAAK,SAAS;AAClC,UAAO,CAAC,OAAO,KAAK,4BAA4B,QAAQ,UAAU;aACzD,KAAK,4BAA4B,iBAAiB;GAC3D,MAAM,SAAS,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE;GACnD,MAAM,UAAU,KAAK,MAAM,MAAO,OAAO,OAAO;GAChD,MAAM,UAAU,KAAK,MAAM,MAAO,OAAO,OAAO;GAChD,MAAM,KAAK,OAAO;GAElB,MAAM,MADK,OAAO,WACD;AAEjB,UAAO,CADM,UAAU,QAAQ,KAAK,MAAM,MAAM,GAAG,EAAE,GAAG,UAAU,SACnD,KAAK,4BAA4B,KAAK,UAAU;aACtD,KAAK,4BAA4B,YAAY;GACtD,MAAM,mBAA6B,EAAE;AACrC,QAAK,IAAI,IAAI,GAAG,IAAI,UAAU,SAAS,GAAG,IACxC,kBAAiB,KAAK,UAAU,IAAI,KAAK,UAAU,GAAG;GAExD,MAAM,iBAAiB,CAAC,GAAG,iBAAiB,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE;GAClE,MAAM,QAAQ,KAAK,KAAM,KAAK,4BAA4B,MAAO,eAAe,OAAO,GAAG;AAC1F,UAAO,CAAC,eAAe,KAAK,IAAI,GAAG,MAAM,GAAG,iBAAiB;QAE7D,OAAM,IAAI,MAAM,2CAA2C,KAAK,0BAA0B;;CAI9F,sBAA8B,WAA6B;AACzD,MAAI,KAAK,mBAAmB,KAAA,EAC1B,OAAM,IAAI,MAAM,8DAA8D;EAGhF,MAAM,KAAK,UAAU;EACrB,MAAM,KAAK;EACX,MAAM,KAAK;EACX,MAAM,KAAK;EAEX,MAAM,IAAI,KAAK,IAAI,KAAK,IAAI,KAAK,gBAAgB,GAAG,EAAE,GAAG;EAEzD,IAAI;AACJ,MAAI,OAAO,GACT,KAAI;MAEJ,KAAI,MAAO,KAAK,OAAO,KAAK,OAAQ,IAAI;AAG1C,MAAI,KAAK,IAAI,KAAK,IAAI,GAAG,EAAE,EAAE,IAAI;EAEjC,MAAM,SAAS,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE;EACnD,MAAM,QAAQ,KAAK,KAAM,IAAI,MAAO,OAAO,OAAO,GAAG;AACrD,SAAO,OAAO,KAAK,IAAI,GAAG,MAAM;;CAGlC,MAAc,2BAA2B,qBAAoE;EAM3G,MAAM,wBAAwB,iBALI,oBAAoB,KAAK,UAAU,WAAW;GAC9E;GACA;GACD,EAAE,EAEuD,KAAK,WAAW;EAE1E,MAAM,oBAAoB,sBAAsB,KAAI,MAAK,EAAE,iBAAkB;EAC7E,MAAM,aAAa,MAAM,KAAK,WAAW,eAAe,kBAAkB;AAE1E,OAAK,IAAI,IAAI,GAAG,IAAI,sBAAsB,QAAQ,IAChD,uBAAsB,GAAG,4BAA4B,WAAW;AAGlE,SAAO,yBAAyB,sBAAsB;;CAGxD,uBAA+B,MAAwB;AACrD,SAAO,KAAK,MAAM,IAAI,OAAO,KAAK,mBAAmB,CAAC,CAAC,QAAO,aAAY,SAAS,MAAM,CAAC,SAAS,EAAE;;CAGvG,MAAM,UAAU,MAAiC;EAC/C,MAAM,sBAAsB,KAAK,uBAAuB,KAAK;AAE7D,MAAI,oBAAoB,WAAW,EACjC,QAAO;AAGT,MAAI,KAAK,4BAA4B,cAAc,oBAAoB,WAAW,EAChF,QAAO;EAGT,MAAM,CAAC,WAAW,aAAa,MAAM,KAAK,2BAA2B,oBAAoB;EAEzF,IAAI;EACJ,IAAI;AAEJ,MAAI,KAAK,mBAAmB,KAAA,GAAW;AACrC,iCAA8B,KAAK,sBAAsB,UAAU;AACnE,qBAAkB;QAElB,EAAC,6BAA6B,mBAAmB,KAAK,6BAA6B,UAAU;EAG/F,MAAM,qBAAqB,gBACxB,KAAK,GAAG,OAAO;GAAE,OAAO;GAAG,OAAO;GAAG,EAAE,CACvC,QAAQ,EAAE,YAAY,QAAQ,4BAA4B,CAC1D,KAAK,EAAE,YAAY,MAAM;EAE5B,MAAM,SAAmB,EAAE;EAC3B,IAAI,aAAa;AAEjB,OAAK,MAAM,SAAS,oBAAoB;GACtC,MAAM,WAAW;GAEjB,MAAM,eADQ,UAAU,MAAM,YAAY,WAAW,EAAE,CAC5B,KAAK,MAAoB,EAAE,SAAS,CAAC,KAAK,IAAI;AAEzE,OAAI,KAAK,iBAAiB,KAAA,KAAa,aAAa,SAAS,KAAK,aAChE;AAGF,UAAO,KAAK,aAAa;AACzB,gBAAa,QAAQ;;AAGvB,MAAI,aAAa,UAAU,QAAQ;GACjC,MAAM,eAAe,UAAU,MAAM,WAAW,CAAC,KAAK,MAAoB,EAAE,SAAS,CAAC,KAAK,IAAI;AAC/F,UAAO,KAAK,aAAa;;AAG3B,SAAO;;CAGT,MAAM,gBACJ,OACA,YAAmC,EAAE,EAChB;EACrB,MAAM,aAAa,UAAU,SAAS,IAAI,YAAY,MAAM,WAAgC,EAAE,EAAE;EAChG,MAAM,YAAwB,EAAE;AAEhC,OAAK,IAAI,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK;GACrC,MAAM,OAAO,MAAM;GACnB,IAAI,aAAa;AAEjB,QAAK,MAAM,SAAS,MAAM,KAAK,UAAU,KAAK,EAAE;IAC9C,MAAM,WAAW,EAAE,GAAG,WAAW,IAAI;AACrC,QAAI,KAAK,cACP,UAAS,cAAc;IAGzB,MAAM,SAAS,IAAIC,0BAAAA,SAAS;KAC1B,aAAa;KACb;KACD,CAAC;AAEF,cAAU,KAAK,OAAO;AACtB,kBAAc,MAAM;;;AAIxB,SAAO;;CAGT,MAAM,eAAe,WAA4C;EAC/D,MAAM,QAAQ,UAAU,KAAI,QAAO,IAAI,YAAY;EACnD,MAAM,YAAY,UAAU,KAAI,QAAO,IAAI,SAAS;AACpD,SAAO,KAAK,gBAAgB,OAAO,UAAU;;CAG/C,MAAM,mBAAmB,WAA4C;AACnE,SAAO,KAAK,eAAe,UAAU"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import { BaseDocumentTransformer, Document } from "@langchain/core/documents";
|
|
2
|
+
import { Embeddings } from "@langchain/core/embeddings";
|
|
3
|
+
|
|
4
|
+
//#region src/semantic_text_splitter.d.ts
|
|
5
|
+
interface SentenceDict {
|
|
6
|
+
sentence: string;
|
|
7
|
+
index: number;
|
|
8
|
+
combinedSentence?: string;
|
|
9
|
+
combinedSentenceEmbedding?: number[];
|
|
10
|
+
}
|
|
11
|
+
declare function calculateCosineDistances(sentences: SentenceDict[]): [number[], SentenceDict[]];
|
|
12
|
+
type BreakpointThresholdType = "percentile" | "standard_deviation" | "interquartile" | "gradient";
|
|
13
|
+
interface SemanticTextSplitterParams {
|
|
14
|
+
embeddings: Embeddings;
|
|
15
|
+
bufferSize?: number;
|
|
16
|
+
addStartIndex?: boolean;
|
|
17
|
+
breakpointThresholdType?: BreakpointThresholdType;
|
|
18
|
+
breakpointThresholdAmount?: number;
|
|
19
|
+
numberOfChunks?: number;
|
|
20
|
+
sentenceSplitRegex?: string;
|
|
21
|
+
minChunkSize?: number;
|
|
22
|
+
}
|
|
23
|
+
declare class SemanticTextSplitter extends BaseDocumentTransformer {
|
|
24
|
+
private embeddings;
|
|
25
|
+
private bufferSize;
|
|
26
|
+
private addStartIndex;
|
|
27
|
+
private breakpointThresholdType;
|
|
28
|
+
private breakpointThresholdAmount;
|
|
29
|
+
private numberOfChunks?;
|
|
30
|
+
private sentenceSplitRegex;
|
|
31
|
+
private minChunkSize?;
|
|
32
|
+
constructor(params: SemanticTextSplitterParams);
|
|
33
|
+
private calculateBreakpointThreshold;
|
|
34
|
+
private thresholdFromClusters;
|
|
35
|
+
private calculateSentenceDistances;
|
|
36
|
+
private getSingleSentencesList;
|
|
37
|
+
splitText(text: string): Promise<string[]>;
|
|
38
|
+
createDocuments(texts: string[], metadatas?: Record<string, any>[]): Promise<Document[]>;
|
|
39
|
+
splitDocuments(documents: Document[]): Promise<Document[]>;
|
|
40
|
+
transformDocuments(documents: Document[]): Promise<Document[]>;
|
|
41
|
+
}
|
|
42
|
+
//#endregion
|
|
43
|
+
export { SemanticTextSplitter, SemanticTextSplitterParams, calculateCosineDistances };
|
|
44
|
+
//# sourceMappingURL=semantic_text_splitter.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"semantic_text_splitter.d.cts","names":[],"sources":["../src/semantic_text_splitter.ts"],"mappings":";;;;UASU,YAAA;EACR,QAAA;EACA,KAAA;EACA,gBAAA;EACA,yBAAA;AAAA;AAAA,iBA2Cc,wBAAA,CAAyB,SAAA,EAAW,YAAA,gBAA4B,YAAA;AAAA,KAkB3E,uBAAA;AAAA,UASY,0BAAA;EACf,UAAA,EAAY,UAAA;EACZ,UAAA;EACA,aAAA;EACA,uBAAA,GAA0B,uBAAA;EAC1B,yBAAA;EACA,cAAA;EACA,kBAAA;EACA,YAAA;AAAA;AAAA,cAGW,oBAAA,SAA6B,uBAAA;EAAA,QAChC,UAAA;EAAA,QACA,UAAA;EAAA,QACA,aAAA;EAAA,QACA,uBAAA;EAAA,QACA,yBAAA;EAAA,QACA,cAAA;EAAA,QACA,kBAAA;EAAA,QACA,YAAA;EAER,WAAA,CAAY,MAAA,EAAQ,0BAAA;EAAA,QAiBZ,4BAAA;EAAA,QAgCA,qBAAA;EAAA,QA0BM,0BAAA;EAAA,QAkBN,sBAAA;EAIF,SAAA,CAAU,IAAA,WAAe,OAAA;EAoDzB,eAAA,CACJ,KAAA,YACA,SAAA,GAAW,MAAA,kBACV,OAAA,CAAQ,QAAA;EA2BL,cAAA,CAAe,SAAA,EAAW,QAAA,KAAa,OAAA,CAAQ,QAAA;EAM/C,kBAAA,CAAmB,SAAA,EAAW,QAAA,KAAa,OAAA,CAAQ,QAAA;AAAA"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import { BaseDocumentTransformer, Document } from "@langchain/core/documents";
|
|
2
|
+
import { Embeddings } from "@langchain/core/embeddings";
|
|
3
|
+
|
|
4
|
+
//#region src/semantic_text_splitter.d.ts
|
|
5
|
+
interface SentenceDict {
|
|
6
|
+
sentence: string;
|
|
7
|
+
index: number;
|
|
8
|
+
combinedSentence?: string;
|
|
9
|
+
combinedSentenceEmbedding?: number[];
|
|
10
|
+
}
|
|
11
|
+
declare function calculateCosineDistances(sentences: SentenceDict[]): [number[], SentenceDict[]];
|
|
12
|
+
type BreakpointThresholdType = "percentile" | "standard_deviation" | "interquartile" | "gradient";
|
|
13
|
+
interface SemanticTextSplitterParams {
|
|
14
|
+
embeddings: Embeddings;
|
|
15
|
+
bufferSize?: number;
|
|
16
|
+
addStartIndex?: boolean;
|
|
17
|
+
breakpointThresholdType?: BreakpointThresholdType;
|
|
18
|
+
breakpointThresholdAmount?: number;
|
|
19
|
+
numberOfChunks?: number;
|
|
20
|
+
sentenceSplitRegex?: string;
|
|
21
|
+
minChunkSize?: number;
|
|
22
|
+
}
|
|
23
|
+
declare class SemanticTextSplitter extends BaseDocumentTransformer {
|
|
24
|
+
private embeddings;
|
|
25
|
+
private bufferSize;
|
|
26
|
+
private addStartIndex;
|
|
27
|
+
private breakpointThresholdType;
|
|
28
|
+
private breakpointThresholdAmount;
|
|
29
|
+
private numberOfChunks?;
|
|
30
|
+
private sentenceSplitRegex;
|
|
31
|
+
private minChunkSize?;
|
|
32
|
+
constructor(params: SemanticTextSplitterParams);
|
|
33
|
+
private calculateBreakpointThreshold;
|
|
34
|
+
private thresholdFromClusters;
|
|
35
|
+
private calculateSentenceDistances;
|
|
36
|
+
private getSingleSentencesList;
|
|
37
|
+
splitText(text: string): Promise<string[]>;
|
|
38
|
+
createDocuments(texts: string[], metadatas?: Record<string, any>[]): Promise<Document[]>;
|
|
39
|
+
splitDocuments(documents: Document[]): Promise<Document[]>;
|
|
40
|
+
transformDocuments(documents: Document[]): Promise<Document[]>;
|
|
41
|
+
}
|
|
42
|
+
//#endregion
|
|
43
|
+
export { SemanticTextSplitter, SemanticTextSplitterParams, calculateCosineDistances };
|
|
44
|
+
//# sourceMappingURL=semantic_text_splitter.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"semantic_text_splitter.d.ts","names":[],"sources":["../src/semantic_text_splitter.ts"],"mappings":";;;;UASU,YAAA;EACR,QAAA;EACA,KAAA;EACA,gBAAA;EACA,yBAAA;AAAA;AAAA,iBA2Cc,wBAAA,CAAyB,SAAA,EAAW,YAAA,gBAA4B,YAAA;AAAA,KAkB3E,uBAAA;AAAA,UASY,0BAAA;EACf,UAAA,EAAY,UAAA;EACZ,UAAA;EACA,aAAA;EACA,uBAAA,GAA0B,uBAAA;EAC1B,yBAAA;EACA,cAAA;EACA,kBAAA;EACA,YAAA;AAAA;AAAA,cAGW,oBAAA,SAA6B,uBAAA;EAAA,QAChC,UAAA;EAAA,QACA,UAAA;EAAA,QACA,aAAA;EAAA,QACA,uBAAA;EAAA,QACA,yBAAA;EAAA,QACA,cAAA;EAAA,QACA,kBAAA;EAAA,QACA,YAAA;EAER,WAAA,CAAY,MAAA,EAAQ,0BAAA;EAAA,QAiBZ,4BAAA;EAAA,QAgCA,qBAAA;EAAA,QA0BM,0BAAA;EAAA,QAkBN,sBAAA;EAIF,SAAA,CAAU,IAAA,WAAe,OAAA;EAoDzB,eAAA,CACJ,KAAA,YACA,SAAA,GAAW,MAAA,kBACV,OAAA,CAAQ,QAAA;EA2BL,cAAA,CAAe,SAAA,EAAW,QAAA,KAAa,OAAA,CAAQ,QAAA;EAM/C,kBAAA,CAAmB,SAAA,EAAW,QAAA,KAAa,OAAA,CAAQ,QAAA;AAAA"}
|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
import { BaseDocumentTransformer, Document } from "@langchain/core/documents";
|
|
2
|
+
//#region src/semantic_text_splitter.ts
|
|
3
|
+
/**
|
|
4
|
+
* Experimental semantic text splitter based on semantic similarity.
|
|
5
|
+
*
|
|
6
|
+
* Inspired by Greg Kamradt's semantic chunking approach:
|
|
7
|
+
* https://github.com/FullStackRetrieval-com/RetrievalTutorials/blob/main/tutorials/LevelsOfTextSplitting/5_Levels_Of_Text_Splitting.ipynb
|
|
8
|
+
*/
|
|
9
|
+
function combineSentences(sentences, bufferSize = 1) {
|
|
10
|
+
for (let i = 0; i < sentences.length; i++) {
|
|
11
|
+
const sentence = sentences[i];
|
|
12
|
+
let combinedSentence = "";
|
|
13
|
+
for (let j = Math.max(0, i - bufferSize); j < i; j++) combinedSentence += sentences[j].sentence + " ";
|
|
14
|
+
combinedSentence += sentence.sentence;
|
|
15
|
+
for (let j = i + 1; j <= Math.min(sentences.length - 1, i + bufferSize); j++) combinedSentence += " " + sentences[j].sentence;
|
|
16
|
+
sentence.combinedSentence = combinedSentence.trim();
|
|
17
|
+
}
|
|
18
|
+
return sentences;
|
|
19
|
+
}
|
|
20
|
+
function cosineSimilarity(a, b) {
|
|
21
|
+
const dotProduct = a.reduce((sum, ai, i) => sum + ai * b[i], 0);
|
|
22
|
+
const magnitudeA = Math.sqrt(a.reduce((sum, ai) => sum + ai * ai, 0));
|
|
23
|
+
const magnitudeB = Math.sqrt(b.reduce((sum, bi) => sum + bi * bi, 0));
|
|
24
|
+
if (magnitudeA === 0 || magnitudeB === 0) return 0;
|
|
25
|
+
return dotProduct / (magnitudeA * magnitudeB);
|
|
26
|
+
}
|
|
27
|
+
function calculateCosineDistances(sentences) {
|
|
28
|
+
const distances = [];
|
|
29
|
+
for (let i = 0; i < sentences.length - 1; i++) {
|
|
30
|
+
const embeddingCurrent = sentences[i].combinedSentenceEmbedding;
|
|
31
|
+
const embeddingNext = sentences[i + 1].combinedSentenceEmbedding;
|
|
32
|
+
const distance = 1 - cosineSimilarity(embeddingCurrent, embeddingNext);
|
|
33
|
+
distances.push(distance);
|
|
34
|
+
}
|
|
35
|
+
return [distances, sentences];
|
|
36
|
+
}
|
|
37
|
+
const BREAKPOINT_DEFAULTS = {
|
|
38
|
+
percentile: 95,
|
|
39
|
+
standard_deviation: 3,
|
|
40
|
+
interquartile: 1.5,
|
|
41
|
+
gradient: 95
|
|
42
|
+
};
|
|
43
|
+
var SemanticTextSplitter = class extends BaseDocumentTransformer {
|
|
44
|
+
embeddings;
|
|
45
|
+
bufferSize;
|
|
46
|
+
addStartIndex;
|
|
47
|
+
breakpointThresholdType;
|
|
48
|
+
breakpointThresholdAmount;
|
|
49
|
+
numberOfChunks;
|
|
50
|
+
sentenceSplitRegex;
|
|
51
|
+
minChunkSize;
|
|
52
|
+
constructor(params) {
|
|
53
|
+
super();
|
|
54
|
+
this.embeddings = params.embeddings;
|
|
55
|
+
this.bufferSize = params.bufferSize ?? 1;
|
|
56
|
+
this.addStartIndex = params.addStartIndex ?? false;
|
|
57
|
+
this.breakpointThresholdType = params.breakpointThresholdType ?? "percentile";
|
|
58
|
+
this.numberOfChunks = params.numberOfChunks;
|
|
59
|
+
this.sentenceSplitRegex = params.sentenceSplitRegex ?? "(?<=[.?!])\\s+";
|
|
60
|
+
this.minChunkSize = params.minChunkSize;
|
|
61
|
+
if (params.breakpointThresholdAmount === void 0) this.breakpointThresholdAmount = BREAKPOINT_DEFAULTS[this.breakpointThresholdType];
|
|
62
|
+
else this.breakpointThresholdAmount = params.breakpointThresholdAmount;
|
|
63
|
+
}
|
|
64
|
+
calculateBreakpointThreshold(distances) {
|
|
65
|
+
if (this.breakpointThresholdType === "percentile") {
|
|
66
|
+
const sorted = [...distances].sort((a, b) => a - b);
|
|
67
|
+
const index = Math.ceil(this.breakpointThresholdAmount / 100 * sorted.length) - 1;
|
|
68
|
+
return [sorted[Math.max(0, index)], distances];
|
|
69
|
+
} else if (this.breakpointThresholdType === "standard_deviation") {
|
|
70
|
+
const mean = distances.reduce((sum, d) => sum + d, 0) / distances.length;
|
|
71
|
+
const variance = distances.reduce((sum, d) => sum + Math.pow(d - mean, 2), 0) / distances.length;
|
|
72
|
+
const stdDev = Math.sqrt(variance);
|
|
73
|
+
return [mean + this.breakpointThresholdAmount * stdDev, distances];
|
|
74
|
+
} else if (this.breakpointThresholdType === "interquartile") {
|
|
75
|
+
const sorted = [...distances].sort((a, b) => a - b);
|
|
76
|
+
const q1Index = Math.floor(.25 * sorted.length);
|
|
77
|
+
const q3Index = Math.floor(.75 * sorted.length);
|
|
78
|
+
const q1 = sorted[q1Index];
|
|
79
|
+
const iqr = sorted[q3Index] - q1;
|
|
80
|
+
return [distances.reduce((sum, d) => sum + d, 0) / distances.length + this.breakpointThresholdAmount * iqr, distances];
|
|
81
|
+
} else if (this.breakpointThresholdType === "gradient") {
|
|
82
|
+
const distanceGradient = [];
|
|
83
|
+
for (let i = 0; i < distances.length - 1; i++) distanceGradient.push(distances[i + 1] - distances[i]);
|
|
84
|
+
const sortedGradient = [...distanceGradient].sort((a, b) => a - b);
|
|
85
|
+
const index = Math.ceil(this.breakpointThresholdAmount / 100 * sortedGradient.length) - 1;
|
|
86
|
+
return [sortedGradient[Math.max(0, index)], distanceGradient];
|
|
87
|
+
} else throw new Error(`Got unexpected breakpointThresholdType: ${this.breakpointThresholdType}`);
|
|
88
|
+
}
|
|
89
|
+
thresholdFromClusters(distances) {
|
|
90
|
+
if (this.numberOfChunks === void 0) throw new Error("This should never be called if numberOfChunks is undefined.");
|
|
91
|
+
const x1 = distances.length;
|
|
92
|
+
const y1 = 0;
|
|
93
|
+
const x2 = 1;
|
|
94
|
+
const y2 = 100;
|
|
95
|
+
const x = Math.max(Math.min(this.numberOfChunks, x1), x2);
|
|
96
|
+
let y;
|
|
97
|
+
if (x2 === x1) y = y2;
|
|
98
|
+
else y = y1 + (y2 - y1) / (x2 - x1) * (x - x1);
|
|
99
|
+
y = Math.min(Math.max(y, 0), 100);
|
|
100
|
+
const sorted = [...distances].sort((a, b) => a - b);
|
|
101
|
+
const index = Math.ceil(y / 100 * sorted.length) - 1;
|
|
102
|
+
return sorted[Math.max(0, index)];
|
|
103
|
+
}
|
|
104
|
+
async calculateSentenceDistances(singleSentencesList) {
|
|
105
|
+
const sentencesWithCombined = combineSentences(singleSentencesList.map((sentence, index) => ({
|
|
106
|
+
sentence,
|
|
107
|
+
index
|
|
108
|
+
})), this.bufferSize);
|
|
109
|
+
const combinedSentences = sentencesWithCombined.map((s) => s.combinedSentence);
|
|
110
|
+
const embeddings = await this.embeddings.embedDocuments(combinedSentences);
|
|
111
|
+
for (let i = 0; i < sentencesWithCombined.length; i++) sentencesWithCombined[i].combinedSentenceEmbedding = embeddings[i];
|
|
112
|
+
return calculateCosineDistances(sentencesWithCombined);
|
|
113
|
+
}
|
|
114
|
+
getSingleSentencesList(text) {
|
|
115
|
+
return text.split(new RegExp(this.sentenceSplitRegex)).filter((sentence) => sentence.trim().length > 0);
|
|
116
|
+
}
|
|
117
|
+
async splitText(text) {
|
|
118
|
+
const singleSentencesList = this.getSingleSentencesList(text);
|
|
119
|
+
if (singleSentencesList.length === 1) return singleSentencesList;
|
|
120
|
+
if (this.breakpointThresholdType === "gradient" && singleSentencesList.length === 2) return singleSentencesList;
|
|
121
|
+
const [distances, sentences] = await this.calculateSentenceDistances(singleSentencesList);
|
|
122
|
+
let breakpointDistanceThreshold;
|
|
123
|
+
let breakpointArray;
|
|
124
|
+
if (this.numberOfChunks !== void 0) {
|
|
125
|
+
breakpointDistanceThreshold = this.thresholdFromClusters(distances);
|
|
126
|
+
breakpointArray = distances;
|
|
127
|
+
} else [breakpointDistanceThreshold, breakpointArray] = this.calculateBreakpointThreshold(distances);
|
|
128
|
+
const indicesAboveThresh = breakpointArray.map((x, i) => ({
|
|
129
|
+
value: x,
|
|
130
|
+
index: i
|
|
131
|
+
})).filter(({ value }) => value > breakpointDistanceThreshold).map(({ index }) => index);
|
|
132
|
+
const chunks = [];
|
|
133
|
+
let startIndex = 0;
|
|
134
|
+
for (const index of indicesAboveThresh) {
|
|
135
|
+
const endIndex = index;
|
|
136
|
+
const combinedText = sentences.slice(startIndex, endIndex + 1).map((d) => d.sentence).join(" ");
|
|
137
|
+
if (this.minChunkSize !== void 0 && combinedText.length < this.minChunkSize) continue;
|
|
138
|
+
chunks.push(combinedText);
|
|
139
|
+
startIndex = index + 1;
|
|
140
|
+
}
|
|
141
|
+
if (startIndex < sentences.length) {
|
|
142
|
+
const combinedText = sentences.slice(startIndex).map((d) => d.sentence).join(" ");
|
|
143
|
+
chunks.push(combinedText);
|
|
144
|
+
}
|
|
145
|
+
return chunks;
|
|
146
|
+
}
|
|
147
|
+
async createDocuments(texts, metadatas = []) {
|
|
148
|
+
const _metadatas = metadatas.length > 0 ? metadatas : texts.map(() => ({}));
|
|
149
|
+
const documents = [];
|
|
150
|
+
for (let i = 0; i < texts.length; i++) {
|
|
151
|
+
const text = texts[i];
|
|
152
|
+
let startIndex = 0;
|
|
153
|
+
for (const chunk of await this.splitText(text)) {
|
|
154
|
+
const metadata = { ..._metadatas[i] };
|
|
155
|
+
if (this.addStartIndex) metadata.start_index = startIndex;
|
|
156
|
+
const newDoc = new Document({
|
|
157
|
+
pageContent: chunk,
|
|
158
|
+
metadata
|
|
159
|
+
});
|
|
160
|
+
documents.push(newDoc);
|
|
161
|
+
startIndex += chunk.length;
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
return documents;
|
|
165
|
+
}
|
|
166
|
+
async splitDocuments(documents) {
|
|
167
|
+
const texts = documents.map((doc) => doc.pageContent);
|
|
168
|
+
const metadatas = documents.map((doc) => doc.metadata);
|
|
169
|
+
return this.createDocuments(texts, metadatas);
|
|
170
|
+
}
|
|
171
|
+
async transformDocuments(documents) {
|
|
172
|
+
return this.splitDocuments(documents);
|
|
173
|
+
}
|
|
174
|
+
};
|
|
175
|
+
//#endregion
|
|
176
|
+
export { SemanticTextSplitter, calculateCosineDistances };
|
|
177
|
+
|
|
178
|
+
//# sourceMappingURL=semantic_text_splitter.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"semantic_text_splitter.js","names":[],"sources":["../src/semantic_text_splitter.ts"],"sourcesContent":["/**\r\n * Experimental semantic text splitter based on semantic similarity.\r\n * \r\n * Inspired by Greg Kamradt's semantic chunking approach:\r\n * https://github.com/FullStackRetrieval-com/RetrievalTutorials/blob/main/tutorials/LevelsOfTextSplitting/5_Levels_Of_Text_Splitting.ipynb\r\n */\r\nimport { Document, BaseDocumentTransformer } from \"@langchain/core/documents\";\r\nimport { Embeddings } from \"@langchain/core/embeddings\";\r\n\r\ninterface SentenceDict {\r\n sentence: string;\r\n index: number;\r\n combinedSentence?: string;\r\n combinedSentenceEmbedding?: number[];\r\n}\r\n\r\nfunction combineSentences(sentences: SentenceDict[], bufferSize: number = 1): SentenceDict[] {\r\n // Go through each sentence dict\r\n for (let i = 0; i < sentences.length; i++) {\r\n const sentence = sentences[i];\r\n \r\n // Create the combined sentence by combining the sentences within the buffer\r\n let combinedSentence = \"\";\r\n \r\n // Add sentences before the current one\r\n for (let j = Math.max(0, i - bufferSize); j < i; j++) {\r\n combinedSentence += sentences[j].sentence + \" \";\r\n }\r\n \r\n // Add the current sentence\r\n combinedSentence += sentence.sentence;\r\n \r\n // Add sentences after the current one\r\n for (let j = i + 1; j <= Math.min(sentences.length - 1, i + bufferSize); j++) {\r\n combinedSentence += \" \" + sentences[j].sentence;\r\n }\r\n \r\n // Assign the combined sentence to the dict\r\n sentence.combinedSentence = combinedSentence.trim();\r\n }\r\n \r\n return sentences;\r\n}\r\n\r\nfunction cosineSimilarity(a: number[], b: number[]): number {\r\n const dotProduct = a.reduce((sum, ai, i) => sum + ai * b[i], 0);\r\n const magnitudeA = Math.sqrt(a.reduce((sum, ai) => sum + ai * ai, 0));\r\n const magnitudeB = Math.sqrt(b.reduce((sum, bi) => sum + bi * bi, 0));\r\n \r\n if (magnitudeA === 0 || magnitudeB === 0) {\r\n return 0;\r\n }\r\n \r\n return dotProduct / (magnitudeA * magnitudeB);\r\n}\r\n\r\nexport function calculateCosineDistances(sentences: SentenceDict[]): [number[], SentenceDict[]] {\r\n const distances: number[] = [];\r\n \r\n for (let i = 0; i < sentences.length - 1; i++) {\r\n const embeddingCurrent = sentences[i].combinedSentenceEmbedding!;\r\n const embeddingNext = sentences[i + 1].combinedSentenceEmbedding!;\r\n \r\n // Calculate cosine similarity\r\n const similarity = cosineSimilarity(embeddingCurrent, embeddingNext);\r\n \r\n // Convert to cosine distance (1 - cosine similarity)\r\n const distance = 1 - similarity;\r\n distances.push(distance);\r\n }\r\n \r\n return [distances, sentences];\r\n}\r\n\r\ntype BreakpointThresholdType = \"percentile\" | \"standard_deviation\" | \"interquartile\" | \"gradient\";\r\n\r\nconst BREAKPOINT_DEFAULTS: Record<BreakpointThresholdType, number> = {\r\n percentile: 95,\r\n standard_deviation: 3,\r\n interquartile: 1.5,\r\n gradient: 95,\r\n};\r\n\r\nexport interface SemanticTextSplitterParams {\r\n embeddings: Embeddings;\r\n bufferSize?: number;\r\n addStartIndex?: boolean;\r\n breakpointThresholdType?: BreakpointThresholdType;\r\n breakpointThresholdAmount?: number;\r\n numberOfChunks?: number;\r\n sentenceSplitRegex?: string;\r\n minChunkSize?: number;\r\n}\r\n\r\nexport class SemanticTextSplitter extends BaseDocumentTransformer {\r\n private embeddings: Embeddings;\r\n private bufferSize: number;\r\n private addStartIndex: boolean;\r\n private breakpointThresholdType: BreakpointThresholdType;\r\n private breakpointThresholdAmount: number;\r\n private numberOfChunks?: number;\r\n private sentenceSplitRegex: string;\r\n private minChunkSize?: number;\r\n\r\n constructor(params: SemanticTextSplitterParams) {\r\n super();\r\n this.embeddings = params.embeddings;\r\n this.bufferSize = params.bufferSize ?? 1;\r\n this.addStartIndex = params.addStartIndex ?? false;\r\n this.breakpointThresholdType = params.breakpointThresholdType ?? \"percentile\";\r\n this.numberOfChunks = params.numberOfChunks;\r\n this.sentenceSplitRegex = params.sentenceSplitRegex ?? \"(?<=[.?!])\\\\s+\";\r\n this.minChunkSize = params.minChunkSize;\r\n \r\n if (params.breakpointThresholdAmount === undefined) {\r\n this.breakpointThresholdAmount = BREAKPOINT_DEFAULTS[this.breakpointThresholdType];\r\n } else {\r\n this.breakpointThresholdAmount = params.breakpointThresholdAmount;\r\n }\r\n }\r\n\r\n private calculateBreakpointThreshold(distances: number[]): [number, number[]] {\r\n if (this.breakpointThresholdType === \"percentile\") {\r\n const sorted = [...distances].sort((a, b) => a - b);\r\n const index = Math.ceil((this.breakpointThresholdAmount / 100) * sorted.length) - 1;\r\n return [sorted[Math.max(0, index)], distances];\r\n } else if (this.breakpointThresholdType === \"standard_deviation\") {\r\n const mean = distances.reduce((sum, d) => sum + d, 0) / distances.length;\r\n const variance = distances.reduce((sum, d) => sum + Math.pow(d - mean, 2), 0) / distances.length;\r\n const stdDev = Math.sqrt(variance);\r\n return [mean + this.breakpointThresholdAmount * stdDev, distances];\r\n } else if (this.breakpointThresholdType === \"interquartile\") {\r\n const sorted = [...distances].sort((a, b) => a - b);\r\n const q1Index = Math.floor(0.25 * sorted.length);\r\n const q3Index = Math.floor(0.75 * sorted.length);\r\n const q1 = sorted[q1Index];\r\n const q3 = sorted[q3Index];\r\n const iqr = q3 - q1;\r\n const mean = distances.reduce((sum, d) => sum + d, 0) / distances.length;\r\n return [mean + this.breakpointThresholdAmount * iqr, distances];\r\n } else if (this.breakpointThresholdType === \"gradient\") {\r\n const distanceGradient: number[] = [];\r\n for (let i = 0; i < distances.length - 1; i++) {\r\n distanceGradient.push(distances[i + 1] - distances[i]);\r\n }\r\n const sortedGradient = [...distanceGradient].sort((a, b) => a - b);\r\n const index = Math.ceil((this.breakpointThresholdAmount / 100) * sortedGradient.length) - 1;\r\n return [sortedGradient[Math.max(0, index)], distanceGradient];\r\n } else {\r\n throw new Error(`Got unexpected breakpointThresholdType: ${this.breakpointThresholdType}`);\r\n }\r\n }\r\n\r\n private thresholdFromClusters(distances: number[]): number {\r\n if (this.numberOfChunks === undefined) {\r\n throw new Error(\"This should never be called if numberOfChunks is undefined.\");\r\n }\r\n \r\n const x1 = distances.length;\r\n const y1 = 0.0;\r\n const x2 = 1.0;\r\n const y2 = 100.0;\r\n \r\n const x = Math.max(Math.min(this.numberOfChunks, x1), x2);\r\n \r\n let y: number;\r\n if (x2 === x1) {\r\n y = y2;\r\n } else {\r\n y = y1 + ((y2 - y1) / (x2 - x1)) * (x - x1);\r\n }\r\n \r\n y = Math.min(Math.max(y, 0), 100);\r\n \r\n const sorted = [...distances].sort((a, b) => a - b);\r\n const index = Math.ceil((y / 100) * sorted.length) - 1;\r\n return sorted[Math.max(0, index)];\r\n }\r\n\r\n private async calculateSentenceDistances(singleSentencesList: string[]): Promise<[number[], SentenceDict[]]> {\r\n const sentences: SentenceDict[] = singleSentencesList.map((sentence, index) => ({\r\n sentence,\r\n index,\r\n }));\r\n\r\n const sentencesWithCombined = combineSentences(sentences, this.bufferSize);\r\n \r\n const combinedSentences = sentencesWithCombined.map(s => s.combinedSentence!);\r\n const embeddings = await this.embeddings.embedDocuments(combinedSentences);\r\n \r\n for (let i = 0; i < sentencesWithCombined.length; i++) {\r\n sentencesWithCombined[i].combinedSentenceEmbedding = embeddings[i];\r\n }\r\n\r\n return calculateCosineDistances(sentencesWithCombined);\r\n }\r\n\r\n private getSingleSentencesList(text: string): string[] {\r\n return text.split(new RegExp(this.sentenceSplitRegex)).filter(sentence => sentence.trim().length > 0);\r\n }\r\n\r\n async splitText(text: string): Promise<string[]> {\r\n const singleSentencesList = this.getSingleSentencesList(text);\r\n\r\n if (singleSentencesList.length === 1) {\r\n return singleSentencesList;\r\n }\r\n\r\n if (this.breakpointThresholdType === \"gradient\" && singleSentencesList.length === 2) {\r\n return singleSentencesList;\r\n }\r\n\r\n const [distances, sentences] = await this.calculateSentenceDistances(singleSentencesList);\r\n\r\n let breakpointDistanceThreshold: number;\r\n let breakpointArray: number[];\r\n\r\n if (this.numberOfChunks !== undefined) {\r\n breakpointDistanceThreshold = this.thresholdFromClusters(distances);\r\n breakpointArray = distances;\r\n } else {\r\n [breakpointDistanceThreshold, breakpointArray] = this.calculateBreakpointThreshold(distances);\r\n }\r\n\r\n const indicesAboveThresh = breakpointArray\r\n .map((x, i) => ({ value: x, index: i }))\r\n .filter(({ value }) => value > breakpointDistanceThreshold)\r\n .map(({ index }) => index);\r\n\r\n const chunks: string[] = [];\r\n let startIndex = 0;\r\n\r\n for (const index of indicesAboveThresh) {\r\n const endIndex = index;\r\n const group = sentences.slice(startIndex, endIndex + 1);\r\n const combinedText = group.map((d: SentenceDict) => d.sentence).join(\" \");\r\n\r\n if (this.minChunkSize !== undefined && combinedText.length < this.minChunkSize) {\r\n continue;\r\n }\r\n \r\n chunks.push(combinedText);\r\n startIndex = index + 1;\r\n }\r\n\r\n if (startIndex < sentences.length) {\r\n const combinedText = sentences.slice(startIndex).map((d: SentenceDict) => d.sentence).join(\" \");\r\n chunks.push(combinedText);\r\n }\r\n\r\n return chunks;\r\n }\r\n\r\n async createDocuments(\r\n texts: string[],\r\n metadatas: Record<string, any>[] = []\r\n ): Promise<Document[]> {\r\n const _metadatas = metadatas.length > 0 ? metadatas : texts.map(() => (<Record<string, any>>{}));\r\n const documents: Document[] = [];\r\n \r\n for (let i = 0; i < texts.length; i++) {\r\n const text = texts[i];\r\n let startIndex = 0;\r\n \r\n for (const chunk of await this.splitText(text)) {\r\n const metadata = { ..._metadatas[i] };\r\n if (this.addStartIndex) {\r\n metadata.start_index = startIndex;\r\n }\r\n \r\n const newDoc = new Document({\r\n pageContent: chunk,\r\n metadata,\r\n });\r\n \r\n documents.push(newDoc);\r\n startIndex += chunk.length;\r\n }\r\n }\r\n \r\n return documents;\r\n }\r\n\r\n async splitDocuments(documents: Document[]): Promise<Document[]> {\r\n const texts = documents.map(doc => doc.pageContent);\r\n const metadatas = documents.map(doc => doc.metadata);\r\n return this.createDocuments(texts, metadatas);\r\n }\r\n\r\n async transformDocuments(documents: Document[]): Promise<Document[]> {\r\n return this.splitDocuments(documents);\r\n }\r\n}"],"mappings":";;;;;;;;AAgBA,SAAS,iBAAiB,WAA2B,aAAqB,GAAmB;AAE3F,MAAK,IAAI,IAAI,GAAG,IAAI,UAAU,QAAQ,KAAK;EACzC,MAAM,WAAW,UAAU;EAG3B,IAAI,mBAAmB;AAGvB,OAAK,IAAI,IAAI,KAAK,IAAI,GAAG,IAAI,WAAW,EAAE,IAAI,GAAG,IAC/C,qBAAoB,UAAU,GAAG,WAAW;AAI9C,sBAAoB,SAAS;AAG7B,OAAK,IAAI,IAAI,IAAI,GAAG,KAAK,KAAK,IAAI,UAAU,SAAS,GAAG,IAAI,WAAW,EAAE,IACvE,qBAAoB,MAAM,UAAU,GAAG;AAIzC,WAAS,mBAAmB,iBAAiB,MAAM;;AAGrD,QAAO;;AAGT,SAAS,iBAAiB,GAAa,GAAqB;CAC1D,MAAM,aAAa,EAAE,QAAQ,KAAK,IAAI,MAAM,MAAM,KAAK,EAAE,IAAI,EAAE;CAC/D,MAAM,aAAa,KAAK,KAAK,EAAE,QAAQ,KAAK,OAAO,MAAM,KAAK,IAAI,EAAE,CAAC;CACrE,MAAM,aAAa,KAAK,KAAK,EAAE,QAAQ,KAAK,OAAO,MAAM,KAAK,IAAI,EAAE,CAAC;AAErE,KAAI,eAAe,KAAK,eAAe,EACrC,QAAO;AAGT,QAAO,cAAc,aAAa;;AAGpC,SAAgB,yBAAyB,WAAuD;CAC9F,MAAM,YAAsB,EAAE;AAE9B,MAAK,IAAI,IAAI,GAAG,IAAI,UAAU,SAAS,GAAG,KAAK;EAC7C,MAAM,mBAAmB,UAAU,GAAG;EACtC,MAAM,gBAAgB,UAAU,IAAI,GAAG;EAMvC,MAAM,WAAW,IAHE,iBAAiB,kBAAkB,cAAc;AAIpE,YAAU,KAAK,SAAS;;AAG1B,QAAO,CAAC,WAAW,UAAU;;AAK/B,MAAM,sBAA+D;CACnE,YAAY;CACZ,oBAAoB;CACpB,eAAe;CACf,UAAU;CACX;AAaD,IAAa,uBAAb,cAA0C,wBAAwB;CAChE;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CAEA,YAAY,QAAoC;AAC9C,SAAO;AACP,OAAK,aAAa,OAAO;AACzB,OAAK,aAAa,OAAO,cAAc;AACvC,OAAK,gBAAgB,OAAO,iBAAiB;AAC7C,OAAK,0BAA0B,OAAO,2BAA2B;AACjE,OAAK,iBAAiB,OAAO;AAC7B,OAAK,qBAAqB,OAAO,sBAAsB;AACvD,OAAK,eAAe,OAAO;AAE3B,MAAI,OAAO,8BAA8B,KAAA,EACvC,MAAK,4BAA4B,oBAAoB,KAAK;MAE1D,MAAK,4BAA4B,OAAO;;CAI5C,6BAAqC,WAAyC;AAC5E,MAAI,KAAK,4BAA4B,cAAc;GACjD,MAAM,SAAS,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE;GACnD,MAAM,QAAQ,KAAK,KAAM,KAAK,4BAA4B,MAAO,OAAO,OAAO,GAAG;AAClF,UAAO,CAAC,OAAO,KAAK,IAAI,GAAG,MAAM,GAAG,UAAU;aACrC,KAAK,4BAA4B,sBAAsB;GAChE,MAAM,OAAO,UAAU,QAAQ,KAAK,MAAM,MAAM,GAAG,EAAE,GAAG,UAAU;GAClE,MAAM,WAAW,UAAU,QAAQ,KAAK,MAAM,MAAM,KAAK,IAAI,IAAI,MAAM,EAAE,EAAE,EAAE,GAAG,UAAU;GAC1F,MAAM,SAAS,KAAK,KAAK,SAAS;AAClC,UAAO,CAAC,OAAO,KAAK,4BAA4B,QAAQ,UAAU;aACzD,KAAK,4BAA4B,iBAAiB;GAC3D,MAAM,SAAS,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE;GACnD,MAAM,UAAU,KAAK,MAAM,MAAO,OAAO,OAAO;GAChD,MAAM,UAAU,KAAK,MAAM,MAAO,OAAO,OAAO;GAChD,MAAM,KAAK,OAAO;GAElB,MAAM,MADK,OAAO,WACD;AAEjB,UAAO,CADM,UAAU,QAAQ,KAAK,MAAM,MAAM,GAAG,EAAE,GAAG,UAAU,SACnD,KAAK,4BAA4B,KAAK,UAAU;aACtD,KAAK,4BAA4B,YAAY;GACtD,MAAM,mBAA6B,EAAE;AACrC,QAAK,IAAI,IAAI,GAAG,IAAI,UAAU,SAAS,GAAG,IACxC,kBAAiB,KAAK,UAAU,IAAI,KAAK,UAAU,GAAG;GAExD,MAAM,iBAAiB,CAAC,GAAG,iBAAiB,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE;GAClE,MAAM,QAAQ,KAAK,KAAM,KAAK,4BAA4B,MAAO,eAAe,OAAO,GAAG;AAC1F,UAAO,CAAC,eAAe,KAAK,IAAI,GAAG,MAAM,GAAG,iBAAiB;QAE7D,OAAM,IAAI,MAAM,2CAA2C,KAAK,0BAA0B;;CAI9F,sBAA8B,WAA6B;AACzD,MAAI,KAAK,mBAAmB,KAAA,EAC1B,OAAM,IAAI,MAAM,8DAA8D;EAGhF,MAAM,KAAK,UAAU;EACrB,MAAM,KAAK;EACX,MAAM,KAAK;EACX,MAAM,KAAK;EAEX,MAAM,IAAI,KAAK,IAAI,KAAK,IAAI,KAAK,gBAAgB,GAAG,EAAE,GAAG;EAEzD,IAAI;AACJ,MAAI,OAAO,GACT,KAAI;MAEJ,KAAI,MAAO,KAAK,OAAO,KAAK,OAAQ,IAAI;AAG1C,MAAI,KAAK,IAAI,KAAK,IAAI,GAAG,EAAE,EAAE,IAAI;EAEjC,MAAM,SAAS,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE;EACnD,MAAM,QAAQ,KAAK,KAAM,IAAI,MAAO,OAAO,OAAO,GAAG;AACrD,SAAO,OAAO,KAAK,IAAI,GAAG,MAAM;;CAGlC,MAAc,2BAA2B,qBAAoE;EAM3G,MAAM,wBAAwB,iBALI,oBAAoB,KAAK,UAAU,WAAW;GAC9E;GACA;GACD,EAAE,EAEuD,KAAK,WAAW;EAE1E,MAAM,oBAAoB,sBAAsB,KAAI,MAAK,EAAE,iBAAkB;EAC7E,MAAM,aAAa,MAAM,KAAK,WAAW,eAAe,kBAAkB;AAE1E,OAAK,IAAI,IAAI,GAAG,IAAI,sBAAsB,QAAQ,IAChD,uBAAsB,GAAG,4BAA4B,WAAW;AAGlE,SAAO,yBAAyB,sBAAsB;;CAGxD,uBAA+B,MAAwB;AACrD,SAAO,KAAK,MAAM,IAAI,OAAO,KAAK,mBAAmB,CAAC,CAAC,QAAO,aAAY,SAAS,MAAM,CAAC,SAAS,EAAE;;CAGvG,MAAM,UAAU,MAAiC;EAC/C,MAAM,sBAAsB,KAAK,uBAAuB,KAAK;AAE7D,MAAI,oBAAoB,WAAW,EACjC,QAAO;AAGT,MAAI,KAAK,4BAA4B,cAAc,oBAAoB,WAAW,EAChF,QAAO;EAGT,MAAM,CAAC,WAAW,aAAa,MAAM,KAAK,2BAA2B,oBAAoB;EAEzF,IAAI;EACJ,IAAI;AAEJ,MAAI,KAAK,mBAAmB,KAAA,GAAW;AACrC,iCAA8B,KAAK,sBAAsB,UAAU;AACnE,qBAAkB;QAElB,EAAC,6BAA6B,mBAAmB,KAAK,6BAA6B,UAAU;EAG/F,MAAM,qBAAqB,gBACxB,KAAK,GAAG,OAAO;GAAE,OAAO;GAAG,OAAO;GAAG,EAAE,CACvC,QAAQ,EAAE,YAAY,QAAQ,4BAA4B,CAC1D,KAAK,EAAE,YAAY,MAAM;EAE5B,MAAM,SAAmB,EAAE;EAC3B,IAAI,aAAa;AAEjB,OAAK,MAAM,SAAS,oBAAoB;GACtC,MAAM,WAAW;GAEjB,MAAM,eADQ,UAAU,MAAM,YAAY,WAAW,EAAE,CAC5B,KAAK,MAAoB,EAAE,SAAS,CAAC,KAAK,IAAI;AAEzE,OAAI,KAAK,iBAAiB,KAAA,KAAa,aAAa,SAAS,KAAK,aAChE;AAGF,UAAO,KAAK,aAAa;AACzB,gBAAa,QAAQ;;AAGvB,MAAI,aAAa,UAAU,QAAQ;GACjC,MAAM,eAAe,UAAU,MAAM,WAAW,CAAC,KAAK,MAAoB,EAAE,SAAS,CAAC,KAAK,IAAI;AAC/F,UAAO,KAAK,aAAa;;AAG3B,SAAO;;CAGT,MAAM,gBACJ,OACA,YAAmC,EAAE,EAChB;EACrB,MAAM,aAAa,UAAU,SAAS,IAAI,YAAY,MAAM,WAAgC,EAAE,EAAE;EAChG,MAAM,YAAwB,EAAE;AAEhC,OAAK,IAAI,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK;GACrC,MAAM,OAAO,MAAM;GACnB,IAAI,aAAa;AAEjB,QAAK,MAAM,SAAS,MAAM,KAAK,UAAU,KAAK,EAAE;IAC9C,MAAM,WAAW,EAAE,GAAG,WAAW,IAAI;AACrC,QAAI,KAAK,cACP,UAAS,cAAc;IAGzB,MAAM,SAAS,IAAI,SAAS;KAC1B,aAAa;KACb;KACD,CAAC;AAEF,cAAU,KAAK,OAAO;AACtB,kBAAc,MAAM;;;AAIxB,SAAO;;CAGT,MAAM,eAAe,WAA4C;EAC/D,MAAM,QAAQ,UAAU,KAAI,QAAO,IAAI,YAAY;EACnD,MAAM,YAAY,UAAU,KAAI,QAAO,IAAI,SAAS;AACpD,SAAO,KAAK,gBAAgB,OAAO,UAAU;;CAG/C,MAAM,mBAAmB,WAA4C;AACnE,SAAO,KAAK,eAAe,UAAU"}
|