Skip to main content

LangChain helpers for working with Logseq documents

Project description

Langchain Logseq

Collection of Langchain utilities for working with Logseq files.


Components

This section provides an overview of the components provided, listed by type

Retrievers

Retrievers inject context into a conversation. Works in tandem with a Contextualizer and Document Loader.

  • Input:
    • natural-language user-input, usually query-like
    • (optional) chat history
  • Output:
    • list of Documents to provide context for an LLM to answer the user-input

Implementations

  • LogseqJournalDateRangeRetriever
    • retrieve Logseq journal Documents, intended for queries that require context from a date range
    • required to set up:
      • RetrieverContextualizer
      • LogseqJournalLoader
    • examples:
      • "What did I do over Christmas break 2024?"
      • "How did I spend the last Independence Day?"

Contextualizers

Contextualizers serve as the bridge between natural-language input and a downstream component that handles fetching of relevant Documents.

  • Input:
    • natural-language user-input, usually query-like
    • (optional) chat history
  • Output:
    • structured downstream query, based on

In this library, an instance of RetrieverContextualizer is provided directly to Retrievers during the latter's instantiation. To set up the RetrieverContextualizer, provide RetrieverContextualizerProps, which includes:

  • llm - this is the backbone of the contextualizer
  • prompt - instructions provided to the LLM
  • output_schema - (optional) structured schema used to fetch relevant Documents
    • if no schema is provided, a string shall be returned instead
  • other flags and settings

Loaders

Loaders are one type of component that can fetch relevant Documents. Loaders are typically specific to a corresponding Retriever component.

  • Input:
    • each loader specifies its own schema
      • the Contextualizer is usually responsible for creating an instance of the query obj to act upon
  • Output:
    • list[Document]

Implementations

  • LogseqJournalFilesystemLoader
    • loads from the filesystem, where journal files are expected to be present at specified path

Scripts

PGVector

upload_journal

usage: python scripts/upload_journal_to_pgvector.py [-h] [-p PATH] from_date to_date

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

langchain_logseq-0.2.6.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

langchain_logseq-0.2.6-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

Details for the file langchain_logseq-0.2.6.tar.gz.

File metadata

  • Download URL: langchain_logseq-0.2.6.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for langchain_logseq-0.2.6.tar.gz
Algorithm Hash digest
SHA256 319220c81774943434bd55b2fc99dad6e5dbbaf721a4769f888cb0d68a04360a
MD5 fc4640dfc4441438af3acf3b6b997171
BLAKE2b-256 0d1c60a7b9c53cf04acd5c6d31935f0e8210e0da6b230cc1697bd00861ad8fce

See more details on using hashes here.

File details

Details for the file langchain_logseq-0.2.6-py3-none-any.whl.

File metadata

File hashes

Hashes for langchain_logseq-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 100b5fbe293b19307917e9149456026af5dcbfd017eb3287014370ab879e854a
MD5 5d21da67a5047db6bfd994884440b2a2
BLAKE2b-256 f6ce4bdea70a1871e6d567053f2cce92cd8410c3ecaa11e5d79040f79a70b1a0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page