Feedback: Redis as a vector database quick start guide

[zostaw]

Page https://redis.io/docs/latest/develop/get-started/vector-database

Hello, I'm not 100% sure if I'm missing something, but I think the doc has a mistake in python code snippet. It states:

from redis.commands.search.index_definition import IndexDefinition, IndexType

while index_definition doesn't exist, it throws:

ModuleNotFoundError: No module named 'redis.commands.search.index_definition'

I believe the proper command should be:

from redis.commands.search.indexDefinition import IndexDefinition, IndexType

That's what I've found in other examples and that's what worked for me.

I'm running it on Raspberry Pi, my python version is 3.11.2 and redis version 5.2.1

Cheers!

[dwdougherty]

Thanks, @zostaw. I'll take a look.

[dwdougherty]

Hi @zostaw. Your assessment was correct. I've issued a PR to the redis-py repo that will correct this issue.

[zostaw]

Thank you so much!

[dwdougherty]

Hi @zostaw. Closing the loop: my redis-py PR was merged, so the change should show up on redis.io/docs in the next day or two.

[uglide]

@dwdougherty we should pin the version of redis-py to the latest stable instead:

'dev_branch': '5.3'

PS: The name of the attribute is misleading :)

[rhuanbarros-luma]

It still wrong on the tutorial. Really anoying bug to start the day

[dwdougherty]

I'm very sorry, @rhuanbarros-luma! The PR I had merged to fix this was overwritten. I will get that fixed as soon as possible.

[dwdougherty]

Hi @rhuanbarros-luma. There's a new version of redis-py (6.0.0) which fixes this issue. That is, the following will now work:

(venv) $ python
Python 3.13.3 (main, Apr  8 2025, 13:54:08) [Clang 16.0.0 (clang-1600.0.26.6)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import redis
>>> redis.__version__
'6.0.0'
>>> from redis.commands.search.index_definition import IndexDefinition, IndexType
>>>

[rhuanbarros-luma]

Nice!, Thank you for your fast response.

[Silverhorse7]

It still wrong on the tutorial. Really anoying bug to start the day

Its still wrong. https://redis.readthedocs.io/en/stable/examples/search_json_examples.html

For those who are getting ModuleNotFoundError: No module named 'redis.commands.search.index_definition'

changing it to from redis.commands.search.indexDefinition import IndexDefinition, IndexType resolved this issue.