langchain-community

Description

Reference documentation for the langchain-community package.

Classes

Class

InMemoryCache

Cache that stores things in memory.

Class

FullLLMCache

SQLite table for full LLM Cache (all generations).

Class

SQLAlchemyCache

Cache that uses SQAlchemy as a backend.

Class

SQLiteCache

Cache that uses SQLite as a backend.

Class

UpstashRedisCache

Cache that uses Upstash Redis as a backend.

Class

RedisCache

Cache that uses Redis as a backend. Allows to use a sync redis.Redis client.

Class

AsyncRedisCache

Cache that uses Redis as a backend. Allows to use an async redis.asyncio.Redis client.

Class

RedisSemanticCache

Cache that uses Redis as a vector-store backend.

Class

GPTCache

Cache that uses GPTCache as a backend.

Class

MomentoCache

Cache that uses Momento as a backend. See https://gomomento.com/

Class

CassandraCache

Cache that uses Cassandra / Astra DB as a backend.

Example:

.. code-block:: python

    import cassio

    from langchain_community.cache import CassandraCache
    from langchain_cor

Class

CassandraSemanticCache

Cache that uses Cassandra as a vector-store backend for semantic (i.e. similarity-based) lookup.

Example:

.. code-block:: python

    import cassio

    from langchain_community.cache im

Class

FullMd5LLMCache

SQLite table for full LLM Cache (all generations).

Class

SQLAlchemyMd5Cache

Cache that uses SQAlchemy as a backend.

Class

AzureCosmosDBSemanticCache

Cache that uses Cosmos DB Mongo vCore vector-store backend

Class

AzureCosmosDBNoSqlSemanticCache

Cache that uses Cosmos DB NoSQL backend

Class

OpenSearchSemanticCache

Cache that uses OpenSearch vector store backend

Class

MemcachedCache

Cache that uses Memcached backend through pymemcache client lib

Class

OutputFunctionsParser

Parse an output that is one of sets of values.

Class

JsonOutputFunctionsParser

Parse an output as the Json object.

Class

JsonKeyOutputFunctionsParser

Parse an output as the element of the Json object.

Class

PydanticOutputFunctionsParser

Parse an output as a pydantic object.

Class

PydanticAttrOutputFunctionsParser

Parse an output as an attribute of a pydantic object.

Class

GuardrailsOutputParser

Parse the output of an LLM call using Guardrails.

Class

SceneXplainAPIWrapper

Wrapper for SceneXplain API.

In order to set this up, you need API key for the SceneXplain API. You can obtain a key by following the steps below.

Class

Component

Base class for all components.

Class

Task

Class for a task.

Class

CUList

Component class for a list.

Class

Member

Component class for a member.

Class

Team

Component class for a team.

Class

Space

Component class for a space.

Class

ClickupAPIWrapper

Wrapper for Clickup API.

Class

ZapierNLAWrapper

Wrapper for Zapier NLA.

Full docs here: https://nla.zapier.com/start/

This wrapper supports both API Key and OAuth Credential auth methods. API Key is the fastest way to get started using this wrapp

Class

SQLDatabase

SQLAlchemy wrapper around a database.

Class

GoogleTrendsAPIWrapper

Wrapper for SerpApi's Google Scholar API

You can create SerpApi.com key by signing up at: https://serpapi.com/users/sign_up.

The wrapper uses the SerpApi.com python package: https://serpapi.com/inte

Class

DataForSeoAPIWrapper

Wrapper around the DataForSeo API.

Class

BraveSearchWrapper

Wrapper around the Brave search engine.

Class

TensorflowDatasets

Access to the TensorFlow Datasets.

The Current implementation can work only with datasets that fit in a memory.

TensorFlow Datasets is a collection of datasets ready to use, with TensorFlow or oth

Class

WikidataAPIWrapper

Wrapper around the Wikidata API.

To use, you should have the wikibase-rest-api-client and mediawikiapi python packages installed. This wrapper will use the Wikibase APIs to conduct searches

Class

WolframAlphaAPIWrapper

Wrapper for Wolfram Alpha.

Docs for using:

Go to wolfram alpha and sign up for a developer account
Create an app and get your APP ID
Save your APP ID into WOLFRAM_ALPHA_APPID env variable 4

Class

HiddenPrints

Context manager to hide prints.

Class

SerpAPIWrapper

Wrapper around SerpAPI.

