File: VEMB_Test.php

package info (click to toggle)
php-nrk-predis 3.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 8,680 kB
  • sloc: php: 71,678; xml: 50; makefile: 12
file content (148 lines) | stat: -rw-r--r-- 4,132 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?php

/*
 * This file is part of the Predis package.
 *
 * (c) 2009-2020 Daniele Alessandri
 * (c) 2021-2025 Till Krüss
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Predis\Command\Redis;

use Predis\Command\Redis\Utils\VectorUtility;

class VEMB_Test extends PredisCommandTestCase
{
    /**
     * {@inheritDoc}
     */
    protected function getExpectedCommand(): string
    {
        return VEMB::class;
    }

    /**
     * {@inheritDoc}
     */
    protected function getExpectedId(): string
    {
        return 'VEMB';
    }

    /**
     * @dataProvider argumentsProvider
     * @param  array $actualArguments
     * @param  array $expectedArguments
     * @return void
     */
    public function testFilterArguments(array $actualArguments, array $expectedArguments): void
    {
        $command = $this->getCommand();
        $command->setArguments($actualArguments);

        $this->assertSame($expectedArguments, $command->getArguments());
    }

    /**
     * @return void
     */
    public function testParseResponse(): void
    {
        $command = $this->getCommand();

        // Without RAW argument
        $this->assertSame([0.111], $command->parseResponse(['0.111']));

        $arguments = ['key', 'elem', true];
        $command->setArguments($arguments);

        // With RAW argument
        $this->assertSame(['0.111'], $command->parseResponse(['0.111']));
    }

    /**
     * @dataProvider quantisationProvider
     * @group connected
     * @return void
     * @requiresRedisVersion >= 8.0.0
     */
    public function testReturnsVectorEmbedding(?string $quantisation)
    {
        $redis = $this->getClient();

        $this->assertTrue(
            $redis->vadd('key', VectorUtility::toBlob([0.1, 0.2, 0.3, 0.4]), 'elem1', null, false, $quantisation)
        );

        // RAW response
        foreach ($redis->vemb('key', 'elem1', true) as $key => $value) {
            if ($key <= 1) {
                $this->assertTrue(is_string($value));
            } else {
                $this->assertTrue(is_float($value));
            }
        }

        // no RAW response
        if ($quantisation !== VADD::QUANT_BIN) {
            $this->assertEqualsWithDelta([0.1, 0.2, 0.3, 0.4], $redis->vemb('key', 'elem1'), 0.1);
        } else {
            // Binary quantisation stores any vector > 0 as 1 and < 0 as 0
            $this->assertEqualsWithDelta([1, 1, 1, 1], $redis->vemb('key', 'elem1'), 0.1);
        }
    }

    /**
     * @dataProvider quantisationProvider
     * @group connected
     * @return void
     * @requiresRedisVersion >= 8.0.0
     */
    public function testReturnsVectorEmbeddingResp3(?string $quantisation)
    {
        $redis = $this->getResp3Client();

        $this->assertTrue(
            $redis->vadd('key', VectorUtility::toBlob([0.1, 0.2, 0.3, 0.4]), 'elem1', null, false, $quantisation)
        );

        // RAW response
        foreach ($redis->vemb('key', 'elem1', true) as $key => $value) {
            if ($key <= 1) {
                $this->assertTrue(is_string($value));
            } else {
                $this->assertTrue(is_float($value));
            }
        }

        // no RAW response
        if ($quantisation !== VADD::QUANT_BIN) {
            $this->assertEqualsWithDelta([0.1, 0.2, 0.3, 0.4], $redis->vemb('key', 'elem1'), 0.1);
        } else {
            // Binary quantisation stores any vector > 0 as 1 and < 0 as 0
            $this->assertEqualsWithDelta([1, 1, 1, 1], $redis->vemb('key', 'elem1'), 0.1);
        }
    }

    public static function argumentsProvider(): array
    {
        return [
            'with default args' => [
                ['key', 'elem'],
                ['key', 'elem'],
            ],
            'with RAW' => [
                ['key', 'elem', true],
                ['key', 'elem', 'RAW'],
            ],
        ];
    }

    public static function quantisationProvider(): array
    {
        return [[VADD::QUANT_DEFAULT], [VADD::QUANT_Q8], [VADD::QUANT_BIN], [VADD::QUANT_NOQUANT]];
    }
}