aigroup-workflow 2.2.1 → 2.2.2

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.
Files changed (640) hide show
  1. package/.claude/commands/fix-build.md +10 -5
  2. package/.claude/commands/init-project.md +13 -8
  3. package/.claude/commands/plan.md +15 -8
  4. package/.claude/commands/review.md +12 -6
  5. package/.claude/commands/tdd.md +11 -5
  6. package/.claude/commands/workflow-start.md +20 -11
  7. package/.claude/settings.json +28 -0
  8. package/.codex/agents/architect.toml +207 -0
  9. package/.codex/agents/build-error-resolver.toml +110 -0
  10. package/.codex/agents/code-reviewer.toml +233 -0
  11. package/.codex/agents/doc-updater.toml +103 -0
  12. package/.codex/agents/e2e-runner.toml +103 -0
  13. package/.codex/agents/get-current-datetime.toml +23 -0
  14. package/.codex/agents/init-architect.toml +181 -0
  15. package/.codex/agents/planner.toml +208 -0
  16. package/.codex/agents/refactor-cleaner.toml +81 -0
  17. package/.codex/agents/rust-reviewer.toml +90 -0
  18. package/.codex/agents/security-reviewer.toml +104 -0
  19. package/.codex/agents/tdd-guide.toml +87 -0
  20. package/AGENTS.md +2 -2
  21. package/CLAUDE.md +23 -1
  22. package/LICENSE +20 -20
  23. package/README.md +333 -333
  24. package/agents/a11y-architect.md +141 -141
  25. package/agents/architect.md +211 -211
  26. package/agents/build-error-resolver.md +114 -114
  27. package/agents/chief-of-staff.md +151 -151
  28. package/agents/code-architect.md +71 -71
  29. package/agents/code-explorer.md +69 -69
  30. package/agents/code-reviewer.md +237 -237
  31. package/agents/code-simplifier.md +47 -47
  32. package/agents/comment-analyzer.md +45 -45
  33. package/agents/conversation-analyzer.md +52 -52
  34. package/agents/cpp-build-resolver.md +90 -90
  35. package/agents/cpp-reviewer.md +72 -72
  36. package/agents/csharp-reviewer.md +101 -101
  37. package/agents/dart-build-resolver.md +201 -201
  38. package/agents/database-reviewer.md +91 -91
  39. package/agents/doc-updater.md +107 -107
  40. package/agents/docs-lookup.md +68 -68
  41. package/agents/e2e-runner.md +107 -107
  42. package/agents/flutter-reviewer.md +243 -243
  43. package/agents/gan-evaluator.md +209 -209
  44. package/agents/gan-generator.md +131 -131
  45. package/agents/gan-planner.md +99 -99
  46. package/agents/get-current-datetime.md +26 -26
  47. package/agents/go-build-resolver.md +94 -94
  48. package/agents/go-reviewer.md +76 -76
  49. package/agents/harness-optimizer.md +35 -35
  50. package/agents/healthcare-reviewer.md +83 -83
  51. package/agents/java-build-resolver.md +153 -153
  52. package/agents/java-reviewer.md +92 -92
  53. package/agents/kotlin-build-resolver.md +118 -118
  54. package/agents/kotlin-reviewer.md +159 -159
  55. package/agents/loop-operator.md +36 -36
  56. package/agents/opensource-forker.md +198 -198
  57. package/agents/opensource-packager.md +249 -249
  58. package/agents/opensource-sanitizer.md +188 -188
  59. package/agents/performance-optimizer.md +446 -446
  60. package/agents/planner.md +212 -212
  61. package/agents/pr-test-analyzer.md +45 -45
  62. package/agents/python-reviewer.md +98 -98
  63. package/agents/pytorch-build-resolver.md +120 -120
  64. package/agents/refactor-cleaner.md +85 -85
  65. package/agents/rust-build-resolver.md +148 -148
  66. package/agents/rust-reviewer.md +94 -94
  67. package/agents/security-reviewer.md +108 -108
  68. package/agents/seo-specialist.md +59 -59
  69. package/agents/silent-failure-hunter.md +50 -50
  70. package/agents/tdd-guide.md +91 -91
  71. package/agents/type-design-analyzer.md +41 -41
  72. package/agents/typescript-reviewer.md +112 -112
  73. package/cli/commands/update.mjs +1 -1
  74. package/cli/utils/scaffold.mjs +53 -0
  75. package/docs/rules/agents.md +166 -50
  76. package/docs/rules/cpp/coding-style.md +44 -44
  77. package/docs/rules/cpp/hooks.md +39 -39
  78. package/docs/rules/cpp/patterns.md +51 -51
  79. package/docs/rules/cpp/security.md +51 -51
  80. package/docs/rules/cpp/testing.md +44 -44
  81. package/docs/rules/csharp/coding-style.md +72 -72
  82. package/docs/rules/csharp/hooks.md +25 -25
  83. package/docs/rules/csharp/patterns.md +50 -50
  84. package/docs/rules/csharp/security.md +58 -58
  85. package/docs/rules/csharp/testing.md +46 -46
  86. package/docs/rules/dart/coding-style.md +159 -159
  87. package/docs/rules/dart/hooks.md +66 -66
  88. package/docs/rules/dart/patterns.md +261 -261
  89. package/docs/rules/dart/security.md +135 -135
  90. package/docs/rules/dart/testing.md +215 -215
  91. package/docs/rules/golang/coding-style.md +32 -32
  92. package/docs/rules/golang/hooks.md +17 -17
  93. package/docs/rules/golang/patterns.md +45 -45
  94. package/docs/rules/golang/security.md +34 -34
  95. package/docs/rules/golang/testing.md +31 -31
  96. package/docs/rules/java/coding-style.md +114 -114
  97. package/docs/rules/java/hooks.md +18 -18
  98. package/docs/rules/java/patterns.md +146 -146
  99. package/docs/rules/java/security.md +100 -100
  100. package/docs/rules/java/testing.md +131 -131
  101. package/docs/rules/kotlin/coding-style.md +86 -86
  102. package/docs/rules/kotlin/hooks.md +17 -17
  103. package/docs/rules/kotlin/patterns.md +146 -146
  104. package/docs/rules/kotlin/security.md +82 -82
  105. package/docs/rules/kotlin/testing.md +128 -128
  106. package/docs/rules/perl/coding-style.md +46 -46
  107. package/docs/rules/perl/hooks.md +22 -22
  108. package/docs/rules/perl/patterns.md +76 -76
  109. package/docs/rules/perl/security.md +69 -69
  110. package/docs/rules/perl/testing.md +54 -54
  111. package/docs/rules/php/coding-style.md +40 -40
  112. package/docs/rules/php/hooks.md +24 -24
  113. package/docs/rules/php/patterns.md +33 -33
  114. package/docs/rules/php/security.md +37 -37
  115. package/docs/rules/php/testing.md +39 -39
  116. package/docs/rules/python/coding-style.md +42 -42
  117. package/docs/rules/python/hooks.md +19 -19
  118. package/docs/rules/python/patterns.md +39 -39
  119. package/docs/rules/python/security.md +30 -30
  120. package/docs/rules/python/testing.md +38 -38
  121. package/docs/rules/rust/coding-style.md +151 -151
  122. package/docs/rules/rust/hooks.md +16 -16
  123. package/docs/rules/rust/patterns.md +168 -168
  124. package/docs/rules/rust/security.md +141 -141
  125. package/docs/rules/rust/testing.md +154 -154
  126. package/docs/rules/swift/coding-style.md +47 -47
  127. package/docs/rules/swift/hooks.md +20 -20
  128. package/docs/rules/swift/patterns.md +66 -66
  129. package/docs/rules/swift/security.md +33 -33
  130. package/docs/rules/swift/testing.md +45 -45
  131. package/docs/rules/typescript/coding-style.md +199 -199
  132. package/docs/rules/typescript/hooks.md +22 -22
  133. package/docs/rules/typescript/patterns.md +52 -52
  134. package/docs/rules/typescript/security.md +28 -28
  135. package/docs/rules/typescript/testing.md +18 -18
  136. package/docs/rules/web/coding-style.md +96 -96
  137. package/docs/rules/web/design-quality.md +62 -62
  138. package/docs/rules/web/hooks.md +120 -120
  139. package/docs/rules/web/patterns.md +79 -79
  140. package/docs/rules/web/performance.md +64 -64
  141. package/docs/rules/web/security.md +57 -57
  142. package/docs/rules/web/testing.md +55 -55
  143. package/docs/templates/README.md +36 -36
  144. package/docs/templates/ai-project-final.md +124 -124
  145. package/docs/templates/ai-project.md +105 -105
  146. package/docs/templates/api.md +157 -157
  147. package/docs/templates/bug.md +62 -62
  148. package/docs/templates/code-review.md +87 -87
  149. package/docs/templates/generic.md +116 -116
  150. package/docs/templates/implementation-plan.md +1 -1
  151. package/docs/templates/meeting.md +68 -68
  152. package/docs/templates/prd.md +98 -98
  153. package/docs/templates/ui.md +134 -134
  154. package/docs/workflow-pipeline.md +5 -5
  155. package/package.json +40 -39
  156. package/skills/SUPERPOWERS-LICENSE +21 -21
  157. package/skills/ai-ml/fine-tuning-expert/SKILL.md +162 -162
  158. package/skills/ai-ml/fine-tuning-expert/references/dataset-preparation.md +540 -540
  159. package/skills/ai-ml/fine-tuning-expert/references/deployment-optimization.md +673 -673
  160. package/skills/ai-ml/fine-tuning-expert/references/evaluation-metrics.md +597 -597
  161. package/skills/ai-ml/fine-tuning-expert/references/hyperparameter-tuning.md +565 -565
  162. package/skills/ai-ml/fine-tuning-expert/references/lora-peft.md +347 -347
  163. package/skills/ai-ml/ml-pipeline/SKILL.md +159 -159
  164. package/skills/ai-ml/ml-pipeline/references/experiment-tracking.md +833 -833
  165. package/skills/ai-ml/ml-pipeline/references/feature-engineering.md +631 -631
  166. package/skills/ai-ml/ml-pipeline/references/model-validation.md +978 -978
  167. package/skills/ai-ml/ml-pipeline/references/pipeline-orchestration.md +907 -907
  168. package/skills/ai-ml/ml-pipeline/references/training-pipelines.md +782 -782
  169. package/skills/ai-ml/rag-architect/SKILL.md +194 -194
  170. package/skills/ai-ml/rag-architect/references/chunking-strategies.md +878 -878
  171. package/skills/ai-ml/rag-architect/references/embedding-models.md +561 -561
  172. package/skills/ai-ml/rag-architect/references/rag-evaluation.md +833 -833
  173. package/skills/ai-ml/rag-architect/references/retrieval-optimization.md +795 -795
  174. package/skills/ai-ml/rag-architect/references/vector-databases.md +589 -589
  175. package/skills/ai-ml/spark-engineer/SKILL.md +148 -148
  176. package/skills/ai-ml/spark-engineer/references/partitioning-caching.md +543 -543
  177. package/skills/ai-ml/spark-engineer/references/performance-tuning.md +544 -544
  178. package/skills/ai-ml/spark-engineer/references/rdd-operations.md +599 -599
  179. package/skills/ai-ml/spark-engineer/references/spark-sql-dataframes.md +474 -474
  180. package/skills/ai-ml/spark-engineer/references/streaming-patterns.md +786 -786
  181. package/skills/backend/api-designer/SKILL.md +217 -217
  182. package/skills/backend/api-designer/references/error-handling.md +541 -541
  183. package/skills/backend/api-designer/references/openapi.md +824 -824
  184. package/skills/backend/api-designer/references/pagination.md +494 -494
  185. package/skills/backend/api-designer/references/rest-patterns.md +335 -335
  186. package/skills/backend/api-designer/references/versioning.md +391 -391
  187. package/skills/backend/architecture-designer/SKILL.md +117 -117
  188. package/skills/backend/architecture-designer/references/adr-template.md +116 -116
  189. package/skills/backend/architecture-designer/references/architecture-patterns.md +111 -111
  190. package/skills/backend/architecture-designer/references/database-selection.md +102 -102
  191. package/skills/backend/architecture-designer/references/nfr-checklist.md +112 -112
  192. package/skills/backend/architecture-designer/references/system-design.md +100 -100
  193. package/skills/backend/code-documenter/SKILL.md +147 -147
  194. package/skills/backend/code-documenter/references/api-docs-fastapi-django.md +166 -166
  195. package/skills/backend/code-documenter/references/api-docs-nestjs-express.md +220 -220
  196. package/skills/backend/code-documenter/references/coverage-reports.md +125 -125
  197. package/skills/backend/code-documenter/references/documentation-systems.md +333 -333
  198. package/skills/backend/code-documenter/references/interactive-api-docs.md +531 -531
  199. package/skills/backend/code-documenter/references/python-docstrings.md +121 -121
  200. package/skills/backend/code-documenter/references/typescript-jsdoc.md +145 -145
  201. package/skills/backend/code-documenter/references/user-guides-tutorials.md +530 -530
  202. package/skills/backend/debugging-wizard/SKILL.md +105 -105
  203. package/skills/backend/debugging-wizard/references/common-patterns.md +132 -132
  204. package/skills/backend/debugging-wizard/references/debugging-tools.md +140 -140
  205. package/skills/backend/debugging-wizard/references/quick-fixes.md +177 -177
  206. package/skills/backend/debugging-wizard/references/strategies.md +142 -142
  207. package/skills/backend/debugging-wizard/references/systematic-debugging.md +367 -367
  208. package/skills/backend/feature-forge/SKILL.md +98 -98
  209. package/skills/backend/feature-forge/references/acceptance-criteria.md +104 -104
  210. package/skills/backend/feature-forge/references/ears-syntax.md +99 -99
  211. package/skills/backend/feature-forge/references/interview-questions.md +150 -150
  212. package/skills/backend/feature-forge/references/pre-discovery-subagents.md +54 -54
  213. package/skills/backend/feature-forge/references/specification-template.md +103 -103
  214. package/skills/backend/fullstack-guardian/SKILL.md +105 -105
  215. package/skills/backend/fullstack-guardian/references/api-design-standards.md +307 -307
  216. package/skills/backend/fullstack-guardian/references/architecture-decisions.md +350 -350
  217. package/skills/backend/fullstack-guardian/references/backend-patterns.md +237 -237
  218. package/skills/backend/fullstack-guardian/references/common-patterns.md +134 -134
  219. package/skills/backend/fullstack-guardian/references/deliverables-checklist.md +354 -354
  220. package/skills/backend/fullstack-guardian/references/design-template.md +91 -91
  221. package/skills/backend/fullstack-guardian/references/error-handling.md +135 -135
  222. package/skills/backend/fullstack-guardian/references/frontend-patterns.md +340 -340
  223. package/skills/backend/fullstack-guardian/references/integration-patterns.md +333 -333
  224. package/skills/backend/fullstack-guardian/references/security-checklist.md +106 -106
  225. package/skills/backend/graphql-architect/SKILL.md +146 -146
  226. package/skills/backend/graphql-architect/references/federation.md +418 -418
  227. package/skills/backend/graphql-architect/references/migration-from-rest.md +1141 -1141
  228. package/skills/backend/graphql-architect/references/resolvers.md +425 -425
  229. package/skills/backend/graphql-architect/references/schema-design.md +393 -393
  230. package/skills/backend/graphql-architect/references/security.md +569 -569
  231. package/skills/backend/graphql-architect/references/subscriptions.md +510 -510
  232. package/skills/backend/legacy-modernizer/SKILL.md +137 -137
  233. package/skills/backend/legacy-modernizer/references/legacy-testing.md +381 -381
  234. package/skills/backend/legacy-modernizer/references/migration-strategies.md +423 -423
  235. package/skills/backend/legacy-modernizer/references/refactoring-patterns.md +395 -395
  236. package/skills/backend/legacy-modernizer/references/strangler-fig-pattern.md +281 -281
  237. package/skills/backend/legacy-modernizer/references/system-assessment.md +487 -487
  238. package/skills/backend/microservices-architect/SKILL.md +164 -164
  239. package/skills/backend/microservices-architect/references/communication.md +499 -499
  240. package/skills/backend/microservices-architect/references/data.md +721 -721
  241. package/skills/backend/microservices-architect/references/decomposition.md +344 -344
  242. package/skills/backend/microservices-architect/references/observability.md +805 -805
  243. package/skills/backend/microservices-architect/references/patterns.md +603 -603
  244. package/skills/database/database-optimizer/SKILL.md +147 -147
  245. package/skills/database/database-optimizer/references/index-strategies.md +331 -331
  246. package/skills/database/database-optimizer/references/monitoring-analysis.md +501 -501
  247. package/skills/database/database-optimizer/references/mysql-tuning.md +452 -452
  248. package/skills/database/database-optimizer/references/postgresql-tuning.md +413 -413
  249. package/skills/database/database-optimizer/references/query-optimization.md +251 -251
  250. package/skills/database/postgres-pro/SKILL.md +152 -152
  251. package/skills/database/postgres-pro/references/extensions.md +404 -404
  252. package/skills/database/postgres-pro/references/jsonb.md +321 -321
  253. package/skills/database/postgres-pro/references/maintenance.md +481 -481
  254. package/skills/database/postgres-pro/references/performance.md +265 -265
  255. package/skills/database/postgres-pro/references/replication.md +446 -446
  256. package/skills/database/sql-pro/SKILL.md +129 -129
  257. package/skills/database/sql-pro/references/database-design.md +402 -402
  258. package/skills/database/sql-pro/references/dialect-differences.md +419 -419
  259. package/skills/database/sql-pro/references/optimization.md +384 -384
  260. package/skills/database/sql-pro/references/query-patterns.md +285 -285
  261. package/skills/database/sql-pro/references/window-functions.md +328 -328
  262. package/skills/dotnet/csharp-developer/SKILL.md +125 -125
  263. package/skills/dotnet/csharp-developer/references/aspnet-core.md +394 -394
  264. package/skills/dotnet/csharp-developer/references/blazor.md +553 -553
  265. package/skills/dotnet/csharp-developer/references/entity-framework.md +409 -409
  266. package/skills/dotnet/csharp-developer/references/modern-csharp.md +248 -248
  267. package/skills/dotnet/csharp-developer/references/performance.md +498 -498
  268. package/skills/dotnet/dotnet-core-expert/SKILL.md +138 -138
  269. package/skills/dotnet/dotnet-core-expert/references/authentication.md +546 -546
  270. package/skills/dotnet/dotnet-core-expert/references/clean-architecture.md +455 -455
  271. package/skills/dotnet/dotnet-core-expert/references/cloud-native.md +548 -548
  272. package/skills/dotnet/dotnet-core-expert/references/entity-framework.md +440 -440
  273. package/skills/dotnet/dotnet-core-expert/references/minimal-apis.md +319 -319
  274. package/skills/frontend/angular-architect/SKILL.md +152 -152
  275. package/skills/frontend/angular-architect/references/components.md +297 -297
  276. package/skills/frontend/angular-architect/references/ngrx.md +401 -401
  277. package/skills/frontend/angular-architect/references/routing.md +361 -361
  278. package/skills/frontend/angular-architect/references/rxjs.md +319 -319
  279. package/skills/frontend/angular-architect/references/testing.md +405 -405
  280. package/skills/frontend/design-commands/design.md +91 -91
  281. package/skills/frontend/design-commands/handoff.md +97 -97
  282. package/skills/frontend/design-commands/prototype.md +120 -120
  283. package/skills/frontend/design-commands/spec.md +160 -160
  284. package/skills/frontend/design-commands/style.md +78 -78
  285. package/skills/frontend/flutter-expert/SKILL.md +138 -138
  286. package/skills/frontend/flutter-expert/references/bloc-state.md +259 -259
  287. package/skills/frontend/flutter-expert/references/gorouter-navigation.md +119 -119
  288. package/skills/frontend/flutter-expert/references/performance.md +99 -99
  289. package/skills/frontend/flutter-expert/references/project-structure.md +118 -118
  290. package/skills/frontend/flutter-expert/references/riverpod-state.md +130 -130
  291. package/skills/frontend/flutter-expert/references/widget-patterns.md +123 -123
  292. package/skills/frontend/nextjs-developer/SKILL.md +143 -143
  293. package/skills/frontend/nextjs-developer/references/app-router.md +311 -311
  294. package/skills/frontend/nextjs-developer/references/data-fetching.md +482 -482
  295. package/skills/frontend/nextjs-developer/references/deployment.md +545 -545
  296. package/skills/frontend/nextjs-developer/references/server-actions.md +462 -462
  297. package/skills/frontend/nextjs-developer/references/server-components.md +384 -384
  298. package/skills/frontend/react-expert/SKILL.md +149 -149
  299. package/skills/frontend/react-expert/references/hooks-patterns.md +162 -162
  300. package/skills/frontend/react-expert/references/migration-class-to-modern.md +1119 -1119
  301. package/skills/frontend/react-expert/references/performance.md +168 -168
  302. package/skills/frontend/react-expert/references/react-19-features.md +174 -174
  303. package/skills/frontend/react-expert/references/server-components.md +143 -143
  304. package/skills/frontend/react-expert/references/state-management.md +171 -171
  305. package/skills/frontend/react-expert/references/testing-react.md +174 -174
  306. package/skills/frontend/react-native-expert/SKILL.md +185 -185
  307. package/skills/frontend/react-native-expert/references/expo-router.md +187 -187
  308. package/skills/frontend/react-native-expert/references/list-optimization.md +204 -204
  309. package/skills/frontend/react-native-expert/references/platform-handling.md +188 -188
  310. package/skills/frontend/react-native-expert/references/project-structure.md +171 -171
  311. package/skills/frontend/react-native-expert/references/storage-hooks.md +173 -173
  312. package/skills/frontend/senior-frontend/SKILL.md +477 -477
  313. package/skills/frontend/senior-frontend/references/frontend_best_practices.md +806 -806
  314. package/skills/frontend/senior-frontend/references/nextjs_optimization_guide.md +724 -724
  315. package/skills/frontend/senior-frontend/references/react_patterns.md +746 -746
  316. package/skills/frontend/senior-frontend/scripts/bundle_analyzer.py +407 -407
  317. package/skills/frontend/senior-frontend/scripts/component_generator.py +329 -329
  318. package/skills/frontend/senior-frontend/scripts/frontend_scaffolder.py +1005 -1005
  319. package/skills/frontend/ui-ux-pro-max/SKILL.md +386 -386
  320. package/skills/frontend/ui-ux-pro-max/data/charts.csv +26 -26
  321. package/skills/frontend/ui-ux-pro-max/data/colors.csv +97 -97
  322. package/skills/frontend/ui-ux-pro-max/data/icons.csv +101 -101
  323. package/skills/frontend/ui-ux-pro-max/data/landing.csv +31 -31
  324. package/skills/frontend/ui-ux-pro-max/data/products.csv +96 -96
  325. package/skills/frontend/ui-ux-pro-max/data/react-performance.csv +45 -45
  326. package/skills/frontend/ui-ux-pro-max/data/stacks/astro.csv +54 -54
  327. package/skills/frontend/ui-ux-pro-max/data/stacks/flutter.csv +53 -53
  328. package/skills/frontend/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -56
  329. package/skills/frontend/ui-ux-pro-max/data/stacks/jetpack-compose.csv +53 -53
  330. package/skills/frontend/ui-ux-pro-max/data/stacks/nextjs.csv +53 -53
  331. package/skills/frontend/ui-ux-pro-max/data/stacks/nuxt-ui.csv +51 -51
  332. package/skills/frontend/ui-ux-pro-max/data/stacks/nuxtjs.csv +59 -59
  333. package/skills/frontend/ui-ux-pro-max/data/stacks/react-native.csv +52 -52
  334. package/skills/frontend/ui-ux-pro-max/data/stacks/react.csv +54 -54
  335. package/skills/frontend/ui-ux-pro-max/data/stacks/shadcn.csv +61 -61
  336. package/skills/frontend/ui-ux-pro-max/data/stacks/svelte.csv +54 -54
  337. package/skills/frontend/ui-ux-pro-max/data/stacks/swiftui.csv +51 -51
  338. package/skills/frontend/ui-ux-pro-max/data/stacks/vue.csv +50 -50
  339. package/skills/frontend/ui-ux-pro-max/data/styles.csv +68 -68
  340. package/skills/frontend/ui-ux-pro-max/data/typography.csv +57 -57
  341. package/skills/frontend/ui-ux-pro-max/data/ui-reasoning.csv +101 -101
  342. package/skills/frontend/ui-ux-pro-max/data/ux-guidelines.csv +99 -99
  343. package/skills/frontend/ui-ux-pro-max/data/web-interface.csv +31 -31
  344. package/skills/frontend/ui-ux-pro-max/scripts/core.py +253 -253
  345. package/skills/frontend/ui-ux-pro-max/scripts/design_system.py +1067 -1067
  346. package/skills/frontend/ui-ux-pro-max/scripts/search.py +114 -114
  347. package/skills/frontend/vue-expert/SKILL.md +98 -98
  348. package/skills/frontend/vue-expert/references/build-tooling.md +480 -480
  349. package/skills/frontend/vue-expert/references/components.md +448 -448
  350. package/skills/frontend/vue-expert/references/composition-api.md +299 -299
  351. package/skills/frontend/vue-expert/references/mobile-hybrid.md +636 -636
  352. package/skills/frontend/vue-expert/references/nuxt.md +669 -669
  353. package/skills/frontend/vue-expert/references/state-management.md +449 -449
  354. package/skills/frontend/vue-expert/references/typescript.md +584 -584
  355. package/skills/frontend/vue-expert-js/SKILL.md +167 -167
  356. package/skills/frontend/vue-expert-js/references/component-architecture.md +219 -219
  357. package/skills/frontend/vue-expert-js/references/composables-patterns.md +183 -183
  358. package/skills/frontend/vue-expert-js/references/jsdoc-typing.md +535 -535
  359. package/skills/frontend/vue-expert-js/references/state-management.md +249 -249
  360. package/skills/frontend/vue-expert-js/references/testing-patterns.md +237 -237
  361. package/skills/go-rust-cpp/cpp-pro/SKILL.md +115 -115
  362. package/skills/go-rust-cpp/cpp-pro/references/build-tooling.md +440 -440
  363. package/skills/go-rust-cpp/cpp-pro/references/concurrency.md +437 -437
  364. package/skills/go-rust-cpp/cpp-pro/references/memory-performance.md +397 -397
  365. package/skills/go-rust-cpp/cpp-pro/references/modern-cpp.md +304 -304
  366. package/skills/go-rust-cpp/cpp-pro/references/templates.md +357 -357
  367. package/skills/go-rust-cpp/golang-pro/SKILL.md +122 -122
  368. package/skills/go-rust-cpp/golang-pro/references/concurrency.md +329 -329
  369. package/skills/go-rust-cpp/golang-pro/references/generics.md +442 -442
  370. package/skills/go-rust-cpp/golang-pro/references/interfaces.md +432 -432
  371. package/skills/go-rust-cpp/golang-pro/references/project-structure.md +477 -477
  372. package/skills/go-rust-cpp/golang-pro/references/testing.md +451 -451
  373. package/skills/go-rust-cpp/rust-engineer/SKILL.md +167 -167
  374. package/skills/go-rust-cpp/rust-engineer/references/async.md +458 -458
  375. package/skills/go-rust-cpp/rust-engineer/references/error-handling.md +334 -334
  376. package/skills/go-rust-cpp/rust-engineer/references/ownership.md +278 -278
  377. package/skills/go-rust-cpp/rust-engineer/references/testing.md +470 -470
  378. package/skills/go-rust-cpp/rust-engineer/references/traits.md +413 -413
  379. package/skills/infra/cli-developer/SKILL.md +113 -113
  380. package/skills/infra/cli-developer/references/design-patterns.md +221 -221
  381. package/skills/infra/cli-developer/references/go-cli.md +540 -540
  382. package/skills/infra/cli-developer/references/node-cli.md +383 -383
  383. package/skills/infra/cli-developer/references/python-cli.md +422 -422
  384. package/skills/infra/cli-developer/references/ux-patterns.md +448 -448
  385. package/skills/infra/cloud-architect/SKILL.md +216 -216
  386. package/skills/infra/cloud-architect/references/aws.md +394 -394
  387. package/skills/infra/cloud-architect/references/azure.md +562 -562
  388. package/skills/infra/cloud-architect/references/cost.md +582 -582
  389. package/skills/infra/cloud-architect/references/gcp.md +633 -633
  390. package/skills/infra/cloud-architect/references/multi-cloud.md +483 -483
  391. package/skills/infra/devops-engineer/SKILL.md +144 -144
  392. package/skills/infra/devops-engineer/references/deployment-strategies.md +241 -241
  393. package/skills/infra/devops-engineer/references/docker-patterns.md +113 -113
  394. package/skills/infra/devops-engineer/references/github-actions.md +139 -139
  395. package/skills/infra/devops-engineer/references/incident-response.md +331 -331
  396. package/skills/infra/devops-engineer/references/kubernetes.md +154 -154
  397. package/skills/infra/devops-engineer/references/platform-engineering.md +417 -417
  398. package/skills/infra/devops-engineer/references/release-automation.md +527 -527
  399. package/skills/infra/devops-engineer/references/terraform-iac.md +141 -141
  400. package/skills/infra/kubernetes-specialist/SKILL.md +241 -241
  401. package/skills/infra/kubernetes-specialist/references/configuration.md +452 -452
  402. package/skills/infra/kubernetes-specialist/references/cost-optimization.md +458 -458
  403. package/skills/infra/kubernetes-specialist/references/custom-operators.md +563 -563
  404. package/skills/infra/kubernetes-specialist/references/gitops.md +530 -530
  405. package/skills/infra/kubernetes-specialist/references/helm-charts.md +912 -912
  406. package/skills/infra/kubernetes-specialist/references/multi-cluster.md +507 -507
  407. package/skills/infra/kubernetes-specialist/references/networking.md +447 -447
  408. package/skills/infra/kubernetes-specialist/references/service-mesh.md +459 -459
  409. package/skills/infra/kubernetes-specialist/references/storage.md +535 -535
  410. package/skills/infra/kubernetes-specialist/references/troubleshooting.md +414 -414
  411. package/skills/infra/kubernetes-specialist/references/workloads.md +377 -377
  412. package/skills/infra/mcp-developer/SKILL.md +143 -143
  413. package/skills/infra/mcp-developer/references/protocol.md +244 -244
  414. package/skills/infra/mcp-developer/references/python-sdk.md +367 -367
  415. package/skills/infra/mcp-developer/references/resources.md +554 -554
  416. package/skills/infra/mcp-developer/references/tools.md +480 -480
  417. package/skills/infra/mcp-developer/references/typescript-sdk.md +350 -350
  418. package/skills/infra/monitoring-expert/SKILL.md +176 -176
  419. package/skills/infra/monitoring-expert/references/alerting-rules.md +141 -141
  420. package/skills/infra/monitoring-expert/references/application-profiling.md +331 -331
  421. package/skills/infra/monitoring-expert/references/capacity-planning.md +344 -344
  422. package/skills/infra/monitoring-expert/references/dashboards.md +126 -126
  423. package/skills/infra/monitoring-expert/references/opentelemetry.md +123 -123
  424. package/skills/infra/monitoring-expert/references/performance-testing.md +269 -269
  425. package/skills/infra/monitoring-expert/references/prometheus-metrics.md +136 -136
  426. package/skills/infra/monitoring-expert/references/structured-logging.md +142 -142
  427. package/skills/infra/sre-engineer/SKILL.md +181 -181
  428. package/skills/infra/sre-engineer/references/automation-toil.md +492 -492
  429. package/skills/infra/sre-engineer/references/error-budget-policy.md +334 -334
  430. package/skills/infra/sre-engineer/references/incident-chaos.md +576 -576
  431. package/skills/infra/sre-engineer/references/monitoring-alerting.md +424 -424
  432. package/skills/infra/sre-engineer/references/slo-sli-management.md +238 -238
  433. package/skills/infra/terraform-engineer/SKILL.md +143 -143
  434. package/skills/infra/terraform-engineer/references/best-practices.md +583 -583
  435. package/skills/infra/terraform-engineer/references/module-patterns.md +297 -297
  436. package/skills/infra/terraform-engineer/references/providers.md +452 -452
  437. package/skills/infra/terraform-engineer/references/state-management.md +371 -371
  438. package/skills/infra/terraform-engineer/references/testing.md +486 -486
  439. package/skills/infra/websocket-engineer/SKILL.md +168 -168
  440. package/skills/infra/websocket-engineer/references/alternatives.md +391 -391
  441. package/skills/infra/websocket-engineer/references/patterns.md +400 -400
  442. package/skills/infra/websocket-engineer/references/protocol.md +195 -195
  443. package/skills/infra/websocket-engineer/references/scaling.md +333 -333
  444. package/skills/infra/websocket-engineer/references/security.md +474 -474
  445. package/skills/java/java-architect/SKILL.md +132 -132
  446. package/skills/java/java-architect/references/jpa-optimization.md +393 -393
  447. package/skills/java/java-architect/references/reactive-webflux.md +356 -356
  448. package/skills/java/java-architect/references/spring-boot-setup.md +269 -269
  449. package/skills/java/java-architect/references/spring-security.md +445 -445
  450. package/skills/java/java-architect/references/testing-patterns.md +500 -500
  451. package/skills/java/kotlin-specialist/SKILL.md +147 -147
  452. package/skills/java/kotlin-specialist/references/android-compose.md +419 -419
  453. package/skills/java/kotlin-specialist/references/coroutines-flow.md +276 -276
  454. package/skills/java/kotlin-specialist/references/dsl-idioms.md +421 -421
  455. package/skills/java/kotlin-specialist/references/ktor-server.md +426 -426
  456. package/skills/java/kotlin-specialist/references/multiplatform-kmp.md +380 -380
  457. package/skills/java/spring-boot-engineer/SKILL.md +195 -195
  458. package/skills/java/spring-boot-engineer/references/cloud.md +498 -498
  459. package/skills/java/spring-boot-engineer/references/data.md +381 -381
  460. package/skills/java/spring-boot-engineer/references/security.md +459 -459
  461. package/skills/java/spring-boot-engineer/references/testing.md +545 -545
  462. package/skills/java/spring-boot-engineer/references/web.md +295 -295
  463. package/skills/javascript/javascript-pro/SKILL.md +132 -132
  464. package/skills/javascript/javascript-pro/references/async-patterns.md +334 -334
  465. package/skills/javascript/javascript-pro/references/browser-apis.md +398 -398
  466. package/skills/javascript/javascript-pro/references/modern-syntax.md +272 -272
  467. package/skills/javascript/javascript-pro/references/modules.md +357 -357
  468. package/skills/javascript/javascript-pro/references/node-essentials.md +471 -471
  469. package/skills/javascript/nestjs-expert/SKILL.md +206 -206
  470. package/skills/javascript/nestjs-expert/references/authentication.md +166 -166
  471. package/skills/javascript/nestjs-expert/references/controllers-routing.md +111 -111
  472. package/skills/javascript/nestjs-expert/references/dtos-validation.md +153 -153
  473. package/skills/javascript/nestjs-expert/references/migration-from-express.md +1237 -1237
  474. package/skills/javascript/nestjs-expert/references/services-di.md +140 -140
  475. package/skills/javascript/nestjs-expert/references/testing-patterns.md +186 -186
  476. package/skills/javascript/typescript-pro/SKILL.md +145 -145
  477. package/skills/javascript/typescript-pro/references/advanced-types.md +259 -259
  478. package/skills/javascript/typescript-pro/references/configuration.md +445 -445
  479. package/skills/javascript/typescript-pro/references/patterns.md +484 -484
  480. package/skills/javascript/typescript-pro/references/type-guards.md +352 -352
  481. package/skills/javascript/typescript-pro/references/utility-types.md +329 -329
  482. package/skills/php/laravel-specialist/SKILL.md +262 -262
  483. package/skills/php/laravel-specialist/references/eloquent.md +351 -351
  484. package/skills/php/laravel-specialist/references/livewire.md +512 -512
  485. package/skills/php/laravel-specialist/references/queues.md +423 -423
  486. package/skills/php/laravel-specialist/references/routing.md +362 -362
  487. package/skills/php/laravel-specialist/references/testing.md +522 -522
  488. package/skills/php/php-pro/SKILL.md +206 -206
  489. package/skills/php/php-pro/references/async-patterns.md +412 -412
  490. package/skills/php/php-pro/references/laravel-patterns.md +377 -377
  491. package/skills/php/php-pro/references/modern-php-features.md +323 -323
  492. package/skills/php/php-pro/references/symfony-patterns.md +466 -466
  493. package/skills/php/php-pro/references/testing-quality.md +466 -466
  494. package/skills/product/competitive-analysis/SKILL.md +257 -257
  495. package/skills/product/meeting-notes/SKILL.md +266 -266
  496. package/skills/product/prd-template/SKILL.md +150 -150
  497. package/skills/product/stakeholder-update/SKILL.md +225 -225
  498. package/skills/product/user-research-synthesis/SKILL.md +235 -235
  499. package/skills/python/django-expert/SKILL.md +162 -162
  500. package/skills/python/django-expert/references/authentication.md +145 -145
  501. package/skills/python/django-expert/references/drf-serializers.md +148 -148
  502. package/skills/python/django-expert/references/models-orm.md +151 -151
  503. package/skills/python/django-expert/references/testing-django.md +204 -204
  504. package/skills/python/django-expert/references/viewsets-views.md +153 -153
  505. package/skills/python/fastapi-expert/SKILL.md +185 -185
  506. package/skills/python/fastapi-expert/references/async-sqlalchemy.md +146 -146
  507. package/skills/python/fastapi-expert/references/authentication.md +159 -159
  508. package/skills/python/fastapi-expert/references/endpoints-routing.md +142 -142
  509. package/skills/python/fastapi-expert/references/migration-from-django.md +996 -996
  510. package/skills/python/fastapi-expert/references/pydantic-v2.md +135 -135
  511. package/skills/python/fastapi-expert/references/testing-async.md +159 -159
  512. package/skills/python/pandas-pro/SKILL.md +178 -178
  513. package/skills/python/pandas-pro/references/aggregation-groupby.md +545 -545
  514. package/skills/python/pandas-pro/references/data-cleaning.md +500 -500
  515. package/skills/python/pandas-pro/references/dataframe-operations.md +420 -420
  516. package/skills/python/pandas-pro/references/merging-joining.md +596 -596
  517. package/skills/python/pandas-pro/references/performance-optimization.md +597 -597
  518. package/skills/python/python-pro/SKILL.md +177 -177
  519. package/skills/python/python-pro/references/async-patterns.md +356 -356
  520. package/skills/python/python-pro/references/packaging.md +460 -460
  521. package/skills/python/python-pro/references/standard-library.md +378 -378
  522. package/skills/python/python-pro/references/testing.md +404 -404
  523. package/skills/python/python-pro/references/type-system.md +290 -290
  524. package/skills/quality/chaos-engineer/SKILL.md +182 -182
  525. package/skills/quality/chaos-engineer/references/chaos-tools.md +511 -511
  526. package/skills/quality/chaos-engineer/references/experiment-design.md +229 -229
  527. package/skills/quality/chaos-engineer/references/game-days.md +434 -434
  528. package/skills/quality/chaos-engineer/references/infrastructure-chaos.md +348 -348
  529. package/skills/quality/chaos-engineer/references/kubernetes-chaos.md +432 -432
  530. package/skills/quality/code-reviewer/SKILL.md +119 -119
  531. package/skills/quality/code-reviewer/references/common-issues.md +142 -142
  532. package/skills/quality/code-reviewer/references/feedback-examples.md +144 -144
  533. package/skills/quality/code-reviewer/references/receiving-feedback.md +238 -238
  534. package/skills/quality/code-reviewer/references/report-template.md +109 -109
  535. package/skills/quality/code-reviewer/references/review-checklist.md +88 -88
  536. package/skills/quality/code-reviewer/references/spec-compliance-review.md +258 -258
  537. package/skills/quality/playwright-expert/SKILL.md +169 -169
  538. package/skills/quality/playwright-expert/references/api-mocking.md +140 -140
  539. package/skills/quality/playwright-expert/references/configuration.md +155 -155
  540. package/skills/quality/playwright-expert/references/debugging-flaky.md +150 -150
  541. package/skills/quality/playwright-expert/references/page-object-model.md +152 -152
  542. package/skills/quality/playwright-expert/references/selectors-locators.md +119 -119
  543. package/skills/quality/secure-code-guardian/SKILL.md +191 -191
  544. package/skills/quality/secure-code-guardian/references/authentication.md +136 -136
  545. package/skills/quality/secure-code-guardian/references/input-validation.md +146 -146
  546. package/skills/quality/secure-code-guardian/references/owasp-prevention.md +135 -135
  547. package/skills/quality/secure-code-guardian/references/security-headers.md +133 -133
  548. package/skills/quality/secure-code-guardian/references/xss-csrf.md +157 -157
  549. package/skills/quality/security-reviewer/SKILL.md +103 -103
  550. package/skills/quality/security-reviewer/references/infrastructure-security.md +268 -268
  551. package/skills/quality/security-reviewer/references/penetration-testing.md +268 -268
  552. package/skills/quality/security-reviewer/references/report-template.md +170 -170
  553. package/skills/quality/security-reviewer/references/sast-tools.md +117 -117
  554. package/skills/quality/security-reviewer/references/secret-scanning.md +125 -125
  555. package/skills/quality/security-reviewer/references/vulnerability-patterns.md +152 -152
  556. package/skills/quality/senior-qa/README.md +196 -196
  557. package/skills/quality/senior-qa/SKILL.md +399 -399
  558. package/skills/quality/senior-qa/references/qa_best_practices.md +964 -964
  559. package/skills/quality/senior-qa/references/test_automation_patterns.md +1009 -1009
  560. package/skills/quality/senior-qa/references/testing_strategies.md +649 -649
  561. package/skills/quality/senior-qa/scripts/coverage_analyzer.py +836 -836
  562. package/skills/quality/senior-qa/scripts/e2e_test_scaffolder.py +820 -820
  563. package/skills/quality/senior-qa/scripts/test_suite_generator.py +605 -605
  564. package/skills/quality/tdd-guide/HOW_TO_USE.md +313 -313
  565. package/skills/quality/tdd-guide/README.md +680 -680
  566. package/skills/quality/tdd-guide/SKILL.md +122 -122
  567. package/skills/quality/tdd-guide/assets/expected_output.json +77 -77
  568. package/skills/quality/tdd-guide/assets/sample_input_python.json +39 -39
  569. package/skills/quality/tdd-guide/assets/sample_input_typescript.json +36 -36
  570. package/skills/quality/tdd-guide/references/ci-integration.md +195 -195
  571. package/skills/quality/tdd-guide/references/framework-guide.md +206 -206
  572. package/skills/quality/tdd-guide/references/tdd-best-practices.md +128 -128
  573. package/skills/quality/tdd-guide/scripts/coverage_analyzer.py +434 -434
  574. package/skills/quality/tdd-guide/scripts/fixture_generator.py +440 -440
  575. package/skills/quality/tdd-guide/scripts/format_detector.py +384 -384
  576. package/skills/quality/tdd-guide/scripts/framework_adapter.py +428 -428
  577. package/skills/quality/tdd-guide/scripts/metrics_calculator.py +456 -456
  578. package/skills/quality/tdd-guide/scripts/output_formatter.py +354 -354
  579. package/skills/quality/tdd-guide/scripts/tdd_workflow.py +474 -474
  580. package/skills/quality/tdd-guide/scripts/test_generator.py +438 -438
  581. package/skills/quality/test-master/SKILL.md +94 -94
  582. package/skills/quality/test-master/references/automation-frameworks.md +294 -294
  583. package/skills/quality/test-master/references/e2e-testing.md +128 -128
  584. package/skills/quality/test-master/references/integration-testing.md +120 -120
  585. package/skills/quality/test-master/references/performance-testing.md +118 -118
  586. package/skills/quality/test-master/references/qa-methodology.md +247 -247
  587. package/skills/quality/test-master/references/security-testing.md +127 -127
  588. package/skills/quality/test-master/references/tdd-iron-laws.md +174 -174
  589. package/skills/quality/test-master/references/test-reports.md +104 -104
  590. package/skills/quality/test-master/references/testing-anti-patterns.md +231 -231
  591. package/skills/quality/test-master/references/unit-testing.md +113 -113
  592. package/skills/ruby/rails-expert/SKILL.md +154 -154
  593. package/skills/ruby/rails-expert/references/active-record.md +244 -244
  594. package/skills/ruby/rails-expert/references/api-development.md +401 -401
  595. package/skills/ruby/rails-expert/references/background-jobs.md +272 -272
  596. package/skills/ruby/rails-expert/references/hotwire-turbo.md +228 -228
  597. package/skills/ruby/rails-expert/references/rspec-testing.md +367 -367
  598. package/skills/swift/swift-expert/SKILL.md +163 -163
  599. package/skills/swift/swift-expert/references/async-concurrency.md +360 -360
  600. package/skills/swift/swift-expert/references/memory-performance.md +377 -377
  601. package/skills/swift/swift-expert/references/protocol-oriented.md +354 -354
  602. package/skills/swift/swift-expert/references/swiftui-patterns.md +291 -291
  603. package/skills/swift/swift-expert/references/testing-patterns.md +399 -399
  604. package/skills/workflow/brainstorming/SKILL.md +164 -164
  605. package/skills/workflow/brainstorming/scripts/frame-template.html +214 -214
  606. package/skills/workflow/brainstorming/scripts/helper.js +88 -88
  607. package/skills/workflow/brainstorming/scripts/server.cjs +354 -354
  608. package/skills/workflow/brainstorming/scripts/start-server.sh +148 -148
  609. package/skills/workflow/brainstorming/scripts/stop-server.sh +56 -56
  610. package/skills/workflow/brainstorming/spec-document-reviewer-prompt.md +49 -49
  611. package/skills/workflow/brainstorming/visual-companion.md +287 -287
  612. package/skills/workflow/documentation/SKILL.md +45 -45
  613. package/skills/workflow/entropy-management/SKILL.md +115 -115
  614. package/skills/workflow/executing-plans/SKILL.md +70 -70
  615. package/skills/workflow/finishing-a-development-branch/SKILL.md +200 -200
  616. package/skills/workflow/receiving-code-review/SKILL.md +213 -213
  617. package/skills/workflow/requesting-code-review/SKILL.md +105 -105
  618. package/skills/workflow/requesting-code-review/code-reviewer.md +146 -146
  619. package/skills/workflow/requirement-engineering/SKILL.md +111 -111
  620. package/skills/workflow/systematic-debugging/CREATION-LOG.md +119 -119
  621. package/skills/workflow/systematic-debugging/SKILL.md +296 -296
  622. package/skills/workflow/systematic-debugging/condition-based-waiting-example.ts +158 -158
  623. package/skills/workflow/systematic-debugging/condition-based-waiting.md +115 -115
  624. package/skills/workflow/systematic-debugging/defense-in-depth.md +122 -122
  625. package/skills/workflow/systematic-debugging/find-polluter.sh +63 -63
  626. package/skills/workflow/systematic-debugging/root-cause-tracing.md +169 -169
  627. package/skills/workflow/systematic-debugging/test-academic.md +14 -14
  628. package/skills/workflow/systematic-debugging/test-pressure-1.md +58 -58
  629. package/skills/workflow/systematic-debugging/test-pressure-2.md +68 -68
  630. package/skills/workflow/systematic-debugging/test-pressure-3.md +69 -69
  631. package/skills/workflow/using-git-worktrees/SKILL.md +218 -218
  632. package/skills/workflow/verification-before-completion/SKILL.md +139 -139
  633. package/skills/workflow/writing-plans/SKILL.md +151 -151
  634. package/skills/workflow/writing-plans/plan-document-reviewer-prompt.md +49 -49
  635. package/skills/workflow/writing-skills/SKILL.md +655 -655
  636. package/skills/workflow/writing-skills/anthropic-best-practices.md +1150 -1150
  637. package/skills/workflow/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -189
  638. package/skills/workflow/writing-skills/persuasion-principles.md +187 -187
  639. package/skills/workflow/writing-skills/render-graphs.js +168 -168
  640. package/skills/workflow/writing-skills/testing-skills-with-subagents.md +384 -384
