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.3.0.tar.gz (13.6 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.3.0-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: langchain_logseq-0.3.0.tar.gz
  • Upload date:
  • Size: 13.6 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.3.0.tar.gz
Algorithm Hash digest
SHA256 8227da08b79a924f526c4043eb6fb392fdcac73db507caad6fec626fccb6a002
MD5 a79a03b6d0dfd4bd2c340e3a3ff08e9e
BLAKE2b-256 a6acf5d1b2b27ba6f4b1959e55e1792eeed9ba3caae7dd8d3cd32487db19bf7e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for langchain_logseq-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 09bc6649ea0c7f733e96c3985718464576cffb0bfd15071955a40c83575a5aa8
MD5 cbf464ffcbe20ff685684d8e097d93e0
BLAKE2b-256 c537e145d18f2c1d8dccb9e70bd17ac7830457d278c3e8d9c7f7062f73e4e67b

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