LangChain.Sources.Pdf 0.13.1-dev.69

🦜️🔗 LangChain .NET

⚡ Building applications with LLMs through composability ⚡
C# implementation of LangChain. We try to be as close to the original as possible in terms of abstractions, but are open to new entities.

While the SemanticKernel is good and we will use it wherever possible, we believe that it has many limitations and based on Microsoft technologies. We proceed from the position of the maximum choice of available options and are open to using third-party libraries within individual implementations.

I want to note:

• I’m unlikely to be able to make serious progress alone, so my goal is to unite the efforts of C# developers to create a C# version of LangChain and control the quality of the final project
• I try to accept any Pull Request within 24 hours (of course, it depends, but I will try)
• I'm also looking for developers to join the core team. I will sponsor them whenever possible and also share any money received.
• I also respond quite quickly on Discord for any questions related to the project

Usage

You can use our wiki to get started: https://github.com/tryAGI/LangChain/wiki
If the wiki contains unupdated code, you can always take a look at the tests for this
Also see examples for example usage or tests.

// Price to run from zero(create embeddings and request to LLM): 0,015$
// Price to re-run if database is exists: 0,0004$
// Dependencies: LangChain, LangChain.Databases.Sqlite, LangChain.Sources.Pdf

// Initialize models
var provider = new OpenAiProvider(
    Environment.GetEnvironmentVariable("OPENAI_API_KEY") ??
    throw new InconclusiveException("OPENAI_API_KEY is not set"));
var llm = new Gpt35TurboModel(provider);
var embeddings = new TextEmbeddingV3SmallModel(provider);

// Create vector database from Harry Potter book pdf
var source = await PdfPigPdfSource.CreateFromUriAsync(new Uri("https://canonburyprimaryschool.co.uk/wp-content/uploads/2016/01/Joanne-K.-Rowling-Harry-Potter-Book-1-Harry-Potter-and-the-Philosophers-Stone-EnglishOnlineClub.com_.pdf"));
var index = await SQLiteVectorStore.GetOrCreateIndexAsync(embeddings, source);

// Now we have two ways: use the async methods or use the chains
// 1. Async methods

// Find similar documents for the question
const string question = "Who was drinking a unicorn blood?";
var similarDocuments = await index.Store.GetSimilarDocuments(question, amount: 5);

// Use similar documents and LLM to answer the question
var answer = await llm.GenerateAsync(
    $"""
     Use the following pieces of context to answer the question at the end.
     If the answer is not in context then just say that you don't know, don't try to make up an answer.
     Keep the answer as short as possible.

     {similarDocuments.AsString()}

     Question: {question}
     Helpful Answer:
     """, cancellationToken: CancellationToken.None).ConfigureAwait(false);

Console.WriteLine($"LLM answer: {answer}"); // The cloaked figure.

// 2. Chains
var promptTemplate =
    @"Use the following pieces of context to answer the question at the end. If the answer is not in context then just say that you don't know, don't try to make up an answer. Keep the answer as short as possible. Always quote the context in your answer.
{context}
Question: {text}
Helpful Answer:";

var chain =
    Set("Who was drinking a unicorn blood?")     // set the question (default key is "text")
    | RetrieveSimilarDocuments(index, amount: 5) // take 5 most similar documents
    | CombineDocuments(outputKey: "context")     // combine documents together and put them into context
    | Template(promptTemplate)                   // replace context and question in the prompt with their values
    | LLM(llm.UseConsoleForDebug());             // send the result to the language model
var chainAnswer = await chain.Run("text");  // get chain result

Console.WriteLine("Chain Answer:"+ chainAnswer);       // print the result
        
Console.WriteLine($"LLM usage: {llm.Usage}");    // Print usage and price
Console.WriteLine($"Embeddings usage: {embeddings.Usage}");   // Print usage and price

Featured projects

• LangChainChat - Allows you to run a chat based on a Blazor project using LangChain.Serve and any of the supported local or paid models

Contributors

