class documentation

This is a class representing a document. Attributes: title (str): The title of the document. links (list[str]): A list of URLs or references to where the document can be accessed. tags (list[str]): A list of tags to which the document belongs. pictures (list[str]): A list of image URLs or paths to pictures of the document. notes (list[str]): The list of note_title names if any. content (str): The text content of the document. Methods: from_text(raw: str) -> Document: Creates a new Document object from text input. from_json(raw: str) -> Document: Creates a new Document object from JSON input. catalog_entry -> dict: Returns a short dict representation as it is stored in the catalog. json -> str: Returns the JSON representation of the document as it is used in the REST API. text -> str: Returns the text representation of the document as it is store in the database.

Class Method from_json Undocumented
Class Method from_text Undocumented
Method __init__ Undocumented
Instance Variable content Undocumented
Instance Variable metadatas Undocumented
Instance Variable title Undocumented
Property catalog_entry Undocumented
Property dict Undocumented
Property text Undocumented
@classmethod
def from_json(cls, raw_content: str) -> Document:

Undocumented

@classmethod
def from_text(cls, title: str, raw_content: str) -> Document:

Undocumented

def __init__(self, title=None, content=None, metadatas={}):

Undocumented

content =

Undocumented

metadatas =

Undocumented

title =

Undocumented

@property
catalog_entry: dict =

Undocumented

@property
dict: dict =

Undocumented

@property
text: str =

Undocumented