Go to file
felpigeon a47c8618ec
Add class attribute "return_generated_question" to class "BaseConversationalRetrievalChain" (#5749)
<!--
Thank you for contributing to LangChain! Your PR will appear in our
release under the title you set. Please make sure it highlights your
valuable contribution.

Replace this with a description of the change, the issue it fixes (if
applicable), and relevant context. List any dependencies required for
this change.

After you're done, someone will review your PR. They may suggest
improvements. If no one reviews your PR within a few days, feel free to
@-mention the same people again, as notifications can get lost.

Finally, we'd love to show appreciation for your contribution - if you'd
like us to shout you out on Twitter, please also include your handle!
-->

Adding a class attribute "return_generated_question" to class
"BaseConversationalRetrievalChain". If set to `True`, the chain's output
has a key "generated_question" with the question generated by the
sub-chain `question_generator` as the value. This way the generated
question can be logged.

<!-- If you're adding a new integration, please include:

1. a test for the integration - favor unit tests that does not rely on
network access.
2. an example notebook showing its use


See contribution guidelines for more information on how to write tests,
lint
etc:


https://github.com/hwchase17/langchain/blob/master/.github/CONTRIBUTING.md
-->

#### Who can review?

<!-- For a quicker response, figure out the right person to tag with @

  @hwchase17 - project lead

  Tracing / Callbacks
  - @agola11

  Async
  - @agola11

  DataLoaders
  - @eyurtsev

  Models
  - @hwchase17
  - @agola11

  Agents / Tools / Toolkits
  - @vowelparrot

  VectorStores / Retrievers / Memory
  - @dev2049

 -->
@dev2049 @vowelparrot
2023-06-05 16:10:12 -07:00
.devcontainer Visual Studio Code/Github Codespaces Dev Containers (#4035) (#4122) 2023-05-04 11:37:00 -07:00
.github Rm Template Title (#5616) 2023-06-02 06:54:55 -07:00
docs docs: updated ecosystem/dependents (#5753) 2023-06-05 16:09:55 -07:00
langchain Add class attribute "return_generated_question" to class "BaseConversationalRetrievalChain" (#5749) 2023-06-05 16:10:12 -07:00
tests Create OpenAIWhisperParser for generating Documents from audio files (#5580) 2023-06-05 15:51:13 -07:00
.dockerignore fix: tests with Dockerfile (#2382) 2023-04-04 06:47:19 -07:00
.flake8 change run to use args and kwargs (#367) 2022-12-18 15:54:56 -05:00
.gitignore Es knn index search 5346 (#5569) 2023-06-02 08:40:35 -07:00
.readthedocs.yaml bring back ref (#4308) 2023-05-07 17:32:28 -07:00
CITATION.cff bump version to 0069 (#710) 2023-01-24 00:24:54 -08:00
Dockerfile make ARG POETRY_HOME available in multistage (#3882) 2023-05-01 20:57:41 -07:00
LICENSE add license (#50) 2022-11-01 21:12:02 -07:00
Makefile Block sockets for unit-tests (#4803) 2023-05-16 14:41:24 -04:00
poetry.lock Zep Hybrid Search (#5742) 2023-06-05 12:59:28 -07:00
poetry.toml fix Poetry 1.4.0+ installation (#1935) 2023-03-27 08:27:54 -07:00
pyproject.toml Zep Hybrid Search (#5742) 2023-06-05 12:59:28 -07:00
README.md Added Dependencies Status, Open issues and releases badges in Readme.md (#5681) 2023-06-04 14:30:52 -07:00

🦜🔗 LangChain

Building applications with LLMs through composability

Release Notes lint test linkcheck Downloads License: MIT Twitter Open in Dev Containers Open in GitHub Codespaces GitHub star chart Dependency Status Open Issues

Looking for the JS/TS version? Check out LangChain.js.

Production Support: As you move your LangChains into production, we'd love to offer more comprehensive support. Please fill out this form and we'll set up a dedicated support Slack channel.

Quick Install

pip install langchain or conda install langchain -c conda-forge

🤔 What is this?

Large language models (LLMs) are emerging as a transformative technology, enabling developers to build applications that they previously could not. However, using these LLMs in isolation is often insufficient for creating a truly powerful app - the real power comes when you can combine them with other sources of computation or knowledge.

This library aims to assist in the development of those types of applications. Common examples of these applications include:

Question Answering over specific documents

💬 Chatbots

🤖 Agents

📖 Documentation

Please see here for full documentation on:

  • Getting started (installation, setting up the environment, simple examples)
  • How-To examples (demos, integrations, helper functions)
  • Reference (full API docs)
  • Resources (high-level explanation of core concepts)

🚀 What can this help with?

There are six main areas that LangChain is designed to help with. These are, in increasing order of complexity:

📃 LLMs and Prompts:

This includes prompt management, prompt optimization, a generic interface for all LLMs, and common utilities for working with LLMs.

🔗 Chains:

Chains go beyond a single LLM call and involve sequences of calls (whether to an LLM or a different utility). LangChain provides a standard interface for chains, lots of integrations with other tools, and end-to-end chains for common applications.

📚 Data Augmented Generation:

Data Augmented Generation involves specific types of chains that first interact with an external data source to fetch data for use in the generation step. Examples include summarization of long pieces of text and question/answering over specific data sources.

🤖 Agents:

Agents involve an LLM making decisions about which Actions to take, taking that Action, seeing an Observation, and repeating that until done. LangChain provides a standard interface for agents, a selection of agents to choose from, and examples of end-to-end agents.

🧠 Memory:

Memory refers to persisting state between calls of a chain/agent. LangChain provides a standard interface for memory, a collection of memory implementations, and examples of chains/agents that use memory.

🧐 Evaluation:

[BETA] Generative models are notoriously hard to evaluate with traditional metrics. One new way of evaluating them is using language models themselves to do the evaluation. LangChain provides some prompts/chains for assisting in this.

For more information on these concepts, please see our full documentation.

💁 Contributing

As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.

For detailed information on how to contribute, see here.