Skip to content

Commit 28de67c

Browse files
authored
Updated package name to match brand (#14)
1 parent 7e95bf3 commit 28de67c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+143
-143
lines changed

README.md

+26-26
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Introduction ##
22

3-
The Predis Vector Library (PredisVL) is a PHP client for AI applications leveraging Redis.
3+
The Redis Vector Library (RedisVL) is a PHP client for AI applications leveraging Redis.
44

55
Designed for:
66
- Vector similarity search
@@ -13,21 +13,21 @@ full-text search, and geo-spatial search.
1313

1414
### Installation ###
1515

16-
For now PredisVL isn't available at packagist.org, but you can still install it via Composer by specifying [GitHub
17-
repository](https://github.com/RedisVentures/predis-vl) in your composer.json file.
16+
For now RedisVL isn't available at packagist.org, but you can still install it via Composer by specifying [GitHub
17+
repository](https://github.com/RedisVentures/redis-vector-php) in your composer.json file.
1818

1919
```shell
2020
{
2121
"repositories": [
2222
{
2323
"type": "github",
24-
"url": "https://github.com/RedisVentures/predis-vl.git"
24+
"url": "https://github.com/RedisVentures/redis-vector-php.git"
2525
}
2626
]
2727
}
2828
```
2929
```shell
30-
composer install redis-ventures/predis-vl
30+
composer install redis-ventures/redis-vl
3131
```
3232

3333
### Setting up Redis ####
@@ -78,7 +78,7 @@ $schema = [
7878
2. Create a SearchIndex object with an input schema and client connection to be able to interact with your Redis index
7979
```php
8080
use Predis\Client;
81-
use RedisVentures\PredisVl\Index\SearchIndex;
81+
use RedisVentures\RedisVl\Index\SearchIndex;
8282

8383
$client = new Client();
8484
$index = new SearchIndex($client, $schema);
@@ -104,7 +104,7 @@ Define queries and perform advanced search over your indices, including combinat
104104

105105
**VectorQuery** - flexible vector-similarity semantic search with customizable filters
106106
```php
107-
use RedisVentures\PredisVl\Query\VectorQuery;
107+
use RedisVentures\RedisVl\Query\VectorQuery;
108108

109109
$query = new VectorQuery(
110110
[0.001, 0.002, 0.03],
@@ -119,8 +119,8 @@ $results = $index->query($query);
119119

120120
Incorporate complex metadata filters on your queries:
121121
```php
122-
use RedisVentures\PredisVl\Query\Filter\TagFilter;
123-
use RedisVentures\PredisVl\Enum\Condition;
122+
use RedisVentures\RedisVl\Query\Filter\TagFilter;
123+
use RedisVentures\RedisVl\Enum\Condition;
124124

125125
$filter = new TagFilter(
126126
'categories',
@@ -150,8 +150,8 @@ Numeric filters could be applied to numeric fields.
150150
Supports variety of conditions applicable for scalar types (==, !=, <, >, <=, >=).
151151
More information [here](https://redis.io/docs/interact/search-and-query/query/range/).
152152
```php
153-
use RedisVentures\PredisVl\Query\Filter\NumericFilter;
154-
use RedisVentures\PredisVl\Enum\Condition;
153+
use RedisVentures\RedisVl\Query\Filter\NumericFilter;
154+
use RedisVentures\RedisVl\Enum\Condition;
155155

156156
$equal = new NumericFilter('numeric', Condition::equal, 10);
157157
$notEqual = new NumericFilter('numeric', Condition::notEqual, 10);
@@ -167,9 +167,9 @@ Tag filters could be applied to tag fields. Single or multiple values can be pro
167167
equality conditions (==, !==), for multiple tags additional conjunction (AND, OR) could be specified.
168168
More information [here](https://redis.io/docs/interact/search-and-query/advanced-concepts/tags/)
169169
```php
170-
use RedisVentures\PredisVl\Query\Filter\TagFilter;
171-
use RedisVentures\PredisVl\Enum\Condition;
172-
use RedisVentures\PredisVl\Enum\Logical;
170+
use RedisVentures\RedisVl\Query\Filter\TagFilter;
171+
use RedisVentures\RedisVl\Enum\Condition;
172+
use RedisVentures\RedisVl\Enum\Logical;
173173

174174
$singleTag = new TagFilter('tag', Condition::equal, 'value')
175175
$multipleTags = new TagFilter('tag', Condition::notEqual, [
@@ -184,8 +184,8 @@ Text filters could be applied to text fields. Values can be provided as a single
184184
specified condition. Empty value corresponds to all values (*).
185185
More information [here](https://redis.io/docs/interact/search-and-query/query/full-text/)
186186
```php
187-
use RedisVentures\PredisVl\Query\Filter\TextFilter;
188-
use RedisVentures\PredisVl\Enum\Condition;
187+
use RedisVentures\RedisVl\Query\Filter\TextFilter;
188+
use RedisVentures\RedisVl\Enum\Condition;
189189

190190
$single = new TextFilter('text', Condition::equal, 'foo');
191191

@@ -205,9 +205,9 @@ Geo filters could be applied to geo fields. Supports only equality conditions,
205205
value should be specified as specific-shape array.
206206
More information [here](https://redis.io/docs/interact/search-and-query/query/geo-spatial/)
207207
```php
208-
use RedisVentures\PredisVl\Query\Filter\GeoFilter;
209-
use RedisVentures\PredisVl\Enum\Condition;
210-
use RedisVentures\PredisVl\Enum\Unit;
208+
use RedisVentures\RedisVl\Query\Filter\GeoFilter;
209+
use RedisVentures\RedisVl\Enum\Condition;
210+
use RedisVentures\RedisVl\Enum\Unit;
211211

212212
$geo = new GeoFilter('geo', Condition::equal, [
213213
'lon' => 10.111,
@@ -223,11 +223,11 @@ To apply multiple filters to a single query use AggregateFilter.
223223
If there's the same logical operator that should be applied for each filter you can pass values in constructor,
224224
if you need a specific combination use `and()` and `or()` methods to create combined filter.
225225
```php
226-
use RedisVentures\PredisVl\Query\Filter\AggregateFilter;
227-
use RedisVentures\PredisVl\Query\Filter\TextFilter;
228-
use RedisVentures\PredisVl\Query\Filter\NumericFilter;
229-
use RedisVentures\PredisVl\Enum\Condition;
230-
use RedisVentures\PredisVl\Enum\Logical;
226+
use RedisVentures\RedisVl\Query\Filter\AggregateFilter;
227+
use RedisVentures\RedisVl\Query\Filter\TextFilter;
228+
use RedisVentures\RedisVl\Query\Filter\NumericFilter;
229+
use RedisVentures\RedisVl\Enum\Condition;
230+
use RedisVentures\RedisVl\Enum\Logical;
231231

232232
$aggregate = new AggregateFilter([
233233
new TextFilter('text', Condition::equal, 'value'),
@@ -254,7 +254,7 @@ The only required option is your API key specified as environment variable or co
254254

255255
### OpenAI ###
256256
```php
257-
use RedisVentures\PredisVl\Vectorizer\Factory;
257+
use RedisVentures\RedisVl\Vectorizer\Factory;
258258

259259
putenv('OPENAI_API_TOKEN=your_token');
260260

@@ -274,7 +274,7 @@ When you perform vector queries against Redis or load hash data into index that
274274
your vector should be represented as a blob string. VectorHelper allows you to create
275275
blob representation from your vector represented as array of floats.
276276
```php
277-
use RedisVentures\PredisVl\VectorHelper;
277+
use RedisVentures\RedisVl\VectorHelper;
278278

279279
$blobVector = VectorHelper::toBytes([0.001, 0.002, 0.003]);
280280
```

composer.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "redis-ventures/predis-vl",
3-
"description": "Predis Vector Library (PredisVL) enables Redis as a real-time database for LLM applications, based on Predis PHP client",
2+
"name": "redis-ventures/redis-vl",
3+
"description": "Redis Vector Library (RedisVL) enables Redis as a real-time database for LLM applications, based on Predis PHP client",
44
"type": "library",
55
"license": "MIT",
66
"require": {
@@ -14,12 +14,12 @@
1414
},
1515
"autoload": {
1616
"psr-4": {
17-
"RedisVentures\\PredisVl\\": "src/"
17+
"RedisVentures\\RedisVl\\": "src/"
1818
}
1919
},
2020
"autoload-dev": {
2121
"psr-4": {
22-
"RedisVentures\\PredisVl\\": "tests/"
22+
"RedisVentures\\RedisVl\\": "tests/"
2323
}
2424
},
2525
"authors": [

src/Enum/Condition.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Enum;
3+
namespace RedisVentures\RedisVl\Enum;
44

5-
use RedisVentures\PredisVl\Enum\Traits\EnumNames;
5+
use RedisVentures\RedisVl\Enum\Traits\EnumNames;
66

77
enum Condition: string
88
{

src/Enum/Logical.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Enum;
3+
namespace RedisVentures\RedisVl\Enum;
44

5-
use RedisVentures\PredisVl\Enum\Traits\EnumNames;
5+
use RedisVentures\RedisVl\Enum\Traits\EnumNames;
66

77
enum Logical: string
88
{

src/Enum/SearchField.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Enum;
3+
namespace RedisVentures\RedisVl\Enum;
44

55
use Predis\Command\Argument\Search\SchemaFields\GeoField;
66
use Predis\Command\Argument\Search\SchemaFields\NumericField;
77
use Predis\Command\Argument\Search\SchemaFields\TagField;
88
use Predis\Command\Argument\Search\SchemaFields\TextField;
99
use Predis\Command\Argument\Search\SchemaFields\VectorField;
10-
use RedisVentures\PredisVl\Enum\Traits\EnumNames;
10+
use RedisVentures\RedisVl\Enum\Traits\EnumNames;
1111

1212
enum SearchField
1313
{

src/Enum/StorageType.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Enum;
3+
namespace RedisVentures\RedisVl\Enum;
44

55
enum StorageType: string
66
{

src/Enum/Traits/EnumNames.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Enum\Traits;
3+
namespace RedisVentures\RedisVl\Enum\Traits;
44

55
trait EnumNames
66
{

src/Enum/Unit.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Enum;
3+
namespace RedisVentures\RedisVl\Enum;
44

5-
use RedisVentures\PredisVl\Enum\Traits\EnumNames;
5+
use RedisVentures\RedisVl\Enum\Traits\EnumNames;
66

77
enum Unit: string
88
{

src/Factory.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl;
3+
namespace RedisVentures\RedisVl;
44

55
use Predis\Command\Argument\Search\CreateArguments;
66
use Predis\Command\Argument\Search\SearchArguments;

src/FactoryInterface.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl;
3+
namespace RedisVentures\RedisVl;
44

55
use Predis\Command\Argument\Search\CreateArguments;
66
use Predis\Command\Argument\Search\SearchArguments;

src/Index/IndexInterface.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Index;
3+
namespace RedisVentures\RedisVl\Index;
44

5-
use RedisVentures\PredisVl\Query\QueryInterface;
5+
use RedisVentures\RedisVl\Query\QueryInterface;
66

77
interface IndexInterface
88
{

src/Index/SearchIndex.php

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Index;
3+
namespace RedisVentures\RedisVl\Index;
44

55
use Exception;
66
use Predis\Client;
77
use Predis\Command\Argument\Search\SchemaFields\VectorField;
88
use Predis\Response\ServerException;
9-
use RedisVentures\PredisVl\Enum\SearchField;
10-
use RedisVentures\PredisVl\Enum\StorageType;
11-
use RedisVentures\PredisVl\Factory;
12-
use RedisVentures\PredisVl\FactoryInterface;
13-
use RedisVentures\PredisVl\Query\QueryInterface;
9+
use RedisVentures\RedisVl\Enum\SearchField;
10+
use RedisVentures\RedisVl\Enum\StorageType;
11+
use RedisVentures\RedisVl\Factory;
12+
use RedisVentures\RedisVl\FactoryInterface;
13+
use RedisVentures\RedisVl\Query\QueryInterface;
1414

1515
class SearchIndex implements IndexInterface
1616
{

src/Query/AbstractQuery.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Query;
3+
namespace RedisVentures\RedisVl\Query;
44

55
use Predis\Command\Argument\Search\SearchArguments;
6-
use RedisVentures\PredisVl\Factory;
7-
use RedisVentures\PredisVl\FactoryInterface;
8-
use RedisVentures\PredisVl\Query\Filter\FilterInterface;
6+
use RedisVentures\RedisVl\Factory;
7+
use RedisVentures\RedisVl\FactoryInterface;
8+
use RedisVentures\RedisVl\Query\Filter\FilterInterface;
99

1010
abstract class AbstractQuery implements QueryInterface
1111
{

src/Query/Filter/AbstractFilter.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Query\Filter;
3+
namespace RedisVentures\RedisVl\Query\Filter;
44

55

66
abstract class AbstractFilter implements FilterInterface

src/Query/Filter/AggregateFilter.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Query\Filter;
3+
namespace RedisVentures\RedisVl\Query\Filter;
44

5-
use RedisVentures\PredisVl\Enum\Logical;
5+
use RedisVentures\RedisVl\Enum\Logical;
66

77
class AggregateFilter extends AbstractFilter implements AggregateFilterInterface
88
{

src/Query/Filter/AggregateFilterInterface.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Query\Filter;
3+
namespace RedisVentures\RedisVl\Query\Filter;
44

55
interface AggregateFilterInterface extends FilterInterface
66
{

src/Query/Filter/FilterInterface.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Query\Filter;
3+
namespace RedisVentures\RedisVl\Query\Filter;
44

55
interface FilterInterface
66
{

src/Query/Filter/GeoFilter.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Query\Filter;
3+
namespace RedisVentures\RedisVl\Query\Filter;
44

55
use JetBrains\PhpStorm\ArrayShape;
6-
use RedisVentures\PredisVl\Enum\Condition;
7-
use RedisVentures\PredisVl\Enum\Unit;
6+
use RedisVentures\RedisVl\Enum\Condition;
7+
use RedisVentures\RedisVl\Enum\Unit;
88

99
class GeoFilter extends AbstractFilter
1010
{

src/Query/Filter/NumericFilter.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Query\Filter;
3+
namespace RedisVentures\RedisVl\Query\Filter;
44

55
use Exception;
6-
use RedisVentures\PredisVl\Enum\Condition;
6+
use RedisVentures\RedisVl\Enum\Condition;
77

88
class NumericFilter extends AbstractFilter
99
{

src/Query/Filter/TagFilter.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Query\Filter;
3+
namespace RedisVentures\RedisVl\Query\Filter;
44

55
use JetBrains\PhpStorm\ArrayShape;
6-
use RedisVentures\PredisVl\Enum\Condition;
7-
use RedisVentures\PredisVl\Enum\Logical;
6+
use RedisVentures\RedisVl\Enum\Condition;
7+
use RedisVentures\RedisVl\Enum\Logical;
88

99
class TagFilter extends AbstractFilter
1010
{

src/Query/Filter/TextFilter.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Query\Filter;
3+
namespace RedisVentures\RedisVl\Query\Filter;
44

5-
use RedisVentures\PredisVl\Enum\Condition;
5+
use RedisVentures\RedisVl\Enum\Condition;
66

77
class TextFilter extends AbstractFilter
88
{

src/Query/QueryInterface.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<?php
22

3-
namespace RedisVentures\PredisVl\Query;
3+
namespace RedisVentures\RedisVl\Query;
44

55
use Predis\Command\Argument\Search\SearchArguments;
6-
use RedisVentures\PredisVl\Query\Filter\FilterInterface;
6+
use RedisVentures\RedisVl\Query\Filter\FilterInterface;
77

88
interface QueryInterface
99
{

0 commit comments

Comments
 (0)