Skip to content

Commit 6e80337

Browse files
committed
docs: remove bytes field example
Signed-off-by: punndcoder28 <[email protected]>
1 parent f1ab69f commit 6e80337

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

docarray/documents/text.py

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -107,22 +107,21 @@ class MultiModalDoc(BaseDoc):
107107
text: Optional[str] = Field(
108108
description='The text content stored in the document',
109109
example='This is an example text content of the document',
110+
default=None,
110111
)
111112
url: Optional[TextUrl] = Field(
112-
description='''The url of the text content. When text content is too long
113-
to be stored inline or in a file, the remote url can be used to load the
114-
text content''',
113+
description='URL to a (potentially remote) text file that can be loaded',
115114
example='https://www.w3.org/History/19921103-hypertext/hypertext/README.html',
115+
default=None,
116116
)
117117
embedding: Optional[AnyEmbedding] = Field(
118-
description='''Embedding field is used to store tensor objects of type
119-
Tensorflow, PyTorch, and NumPy''',
120-
example='''np.zeros((3, 32, 32))''',
118+
description='Store an embedding: a vector representation of the text',
119+
example='[1, 0, 1]',
120+
default=None,
121121
)
122122
bytes_: Optional[bytes] = Field(
123-
description='''The bytes of image or video content that can be loaded
124-
into an image or video tensor object''',
125-
example='',
123+
description='Bytes representation of the text',
124+
default=None,
126125
)
127126

128127
def __init__(self, text: Optional[str] = None, **kwargs):

0 commit comments

Comments
 (0)