modules/text2vec-contextionary/additional/nearestneighbors/extender_test.go

//                           _       _
// __      _____  __ ___   ___  __ _| |_ ___
// \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
//  \ V  V /  __/ (_| |\ V /| | (_| | ||  __/
//   \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
//
//  Copyright © 2016 - 2024 Weaviate B.V. All rights reserved.
//
//  CONTACT: [email protected]
//

package nearestneighbors

import (
	"context"
	"testing"

	"github.com/go-openapi/strfmt"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"github.com/weaviate/weaviate/entities/additional"
	"github.com/weaviate/weaviate/entities/search"
	txt2vecmodels "github.com/weaviate/weaviate/modules/text2vec-contextionary/additional/models"
)

func TestExtender(t *testing.T) {
	f := &fakeContextionary{}
	e := NewExtender(f)

	t.Run("with empty results", func(t *testing.T) {
		testData := []search.Result(nil)
		expectedResults := []search.Result(nil)

		res, err := e.Multi(context.Background(), testData, nil)
		require.Nil(t, err)
		assert.Equal(t, expectedResults, res)
	})

	t.Run("with a single result", func(t *testing.T) {
		testData := &search.Result{
			Schema: map[string]interface{}{"name": "item1"},
			Vector: []float32{0.1, 0.3, 0.5},
			AdditionalProperties: map[string]interface{}{
				"classification": &additional.Classification{ // verify it doesn't remove existing additional props
					ID: strfmt.UUID("123"),
				},
			},
		}

		expectedResult := &search.Result{
			Schema: map[string]interface{}{"name": "item1"},
			Vector: []float32{0.1, 0.3, 0.5},
			AdditionalProperties: map[string]interface{}{
				"classification": &additional.Classification{ // verify it doesn't remove existing additional props
					ID: strfmt.UUID("123"),
				},
				"nearestNeighbors": &txt2vecmodels.NearestNeighbors{
					Neighbors: []*txt2vecmodels.NearestNeighbor{
						{
							Concept:  "word1",
							Distance: 1,
						},
						{
							Concept:  "word2",
							Distance: 2,
						},
						{
							Concept:  "word3",
							Distance: 3,
						},
					},
				},
			},
		}

		res, err := e.Single(context.Background(), testData, nil)
		require.Nil(t, err)
		assert.Equal(t, expectedResult, res)
	})

	t.Run("with multiple results", func(t *testing.T) {
		vectors := [][]float32{
			{0.1, 0.2, 0.3},
			{0.11, 0.22, 0.33},
			{0.111, 0.222, 0.333},
		}

		testData := []search.Result{
			{
				Schema: map[string]interface{}{"name": "item1"},
				Vector: vectors[0],
			},
			{
				Schema: map[string]interface{}{"name": "item2"},
				Vector: vectors[1],
			},
			{
				Schema: map[string]interface{}{"name": "item3"},
				Vector: vectors[2],
				AdditionalProperties: map[string]interface{}{
					"classification": &additional.Classification{ // verify it doesn't remove existing additional props
						ID: strfmt.UUID("123"),
					},
				},
			},
		}

		expectedResults := []search.Result{
			{
				Schema: map[string]interface{}{"name": "item1"},
				Vector: vectors[0],
				AdditionalProperties: map[string]interface{}{
					"nearestNeighbors": &txt2vecmodels.NearestNeighbors{
						Neighbors: []*txt2vecmodels.NearestNeighbor{
							{
								Concept:  "word1",
								Distance: 1,
							},
							{
								Concept:  "word2",
								Distance: 2,
							},
							{
								Concept:  "word3",
								Distance: 3,
							},
						},
					},
				},
			},
			{
				Schema: map[string]interface{}{"name": "item2"},
				Vector: vectors[1],
				AdditionalProperties: map[string]interface{}{
					"nearestNeighbors": &txt2vecmodels.NearestNeighbors{
						Neighbors: []*txt2vecmodels.NearestNeighbor{
							{
								Concept:  "word4",
								Distance: 0.1,
							},
							{
								Concept:  "word5",
								Distance: 0.2,
							},
							{
								Concept:  "word6",
								Distance: 0.3,
							},
						},
					},
				},
			},
			{
				Schema: map[string]interface{}{"name": "item3"},
				Vector: vectors[2],
				AdditionalProperties: map[string]interface{}{
					"classification": &additional.Classification{ // verify it doesn't remove existing additional props
						ID: strfmt.UUID("123"),
					},
					"nearestNeighbors": &txt2vecmodels.NearestNeighbors{
						Neighbors: []*txt2vecmodels.NearestNeighbor{
							{
								Concept:  "word7",
								Distance: 1.1,
							},
							{
								Concept:  "word8",
								Distance: 2.2,
							},
							{
								Concept:  "word9",
								Distance: 3.3,
							},
						},
					},
				},
			},
		}

		res, err := e.Multi(context.Background(), testData, nil)
		require.Nil(t, err)
		assert.Equal(t, expectedResults, res)
		assert.Equal(t, f.calledWithVectors, vectors)
	})
}

type fakeContextionary struct {
	calledWithVectors [][]float32
}

func (f *fakeContextionary) MultiNearestWordsByVector(ctx context.Context, vectors [][]float32, k, n int) ([]*txt2vecmodels.NearestNeighbors, error) {
	f.calledWithVectors = vectors
	out := []*txt2vecmodels.NearestNeighbors{
		{
			Neighbors: []*txt2vecmodels.NearestNeighbor{
				{
					Concept:  "word1",
					Distance: 1.0,
					Vector:   nil,
				},
				{
					Concept:  "word2",
					Distance: 2.0,
					Vector:   nil,
				},
				{
					Concept:  "$THING[abc]",
					Distance: 9.99,
					Vector:   nil,
				},
				{
					Concept:  "word3",
					Distance: 3.0,
					Vector:   nil,
				},
			},
		},

		{
			Neighbors: []*txt2vecmodels.NearestNeighbor{
				{
					Concept:  "word4",
					Distance: 0.1,
					Vector:   nil,
				},
				{
					Concept:  "word5",
					Distance: 0.2,
					Vector:   nil,
				},
				{
					Concept:  "word6",
					Distance: 0.3,
					Vector:   nil,
				},
			},
		},

		{
			Neighbors: []*txt2vecmodels.NearestNeighbor{
				{
					Concept:  "word7",
					Distance: 1.1,
					Vector:   nil,
				},
				{
					Concept:  "word8",
					Distance: 2.2,
					Vector:   nil,
				},
				{
					Concept:  "word9",
					Distance: 3.3,
					Vector:   nil,
				},
			},
		},
	}

	return out[:len(vectors)], nil // return up to three results, but fewer if the input is shorter
}