To use, you should have the google-search-results python package installed, and the environment variable SERPAPI_API_KEY set with your API key, or pass `serpapi_api_ke

Class

JiraOauth2Token

Jira OAuth2 token.

Class

JiraOauth2

Jira OAuth2.

Class

JiraAPIWrapper

Wrapper for Jira API. You can connect to Jira with either an API token or OAuth2.

with API token, you need to provide the JIRA_USERNAME and JIRA_API_TOKEN environment variables or arguments. ex:

Class

InfobipAPIWrapper

Wrapper for Infobip API for messaging.

Class

GoogleSerperAPIWrapper

Wrapper around the Serper.dev Google Search API.

You can create a free API key at https://serper.dev.

To use, you should have the environment variable SERPER_API_KEY set with your API key, or pa

Class

TwilioAPIWrapper

Messaging Client using Twilio.

To use, you should have the twilio python package installed, and the environment variables TWILIO_ACCOUNT_SID, TWILIO_AUTH_TOKEN, and TWILIO_FROM_NUMBER

Class

WikipediaAPIWrapper

Wrapper around WikipediaAPI.

To use, you should have the wikipedia python package installed. This wrapper will use the Wikipedia API to conduct searches and fetch page summaries. By default, it w

Class

ArceeRoute

Routes available for the Arcee API as enumerator.

Class

DALMFilterType

Filter types available for a DALM retrieval as enumerator.

Class

DALMFilter

Filters available for a DALM retrieval and generation.

Class

ArceeDocumentSource

Source of an Arcee document.

Class

ArceeDocument

Arcee document.

Class

ArceeDocumentAdapter

Adapter for Arcee documents

Class

ArceeWrapper

Wrapper for Arcee API.

For more details, see: https://www.arcee.ai/

Class

Portkey

Portkey configuration.

Class

StackExchangeAPIWrapper

Wrapper for Stack Exchange API.

Class

OpenWeatherMapAPIWrapper

Wrapper for OpenWeatherMap API using PyOWM.

Docs for using:

Go to OpenWeatherMap and sign up for an API key
Save your API KEY into OPENWEATHERMAP_API_KEY env variable
pip install pyowm

Class

SetupMode

Class

GoogleBooksAPIWrapper

Wrapper around Google Books API.

To use, you should have a Google Books API key available. This wrapper will use the Google Books API to conduct searches and fetch books based on a query passed in by

Class

NasaAPIWrapper

Wrapper for NASA API.

Class

GoogleLensAPIWrapper

Wrapper for SerpApi's Google Lens API

You can create SerpApi.com key by signing up at: https://serpapi.com/users/sign_up.

The wrapper uses the SerpApi.com python package: https://serpapi.com/integra

Class

AlphaVantageAPIWrapper

Wrapper for AlphaVantage API for Currency Exchange Rate.

Docs for using:

Go to AlphaVantage and sign up for an API key
Save your API KEY into ALPHAVANTAGE_API_KEY env variable

Class

HTTPVerb

Enumerator of the HTTP verbs.

Class

OpenAPISpec

OpenAPI Model that removes mis-formatted parts of the spec.

Class

FinancialDatasetsAPIWrapper

Wrapper for financial datasets API.

Class

SemanticScholarAPIWrapper

Wrapper around semanticscholar.org API. https://github.com/danielnsilva/semanticscholar

You should have this library installed.

pip install semanticscholar

Semantic Scholar API can conduct search

Class

PubMedAPIWrapper

Wrapper around PubMed API.

This wrapper will use the PubMed API to conduct searches and fetch document summaries. By default, it will return the document summaries of the top-k results of an input se

Class

SentinelT

An empty Sentinel type.

Class

RivaAudioEncoding

An enum of the possible choices for Riva audio encoding.

The list of types exposed by the Riva GRPC Protobuf files can be found with the following commands:

import riva.client
print(riva.cl

Class

RivaAuthMixin

Configuration for the authentication to a Riva service connection.

Class

RivaCommonConfigMixin

A collection of common Riva settings.

Class

AudioStream

A message containing streaming audio.

Class

RivaASR

A runnable that performs Automatic Speech Recognition (ASR) using NVIDIA Riva.

Class

RivaTTS

A runnable that performs Text-to-Speech (TTS) with NVIDIA Riva.

Class

GitHubAPIWrapper

Wrapper for GitHub API.

Class

TokenEscaper

Escape punctuation within an input string.

Class

Requests

Wrapper around requests to handle auth and async.

The main purpose of this wrapper is to handle authentication (by saving headers) and enable easy async methods on the same base object.

Class

GenericRequestsWrapper

Lightweight wrapper around requests library.

Class

JsonRequestsWrapper

Lightweight wrapper around requests library, with async support.

The main purpose of this wrapper is to always return a json output.

Class

TextRequestsWrapper

Lightweight wrapper around requests library, with async support.

The main purpose of this wrapper is to always return a text output.

Class

JinaSearchAPIWrapper

Wrapper around the Jina search engine.

Class

SetupMode

Setup mode for AstraDBEnvironment as enumerator.

Class

LambdaWrapper

Wrapper for AWS Lambda SDK. To use, you should have the boto3 package installed and a lambda functions built from the AWS Console or CLI. Set up your AWS credentials with aws configure

Class

DataheraldAPIWrapper

Wrapper for Dataherald.

Docs for using:

Go to dataherald and sign up
Create an API key
Save your API key into DATAHERALD_API_KEY env variable
pip install dataherald

Class

DallEAPIWrapper

Wrapper for OpenAI's DALL-E Image Generator.

https://platform.openai.com/docs/guides/images/generations?context=node

Usage instructions:

pip install openai
save your OPENAI_API_KEY in an en

Class

AskNewsAPIWrapper

Wrapper for AskNews API.

Class

TavilySearchAPIWrapper

Wrapper for Tavily Search API.

Class

DriaAPIWrapper

Wrapper around Dria API.

This wrapper facilitates interactions with Dria's vector search and retrieval services, including creating knowledge bases, inserting data, and fetching search results.

Class

MaxComputeAPIWrapper

Interface for querying Alibaba Cloud MaxCompute tables.

Class

GoogleFinanceAPIWrapper

Wrapper for SerpApi's Google Finance API

You can create SerpApi.com key by signing up at: https://serpapi.com/users/sign_up. The wrapper uses the SerpApi.com python package: https://serpapi.com/integ

Class

ArxivAPIWrapper

Wrapper around ArxivAPI.

To use, you should have the arxiv python package installed. https://lukasschwab.me/arxiv.py/index.html This wrapper will use the Arxiv API to conduct searches and fetch d

Class

Routes

Routes available for the Pebblo API as enumerator.

Class

IndexedDocument

Pebblo Indexed Document.

Class

Runtime

Pebblo Runtime.

Class

Framework

Pebblo Framework instance.

Class

App

Pebblo AI application.

Class

Doc

Pebblo document.

Class

PebbloLoaderAPIWrapper

Wrapper for Pebblo Loader API.

Class

SearxResults

Dict like wrapper around search api results.

Class

SearxSearchWrapper

Wrapper for Searx API.

To use you need to provide the searx host by passing the named parameter searx_host or exporting the environment variable SEARX_HOST.

In some situations you might want

Class

SearchApiAPIWrapper

Wrapper around SearchApi API.

To use, you should have the environment variable SEARCHAPI_API_KEY set with your API key, or pass searchapi_api_key as a named parameter to the constructor.

Class

MojeekSearchAPIWrapper

Class

GraphQLAPIWrapper

Wrapper around GraphQL API.

To use, you should have the gql python package installed. This wrapper will use the GraphQL API to conduct queries.

Class

SteamWebAPIWrapper

Wrapper for Steam API.

Class

CassandraDatabase

Apache Cassandra® database wrapper.

Class

DatabaseError

Exception raised for errors in the database schema.

Class

Table

Class

MerriamWebsterAPIWrapper

Wrapper for Merriam-Webster.

Docs for using:

Go to https://www.dictionaryapi.com/register/index and register an developer account with a key for the Collegiate Dictionary
Get your API Key f

Class

PolygonAPIWrapper

Wrapper for Polygon API.

Class

GoogleScholarAPIWrapper

Wrapper for Google Scholar API

You can create serpapi key by signing up at: https://serpapi.com/users/sign_up.

The wrapper uses the serpapi python package: https://serpapi.com/integrations/python#se

Class

DuckDuckGoSearchAPIWrapper

Wrapper for DuckDuckGo Search API.

Free and does not require any setup.

Class

MetaphorSearchAPIWrapper

Wrapper for Metaphor Search API.

Class

OutlineAPIWrapper

Wrapper around OutlineAPI.

This wrapper will use the Outline API to query the documents of your instance. By default it will return the document content of the top-k results. It limits the document c

Class

GitLabAPIWrapper

Wrapper for GitLab API.

Class

RedditSearchAPIWrapper

Wrapper for Reddit API

To use, set the environment variables REDDIT_CLIENT_ID, REDDIT_CLIENT_SECRET, REDDIT_USER_AGENT to set the client ID, client secret, and user agent, respectively, a

Class

GoldenQueryAPIWrapper

Wrapper for Golden.

Docs for using:

Go to https://golden.com and sign up for an account
Get your API Key from https://golden.com/settings/api
Save your API Key into GOLDEN_API_KEY env varia

Class

RememberizerAPIWrapper

Wrapper for Rememberizer APIs.

Class

BibtexparserWrapper

Wrapper around bibtexparser.

To use, you should have the bibtexparser python package installed. https://bibtexparser.readthedocs.io/en/master/

This wrapper will use bibtexparser to load a collec

Class

SparkSQL

SparkSQL is a utility class for interacting with Spark SQL.

Class

GoogleJobsAPIWrapper

Wrapper for SerpApi's Google Scholar API

You can create SerpApi.com key by signing up at: https://serpapi.com/users/sign_up. The wrapper uses the SerpApi.com python package: https://serpapi.com/integ

Class

YouHitMetadata

Metadata on a single hit from you.com

Class

YouHit

A single hit from you.com, which may contain multiple snippets

Class

YouAPIOutput

Output from you.com API.

Class

YouDocument

Output of parsing one snippet.

Class

YouSearchAPIWrapper

Wrapper for you.com Search and News API.

To connect to the You.com api requires an API key which you can get at https://api.you.com. You can check out the docs at https://documentation.you.com/api-re

Class

BingSearchAPIWrapper

Wrapper for Bing Web Search API.

Class

NoDiskStorage

Mixin to prevent storing on disk.

Class

ManagedPassioLifeAuth

Manage the token for the NutritionAI API.

Class

NutritionAIAPI

Wrapper for the Passio Nutrition AI API.

Class

PowerBIDataset

Create PowerBI engine from dataset ID and credential or token.

Use either the credential or a supplied token to authenticate. If both are supplied the credential is used to generate a token. The impe

Class

HypotheticalDocumentEmbedder

Class

SelfHostedEmbeddings

Custom embedding models on self-hosted remote hardware.

Supported hardware includes auto-launched instances on AWS, GCP, Azure, and Lambda, as well as servers specified by IP address and SSH credenti

Class

Model2vecEmbeddings

Model2Vec embedding models.

Install model2vec first, run 'pip install -U model2vec'. The github repository for model2vec is : https://github.com/MinishLab/model2vec

Class

OctoAIEmbeddings

OctoAI Compute Service embedding models.

See https://octo.ai/ for information about OctoAI.

To use, you should have the openai python package installed and the environment variable ``OCTOAI_API_

Class

NLPCloudEmbeddings

NLP Cloud embedding models.

To use, you should have the nlpcloud python package installed

Class

ZhipuAIEmbeddings

ZhipuAI embedding model integration.

Setup:

To use, you should have the ``zhipuai`` python package installed, and the
environment variable ``ZHIPU_API_KEY`` set with your API KEY.

More

Class

VolcanoEmbeddings

Volcengine Embeddings embedding models.

Class

QuantizedBiEncoderEmbeddings

Quantized bi-encoders embedding models.

Please ensure that you have installed optimum-intel and ipex.

Class

LocalAIEmbeddings

LocalAI embedding models.

Since LocalAI and OpenAI have 1:1 compatibility between APIs, this class uses the openai Python package's openai.Embedding as its client. Thus, you should have the `

