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 all commits
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
25 changes: 21 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,25 @@ 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',
default=None,
)
url: Optional[TextUrl] = Field(
description='URL to a (potentially remote) text file that can be loaded',
example='https://www.w3.org/History/19921103-hypertext/hypertext/README.html',
default=None,
)
embedding: Optional[AnyEmbedding] = Field(
description='Store an embedding: a vector representation of the text',
example=[1, 0, 1],
default=None,
)
bytes_: Optional[bytes] = Field(
description='Bytes representation of the text',
default=None,
)

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