Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

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

Changes from 1 commit
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
Prev Previous commit
Next Next commit
feat: add example and description to ID of BaseDoc 
Signed-off-by: Joan Fontanals Martinez <[email protected]>
  • Loading branch information
Joan Fontanals Martinez committed Jul 31, 2023
commit 3f4e86fbdab2ad556c1b0d2820a9f8789923768b
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()), example=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