Skip to content
This repository was archived by the owner on Sep 9, 2026. It is now read-only.

feat: add description and example to ID field of BaseDoc #1737

Merged
JoanFM merged 4 commits into from
Aug 1, 2023
Merged

feat: add description and example to ID field of BaseDoc #1737

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c2616fa
feat: add example to ID of BaseDoc
Jul 31, 2023
3f4e86f
feat: add example and description to ID of BaseDoc
Jul 31, 2023
46bcf5a
fix: fix the hnswlib tests
Jul 31, 2023
c1b4aa5
fix: fix elastic v7 test
Aug 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docarray/base_doc/doc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,11 @@ class MyDoc(BaseDoc):
https://docs.pydantic.dev/usage/models/) and can be used in a similar way.
"""

id: Optional[ID] = Field(default_factory=lambda: ID(os.urandom(16).hex()))
id: Optional[ID] = Field(
description='The ID of the BaseDoc. This is useful for indexing in vector stores. If not set by user, it will automatically be assigned a random value',
default_factory=lambda: ID(os.urandom(16).hex()),
example=os.urandom(16).hex(),
)

class Config:
json_loads = orjson.loads
Expand Down