docs: adding field descriptions to predefined mesh 3D document

punndcoder28 · punndcoder28 · commit 251f27833ed7 · 2023-09-15T21:38:31.000+05:30
Signed-off-by: punndcoder28 &lt;puneethk.2899@gmail.com&gt;
diff --git a/docarray/documents/mesh/mesh_3d.py b/docarray/documents/mesh/mesh_3d.py
@@ -5,6 +5,8 @@
 from docarray.typing.tensor.embedding import AnyEmbedding
 from docarray.typing.url.url_3d.mesh_url import Mesh3DUrl
 
+from pydantic import Field
+
 T = TypeVar('T', bound='Mesh3D')
 
 
@@ -103,10 +105,24 @@ class MultiModalDoc(BaseDoc):
 
     """
 
-    url: Optional[Mesh3DUrl] = None
-    tensors: Optional[VerticesAndFaces] = None
-    embedding: Optional[AnyEmbedding] = None
-    bytes_: Optional[bytes] = None
+    url: Optional[Mesh3DUrl] = Field(
+        description='URL to a file containing 3D mesh information. Can be remote (web) URL, or a local file path.',
+        example='https://people.sc.fsu.edu/~jburkardt/data/obj/al.obj',
+        default=None,
+    )
+    tensors: Optional[VerticesAndFaces] = Field(
+        description='A tensor object of 3D mesh of type `VerticesAndFaces`.',
+        example=[[0, 1, 1], [1, 0, 1], [1, 1, 0]],
+        default=None,
+    )
+    embedding: Optional[AnyEmbedding] = Field(
+        description='Store an embedding: a vector representation of the 3D mesh.',
+        default=[[1, 0, 1], [0, 1, 1], [1, 1, 0]],
+    )
+    bytes_: Optional[bytes] = Field(
+        description='Bytes representation of 3D mesh.',
+        default=None,
+    )
 
     @classmethod
     def validate(