<table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://www.upwork.com/freelancers/~017b1ad6f6af9cc189"><img src="https://avatars.githubusercontent.com/u/3002068?v=4?s=100" width="100px;" alt="Konstantin S."/><br />_{<b>Konstantin S.</b>}</a><br /><a href="#infra-HavenDV" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/tryAGI/LangChain/commits?author=HavenDV" title="Tests">⚠️</a> <a href="https://github.com/tryAGI/LangChain/commits?author=HavenDV" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/TesAnti"><img src="https://avatars.githubusercontent.com/u/8780022?v=4?s=100" width="100px;" alt="TesAnti"/><br />_{<b>TesAnti</b>}</a><br /><a href="#infra-TesAnti" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/tryAGI/LangChain/commits?author=TesAnti" title="Tests">⚠️</a> <a href="https://github.com/tryAGI/LangChain/commits?author=TesAnti" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/khoroshevj"><img src="https://avatars.githubusercontent.com/u/13628506?v=4?s=100" width="100px;" alt="Khoroshev Evgeniy"/><br />_{<b>Khoroshev Evgeniy</b>}</a><br /><a href="#infra-khoroshevj" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/tryAGI/LangChain/commits?author=khoroshevj" title="Tests">⚠️</a> <a href="https://github.com/tryAGI/LangChain/commits?author=khoroshevj" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/SiegDuch"><img src="https://avatars.githubusercontent.com/u/104992451?v=4?s=100" width="100px;" alt="SiegDuch"/><br />_{<b>SiegDuch</b>}</a><br /><a href="#infra-SiegDuch" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/gunpal5"><img src="https://avatars.githubusercontent.com/u/10114874?v=4?s=100" width="100px;" alt="gunpal5"/><br />_{<b>gunpal5</b>}</a><br /><a href="#infra-gunpal5" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/tryAGI/LangChain/commits?author=gunpal5" title="Tests">⚠️</a> <a href="https://github.com/tryAGI/LangChain/commits?author=gunpal5" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/kharedev247"><img src="https://avatars.githubusercontent.com/u/72281217?v=4?s=100" width="100px;" alt="Ketan Khare"/><br />_{<b>Ketan Khare</b>}</a><br /><a href="#infra-kharedev247" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/tryAGI/LangChain/commits?author=kharedev247" title="Tests">⚠️</a> <a href="https://github.com/tryAGI/LangChain/commits?author=kharedev247" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="http://rooc.nl"><img src="https://avatars.githubusercontent.com/u/5981147?v=4?s=100" width="100px;" alt="Roderic Bos"/><br />_{<b>Roderic Bos</b>}</a><br /><a href="#infra-IRooc" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/tryAGI/LangChain/commits?author=IRooc" title="Tests">⚠️</a> <a href="https://github.com/tryAGI/LangChain/commits?author=IRooc" title="Code">💻</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/hiptopjones"><img src="https://avatars.githubusercontent.com/u/3208743?v=4?s=100" width="100px;" alt="Peter James"/><br />_{<b>Peter James</b>}</a><br /><a href="#infra-hiptopjones" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/tryAGI/LangChain/commits?author=hiptopjones" title="Tests">⚠️</a> <a href="https://github.com/tryAGI/LangChain/commits?author=hiptopjones" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/curlyfro"><img src="https://avatars.githubusercontent.com/u/127311?v=4?s=100" width="100px;" alt="Ty Augustine"/><br />_{<b>Ty Augustine</b>}</a><br /><a href="#infra-curlyfro" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/tryAGI/LangChain/commits?author=curlyfro" title="Tests">⚠️</a> <a href="https://github.com/tryAGI/LangChain/commits?author=curlyfro" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/ericgreenmix"><img src="https://avatars.githubusercontent.com/u/1297049?v=4?s=100" width="100px;" alt="Eric Green"/><br />_{<b>Eric Green</b>}</a><br /><a href="#infra-ericgreenmix" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/tryAGI/LangChain/commits?author=ericgreenmix" title="Tests">⚠️</a> <a href="https://github.com/tryAGI/LangChain/commits?author=ericgreenmix" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Lyx52"><img src="https://avatars.githubusercontent.com/u/55701905?v=4?s=100" width="100px;" alt="Lyx52"/><br />_<b>Lyx52</b></a><br /><a href="#infra-Lyx52" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/tryAGI/LangChain/commits?author=Lyx52" title="Tests">⚠️</a> <a href="https://github.com/tryAGI/LangChain/commits?author=Lyx52" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/fiorelorenzo"><img src="https://avatars.githubusercontent.com/u/29930922?v=4?s=100" width="100px;" alt="Lorenzo Fiore"/><br />_{<b>Lorenzo Fiore</b>}</a><br /><a href="#infra-fiorelorenzo" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/tryAGI/LangChain/commits?author=fiorelorenzo" title="Tests">⚠️</a> <a href="https://github.com/tryAGI/LangChain/commits?author=fiorelorenzo" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/matt-regier"><img src="https://avatars.githubusercontent.com/u/13575802?v=4?s=100" width="100px;" alt="matt-regier"/><br />_{<b>matt-regier</b>}</a><br /><a href="#infra-matt-regier" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/tryAGI/LangChain/commits?author=matt-regier" title="Tests">⚠️</a> <a href="https://github.com/tryAGI/LangChain/commits?author=matt-regier" title="Code">💻</a></td> </tr> </tbody> </table>

Support

Priority place for bugs: https://github.com/tryAGI/LangChain/issues
Priority place for ideas and general questions: https://github.com/tryAGI/LangChain/discussions
Discord: https://discord.gg/Ca2xhfBf3v

Legal information and credits

It's licensed under the MIT license. We do not plan to change the license in any foreseeable future for this project, but projects based on this within the organization may have different licenses.
Some documentation is based on documentation from dotnet/docs repository under CC BY 4.0 license, where code examples are changed to code examples for using this project.