This repository was archived by the owner on Sep 9, 2026. It is now read-only.
Repository navigation
This repository was archived by the owner on Sep 9, 2026. It is now read-only.
json method not working correctly with DocVec #1490
Description
Description:
The json method doesn't work correctly when using DocVec. The json output for a field containing a DocVec instance returns null.
Steps to reproduce:
Using the following code with a custom class and DocList:
from docarray import DocVec, BaseDoc, DocList
from docarray.documents.image import ImageDoc
class CustomClass(BaseDoc):
images: DocList[ImageDoc]
images = DocList[ImageDoc]([ImageDoc(url=f'http://url.com/{i}.png') for i in range(10)])
custom_instance = CustomClass(images=images)
custom_instance.json()Output:
'{"id":"05094c8c7045d988c58791da43f79584","images":[{"id":"c7cb6d04ddda6d5f6299959fcae6241a","url":"http://url.com/0.png","tensor":null,"embedding":null,"bytes_":null},{"id":"1175d1988e1173b5217dd148dca705f7","url":"http://url.com/1.png","tensor":null,"embedding":null,"bytes_":null},{...}]}'
Using the following code with a custom class and DocVec:
from docarray import DocVec, BaseDoc, DocList
from docarray.documents.image import ImageDoc
class CustomClass(BaseDoc):
images: DocVec[ImageDoc]
images = DocVec[ImageDoc]([ImageDoc(url=f'http://url.com/{i}.png') for i in range(10)])
custom_instance = CustomClass(images=images)
custom_instance.json()Output:
'{"id":"2f040340fa6ad9dbc10d394609251afa","images":null}'
Expected behavior:
The json method should return the correct output when using DocVec with any custom class, similar to how it works with DocList.
Activity
JoanFM commentedon May 5, 2023
Note:
on
main, the first part raises a ValueError:samsja commentedon May 5, 2023
Hey @movchan74 so far we don't support
to_jsonon DocVec which is why the nested DocVec cannot be serialized with json. Once we supportto_jsonon DocVec we will make sure that the nested support is working and therefore fix the bug that you see.JoanFM commentedon May 10, 2023
Closing in favor of #1330