diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index f3b29a86..533bc1d4 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -31,7 +31,7 @@ jobs: steps: - name: Checkout Repository - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4 + uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4 - name: Setup Python uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0 diff --git a/.kokoro/release.sh b/.kokoro/release.sh index bf07994c..515049fe 100755 --- a/.kokoro/release.sh +++ b/.kokoro/release.sh @@ -23,7 +23,7 @@ python3 -m releasetool publish-reporter-script > /tmp/publisher-script; source / export PYTHONUNBUFFERED=1 # Move into the package, build the distribution and upload. -TWINE_PASSWORD=$(cat "${KOKORO_KEYSTORE_DIR}/73713_google-cloud-pypi-token-keystore-2") +TWINE_PASSWORD=$(cat "${KOKORO_KEYSTORE_DIR}/73713_google-cloud-pypi-token-keystore-3") cd github/langchain-google-cloud-sql-pg-python python3 -m build --wheel twine upload --username __token__ --password "${TWINE_PASSWORD}" dist/* diff --git a/.kokoro/release/common.cfg b/.kokoro/release/common.cfg index 623c99af..cff064fd 100644 --- a/.kokoro/release/common.cfg +++ b/.kokoro/release/common.cfg @@ -28,7 +28,7 @@ before_action { fetch_keystore { keystore_resource { keystore_config_id: 73713 - keyname: "google-cloud-pypi-token-keystore-2" + keyname: "google-cloud-pypi-token-keystore-3" } } } diff --git a/CHANGELOG.md b/CHANGELOG.md index 9d7bd57a..d75d9a9e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## [0.11.1](https://github.com/googleapis/langchain-google-cloud-sql-pg-python/compare/v0.11.0...v0.11.1) (2024-11-15) + + +### Documentation + +* Add benefits to readme ([#224](https://github.com/googleapis/langchain-google-cloud-sql-pg-python/issues/224)) ([f791be0](https://github.com/googleapis/langchain-google-cloud-sql-pg-python/commit/f791be05ea32a0da473562a63f43dcd18c00d399)) +* Adding a readme to itemise sample notebooks. ([#225](https://github.com/googleapis/langchain-google-cloud-sql-pg-python/issues/225)) ([4ce8be3](https://github.com/googleapis/langchain-google-cloud-sql-pg-python/commit/4ce8be3d43c5d0825859f21352131a71a62105af)) + ## [0.11.0](https://github.com/googleapis/langchain-google-cloud-sql-pg-python/compare/v0.10.0...v0.11.0) (2024-10-04) diff --git a/README.rst b/README.rst index dc45371c..9f76d6b5 100644 --- a/README.rst +++ b/README.rst @@ -6,6 +6,14 @@ Cloud SQL for PostgreSQL for LangChain - `Client Library Documentation`_ - `Product Documentation`_ +The **Cloud SQL for PostgreSQL for LangChain** package provides a first class experience for connecting to +Cloud SQL instances from the LangChain ecosystem while providing the following benefits: + +- **Simplified & Secure Connections**: easily and securely create shared connection pools to connect to Google Cloud databases utilizing IAM for authorization and database authentication without needing to manage SSL certificates, configure firewall rules, or enable authorized networks. +- **Improved performance & Simplified management**: use a single-table schema can lead to faster query execution, especially for large collections. +- **Improved metadata handling**: store metadata in columns instead of JSON, resulting in significant performance improvements. +- **Clear separation**: clearly separate table and extension creation, allowing for distinct permissions and streamlined workflows. + .. |preview| image:: https://img.shields.io/badge/support-preview-orange.svg :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels .. |pypi| image:: https://img.shields.io/pypi/v/langchain-google-cloud-sql-pg.svg diff --git a/pyproject.toml b/pyproject.toml index dacb49f3..ce86aa38 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -44,7 +44,7 @@ test = [ "mypy==1.11.2", "pytest-asyncio==0.24.0", "pytest==8.3.3", - "pytest-cov==5.0.0" + "pytest-cov==6.0.0" ] [build-system] diff --git a/samples/README.md b/samples/README.md new file mode 100644 index 00000000..7239fbd5 --- /dev/null +++ b/samples/README.md @@ -0,0 +1,15 @@ +# Cloud SQL for PostgreSQL for LangChain Resources + +This directory provides code samples to help you get started with LangChain and Cloud SQL for PostgreSQL. + +## Guides & Samples + +| Sample | Description | +| ------ | ----------- | +| [Langchain Quick Start](./langchain_quick_start.ipynb) | This codelab demonstrates how to create a powerful interactive GenAI application using Retrieval Augmented Generation (RAG) powered by [CloudSQLfor PostgreSQL](https://cloud.google.com/sql/docs/postgres) and [LangChain](https://www.langchain.com/). | +| [Get Started: `PostgresVectorStore`](../docs/vector_store.ipynb) | This notebook goes over how to use Cloud SQL for PostgreSQL to store vector embeddings with the `PostgresVectorStore` class. | +| [Get Started: `PostgresLoader`](../docs/document_loader.ipynb) | This notebook goes over how to use Cloud SQL for PostgreSQL to load Documents with the `PostgresLoader` class. | +| [Get Started: `PostgresChatMessageHistory`](../docs/chat_message_history.ipynb) | This notebook goes over how to use Cloud SQL for PostgreSQL to store chat message history with the `PostgresChatMessageHistory` class. | +| [How to Choose a Nearest-Neighbor Index Guide](../docs/how_to_choose_an_index_guide.md) | This guide outlines different indexing strategies for approximate nearest neighbor (ANN) search. | +| [Index Tuning Sample](./index_tuning_sample) | This guide demonstrates how to fine-tune your LangChain PostgreSQL index for better vector similarity search results. | +| [Langchain on VertexAI](./langchain_on_vertexai) | This guide explains how to build and deploy LangChain apps to a managed Reasoning Engine runtime using LangChain on Vertex AI. | diff --git a/src/langchain_google_cloud_sql_pg/version.py b/src/langchain_google_cloud_sql_pg/version.py index 185281d4..d946cfe3 100644 --- a/src/langchain_google_cloud_sql_pg/version.py +++ b/src/langchain_google_cloud_sql_pg/version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "0.11.0" +__version__ = "0.11.1"