@mytechtoday/augment-extensions 0.7.0 → 1.2.0

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 (483) hide show
  1. package/AGENTS.md +265 -232
  2. package/README.md +956 -771
  3. package/augment-extensions/coding-standards/bash/README.md +196 -196
  4. package/augment-extensions/coding-standards/bash/module.json +163 -163
  5. package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -336
  6. package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -289
  7. package/augment-extensions/coding-standards/css/README.md +40 -40
  8. package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -550
  9. package/augment-extensions/coding-standards/css/module.json +44 -44
  10. package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -448
  11. package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -492
  12. package/augment-extensions/coding-standards/html/README.md +40 -40
  13. package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -267
  14. package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -505
  15. package/augment-extensions/coding-standards/html/module.json +44 -44
  16. package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -349
  17. package/augment-extensions/coding-standards/html-css-js/README.md +194 -194
  18. package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -487
  19. package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -550
  20. package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -667
  21. package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -267
  22. package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -612
  23. package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -505
  24. package/augment-extensions/coding-standards/html-css-js/module.json +48 -48
  25. package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -515
  26. package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -448
  27. package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -492
  28. package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -439
  29. package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -349
  30. package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -486
  31. package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -463
  32. package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -543
  33. package/augment-extensions/coding-standards/js/README.md +46 -46
  34. package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -487
  35. package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -667
  36. package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -612
  37. package/augment-extensions/coding-standards/js/module.json +49 -49
  38. package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -515
  39. package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -439
  40. package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -486
  41. package/augment-extensions/coding-standards/js/rules/performance.md +463 -463
  42. package/augment-extensions/coding-standards/js/rules/tooling.md +543 -543
  43. package/augment-extensions/coding-standards/php/README.md +248 -248
  44. package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -204
  45. package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -206
  46. package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -234
  47. package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -211
  48. package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -215
  49. package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -189
  50. package/augment-extensions/coding-standards/php/module.json +166 -166
  51. package/augment-extensions/coding-standards/php/rules/api-development.md +480 -480
  52. package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -332
  53. package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -472
  54. package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -561
  55. package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -402
  56. package/augment-extensions/coding-standards/php/rules/documentation.md +425 -425
  57. package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -627
  58. package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -336
  59. package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -677
  60. package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -279
  61. package/augment-extensions/coding-standards/php/rules/performance.md +392 -392
  62. package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -186
  63. package/augment-extensions/coding-standards/php/rules/security.md +358 -358
  64. package/augment-extensions/coding-standards/php/rules/testing.md +403 -403
  65. package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -331
  66. package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -426
  67. package/augment-extensions/coding-standards/powershell/README.md +154 -154
  68. package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -272
  69. package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -173
  70. package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -243
  71. package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -297
  72. package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -224
  73. package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -340
  74. package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -255
  75. package/augment-extensions/coding-standards/powershell/module.json +165 -165
  76. package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -439
  77. package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -240
  78. package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -384
  79. package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -383
  80. package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -482
  81. package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -296
  82. package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -314
  83. package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -466
  84. package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -244
  85. package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -266
  86. package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -209
  87. package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -314
  88. package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -268
  89. package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -197
  90. package/augment-extensions/coding-standards/python/README.md +48 -48
  91. package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -373
  92. package/augment-extensions/coding-standards/python/module.json +30 -30
  93. package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -884
  94. package/augment-extensions/coding-standards/python/rules/best-practices.md +232 -232
  95. package/augment-extensions/coding-standards/python/rules/code-organization.md +220 -220
  96. package/augment-extensions/coding-standards/python/rules/documentation.md +831 -831
  97. package/augment-extensions/coding-standards/python/rules/error-handling.md +1008 -1008
  98. package/augment-extensions/coding-standards/python/rules/naming-conventions.md +172 -172
  99. package/augment-extensions/coding-standards/python/rules/testing.md +409 -409
  100. package/augment-extensions/coding-standards/python/rules/tooling.md +446 -446
  101. package/augment-extensions/coding-standards/python/rules/type-hints.md +253 -253
  102. package/augment-extensions/coding-standards/react/README.md +45 -45
  103. package/augment-extensions/coding-standards/react/module.json +27 -27
  104. package/augment-extensions/coding-standards/react/rules/component-patterns.md +214 -214
  105. package/augment-extensions/coding-standards/react/rules/hooks-best-practices.md +235 -235
  106. package/augment-extensions/coding-standards/react/rules/performance.md +300 -300
  107. package/augment-extensions/coding-standards/react/rules/state-management.md +265 -265
  108. package/augment-extensions/coding-standards/react/rules/typescript-react.md +271 -271
  109. package/augment-extensions/coding-standards/typescript/README.md +45 -45
  110. package/augment-extensions/coding-standards/typescript/module.json +27 -27
  111. package/augment-extensions/coding-standards/typescript/rules/naming-conventions.md +225 -225
  112. package/augment-extensions/collections/html-css-js/README.md +82 -82
  113. package/augment-extensions/collections/html-css-js/collection.json +41 -41
  114. package/augment-extensions/domain-rules/api-design/README.md +41 -41
  115. package/augment-extensions/domain-rules/api-design/module.json +27 -27
  116. package/augment-extensions/domain-rules/api-design/rules/authentication.md +263 -263
  117. package/augment-extensions/domain-rules/api-design/rules/documentation.md +395 -395
  118. package/augment-extensions/domain-rules/api-design/rules/error-handling.md +290 -290
  119. package/augment-extensions/domain-rules/api-design/rules/graphql-api.md +313 -313
  120. package/augment-extensions/domain-rules/api-design/rules/rest-api.md +214 -214
  121. package/augment-extensions/domain-rules/api-design/rules/versioning.md +268 -268
  122. package/augment-extensions/domain-rules/database/README.md +161 -161
  123. package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -793
  124. package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -1132
  125. package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -868
  126. package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -805
  127. package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -621
  128. package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -965
  129. package/augment-extensions/domain-rules/database/module.json +28 -28
  130. package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -624
  131. package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -588
  132. package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -856
  133. package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -778
  134. package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -963
  135. package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -1076
  136. package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -697
  137. package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -671
  138. package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -607
  139. package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -907
  140. package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -783
  141. package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -980
  142. package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -485
  143. package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -521
  144. package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -858
  145. package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -934
  146. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/README.md +23 -23
  147. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/module.json +26 -26
  148. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/README.md +23 -23
  149. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/module.json +26 -26
  150. package/augment-extensions/domain-rules/design/color/themes/dracula/README.md +23 -23
  151. package/augment-extensions/domain-rules/design/color/themes/dracula/module.json +26 -26
  152. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/README.md +23 -23
  153. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/module.json +26 -26
  154. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/README.md +23 -23
  155. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/module.json +26 -26
  156. package/augment-extensions/domain-rules/design/color/themes/high-contrast/README.md +27 -27
  157. package/augment-extensions/domain-rules/design/color/themes/high-contrast/module.json +26 -26
  158. package/augment-extensions/domain-rules/design/color/themes/monokai/README.md +23 -23
  159. package/augment-extensions/domain-rules/design/color/themes/monokai/module.json +26 -26
  160. package/augment-extensions/domain-rules/design/color/themes/nord/README.md +23 -23
  161. package/augment-extensions/domain-rules/design/color/themes/nord/module.json +26 -26
  162. package/augment-extensions/domain-rules/design/color/themes/one-dark/README.md +23 -23
  163. package/augment-extensions/domain-rules/design/color/themes/one-dark/module.json +26 -26
  164. package/augment-extensions/domain-rules/design/color/themes/one-light/README.md +23 -23
  165. package/augment-extensions/domain-rules/design/color/themes/one-light/module.json +26 -26
  166. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/README.md +23 -23
  167. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/module.json +26 -26
  168. package/augment-extensions/domain-rules/design/color/themes/solarized-light/README.md +23 -23
  169. package/augment-extensions/domain-rules/design/color/themes/solarized-light/module.json +26 -26
  170. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/README.md +23 -23
  171. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/module.json +26 -26
  172. package/augment-extensions/domain-rules/mcp/README.md +150 -150
  173. package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -522
  174. package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -520
  175. package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -570
  176. package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -427
  177. package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -435
  178. package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -502
  179. package/augment-extensions/domain-rules/mcp/module.json +49 -49
  180. package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -595
  181. package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -345
  182. package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -687
  183. package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -636
  184. package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -484
  185. package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -360
  186. package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -393
  187. package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -194
  188. package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -625
  189. package/augment-extensions/domain-rules/security/README.md +41 -41
  190. package/augment-extensions/domain-rules/security/module.json +28 -28
  191. package/augment-extensions/domain-rules/security/rules/authentication-security.md +361 -361
  192. package/augment-extensions/domain-rules/security/rules/encryption.md +208 -208
  193. package/augment-extensions/domain-rules/security/rules/input-validation.md +294 -294
  194. package/augment-extensions/domain-rules/security/rules/owasp-top-10.md +339 -339
  195. package/augment-extensions/domain-rules/security/rules/secure-coding.md +293 -293
  196. package/augment-extensions/domain-rules/security/rules/web-security.md +268 -268
  197. package/augment-extensions/domain-rules/seo-sales-marketing/ANNOUNCEMENT.md +143 -0
  198. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/README.md +140 -136
  199. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/SCHEMA-VALIDATION-REPORT.md +216 -216
  200. package/augment-extensions/domain-rules/seo-sales-marketing/TEST-VALIDATION.md +129 -0
  201. package/augment-extensions/domain-rules/seo-sales-marketing/USAGE-GUIDES.md +254 -0
  202. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/brand-kit-example.yaml +292 -292
  203. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/campaign-brief-example.yaml +389 -389
  204. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/content-calendar-example.yaml +643 -643
  205. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/email-newsletter-example.md +376 -376
  206. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/landing-page-example.md +934 -934
  207. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/ppc-ad-copy-example.md +301 -301
  208. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/seo-blog-post-example.md +347 -347
  209. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/social-media-campaign-example.md +606 -606
  210. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/module.json +50 -50
  211. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/affiliate-influencer-marketing.md +593 -593
  212. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/asset-management.md +418 -418
  213. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/brand-consistency.md +210 -210
  214. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/content-marketing.md +337 -337
  215. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/conversion-optimization.md +455 -455
  216. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/direct-sales.md +499 -499
  217. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/email-marketing.md +439 -439
  218. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/legal-compliance.md +227 -227
  219. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/ppc-advertising.md +569 -569
  220. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/seo-optimization.md +470 -470
  221. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/social-media-marketing.md +414 -414
  222. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/universal-marketing.md +177 -177
  223. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/asset-inventory.schema.json +247 -247
  224. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/brand-kit.schema.json +326 -326
  225. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/campaign-brief.schema.json +342 -342
  226. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/color-palette.schema.json +223 -223
  227. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/content-template.schema.json +383 -383
  228. package/augment-extensions/domain-rules/wordpress/README.md +163 -163
  229. package/augment-extensions/domain-rules/wordpress/module.json +32 -32
  230. package/augment-extensions/domain-rules/wordpress/rules/coding-standards.md +617 -617
  231. package/augment-extensions/domain-rules/wordpress/rules/directory-structure.md +270 -270
  232. package/augment-extensions/domain-rules/wordpress/rules/file-patterns.md +423 -423
  233. package/augment-extensions/domain-rules/wordpress/rules/gutenberg-blocks.md +493 -493
  234. package/augment-extensions/domain-rules/wordpress/rules/performance.md +568 -568
  235. package/augment-extensions/domain-rules/wordpress/rules/plugin-development.md +510 -510
  236. package/augment-extensions/domain-rules/wordpress/rules/project-detection.md +251 -251
  237. package/augment-extensions/domain-rules/wordpress/rules/rest-api.md +501 -501
  238. package/augment-extensions/domain-rules/wordpress/rules/security.md +564 -564
  239. package/augment-extensions/domain-rules/wordpress/rules/theme-development.md +388 -388
  240. package/augment-extensions/domain-rules/wordpress/rules/woocommerce.md +441 -441
  241. package/augment-extensions/domain-rules/wordpress-plugin/README.md +139 -139
  242. package/augment-extensions/domain-rules/wordpress-plugin/examples/ajax-plugin.md +1599 -1599
  243. package/augment-extensions/domain-rules/wordpress-plugin/examples/custom-post-type-plugin.md +1727 -1727
  244. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block-plugin.md +428 -428
  245. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block.md +422 -422
  246. package/augment-extensions/domain-rules/wordpress-plugin/examples/mvc-plugin.md +1623 -1623
  247. package/augment-extensions/domain-rules/wordpress-plugin/examples/object-oriented-plugin.md +1343 -1343
  248. package/augment-extensions/domain-rules/wordpress-plugin/examples/rest-endpoint.md +734 -734
  249. package/augment-extensions/domain-rules/wordpress-plugin/examples/settings-page-plugin.md +1350 -1350
  250. package/augment-extensions/domain-rules/wordpress-plugin/examples/simple-procedural-plugin.md +503 -503
  251. package/augment-extensions/domain-rules/wordpress-plugin/examples/singleton-plugin.md +971 -971
  252. package/augment-extensions/domain-rules/wordpress-plugin/module.json +53 -53
  253. package/augment-extensions/domain-rules/wordpress-plugin/rules/activation-hooks.md +770 -770
  254. package/augment-extensions/domain-rules/wordpress-plugin/rules/admin-interface.md +874 -874
  255. package/augment-extensions/domain-rules/wordpress-plugin/rules/ajax-handlers.md +629 -629
  256. package/augment-extensions/domain-rules/wordpress-plugin/rules/asset-management.md +559 -559
  257. package/augment-extensions/domain-rules/wordpress-plugin/rules/context-providers.md +709 -709
  258. package/augment-extensions/domain-rules/wordpress-plugin/rules/cron-jobs.md +736 -736
  259. package/augment-extensions/domain-rules/wordpress-plugin/rules/database-management.md +1057 -1057
  260. package/augment-extensions/domain-rules/wordpress-plugin/rules/documentation-standards.md +463 -463
  261. package/augment-extensions/domain-rules/wordpress-plugin/rules/frontend-functionality.md +478 -478
  262. package/augment-extensions/domain-rules/wordpress-plugin/rules/gutenberg-blocks.md +818 -818
  263. package/augment-extensions/domain-rules/wordpress-plugin/rules/internationalization.md +416 -416
  264. package/augment-extensions/domain-rules/wordpress-plugin/rules/migration.md +667 -667
  265. package/augment-extensions/domain-rules/wordpress-plugin/rules/performance-optimization.md +878 -878
  266. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-architecture.md +693 -693
  267. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-structure.md +352 -352
  268. package/augment-extensions/domain-rules/wordpress-plugin/rules/rest-api.md +818 -818
  269. package/augment-extensions/domain-rules/wordpress-plugin/rules/scaffolding-workflow.md +624 -624
  270. package/augment-extensions/domain-rules/wordpress-plugin/rules/security-best-practices.md +866 -866
  271. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing-patterns.md +1165 -1165
  272. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing.md +414 -414
  273. package/augment-extensions/domain-rules/wordpress-plugin/rules/vscode-integration.md +751 -751
  274. package/augment-extensions/domain-rules/wordpress-plugin/rules/woocommerce-integration.md +949 -949
  275. package/augment-extensions/domain-rules/wordpress-plugin/rules/wordpress-org-submission.md +458 -458
  276. package/augment-extensions/examples/design-patterns/README.md +37 -37
  277. package/augment-extensions/examples/design-patterns/examples/behavioral-patterns.md +370 -370
  278. package/augment-extensions/examples/design-patterns/examples/creational-patterns.md +250 -250
  279. package/augment-extensions/examples/design-patterns/examples/structural-patterns.md +264 -264
  280. package/augment-extensions/examples/design-patterns/module.json +27 -27
  281. package/augment-extensions/examples/gutenberg-block-plugin/README.md +101 -101
  282. package/augment-extensions/examples/gutenberg-block-plugin/examples/testimonial-block.md +428 -428
  283. package/augment-extensions/examples/gutenberg-block-plugin/module.json +40 -40
  284. package/augment-extensions/examples/rest-api-plugin/README.md +98 -98
  285. package/augment-extensions/examples/rest-api-plugin/examples/task-manager-api.md +1299 -1299
  286. package/augment-extensions/examples/rest-api-plugin/module.json +40 -40
  287. package/augment-extensions/examples/woocommerce-extension/README.md +98 -98
  288. package/augment-extensions/examples/woocommerce-extension/examples/product-customizer.md +763 -763
  289. package/augment-extensions/examples/woocommerce-extension/module.json +40 -40
  290. package/augment-extensions/workflows/beads/README.md +135 -135
  291. package/augment-extensions/workflows/beads/examples/complete-workflow-example.md +278 -278
  292. package/augment-extensions/workflows/beads/module.json +55 -55
  293. package/augment-extensions/workflows/beads/rules/best-practices.md +398 -398
  294. package/augment-extensions/workflows/beads/rules/file-format.md +327 -327
  295. package/augment-extensions/workflows/beads/rules/manual-setup.md +315 -315
  296. package/augment-extensions/workflows/beads/rules/workflow.md +326 -326
  297. package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md +145 -145
  298. package/augment-extensions/workflows/beads-integration/README.md +143 -143
  299. package/augment-extensions/workflows/beads-integration/config/defaults.json +32 -32
  300. package/augment-extensions/workflows/beads-integration/config/schema.json +140 -140
  301. package/augment-extensions/workflows/beads-integration/examples/basic-task-generation.md +293 -293
  302. package/augment-extensions/workflows/beads-integration/module.json +75 -75
  303. package/augment-extensions/workflows/beads-integration/rules/core-rules.md +219 -219
  304. package/augment-extensions/workflows/beads-integration/rules/effectiveness-standards.md +256 -256
  305. package/augment-extensions/workflows/beads-integration/rules/task-generation.md +607 -607
  306. package/augment-extensions/workflows/database/README.md +195 -195
  307. package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -295
  308. package/augment-extensions/workflows/database/examples/migration-example.md +498 -498
  309. package/augment-extensions/workflows/database/examples/optimization-example.md +496 -496
  310. package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -444
  311. package/augment-extensions/workflows/database/module.json +42 -42
  312. package/augment-extensions/workflows/database/rules/data-migration.md +249 -249
  313. package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -339
  314. package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -352
  315. package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -435
  316. package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -535
  317. package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -305
  318. package/augment-extensions/workflows/database/rules/workflow.md +458 -458
  319. package/augment-extensions/workflows/wordpress-plugin/README.md +232 -232
  320. package/augment-extensions/workflows/wordpress-plugin/ai-prompts.md +839 -839
  321. package/augment-extensions/workflows/wordpress-plugin/bead-decomposition-patterns.md +854 -854
  322. package/augment-extensions/workflows/wordpress-plugin/examples/complete-plugin-example.md +540 -540
  323. package/augment-extensions/workflows/wordpress-plugin/examples/custom-post-type-example.md +1083 -1083
  324. package/augment-extensions/workflows/wordpress-plugin/examples/feature-addition-workflow.md +669 -669
  325. package/augment-extensions/workflows/wordpress-plugin/examples/plugin-creation-workflow.md +597 -597
  326. package/augment-extensions/workflows/wordpress-plugin/examples/secure-form-handler-example.md +925 -925
  327. package/augment-extensions/workflows/wordpress-plugin/examples/security-audit-workflow.md +752 -752
  328. package/augment-extensions/workflows/wordpress-plugin/examples/wordpress-org-submission-workflow.md +773 -773
  329. package/augment-extensions/workflows/wordpress-plugin/module.json +49 -49
  330. package/augment-extensions/workflows/wordpress-plugin/rules/best-practices.md +942 -942
  331. package/augment-extensions/workflows/wordpress-plugin/rules/development-workflow.md +702 -702
  332. package/augment-extensions/workflows/wordpress-plugin/rules/submission-workflow.md +728 -728
  333. package/augment-extensions/workflows/wordpress-plugin/rules/testing-workflow.md +775 -775
  334. package/augment-extensions/writing-standards/screenplay/README.md +339 -300
  335. package/augment-extensions/writing-standards/screenplay/_templates/README.md +121 -121
  336. package/augment-extensions/writing-standards/screenplay/_templates/genre-template.md +153 -153
  337. package/augment-extensions/writing-standards/screenplay/_templates/style-template.md +243 -243
  338. package/augment-extensions/writing-standards/screenplay/_templates/theme-template.md +213 -213
  339. package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -164
  340. package/augment-extensions/writing-standards/screenplay/examples/beat-sheet-example.yaml +95 -95
  341. package/augment-extensions/writing-standards/screenplay/examples/character-profile-example.yaml +116 -116
  342. package/augment-extensions/writing-standards/screenplay/examples/commercial-30sec.fountain +151 -151
  343. package/augment-extensions/writing-standards/screenplay/examples/independent-monologue.fountain +67 -67
  344. package/augment-extensions/writing-standards/screenplay/examples/news-segment.fountain +142 -142
  345. package/augment-extensions/writing-standards/screenplay/examples/plot-outline-example.yaml +184 -184
  346. package/augment-extensions/writing-standards/screenplay/examples/tv-episode-teaser.fountain +204 -204
  347. package/augment-extensions/writing-standards/screenplay/genres/README.md +181 -181
  348. package/augment-extensions/writing-standards/screenplay/genres/examples/.gitkeep +2 -2
  349. package/augment-extensions/writing-standards/screenplay/genres/module.json +70 -70
  350. package/augment-extensions/writing-standards/screenplay/genres/rules/.gitkeep +2 -2
  351. package/augment-extensions/writing-standards/screenplay/genres/rules/action.md +399 -399
  352. package/augment-extensions/writing-standards/screenplay/genres/rules/adventure.md +407 -407
  353. package/augment-extensions/writing-standards/screenplay/genres/rules/animation.md +293 -293
  354. package/augment-extensions/writing-standards/screenplay/genres/rules/biographical.md +293 -293
  355. package/augment-extensions/writing-standards/screenplay/genres/rules/comedy.md +401 -401
  356. package/augment-extensions/writing-standards/screenplay/genres/rules/documentary.md +293 -293
  357. package/augment-extensions/writing-standards/screenplay/genres/rules/drama.md +409 -409
  358. package/augment-extensions/writing-standards/screenplay/genres/rules/fantasy.md +293 -293
  359. package/augment-extensions/writing-standards/screenplay/genres/rules/historical.md +293 -293
  360. package/augment-extensions/writing-standards/screenplay/genres/rules/horror.md +268 -268
  361. package/augment-extensions/writing-standards/screenplay/genres/rules/musical.md +294 -294
  362. package/augment-extensions/writing-standards/screenplay/genres/rules/mystery.md +293 -293
  363. package/augment-extensions/writing-standards/screenplay/genres/rules/noir.md +294 -294
  364. package/augment-extensions/writing-standards/screenplay/genres/rules/romance.md +293 -293
  365. package/augment-extensions/writing-standards/screenplay/genres/rules/sci-fi.md +289 -289
  366. package/augment-extensions/writing-standards/screenplay/genres/rules/superhero.md +293 -293
  367. package/augment-extensions/writing-standards/screenplay/genres/rules/thriller.md +294 -294
  368. package/augment-extensions/writing-standards/screenplay/genres/rules/western.md +293 -293
  369. package/augment-extensions/writing-standards/screenplay/module.json +124 -124
  370. package/augment-extensions/writing-standards/screenplay/rules/aaa-hollywood-films.md +339 -339
  371. package/augment-extensions/writing-standards/screenplay/rules/ai-integration-testing.md +329 -329
  372. package/augment-extensions/writing-standards/screenplay/rules/character-development.md +169 -169
  373. package/augment-extensions/writing-standards/screenplay/rules/commercials.md +437 -437
  374. package/augment-extensions/writing-standards/screenplay/rules/dialogue-writing.md +263 -263
  375. package/augment-extensions/writing-standards/screenplay/rules/diversity-inclusion.md +261 -261
  376. package/augment-extensions/writing-standards/screenplay/rules/examples-guide.md +315 -315
  377. package/augment-extensions/writing-standards/screenplay/rules/file-organization.md +213 -0
  378. package/augment-extensions/writing-standards/screenplay/rules/formatting-validation.md +413 -413
  379. package/augment-extensions/writing-standards/screenplay/rules/fountain-format.md +372 -372
  380. package/augment-extensions/writing-standards/screenplay/rules/independent-films.md +374 -374
  381. package/augment-extensions/writing-standards/screenplay/rules/live-tv-productions.md +443 -443
  382. package/augment-extensions/writing-standards/screenplay/rules/narrative-structures.md +207 -207
  383. package/augment-extensions/writing-standards/screenplay/rules/news-broadcasts.md +444 -444
  384. package/augment-extensions/writing-standards/screenplay/rules/pacing-timing.md +331 -331
  385. package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md +334 -334
  386. package/augment-extensions/writing-standards/screenplay/rules/quick-reference.md +299 -299
  387. package/augment-extensions/writing-standards/screenplay/rules/screen-continuity.md +263 -263
  388. package/augment-extensions/writing-standards/screenplay/rules/streaming-content.md +412 -412
  389. package/augment-extensions/writing-standards/screenplay/rules/trope-management.md +370 -370
  390. package/augment-extensions/writing-standards/screenplay/rules/tv-series.md +374 -374
  391. package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -339
  392. package/augment-extensions/writing-standards/screenplay/rules/vscode-integration.md +277 -277
  393. package/augment-extensions/writing-standards/screenplay/rules/web-content.md +393 -393
  394. package/augment-extensions/writing-standards/screenplay/schemas/beat-sheet.json +332 -332
  395. package/augment-extensions/writing-standards/screenplay/schemas/character-profile.json +247 -247
  396. package/augment-extensions/writing-standards/screenplay/schemas/feature-selection.json +200 -200
  397. package/augment-extensions/writing-standards/screenplay/schemas/plot-outline.json +233 -233
  398. package/augment-extensions/writing-standards/screenplay/schemas/screenplay-config.json +245 -245
  399. package/augment-extensions/writing-standards/screenplay/schemas/trope-inventory.json +221 -221
  400. package/augment-extensions/writing-standards/screenplay/styles/README.md +159 -159
  401. package/augment-extensions/writing-standards/screenplay/styles/examples/.gitkeep +2 -2
  402. package/augment-extensions/writing-standards/screenplay/styles/examples/style-applications.md +1449 -1449
  403. package/augment-extensions/writing-standards/screenplay/styles/module.json +64 -64
  404. package/augment-extensions/writing-standards/screenplay/styles/rules/.gitkeep +2 -2
  405. package/augment-extensions/writing-standards/screenplay/styles/rules/dialogue-centric.md +520 -520
  406. package/augment-extensions/writing-standards/screenplay/styles/rules/ensemble.md +499 -499
  407. package/augment-extensions/writing-standards/screenplay/styles/rules/epic.md +497 -497
  408. package/augment-extensions/writing-standards/screenplay/styles/rules/experimental.md +492 -492
  409. package/augment-extensions/writing-standards/screenplay/styles/rules/flashback.md +509 -509
  410. package/augment-extensions/writing-standards/screenplay/styles/rules/linear.md +490 -490
  411. package/augment-extensions/writing-standards/screenplay/styles/rules/minimalist.md +499 -499
  412. package/augment-extensions/writing-standards/screenplay/styles/rules/non-linear.md +501 -501
  413. package/augment-extensions/writing-standards/screenplay/styles/rules/poetic.md +499 -499
  414. package/augment-extensions/writing-standards/screenplay/styles/rules/realistic.md +498 -498
  415. package/augment-extensions/writing-standards/screenplay/styles/rules/satirical.md +499 -499
  416. package/augment-extensions/writing-standards/screenplay/styles/rules/surreal.md +508 -508
  417. package/augment-extensions/writing-standards/screenplay/styles/rules/voice-over.md +500 -500
  418. package/augment-extensions/writing-standards/screenplay/themes/README.md +158 -158
  419. package/augment-extensions/writing-standards/screenplay/themes/examples/.gitkeep +2 -2
  420. package/augment-extensions/writing-standards/screenplay/themes/examples/common-mistakes-and-fixes.md +643 -643
  421. package/augment-extensions/writing-standards/screenplay/themes/examples/complete-scene-example.md +311 -311
  422. package/augment-extensions/writing-standards/screenplay/themes/examples/individual-theme-examples.md +562 -562
  423. package/augment-extensions/writing-standards/screenplay/themes/examples/multi-theme-weaving.md +538 -538
  424. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-application-guide.md +432 -432
  425. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-integration-across-acts.md +637 -637
  426. package/augment-extensions/writing-standards/screenplay/themes/module.json +66 -66
  427. package/augment-extensions/writing-standards/screenplay/themes/rules/.gitkeep +2 -2
  428. package/augment-extensions/writing-standards/screenplay/themes/rules/ambition.md +458 -458
  429. package/augment-extensions/writing-standards/screenplay/themes/rules/betrayal.md +490 -490
  430. package/augment-extensions/writing-standards/screenplay/themes/rules/environment.md +458 -458
  431. package/augment-extensions/writing-standards/screenplay/themes/rules/fate.md +459 -459
  432. package/augment-extensions/writing-standards/screenplay/themes/rules/friendship.md +491 -491
  433. package/augment-extensions/writing-standards/screenplay/themes/rules/growth.md +491 -491
  434. package/augment-extensions/writing-standards/screenplay/themes/rules/identity.md +490 -490
  435. package/augment-extensions/writing-standards/screenplay/themes/rules/isolation.md +464 -464
  436. package/augment-extensions/writing-standards/screenplay/themes/rules/justice.md +461 -461
  437. package/augment-extensions/writing-standards/screenplay/themes/rules/love.md +489 -489
  438. package/augment-extensions/writing-standards/screenplay/themes/rules/power.md +494 -494
  439. package/augment-extensions/writing-standards/screenplay/themes/rules/redemption.md +483 -483
  440. package/augment-extensions/writing-standards/screenplay/themes/rules/revenge.md +489 -489
  441. package/augment-extensions/writing-standards/screenplay/themes/rules/survival.md +496 -496
  442. package/augment-extensions/writing-standards/screenplay/themes/rules/technology.md +463 -463
  443. package/augment-extensions/writing-standards/screenplay/utils/__tests__/file-organization.test.ts +169 -0
  444. package/augment-extensions/writing-standards/screenplay/utils/file-organization.ts +165 -0
  445. package/cli/MODULES.md +302 -302
  446. package/cli/dist/cli.js +109 -22
  447. package/cli/dist/cli.js.map +1 -1
  448. package/cli/dist/commands/gui.d.ts.map +1 -1
  449. package/cli/dist/commands/gui.js +54 -6
  450. package/cli/dist/commands/gui.js.map +1 -1
  451. package/cli/dist/commands/init.d.ts.map +1 -1
  452. package/cli/dist/commands/init.js +76 -23
  453. package/cli/dist/commands/init.js.map +1 -1
  454. package/cli/dist/commands/self-remove.d.ts.map +1 -1
  455. package/cli/dist/commands/self-remove.js +48 -74
  456. package/cli/dist/commands/self-remove.js.map +1 -1
  457. package/cli/dist/commands/show.d.ts +11 -0
  458. package/cli/dist/commands/show.d.ts.map +1 -1
  459. package/cli/dist/commands/show.js +120 -0
  460. package/cli/dist/commands/show.js.map +1 -1
  461. package/cli/dist/commands/showCompleted.d.ts +21 -0
  462. package/cli/dist/commands/showCompleted.d.ts.map +1 -0
  463. package/cli/dist/commands/showCompleted.js +225 -0
  464. package/cli/dist/commands/showCompleted.js.map +1 -0
  465. package/cli/dist/commands/skill.js +88 -88
  466. package/cli/dist/commands/update.d.ts +2 -0
  467. package/cli/dist/commands/update.d.ts.map +1 -1
  468. package/cli/dist/commands/update.js +67 -1
  469. package/cli/dist/commands/update.js.map +1 -1
  470. package/cli/dist/utils/beadsCompletedChecker.d.ts +72 -0
  471. package/cli/dist/utils/beadsCompletedChecker.d.ts.map +1 -0
  472. package/cli/dist/utils/beadsCompletedChecker.js +198 -0
  473. package/cli/dist/utils/beadsCompletedChecker.js.map +1 -0
  474. package/cli/dist/utils/catalog-sync.js +13 -13
  475. package/cli/dist/utils/extractCommandHelp.d.ts +51 -0
  476. package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
  477. package/cli/dist/utils/extractCommandHelp.js +250 -0
  478. package/cli/dist/utils/extractCommandHelp.js.map +1 -0
  479. package/cli/dist/utils/install-rules.js +55 -55
  480. package/cli/dist/utils/mcp-integration.js +44 -44
  481. package/cli/dist/utils/rule-install-hooks.js +8 -8
  482. package/modules.md +667 -630
  483. package/package.json +85 -85
