diff --git a/reference/packages.yml b/reference/packages.yml index bf761946b..5f442641d 100644 --- a/reference/packages.yml +++ b/reference/packages.yml @@ -34,38 +34,38 @@ packages: integration: false repo: langchain-ai/langchain path: libs/cli - downloads: 68000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 75000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-core integration: false repo: langchain-ai/langchain path: libs/core - downloads: 65000000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 69000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-classic integration: false repo: langchain-ai/langchain path: libs/langchain - downloads: 102000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 2000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain integration: false repo: langchain-ai/langchain path: libs/langchain_v1 - downloads: 76000000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 86000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-tests integration: false repo: langchain-ai/langchain path: libs/standard-tests - downloads: 353000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 329000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-text-splitters integration: false repo: langchain-ai/langchain path: libs/text-splitters - downloads: 27000000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 29000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" # monorepo partners (alphabetical by path) - name: langchain-anthropic @@ -74,195 +74,195 @@ packages: repo: langchain-ai/langchain path: libs/partners/anthropic js: "@langchain/anthropic" - downloads: 5000000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 7000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-chroma highlight: true repo: langchain-ai/langchain path: libs/partners/chroma js: "@langchain/community" - downloads: 925000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 1000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-deepseek highlight: true repo: langchain-ai/langchain path: libs/partners/deepseek js: "@langchain/deepseek" - downloads: 356000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 384000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-exa repo: langchain-ai/langchain path: libs/partners/exa provider_page: exa_search js: "@langchain/exa" - downloads: 18000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 19000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-fireworks highlight: true repo: langchain-ai/langchain path: libs/partners/fireworks js: "@langchain/community" - downloads: 458000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 806000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-groq highlight: true repo: langchain-ai/langchain path: libs/partners/groq js: "@langchain/groq" - downloads: 1000000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 2000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-huggingface highlight: true repo: langchain-ai/langchain path: libs/partners/huggingface js: "@langchain/community" - downloads: 925000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 1000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-mistralai highlight: true repo: langchain-ai/langchain path: libs/partners/mistralai js: "@langchain/mistralai" - downloads: 580000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 626000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-nomic repo: langchain-ai/langchain path: libs/partners/nomic js: "@langchain/nomic" - downloads: 25000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 27000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-ollama highlight: true repo: langchain-ai/langchain path: libs/partners/ollama js: "@langchain/ollama" - downloads: 1000000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 2000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-openai highlight: true repo: langchain-ai/langchain path: libs/partners/openai js: "@langchain/openai" - downloads: 27000000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 32000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-perplexity highlight: true repo: langchain-ai/langchain path: libs/partners/perplexity js: "@langchain/community" - downloads: 414000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 459000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-prompty repo: langchain-ai/langchain path: libs/partners/prompty provider_page: microsoft downloads: 4000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-qdrant highlight: true repo: langchain-ai/langchain path: libs/partners/qdrant js: "@langchain/qdrant" - downloads: 285000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 360000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-xai name_title: xAI (Grok) highlight: true repo: langchain-ai/langchain path: libs/partners/xai js: "@langchain/xai" - downloads: 113000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 138000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" # internal langchain-ai org repos (alphabetical by path) - name: langchain-community integration: false repo: langchain-ai/langchain-community path: libs/community - downloads: 30000000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 34000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-experimental integration: false repo: langchain-ai/langchain-experimental path: libs/experimental - downloads: 2000000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 3000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-mcp-adapters integration: false repo: langchain-ai/langchain-mcp-adapters - downloads: 989000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 1000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" # external langchain-ai org repos (alphabetical by path) - name: langchain-ai21 repo: langchain-ai/langchain-ai21 path: libs/ai21 downloads: 2000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-aws name_title: AWS highlight: true repo: langchain-ai/langchain-aws path: libs/aws js: "@langchain/aws" - downloads: 6000000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 7000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-azure-ai highlight: true repo: langchain-ai/langchain-azure path: libs/azure-ai provider_page: azure_ai js: "@langchain/openai" - downloads: 79000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 112000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-azure-dynamic-sessions repo: langchain-ai/langchain-azure path: libs/azure-dynamic-sessions provider_page: microsoft js: "@langchain/azure-dynamic-sessions" - downloads: 31000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 36000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-sqlserver repo: langchain-ai/langchain-azure path: libs/sqlserver provider_page: microsoft downloads: 1000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-cerebras repo: langchain-ai/langchain-cerebras path: libs/cerebras js: "@langchain/cerebras" - downloads: 44000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 47000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-cohere highlight: true repo: langchain-ai/langchain-cohere path: libs/cohere js: "@langchain/cohere" - downloads: 797000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 940000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-astradb name_title: DataStax Astra DB highlight: true repo: langchain-ai/langchain-datastax path: libs/astradb js: "@langchain/community" - downloads: 138000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 139000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-elasticsearch highlight: true repo: langchain-ai/langchain-elastic path: libs/elasticsearch js: "@langchain/community" - downloads: 238000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 272000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-google-community name_title: Google (Community) repo: langchain-ai/langchain-google path: libs/community provider_page: google - downloads: 6000000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 7000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-google-genai name_title: Google (GenAI) highlight: true @@ -270,8 +270,8 @@ packages: path: libs/genai provider_page: google js: "@langchain/google-genai" - downloads: 5000000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 6000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-google-vertexai name_title: Google (Vertex AI) highlight: true @@ -279,488 +279,488 @@ packages: path: libs/vertexai provider_page: google js: "@langchain/google-vertexai" - downloads: 25000000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 27000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-ibm name_title: IBM highlight: true repo: langchain-ai/langchain-ibm path: libs/ibm js: "@langchain/ibm" - downloads: 397000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 494000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-db2 repo: langchain-ai/langchain-ibm path: libs/langchain-db2 provider_page: ibm - downloads: 2000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 3000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-milvus highlight: true repo: langchain-ai/langchain-milvus path: libs/milvus js: "@langchain/community" - downloads: 307000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 345000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-mongodb highlight: true repo: langchain-ai/langchain-mongodb path: libs/langchain-mongodb provider_page: mongodb_atlas js: "@langchain/mongodb" - downloads: 401000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 431000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-neo4j repo: langchain-ai/langchain-neo4j path: libs/neo4j js: "@langchain/community" - downloads: 102000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 114000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-nvidia-ai-endpoints highlight: true repo: langchain-ai/langchain-nvidia path: libs/ai-endpoints provider_page: nvidia - downloads: 307000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 427000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-pinecone highlight: true repo: langchain-ai/langchain-pinecone path: libs/pinecone js: "@langchain/pinecone" - downloads: 596000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 1000000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-postgres highlight: true repo: langchain-ai/langchain-postgres provider_page: pgvector js: "@langchain/community" - downloads: 743000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 837000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-redis highlight: true repo: langchain-ai/langchain-redis path: libs/redis js: "@langchain/redis" - downloads: 89000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 129000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-sema4 repo: langchain-ai/langchain-sema4 path: libs/sema4 provider_page: robocorp - downloads: 197 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 150 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-snowflake repo: langchain-ai/langchain-snowflake path: libs/snowflake - downloads: 1000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 3000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-together highlight: true repo: langchain-ai/langchain-together path: libs/together js: "@langchain/community" - downloads: 139000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 162000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-unstructured repo: langchain-ai/langchain-unstructured path: libs/unstructured js: "@langchain/community" - downloads: 194000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 208000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-upstage repo: langchain-ai/langchain-upstage path: libs/upstage - downloads: 31000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 52000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-weaviate repo: langchain-ai/langchain-weaviate path: libs/weaviate js: "@langchain/weaviate" - downloads: 52000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 59000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" # external repos (not organized) - name: langchain-aimlapi repo: D1m7asis/langchain-aimlapi path: libs/aimlapi - downloads: 292 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 661 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: databricks-langchain name_title: Databricks highlight: true repo: databricks/databricks-ai-bridge path: integrations/langchain js: "@langchain/community" - downloads: 440000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 526000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-couchbase repo: Couchbase-Ecosystem/langchain-couchbase downloads: 2000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-box repo: box-community/langchain-box path: libs/box - downloads: 841 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 827 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-linkup repo: LinkupPlatform/langchain-linkup - downloads: 8000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 13000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-oceanbase repo: oceanbase/langchain-oceanbase - downloads: 208 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 229 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-predictionguard repo: predictionguard/langchain-predictionguard downloads: 3000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-cratedb repo: crate/langchain-cratedb - downloads: 314 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 162 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-modelscope repo: modelscope/langchain-modelscope - downloads: 235 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 100 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-falkordb repo: kingtroga/langchain-falkordb - downloads: 65 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 82 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-dappier repo: DappierAI/langchain-dappier - downloads: 137 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 146 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-pull-md repo: chigwell/langchain-pull-md - downloads: 115 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 98 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-kuzu repo: kuzudb/langchain-kuzu - downloads: 620 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 610 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-docling repo: DS4SD/docling-langchain - downloads: 40000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 44000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-lindorm-integration name_title: Lindorm repo: AlwaysBluer/langchain-lindorm-integration provider_page: lindorm - downloads: 36 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 33 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-hyperbrowser repo: hyperbrowserai/langchain-hyperbrowser - downloads: 3000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 4000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-fmp-data repo: MehdiZare/langchain-fmp-data - downloads: 102 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 123 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: tilores-langchain name_title: Tilores repo: tilotech/tilores-langchain - downloads: 491 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 228 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-pipeshift repo: pipeshift-org/langchain-pipeshift - downloads: 61 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 55 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-sambanova repo: sambanova/langchain-sambanova - downloads: 96000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 98000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-jenkins repo: Amitgb14/langchain_jenkins - downloads: 451 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 282 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-goodfire repo: keenanpepper/langchain-goodfire - downloads: 149 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 144 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-nimble repo: Nimbleway/langchain-nimble - downloads: 139 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 134 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-apify repo: apify/langchain-apify - downloads: 7000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 9000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langfair name_title: LangFair repo: cvs-health/langfair downloads: 1000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-abso repo: lunary-ai/langchain-abso - downloads: 107 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 108 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-graph-retriever name_title: Graph RAG repo: datastax/graph-rag path: packages/langchain-graph-retriever provider_page: graph_rag - downloads: 103000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 104000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-salesforce repo: colesmcintosh/langchain-salesforce - downloads: 2000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 3000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-discord-shikenso name_title: Discord (Shikenso) repo: Shikenso-Analytics/langchain-discord - downloads: 127 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 150 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-vdms name_title: VDMS repo: IntelLabs/langchain-vdms - downloads: 3000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 2000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-deeplake repo: activeloopai/langchain-deeplake - downloads: 645 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 639 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-cognee repo: topoteretes/langchain-cognee - downloads: 144 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 194 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-prolog repo: apisani1/langchain-prolog - downloads: 443 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 445 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-permit repo: permitio/langchain-permit - downloads: 224 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 87 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-pymupdf4llm repo: lakinduboteju/langchain-pymupdf4llm - downloads: 17000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 18000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-writer repo: writer/langchain-writer - downloads: 7000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 9000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-taiga name_title: Taiga repo: Shikenso-Analytics/langchain-taiga downloads: 167 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-tableau name_title: Tableau repo: Tab-SE/tableau_langchain - downloads: 335 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 361 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: ads4gpts-langchain name_title: ADS4GPTs repo: ADS4GPTs/ads4gpts path: libs/python-sdk/ads4gpts-langchain - downloads: 742 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 836 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-contextual name_title: Contextual AI repo: ContextualAI//langchain-contextual path: langchain-contextual - downloads: 412 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 382 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-valthera name_title: Valthera repo: valthera/langchain-valthera - downloads: 101 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 109 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-opengradient repo: OpenGradient/og-langchain - downloads: 81 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 87 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: goat-sdk-adapter-langchain name_title: GOAT SDK repo: goat-sdk/goat path: python/src/adapters/langchain provider_page: goat - downloads: 286 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 186 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-netmind repo: protagolabs/langchain-netmind - downloads: 53 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 47 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-agentql repo: tinyfish-io/agentql-integrations path: langchain - downloads: 312 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 290 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-xinference repo: TheSongg/langchain-xinference - downloads: 135 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 156 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-tavily highlight: true repo: tavily-ai/langchain-tavily js: "@langchain/tavily" - downloads: 308000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 341000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-zotero-retriever name_title: Zotero repo: TimBMK/langchain-zotero-retriever provider_page: zotero - downloads: 62 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 50 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-naver name_title: Naver repo: NaverCloudPlatform/langchain-naver downloads: 2000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-naver-community name_title: Naver (Community) repo: e7217/langchain-naver-community provider_page: naver - downloads: 726 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 760 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-memgraph repo: memgraph/langchain-memgraph - downloads: 9000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 18000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-vectara repo: vectara/langchain-vectara path: libs/vectara - downloads: 232 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 87 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-oxylabs repo: oxylabs/langchain-oxylabs - downloads: 231 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 301 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-runpod name_title: RunPod repo: runpod/langchain-runpod - downloads: 690 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 1000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-mariadb repo: mariadb-corporation/langchain-mariadb downloads: 3000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-qwq repo: yigit353/langchain-qwq provider_page: alibaba_cloud - downloads: 8000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 10000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-litellm name_title: LiteLLM highlight: true repo: akshay-dongare/langchain-litellm - downloads: 190000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 144000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-cloudflare repo: cloudflare/langchain-cloudflare path: libs/langchain-cloudflare js: "@langchain/cloudflare" downloads: 1000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-ydb repo: ydb-platform/langchain-ydb downloads: 1000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-singlestore name_title: SingleStore repo: singlestore-labs/langchain-singlestore - downloads: 667 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 672 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-galaxia-retriever repo: rrozanski-smabbler/galaxia-langchain provider_page: galaxia downloads: 92 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-valyu repo: valyu-network/langchain-valyu - downloads: 608 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 738 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-hana name_title: SAP HANA Cloud repo: SAP/langchain-integration-for-sap-hana-cloud provider_page: sap - downloads: 31000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 28000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-gel repo: geldata/langchain-gel - downloads: 99 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 94 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-brightdata repo: luminati-io/langchain-brightdata downloads: 2000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-featherless-ai repo: featherlessai/langchain-featherless-ai - downloads: 94 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 114 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-nebius repo: nebius/langchain-nebius path: libs/nebius - downloads: 937 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 1000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-surrealdb repo: surrealdb/langchain-surrealdb - downloads: 164 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 224 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-greennode repo: greennode-ai/langchain-greennode path: libs/greennode - downloads: 50 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 44 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-tensorlake repo: tensorlakeai/langchain-tensorlake - downloads: 170 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 190 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-gradient name_title: DigitalOcean Gradient repo: digitalocean/langchain-gradient provider_page: gradientai - downloads: 791 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 392 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-anchorbrowser name_title: Anchor Browser repo: anchorbrowser/langchain-anchorbrowser provider_page: anchor_browser - downloads: 266 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 289 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: toolbox-langchain name_title: MCP Toolbox (Google) highlight: true repo: googleapis/mcp-toolbox-sdk-python path: packages/toolbox-langchain - downloads: 6000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 7000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-scrapeless repo: scrapeless-ai/langchain-scrapeless - downloads: 57 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 56 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-google-bigtable name_title: Bigtable (Google) repo: googleapis/langchain-google-bigtable-python provider_page: google - downloads: 350 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 514 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-oci name_title: Oracle Cloud Infrastructure (OCI) repo: oracle/langchain-oracle - downloads: 2000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 3000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-zeusdb repo: zeusdb/langchain-zeusdb path: libs/zeusdb - downloads: 190 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 328 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-scraperapi repo: scraperapi/langchain-scraperapi - downloads: 405 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 722 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-localai repo: mkhludnev/langchain-localai path: libs/localai downloads: 3000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-scrapegraph repo: ScrapeGraphAI/langchain-scrapegraph - downloads: 945 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 660 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" - name: langchain-voyageai repo: voyage-ai/langchain-voyageai path: libs/voyageai - downloads: 38000 - downloads_updated_at: "2025-10-20T00:06:34.640756+00:00" + downloads: 47000 + downloads_updated_at: "2025-11-03T01:54:16.054206+00:00" diff --git a/src/oss/python/integrations/vectorstores/azure_db_for_postgresql.mdx b/src/oss/python/integrations/vectorstores/azure_db_for_postgresql.mdx new file mode 100644 index 000000000..175c7e628 --- /dev/null +++ b/src/oss/python/integrations/vectorstores/azure_db_for_postgresql.mdx @@ -0,0 +1,425 @@ +--- +title: Azure Database for PostgreSQL - Flexible Server +--- + +[Azure Database for PostgreSQL - Flexible Server](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/service-overview) is a relational database service based on the open-source Postgres database engine. It's a fully managed database-as-a-service that can handle mission-critical workloads with predictable performance, security, high availability, and dynamic scalability. + +This notebook shows you how to leverage this integrated [vector database](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/how-to-use-pgvector) to store documents in collections, create indices and perform vector search queries using approximate nearest neighbor algorithms such as Cosine Distance, L2 (Euclidean distance), and IP (inner product) to locate documents close to the query vectors. + +## Vector Support on Azure Database for PostgreSQL - Flexible Server + +Azure Database for PostgreSQL - Flexible Server enables you to efficiently store and query millions of vector embeddings in PostgreSQL. As well as scale your AI use cases from POC to production: + +* Provides a familiar SQL interface for querying vector embeddings and relational data. +* Boosts `pgvector` with a faster and more precise similarity search across 100M+ vectors using [DiskANN indexing algorithm.](https://aka.ms/pg-diskann-docs) +* Simplifies operations by integrating relational metadata, vector embeddings, and time-series data into a single database. +* Leverages the power of the robust PostgreSQL ecosystem and Azure Cloud for enterprise-grade features including replication, and high availability. + +## Authentication + +Azure Database for PostgreSQL - Flexible Server supports password-based as well as [Microsoft Entra](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/concepts-azure-ad-authentication) (formerly Azure Active Directory) authentication. +Entra authentication allows you to use Entra identity to authenticate to your PostgreSQL server. This eliminates the need to manage separate usernames and passwords for your database users, and allows +you to leverage the same security mechanisms that you use for other Azure services. + +This notebook is set up to use either authentication method. You can configure whether or not to use Entra authentication later in the notebook. + +## Setup + +Since Azure Database for PostgreSQL is open-source Postgres, you can use [LangChain's Postgres support](https://python.langchain.com/docs/integrations/vectorstores/pgvector/) to connect to Azure Database for PostgreSQL. + +First download the partner package: + +```python +%pip install -qU langchain-azure-postgresql +%pip install -qU langchain-openai +%pip install -qU azure-identity +``` + +### Enable pgvector on Azure Database for PostgreSQL - Flexible Server + +See [enablement instructions](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/how-to-use-pgvector) for Azure Database for PostgreSQL. + +### Set up credentials + +You will need your Azure Database for PostgreSQL [connection details](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/quickstart-create-server-portal#get-the-connection-information) and add them as environment variables to run this notebook. + +Set the `USE_ENTRA_AUTH` flag to `True` if you want to use Microsoft Entra authentication. If using Entra authentication, you will only need to supply the host and database name. If using password authentication, you'll also need to set the username and password. + +```python +import getpass +import os + +USE_ENTRA_AUTH = True + +# Supply the connection details for the database +os.environ["DBHOST"] = "REPLACE_WITH_SERVER_NAME" +os.environ["DBNAME"] = "REPLACE_WITH_DATABASE_NAME" +os.environ["SSLMODE"] = "require" + +if not USE_ENTRA_AUTH: + # If using a username and password, supply them here + os.environ["DBUSER"] = "REPLACE_WITH_USERNAME" + os.environ["DBPASSWORD"] = getpass.getpass("Database Password:") +``` + +### Setup Azure OpenAI Embeddings + +```python +os.environ["AZURE_OPENAI_ENDPOINT"] = "REPLACE_WITH_AZURE_OPENAI_ENDPOINT" +os.environ["AZURE_OPENAI_API_KEY"] = getpass.getpass("Azure OpenAI API Key:") +``` + +```python +AZURE_OPENAI_ENDPOINT = os.environ["AZURE_OPENAI_ENDPOINT"] +AZURE_OPENAI_API_KEY = os.environ["AZURE_OPENAI_API_KEY"] + +from langchain_openai import AzureOpenAIEmbeddings + +embeddings = AzureOpenAIEmbeddings( + model="text-embedding-3-small", + api_key=AZURE_OPENAI_API_KEY, + azure_endpoint=AZURE_OPENAI_ENDPOINT, + azure_deployment="text-embedding-3-small", +) +``` + +## Initialization + +### Use Microsoft Entra authentication + +The following sections demonstrate how to set up LangChain to use Microsoft Entra authentication. The class `AzurePGConnectionPool` in the LangChain Azure Postgres package retrieves tokens for the Azure Database for PostgreSQL service by using `DefaultAzureCredential` from the `azure.identity` library. + +The connection can be passed into the `connection` parameter of the `AzurePGVectorStore` LangChain vector store. + +#### Sign in to Azure + +To log into Azure, ensure you have the [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) installed. You will need to run the following command in your terminal: + +```bash +az login +``` + +Once you have logged in, the below code will be able to fetch the token. + +```python +from langchain_azure_postgresql.common import ( + BasicAuth, + AzurePGConnectionPool, + ConnectionInfo, +) +from langchain_azure_postgresql.langchain import AzurePGVectorStore + +entra_connection_pool = AzurePGConnectionPool( + azure_conn_info=ConnectionInfo( + host=os.environ["DBHOST"], dbname=os.environ["DBNAME"] + ) +) +``` + +### Password Authentication + +If you're not using Microsoft Entra authentication, the `BasicAuth` class allows the use of username and password: + +```python +basic_auth_connection_pool = AzurePGConnectionPool( + azure_conn_info=ConnectionInfo( + host=os.environ["DBHOST"], + dbname=os.environ["DBNAME"], + credentials=BasicAuth( + username=os.environ["DBUSER"], + password=os.environ["DBPASSWORD"], + ), + ) +) +``` + +### Creating the vector store + +```python +from langchain_core.documents import Document +from langchain_azure_postgresql.langchain import AzurePGVectorStore + +table_name = "my_docs" + +# The connection is either using Entra ID or Basic Auth +connection = entra_connection_pool if USE_ENTRA_AUTH else basic_auth_connection_pool + +vector_store = AzurePGVectorStore( + embedding=embeddings, + table_name=table_name, + connection=connection, +) +``` + +```output +Metadata columns are specified as a string, defaulting to 'jsonb' type. +Embedding type is not specified, defaulting to 'vector'. +Embedding dimension is not specified, defaulting to 1536. +Embedding index is not specified, defaulting to 'DiskANN' with 'vector_cosine_ops' opclass. +``` + +## Initialize the DiskANN Vector index for more efficient vector search + +[DiskANN](https://aka.ms/pg-diskann-blog) is a scalable approximate nearest neighbor search algorithm for efficient vector search at any scale. It offers high recall, high queries per second, and low query latency, even for billion-point datasets. Those characteristics make it a powerful tool for handling large volumes of data. + +```python +vector_store.create_index() +``` + +```output +True +``` + +## Manage vector store + +### Add items to vector store + +Note that adding documents by ID will over-write any existing documents that match that ID. + +```python +docs = [ + Document( + page_content="there are cats in the pond", + metadata={"doc_id": 1, "location": "pond", "topic": "animals"}, + ), + Document( + page_content="ducks are also found in the pond", + metadata={"doc_id": 2, "location": "pond", "topic": "animals"}, + ), + Document( + page_content="fresh apples are available at the market", + metadata={"doc_id": 3, "location": "market", "topic": "food"}, + ), + Document( + page_content="the market also sells fresh oranges", + metadata={"doc_id": 4, "location": "market", "topic": "food"}, + ), + Document( + page_content="the new art exhibit is fascinating", + metadata={"doc_id": 5, "location": "museum", "topic": "art"}, + ), + Document( + page_content="a sculpture exhibit is also at the museum", + metadata={"doc_id": 6, "location": "museum", "topic": "art"}, + ), + Document( + page_content="a new coffee shop opened on Main Street", + metadata={"doc_id": 7, "location": "Main Street", "topic": "food"}, + ), + Document( + page_content="the book club meets at the library", + metadata={"doc_id": 8, "location": "library", "topic": "reading"}, + ), + Document( + page_content="the library hosts a weekly story time for kids", + metadata={"doc_id": 9, "location": "library", "topic": "reading"}, + ), + Document( + page_content="a cooking class for beginners is offered at the community center", + metadata={"doc_id": 10, "location": "community center", "topic": "classes"}, + ), +] + +uuids = vector_store.add_documents(docs) +uuids +``` + +```output +['00e2cfe6-6e58-4733-9ebf-a708fd16488a', + '224a22a8-567f-4e12-ac0f-5cfe4f0a4480', + '62058e25-8f5e-4388-81c2-a5b7348ffef0', + '1d37d282-504d-4d28-855a-8d39694b0265', + '1fffcd2e-6fce-423f-bac3-ee5dc9084673', + 'b99efbab-2247-418f-b80d-d865f01d3c9e', + 'd2a86d1b-5d81-4c53-b3d2-a6b1e5189a3f', + 'a9577242-823e-42bc-9b0f-01670dbec190', + 'eaa45ae8-a84b-46eb-8a27-bf8652148d17', + '7d7f04fd-6fb8-4a29-8708-b9f835ef270a'] +``` + +### Update items in vector store + +```python +updated_docs = [ + Document( + page_content="Updated - cooking class for beginners is offered at the community center", + metadata={"doc_id": 10, "location": "community center", "topic": "classes"}, + id=uuids[-1], + ) +] +vector_store.add_documents(updated_docs, ids=[uuids[-1]], on_conflict_update=True) +``` + +```output +['7d7f04fd-6fb8-4a29-8708-b9f835ef270a'] +``` + +### See items from the vector store + +```python +vector_store.get_by_ids([str(uuids[3])]) +``` + +```output +[Document(id='1d37d282-504d-4d28-855a-8d39694b0265', metadata={'topic': 'food', 'doc_id': 4, 'location': 'market'}, page_content='the market also sells fresh oranges')] +``` + +### Delete items from vector store + +```python +vector_store.delete(ids=[uuids[3]]) +``` + +```output +True +``` + +## Query vector store + +After you create your vector store and add the relevant documents, you can query the vector store in your chain or agent. + +### Filtering Support + +The vector store supports a set of filters that can be applied against the metadata fields of the documents via the `FilterCondition`, `OrFilter`, and `AndFilter` in the [LangChain Azure PostgreSQL](https://pypi.org/project/langchain-azure-postgresql/) package: + +| Operator | Meaning/Category | +| -------- | ------------------------------- | +| `=` | Equality | +| `!=` | Inequality | +| `<` | Less than | +| `<=` | Less than or equal | +| `>` | Greater than | +| `>=` | Greater than or equal | +| `in` | Special cased (in) | +| `not in` | Special cased (not in) | +| `is null` | Special cased (is null) | +| `is not null` | Special cased (is not null) | +| `between` | Special cased (between) | +| `not between` | Special cased (not between) | +| `like` | Text (like) | +| `ilike` | Text (case-insensitive like) | +| `AND` | Logical (and) | +| `OR` | Logical (or) | + +### Query directly + +Performing a simple similarity search can be done as follows: + +```python +from langchain_azure_postgresql import FilterCondition, AndFilter + +results = vector_store.similarity_search( + "kitty", + k=10, + filter=FilterCondition( + column="(metadata->>'doc_id')::int", + operator="in", + value=[1, 5, 2, 9], + ), +) + +for doc in results: + print("* " + doc.page_content + " [" + str(doc.metadata) + "]") +``` + +```output +* there are cats in the pond [{'topic': 'animals', 'doc_id': 1, 'location': 'pond'}] +* ducks are also found in the pond [{'topic': 'animals', 'doc_id': 2, 'location': 'pond'}] +* the new art exhibit is fascinating [{'topic': 'art', 'doc_id': 5, 'location': 'museum'}] +* the library hosts a weekly story time for kids [{'topic': 'reading', 'doc_id': 9, 'location': 'library'}] +``` + +If you want to use logical `AND` filters, here is an example: + +```python +results = vector_store.similarity_search( + "ducks", + k=10, + filter=AndFilter( + AND=[ + FilterCondition( + column="(metadata->>'doc_id')::int", + operator="in", + value=[1, 5, 2, 9], + ), + FilterCondition( + column="metadata->>'location'", + operator="in", + value=["pond", "market"], + ), + ] + ), +) + +for doc in results: + print("* " + doc.page_content + " [" + str(doc.metadata) + "]") +``` + +```output +* ducks are also found in the pond [{'topic': 'animals', 'doc_id': 2, 'location': 'pond'}] +* there are cats in the pond [{'topic': 'animals', 'doc_id': 1, 'location': 'pond'}] +``` + +If you want to execute a similarity search and receive the corresponding scores you can run: + +```python +results = vector_store.similarity_search_with_score(query="cats", k=1) +for doc, score in results: + print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]") +``` + +```output +* [SIM=0.528167] there are cats in the pond [{'topic': 'animals', 'doc_id': 1, 'location': 'pond'}] +``` + +### Query by turning into retriever + +You can also transform the vector store into a retriever for easier usage in your chains. + +```python +retriever = vector_store.as_retriever(search_kwargs={"k": 1}) +retriever.invoke("kitty") +``` + +```output +[Document(id='00e2cfe6-6e58-4733-9ebf-a708fd16488a', metadata={'topic': 'animals', 'doc_id': 1, 'location': 'pond'}, page_content='there are cats in the pond')] +``` + +If you want to use max marginal relevance search on your vector store: + +```python +results = vector_store.max_marginal_relevance_search( + "query about cats", + k=10, + lambda_mult=0.5, + filter=FilterCondition( + column="(metadata->>'doc_id')::int", + operator="in", + value=[1, 2, 5, 9], + ), +) + +for doc in results: + print("* " + doc.page_content + " [" + str(doc.metadata) + "]") +``` + +```output +* there are cats in the pond [{'topic': 'animals', 'doc_id': 1, 'location': 'pond'}] +* the new art exhibit is fascinating [{'topic': 'art', 'doc_id': 5, 'location': 'museum'}] +* the library hosts a weekly story time for kids [{'topic': 'reading', 'doc_id': 9, 'location': 'library'}] +* ducks are also found in the pond [{'topic': 'animals', 'doc_id': 2, 'location': 'pond'}] +``` + +For a full list of the different searches you can execute on a `AzurePGVectorStore` vector store, please refer to the [documentation](https://github.com/langchain-ai/langchain-azure/tree/main/libs/azure-postgresql). + +## Usage for retrieval-augmented generation + +For guides on how to use this vector store for retrieval-augmented generation (RAG), see the following sections: + +* [Tutorials: working with external knowledge](https://python.langchain.com/docs/tutorials/#working-with-external-knowledge) +* [How-to: Question and answer with RAG](https://python.langchain.com/docs/how_to/#qa-with-rag) +* [Retrieval conceptual docs](https://python.langchain.com/docs/concepts/#retrieval) + +## API reference + +For detailed documentation of all AzurePGVectorStore features and configurations head to the API reference: https://github.com/langchain-ai/langchain-azure/tree/main/libs/azure-postgresql/src/langchain_azure_postgresql/langchain diff --git a/src/oss/python/integrations/vectorstores/index.mdx b/src/oss/python/integrations/vectorstores/index.mdx index 96d8e0154..a2df9d585 100644 --- a/src/oss/python/integrations/vectorstores/index.mdx +++ b/src/oss/python/integrations/vectorstores/index.mdx @@ -679,8 +679,9 @@ vector_store = QdrantVectorStore( - + +