langchain/.gitignore

.vs/
.vscode/
.idea/
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# Google GitHub Actions credentials files created by:
# https://github.com/google-github-actions/auth
#
# That action recommends adding this gitignore to prevent accidentally committing keys.
gha-creds-*.json

# PyInstaller
#  Usually these files are written by a python script from a template
#  before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/
docs/docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints
notebooks/

# IPython
profile_default/
ipython_config.py

# pyenv
.python-version

# pipenv
#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
#   However, in case of collaboration, if having platform-specific dependencies or dependencies
#   having no cross-platform support, pipenv may install dependencies that don't work, or not
#   install all needed dependencies.
#Pipfile.lock

# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.envrc
.venv*
venv*
env/
ENV/
env.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# macOS display setting files
.DS_Store

# Wandb directory
wandb/

# asdf tool versions
.tool-versions
/.ruff_cache/

*.pkl
*.bin

# integration test artifacts
data_map*
\[('_type', 'fake'), ('stop', None)]

# Replit files
*replit*

node_modules
docs/.yarn/
docs/node_modules/
docs/.docusaurus/
docs/.cache-loader/
docs/_dist
docs/api_reference/*api_reference.rst
docs/api_reference/_build
docs/api_reference/*/
!docs/api_reference/_static/
!docs/api_reference/templates/
!docs/api_reference/themes/
docs/docs/build
docs/docs/node_modules
docs/docs/yarn.lock
_dist
docs/docs/templates