@@ -1,521 +1,521 @@
1
- # Vector Databases
2
-
3
- ## Overview
4
-
5
- This document covers vector database fundamentals, including when to use vector databases, embedding generation, vector storage, similarity search, distance metrics, hybrid search, database selection, and use cases for semantic search, RAG (Retrieval-Augmented Generation), and recommendation systems.
6
-
7
- ---
8
-
9
- ## When to Use Vector Databases
10
-
11
- ### Ideal Use Cases
12
-
13
- **Use vector databases when:**
14
- - ✅ Semantic search is required (meaning-based, not keyword-based)
15
- - ✅ Building RAG (Retrieval-Augmented Generation) systems
16
- - ✅ Similarity search across unstructured data (text, images, audio)
17
- - ✅ Recommendation engines based on content similarity
18
- - ✅ Anomaly detection using vector similarity
19
- - ✅ Duplicate detection (near-duplicate content)
20
- - ✅ Question-answering systems
21
- - ✅ Image/video search by content
22
-
23
- **Examples:**
24
- - Semantic document search (find similar documents by meaning)
25
- - Chatbots with context retrieval (RAG systems)
26
- - Product recommendations (similar items)
27
- - Image similarity search (reverse image search)
28
- - Code search (find similar code snippets)
29
- - Customer support (find similar tickets/solutions)
30
- - Content moderation (detect similar harmful content)
31
-
32
- ### When to Use Traditional Databases Instead
33
-
34
- **Use relational/NoSQL databases when:**
35
- - ❌ Exact keyword matching is sufficient
36
- - ❌ Structured data with clear relationships
37
- - ❌ No need for semantic understanding
38
- - ❌ Simple filtering and sorting operations
39
- - ❌ ACID transactions are critical
40
- - ❌ Cost optimization is priority (vector DBs can be expensive)
41
-
42
- ---
43
-
44
- ## Vector Database Fundamentals
45
-
46
- ### What is a Vector Database?
47
-
48
- **Definition**: Database optimized for storing and querying high-dimensional vectors (embeddings)
49
-
50
- **Key Characteristics:**
51
- - Stores vectors (arrays of numbers representing data)
52
- - Optimized for similarity search (nearest neighbor search)
53
- - Supports high-dimensional data (100s to 1000s of dimensions)
54
- - Fast approximate nearest neighbor (ANN) search
55
- - Metadata filtering combined with vector search
56
-
57
- **Example Vector:**
58
- ```
59
- Text: "The cat sat on the mat"
60
- Embedding: [0.234, -0.567, 0.891, ..., 0.123] # 1536 dimensions (OpenAI)
61
- ```
62
-
63
- ### How Vector Databases Work
64
-
65
- **1. Embedding Generation:**
66
- - Convert data (text, images, etc.) to vectors using ML models
67
- - Each vector represents semantic meaning in high-dimensional space
68
- - Similar items have similar vectors (close in vector space)
69
-
70
- **2. Vector Storage:**
71
- - Store vectors with metadata (original text, IDs, tags, etc.)
72
- - Index vectors for fast similarity search
73
- - Support CRUD operations on vectors
74
-
75
- **3. Similarity Search:**
76
- - Query with a vector (e.g., embedding of search query)
77
- - Find k-nearest neighbors (most similar vectors)
78
- - Return results ranked by similarity score
79
-
80
- ---
81
-
82
- ## Distance Metrics
83
-
84
- ### Common Distance Metrics
85
-
86
- **1. Cosine Similarity (Most Common)**
87
- - Measures angle between vectors
88
- - Range: -1 (opposite) to 1 (identical)
89
- - Ignores magnitude, focuses on direction
90
- - **Best for**: Text embeddings, semantic search
91
-
92
- ```python
93
- # Cosine similarity
94
- from numpy import dot
95
- from numpy.linalg import norm
96
-
97
- def cosine_similarity(a, b):
98
- return dot(a, b) / (norm(a) * norm(b))
99
- ```
100
-
101
- **2. Euclidean Distance (L2)**
102
- - Measures straight-line distance between vectors
103
- - Range: 0 (identical) to ∞ (very different)
104
- - Considers both direction and magnitude
105
- - **Best for**: Image embeddings, spatial data
106
-
107
- ```python
108
- # Euclidean distance
109
- import numpy as np
110
-
111
- def euclidean_distance(a, b):
112
- return np.linalg.norm(a - b)
113
- ```
114
-
115
- **3. Dot Product**
116
- - Measures alignment and magnitude
117
- - Range: -∞ to ∞
118
- - Faster than cosine (no normalization)
119
- - **Best for**: Normalized embeddings, performance-critical applications
120
-
121
- ```python
122
- # Dot product
123
- import numpy as np
124
-
125
- def dot_product(a, b):
126
- return np.dot(a, b)
127
- ```
128
-
129
- **4. Manhattan Distance (L1)**
130
- - Sum of absolute differences
131
- - Range: 0 to ∞
132
- - Less sensitive to outliers than Euclidean
133
- - **Best for**: High-dimensional sparse data
134
-
135
- ### Choosing a Distance Metric
136
-
137
- | Metric | Use Case | Pros | Cons |
138
- |--------|----------|------|------|
139
- | Cosine | Text embeddings, semantic search | Ignores magnitude, intuitive | Slower than dot product |
140
- | Euclidean | Image embeddings, spatial data | Considers magnitude | Sensitive to scale |
141
- | Dot Product | Normalized embeddings, speed | Fastest | Requires normalized vectors |
142
- | Manhattan | Sparse high-dimensional data | Robust to outliers | Less intuitive |
143
-
144
- **Recommendation**: Use **cosine similarity** for most text-based applications
145
-
146
- ---
147
-
148
- ## Popular Vector Databases
149
-
150
- ### Database Comparison
151
-
152
- **Pinecone (Managed)**
153
- - Fully managed cloud service
154
- - Easy to use, minimal setup
155
- - Auto-scaling and high availability
156
- - Metadata filtering
157
- - Hybrid search (vector + metadata)
158
- - **Best for**: Production applications, minimal ops overhead
159
-
160
- **Weaviate (Open Source + Managed)**
161
- - Open source with managed cloud option
162
- - Built-in vectorization (multiple models)
163
- - GraphQL API
164
- - Hybrid search (vector + keyword)
165
- - Multi-tenancy support
166
- - **Best for**: Flexibility, self-hosting option
167
-
168
- **Milvus (Open Source)**
169
- - Open source, CNCF project
170
- - High performance, scalable
171
- - Multiple index types (HNSW, IVF, etc.)
172
- - GPU acceleration support
173
- - Kubernetes-native
174
- - **Best for**: Large-scale deployments, self-hosting
175
-
176
- **Qdrant (Open Source + Managed)**
177
- - Open source with managed cloud option
178
- - Written in Rust (high performance)
179
- - Rich filtering capabilities
180
- - Payload-based filtering
181
- - Snapshots and backups
182
- - **Best for**: Advanced filtering, self-hosting
183
-
184
- **Chroma (Open Source)**
185
- - Open source, embedded database
186
- - Simple API, easy to get started
187
- - Built for LLM applications
188
- - Local-first development
189
- - Python/JavaScript SDKs
190
- - **Best for**: Development, prototyping, local applications
191
-
192
- **pgvector (PostgreSQL Extension)**
193
- - PostgreSQL extension for vector storage
194
- - Leverage existing PostgreSQL infrastructure
195
- - ACID transactions with vectors
196
- - Combine relational + vector data
197
- - Familiar SQL interface
198
- - **Best for**: Existing PostgreSQL users, hybrid workloads
199
-
200
- ### Selection Criteria
201
-
202
- **Choose Pinecone if:**
203
- - You want fully managed service
204
- - Minimal ops overhead is priority
205
- - You need auto-scaling
206
- - Budget allows for managed service
207
-
208
- **Choose Weaviate if:**
209
- - You want built-in vectorization
210
- - GraphQL API is preferred
211
- - You need self-hosting option
212
- - Hybrid search is critical
213
-
214
- **Choose Milvus if:**
215
- - You need maximum performance
216
- - Large-scale deployment (billions of vectors)
217
- - GPU acceleration is required
218
- - Kubernetes infrastructure exists
219
-
220
- **Choose Qdrant if:**
221
- - Advanced filtering is critical
222
- - You want Rust performance
223
- - Self-hosting with managed option
224
- - Payload-based search is needed
225
-
226
- **Choose Chroma if:**
227
- - You're prototyping/developing locally
228
- - Simple API is priority
229
- - Embedded database is preferred
230
- - LLM application focus
231
-
232
- **Choose pgvector if:**
233
- - You already use PostgreSQL
234
- - You need ACID transactions with vectors
235
- - Hybrid relational + vector data
236
- - Familiar SQL interface is preferred
237
-
238
- ---
239
-
240
- ## Hybrid Search
241
-
242
- ### What is Hybrid Search?
243
-
244
- **Definition**: Combining vector similarity search with traditional keyword/metadata filtering
245
-
246
- **Benefits:**
247
- - More accurate results (semantic + keyword matching)
248
- - Filter by metadata (date, category, author, etc.)
249
- - Combine multiple ranking signals
250
- - Better user experience
251
-
252
- ### Hybrid Search Patterns
253
-
254
- **Pattern 1: Vector Search + Metadata Filtering**
255
- ```python
256
- # Search for similar documents, filtered by category
257
- results = index.query(
258
- vector=query_embedding,
259
- top_k=10,
260
- filter={"category": "technology", "date": {"$gte": "2024-01-01"}}
261
- )
262
- ```
263
-
264
- **Pattern 2: Vector Search + Keyword Search**
265
- ```python
266
- # Combine semantic search with keyword matching
267
- vector_results = vector_search(query_embedding, top_k=50)
268
- keyword_results = keyword_search(query_text, top_k=50)
269
-
270
- # Merge and re-rank results
271
- final_results = merge_and_rerank(vector_results, keyword_results)
272
- ```
273
-
274
- **Pattern 3: Weighted Hybrid Search**
275
- ```python
276
- # Weight vector and keyword scores
277
- final_score = (0.7 * vector_score) + (0.3 * keyword_score)
278
- ```
279
-
280
- ### Implementing Hybrid Search
281
-
282
- **Example with Weaviate:**
283
- ```python
284
- import weaviate
285
-
286
- client = weaviate.Client("http://localhost:8080")
287
-
288
- # Hybrid search (vector + keyword)
289
- result = client.query.get("Article", ["title", "content"]) \
290
- .with_hybrid(
291
- query="machine learning",
292
- alpha=0.5 # 0.5 = equal weight vector/keyword
293
- ) \
294
- .with_where({
295
- "path": ["category"],
296
- "operator": "Equal",
297
- "valueString": "AI"
298
- }) \
299
- .with_limit(10) \
300
- .do()
301
- ```
302
-
303
- **Example with Pinecone:**
304
- ```python
305
- import pinecone
306
-
307
- index = pinecone.Index("my-index")
308
-
309
- # Vector search with metadata filtering
310
- results = index.query(
311
- vector=query_embedding,
312
- top_k=10,
313
- filter={
314
- "category": {"$eq": "AI"},
315
- "published_date": {"$gte": "2024-01-01"}
316
- },
317
- include_metadata=True
318
- )
319
- ```
320
-
321
- ---
322
-
323
- ## Use Cases
324
-
325
- ### 1. Semantic Search
326
-
327
- **Problem**: Keyword search misses semantically similar content
328
-
329
- **Solution**: Vector search finds documents by meaning, not just keywords
330
-
331
- **Example:**
332
- ```
333
- Query: "How to fix a leaky faucet"
334
- Keyword search: Finds documents with exact words "leaky faucet"
335
- Vector search: Also finds "dripping tap repair", "water fixture maintenance"
336
- ```
337
-
338
- **Implementation:**
339
- 1. Generate embeddings for all documents
340
- 2. Store embeddings in vector database
341
- 3. Generate embedding for search query
342
- 4. Find k-nearest neighbors
343
- 5. Return ranked results
344
-
345
- ### 2. RAG (Retrieval-Augmented Generation)
346
-
347
- **Problem**: LLMs lack domain-specific knowledge or up-to-date information
348
-
349
- **Solution**: Retrieve relevant context from vector database, augment LLM prompt
350
-
351
- **Workflow:**
352
- 1. User asks question
353
- 2. Generate embedding for question
354
- 3. Search vector database for relevant documents
355
- 4. Retrieve top-k most similar documents
356
- 5. Augment LLM prompt with retrieved context
357
- 6. Generate answer using LLM + context
358
-
359
- **Example:**
360
- ```python
361
- # RAG implementation
362
- def rag_query(question, index, llm):
363
- # 1. Generate question embedding
364
- question_embedding = embed(question)
365
-
366
- # 2. Retrieve relevant documents
367
- results = index.query(question_embedding, top_k=5)
368
- context = "\n".join([r.text for r in results])
369
-
370
- # 3. Augment prompt with context
371
- prompt = f"""
372
- Context: {context}
373
-
374
- Question: {question}
375
-
376
- Answer based on the context above:
377
- """
378
-
379
- # 4. Generate answer
380
- answer = llm.generate(prompt)
381
- return answer
382
- ```
383
-
384
- ### 3. Recommendation Systems
385
-
386
- **Problem**: Recommend similar items based on content, not just collaborative filtering
387
-
388
- **Solution**: Find items with similar embeddings
389
-
390
- **Example:**
391
- ```python
392
- # Product recommendation
393
- def recommend_similar_products(product_id, index, top_k=5):
394
- # Get product embedding
395
- product_embedding = index.fetch([product_id])[0].vector
396
-
397
- # Find similar products
398
- results = index.query(
399
- vector=product_embedding,
400
- top_k=top_k + 1, # +1 to exclude self
401
- filter={"product_id": {"$ne": product_id}}
402
- )
403
-
404
- return results[1:] # Exclude the product itself
405
- ```
406
-
407
- ---
408
-
409
- ## Best Practices
410
-
411
- ### 1. Embedding Generation
412
-
413
- ✅ **DO:**
414
- - Use consistent embedding models (same model for indexing and querying)
415
- - Normalize embeddings if using dot product
416
- - Batch embed documents for efficiency
417
- - Cache embeddings to avoid re-computation
418
- - Version embeddings (track which model generated them)
419
-
420
- ❌ **DON'T:**
421
- - Mix embeddings from different models
422
- - Re-embed documents unnecessarily
423
- - Ignore embedding model updates
424
- - Store embeddings without metadata
425
-
426
- ### 2. Vector Storage
427
-
428
- ✅ **DO:**
429
- - Store metadata with vectors (original text, IDs, timestamps)
430
- - Use appropriate index type for your scale
431
- - Monitor index size and performance
432
- - Implement backup and recovery
433
- - Version your vector data
434
-
435
- ❌ **DON'T:**
436
- - Store only vectors without metadata
437
- - Use flat index for large datasets (>100k vectors)
438
- - Ignore index maintenance
439
- - Skip backups
440
-
441
- ### 3. Similarity Search
442
-
443
- ✅ **DO:**
444
- - Choose appropriate distance metric (cosine for text)
445
- - Tune top_k based on use case
446
- - Implement hybrid search for better accuracy
447
- - Monitor query latency
448
- - Use metadata filtering to narrow results
449
-
450
- ❌ **DON'T:**
451
- - Use wrong distance metric
452
- - Return too many results (top_k > 100)
453
- - Rely solely on vector search (ignore metadata)
454
- - Ignore performance optimization
455
-
456
- ### 4. Performance Optimization
457
-
458
- ✅ **DO:**
459
- - Use approximate nearest neighbor (ANN) algorithms
460
- - Tune index parameters (ef_construction, M for HNSW)
461
- - Implement caching for frequent queries
462
- - Batch operations when possible
463
- - Monitor and optimize query latency
464
-
465
- ❌ **DON'T:**
466
- - Use exact nearest neighbor for large datasets
467
- - Ignore index tuning
468
- - Query one vector at a time
469
- - Skip performance monitoring
470
-
471
- ---
472
-
473
- ## Common Pitfalls
474
-
475
- ### 1. Wrong Distance Metric
476
-
477
- **Problem**: Using Euclidean distance for text embeddings
478
-
479
- **Solution**: Use cosine similarity for text, Euclidean for images
480
-
481
- ### 2. Not Normalizing Embeddings
482
-
483
- **Problem**: Dot product gives inconsistent results
484
-
485
- **Solution**: Normalize embeddings before using dot product
486
-
487
- ### 3. Ignoring Metadata
488
-
489
- **Problem**: Vector search returns irrelevant results
490
-
491
- **Solution**: Combine vector search with metadata filtering
492
-
493
- ### 4. Poor Chunking Strategy
494
-
495
- **Problem**: Embeddings represent too much or too little context
496
-
497
- **Solution**: Chunk documents appropriately (see vector-embeddings.md)
498
-
499
- ### 5. Not Versioning Embeddings
500
-
501
- **Problem**: Can't track which model generated embeddings
502
-
503
- **Solution**: Store embedding model version with vectors
504
-
505
- ---
506
-
507
- ## Summary
508
-
509
- **Key Takeaways:**
510
- 1. Vector databases enable semantic search and similarity-based retrieval
511
- 2. Choose distance metric based on data type (cosine for text)
512
- 3. Use hybrid search for better accuracy (vector + metadata)
513
- 4. Popular options: Pinecone (managed), Weaviate (flexible), Milvus (scale)
514
- 5. Common use cases: semantic search, RAG, recommendations
515
- 6. Best practices: consistent embeddings, metadata storage, performance tuning
516
-
517
- **Next Steps:**
518
- - See `vector-embeddings.md` for embedding generation strategies
519
- - See `vector-indexing.md` for index optimization
520
- - See `examples/vector-database-example.md` for complete implementation
521
-
1
+ # Vector Databases
2
+
3
+ ## Overview
4
+
5
+ This document covers vector database fundamentals, including when to use vector databases, embedding generation, vector storage, similarity search, distance metrics, hybrid search, database selection, and use cases for semantic search, RAG (Retrieval-Augmented Generation), and recommendation systems.
6
+
7
+ ---
8
+
9
+ ## When to Use Vector Databases
10
+
11
+ ### Ideal Use Cases
12
+
13
+ **Use vector databases when:**
14
+ - ✅ Semantic search is required (meaning-based, not keyword-based)
15
+ - ✅ Building RAG (Retrieval-Augmented Generation) systems
16
+ - ✅ Similarity search across unstructured data (text, images, audio)
17
+ - ✅ Recommendation engines based on content similarity
18
+ - ✅ Anomaly detection using vector similarity
19
+ - ✅ Duplicate detection (near-duplicate content)
20
+ - ✅ Question-answering systems
21
+ - ✅ Image/video search by content
22
+
23
+ **Examples:**
24
+ - Semantic document search (find similar documents by meaning)
25
+ - Chatbots with context retrieval (RAG systems)
26
+ - Product recommendations (similar items)
27
+ - Image similarity search (reverse image search)
28
+ - Code search (find similar code snippets)
29
+ - Customer support (find similar tickets/solutions)
30
+ - Content moderation (detect similar harmful content)
31
+
32
+ ### When to Use Traditional Databases Instead
33
+
34
+ **Use relational/NoSQL databases when:**
35
+ - ❌ Exact keyword matching is sufficient
36
+ - ❌ Structured data with clear relationships
37
+ - ❌ No need for semantic understanding
38
+ - ❌ Simple filtering and sorting operations
39
+ - ❌ ACID transactions are critical
40
+ - ❌ Cost optimization is priority (vector DBs can be expensive)
41
+
42
+ ---
43
+
44
+ ## Vector Database Fundamentals
45
+
46
+ ### What is a Vector Database?
47
+
48
+ **Definition**: Database optimized for storing and querying high-dimensional vectors (embeddings)
49
+
50
+ **Key Characteristics:**
51
+ - Stores vectors (arrays of numbers representing data)
52
+ - Optimized for similarity search (nearest neighbor search)
53
+ - Supports high-dimensional data (100s to 1000s of dimensions)
54
+ - Fast approximate nearest neighbor (ANN) search
55
+ - Metadata filtering combined with vector search
56
+
57
+ **Example Vector:**
58
+ ```
59
+ Text: "The cat sat on the mat"
60
+ Embedding: [0.234, -0.567, 0.891, ..., 0.123] # 1536 dimensions (OpenAI)
61
+ ```
62
+
63
+ ### How Vector Databases Work
64
+
65
+ **1. Embedding Generation:**
66
+ - Convert data (text, images, etc.) to vectors using ML models
67
+ - Each vector represents semantic meaning in high-dimensional space
68
+ - Similar items have similar vectors (close in vector space)
69
+
70
+ **2. Vector Storage:**
71
+ - Store vectors with metadata (original text, IDs, tags, etc.)
72
+ - Index vectors for fast similarity search
73
+ - Support CRUD operations on vectors
74
+
75
+ **3. Similarity Search:**
76
+ - Query with a vector (e.g., embedding of search query)
77
+ - Find k-nearest neighbors (most similar vectors)
78
+ - Return results ranked by similarity score
79
+
80
+ ---
81
+
82
+ ## Distance Metrics
83
+
84
+ ### Common Distance Metrics
85
+
86
+ **1. Cosine Similarity (Most Common)**
87
+ - Measures angle between vectors
88
+ - Range: -1 (opposite) to 1 (identical)
89
+ - Ignores magnitude, focuses on direction
90
+ - **Best for**: Text embeddings, semantic search
91
+
92
+ ```python
93
+ # Cosine similarity
94
+ from numpy import dot
95
+ from numpy.linalg import norm
96
+
97
+ def cosine_similarity(a, b):
98
+ return dot(a, b) / (norm(a) * norm(b))
99
+ ```
100
+
101
+ **2. Euclidean Distance (L2)**
102
+ - Measures straight-line distance between vectors
103
+ - Range: 0 (identical) to ∞ (very different)
104
+ - Considers both direction and magnitude
105
+ - **Best for**: Image embeddings, spatial data
106
+
107
+ ```python
108
+ # Euclidean distance
109
+ import numpy as np
110
+
111
+ def euclidean_distance(a, b):
112
+ return np.linalg.norm(a - b)
113
+ ```
114
+
115
+ **3. Dot Product**
116
+ - Measures alignment and magnitude
117
+ - Range: -∞ to ∞
118
+ - Faster than cosine (no normalization)
119
+ - **Best for**: Normalized embeddings, performance-critical applications
120
+
121
+ ```python
122
+ # Dot product
123
+ import numpy as np
124
+
125
+ def dot_product(a, b):
126
+ return np.dot(a, b)
127
+ ```
128
+
129
+ **4. Manhattan Distance (L1)**
130
+ - Sum of absolute differences
131
+ - Range: 0 to ∞
132
+ - Less sensitive to outliers than Euclidean
133
+ - **Best for**: High-dimensional sparse data
134
+
135
+ ### Choosing a Distance Metric
136
+
137
+ | Metric | Use Case | Pros | Cons |
138
+ |--------|----------|------|------|
139
+ | Cosine | Text embeddings, semantic search | Ignores magnitude, intuitive | Slower than dot product |
140
+ | Euclidean | Image embeddings, spatial data | Considers magnitude | Sensitive to scale |
141
+ | Dot Product | Normalized embeddings, speed | Fastest | Requires normalized vectors |
142
+ | Manhattan | Sparse high-dimensional data | Robust to outliers | Less intuitive |
143
+
144
+ **Recommendation**: Use **cosine similarity** for most text-based applications
145
+
146
+ ---
147
+
148
+ ## Popular Vector Databases
149
+
150
+ ### Database Comparison
151
+
152
+ **Pinecone (Managed)**
153
+ - Fully managed cloud service
154
+ - Easy to use, minimal setup
155
+ - Auto-scaling and high availability
156
+ - Metadata filtering
157
+ - Hybrid search (vector + metadata)
158
+ - **Best for**: Production applications, minimal ops overhead
159
+
160
+ **Weaviate (Open Source + Managed)**
161
+ - Open source with managed cloud option
162
+ - Built-in vectorization (multiple models)
163
+ - GraphQL API
164
+ - Hybrid search (vector + keyword)
165
+ - Multi-tenancy support
166
+ - **Best for**: Flexibility, self-hosting option
167
+
168
+ **Milvus (Open Source)**
169
+ - Open source, CNCF project
170
+ - High performance, scalable
171
+ - Multiple index types (HNSW, IVF, etc.)
172
+ - GPU acceleration support
173
+ - Kubernetes-native
174
+ - **Best for**: Large-scale deployments, self-hosting
175
+
176
+ **Qdrant (Open Source + Managed)**
177
+ - Open source with managed cloud option
178
+ - Written in Rust (high performance)
179
+ - Rich filtering capabilities
180
+ - Payload-based filtering
181
+ - Snapshots and backups
182
+ - **Best for**: Advanced filtering, self-hosting
183
+
184
+ **Chroma (Open Source)**
185
+ - Open source, embedded database
186
+ - Simple API, easy to get started
187
+ - Built for LLM applications
188
+ - Local-first development
189
+ - Python/JavaScript SDKs
190
+ - **Best for**: Development, prototyping, local applications
191
+
192
+ **pgvector (PostgreSQL Extension)**
193
+ - PostgreSQL extension for vector storage
194
+ - Leverage existing PostgreSQL infrastructure
195
+ - ACID transactions with vectors
196
+ - Combine relational + vector data
197
+ - Familiar SQL interface
198
+ - **Best for**: Existing PostgreSQL users, hybrid workloads
199
+
200
+ ### Selection Criteria
201
+
202
+ **Choose Pinecone if:**
203
+ - You want fully managed service
204
+ - Minimal ops overhead is priority
205
+ - You need auto-scaling
206
+ - Budget allows for managed service
207
+
208
+ **Choose Weaviate if:**
209
+ - You want built-in vectorization
210
+ - GraphQL API is preferred
211
+ - You need self-hosting option
212
+ - Hybrid search is critical
213
+
214
+ **Choose Milvus if:**
215
+ - You need maximum performance
216
+ - Large-scale deployment (billions of vectors)
217
+ - GPU acceleration is required
218
+ - Kubernetes infrastructure exists
219
+
220
+ **Choose Qdrant if:**
221
+ - Advanced filtering is critical
222
+ - You want Rust performance
223
+ - Self-hosting with managed option
224
+ - Payload-based search is needed
225
+
226
+ **Choose Chroma if:**
227
+ - You're prototyping/developing locally
228
+ - Simple API is priority
229
+ - Embedded database is preferred
230
+ - LLM application focus
231
+
232
+ **Choose pgvector if:**
233
+ - You already use PostgreSQL
234
+ - You need ACID transactions with vectors
235
+ - Hybrid relational + vector data
236
+ - Familiar SQL interface is preferred
237
+
238
+ ---
239
+
240
+ ## Hybrid Search
241
+
242
+ ### What is Hybrid Search?
243
+
244
+ **Definition**: Combining vector similarity search with traditional keyword/metadata filtering
245
+
246
+ **Benefits:**
247
+ - More accurate results (semantic + keyword matching)
248
+ - Filter by metadata (date, category, author, etc.)
249
+ - Combine multiple ranking signals
250
+ - Better user experience
251
+
252
+ ### Hybrid Search Patterns
253
+
254
+ **Pattern 1: Vector Search + Metadata Filtering**
255
+ ```python
256
+ # Search for similar documents, filtered by category
257
+ results = index.query(
258
+ vector=query_embedding,
259
+ top_k=10,
260
+ filter={"category": "technology", "date": {"$gte": "2024-01-01"}}
261
+ )
262
+ ```
263
+
264
+ **Pattern 2: Vector Search + Keyword Search**
265
+ ```python
266
+ # Combine semantic search with keyword matching
267
+ vector_results = vector_search(query_embedding, top_k=50)
268
+ keyword_results = keyword_search(query_text, top_k=50)
269
+
270
+ # Merge and re-rank results
271
+ final_results = merge_and_rerank(vector_results, keyword_results)
272
+ ```
273
+
274
+ **Pattern 3: Weighted Hybrid Search**
275
+ ```python
276
+ # Weight vector and keyword scores
277
+ final_score = (0.7 * vector_score) + (0.3 * keyword_score)
278
+ ```
279
+
280
+ ### Implementing Hybrid Search
281
+
282
+ **Example with Weaviate:**
283
+ ```python
284
+ import weaviate
285
+
286
+ client = weaviate.Client("http://localhost:8080")
287
+
288
+ # Hybrid search (vector + keyword)
289
+ result = client.query.get("Article", ["title", "content"]) \
290
+ .with_hybrid(
291
+ query="machine learning",
292
+ alpha=0.5 # 0.5 = equal weight vector/keyword
293
+ ) \
294
+ .with_where({
295
+ "path": ["category"],
296
+ "operator": "Equal",
297
+ "valueString": "AI"
298
+ }) \
299
+ .with_limit(10) \
300
+ .do()
301
+ ```
302
+
303
+ **Example with Pinecone:**
304
+ ```python
305
+ import pinecone
306
+
307
+ index = pinecone.Index("my-index")
308
+
309
+ # Vector search with metadata filtering
310
+ results = index.query(
311
+ vector=query_embedding,
312
+ top_k=10,
313
+ filter={
314
+ "category": {"$eq": "AI"},
315
+ "published_date": {"$gte": "2024-01-01"}
316
+ },
317
+ include_metadata=True
318
+ )
319
+ ```
320
+
321
+ ---
322
+
323
+ ## Use Cases
324
+
325
+ ### 1. Semantic Search
326
+
327
+ **Problem**: Keyword search misses semantically similar content
328
+
329
+ **Solution**: Vector search finds documents by meaning, not just keywords
330
+
331
+ **Example:**
332
+ ```
333
+ Query: "How to fix a leaky faucet"
334
+ Keyword search: Finds documents with exact words "leaky faucet"
335
+ Vector search: Also finds "dripping tap repair", "water fixture maintenance"
336
+ ```
337
+
338
+ **Implementation:**
339
+ 1. Generate embeddings for all documents
340
+ 2. Store embeddings in vector database
341
+ 3. Generate embedding for search query
342
+ 4. Find k-nearest neighbors
343
+ 5. Return ranked results
344
+
345
+ ### 2. RAG (Retrieval-Augmented Generation)
346
+
347
+ **Problem**: LLMs lack domain-specific knowledge or up-to-date information
348
+
349
+ **Solution**: Retrieve relevant context from vector database, augment LLM prompt
350
+
351
+ **Workflow:**
352
+ 1. User asks question
353
+ 2. Generate embedding for question
354
+ 3. Search vector database for relevant documents
355
+ 4. Retrieve top-k most similar documents
356
+ 5. Augment LLM prompt with retrieved context
357
+ 6. Generate answer using LLM + context
358
+
359
+ **Example:**
360
+ ```python
361
+ # RAG implementation
362
+ def rag_query(question, index, llm):
363
+ # 1. Generate question embedding
364
+ question_embedding = embed(question)
365
+
366
+ # 2. Retrieve relevant documents
367
+ results = index.query(question_embedding, top_k=5)
368
+ context = "\n".join([r.text for r in results])
369
+
370
+ # 3. Augment prompt with context
371
+ prompt = f"""
372
+ Context: {context}
373
+
374
+ Question: {question}
375
+
376
+ Answer based on the context above:
377
+ """
378
+
379
+ # 4. Generate answer
380
+ answer = llm.generate(prompt)
381
+ return answer
382
+ ```
383
+
384
+ ### 3. Recommendation Systems
385
+
386
+ **Problem**: Recommend similar items based on content, not just collaborative filtering
387
+
388
+ **Solution**: Find items with similar embeddings
389
+
390
+ **Example:**
391
+ ```python
392
+ # Product recommendation
393
+ def recommend_similar_products(product_id, index, top_k=5):
394
+ # Get product embedding
395
+ product_embedding = index.fetch([product_id])[0].vector
396
+
397
+ # Find similar products
398
+ results = index.query(
399
+ vector=product_embedding,
400
+ top_k=top_k + 1, # +1 to exclude self
401
+ filter={"product_id": {"$ne": product_id}}
402
+ )
403
+
404
+ return results[1:] # Exclude the product itself
405
+ ```
406
+
407
+ ---
408
+
409
+ ## Best Practices
410
+
411
+ ### 1. Embedding Generation
412
+
413
+ ✅ **DO:**
414
+ - Use consistent embedding models (same model for indexing and querying)
415
+ - Normalize embeddings if using dot product
416
+ - Batch embed documents for efficiency
417
+ - Cache embeddings to avoid re-computation
418
+ - Version embeddings (track which model generated them)
419
+
420
+ ❌ **DON'T:**
421
+ - Mix embeddings from different models
422
+ - Re-embed documents unnecessarily
423
+ - Ignore embedding model updates
424
+ - Store embeddings without metadata
425
+
426
+ ### 2. Vector Storage
427
+
428
+ ✅ **DO:**
429
+ - Store metadata with vectors (original text, IDs, timestamps)
430
+ - Use appropriate index type for your scale
431
+ - Monitor index size and performance
432
+ - Implement backup and recovery
433
+ - Version your vector data
434
+
435
+ ❌ **DON'T:**
436
+ - Store only vectors without metadata
437
+ - Use flat index for large datasets (>100k vectors)
438
+ - Ignore index maintenance
439
+ - Skip backups
440
+
441
+ ### 3. Similarity Search
442
+
443
+ ✅ **DO:**
444
+ - Choose appropriate distance metric (cosine for text)
445
+ - Tune top_k based on use case
446
+ - Implement hybrid search for better accuracy
447
+ - Monitor query latency
448
+ - Use metadata filtering to narrow results
449
+
450
+ ❌ **DON'T:**
451
+ - Use wrong distance metric
452
+ - Return too many results (top_k > 100)
453
+ - Rely solely on vector search (ignore metadata)
454
+ - Ignore performance optimization
455
+
456
+ ### 4. Performance Optimization
457
+
458
+ ✅ **DO:**
459
+ - Use approximate nearest neighbor (ANN) algorithms
460
+ - Tune index parameters (ef_construction, M for HNSW)
461
+ - Implement caching for frequent queries
462
+ - Batch operations when possible
463
+ - Monitor and optimize query latency
464
+
465
+ ❌ **DON'T:**
466
+ - Use exact nearest neighbor for large datasets
467
+ - Ignore index tuning
468
+ - Query one vector at a time
469
+ - Skip performance monitoring
470
+
471
+ ---
472
+
473
+ ## Common Pitfalls
474
+
475
+ ### 1. Wrong Distance Metric
476
+
477
+ **Problem**: Using Euclidean distance for text embeddings
478
+
479
+ **Solution**: Use cosine similarity for text, Euclidean for images
480
+
481
+ ### 2. Not Normalizing Embeddings
482
+
483
+ **Problem**: Dot product gives inconsistent results
484
+
485
+ **Solution**: Normalize embeddings before using dot product
486
+
487
+ ### 3. Ignoring Metadata
488
+
489
+ **Problem**: Vector search returns irrelevant results
490
+
491
+ **Solution**: Combine vector search with metadata filtering
492
+
493
+ ### 4. Poor Chunking Strategy
494
+
495
+ **Problem**: Embeddings represent too much or too little context
496
+
497
+ **Solution**: Chunk documents appropriately (see vector-embeddings.md)
498
+
499
+ ### 5. Not Versioning Embeddings
500
+
501
+ **Problem**: Can't track which model generated embeddings
502
+
503
+ **Solution**: Store embedding model version with vectors
504
+
505
+ ---
506
+
507
+ ## Summary
508
+
509
+ **Key Takeaways:**
510
+ 1. Vector databases enable semantic search and similarity-based retrieval
511
+ 2. Choose distance metric based on data type (cosine for text)
512
+ 3. Use hybrid search for better accuracy (vector + metadata)
513
+ 4. Popular options: Pinecone (managed), Weaviate (flexible), Milvus (scale)
514
+ 5. Common use cases: semantic search, RAG, recommendations
515
+ 6. Best practices: consistent embeddings, metadata storage, performance tuning
516
+
517
+ **Next Steps:**
518
+ - See `vector-embeddings.md` for embedding generation strategies
519
+ - See `vector-indexing.md` for index optimization
520
+ - See `examples/vector-database-example.md` for complete implementation
521
+