Document

Document

Bases: BaseModel

The basic class for the document.

Attributes:

Name	Type	Description
id	str	Unique identifier for the document.
text	Optional[str]	The content of the document.
metadata	Dict[str, Any]	Metadata associated with the document.
embedding	List[float]	Embedding data associated with the document

Source code in agentuniverse/agent/action/knowledge/store/document.py

Python

class Document(BaseModel):
    """The basic class for the document.

    Attributes:
        id (str): Unique identifier for the document.
        text (Optional[str]): The content of the document.
        metadata (Dict[str, Any]): Metadata associated with the document.
        embedding (List[float]): Embedding data associated with the document
    """

    id: str = None
    text: Optional[str] = ""
    metadata: Optional[Dict[str, Any]] = None
    embedding: List[float] = Field(default_factory=list)

    @model_validator(mode='before')
    def create_id(cls, values):
        text: str = values.get('text', '')
        if not values.get('id'):
            values['id'] = str(uuid.uuid5(uuid.NAMESPACE_URL, text))
        return values

    def as_langchain(self) -> LCDocument:
        """Convert to LangChain document format."""
        metadata = self.metadata or {}
        return LCDocument(page_content=self.text, metadata=metadata)

    @staticmethod
    def as_langchain_list(document_list) -> List[LCDocument]:
        """Convert agentUniverse(aU) document list to langchain document list """
        langchain_document_list = []
        if document_list is None:
            return langchain_document_list
        for document in document_list:
            langchain_document_list.append(LCDocument(page_content=document.text, metadata=document.metadata))
        return langchain_document_list

    @staticmethod
    def from_langchain_list(lc_document_list: List[LCDocument]):
        """Convert langchain document list to agentUniverse(aU) document list """
        document_list = []
        if lc_document_list is None:
            return document_list
        for lc_document in lc_document_list:
            document_list.append(Document(text=lc_document.page_content, metadata=lc_document.metadata))
        return document_list

as_langchain()

Convert to LangChain document format.

Source code in agentuniverse/agent/action/knowledge/store/document.py

Python

def as_langchain(self) -> LCDocument:
    """Convert to LangChain document format."""
    metadata = self.metadata or {}
    return LCDocument(page_content=self.text, metadata=metadata)

as_langchain_list(document_list) staticmethod

Convert agentUniverse(aU) document list to langchain document list

Source code in agentuniverse/agent/action/knowledge/store/document.py

Python

@staticmethod
def as_langchain_list(document_list) -> List[LCDocument]:
    """Convert agentUniverse(aU) document list to langchain document list """
    langchain_document_list = []
    if document_list is None:
        return langchain_document_list
    for document in document_list:
        langchain_document_list.append(LCDocument(page_content=document.text, metadata=document.metadata))
    return langchain_document_list

from_langchain_list(lc_document_list) staticmethod

Convert langchain document list to agentUniverse(aU) document list

Source code in agentuniverse/agent/action/knowledge/store/document.py

Python

@staticmethod
def from_langchain_list(lc_document_list: List[LCDocument]):
    """Convert langchain document list to agentUniverse(aU) document list """
    document_list = []
    if lc_document_list is None:
        return document_list
    for lc_document in lc_document_list:
        document_list.append(Document(text=lc_document.page_content, metadata=lc_document.metadata))
    return document_list