**feat(similarity): add similarity calculation between vectors and text inputs**
- Introduced `calculateSimilarity` method in `types.d.ts` for comparing vectors or textual inputs: - Added support for custom options, including `forceEmbed` and a custom `distanceFunction`. - Enhanced functionality in `embed` to convert text inputs into vector representations. - Added new test cases in `vector-operations.test.ts`: - Validated similarity calculations between identical and different vectors. - Tested similarity scoring for similar and dissimilar text inputs. - Updated `README.md`: - Documented `calculateSimilarity` usage examples, including advanced options. - Clarified the integration of the similarity function into workflows. **Purpose**: Enable calculation of similarity scores for vectors and text inputs to facilitate advanced data comparison and retrieval tasks.
This commit is contained in:
parent
90cbccb1da
commit
d05d381a5d
3 changed files with 77 additions and 0 deletions
|
|
@ -88,4 +88,54 @@ describe('Vector Operations', () => {
|
|||
// The closest should be the exact match
|
||||
expect(results[0].metadata.id).toBe('vec1')
|
||||
})
|
||||
|
||||
it('should calculate similarity between vectors correctly', async () => {
|
||||
const brainy = await import('../dist/unified.js')
|
||||
|
||||
const db = new brainy.BrainyData({
|
||||
distanceFunction: euclideanDistance
|
||||
})
|
||||
|
||||
await db.init()
|
||||
|
||||
// Create test vectors
|
||||
const vectorA = createTestVector(0)
|
||||
const vectorB = createTestVector(0) // Identical to vectorA
|
||||
const vectorC = createTestVector(1) // Different from vectorA
|
||||
|
||||
// Calculate similarity between identical vectors
|
||||
const similarityIdentical = await db.calculateSimilarity(vectorA, vectorB)
|
||||
|
||||
// Calculate similarity between different vectors
|
||||
const similarityDifferent = await db.calculateSimilarity(vectorA, vectorC)
|
||||
|
||||
// Identical vectors should have similarity close to 1
|
||||
expect(similarityIdentical).toBeCloseTo(1, 1)
|
||||
|
||||
// Different vectors should have lower similarity
|
||||
expect(similarityDifferent).toBeLessThan(similarityIdentical)
|
||||
})
|
||||
|
||||
it('should calculate similarity between text inputs correctly', async () => {
|
||||
const brainy = await import('../dist/unified.js')
|
||||
|
||||
const db = new brainy.BrainyData()
|
||||
|
||||
await db.init()
|
||||
|
||||
// Calculate similarity between similar texts
|
||||
const similarityHigh = await db.calculateSimilarity(
|
||||
"Cats are furry pets",
|
||||
"Felines make good companions"
|
||||
)
|
||||
|
||||
// Calculate similarity between different texts
|
||||
const similarityLow = await db.calculateSimilarity(
|
||||
"Cats are furry pets",
|
||||
"Python is a programming language"
|
||||
)
|
||||
|
||||
// Similar texts should have higher similarity than different texts
|
||||
expect(similarityHigh).toBeGreaterThan(similarityLow)
|
||||
})
|
||||
})
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue