Skip to main content

LangChain integrations for Google Cloud Firestore

Project description

preview pypi versions

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.

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.

Supported Python Versions

Python >= 3.8

Mac/Linux

pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install langchain-google-firestore

Windows

pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install langchain-google-firestore

Vector Store Usage

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

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.

Document Loader Usage

Use a document loader to load data as LangChain Documents.

from langchain_google_firestore import FirestoreLoader

loader = FirestoreLoader("Collection")
docs = loader.lazy_load()

See the full Document Loader tutorial.

Chat Message History Usage

Use ChatMessageHistory to store messages and provide conversation history to LLMs.

from langchain_google_firestore import FirestoreChatMessageHistory

history = FirestoreChatMessageHistory(
    session_id="my-session-id",
    collection="HistoryMessages"
)

See the full Chat Message History tutorial.

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.

License

Apache 2.0 - See LICENSE for more information.

Disclaimer

This is not an officially supported Google product.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

langchain_google_firestore-0.4.0-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

Details for the file langchain_google_firestore-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for langchain_google_firestore-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d658ffab869b8871d70e2b59cbc9d19a773fee8a00fb013486a4a6138c0391de
MD5 426e9716ac937aa3abbcbeaaddf62dd9
BLAKE2b-256 665a6f7a99a233edefd8c17b742be232677badd2ec9c0fddf4cf7385c9ed757b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page