3fi"ddlmZddlmZddlmZmZddlmZddl m Z eedGdd Z d Z ed e d e e fd Zed e d ee ee fd dfdZed e d ee ee fd e fdZy))Iterable) dataclass)LiteralUnion)beta)DocumentT)frozenceZdZUdZeed< eded< eed< edededdfdZedededdfdZ edededdfd Z y ) LinkaRA link to/from a tag of a given kind. Documents in a :class:`graph vector store ` are connected via "links". Links form a bipartite graph between documents and tags: documents are connected to tags, and tags are connected to other documents. When documents are retrieved from a graph vector store, a pair of documents are connected with a depth of one if both documents are connected to the same tag. Links have a ``kind`` property, used to namespace different tag identifiers. For example a link to a keyword might use kind ``kw``, while a link to a URL might use kind ``url``. This allows the same tag value to be used in different contexts without causing name collisions. Links are directed. The directionality of links controls how the graph is traversed at retrieval time. For example, given documents ``A`` and ``B``, connected by links to tag ``T``: +----------+----------+---------------------------------+ | A to T | B to T | Result | +==========+==========+=================================+ | outgoing | incoming | Retrieval traverses from A to B | +----------+----------+---------------------------------+ | incoming | incoming | No traversal from A to B | +----------+----------+---------------------------------+ | outgoing | incoming | No traversal from A to B | +----------+----------+---------------------------------+ | bidir | incoming | Retrieval traverses from A to B | +----------+----------+---------------------------------+ | bidir | outgoing | No traversal from A to B | +----------+----------+---------------------------------+ | outgoing | bidir | Retrieval traverses from A to B | +----------+----------+---------------------------------+ | incoming | bidir | No traversal from A to B | +----------+----------+---------------------------------+ Directed links make it possible to describe relationships such as term references / definitions: term definitions are generally relevant to any documents that use the term, but the full set of documents using a term generally aren't relevant to the term's definition. .. seealso:: - :mod:`How to use a graph vector store ` - :class:`How to link Documents on hyperlinks in HTML ` - :class:`How to link Documents on common keywords (using KeyBERT) ` - :class:`How to link Documents on common named entities (using GliNER) ` How to add links to a Document ============================== How to create links ------------------- You can create links using the Link class's constructors :meth:`incoming`, :meth:`outgoing`, and :meth:`bidir`:: from langchain_community.graph_vectorstores.links import Link print(Link.bidir(kind="location", tag="Paris")) .. code-block:: output Link(kind='location', direction='bidir', tag='Paris') Extending documents with links ------------------------------ Now that we know how to create links, let's associate them with some documents. These edges will strengthen the connection between documents that share a keyword when using a graph vector store to retrieve documents. First, we'll load some text and chunk it into smaller pieces. Then we'll add a link to each document to link them all together:: from langchain_community.document_loaders import TextLoader from langchain_community.graph_vectorstores.links import add_links from langchain_text_splitters import CharacterTextSplitter loader = TextLoader("state_of_the_union.txt") raw_documents = loader.load() text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=0) documents = text_splitter.split_documents(raw_documents) for doc in documents: add_links(doc, Link.bidir(kind="genre", tag="oratory")) print(documents[0].metadata) .. code-block:: output {'source': 'state_of_the_union.txt', 'links': [Link(kind='genre', direction='bidir', tag='oratory')]} As we can see, each document's metadata now includes a bidirectional link to the genre ``oratory``. The documents can then be added to a graph vector store:: from langchain_community.graph_vectorstores import CassandraGraphVectorStore graph_vectorstore = CassandraGraphVectorStore.from_documents( documents=documents, embeddings=... ) kind)inoutbidir directiontagreturnct|d|S)zpCreate an incoming link. Args: kind: the link kind. tag: the link tag. r r rrr r rs j/var/www/auto_recruiter/arenv/lib/python3.12/site-packages/langchain_community/graph_vectorstores/links.pyincomingz Link.incomings377ct|d|S)zpCreate an outgoing link. Args: kind: the link kind. tag: the link tag. rrrrs routgoingz Link.outgoingsC88rct|d|S)ztCreate a bidirectional link. Args: kind: the link kind. tag: the link tag. rrrrs rrz Link.bidirsc::rN) __name__ __module__ __qualname____doc__str__annotations__r staticmethodrrrrrr r sjX IW+,,$ H8s88889s9999;C;c;f;;rr linksdocrc|jjtg}t|tst |}||jt<|S)zGet the links from a document. Args: doc: The document to get the link tags from. Returns: The set of link tags from the document. )metadata setdefaultMETADATA_LINKS_KEY isinstancelist)r&r%s r get_linksr-sB LL # #$6 ;E eT "U +0 '( LrNct|}|D]5}t|tr|j|%|j |7y)zAdd links to the given metadata. Args: doc: The document to add the links to. *links: The links to add to the document. N)r-r+rextendappend)r&r%links_in_metadatalinks r add_linksr3sC"#+ dH %  $ $T *  $ $T * +rctt|}|D]5}t|tr|j |%|j |7t |ji|jtt|iS)zReturn a document with the given links added. Args: doc: The document to add the links to. *links: The links to add to the document. Returns: A document with a shallow-copy of the metadata with the links added. ) page_contentr() setr-r+rupdateaddrr5r(r*r,)r&r% new_linksr2s rcopy_with_linksr:s|IcN#I  dH %   T " MM$   %% ll Y  r)collections.abcr dataclassesrtypingrrlangchain_core._apirlangchain_core.documentsrr r*r,r-r3r:r$rrr@s$!!$- $Q;Q;Q;h8T " +8 +U4$+?%@ +T + +5x~1E+F8r