@@ -1,878 +1,878 @@
1
- # Chunking Strategies
2
-
3
- ---
4
-
5
- ## Strategy Comparison Matrix
6
-
7
- | Strategy | Best For | Chunk Quality | Implementation Complexity |
8
- |----------|----------|---------------|---------------------------|
9
- | **Fixed-size** | Simple documents, logs | Low-Medium | Simple |
10
- | **Recursive character** | General text, articles | Medium | Simple |
11
- | **Sentence-based** | Conversational, Q&A | Medium-High | Medium |
12
- | **Semantic** | Technical docs, manuals | High | Medium |
13
- | **Document-aware** | Structured content (MD, HTML) | High | Medium |
14
- | **Agentic/Contextual** | Complex documents | Very High | Complex |
15
- | **Late chunking** | Long-context embeddings | High | Medium |
16
-
17
- ---
18
-
19
- ## When to Use Each Strategy
20
-
21
- ### Fixed-Size Chunking
22
- ```
23
- Best For:
24
- - Log files and structured data
25
- - Quick prototyping
26
- - When content has no natural structure
27
- - Baseline comparison
28
-
29
- When to Avoid:
30
- - Technical documentation
31
- - Content with semantic units (paragraphs, sections)
32
- - When context preservation matters
33
- ```
34
-
35
- ### Recursive Character Splitting
36
- ```
37
- Best For:
38
- - General articles and blog posts
39
- - Mixed content types
40
- - Default starting point for most RAG
41
- - LangChain/LlamaIndex default
42
-
43
- When to Avoid:
44
- - Highly structured documents
45
- - Code-heavy content
46
- - Tables and lists
47
- ```
48
-
49
- ### Semantic Chunking
50
- ```
51
- Best For:
52
- - Technical documentation
53
- - Research papers
54
- - Content with natural topic boundaries
55
- - When retrieval precision is critical
56
-
57
- When to Avoid:
58
- - Real-time ingestion (slower)
59
- - Very short documents
60
- - Cost-sensitive pipelines (requires embeddings)
61
- ```
62
-
63
- ### Document-Aware Chunking
64
- ```
65
- Best For:
66
- - Markdown documentation
67
- - HTML pages
68
- - LaTeX papers
69
- - Code files
70
-
71
- When to Avoid:
72
- - Plain text without structure
73
- - Inconsistent formatting
74
- ```
75
-
76
- ---
77
-
78
- ## Fixed-Size Chunking
79
-
80
- ```python
81
- def fixed_size_chunk(
82
- text: str,
83
- chunk_size: int = 500,
84
- overlap: int = 50
85
- ) -> list[str]:
86
- """Simple fixed-size chunking with overlap."""
87
- chunks = []
88
- start = 0
89
-
90
- while start < len(text):
91
- end = start + chunk_size
92
- chunk = text[start:end]
93
-
94
- # Try to break at word boundary
95
- if end < len(text):
96
- last_space = chunk.rfind(' ')
97
- if last_space > chunk_size * 0.8: # Only if reasonably far in
98
- chunk = chunk[:last_space]
99
- end = start + last_space
100
-
101
- chunks.append(chunk.strip())
102
- start = end - overlap
103
-
104
- return chunks
105
-
106
- # Usage
107
- chunks = fixed_size_chunk(document_text, chunk_size=500, overlap=50)
108
- ```
109
-
110
- ---
111
-
112
- ## Recursive Character Splitting (LangChain Style)
113
-
114
- ```python
115
- from typing import Callable
116
-
117
- class RecursiveCharacterSplitter:
118
- """Split text recursively using multiple separators."""
119
-
120
- def __init__(
121
- self,
122
- chunk_size: int = 1000,
123
- chunk_overlap: int = 200,
124
- separators: list[str] | None = None,
125
- length_function: Callable[[str], int] = len
126
- ):
127
- self.chunk_size = chunk_size
128
- self.chunk_overlap = chunk_overlap
129
- self.separators = separators or ["\n\n", "\n", ". ", " ", ""]
130
- self.length_function = length_function
131
-
132
- def split_text(self, text: str) -> list[str]:
133
- """Split text into chunks."""
134
- return self._split_text(text, self.separators)
135
-
136
- def _split_text(self, text: str, separators: list[str]) -> list[str]:
137
- final_chunks = []
138
- separator = separators[-1]
139
-
140
- for i, sep in enumerate(separators):
141
- if sep == "":
142
- separator = sep
143
- break
144
- if sep in text:
145
- separator = sep
146
- break
147
-
148
- splits = text.split(separator) if separator else list(text)
149
-
150
- good_splits = []
151
- for split in splits:
152
- if self.length_function(split) < self.chunk_size:
153
- good_splits.append(split)
154
- else:
155
- if good_splits:
156
- merged = self._merge_splits(good_splits, separator)
157
- final_chunks.extend(merged)
158
- good_splits = []
159
- # Recursively split large chunks
160
- other_chunks = self._split_text(split, separators[separators.index(separator) + 1:])
161
- final_chunks.extend(other_chunks)
162
-
163
- if good_splits:
164
- merged = self._merge_splits(good_splits, separator)
165
- final_chunks.extend(merged)
166
-
167
- return final_chunks
168
-
169
- def _merge_splits(self, splits: list[str], separator: str) -> list[str]:
170
- """Merge splits into chunks respecting size limits."""
171
- chunks = []
172
- current_chunk = []
173
- current_length = 0
174
-
175
- for split in splits:
176
- split_length = self.length_function(split)
177
-
178
- if current_length + split_length > self.chunk_size:
179
- if current_chunk:
180
- chunks.append(separator.join(current_chunk))
181
- # Keep overlap
182
- while current_length > self.chunk_overlap and current_chunk:
183
- current_length -= self.length_function(current_chunk[0])
184
- current_chunk = current_chunk[1:]
185
-
186
- current_chunk.append(split)
187
- current_length += split_length
188
-
189
- if current_chunk:
190
- chunks.append(separator.join(current_chunk))
191
-
192
- return chunks
193
-
194
- # Usage
195
- splitter = RecursiveCharacterSplitter(
196
- chunk_size=1000,
197
- chunk_overlap=200,
198
- separators=["\n\n", "\n", ". ", " "]
199
- )
200
- chunks = splitter.split_text(document_text)
201
- ```
202
-
203
- ### Token-Based Splitting
204
-
205
- ```python
206
- import tiktoken
207
-
208
- def create_token_splitter(
209
- model: str = "gpt-4",
210
- chunk_size: int = 500,
211
- chunk_overlap: int = 50
212
- ):
213
- """Create splitter that counts tokens instead of characters."""
214
- encoding = tiktoken.encoding_for_model(model)
215
-
216
- def token_length(text: str) -> int:
217
- return len(encoding.encode(text))
218
-
219
- return RecursiveCharacterSplitter(
220
- chunk_size=chunk_size,
221
- chunk_overlap=chunk_overlap,
222
- length_function=token_length
223
- )
224
-
225
- # Usage
226
- token_splitter = create_token_splitter(chunk_size=500, chunk_overlap=50)
227
- chunks = token_splitter.split_text(document_text)
228
- ```
229
-
230
- ---
231
-
232
- ## Sentence-Based Chunking
233
-
234
- ```python
235
- import re
236
- from dataclasses import dataclass
237
-
238
- @dataclass
239
- class SentenceChunk:
240
- text: str
241
- sentences: list[str]
242
- start_sentence: int
243
- end_sentence: int
244
-
245
- def sentence_chunk(
246
- text: str,
247
- sentences_per_chunk: int = 5,
248
- overlap_sentences: int = 1
249
- ) -> list[SentenceChunk]:
250
- """Chunk by sentence count with overlap."""
251
- # Split into sentences
252
- sentence_pattern = r'(?<=[.!?])\s+'
253
- sentences = re.split(sentence_pattern, text)
254
- sentences = [s.strip() for s in sentences if s.strip()]
255
-
256
- chunks = []
257
- i = 0
258
-
259
- while i < len(sentences):
260
- end = min(i + sentences_per_chunk, len(sentences))
261
- chunk_sentences = sentences[i:end]
262
-
263
- chunks.append(SentenceChunk(
264
- text=" ".join(chunk_sentences),
265
- sentences=chunk_sentences,
266
- start_sentence=i,
267
- end_sentence=end - 1
268
- ))
269
-
270
- i += sentences_per_chunk - overlap_sentences
271
-
272
- return chunks
273
-
274
- # Better sentence splitting with NLTK
275
- import nltk
276
- nltk.download('punkt')
277
- from nltk.tokenize import sent_tokenize
278
-
279
- def sentence_chunk_nltk(
280
- text: str,
281
- max_chunk_size: int = 1000,
282
- overlap_sentences: int = 2
283
- ) -> list[str]:
284
- """Chunk by sentences up to max size."""
285
- sentences = sent_tokenize(text)
286
- chunks = []
287
- current_chunk = []
288
- current_size = 0
289
-
290
- for sentence in sentences:
291
- sentence_size = len(sentence)
292
-
293
- if current_size + sentence_size > max_chunk_size and current_chunk:
294
- chunks.append(" ".join(current_chunk))
295
- # Keep overlap sentences
296
- current_chunk = current_chunk[-overlap_sentences:] if overlap_sentences else []
297
- current_size = sum(len(s) for s in current_chunk)
298
-
299
- current_chunk.append(sentence)
300
- current_size += sentence_size
301
-
302
- if current_chunk:
303
- chunks.append(" ".join(current_chunk))
304
-
305
- return chunks
306
- ```
307
-
308
- ---
309
-
310
- ## Semantic Chunking
311
-
312
- ```python
313
- import numpy as np
314
- from sentence_transformers import SentenceTransformer
315
- from sklearn.metrics.pairwise import cosine_similarity
316
-
317
- class SemanticChunker:
318
- """Chunk based on semantic similarity between sentences."""
319
-
320
- def __init__(
321
- self,
322
- model_name: str = "all-MiniLM-L6-v2",
323
- similarity_threshold: float = 0.5,
324
- min_chunk_size: int = 100,
325
- max_chunk_size: int = 1500
326
- ):
327
- self.model = SentenceTransformer(model_name)
328
- self.similarity_threshold = similarity_threshold
329
- self.min_chunk_size = min_chunk_size
330
- self.max_chunk_size = max_chunk_size
331
-
332
- def chunk(self, text: str) -> list[str]:
333
- """Split text at semantic boundaries."""
334
- # Split into sentences
335
- sentences = self._split_sentences(text)
336
- if len(sentences) <= 1:
337
- return [text]
338
-
339
- # Get embeddings
340
- embeddings = self.model.encode(sentences)
341
-
342
- # Find breakpoints based on similarity drops
343
- breakpoints = self._find_breakpoints(embeddings)
344
-
345
- # Create chunks
346
- chunks = []
347
- start = 0
348
-
349
- for bp in breakpoints:
350
- chunk_text = " ".join(sentences[start:bp])
351
-
352
- # Handle size constraints
353
- if len(chunk_text) > self.max_chunk_size:
354
- # Split large chunks
355
- sub_chunks = self._split_large_chunk(sentences[start:bp])
356
- chunks.extend(sub_chunks)
357
- elif len(chunk_text) >= self.min_chunk_size:
358
- chunks.append(chunk_text)
359
- elif chunks:
360
- # Merge small chunk with previous
361
- chunks[-1] += " " + chunk_text
362
- else:
363
- chunks.append(chunk_text)
364
-
365
- start = bp
366
-
367
- # Handle remaining sentences
368
- if start < len(sentences):
369
- remaining = " ".join(sentences[start:])
370
- if chunks and len(remaining) < self.min_chunk_size:
371
- chunks[-1] += " " + remaining
372
- else:
373
- chunks.append(remaining)
374
-
375
- return chunks
376
-
377
- def _split_sentences(self, text: str) -> list[str]:
378
- """Split text into sentences."""
379
- import re
380
- sentences = re.split(r'(?<=[.!?])\s+', text)
381
- return [s.strip() for s in sentences if s.strip()]
382
-
383
- def _find_breakpoints(self, embeddings: np.ndarray) -> list[int]:
384
- """Find semantic breakpoints using similarity drops."""
385
- breakpoints = []
386
-
387
- for i in range(1, len(embeddings)):
388
- similarity = cosine_similarity(
389
- embeddings[i-1:i],
390
- embeddings[i:i+1]
391
- )[0][0]
392
-
393
- if similarity < self.similarity_threshold:
394
- breakpoints.append(i)
395
-
396
- return breakpoints
397
-
398
- def _split_large_chunk(self, sentences: list[str]) -> list[str]:
399
- """Split oversized chunk at midpoint."""
400
- mid = len(sentences) // 2
401
- return [
402
- " ".join(sentences[:mid]),
403
- " ".join(sentences[mid:])
404
- ]
405
-
406
- # Usage
407
- chunker = SemanticChunker(
408
- similarity_threshold=0.5,
409
- min_chunk_size=200,
410
- max_chunk_size=1000
411
- )
412
- semantic_chunks = chunker.chunk(document_text)
413
- ```
414
-
415
- ### Percentile-Based Breakpoints
416
-
417
- ```python
418
- def find_breakpoints_percentile(
419
- embeddings: np.ndarray,
420
- percentile: int = 25
421
- ) -> list[int]:
422
- """Find breakpoints at similarity drops below percentile threshold."""
423
- similarities = []
424
-
425
- for i in range(1, len(embeddings)):
426
- sim = cosine_similarity(
427
- embeddings[i-1:i],
428
- embeddings[i:i+1]
429
- )[0][0]
430
- similarities.append((i, sim))
431
-
432
- # Dynamic threshold based on distribution
433
- sim_values = [s[1] for s in similarities]
434
- threshold = np.percentile(sim_values, percentile)
435
-
436
- return [i for i, sim in similarities if sim < threshold]
437
- ```
438
-
439
- ---
440
-
441
- ## Document-Aware Chunking
442
-
443
- ### Markdown Chunking
444
-
445
- ```python
446
- import re
447
- from dataclasses import dataclass
448
-
449
- @dataclass
450
- class MarkdownChunk:
451
- text: str
452
- heading: str | None
453
- heading_level: int
454
- metadata: dict
455
-
456
- def chunk_markdown(
457
- text: str,
458
- max_chunk_size: int = 1500,
459
- include_heading_in_chunk: bool = True
460
- ) -> list[MarkdownChunk]:
461
- """Chunk markdown by headers while respecting structure."""
462
- # Pattern to match headers
463
- header_pattern = r'^(#{1,6})\s+(.+)$'
464
-
465
- lines = text.split('\n')
466
- chunks = []
467
- current_chunk_lines = []
468
- current_heading = None
469
- current_level = 0
470
- heading_stack = [] # For breadcrumb context
471
-
472
- for line in lines:
473
- header_match = re.match(header_pattern, line)
474
-
475
- if header_match:
476
- # Save current chunk if exists
477
- if current_chunk_lines:
478
- chunk_text = '\n'.join(current_chunk_lines)
479
- if len(chunk_text.strip()) > 0:
480
- prefix = f"# {current_heading}\n\n" if include_heading_in_chunk and current_heading else ""
481
- chunks.append(MarkdownChunk(
482
- text=prefix + chunk_text,
483
- heading=current_heading,
484
- heading_level=current_level,
485
- metadata={"breadcrumb": " > ".join(heading_stack)}
486
- ))
487
-
488
- # Update heading context
489
- level = len(header_match.group(1))
490
- heading = header_match.group(2).strip()
491
-
492
- # Maintain heading stack for breadcrumbs
493
- while heading_stack and current_level >= level:
494
- heading_stack.pop()
495
- current_level -= 1
496
-
497
- heading_stack.append(heading)
498
- current_heading = heading
499
- current_level = level
500
- current_chunk_lines = []
501
-
502
- else:
503
- current_chunk_lines.append(line)
504
-
505
- # Check chunk size
506
- current_text = '\n'.join(current_chunk_lines)
507
- if len(current_text) > max_chunk_size:
508
- # Split at paragraph boundary
509
- paragraphs = current_text.split('\n\n')
510
- if len(paragraphs) > 1:
511
- split_point = len('\n\n'.join(paragraphs[:-1]))
512
- chunk_text = current_text[:split_point]
513
- prefix = f"# {current_heading}\n\n" if include_heading_in_chunk and current_heading else ""
514
- chunks.append(MarkdownChunk(
515
- text=prefix + chunk_text,
516
- heading=current_heading,
517
- heading_level=current_level,
518
- metadata={"breadcrumb": " > ".join(heading_stack)}
519
- ))
520
- current_chunk_lines = [current_text[split_point:].strip()]
521
-
522
- # Don't forget the last chunk
523
- if current_chunk_lines:
524
- chunk_text = '\n'.join(current_chunk_lines)
525
- if len(chunk_text.strip()) > 0:
526
- prefix = f"# {current_heading}\n\n" if include_heading_in_chunk and current_heading else ""
527
- chunks.append(MarkdownChunk(
528
- text=prefix + chunk_text,
529
- heading=current_heading,
530
- heading_level=current_level,
531
- metadata={"breadcrumb": " > ".join(heading_stack)}
532
- ))
533
-
534
- return chunks
535
- ```
536
-
537
- ### Code-Aware Chunking
538
-
539
- ```python
540
- import re
541
- from dataclasses import dataclass
542
-
543
- @dataclass
544
- class CodeChunk:
545
- text: str
546
- language: str | None
547
- chunk_type: str # "code", "text", "mixed"
548
-
549
- def chunk_with_code_blocks(
550
- text: str,
551
- max_chunk_size: int = 1500
552
- ) -> list[CodeChunk]:
553
- """Chunk text while keeping code blocks intact."""
554
- # Pattern to match code blocks
555
- code_block_pattern = r'```(\w+)?\n(.*?)```'
556
-
557
- chunks = []
558
- last_end = 0
559
-
560
- for match in re.finditer(code_block_pattern, text, re.DOTALL):
561
- # Text before code block
562
- text_before = text[last_end:match.start()].strip()
563
- if text_before:
564
- # Chunk the text portion
565
- text_chunks = recursive_chunk(text_before, max_chunk_size)
566
- chunks.extend([
567
- CodeChunk(text=t, language=None, chunk_type="text")
568
- for t in text_chunks
569
- ])
570
-
571
- # Code block (keep intact if possible)
572
- language = match.group(1)
573
- code_content = match.group(2)
574
- full_block = match.group(0)
575
-
576
- if len(full_block) <= max_chunk_size:
577
- chunks.append(CodeChunk(
578
- text=full_block,
579
- language=language,
580
- chunk_type="code"
581
- ))
582
- else:
583
- # Split large code blocks by function/class
584
- code_chunks = split_code_block(code_content, language, max_chunk_size)
585
- chunks.extend(code_chunks)
586
-
587
- last_end = match.end()
588
-
589
- # Remaining text after last code block
590
- remaining = text[last_end:].strip()
591
- if remaining:
592
- text_chunks = recursive_chunk(remaining, max_chunk_size)
593
- chunks.extend([
594
- CodeChunk(text=t, language=None, chunk_type="text")
595
- for t in text_chunks
596
- ])
597
-
598
- return chunks
599
-
600
- def split_code_block(code: str, language: str, max_size: int) -> list[CodeChunk]:
601
- """Split code block at logical boundaries."""
602
- # Simple function/class boundary splitting for Python
603
- if language == "python":
604
- pattern = r'\n(?=def |class |async def )'
605
- elif language in ["javascript", "typescript"]:
606
- pattern = r'\n(?=function |class |const |export )'
607
- else:
608
- pattern = r'\n\n'
609
-
610
- parts = re.split(pattern, code)
611
- chunks = []
612
- current = ""
613
-
614
- for part in parts:
615
- if len(current) + len(part) > max_size and current:
616
- chunks.append(CodeChunk(
617
- text=f"```{language}\n{current}```",
618
- language=language,
619
- chunk_type="code"
620
- ))
621
- current = part
622
- else:
623
- current += part
624
-
625
- if current:
626
- chunks.append(CodeChunk(
627
- text=f"```{language}\n{current}```",
628
- language=language,
629
- chunk_type="code"
630
- ))
631
-
632
- return chunks
633
- ```
634
-
635
- ---
636
-
637
- ## Contextual/Agentic Chunking
638
-
639
- ```python
640
- from openai import OpenAI
641
-
642
- def contextual_chunk(
643
- document: str,
644
- max_chunk_size: int = 1500
645
- ) -> list[dict]:
646
- """Use LLM to add context to each chunk."""
647
- # First, do structural chunking
648
- base_chunks = recursive_chunk(document, max_chunk_size)
649
-
650
- client = OpenAI()
651
- contextualized_chunks = []
652
-
653
- for chunk in base_chunks:
654
- # Generate contextual summary
655
- response = client.chat.completions.create(
656
- model="gpt-4o-mini",
657
- messages=[
658
- {
659
- "role": "system",
660
- "content": """Provide a brief context for this document chunk.
661
- Include: what topic it covers, how it relates to the broader document,
662
- and key concepts mentioned. Keep it under 100 words."""
663
- },
664
- {
665
- "role": "user",
666
- "content": f"Document excerpt:\n\n{chunk}"
667
- }
668
- ],
669
- max_tokens=150
670
- )
671
-
672
- context = response.choices[0].message.content
673
-
674
- contextualized_chunks.append({
675
- "text": chunk,
676
- "context": context,
677
- "text_with_context": f"Context: {context}\n\nContent: {chunk}"
678
- })
679
-
680
- return contextualized_chunks
681
- ```
682
-
683
- ### Propositions-Based Chunking
684
-
685
- ```python
686
- def extract_propositions(text: str) -> list[str]:
687
- """Extract atomic propositions from text using LLM."""
688
- client = OpenAI()
689
-
690
- response = client.chat.completions.create(
691
- model="gpt-4o-mini",
692
- messages=[
693
- {
694
- "role": "system",
695
- "content": """Extract atomic propositions from the text.
696
- Each proposition should:
697
- - Be a single, complete fact
698
- - Be self-contained (understandable without context)
699
- - Include necessary entity references
700
-
701
- Return as a JSON array of strings."""
702
- },
703
- {
704
- "role": "user",
705
- "content": text
706
- }
707
- ],
708
- response_format={"type": "json_object"}
709
- )
710
-
711
- import json
712
- result = json.loads(response.choices[0].message.content)
713
- return result.get("propositions", [])
714
-
715
- # Usage: For very fine-grained retrieval
716
- propositions = extract_propositions(document_text)
717
- # Each proposition becomes its own retrievable unit
718
- ```
719
-
720
- ---
721
-
722
- ## Late Chunking (for Long-Context Embeddings)
723
-
724
- ```python
725
- from transformers import AutoTokenizer, AutoModel
726
- import torch
727
-
728
- class LateChunker:
729
- """
730
- Late chunking: embed full document, then pool token embeddings into chunks.
731
- Preserves full document context while creating retrievable chunks.
732
- """
733
-
734
- def __init__(self, model_name: str = "jinaai/jina-embeddings-v2-base-en"):
735
- self.tokenizer = AutoTokenizer.from_pretrained(model_name)
736
- self.model = AutoModel.from_pretrained(model_name, trust_remote_code=True)
737
- self.model.eval()
738
-
739
- def chunk_and_embed(
740
- self,
741
- text: str,
742
- chunk_size: int = 512,
743
- overlap: int = 64
744
- ) -> list[dict]:
745
- """
746
- Embed full document, then create chunk embeddings via mean pooling.
747
- """
748
- # Tokenize full document
749
- inputs = self.tokenizer(
750
- text,
751
- return_tensors="pt",
752
- truncation=True,
753
- max_length=8192 # Model's max context
754
- )
755
-
756
- # Get token-level embeddings
757
- with torch.no_grad():
758
- outputs = self.model(**inputs)
759
- token_embeddings = outputs.last_hidden_state[0] # [seq_len, hidden_dim]
760
-
761
- # Get token-to-text mapping
762
- tokens = self.tokenizer.convert_ids_to_tokens(inputs["input_ids"][0])
763
-
764
- # Create chunks from token embeddings
765
- chunks = []
766
- seq_len = token_embeddings.shape[0]
767
- start = 0
768
-
769
- while start < seq_len:
770
- end = min(start + chunk_size, seq_len)
771
-
772
- # Mean pool token embeddings for this chunk
773
- chunk_embedding = token_embeddings[start:end].mean(dim=0).numpy()
774
-
775
- # Reconstruct text for this chunk
776
- chunk_token_ids = inputs["input_ids"][0][start:end]
777
- chunk_text = self.tokenizer.decode(chunk_token_ids, skip_special_tokens=True)
778
-
779
- chunks.append({
780
- "text": chunk_text,
781
- "embedding": chunk_embedding,
782
- "start_token": start,
783
- "end_token": end
784
- })
785
-
786
- start = end - overlap
787
-
788
- return chunks
789
-
790
- # Usage
791
- late_chunker = LateChunker()
792
- chunks_with_embeddings = late_chunker.chunk_and_embed(
793
- long_document,
794
- chunk_size=512,
795
- overlap=64
796
- )
797
- ```
798
-
799
- ---
800
-
801
- ## Metadata Enrichment
802
-
803
- ```python
804
- from dataclasses import dataclass
805
- from datetime import datetime
806
- import hashlib
807
-
808
- @dataclass
809
- class EnrichedChunk:
810
- text: str
811
- embedding: list[float] | None
812
- metadata: dict
813
-
814
- def enrich_chunk(
815
- text: str,
816
- source_file: str,
817
- chunk_index: int,
818
- total_chunks: int,
819
- additional_metadata: dict | None = None
820
- ) -> EnrichedChunk:
821
- """Add comprehensive metadata to chunk."""
822
- metadata = {
823
- # Source tracking
824
- "source": source_file,
825
- "chunk_index": chunk_index,
826
- "total_chunks": total_chunks,
827
-
828
- # Content characteristics
829
- "char_count": len(text),
830
- "word_count": len(text.split()),
831
- "content_hash": hashlib.md5(text.encode()).hexdigest()[:12],
832
-
833
- # Temporal
834
- "indexed_at": datetime.utcnow().isoformat(),
835
-
836
- # Position context
837
- "position": "start" if chunk_index == 0 else (
838
- "end" if chunk_index == total_chunks - 1 else "middle"
839
- )
840
- }
841
-
842
- if additional_metadata:
843
- metadata.update(additional_metadata)
844
-
845
- return EnrichedChunk(text=text, embedding=None, metadata=metadata)
846
- ```
847
-
848
- ---
849
-
850
- ## Chunk Size Selection Guide
851
-
852
- | Document Type | Recommended Size | Overlap | Rationale |
853
- |--------------|------------------|---------|-----------|
854
- | FAQ/Q&A | 200-400 tokens | 20-50 | Keep Q&A pairs together |
855
- | Technical docs | 400-600 tokens | 50-100 | Balance context vs precision |
856
- | Legal/contracts | 600-800 tokens | 100-150 | Preserve clause context |
857
- | Code documentation | 300-500 tokens | 50-100 | Keep function docs together |
858
- | Chat transcripts | 150-300 tokens | 25-50 | Natural turn boundaries |
859
- | Research papers | 500-800 tokens | 100-200 | Section-level coherence |
860
-
861
- ---
862
-
863
- ## Quick Reference
864
-
865
- | Strategy | Use Case | Code Pattern |
866
- |----------|----------|--------------|
867
- | Fixed-size | Logs, baseline | `text[i:i+chunk_size]` |
868
- | Recursive | General text | Split by `["\n\n", "\n", ". "]` |
869
- | Sentence | Q&A content | `sent_tokenize()` + merge |
870
- | Semantic | Technical docs | Similarity-based breaks |
871
- | Markdown | Documentation | Header-aware splitting |
872
- | Late chunking | Long-context models | Embed full, pool chunks |
873
-
874
- ## Related Skills
875
-
876
- - **RAG Architect** - Integration with vector databases
877
- - **Python Pro** - Preprocessing pipelines
878
- - **NLP Engineer** - Tokenization and text processing
1
+ # Chunking Strategies
2
+
3
+ ---
4
+
5
+ ## Strategy Comparison Matrix
6
+
7
+ | Strategy | Best For | Chunk Quality | Implementation Complexity |
8
+ |----------|----------|---------------|---------------------------|
9
+ | **Fixed-size** | Simple documents, logs | Low-Medium | Simple |
10
+ | **Recursive character** | General text, articles | Medium | Simple |
11
+ | **Sentence-based** | Conversational, Q&A | Medium-High | Medium |
12
+ | **Semantic** | Technical docs, manuals | High | Medium |
13
+ | **Document-aware** | Structured content (MD, HTML) | High | Medium |
14
+ | **Agentic/Contextual** | Complex documents | Very High | Complex |
15
+ | **Late chunking** | Long-context embeddings | High | Medium |
16
+
17
+ ---
18
+
19
+ ## When to Use Each Strategy
20
+
21
+ ### Fixed-Size Chunking
22
+ ```
23
+ Best For:
24
+ - Log files and structured data
25
+ - Quick prototyping
26
+ - When content has no natural structure
27
+ - Baseline comparison
28
+
29
+ When to Avoid:
30
+ - Technical documentation
31
+ - Content with semantic units (paragraphs, sections)
32
+ - When context preservation matters
33
+ ```
34
+
35
+ ### Recursive Character Splitting
36
+ ```
37
+ Best For:
38
+ - General articles and blog posts
39
+ - Mixed content types
40
+ - Default starting point for most RAG
41
+ - LangChain/LlamaIndex default
42
+
43
+ When to Avoid:
44
+ - Highly structured documents
45
+ - Code-heavy content
46
+ - Tables and lists
47
+ ```
48
+
49
+ ### Semantic Chunking
50
+ ```
51
+ Best For:
52
+ - Technical documentation
53
+ - Research papers
54
+ - Content with natural topic boundaries
55
+ - When retrieval precision is critical
56
+
57
+ When to Avoid:
58
+ - Real-time ingestion (slower)
59
+ - Very short documents
60
+ - Cost-sensitive pipelines (requires embeddings)
61
+ ```
62
+
63
+ ### Document-Aware Chunking
64
+ ```
65
+ Best For:
66
+ - Markdown documentation
67
+ - HTML pages
68
+ - LaTeX papers
69
+ - Code files
70
+
71
+ When to Avoid:
72
+ - Plain text without structure
73
+ - Inconsistent formatting
74
+ ```
75
+
76
+ ---
77
+
78
+ ## Fixed-Size Chunking
79
+
80
+ ```python
81
+ def fixed_size_chunk(
82
+ text: str,
83
+ chunk_size: int = 500,
84
+ overlap: int = 50
85
+ ) -> list[str]:
86
+ """Simple fixed-size chunking with overlap."""
87
+ chunks = []
88
+ start = 0
89
+
90
+ while start < len(text):
91
+ end = start + chunk_size
92
+ chunk = text[start:end]
93
+
94
+ # Try to break at word boundary
95
+ if end < len(text):
96
+ last_space = chunk.rfind(' ')
97
+ if last_space > chunk_size * 0.8: # Only if reasonably far in
98
+ chunk = chunk[:last_space]
99
+ end = start + last_space
100
+
101
+ chunks.append(chunk.strip())
102
+ start = end - overlap
103
+
104
+ return chunks
105
+
106
+ # Usage
107
+ chunks = fixed_size_chunk(document_text, chunk_size=500, overlap=50)
108
+ ```
109
+
110
+ ---
111
+
112
+ ## Recursive Character Splitting (LangChain Style)
113
+
114
+ ```python
115
+ from typing import Callable
116
+
117
+ class RecursiveCharacterSplitter:
118
+ """Split text recursively using multiple separators."""
119
+
120
+ def __init__(
121
+ self,
122
+ chunk_size: int = 1000,
123
+ chunk_overlap: int = 200,
124
+ separators: list[str] | None = None,
125
+ length_function: Callable[[str], int] = len
126
+ ):
127
+ self.chunk_size = chunk_size
128
+ self.chunk_overlap = chunk_overlap
129
+ self.separators = separators or ["\n\n", "\n", ". ", " ", ""]
130
+ self.length_function = length_function
131
+
132
+ def split_text(self, text: str) -> list[str]:
133
+ """Split text into chunks."""
134
+ return self._split_text(text, self.separators)
135
+
136
+ def _split_text(self, text: str, separators: list[str]) -> list[str]:
137
+ final_chunks = []
138
+ separator = separators[-1]
139
+
140
+ for i, sep in enumerate(separators):
141
+ if sep == "":
142
+ separator = sep
143
+ break
144
+ if sep in text:
145
+ separator = sep
146
+ break
147
+
148
+ splits = text.split(separator) if separator else list(text)
149
+
150
+ good_splits = []
151
+ for split in splits:
152
+ if self.length_function(split) < self.chunk_size:
153
+ good_splits.append(split)
154
+ else:
155
+ if good_splits:
156
+ merged = self._merge_splits(good_splits, separator)
157
+ final_chunks.extend(merged)
158
+ good_splits = []
159
+ # Recursively split large chunks
160
+ other_chunks = self._split_text(split, separators[separators.index(separator) + 1:])
161
+ final_chunks.extend(other_chunks)
162
+
163
+ if good_splits:
164
+ merged = self._merge_splits(good_splits, separator)
165
+ final_chunks.extend(merged)
166
+
167
+ return final_chunks
168
+
169
+ def _merge_splits(self, splits: list[str], separator: str) -> list[str]:
170
+ """Merge splits into chunks respecting size limits."""
171
+ chunks = []
172
+ current_chunk = []
173
+ current_length = 0
174
+
175
+ for split in splits:
176
+ split_length = self.length_function(split)
177
+
178
+ if current_length + split_length > self.chunk_size:
179
+ if current_chunk:
180
+ chunks.append(separator.join(current_chunk))
181
+ # Keep overlap
182
+ while current_length > self.chunk_overlap and current_chunk:
183
+ current_length -= self.length_function(current_chunk[0])
184
+ current_chunk = current_chunk[1:]
185
+
186
+ current_chunk.append(split)
187
+ current_length += split_length
188
+
189
+ if current_chunk:
190
+ chunks.append(separator.join(current_chunk))
191
+
192
+ return chunks
193
+
194
+ # Usage
195
+ splitter = RecursiveCharacterSplitter(
196
+ chunk_size=1000,
197
+ chunk_overlap=200,
198
+ separators=["\n\n", "\n", ". ", " "]
199
+ )
200
+ chunks = splitter.split_text(document_text)
201
+ ```
202
+
203
+ ### Token-Based Splitting
204
+
205
+ ```python
206
+ import tiktoken
207
+
208
+ def create_token_splitter(
209
+ model: str = "gpt-4",
210
+ chunk_size: int = 500,
211
+ chunk_overlap: int = 50
212
+ ):
213
+ """Create splitter that counts tokens instead of characters."""
214
+ encoding = tiktoken.encoding_for_model(model)
215
+
216
+ def token_length(text: str) -> int:
217
+ return len(encoding.encode(text))
218
+
219
+ return RecursiveCharacterSplitter(
220
+ chunk_size=chunk_size,
221
+ chunk_overlap=chunk_overlap,
222
+ length_function=token_length
223
+ )
224
+
225
+ # Usage
226
+ token_splitter = create_token_splitter(chunk_size=500, chunk_overlap=50)
227
+ chunks = token_splitter.split_text(document_text)
228
+ ```
229
+
230
+ ---
231
+
232
+ ## Sentence-Based Chunking
233
+
234
+ ```python
235
+ import re
236
+ from dataclasses import dataclass
237
+
238
+ @dataclass
239
+ class SentenceChunk:
240
+ text: str
241
+ sentences: list[str]
242
+ start_sentence: int
243
+ end_sentence: int
244
+
245
+ def sentence_chunk(
246
+ text: str,
247
+ sentences_per_chunk: int = 5,
248
+ overlap_sentences: int = 1
249
+ ) -> list[SentenceChunk]:
250
+ """Chunk by sentence count with overlap."""
251
+ # Split into sentences
252
+ sentence_pattern = r'(?<=[.!?])\s+'
253
+ sentences = re.split(sentence_pattern, text)
254
+ sentences = [s.strip() for s in sentences if s.strip()]
255
+
256
+ chunks = []
257
+ i = 0
258
+
259
+ while i < len(sentences):
260
+ end = min(i + sentences_per_chunk, len(sentences))
261
+ chunk_sentences = sentences[i:end]
262
+
263
+ chunks.append(SentenceChunk(
264
+ text=" ".join(chunk_sentences),
265
+ sentences=chunk_sentences,
266
+ start_sentence=i,
267
+ end_sentence=end - 1
268
+ ))
269
+
270
+ i += sentences_per_chunk - overlap_sentences
271
+
272
+ return chunks
273
+
274
+ # Better sentence splitting with NLTK
275
+ import nltk
276
+ nltk.download('punkt')
277
+ from nltk.tokenize import sent_tokenize
278
+
279
+ def sentence_chunk_nltk(
280
+ text: str,
281
+ max_chunk_size: int = 1000,
282
+ overlap_sentences: int = 2
283
+ ) -> list[str]:
284
+ """Chunk by sentences up to max size."""
285
+ sentences = sent_tokenize(text)
286
+ chunks = []
287
+ current_chunk = []
288
+ current_size = 0
289
+
290
+ for sentence in sentences:
291
+ sentence_size = len(sentence)
292
+
293
+ if current_size + sentence_size > max_chunk_size and current_chunk:
294
+ chunks.append(" ".join(current_chunk))
295
+ # Keep overlap sentences
296
+ current_chunk = current_chunk[-overlap_sentences:] if overlap_sentences else []
297
+ current_size = sum(len(s) for s in current_chunk)
298
+
299
+ current_chunk.append(sentence)
300
+ current_size += sentence_size
301
+
302
+ if current_chunk:
303
+ chunks.append(" ".join(current_chunk))
304
+
305
+ return chunks
306
+ ```
307
+
308
+ ---
309
+
310
+ ## Semantic Chunking
311
+
312
+ ```python
313
+ import numpy as np
314
+ from sentence_transformers import SentenceTransformer
315
+ from sklearn.metrics.pairwise import cosine_similarity
316
+
317
+ class SemanticChunker:
318
+ """Chunk based on semantic similarity between sentences."""
319
+
320
+ def __init__(
321
+ self,
322
+ model_name: str = "all-MiniLM-L6-v2",
323
+ similarity_threshold: float = 0.5,
324
+ min_chunk_size: int = 100,
325
+ max_chunk_size: int = 1500
326
+ ):
327
+ self.model = SentenceTransformer(model_name)
328
+ self.similarity_threshold = similarity_threshold
329
+ self.min_chunk_size = min_chunk_size
330
+ self.max_chunk_size = max_chunk_size
331
+
332
+ def chunk(self, text: str) -> list[str]:
333
+ """Split text at semantic boundaries."""
334
+ # Split into sentences
335
+ sentences = self._split_sentences(text)
336
+ if len(sentences) <= 1:
337
+ return [text]
338
+
339
+ # Get embeddings
340
+ embeddings = self.model.encode(sentences)
341
+
342
+ # Find breakpoints based on similarity drops
343
+ breakpoints = self._find_breakpoints(embeddings)
344
+
345
+ # Create chunks
346
+ chunks = []
347
+ start = 0
348
+
349
+ for bp in breakpoints:
350
+ chunk_text = " ".join(sentences[start:bp])
351
+
352
+ # Handle size constraints
353
+ if len(chunk_text) > self.max_chunk_size:
354
+ # Split large chunks
355
+ sub_chunks = self._split_large_chunk(sentences[start:bp])
356
+ chunks.extend(sub_chunks)
357
+ elif len(chunk_text) >= self.min_chunk_size:
358
+ chunks.append(chunk_text)
359
+ elif chunks:
360
+ # Merge small chunk with previous
361
+ chunks[-1] += " " + chunk_text
362
+ else:
363
+ chunks.append(chunk_text)
364
+
365
+ start = bp
366
+
367
+ # Handle remaining sentences
368
+ if start < len(sentences):
369
+ remaining = " ".join(sentences[start:])
370
+ if chunks and len(remaining) < self.min_chunk_size:
371
+ chunks[-1] += " " + remaining
372
+ else:
373
+ chunks.append(remaining)
374
+
375
+ return chunks
376
+
377
+ def _split_sentences(self, text: str) -> list[str]:
378
+ """Split text into sentences."""
379
+ import re
380
+ sentences = re.split(r'(?<=[.!?])\s+', text)
381
+ return [s.strip() for s in sentences if s.strip()]
382
+
383
+ def _find_breakpoints(self, embeddings: np.ndarray) -> list[int]:
384
+ """Find semantic breakpoints using similarity drops."""
385
+ breakpoints = []
386
+
387
+ for i in range(1, len(embeddings)):
388
+ similarity = cosine_similarity(
389
+ embeddings[i-1:i],
390
+ embeddings[i:i+1]
391
+ )[0][0]
392
+
393
+ if similarity < self.similarity_threshold:
394
+ breakpoints.append(i)
395
+
396
+ return breakpoints
397
+
398
+ def _split_large_chunk(self, sentences: list[str]) -> list[str]:
399
+ """Split oversized chunk at midpoint."""
400
+ mid = len(sentences) // 2
401
+ return [
402
+ " ".join(sentences[:mid]),
403
+ " ".join(sentences[mid:])
404
+ ]
405
+
406
+ # Usage
407
+ chunker = SemanticChunker(
408
+ similarity_threshold=0.5,
409
+ min_chunk_size=200,
410
+ max_chunk_size=1000
411
+ )
412
+ semantic_chunks = chunker.chunk(document_text)
413
+ ```
414
+
415
+ ### Percentile-Based Breakpoints
416
+
417
+ ```python
418
+ def find_breakpoints_percentile(
419
+ embeddings: np.ndarray,
420
+ percentile: int = 25
421
+ ) -> list[int]:
422
+ """Find breakpoints at similarity drops below percentile threshold."""
423
+ similarities = []
424
+
425
+ for i in range(1, len(embeddings)):
426
+ sim = cosine_similarity(
427
+ embeddings[i-1:i],
428
+ embeddings[i:i+1]
429
+ )[0][0]
430
+ similarities.append((i, sim))
431
+
432
+ # Dynamic threshold based on distribution
433
+ sim_values = [s[1] for s in similarities]
434
+ threshold = np.percentile(sim_values, percentile)
435
+
436
+ return [i for i, sim in similarities if sim < threshold]
437
+ ```
438
+
439
+ ---
440
+
441
+ ## Document-Aware Chunking
442
+
443
+ ### Markdown Chunking
444
+
445
+ ```python
446
+ import re
447
+ from dataclasses import dataclass
448
+
449
+ @dataclass
450
+ class MarkdownChunk:
451
+ text: str
452
+ heading: str | None
453
+ heading_level: int
454
+ metadata: dict
455
+
456
+ def chunk_markdown(
457
+ text: str,
458
+ max_chunk_size: int = 1500,
459
+ include_heading_in_chunk: bool = True
460
+ ) -> list[MarkdownChunk]:
461
+ """Chunk markdown by headers while respecting structure."""
462
+ # Pattern to match headers
463
+ header_pattern = r'^(#{1,6})\s+(.+)$'
464
+
465
+ lines = text.split('\n')
466
+ chunks = []
467
+ current_chunk_lines = []
468
+ current_heading = None
469
+ current_level = 0
470
+ heading_stack = [] # For breadcrumb context
471
+
472
+ for line in lines:
473
+ header_match = re.match(header_pattern, line)
474
+
475
+ if header_match:
476
+ # Save current chunk if exists
477
+ if current_chunk_lines:
478
+ chunk_text = '\n'.join(current_chunk_lines)
479
+ if len(chunk_text.strip()) > 0:
480
+ prefix = f"# {current_heading}\n\n" if include_heading_in_chunk and current_heading else ""
481
+ chunks.append(MarkdownChunk(
482
+ text=prefix + chunk_text,
483
+ heading=current_heading,
484
+ heading_level=current_level,
485
+ metadata={"breadcrumb": " > ".join(heading_stack)}
486
+ ))
487
+
488
+ # Update heading context
489
+ level = len(header_match.group(1))
490
+ heading = header_match.group(2).strip()
491
+
492
+ # Maintain heading stack for breadcrumbs
493
+ while heading_stack and current_level >= level:
494
+ heading_stack.pop()
495
+ current_level -= 1
496
+
497
+ heading_stack.append(heading)
498
+ current_heading = heading
499
+ current_level = level
500
+ current_chunk_lines = []
501
+
502
+ else:
503
+ current_chunk_lines.append(line)
504
+
505
+ # Check chunk size
506
+ current_text = '\n'.join(current_chunk_lines)
507
+ if len(current_text) > max_chunk_size:
508
+ # Split at paragraph boundary
509
+ paragraphs = current_text.split('\n\n')
510
+ if len(paragraphs) > 1:
511
+ split_point = len('\n\n'.join(paragraphs[:-1]))
512
+ chunk_text = current_text[:split_point]
513
+ prefix = f"# {current_heading}\n\n" if include_heading_in_chunk and current_heading else ""
514
+ chunks.append(MarkdownChunk(
515
+ text=prefix + chunk_text,
516
+ heading=current_heading,
517
+ heading_level=current_level,
518
+ metadata={"breadcrumb": " > ".join(heading_stack)}
519
+ ))
520
+ current_chunk_lines = [current_text[split_point:].strip()]
521
+
522
+ # Don't forget the last chunk
523
+ if current_chunk_lines:
524
+ chunk_text = '\n'.join(current_chunk_lines)
525
+ if len(chunk_text.strip()) > 0:
526
+ prefix = f"# {current_heading}\n\n" if include_heading_in_chunk and current_heading else ""
527
+ chunks.append(MarkdownChunk(
528
+ text=prefix + chunk_text,
529
+ heading=current_heading,
530
+ heading_level=current_level,
531
+ metadata={"breadcrumb": " > ".join(heading_stack)}
532
+ ))
533
+
534
+ return chunks
535
+ ```
536
+
537
+ ### Code-Aware Chunking
538
+
539
+ ```python
540
+ import re
541
+ from dataclasses import dataclass
542
+
543
+ @dataclass
544
+ class CodeChunk:
545
+ text: str
546
+ language: str | None
547
+ chunk_type: str # "code", "text", "mixed"
548
+
549
+ def chunk_with_code_blocks(
550
+ text: str,
551
+ max_chunk_size: int = 1500
552
+ ) -> list[CodeChunk]:
553
+ """Chunk text while keeping code blocks intact."""
554
+ # Pattern to match code blocks
555
+ code_block_pattern = r'```(\w+)?\n(.*?)```'
556
+
557
+ chunks = []
558
+ last_end = 0
559
+
560
+ for match in re.finditer(code_block_pattern, text, re.DOTALL):
561
+ # Text before code block
562
+ text_before = text[last_end:match.start()].strip()
563
+ if text_before:
564
+ # Chunk the text portion
565
+ text_chunks = recursive_chunk(text_before, max_chunk_size)
566
+ chunks.extend([
567
+ CodeChunk(text=t, language=None, chunk_type="text")
568
+ for t in text_chunks
569
+ ])
570
+
571
+ # Code block (keep intact if possible)
572
+ language = match.group(1)
573
+ code_content = match.group(2)
574
+ full_block = match.group(0)
575
+
576
+ if len(full_block) <= max_chunk_size:
577
+ chunks.append(CodeChunk(
578
+ text=full_block,
579
+ language=language,
580
+ chunk_type="code"
581
+ ))
582
+ else:
583
+ # Split large code blocks by function/class
584
+ code_chunks = split_code_block(code_content, language, max_chunk_size)
585
+ chunks.extend(code_chunks)
586
+
587
+ last_end = match.end()
588
+
589
+ # Remaining text after last code block
590
+ remaining = text[last_end:].strip()
591
+ if remaining:
592
+ text_chunks = recursive_chunk(remaining, max_chunk_size)
593
+ chunks.extend([
594
+ CodeChunk(text=t, language=None, chunk_type="text")
595
+ for t in text_chunks
596
+ ])
597
+
598
+ return chunks
599
+
600
+ def split_code_block(code: str, language: str, max_size: int) -> list[CodeChunk]:
601
+ """Split code block at logical boundaries."""
602
+ # Simple function/class boundary splitting for Python
603
+ if language == "python":
604
+ pattern = r'\n(?=def |class |async def )'
605
+ elif language in ["javascript", "typescript"]:
606
+ pattern = r'\n(?=function |class |const |export )'
607
+ else:
608
+ pattern = r'\n\n'
609
+
610
+ parts = re.split(pattern, code)
611
+ chunks = []
612
+ current = ""
613
+
614
+ for part in parts:
615
+ if len(current) + len(part) > max_size and current:
616
+ chunks.append(CodeChunk(
617
+ text=f"```{language}\n{current}```",
618
+ language=language,
619
+ chunk_type="code"
620
+ ))
621
+ current = part
622
+ else:
623
+ current += part
624
+
625
+ if current:
626
+ chunks.append(CodeChunk(
627
+ text=f"```{language}\n{current}```",
628
+ language=language,
629
+ chunk_type="code"
630
+ ))
631
+
632
+ return chunks
633
+ ```
634
+
635
+ ---
636
+
637
+ ## Contextual/Agentic Chunking
638
+
639
+ ```python
640
+ from openai import OpenAI
641
+
642
+ def contextual_chunk(
643
+ document: str,
644
+ max_chunk_size: int = 1500
645
+ ) -> list[dict]:
646
+ """Use LLM to add context to each chunk."""
647
+ # First, do structural chunking
648
+ base_chunks = recursive_chunk(document, max_chunk_size)
649
+
650
+ client = OpenAI()
651
+ contextualized_chunks = []
652
+
653
+ for chunk in base_chunks:
654
+ # Generate contextual summary
655
+ response = client.chat.completions.create(
656
+ model="gpt-4o-mini",
657
+ messages=[
658
+ {
659
+ "role": "system",
660
+ "content": """Provide a brief context for this document chunk.
661
+ Include: what topic it covers, how it relates to the broader document,
662
+ and key concepts mentioned. Keep it under 100 words."""
663
+ },
664
+ {
665
+ "role": "user",
666
+ "content": f"Document excerpt:\n\n{chunk}"
667
+ }
668
+ ],
669
+ max_tokens=150
670
+ )
671
+
672
+ context = response.choices[0].message.content
673
+
674
+ contextualized_chunks.append({
675
+ "text": chunk,
676
+ "context": context,
677
+ "text_with_context": f"Context: {context}\n\nContent: {chunk}"
678
+ })
679
+
680
+ return contextualized_chunks
681
+ ```
682
+
683
+ ### Propositions-Based Chunking
684
+
685
+ ```python
686
+ def extract_propositions(text: str) -> list[str]:
687
+ """Extract atomic propositions from text using LLM."""
688
+ client = OpenAI()
689
+
690
+ response = client.chat.completions.create(
691
+ model="gpt-4o-mini",
692
+ messages=[
693
+ {
694
+ "role": "system",
695
+ "content": """Extract atomic propositions from the text.
696
+ Each proposition should:
697
+ - Be a single, complete fact
698
+ - Be self-contained (understandable without context)
699
+ - Include necessary entity references
700
+
701
+ Return as a JSON array of strings."""
702
+ },
703
+ {
704
+ "role": "user",
705
+ "content": text
706
+ }
707
+ ],
708
+ response_format={"type": "json_object"}
709
+ )
710
+
711
+ import json
712
+ result = json.loads(response.choices[0].message.content)
713
+ return result.get("propositions", [])
714
+
715
+ # Usage: For very fine-grained retrieval
716
+ propositions = extract_propositions(document_text)
717
+ # Each proposition becomes its own retrievable unit
718
+ ```
719
+
720
+ ---
721
+
722
+ ## Late Chunking (for Long-Context Embeddings)
723
+
724
+ ```python
725
+ from transformers import AutoTokenizer, AutoModel
726
+ import torch
727
+
728
+ class LateChunker:
729
+ """
730
+ Late chunking: embed full document, then pool token embeddings into chunks.
731
+ Preserves full document context while creating retrievable chunks.
732
+ """
733
+
734
+ def __init__(self, model_name: str = "jinaai/jina-embeddings-v2-base-en"):
735
+ self.tokenizer = AutoTokenizer.from_pretrained(model_name)
736
+ self.model = AutoModel.from_pretrained(model_name, trust_remote_code=True)
737
+ self.model.eval()
738
+
739
+ def chunk_and_embed(
740
+ self,
741
+ text: str,
742
+ chunk_size: int = 512,
743
+ overlap: int = 64
744
+ ) -> list[dict]:
745
+ """
746
+ Embed full document, then create chunk embeddings via mean pooling.
747
+ """
748
+ # Tokenize full document
749
+ inputs = self.tokenizer(
750
+ text,
751
+ return_tensors="pt",
752
+ truncation=True,
753
+ max_length=8192 # Model's max context
754
+ )
755
+
756
+ # Get token-level embeddings
757
+ with torch.no_grad():
758
+ outputs = self.model(**inputs)
759
+ token_embeddings = outputs.last_hidden_state[0] # [seq_len, hidden_dim]
760
+
761
+ # Get token-to-text mapping
762
+ tokens = self.tokenizer.convert_ids_to_tokens(inputs["input_ids"][0])
763
+
764
+ # Create chunks from token embeddings
765
+ chunks = []
766
+ seq_len = token_embeddings.shape[0]
767
+ start = 0
768
+
769
+ while start < seq_len:
770
+ end = min(start + chunk_size, seq_len)
771
+
772
+ # Mean pool token embeddings for this chunk
773
+ chunk_embedding = token_embeddings[start:end].mean(dim=0).numpy()
774
+
775
+ # Reconstruct text for this chunk
776
+ chunk_token_ids = inputs["input_ids"][0][start:end]
777
+ chunk_text = self.tokenizer.decode(chunk_token_ids, skip_special_tokens=True)
778
+
779
+ chunks.append({
780
+ "text": chunk_text,
781
+ "embedding": chunk_embedding,
782
+ "start_token": start,
783
+ "end_token": end
784
+ })
785
+
786
+ start = end - overlap
787
+
788
+ return chunks
789
+
790
+ # Usage
791
+ late_chunker = LateChunker()
792
+ chunks_with_embeddings = late_chunker.chunk_and_embed(
793
+ long_document,
794
+ chunk_size=512,
795
+ overlap=64
796
+ )
797
+ ```
798
+
799
+ ---
800
+
801
+ ## Metadata Enrichment
802
+
803
+ ```python
804
+ from dataclasses import dataclass
805
+ from datetime import datetime
806
+ import hashlib
807
+
808
+ @dataclass
809
+ class EnrichedChunk:
810
+ text: str
811
+ embedding: list[float] | None
812
+ metadata: dict
813
+
814
+ def enrich_chunk(
815
+ text: str,
816
+ source_file: str,
817
+ chunk_index: int,
818
+ total_chunks: int,
819
+ additional_metadata: dict | None = None
820
+ ) -> EnrichedChunk:
821
+ """Add comprehensive metadata to chunk."""
822
+ metadata = {
823
+ # Source tracking
824
+ "source": source_file,
825
+ "chunk_index": chunk_index,
826
+ "total_chunks": total_chunks,
827
+
828
+ # Content characteristics
829
+ "char_count": len(text),
830
+ "word_count": len(text.split()),
831
+ "content_hash": hashlib.md5(text.encode()).hexdigest()[:12],
832
+
833
+ # Temporal
834
+ "indexed_at": datetime.utcnow().isoformat(),
835
+
836
+ # Position context
837
+ "position": "start" if chunk_index == 0 else (
838
+ "end" if chunk_index == total_chunks - 1 else "middle"
839
+ )
840
+ }
841
+
842
+ if additional_metadata:
843
+ metadata.update(additional_metadata)
844
+
845
+ return EnrichedChunk(text=text, embedding=None, metadata=metadata)
846
+ ```
847
+
848
+ ---
849
+
850
+ ## Chunk Size Selection Guide
851
+
852
+ | Document Type | Recommended Size | Overlap | Rationale |
853
+ |--------------|------------------|---------|-----------|
854
+ | FAQ/Q&A | 200-400 tokens | 20-50 | Keep Q&A pairs together |
855
+ | Technical docs | 400-600 tokens | 50-100 | Balance context vs precision |
856
+ | Legal/contracts | 600-800 tokens | 100-150 | Preserve clause context |
857
+ | Code documentation | 300-500 tokens | 50-100 | Keep function docs together |
858
+ | Chat transcripts | 150-300 tokens | 25-50 | Natural turn boundaries |
859
+ | Research papers | 500-800 tokens | 100-200 | Section-level coherence |
860
+
861
+ ---
862
+
863
+ ## Quick Reference
864
+
865
+ | Strategy | Use Case | Code Pattern |
866
+ |----------|----------|--------------|
867
+ | Fixed-size | Logs, baseline | `text[i:i+chunk_size]` |
868
+ | Recursive | General text | Split by `["\n\n", "\n", ". "]` |
869
+ | Sentence | Q&A content | `sent_tokenize()` + merge |
870
+ | Semantic | Technical docs | Similarity-based breaks |
871
+ | Markdown | Documentation | Header-aware splitting |
872
+ | Late chunking | Long-context models | Embed full, pool chunks |
873
+
874
+ ## Related Skills
875
+
876
+ - **RAG Architect** - Integration with vector databases
877
+ - **Python Pro** - Preprocessing pipelines
878
+ - **NLP Engineer** - Tokenization and text processing