Skip to content

docs: adding field descriptions to predefined text document #1770

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 3 commits into from
Sep 14, 2023
Merged

docs: adding field descriptions to predefined text document #1770

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9a872cd
docs: adding field descriptions to predefined text document
punndcoder28 Sep 1, 2023
f1ab69f
docs: adding field descriptions to predefined text document
punndcoder28 Sep 1, 2023
2ee9c01
docs: remove bytes field example
punndcoder28 Sep 5, 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
Next Next commit
docs: adding field descriptions to predefined text document 
Signed-off-by: punndcoder28 <[email protected]>
  • Loading branch information
@punndcoder28
punndcoder28 committed Sep 14, 2023
commit 9a872cddf177eb6e3b91a0fb26039db29aed9d2f
26 changes: 22 additions & 4 deletions docarray/documents/text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
from typing import Any, Optional, Type, TypeVar, Union

from pydantic import Field

from docarray.base_doc import BaseDoc
from docarray.typing import TextUrl
from docarray.typing.tensor.embedding import AnyEmbedding
Expand Down Expand Up @@ -102,10 +104,26 @@ class MultiModalDoc(BaseDoc):

"""

text: Optional[str] = None
url: Optional[TextUrl] = None
embedding: Optional[AnyEmbedding] = None
bytes_: Optional[bytes] = None
text: Optional[str] = Field(
description='The text content stored in the document',
example='This is an example text content of the document',
)
url: Optional[TextUrl] = Field(
description='''The url of the text content. When text content is too long
to be stored inline or in a file, the remote url can be used to load the
text content''',
example='https://www.w3.org/History/19921103-hypertext/hypertext/README.html',
)
embedding: Optional[AnyEmbedding] = Field(
description='''Embedding field is used to store tensor objects of type
Tensorflow, PyTorch, and NumPy''',
example='''np.zeros((3, 64, 64))''',
)
bytes_: Optional[bytes] = Field(
description='''The bytes of image or video content that can be loaded
into an image or video tensor object''',
example='',
)

def __init__(self, text: Optional[str] = None, **kwargs):
if 'text' not in kwargs:
Expand Down