docs: adding field descriptions to predefined text document

punndcoder28 · punndcoder28 · commit 51582e17b36a · 2023-09-01T23:34:23.000+05:30
Signed-off-by: punndcoder28 &lt;puneethk.2899@gmail.com&gt;
diff --git a/docarray/documents/text.py b/docarray/documents/text.py
@@ -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
@@ -102,10 +104,26 @@ class MultiModalDoc(BaseDoc):
 
     """
 
-    text: Optional[str]
-    url: Optional[TextUrl]
-    embedding: Optional[AnyEmbedding]
-    bytes_: Optional[bytes]
+    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:
