langchain-postgres 0.0.13__py3-none-any.whl → 0.0.14rc1__py3-none-any.whl

langchain_postgres/vectorstores.py

@@ -19,6 +19,7 @@ from typing import (
     Type,
     Union,
 )
+import warnings
 from typing import (
     cast as typing_cast,
 )
@@ -48,6 +49,8 @@ from sqlalchemy.orm import (
 
 from langchain_postgres._utils import maximal_marginal_relevance
 
+warnings.simplefilter("once", PendingDeprecationWarning)
+
 
 class DistanceStrategy(str, enum.Enum):
     """Enumerator of the Distance strategies."""
@@ -197,9 +200,7 @@ def _get_embedding_collection_store(vector_dimension: Optional[int] = None) -> A
 
         __tablename__ = "langchain_pg_embedding"
 
-        id = sqlalchemy.Column(
-            sqlalchemy.String, nullable=True, primary_key=True, index=True, unique=True
-        )
+        id = sqlalchemy.Column(sqlalchemy.String, primary_key=True)
 
         collection_id = sqlalchemy.Column(
             UUID(as_uuid=True),
@@ -269,7 +270,6 @@ class PGVector(VectorStore):
     Instantiate:
         .. code-block:: python
 
-            from langchain_postgres import PGVector
             from langchain_postgres.vectorstores import PGVector
             from langchain_openai import OpenAIEmbeddings
 
@@ -429,6 +429,13 @@ class PGVector(VectorStore):
         self._async_engine: Optional[AsyncEngine] = None
         self._async_init = False
 
+        warnings.warn(
+            "PGVector is being deprecated and will be removed in the future. "
+            "Please migrate to PGVectorStore. "
+            "Refer to the migration guide at [https://github.com/langchain-ai/langchain-postgres/blob/main/examples/migrate_pgvector_to_pgvectorstore.md] for details.",
+            PendingDeprecationWarning,
+        )
+
         if isinstance(connection, str):
             if async_mode:
                 self._async_engine = create_async_engine(

langchain_postgres-0.0.14rc1.dist-info/METADATA

@@ -0,0 +1,170 @@
+Metadata-Version: 2.1
+Name: langchain-postgres
+Version: 0.0.14rc1
+Summary: An integration package connecting Postgres and LangChain
+Home-page: https://github.com/langchain-ai/langchain-postgres
+License: MIT
+Requires-Python: >=3.9,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: asyncpg (>=0.30.0,<0.31.0)
+Requires-Dist: langchain-core (>=0.2.13,<0.4.0)
+Requires-Dist: numpy (>=1.21,<2.0)
+Requires-Dist: pgvector (>=0.2.5,<0.4)
+Requires-Dist: psycopg (>=3,<4)
+Requires-Dist: psycopg-pool (>=3.2.1,<4.0.0)
+Requires-Dist: sqlalchemy (>=2,<3)
+Project-URL: Repository, https://github.com/langchain-ai/langchain-postgres
+Project-URL: Source Code, https://github.com/langchain-ai/langchain-postgres/tree/master/langchain_postgres
+Description-Content-Type: text/markdown
+
+# langchain-postgres
+
+[![Release Notes](https://img.shields.io/github/release/langchain-ai/langchain-postgres)](https://github.com/langchain-ai/langchain-postgres/releases)
+[![CI](https://github.com/langchain-ai/langchain-postgres/actions/workflows/ci.yml/badge.svg)](https://github.com/langchain-ai/langchain-postgres/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchainai.svg?style=social&label=Follow%20%40LangChainAI)](https://twitter.com/langchainai)
+[![](https://dcbadge.vercel.app/api/server/6adMQxSpJS?compact=true&style=flat)](https://discord.gg/6adMQxSpJS)
+[![Open Issues](https://img.shields.io/github/issues-raw/langchain-ai/langchain-postgres)](https://github.com/langchain-ai/langchain-postgres/issues)
+
+The `langchain-postgres` package implementations of core LangChain abstractions using `Postgres`.
+
+The package is released under the MIT license.
+
+Feel free to use the abstraction as provided or else modify them / extend them as appropriate for your own application.
+
+## Requirements
+
+The package supports the [asyncpg](https://github.com/MagicStack/asyncpg) and [psycogp3](https://www.psycopg.org/psycopg3/) drivers.
+
+## Installation
+
+```bash
+pip install -U langchain-postgres
+```
+
+## Usage
+
+### Vectorstore
+
+> [!WARNING]
+> In v0.0.14+, `PGVector` is deprecated. Please migrate to `PGVectorStore`
+> Version 0.0.14+ has not been released yet, but you can test version of the vectorstore on the main branch. Until official release do not use in production.
+> for improved performance and manageability.
+> See the [migration guide](https://github.com/langchain-ai/langchain-postgres/blob/main/examples/migrate_pgvector_to_pgvectorstore.md) for details on how to migrate from `PGVector` to `PGVectorStore`.
+
+For a detailed example on `PGVectorStore` see [here](https://github.com/langchain-ai/langchain-postgres/blob/main/examples/pg_vectorstore.ipynb).
+
+```python
+from langchain_core.documents import Document
+from langchain_core.embeddings import DeterministicFakeEmbedding
+from langchain_postgres import PGEngine, PGVectorStore
+
+# Replace the connection string with your own Postgres connection string
+CONNECTION_STRING = "postgresql+psycopg3://langchain:langchain@localhost:6024/langchain"
+engine = PGEngine.from_connection_string(url=CONNECTION_STRING)
+
+# Replace the vector size with your own vector size
+VECTOR_SIZE = 768
+embedding = DeterministicFakeEmbedding(size=VECTOR_SIZE)
+
+TABLE_NAME = "my_doc_collection"
+
+engine.init_vectorstore_table(
+    table_name=TABLE_NAME,
+    vector_size=VECTOR_SIZE,
+)
+
+store = PGVectorStore.create_sync(
+    engine=engine,
+    table_name=TABLE_NAME,
+    embedding_service=embedding,
+)
+
+docs = [
+    Document(page_content="Apples and oranges"),
+    Document(page_content="Cars and airplanes"),
+    Document(page_content="Train")
+]
+
+store.add_documents(docs)
+
+query = "I'd like a fruit."
+docs = store.similarity_search(query)
+print(docs)
+```
+
+> [!TIP]
+> All synchronous functions have corresponding asynchronous functions
+
+### ChatMessageHistory
+
+The chat message history abstraction helps to persist chat message history
+in a postgres table.
+
+PostgresChatMessageHistory is parameterized using a `table_name` and a `session_id`.
+
+The `table_name` is the name of the table in the database where
+the chat messages will be stored.
+
+The `session_id` is a unique identifier for the chat session. It can be assigned
+by the caller using `uuid.uuid4()`.
+
+```python
+import uuid
+
+from langchain_core.messages import SystemMessage, AIMessage, HumanMessage
+from langchain_postgres import PostgresChatMessageHistory
+import psycopg
+
+# Establish a synchronous connection to the database
+# (or use psycopg.AsyncConnection for async)
+conn_info = ... # Fill in with your connection info
+sync_connection = psycopg.connect(conn_info)
+
+# Create the table schema (only needs to be done once)
+table_name = "chat_history"
+PostgresChatMessageHistory.create_tables(sync_connection, table_name)
+
+session_id = str(uuid.uuid4())
+
+# Initialize the chat history manager
+chat_history = PostgresChatMessageHistory(
+    table_name,
+    session_id,
+    sync_connection=sync_connection
+)
+
+# Add messages to the chat history
+chat_history.add_messages([
+    SystemMessage(content="Meow"),
+    AIMessage(content="woof"),
+    HumanMessage(content="bark"),
+])
+
+print(chat_history.messages)
+```
+
+## Google Cloud Integrations
+
+[Google Cloud](https://python.langchain.com/docs/integrations/providers/google/) provides Vector Store, Chat Message History, and Data Loader integrations for [AlloyDB](https://cloud.google.com/alloydb) and [Cloud SQL](https://cloud.google.com/sql) for PostgreSQL databases via the following PyPi packages:
+
+* [`langchain-google-alloydb-pg`](https://github.com/googleapis/langchain-google-alloydb-pg-python)
+
+* [`langchain-google-cloud-sql-pg`](https://github.com/googleapis/langchain-google-cloud-sql-pg-python)
+
+Using the Google Cloud integrations provides the following benefits:
+
+- **Enhanced Security**: Securely 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.
+- **Simplified and Secure Connections:** Connect to Google Cloud databases effortlessly using the instance name instead of complex connection strings. The integrations creates a secure connection pool that can be easily shared across your application using the `engine` object.
+
+| Vector Store             | Metadata filtering | Async support  | Schema Flexibility | Improved metadata handling | Hybrid Search |
+|--------------------------|--------------------|----------------|--------------------|----------------------------|---------------|
+| Google AlloyDB           |          ✓         |        ✓       |         ✓          |             ✓              |       ✗       |
+| Google Cloud SQL Postgres|          ✓         |        ✓       |         ✓          |             ✓              |       ✗       |
+
+

langchain_postgres-0.0.14rc1.dist-info/RECORD

@@ -0,0 +1,16 @@
+langchain_postgres/__init__.py,sha256=UxIanyWPeUVtWFKCT-sWGXbWUO5I76akABXhXolY9bM,702
+langchain_postgres/_utils.py,sha256=N_OBzYFCb_bsHOnZ-YRg6izhmuudorQhupgeG-rSKUc,2848
+langchain_postgres/chat_message_histories.py,sha256=Et5AgXSRBCghLC5sn6EEUDd1xupaiPv-A5IyNBjpaTc,14213
+langchain_postgres/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+langchain_postgres/translator.py,sha256=6cTS2RJUodMUdsurJM-f-vgPXl6Ad6bfMo8ECuh5Jr4,1524
+langchain_postgres/utils/pgvector_migrator.py,sha256=OIclFsCKWQAtJ1JyFQsVQoWZSrEJg67GVnY84aBlucE,11776
+langchain_postgres/v2/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+langchain_postgres/v2/async_vectorstore.py,sha256=FMV-IwH7cJ2VuxnrMCy0X0WWG65oHNXfKAwsdf0Tp20,51786
+langchain_postgres/v2/engine.py,sha256=8XD6ta2HzuYtHnxhvY-I_vMYqZd33yj2y9ZqQFbEz1g,14266
+langchain_postgres/v2/indexes.py,sha256=aLCFGYiIbLBUr88drMLD6l41MPRI7lv0ALMVRWfqdq4,4888
+langchain_postgres/v2/vectorstores.py,sha256=R17q1KIEZPBwEHgE6JYiRSiN8rZXzVPCmBoJobiyjM8,37198
+langchain_postgres/vectorstores.py,sha256=Xjyqxa_nL7Xvq6dwqWUu4VdNZ5z6ypjFoSU9wj6Ad5c,84195
+langchain_postgres-0.0.14rc1.dist-info/LICENSE,sha256=2btS8uNUDWD_UNjw9ba6ZJt_00aUjEw9CGyK-xIHY8c,1072
+langchain_postgres-0.0.14rc1.dist-info/METADATA,sha256=ZOG0qTuKUt4_uz2VUAy4Cj4A-DtsfouNBB6ITk7bihk,7179
+langchain_postgres-0.0.14rc1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+langchain_postgres-0.0.14rc1.dist-info/RECORD,,

langchain_postgres-0.0.13.dist-info/METADATA

@@ -1,109 +0,0 @@
-Metadata-Version: 2.1
-Name: langchain-postgres
-Version: 0.0.13
-Summary: An integration package connecting Postgres and LangChain
-Home-page: https://github.com/langchain-ai/langchain-postgres
-License: MIT
-Requires-Python: >=3.9,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: langchain-core (>=0.2.13,<0.4.0)
-Requires-Dist: numpy (>=1.21)
-Requires-Dist: pgvector (<0.4)
-Requires-Dist: psycopg (>=3,<4)
-Requires-Dist: psycopg-pool (>=3.2.1,<4.0.0)
-Requires-Dist: sqlalchemy (>=2,<3)
-Project-URL: Repository, https://github.com/langchain-ai/langchain-postgres
-Project-URL: Source Code, https://github.com/langchain-ai/langchain-postgres/tree/master/langchain_postgres
-Description-Content-Type: text/markdown
-
-# langchain-postgres
-
-[![Release Notes](https://img.shields.io/github/release/langchain-ai/langchain-postgres)](https://github.com/langchain-ai/langchain-postgres/releases)
-[![CI](https://github.com/langchain-ai/langchain-postgres/actions/workflows/ci.yml/badge.svg)](https://github.com/langchain-ai/langchain-postgres/actions/workflows/ci.yml)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchainai.svg?style=social&label=Follow%20%40LangChainAI)](https://twitter.com/langchainai)
-[![](https://dcbadge.vercel.app/api/server/6adMQxSpJS?compact=true&style=flat)](https://discord.gg/6adMQxSpJS)
-[![Open Issues](https://img.shields.io/github/issues-raw/langchain-ai/langchain-postgres)](https://github.com/langchain-ai/langchain-postgres/issues)
-
-The `langchain-postgres` package implementations of core LangChain abstractions using `Postgres`.
-
-The package is released under the MIT license. 
-
-Feel free to use the abstraction as provided or else modify them / extend them as appropriate for your own application.
-
-## Requirements
-
-The package currently only supports the [psycogp3](https://www.psycopg.org/psycopg3/) driver.
-
-## Installation
-
-```bash
-pip install -U langchain-postgres
-```
-
-## Change Log
-
-0.0.6: 
-- Remove langgraph as a dependency as it was causing dependency conflicts.
-- Base interface for checkpointer changed in langgraph, so existing implementation would've broken regardless.
-
-## Usage
-
-### ChatMessageHistory
-
-The chat message history abstraction helps to persist chat message history 
-in a postgres table.
-
-PostgresChatMessageHistory is parameterized using a `table_name` and a `session_id`.
-
-The `table_name` is the name of the table in the database where 
-the chat messages will be stored.
-
-The `session_id` is a unique identifier for the chat session. It can be assigned
-by the caller using `uuid.uuid4()`.
-
-```python
-import uuid
-
-from langchain_core.messages import SystemMessage, AIMessage, HumanMessage
-from langchain_postgres import PostgresChatMessageHistory
-import psycopg
-
-# Establish a synchronous connection to the database
-# (or use psycopg.AsyncConnection for async)
-conn_info = ... # Fill in with your connection info
-sync_connection = psycopg.connect(conn_info)
-
-# Create the table schema (only needs to be done once)
-table_name = "chat_history"
-PostgresChatMessageHistory.create_tables(sync_connection, table_name)
-
-session_id = str(uuid.uuid4())
-
-# Initialize the chat history manager
-chat_history = PostgresChatMessageHistory(
-    table_name,
-    session_id,
-    sync_connection=sync_connection
-)
-
-# Add messages to the chat history
-chat_history.add_messages([
-    SystemMessage(content="Meow"),
-    AIMessage(content="woof"),
-    HumanMessage(content="bark"),
-])
-
-print(chat_history.messages)
-```
-
-
-### Vectorstore
-
-See example for the [PGVector vectorstore here](https://github.com/langchain-ai/langchain-postgres/blob/main/examples/vectorstore.ipynb)
-

langchain_postgres-0.0.13.dist-info/RECORD

@@ -1,10 +0,0 @@
-langchain_postgres/__init__.py,sha256=iH8JoksQ4c_36xRmbi9WoYzfBRETTH8r8PPDD_wrRt8,502
-langchain_postgres/_utils.py,sha256=N_OBzYFCb_bsHOnZ-YRg6izhmuudorQhupgeG-rSKUc,2848
-langchain_postgres/chat_message_histories.py,sha256=gh6hjBlrJ5GSo5kePQdh3VhiUYoWWdP37GXtZ1e25a4,14033
-langchain_postgres/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-langchain_postgres/translator.py,sha256=6cTS2RJUodMUdsurJM-f-vgPXl6Ad6bfMo8ECuh5Jr4,1524
-langchain_postgres/vectorstores.py,sha256=Z2nPxj6234pgUtTfVYEAs2lON840Ugw9YuOjjpiJcc4,83866
-langchain_postgres-0.0.13.dist-info/LICENSE,sha256=2btS8uNUDWD_UNjw9ba6ZJt_00aUjEw9CGyK-xIHY8c,1072
-langchain_postgres-0.0.13.dist-info/METADATA,sha256=SfDySVkYDRUVfIU83ogMil0ezXT8JBYATGWgilsWUqY,4008
-langchain_postgres-0.0.13.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-langchain_postgres-0.0.13.dist-info/RECORD,,