Skip to content

refactor: set fields for pre-defined text doc #823

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
samsja merged 2 commits into from
Nov 23, 2022
Merged

refactor: set fields for pre-defined text doc #823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b54dd32
refactor: set fields for pre-defined text doc
JohannesMessner Nov 21, 2022
3a2d6b9
Merge branch 'feat-rewrite-v2' into refactor-text-doc
JohannesMessner Nov 23, 2022
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
6 changes: 3 additions & 3 deletions docarray/predefined_document/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class Image(BaseDocument):
image = Image(url='http://www.jina.ai/image.jpg')
image.tensor = image.url.load()
model = MyEmbeddingModel()
image.embedding = MyEmbeddingModel(image.tensor)
image.embedding = model(image.tensor)

You can extend this Document:

Expand All @@ -40,8 +40,8 @@ class MyImage(Image):
image = MyImage(url='http://www.jina.ai/image.jpg')
image.tensor = image.url.load()
model = MyEmbeddingModel()
image.embedding = MyEmbeddingModel(image.tensor)
image.second_embedding = MyEmbeddingModel(image.tensor)
image.embedding = model(image.tensor)
image.second_embedding = model(image.tensor)


You can use this Document for composition:
Expand Down
65 changes: 60 additions & 5 deletions docarray/predefined_document/text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,69 @@
from typing import Optional

from docarray.document import BaseDocument
from docarray.typing.tensor.embedding import Embedding, Tensor
from docarray.typing import TextUrl
from docarray.typing.tensor.embedding import Embedding


class Text(BaseDocument):
"""
base Document for Text handling
Document for handling text.
It can contain a TextUrl (`Text.url`), a str (`Text.text`),
and an Embedding (`Text.embedding`).

EXAMPLE USAGE:

You can use this Document directly:

.. code-block:: python

from docarray import Text

# use it directly
txt_doc = Text(url='http://www.jina.ai/')
txt_doc.text = txt_doc.url.load()
model = MyEmbeddingModel()
txt_doc.embedding = model(txt_doc.text)

You can extend this Document:

.. code-block:: python

from docarray import Text
from docarray.typing import Embedding
from typing import Optional

# extend it
class MyText(Text):
second_embedding: Optional[Embedding]


txt_doc = MyText(url='http://www.jina.ai/')
txt_doc.text = txt_doc.url.load()
model = MyEmbeddingModel()
txt_doc.embedding = model(txt_doc.text)
txt_doc.second_embedding = model(txt_doc.text)


You can use this Document for composition:

.. code-block:: python

from docarray import Document, Image, Text

# compose it
class MultiModalDoc(Document):
image_doc: Image
text_doc: Text


mmdoc = MultiModalDoc(
image_doc=Image(url="http://www.jina.ai/image.jpg"),
text_doc=Text(text="hello world, how are you doing?"),
)
mmdoc.text_doc.text = mmdoc.text_doc.url.load()
"""

text: str = ''
tensor: Optional[Tensor]
embedding: Optional[Embedding]
text: Optional[str] = None
url: Optional[TextUrl] = None
embedding: Optional[Embedding] = None