https://github.com/googleapis/langchain-google-firestore-python

https://github.com/googleapis/langchain-google-firestore-python

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/googleapis/langchain-google-firestore-python
• Owner: googleapis
• License: apache-2.0
• Created: 2024-01-16T20:49:00.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-07-18T22:56:06.000Z (4 months ago)
• Last Synced: 2024-07-21T15:42:14.151Z (4 months ago)
• Language: Python
• Size: 183 KB
• Stars: 16
• Watchers: 19
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

• jimsghstars - googleapis/langchain-google-firestore-python - (Python)

README

        
Firestore for LangChain

=======================

|preview| |pypi| |versions|

- `Client Library Documentation`_

- `Product Documentation`_

.. |preview| image:: https://img.shields.io/badge/support-preview-orange.svg

   :target: https://cloud.google.com/products#product-launch-stages

.. |pypi| image:: https://img.shields.io/pypi/v/langchain-google-firestore.svg

   :target: https://pypi.org/project/langchain-google-firestore/

.. |versions| image:: https://img.shields.io/pypi/pyversions/langchain-google-firestore.svg

   :target: https://pypi.org/project/langchain-google-firestore/

.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/langchain-google-firestore/latest

.. _Product Documentation: https://cloud.google.com/firestore

Quick Start

-----------

In order to use this library, you first need to go through the following

steps:

1. `Select or create a Cloud Platform project.`_

2. `Enable billing for your project.`_

3. `Enable the Google Cloud Firestore API.`_

4. `Setup Authentication.`_

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project

.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project

.. _Enable the Google Cloud Firestore API.: https://console.cloud.google.com/flows/enableapi?apiid=firestore.googleapis.com

.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation

~~~~~~~~~~~~

Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to create isolated Python environments. The basic problem it addresses is

one of dependencies and versions, and indirectly permissions.

With `virtualenv`_, it’s possible to install this library without needing system install permissions, and without clashing with the installed system dependencies.

.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/

Supported Python Versions

^^^^^^^^^^^^^^^^^^^^^^^^^

Python >= 3.8

Mac/Linux

^^^^^^^^^

.. code-block:: console

   pip install virtualenv

   virtualenv 

   source /bin/activate

   /bin/pip install langchain-google-firestore

Windows

^^^^^^^

.. code-block:: console

   pip install virtualenv

   virtualenv 

   \Scripts\activate

   \Scripts\pip.exe install langchain-google-firestore

Vector Store Usage

~~~~~~~~~~~~~~~~~~~

Use a vector store to store embedded data and perform vector search.

.. code-block:: python

    

    from langchain_google_firestore import FirestoreVectorStore

    from langchain_google_vertexai import VertexAIEmbeddings

    embedding = VertexAIEmbeddings(model_name="textembedding-gecko@003")

    store = FirestoreVectorStore(

        collection="VectorStore",

        embedding=embedding

    )

See the full `Vector Store`_ tutorial.

.. _`Vector Store`: https://github.com/googleapis/langchain-google-firestore-python/blob/main/docs/vectorstores.ipynb

Document Loader Usage

~~~~~~~~~~~~~~~~~~~~~

Use a document loader to load data as LangChain ``Document``\ s.

.. code-block:: python

    from langchain_google_firestore import FirestoreLoader

    loader = FirestoreLoader("Collection")

    docs = loader.lazy_load()

See the full `Document Loader`_ tutorial.

.. _`Document Loader`: https://github.com/googleapis/langchain-google-firestore-python/blob/main/docs/document_loader.ipynb

Chat Message History Usage

--------------------------

Use ``ChatMessageHistory`` to store messages and provide conversation

history to LLMs.

.. code:: python

    

    from langchain_google_firestore import FirestoreChatMessageHistory

    history = FirestoreChatMessageHistory(

        session_id="my-session-id",

        collection="HistoryMessages"

    )

See the full `Chat Message History`_ tutorial.

.. _`Chat Message History`: https://github.com/googleapis/langchain-google-firestore-python/blob/main/docs/chat_message_history.ipynb

Contributions

~~~~~~~~~~~~~

Contributions to this library are always welcome and highly encouraged.

See `CONTRIBUTING`_ for more information how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in

this project you agree to abide by its terms. See `Code of Conduct`_ for more

information.

.. _`CONTRIBUTING`: https://github.com/googleapis/langchain-google-firestore-python/blob/main/CONTRIBUTING.md

.. _`Code of Conduct`: https://github.com/googleapis/langchain-google-firestore-python/blob/main/CODE_OF_CONDUCT.md

License

-------

Apache 2.0 - See

`LICENSE `_

for more information.

Disclaimer

----------

This is not an officially supported Google product.