prof
Harrison/relevancy score (#3907) Co-authored-by: Ryan Grippeling <R.Grippeling@hotmail.com> Co-authored-by: Ryan <ryan@webgrip.nl> Co-authored-by: Zander Chase <130414180+vowelparrot@users.noreply.github.com> 1 year ago			`.vs/`
Fix pip install issue due to FAISS (#102) - change requirements.txt to fix Issue #101 - update .gitignore to support VSCode dev environment 2 years ago			`.vscode/`
add .idea files to gitignore, add zsh note to installation docs (#329) 1 year ago			`.idea/`
initial commit 2 years ago			`# Byte-compiled / optimized / DLL files`
			`__pycache__/`
			`*.py[cod]`
			`*$py.class`

			`# C extensions`
			`*.so`

			`# Distribution / packaging`
			`.Python`
			`build/`
			`develop-eggs/`
			`dist/`
			`downloads/`
			`eggs/`
			`.eggs/`
			`lib/`
			`lib64/`
			`parts/`
			`sdist/`
			`var/`
			`wheels/`
			`pip-wheel-metadata/`
			`share/python-wheels/`
			`*.egg-info/`
			`.installed.cfg`
			`*.egg`
			`MANIFEST`

Add Google GitHub Action creds file to gitignore. (#11296) Should resolve the issue here: https://github.com/langchain-ai/langchain/actions/runs/6342767671/job/17229204508#step:7:36 After this merges, we can revert https://github.com/langchain-ai/langchain/pull/11192 7 months ago			`# Google GitHub Actions credentials files created by:`
			`# https://github.com/google-github-actions/auth`
			`#`
			`# That action recommends adding this gitignore to prevent accidentally committing keys.`
			`gha-creds-*.json`

initial commit 2 years ago			`# PyInstaller`
			`# Usually these files are written by a python script from a template`
			`# before PyInstaller builds the exe, so as to inject date/other infos into it.`
			`*.manifest`
			`*.spec`

			`# Installer logs`
			`pip-log.txt`
			`pip-delete-this-directory.txt`

			`# Unit test / coverage reports`
			`htmlcov/`
			`.tox/`
			`.nox/`
			`.coverage`
			`.coverage.*`
			`.cache`
			`nosetests.xml`
			`coverage.xml`
			`*.cover`
			`*.py,cover`
			`.hypothesis/`
			`.pytest_cache/`

			`# Translations`
			`*.mo`
			`*.pot`

			`# Django stuff:`
			`*.log`
			`local_settings.py`
			`db.sqlite3`
			`db.sqlite3-journal`

			`# Flask stuff:`
			`instance/`
			`.webassets-cache`

			`# Scrapy stuff:`
			`.scrapy`

			`# Sphinx documentation`
			`docs/_build/`
Doc refactor (#6300) Co-authored-by: jacoblee93 <jacoblee93@gmail.com> Co-authored-by: Harrison Chase <hw.chase.17@gmail.com> 11 months ago			`docs/docs/_build/`
initial commit 2 years ago
			`# PyBuilder`
			`target/`

			`# Jupyter Notebook`
			`.ipynb_checkpoints`
			`notebooks/`

			`# IPython`
			`profile_default/`
			`ipython_config.py`

			`# pyenv`
			`.python-version`

			`# pipenv`
			`# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.`
			`# However, in case of collaboration, if having platform-specific dependencies or dependencies`
			`# having no cross-platform support, pipenv may install dependencies that don't work, or not`
			`# install all needed dependencies.`
			`#Pipfile.lock`

			`# PEP 582; used by e.g. github.com/David-OConnor/pyflow`
			`__pypackages__/`

			`# Celery stuff`
			`celerybeat-schedule`
			`celerybeat.pid`

			`# SageMath parsed files`
			`*.sage.py`

			`# Environments`
			`.env`
Allow the regular openai class to be used for ChatGPT models (#1393) Co-authored-by: Harrison Chase <hw.chase.17@gmail.com> 1 year ago			`.envrc`
airbyte[patch]: init pkg (#18236) 3 months ago			`.venv*`
Add docstrings for Clickhouse class methods (#19195) Thank you for contributing to LangChain! - [ ] PR title: "package: description" - Where "package" is whichever of langchain, community, core, experimental, etc. is being modified. Use "docs: ..." for purely docs changes, "templates: ..." for template changes, "infra: ..." for CI changes. - Example: "community: add foobar LLM" - [ ] PR message: *Delete this entire checklist* and replace with - Description: a description of the change - Issue: the issue # it fixes, if applicable - Dependencies: any dependencies required for this change - Twitter handle: if your PR gets announced, and you'd like a mention, we'll gladly shout you out! - [ ] Add tests and docs: If you're adding a new integration, please include 1. a test for the integration, preferably unit tests that do not rely on network access, 2. an example notebook showing its use. It lives in `docs/docs/integrations` directory. - [x] Lint and test: Run `make format`, `make lint` and `make test` from the root of the package(s) you've modified. See contribution guidelines for more: https://python.langchain.com/docs/contributing/ Additional guidelines: - Make sure optional dependencies are imported within a function. - Please do not add dependencies to pyproject.toml files (even optional ones) unless they are required for unit tests. - Most PRs should not touch more than one package. - Changes should be backwards compatible. - If you are adding something to community, do not re-import it in langchain. If no one reviews your PR within a few days, please @-mention one of baskaryan, efriis, eyurtsev, hwchase17. 2 months ago			`venv*`
initial commit 2 years ago			`env/`
			`ENV/`
			`env.bak/`

			`# Spyder project settings`
			`.spyderproject`
			`.spyproject`

			`# Rope project settings`
			`.ropeproject`

			`# mkdocs documentation`
			`/site`

			`# mypy`
			`.mypy_cache/`
			`.dmypy.json`
			`dmypy.json`

			`# Pyre type checker`
			`.pyre/`
Add macOS .DS_Store to .gitignore (#401) These are macOS specific files left around in directories (to save user's display settings) 1 year ago
			`# macOS display setting files`
			`.DS_Store`
Zapier Integration (#1654) * Zapier Wrapper and Tools (implemented by Zapier Team) * Zapier Toolkit, examples with mrkl agent --------- Co-authored-by: Mike Knoop <mikeknoop@gmail.com> Co-authored-by: Robert Lewis <robert.lewis@zapier.com> 1 year ago
Harrison/wandb (#1764) Co-authored-by: Anish Shah <93145909+ash0ts@users.noreply.github.com> 1 year ago			`# Wandb directory`
			`wandb/`

Zapier Integration (#1654) * Zapier Wrapper and Tools (implemented by Zapier Team) * Zapier Toolkit, examples with mrkl agent --------- Co-authored-by: Mike Knoop <mikeknoop@gmail.com> Co-authored-by: Robert Lewis <robert.lewis@zapier.com> 1 year ago			`# asdf tool versions`
Harrison/wandb (#1764) Co-authored-by: Anish Shah <93145909+ash0ts@users.noreply.github.com> 1 year ago			`.tool-versions`
fix: elasticsearch (#2402) - Create a new docker-compose file to start an Elasticsearch instance for integration tests. - Add new tests to `test_elasticsearch.py` to verify Elasticsearch functionality. - Include an optional group `test_integration` in the `pyproject.toml` file. This group should contain dependencies for integration tests and can be installed using the command `poetry install --with test_integration`. Any new dependencies should be added by running `poetry add some_new_deps --group "test_integration" ` Note: New tests running in live mode, which involve end-to-end testing of the OpenAI API. In the future, adding `pytest-vcr` to record and replay all API requests would be a nice feature for testing process.More info: https://pytest-vcr.readthedocs.io/en/latest/ Fixes https://github.com/hwchase17/langchain/issues/2386 1 year ago			`/.ruff_cache/`
Fix notebook example (#3142) The following calls were throwing an exception: https://github.com/hwchase17/langchain/blob/575b717d108984676e25afd0910ccccfdaf9693d/docs/use_cases/evaluation/agent_vectordb_sota_pg.ipynb?short_path=4b3386c#L192 https://github.com/hwchase17/langchain/blob/575b717d108984676e25afd0910ccccfdaf9693d/docs/use_cases/evaluation/agent_vectordb_sota_pg.ipynb?short_path=4b3386c#L239 Exception: ``` --------------------------------------------------------------------------- ValidationError Traceback (most recent call last) Cell In[14], line 1 ----> 1 chain_sota = RetrievalQA.from_chain_type(llm=OpenAI(temperature=0), chain_type="stuff", retriever=vectorstore_sota, input_key="question") File ~/github/langchain/venv/lib/python3.9/site-packages/langchain/chains/retrieval_qa/base.py:89, in BaseRetrievalQA.from_chain_type(cls, llm, chain_type, chain_type_kwargs, kwargs) 85 _chain_type_kwargs = chain_type_kwargs or {} 86 combine_documents_chain = load_qa_chain( 87 llm, chain_type=chain_type, _chain_type_kwargs 88 ) ---> 89 return cls(combine_documents_chain=combine_documents_chain, *kwargs) File ~/github/langchain/venv/lib/python3.9/site-packages/pydantic/main.py:341, in pydantic.main.BaseModel.__init__() ValidationError: 1 validation error for RetrievalQA retriever instance of BaseRetriever expected (type=type_error.arbitrary_type; expected_arbitrary_type=BaseRetriever) ``` The vectorstores had to be converted to retrievers: `vectorstore_sota.as_retriever()` and `vectorstore_pg.as_retriever()`. The PR also: - adds the file `paul_graham_essay.txt` referenced by this notebook - adds to gitignore .pkl and *.bin files that are generated by this notebook Interestingly enough, the performance of the prediction greatly increased (new version of langchain or ne version of OpenAI models since the last run of the notebook): from 19/33 correct to 28/33 correct! 1 year ago
			`*.pkl`
Allow clearing cache and fix gptcache (#3493) This PR * Adds `clear` method for `BaseCache` and implements it for various caches * Adds the default `init_func=None` and fixes gptcache integtest * Since right now integtest is not running in CI, I've verified the changes by running `docs/modules/models/llms/examples/llm_caching.ipynb` (until proper e2e integtest is done in CI) 1 year ago			`*.bin`

			`# integration test artifacts`
			`data_map*`
Es knn index search 5346 (#5569) # Create elastic_vector_search.ElasticKnnSearch class This extends `langchain/vectorstores/elastic_vector_search.py` by adding a new class `ElasticKnnSearch` Features: - Allow creating an index with the `dense_vector` mapping compataible with kNN search - Store embeddings in index for use with kNN search (correct mapping creates HNSW data structure) - Perform approximate kNN search - Perform hybrid BM25 (`query{}`) + kNN (`knn{}`) search - perform knn search by either providing a `query_vector` or passing a hosted `model_id` to use query_vector_builder to automatically generate a query_vector at search time Connection options - Using `cloud_id` from Elastic Cloud - Passing elasticsearch client object search options - query - k - query_vector - model_id - size - source - knn_boost (hybrid search) - query_boost (hybrid search) - fields This also adds examples to `docs/modules/indexes/vectorstores/examples/elasticsearch.ipynb` Fixes # [5346](https://github.com/hwchase17/langchain/issues/5346) cc: @dev2049 --> --------- Co-authored-by: Dev 2049 <dev.dev2049@gmail.com> 12 months ago			`\[('_type', 'fake'), ('stop', None)]`

			`# Replit files`
Doc refactor (#6300) Co-authored-by: jacoblee93 <jacoblee93@gmail.com> Co-authored-by: Harrison Chase <hw.chase.17@gmail.com> 11 months ago			`replit`

			`node_modules`
			`docs/.yarn/`
			`docs/node_modules/`
			`docs/.docusaurus/`
			`docs/.cache-loader/`
			`docs/_dist`
API Reference building script update (#13587) The namespaces like `langchain.agents.format_scratchpad` clogging the API Reference sidebar. This change removes those 3-level namespaces from sidebar (this issue was discussed with @efriis ) --------- Co-authored-by: Erick Friis <erick@langchain.dev> 5 months ago			`docs/api_reference/*api_reference.rst`
Doc refactor (#6300) Co-authored-by: jacoblee93 <jacoblee93@gmail.com> Co-authored-by: Harrison Chase <hw.chase.17@gmail.com> 11 months ago			`docs/api_reference/_build`
Fix `make docs_build` and related scripts (#7276) Description: a description of the change Fixed `make docs_build` and related scripts which caused errors. There are several changes. First, I made the build of the documentation and the API Reference into two separate commands. This is because it takes less time to build. The commands for documents are `make docs_build`, `make docs_clean`, and `make docs_linkcheck`. The commands for API Reference are `make api_docs_build`, `api_docs_clean`, and `api_docs_linkcheck`. It looked like `docs/.local_build.sh` could be used to build the documentation, so I used that. Since `.local_build.sh` was also building API Rerefence internally, I removed that process. `.local_build.sh` also added some Bash options to stop in error or so. Futher more added `cd "${SCRIPT_DIR}"` at the beginning so that the script will work no matter which directory it is executed in. `docs/api_reference/api_reference.rst` is removed, because which is generated by `docs/api_reference/create_api_rst.py`, and added it to .gitignore. Finally, the description of CONTRIBUTING.md was modified. Issue: the issue # it fixes (if applicable) https://github.com/hwchase17/langchain/issues/6413 Dependencies: any dependencies required for this change `nbdoc` was missing in group docs so it was added. I installed it with the `poetry add --group docs nbdoc` command. I am concerned if any modifications are needed to poetry.lock. I would greatly appreciate it if you could pay close attention to this file during the review. Tag maintainer - General / Misc / if you don't know who to tag: @baskaryan If this PR needs any additional changes, I'll be happy to make them! --------- Co-authored-by: Bagatur <baskaryan@gmail.com> 10 months ago			`docs/api_reference/*/`
			`!docs/api_reference/_static/`
			`!docs/api_reference/templates/`
			`!docs/api_reference/themes/`
Restructure docs (#11620) 7 months ago			`docs/docs/build`
			`docs/docs/node_modules`
			`docs/docs/yarn.lock`
Add LCEL to LLM intro (#11835) 7 months ago			`_dist`
Cache calls to create_model for get_input_schema and get_output_schema (#17755) Thank you for contributing to LangChain! - [ ] PR title: "package: description" - Where "package" is whichever of langchain, community, core, experimental, etc. is being modified. Use "docs: ..." for purely docs changes, "templates: ..." for template changes, "infra: ..." for CI changes. - Example: "community: add foobar LLM" - [ ] PR message: *Delete this entire checklist* and replace with - Description: a description of the change - Issue: the issue # it fixes, if applicable - Dependencies: any dependencies required for this change - Twitter handle: if your PR gets announced, and you'd like a mention, we'll gladly shout you out! - [ ] Add tests and docs: If you're adding a new integration, please include 1. a test for the integration, preferably unit tests that do not rely on network access, 2. an example notebook showing its use. It lives in `docs/docs/integrations` directory. - [ ] Lint and test: Run `make format`, `make lint` and `make test` from the root of the package(s) you've modified. See contribution guidelines for more: https://python.langchain.com/docs/contributing/ Additional guidelines: - Make sure optional dependencies are imported within a function. - Please do not add dependencies to pyproject.toml files (even optional ones) unless they are required for unit tests. - Most PRs should not touch more than one package. - Changes should be backwards compatible. - If you are adding something to community, do not re-import it in langchain. If no one reviews your PR within a few days, please @-mention one of baskaryan, efriis, eyurtsev, hwchase17. 3 months ago			`docs/docs/templates`

			`prof`