Class

ClovaXEmbeddings

NCP ClovaStudio Embedding API.

following environment variables set or passed in constructor in lower case:

NCP_CLOVASTUDIO_API_KEY
NCP_APIGW_API_KEY
NCP_CLOVASTUDIO_APP_ID

Class

SelfHostedHuggingFaceEmbeddings

HuggingFace embedding models on self-hosted remote hardware.

Supported hardware includes auto-launched instances on AWS, GCP, Azure, and Lambda, as well as servers specified by IP address and SSH cre

Class

SelfHostedHuggingFaceInstructEmbeddings

HuggingFace InstructEmbedding models on self-hosted remote hardware.

Supported hardware includes auto-launched instances on AWS, GCP, Azure, and Lambda, as well as servers specified by IP address and

Class

LlamaCppEmbeddings

llama.cpp embedding models.

To use, you should have the llama-cpp-python library installed, and provide the path to the Llama model as a named parameter to the constructor. Check out: https://github.

Class

LLMRailsEmbeddings

LLMRails embedding models.

To use, you should have the environment variable LLM_RAILS_API_KEY set with your API key or pass it as a named parameter to the constructor.

Model can be one of ["emb

Class

QuantizedBgeEmbeddings

Leverage Itrex runtime to unlock the performance of compressed NLP models.

Please ensure that you have installed intel-extension-for-transformers.

Class

LlamafileEmbeddings

Llamafile lets you distribute and run large language models with a single file.

To get started, see: https://github.com/Mozilla-Ocho/llamafile

To use this class, you will need to first:

Download

Class

ModelScopeEmbeddings

ModelScopeHub embedding models.

To use, you should have the modelscope python package installed.

Class

TextEmbedEmbeddings

A class to handle embedding requests to the TextEmbed API.

Class

AsyncOpenAITextEmbedEmbeddingClient

A client to handle synchronous and asynchronous requests to the TextEmbed API.

Class

FakeEmbeddings

Fake embedding model.

Class

DeterministicFakeEmbedding

Fake embedding model that always returns the same embedding vector for the same text.

Class

JavelinAIGatewayEmbeddings

Javelin AI Gateway embeddings.

To use, you should have the javelin_sdk python package installed. For more information, see https://docs.getjavelin.io

Class

EdenAiEmbeddings

EdenAI embedding. environment variable EDENAI_API_KEY set with your API key, or pass it as a named parameter.

Class

SpacyEmbeddings

Embeddings by spaCy models.

Class

TakeoffEmbeddingException

Custom exception for interfacing with Takeoff Embedding class.

Class

MissingConsumerGroup

Exception raised when no consumer group is provided on initialization of TitanTakeoffEmbed or in embed request.

Class

Device

Device to use for inference, cuda or cpu.

Class

ReaderConfig

Configuration for the reader to be deployed in Takeoff.

Class

TitanTakeoffEmbed

Interface with Takeoff Inference API for embedding models.

Use it to send embedding requests and to deploy embedding readers with Takeoff.

Class

GradientEmbeddings

Gradient.ai Embedding models.

GradientLLM is a class to interact with Embedding Models on gradient.ai

To use, set the environment variable GRADIENT_ACCESS_TOKEN with your API token and ``GRADIEN

Class

TinyAsyncGradientEmbeddingClient

Deprecated, TinyAsyncGradientEmbeddingClient was removed.

This class is just for backwards compatibility with older versions of langchain_community. It might be entirely removed in the future.

Class

QianfanEmbeddingsEndpoint

Baidu Qianfan Embeddings embedding models.

Class

EmbeddingsContentHandler

Content handler for LLM class.

Class

SagemakerEndpointEmbeddings

Custom Sagemaker Inference Endpoints.

To use, you must supply the endpoint name from your deployed Sagemaker model & the region where it is deployed.

To authenticate, the AWS client uses the followi

Class

ClarifaiEmbeddings

Clarifai embedding models.

To use, you should have the clarifai python package installed, and the environment variable CLARIFAI_PAT set with your personal access token or pass it as a named p

Class

BookendEmbeddings

Bookend AI sentence_transformers embedding models.

Class

AwaEmbeddings

Embedding documents and queries with Awa DB.

Class

IpexLLMBgeEmbeddings

Wrapper around the BGE embedding model with IPEX-LLM optimizations on Intel CPUs and GPUs.

To use, you should have the ipex-llm and sentence_transformers package installed. Refer to `here <ht

Class

OpenVINOEmbeddings

OpenVINO embedding models.

Class

OpenVINOBgeEmbeddings

OpenVNO BGE embedding models.

Class

MiniMaxEmbeddings

MiniMax embedding model integration.

Class

PremAIEmbeddings

Prem's Embedding APIs

Class

AnyscaleEmbeddings

Anyscale Embeddings API.

Class

FastEmbedEmbeddings

Qdrant FastEmbedding models.

FastEmbed is a lightweight, fast, Python library built for embedding generation. See more documentation at:

https://github.com/qdrant/fastembed/
https://qdrant.github

Class

JohnSnowLabsEmbeddings

JohnSnowLabs embedding models

To use, you should have the johnsnowlabs python package installed. Example: .. code-block:: python

    from langchain_community.embeddings.johnsnowlabs impo

Class

EmbaasEmbeddingsPayload

Payload for the Embaas embeddings API.

Class

EmbaasEmbeddings

Embaas's embedding service.

To use, you should have the environment variable EMBAAS_API_KEY set with your API key, or pass it as a named parameter to the constructor.

Class

DeepInfraEmbeddings

Deep Infra's embedding inference service.

To use, you should have the environment variable DEEPINFRA_API_TOKEN set with your API token, or pass it as a named parameter to the constructor. There a

Class

OVHCloudEmbeddings

OVHcloud AI Endpoints Embeddings.

Class

GooglePalmEmbeddings

Google's PaLM Embeddings APIs.

Class

BaichuanTextEmbeddings

Baichuan Text Embedding models.

Class

LaserEmbeddings

LASER Language-Agnostic SEntence Representations. LASER is a Python library developed by the Meta AI Research team and used for creating multilingual sentence embeddings for over 147 languages as of 2

Class

OCIAuthType

OCI authentication types as enumerator.

Class

OCIGenAIEmbeddings

OCI embedding models.

To authenticate, the OCI client uses the methods described in https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm

The authentifcation method

Class

MlflowAIGatewayEmbeddings

MLflow AI Gateway embeddings.

To use, you should have the mlflow[gateway] python package installed. For more information, see https://mlflow.org/docs/latest/gateway/index.html.

Class

GPT4AllEmbeddings

GPT4All embedding models.

To use, you should have the gpt4all python package installed

Class

AscendEmbeddings

Ascend NPU accelerate Embedding model

Please ensure that you have installed CANN and torch_npu.

Example:

from langchain_community.embeddings import AscendEmbeddings model = AscendEmbeddings(model_p

Class

MlflowEmbeddings

Embedding LLMs in MLflow.

To use, you should have the mlflow[genai] python package installed. For more information, see https://mlflow.org/docs/latest/llms/deployments.

Class

MlflowCohereEmbeddings

Cohere embedding LLMs in MLflow.

Class

InfinityEmbeddings

Self-hosted embedding models for infinity package.

See https://github.com/michaelfeil/infinity This also works for text-embeddings-inference and other self-hosted openai-compatible servers.

Infini

Class

TinyAsyncOpenAIInfinityEmbeddingClient

Helper tool to embed Infinity.

It is not a part of Langchain's stable API, direct use discouraged.

Class

MosaicMLInstructorEmbeddings

MosaicML embedding service.

To use, you should have the environment variable MOSAICML_API_TOKEN set with your API token, or pass it as a named parameter to the constructor.

Class

YandexGPTEmbeddings

YandexGPT Embeddings models.

To use, you should have the yandexcloud python package installed.

There are two authentication options for the service account with the ai.languageModels.user ro

Class

HunyuanEmbeddings

Tencent Hunyuan embedding models API by Tencent.

For more information, see https://cloud.tencent.com/document/product/1729

Class

DashScopeEmbeddings

DashScope embedding models.

To use, you should have the dashscope python package installed, and the environment variable DASHSCOPE_API_KEY set with your API key or pass it as a named paramete

Class

InfinityEmbeddingsLocal

Optimized Infinity embedding models.

https://github.com/michaelfeil/infinity This class deploys a local Infinity instance to embed text. The class requires async usage.

Infinity is a class to intera

Class

Url

URL class for parsing the URL.

Class

SparkLLMTextEmbeddings

SparkLLM embedding model integration.

Class

AssembleHeaderException

Exception raised for errors in the header assembly.

Class

XinferenceEmbeddings

Xinference embedding models.

To use, you should have the xinference library installed:

.. code-block:: bash

pip install xinference

If you're simply using the services provided by Xinference, y

Class

AlephAlphaAsymmetricSemanticEmbedding

Aleph Alpha's asymmetric semantic embedding.

AA provides you with an endpoint to embed a document and a query. The models were optimized to make the embeddings of documents and the query for a docume

Class

AlephAlphaSymmetricSemanticEmbedding

Symmetric version of the Aleph Alpha's semantic embeddings.

The main difference is that here, both the documents and queries are embedded with a SemanticRepresentation.Symmetric Example: .. code-

Class

Text2vecEmbeddings

text2vec embedding models.

Install text2vec first, run 'pip install -U text2vec'. The github repository for text2vec is : https://github.com/shibing624/text2vec

Class

JinaEmbeddings

Jina embedding models.

Class

TensorflowHubEmbeddings

TensorflowHub embedding models.

To use, you should have the tensorflow_text python package installed.

Class

DocstoreFn

Docstore via arbitrary lookup function.

Class

Wikipedia

Wikipedia API.

Class

InMemoryDocstore

Simple in memory docstore in the form of a dict.

Class

Docstore

Interface to access to place that stores documents.

Class

AddableMixin

Mixin class that supports adding texts.

Class

GoogleBooksQueryInput

Input for the GoogleBooksQuery tool.

Class

GoogleBooksQueryRun

Tool that searches the Google Books API.

Class

YahooFinanceNewsInput

Input for the YahooFinanceNews tool.

Class

YahooFinanceNewsTool

Tool that searches financial news on Yahoo Finance.

Class

ApiConfig

API Configuration.

Class

AIPlugin

AI Plugin Definition.

Class

AIPluginToolSchema

Schema for AIPluginTool.

Class

AIPluginTool

Tool for getting the OpenAPI spec for an AI Plugin.

Class

IFTTTWebhook

IFTTT Webhook.

Class

HumanInputRun

Tool that asks user for input.

Class

BraveSearch

Tool that queries the BraveSearch.

Api key can be provided as an environment variable BRAVE_SEARCH_API_KEY or as a parameter.

Example usages: .. code-block:: python # uses BRAVE_SEARCH_API_KEY f

Class

ExecPythonInput

Class

ExecPython

Riza Code tool.

Class

ExecJavaScriptInput

Class

ExecJavaScript

A tool implementation to execute JavaScript via Riza's Code Interpreter API.

Class

GitHubAction

Tool for interacting with the GitHub API.

Class

JiraAction

Tool that queries the Atlassian Jira API.

Class

ShellInput

Commands for the Bash Shell tool.

Class

ShellTool

Tool to run shell commands.

Class

BaseSQLDatabaseTool

Base tool for interacting with a SQL database.

Class

QuerySQLDatabaseTool

Tool for querying a SQL database.

.. versionchanged:: 0.3.12

Renamed from QuerySQLDataBaseTool to QuerySQLDatabaseTool.
Legacy name still works for backwards compatibility.

Class

InfoSQLDatabaseTool

Tool for getting metadata about a SQL database.

Class

ListSQLDatabaseTool

Tool for getting tables names.

Class

QuerySQLCheckerTool

Use an LLM to check if a query is correct. Adapted from https://www.patterns.app/blog/2023/01/18/crunchbot-sql-analyst-gpt/

Class

ArxivInput

Input for the Arxiv tool.

Class

ArxivQueryRun

Tool that searches the Arxiv API.

Class

QueryPowerBITool

Tool for querying a Power BI Dataset.

Class

InfoPowerBITool

Tool for getting metadata about a PowerBI Dataset.

Class

ListPowerBITool

Tool for getting tables names.

Class

SearchInput

Input for the AskNews Search tool.

Class

AskNewsSearch

Tool that searches the AskNews API.

Class

BingSearchRun

Tool that queries the Bing search API.

Class

BingSearchResults

Bing Search tool.

Class

GoogleFinanceQueryRun

Tool that queries the Google Finance API.

Class

MojeekSearch

Class

CreateSessionSchema

Input for CreateSessionTool.

Class

MultionCreateSession

Tool that creates a new Multion Browser Window with provided fields.

Class

UpdateSessionSchema

Input for UpdateSessionTool.

Class

MultionUpdateSession

Tool that updates an existing Multion Browser Window with provided fields.

Class

CloseSessionSchema

Input for UpdateSessionTool.

Class

MultionCloseSession

Tool that closes an existing Multion Browser Window with provided fields.

Class

GoogleTrendsQueryRun

Tool that queries the Google trends API.

Class

JinaInput

Input for the Jina search tool.

Class

JinaSearch

Tool that queries the JinaSearch.

..versionadded:: 0.2.16

Class

SemantscholarInput

Input for the SemanticScholar tool.

Class

SemanticScholarQueryRun

Tool that searches the semanticscholar API.

Class

ClickupAction

Tool that queries the Clickup API.

Class

EdenaiTool

the base tool for all the EdenAI Tools . you should have the environment variable EDENAI_API_KEY set with your API token. You can find your token here: https://app.edenai.run/admin/account/setting

Class

TextToSpeechInput

Class

EdenAiTextToSpeechTool

Tool that queries the Eden AI Text to speech API. for api reference check edenai documentation: https://docs.edenai.co/reference/audio_text_to_speech_create.

To use, you should have the environment v

Class

TextModerationInput

Class

EdenAiTextModerationTool

Tool that queries the Eden AI Explicit text detection.

for api reference check edenai documentation: https://docs.edenai.co/reference/image_explicit_content_create.

To use, you should have the envir

Class

SpeechToTextInput

Class

EdenAiSpeechToTextTool

Tool that queries the Eden AI Speech To Text API.

for api reference check edenai documentation: https://app.edenai.run/bricks/speech/asynchronous-speech-to-text.

To use, you should have the environm

Class

ExplicitImageInput

Class

EdenAiExplicitImageTool

Tool that queries the Eden AI Explicit image detection.

for api reference check edenai documentation: https://docs.edenai.co/reference/image_explicit_content_create.

To use, you should have the envi

Class

IDParsingInput

Class

EdenAiParsingIDTool

Tool that queries the Eden AI Identity parsing API.

for api reference check edenai documentation: https://docs.edenai.co/reference/ocr_identity_parser_create.

To use, you should have the environmen

Class

ObjectDetectionInput

Class

EdenAiObjectDetectionTool

Tool that queries the Eden AI Object detection API.

for api reference check edenai documentation: https://docs.edenai.co/reference/image_object_detection_create.

To use, you should have the environm

Class

InvoiceParsingInput

Class

EdenAiParsingInvoiceTool

Tool that queries the Eden AI Invoice parsing API.

for api reference check edenai documentation: https://docs.edenai.co/reference/ocr_invoice_parser_create.

To use, you should have the environment v

Class

SleepInput

Input for CopyFileTool.

Class

SleepTool

Tool that adds the capability to sleep.

Class

NutritionAIInputs

Inputs to the Passio Nutrition AI tool.

Class

NutritionAI

Tool that queries the Passio Nutrition AI API.

Class

BaseSparkSQLTool

Base tool for interacting with Spark SQL.

Class

QuerySparkSQLTool

Tool for querying a Spark SQL.

Class

InfoSparkSQLTool

Tool for getting metadata about a Spark SQL.

Class

ListSparkSQLTool

Tool for getting tables names.

Class

QueryCheckerTool

Use an LLM to check if a query is correct. Adapted from https://www.patterns.app/blog/2023/01/18/crunchbot-sql-analyst-gpt/

Class

TransferSchema

Schema for transfer operations.

Class

AINTransfer

Tool for transfer operations.

Class

ValueSchema

Schema for value operations.

Class

AINValueOps

Tool for value operations.

Class

RuleSchema

Schema for owner operations.

Class

AINOwnerOps

Tool for owner operations.

Class

AppOperationType

Type of app operation as enumerator.

Class

AppSchema

Schema for app operations.

Class

AINAppOps

Tool for app operations.

Class

RuleSchema

Schema for owner operations.

Class

AINRuleOps

Tool for owner operations.

Class

OperationType

Type of operation as enumerator.

Class

AINBaseTool

Base class for the AINetwork tools.

Class

SendMessageSchema

Input for SendMessageTool.

Class

O365SendMessage

Send an email in Office 365.

Class

SendEventSchema

Input for CreateEvent Tool.

Class

O365SendEvent

Tool for sending calendar events in Office 365.

Class

CreateDraftMessageSchema

Input for SendMessageTool.

Class

O365CreateDraftMessage

Tool for creating a draft email in Office 365.

Class

SearchEmailsInput

Input for SearchEmails Tool.

Class

O365SearchEmails

Search email messages in Office 365.

Free, but setup is required.

Class

SearchEventsInput

Input for SearchEmails Tool.

From https://learn.microsoft.com/en-us/graph/search-query-parameter

Class

O365SearchEvents

Search calendar events in Office 365.

Free, but setup is required

Class

O365BaseTool

Base class for the Office 365 tools.

Class

Unparser

Traverse an AST and output source code for the abstract syntax; original formatting is disregarded.

Class

UploadedFile

Description of the uploaded path with its remote path.

Class

E2BDataAnalysisToolArguments

Arguments for the E2BDataAnalysisTool.

Class

E2BDataAnalysisTool

Tool for running python code in a sandboxed environment for data analysis.

Class

JsonSpec

Base class for JSON spec.

Class

JsonListKeysTool

Tool for listing keys in a JSON spec.

Class

JsonGetValueTool

Tool for getting a value in a JSON spec.

Class

OpenWeatherMapQueryRun

Tool that queries the OpenWeatherMap API.

Class

DDGInput

Input for the DuckDuckGo search tool.

Class

DuckDuckGoSearchRun

DuckDuckGo tool.

Class

DuckDuckGoSearchResults

Tool that queries the DuckDuckGo search API and returns the results in output_format.

Class

BaseRequestsTool

Base class for requests tools.

Class

RequestsGetTool

Tool for making a GET request to an API endpoint.

Class

RequestsPostTool

Tool for making a POST request to an API endpoint.

Class

RequestsPatchTool

Tool for making a PATCH request to an API endpoint.

Class

RequestsPutTool

Tool for making a PUT request to an API endpoint.

Class

RequestsDeleteTool

Tool for making a DELETE request to an API endpoint.

Class

ElevenLabsModel

Models available for Eleven Labs Text2Speech.

Class

ElevenLabsModel

Models available for Eleven Labs Text2Speech.

Class

ElevenLabsText2SpeechTool

Tool that queries the Eleven Labs Text2Speech API.

In order to set this up, follow instructions at: https://elevenlabs.io/docs

Class

AzureAiServicesTextToSpeechTool

Tool that queries the Azure AI Services Text to Speech API.

In order to set this up, follow instructions at: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/get-started-text-to-spe

Class

AzureAiServicesDocumentIntelligenceTool

Tool that queries the Azure AI Services Document Intelligence API.

In order to set this up, follow instructions at: https://learn.microsoft.com/en-us/azure/ai-services/document-intelligence/quickstar

Class

AzureAiServicesImageAnalysisTool

Tool that queries the Azure AI Services Image Analysis API.

In order to set this up, follow instructions at: https://learn.microsoft.com/azure/ai-services/computer-vision/quickstarts-sdk/image-analys

Class

AzureAiServicesTextAnalyticsForHealthTool

Tool that queries the Azure AI Services Text Analytics for Health API.

In order to set this up, follow instructions at: https://learn.microsoft.com/en-us/azure/ai-services/language-service/text-analy

Class

AzureAiServicesSpeechToTextTool

Tool that queries the Azure AI Services Speech to Text API.

In order to set this up, follow instructions at: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/get-started-speech-to-t

Class

YouInput

Input schema for the you.com tool.

Class

YouSearchTool

Tool that searches the you.com API.

Class

GoogleLensQueryRun

Tool that queries the Google Lens API.

Class

GoogleJobsQueryRun

Tool that queries the Google Jobs API.

Class

SearchAPIRun

Tool that queries the SearchApi.io search API.

Class

SearchAPIResults

Tool that queries the SearchApi.io search API and returns JSON.

Class

PubmedQueryRun

Tool that searches the PubMed API.

Class

BaseGraphQLTool

Base tool for querying a GraphQL API.

Class

PolygonAggregatesSchema

Input for PolygonAggregates.

Class

PolygonAggregates

Tool that gets aggregate bars (stock prices) over a given date range for a given ticker from Polygon.

Class

Inputs

Inputs for Polygon's Last Quote API

Class

PolygonLastQuote

Tool that gets the last quote of a ticker from Polygon

Class

Inputs

Inputs for Polygon's Financials API

Class

PolygonFinancials

Tool that gets the financials of a ticker from Polygon

Class

Inputs

Inputs for Polygon's Ticker News API

Class

PolygonTickerNews

Tool that gets the latest news for a given ticker from Polygon

Class

TavilyInput

Input for the Tavily tool.

Class

WriteFileInput

Input for WriteFileTool.

Class

WriteFileTool

Tool that writes a file to disk.

Class

FileMoveInput

Input for MoveFileTool.

Class

MoveFileTool

Tool that moves a file.

Functions

Modules

Types

Class

NavigateTool

Tool for navigating a browser to a URL.

Security Note: This tool provides code to control web-browser navigation.

This tool can navigate to any URL, including internal network URLs, and

Class

RecursiveUrlLoader

Recursively load all child links from a root URL.

Security Note: This loader is a crawler that will start crawling at a given URL and then expand to crawl child links recursively.

We

Class

GenericLoader

Generic Document Loader.

A generic document loader that allows combining an arbitrary blob loader with a blob parser.

Examples:

Parse a specific PDF file:

.. code-block:: python

    f

Class

FileSystemBlobLoader

Load blobs in the local file system.

Example:

.. code-block:: python

from langchain_community.document_loaders.blob_loaders import FileSystemBlobLoader
loader = FileSystemBlobLoader("/path/

Class

ZepCloudChatMessageHistory

Chat message history that uses Zep Cloud as a backend.

Recommended usage::

# Set up Zep Chat History
zep_chat_history = ZepChatMessageHistory(
    session_id=session_id,
    api_key=

Class

ZepChatMessageHistory

Chat message history that uses Zep as a backend.

Recommended usage::

# Set up Zep Chat History
zep_chat_history = ZepChatMessageHistory(
    session_id=session_id,
    url=ZEP_API_UR

Class

LLMRequestsChain

Chain that requests a URL and then uses an LLM to parse results.

Security Note: This chain can make GET requests to arbitrary URLs, including internal URLs.

Control access to who can run

Class

LLMonitorCallbackHandler

Callback Handler for LLMonitor`.

Parameters:

- `app_id`: The app id of the app you want to report to. Defaults to
`None`, which means that `LLMONITOR_APP_ID` will be used.
- `api_url

Class

PaiEasEndpoint

Langchain LLM class to help to access eass llm service.

To use this endpoint, must have a deployed eas chat llm service on PAI AliCloud.

One can set the environment variable eas_service_url a

Class

GitHubToolkit

GitHub Toolkit.

Security Note: This toolkit contains tools that can read and modify the state of a service; e.g., by creating, deleting, or updating, reading underlying data.

For examp

Class

JiraToolkit

Jira Toolkit.

Security Note: This toolkit contains tools that can read and modify the state of a service; e.g., by creating, deleting, or updating, reading underlying data.

See https:/

Class

PowerBIToolkit

Toolkit for interacting with Power BI dataset.

Security Note: This toolkit interacts with an external service.

Control access to who can use this toolkit.

Make sure that the capabilities

Class

NLAToolkit

Natural Language API Toolkit.

Security Note: This toolkit creates tools that enable making calls to an Open API compliant API.

The tools created by this toolkit may be able to make GET, PO

Class

GitLabToolkit

GitLab Toolkit.

Security Note: This toolkit contains tools that can read and modify the state of a service; e.g., by creating, deleting, or updating, reading underlying data.

For examp

Class

PlayWrightBrowserToolkit

Toolkit for PlayWright browser tools.

Security Note: This toolkit provides code to control a web-browser.

Careful if exposing this toolkit to end-users. The tools in the toolkit
are capa

Class

RequestsToolkit

Toolkit for making REST requests.

Security Note: This toolkit contains tools to make GET, POST, PATCH, PUT, and DELETE requests to an API.

Exercise care in who is allowed to use this toolk

Class

ChatGooglePalm

Google PaLM Chat models API.

To use you must have the google.generativeai Python package installed and either:

1. The ``GOOGLE_API_KEY`` environment variable set with your API key, or
2. P

Class

ChatSnowflakeCortex

Snowflake Cortex based Chat model

To use the chat model, you must have the snowflake-snowpark-python Python package installed and either:

1. environment variables set with your snowflake cre

Class

PaiEasChatEndpoint

Alibaba Cloud PAI-EAS LLM Service chat model API.

To use, must have a deployed eas chat llm service on AliCloud. One can set the

environment variable eas_service_url and eas_service_token

Class

TavilySearchResults

deprecated

Tool that queries the Tavily Search API and gets back json.

Setup: Install langchain-openai and tavily-python, and set environment variable TAVILY_API_KEY.

.. code-bl

Function

create_openapi_agent

Construct an OpenAPI agent from an LLM and tools.

Security Note: When creating an OpenAPI agent, check the permissions and capabilities of the underlying toolkit.

For example, if the defau

Module

output_parsers

OutputParser classes parse the output of an LLM call.

Class hierarchy:

.. code-block::

BaseLLMOutputParser --> BaseOutputParser --> <name>OutputParser  # GuardrailsOutputParser

**Main

Module

document_loaders

Document Loaders are classes to load Documents.

Document Loaders are usually used to load a lot of Documents in a single run.

Class hierarchy:

.. code-block::

BaseLoader --> <name

Module

chat_message_histories

Chat message history stores a history of the message interactions in a chat.

Class hierarchy:

.. code-block::

BaseChatMessageHistory --> <name>ChatMessageHistory  # Examples: FileChatMe

Module

document_transformers

Document Transformers are classes to transform Documents.

Document Transformers usually used to transform a lot of Documents in a single run.

Class hierarchy:

.. code-block::

BaseD

Menu

langchain-community

Description

Classes

InMemoryCache

FullLLMCache

SQLAlchemyCache

SQLiteCache

UpstashRedisCache

RedisCache

AsyncRedisCache

RedisSemanticCache

GPTCache

MomentoCache

CassandraCache

CassandraSemanticCache

FullMd5LLMCache

SQLAlchemyMd5Cache

AzureCosmosDBSemanticCache

AzureCosmosDBNoSqlSemanticCache

OpenSearchSemanticCache

MemcachedCache

OutputFunctionsParser

JsonOutputFunctionsParser

JsonKeyOutputFunctionsParser

PydanticOutputFunctionsParser

PydanticAttrOutputFunctionsParser

GuardrailsOutputParser

SceneXplainAPIWrapper

Component

Task

CUList

Member

Team

Space

ClickupAPIWrapper

ZapierNLAWrapper

SQLDatabase

GoogleTrendsAPIWrapper

DataForSeoAPIWrapper

BraveSearchWrapper

TensorflowDatasets

WikidataAPIWrapper

WolframAlphaAPIWrapper

HiddenPrints

SerpAPIWrapper

JiraOauth2Token

JiraOauth2

JiraAPIWrapper

InfobipAPIWrapper

GoogleSerperAPIWrapper

TwilioAPIWrapper

WikipediaAPIWrapper

ArceeRoute

DALMFilterType

DALMFilter

ArceeDocumentSource

ArceeDocument

ArceeDocumentAdapter

ArceeWrapper

Portkey

StackExchangeAPIWrapper

OpenWeatherMapAPIWrapper

SetupMode

GoogleBooksAPIWrapper

NasaAPIWrapper

GoogleLensAPIWrapper

AlphaVantageAPIWrapper

HTTPVerb

OpenAPISpec

FinancialDatasetsAPIWrapper

SemanticScholarAPIWrapper

PubMedAPIWrapper

SentinelT

RivaAudioEncoding

RivaAuthMixin

RivaCommonConfigMixin

AudioStream

RivaASR

RivaTTS