id
stringlengths 14
16
| text
stringlengths 20
3.26k
| source
stringlengths 65
181
|
|---|---|---|
5ac1b6cc5af2-33 | document_loaders.parsers.grobid.ServerUnavailableException
Exception raised when the Grobid server is unavailable.
document_loaders.parsers.html.bs4.BS4HTMLParser(*)
Parse HTML files using Beautiful Soup.
document_loaders.parsers.language.c.CSegmenter(code)
Code segmenter for C.
document_loaders.parsers.language.cobol.CobolSegmenter(code)
Code segmenter for COBOL.
document_loaders.parsers.language.code_segmenter.CodeSegmenter(code)
Abstract class for the code segmenter.
document_loaders.parsers.language.cpp.CPPSegmenter(code)
Code segmenter for C++.
document_loaders.parsers.language.csharp.CSharpSegmenter(code)
Code segmenter for C#.
document_loaders.parsers.language.go.GoSegmenter(code)
Code segmenter for Go.
document_loaders.parsers.language.java.JavaSegmenter(code)
Code segmenter for Java.
document_loaders.parsers.language.javascript.JavaScriptSegmenter(code)
Code segmenter for JavaScript.
document_loaders.parsers.language.kotlin.KotlinSegmenter(code)
Code segmenter for Kotlin.
document_loaders.parsers.language.language_parser.LanguageParser([...])
Parse using the respective programming language syntax.
document_loaders.parsers.language.lua.LuaSegmenter(code)
Code segmenter for Lua.
document_loaders.parsers.language.perl.PerlSegmenter(code)
Code segmenter for Perl.
document_loaders.parsers.language.php.PHPSegmenter(code)
Code segmenter for PHP.
document_loaders.parsers.language.python.PythonSegmenter(code)
Code segmenter for Python.
document_loaders.parsers.language.ruby.RubySegmenter(code)
Code segmenter for Ruby.
document_loaders.parsers.language.rust.RustSegmenter(code)
Code segmenter for Rust.
document_loaders.parsers.language.scala.ScalaSegmenter(code)
Code segmenter for Scala. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-34 | document_loaders.parsers.language.scala.ScalaSegmenter(code)
Code segmenter for Scala.
document_loaders.parsers.language.tree_sitter_segmenter.TreeSitterSegmenter(code)
Abstract class for `CodeSegmenter`s that use the tree-sitter library.
document_loaders.parsers.language.typescript.TypeScriptSegmenter(code)
Code segmenter for TypeScript.
document_loaders.parsers.msword.MsWordParser()
Parse the Microsoft Word documents from a blob.
document_loaders.parsers.pdf.AmazonTextractPDFParser([...])
Send PDF files to Amazon Textract and parse them.
document_loaders.parsers.pdf.DocumentIntelligenceParser(...)
Loads a PDF with Azure Document Intelligence (formerly Form Recognizer) and chunks at character level.
document_loaders.parsers.pdf.PDFMinerParser([...])
Parse PDF using PDFMiner.
document_loaders.parsers.pdf.PDFPlumberParser([...])
Parse PDF with PDFPlumber.
document_loaders.parsers.pdf.PyMuPDFParser([...])
Parse PDF using PyMuPDF.
document_loaders.parsers.pdf.PyPDFParser([...])
Load PDF using pypdf
document_loaders.parsers.pdf.PyPDFium2Parser([...])
Parse PDF with PyPDFium2.
document_loaders.parsers.txt.TextParser()
Parser for text blobs.
document_loaders.parsers.vsdx.VsdxParser()
Parser for vsdx files.
document_loaders.pdf.AmazonTextractPDFLoader(...)
Load PDF files from a local file system, HTTP or S3.
document_loaders.pdf.BasePDFLoader(file_path, *)
Base Loader class for PDF files.
document_loaders.pdf.DocumentIntelligenceLoader(...)
Load a PDF with Azure Document Intelligence
document_loaders.pdf.MathpixPDFLoader(file_path)
Load PDF files using Mathpix service.
document_loaders.pdf.OnlinePDFLoader(...[, ...]) | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-35 | document_loaders.pdf.OnlinePDFLoader(...[, ...])
Load online PDF.
document_loaders.pdf.PDFMinerLoader(file_path, *)
Load PDF files using PDFMiner.
document_loaders.pdf.PDFMinerPDFasHTMLLoader(...)
Load PDF files as HTML content using PDFMiner.
document_loaders.pdf.PDFPlumberLoader(file_path)
Load PDF files using pdfplumber.
document_loaders.pdf.PagedPDFSplitter
alias of PyPDFLoader
document_loaders.pdf.PyMuPDFLoader(file_path, *)
Load PDF files using PyMuPDF.
document_loaders.pdf.PyPDFDirectoryLoader(path)
Load a directory with PDF files using pypdf and chunks at character level.
document_loaders.pdf.PyPDFLoader(file_path)
Load PDF using pypdf into list of documents.
document_loaders.pdf.PyPDFium2Loader(...[, ...])
Load PDF using pypdfium2 and chunks at character level.
document_loaders.pdf.UnstructuredPDFLoader(...)
Load PDF files using Unstructured.
document_loaders.pebblo.PebbloSafeLoader(...)
Pebblo Safe Loader class is a wrapper around document loaders enabling the data to be scrutinized.
document_loaders.polars_dataframe.PolarsDataFrameLoader(...)
Load Polars DataFrame.
document_loaders.powerpoint.UnstructuredPowerPointLoader(...)
Load Microsoft PowerPoint files using Unstructured.
document_loaders.psychic.PsychicLoader(...)
Load from Psychic.dev.
document_loaders.pubmed.PubMedLoader(query)
Load from the PubMed biomedical library.
document_loaders.pyspark_dataframe.PySparkDataFrameLoader([...])
Load PySpark DataFrames.
document_loaders.python.PythonLoader(file_path)
Load Python files, respecting any non-default encoding if specified. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-36 | Load Python files, respecting any non-default encoding if specified.
document_loaders.quip.QuipLoader(api_url, ...)
Load Quip pages.
document_loaders.readthedocs.ReadTheDocsLoader(path)
Load ReadTheDocs documentation directory.
document_loaders.recursive_url_loader.RecursiveUrlLoader(url)
Load all child links from a URL page.
document_loaders.reddit.RedditPostsLoader(...)
Load Reddit posts.
document_loaders.roam.RoamLoader(path)
Load Roam files from a directory.
document_loaders.rocksetdb.ColumnNotFoundError(...)
Column not found error.
document_loaders.rocksetdb.RocksetLoader(...)
Load from a Rockset database.
document_loaders.rspace.RSpaceLoader(global_id)
Load content from RSpace notebooks, folders, documents or PDF Gallery files.
document_loaders.rss.RSSFeedLoader([urls, ...])
Load news articles from RSS feeds using Unstructured.
document_loaders.rst.UnstructuredRSTLoader(...)
Load RST files using Unstructured.
document_loaders.rtf.UnstructuredRTFLoader(...)
Load RTF files using Unstructured.
document_loaders.s3_directory.S3DirectoryLoader(bucket)
Load from Amazon AWS S3 directory.
document_loaders.s3_file.S3FileLoader(...[, ...])
Load from Amazon AWS S3 file.
document_loaders.scrapfly.ScrapflyLoader(urls, *)
Turn a url to llm accessible markdown with Scrapfly.io.
document_loaders.sharepoint.SharePointLoader
Load from SharePoint.
document_loaders.sitemap.SitemapLoader(web_path)
Load a sitemap and its URLs.
document_loaders.slack_directory.SlackDirectoryLoader(...)
Load from a Slack directory dump.
document_loaders.snowflake_loader.SnowflakeLoader(...) | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-37 | document_loaders.snowflake_loader.SnowflakeLoader(...)
Load from Snowflake API.
document_loaders.spider.SpiderLoader(url, *)
Load web pages as Documents using Spider AI.
document_loaders.spreedly.SpreedlyLoader(...)
Load from Spreedly API.
document_loaders.sql_database.SQLDatabaseLoader(...)
Load documents by querying database tables supported by SQLAlchemy.
document_loaders.srt.SRTLoader(file_path)
Load .srt (subtitle) files.
document_loaders.stripe.StripeLoader(resource)
Load from Stripe API.
document_loaders.surrealdb.SurrealDBLoader([...])
Load SurrealDB documents.
document_loaders.telegram.TelegramChatApiLoader([...])
Load Telegram chat json directory dump.
document_loaders.telegram.TelegramChatFileLoader(path)
Load from Telegram chat dump.
document_loaders.telegram.TelegramChatLoader
alias of TelegramChatFileLoader
document_loaders.tencent_cos_directory.TencentCOSDirectoryLoader(...)
Load from Tencent Cloud COS directory.
document_loaders.tencent_cos_file.TencentCOSFileLoader(...)
Load from Tencent Cloud COS file.
document_loaders.tensorflow_datasets.TensorflowDatasetLoader(...)
Load from TensorFlow Dataset.
document_loaders.text.TextLoader(file_path)
Load text file.
document_loaders.tidb.TiDBLoader(...[, ...])
Load documents from TiDB.
document_loaders.tomarkdown.ToMarkdownLoader(...)
Load HTML using 2markdown API.
document_loaders.toml.TomlLoader(source)
Load TOML files.
document_loaders.trello.TrelloLoader(client, ...)
Load cards from a Trello board.
document_loaders.tsv.UnstructuredTSVLoader(...)
Load TSV files using Unstructured.
document_loaders.twitter.TwitterTweetLoader(...)
Load Twitter tweets. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-38 | document_loaders.twitter.TwitterTweetLoader(...)
Load Twitter tweets.
document_loaders.unstructured.UnstructuredAPIFileIOLoader(file)
Load files using Unstructured API.
document_loaders.unstructured.UnstructuredAPIFileLoader([...])
Load files using Unstructured API.
document_loaders.unstructured.UnstructuredBaseLoader([...])
Base Loader that uses Unstructured.
document_loaders.unstructured.UnstructuredFileIOLoader(file)
Load files using Unstructured.
document_loaders.unstructured.UnstructuredFileLoader(...)
Load files using Unstructured.
document_loaders.url.UnstructuredURLLoader(urls)
Load files from remote URLs using Unstructured.
document_loaders.url_playwright.PlaywrightEvaluator()
Abstract base class for all evaluators.
document_loaders.url_playwright.PlaywrightURLLoader(urls)
Load HTML pages with Playwright and parse with Unstructured.
document_loaders.url_playwright.UnstructuredHtmlEvaluator([...])
Evaluate the page HTML content using the unstructured library.
document_loaders.url_selenium.SeleniumURLLoader(urls)
Load HTML pages with Selenium and parse with Unstructured.
document_loaders.vsdx.VsdxLoader(file_path)
Initialize with file path.
document_loaders.weather.WeatherDataLoader(...)
Load weather data with Open Weather Map API.
document_loaders.web_base.WebBaseLoader([...])
Load HTML pages using urllib and parse them with `BeautifulSoup'.
document_loaders.whatsapp_chat.WhatsAppChatLoader(path)
Load WhatsApp messages text file.
document_loaders.wikipedia.WikipediaLoader(query)
Load from Wikipedia.
document_loaders.word_document.Docx2txtLoader(...)
Load DOCX file using docx2txt and chunks at character level.
document_loaders.word_document.UnstructuredWordDocumentLoader(...)
Load Microsoft Word file using Unstructured.
document_loaders.xml.UnstructuredXMLLoader(...)
Load XML file using Unstructured. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-39 | document_loaders.xml.UnstructuredXMLLoader(...)
Load XML file using Unstructured.
document_loaders.xorbits.XorbitsLoader(...)
Load Xorbits DataFrame.
document_loaders.youtube.GoogleApiClient([...])
Generic Google API Client.
document_loaders.youtube.GoogleApiYoutubeLoader(...)
Load all Videos from a YouTube Channel.
document_loaders.youtube.TranscriptFormat(value)
Transcript format.
document_loaders.youtube.YoutubeLoader(video_id)
Load YouTube transcripts.
document_loaders.yuque.YuqueLoader(access_token)
Load documents from Yuque.
Functions¶
document_loaders.base_o365.fetch_mime_types(...)
Fetch the mime types for the specified file types.
document_loaders.chatgpt.concatenate_rows(...)
Combine message information in a readable format ready to be used.
document_loaders.facebook_chat.concatenate_rows(row)
Combine message information in a readable format ready to be used.
document_loaders.helpers.detect_file_encodings(...)
Try to detect the file encoding.
document_loaders.notebook.concatenate_cells(...)
Combine cells information in a readable format ready to be used.
document_loaders.notebook.remove_newlines(x)
Recursively remove newlines, no matter the data structure they are stored in.
document_loaders.parsers.pdf.extract_from_images_with_rapidocr(images)
Extract text from images with RapidOCR.
document_loaders.parsers.registry.get_parser(...)
Get a parser by parser name.
document_loaders.rocksetdb.default_joiner(docs)
Default joiner for content columns.
document_loaders.telegram.concatenate_rows(row)
Combine message information in a readable format ready to be used.
document_loaders.telegram.text_to_docs(text)
Convert a string or list of strings to a list of Documents with metadata.
document_loaders.unstructured.get_elements_from_api([...])
Retrieve a list of elements from the Unstructured API. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-40 | Retrieve a list of elements from the Unstructured API.
document_loaders.unstructured.satisfies_min_unstructured_version(...)
Check if the installed Unstructured version exceeds the minimum version for the feature in question.
document_loaders.unstructured.validate_unstructured_version(...)
Raise an error if the Unstructured version does not exceed the specified minimum.
document_loaders.whatsapp_chat.concatenate_rows(...)
Combine message information in a readable format ready to be used.
langchain_community.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:
BaseDocumentTransformer --> <name> # Examples: DoctranQATransformer, DoctranTextTranslator
Main helpers:
Document
Classes¶
document_transformers.beautiful_soup_transformer.BeautifulSoupTransformer()
Transform HTML content by extracting specific tags and removing unwanted ones.
document_transformers.doctran_text_extract.DoctranPropertyExtractor(...)
Extract properties from text documents using doctran.
document_transformers.doctran_text_qa.DoctranQATransformer([...])
Extract QA from text documents using doctran.
document_transformers.doctran_text_translate.DoctranTextTranslator([...])
Translate text documents using doctran.
document_transformers.embeddings_redundant_filter.EmbeddingsClusteringFilter
Perform K-means clustering on document vectors.
document_transformers.embeddings_redundant_filter.EmbeddingsRedundantFilter
Filter that drops redundant documents by comparing their embeddings.
document_transformers.google_translate.GoogleTranslateTransformer(...)
[Deprecated] Translate text documents using Google Cloud Translation.
document_transformers.html2text.Html2TextTransformer([...])
Replace occurrences of a particular search pattern with a replacement string
document_transformers.long_context_reorder.LongContextReorder
Reorder long context. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-41 | document_transformers.long_context_reorder.LongContextReorder
Reorder long context.
document_transformers.markdownify.MarkdownifyTransformer([...])
Converts HTML documents to Markdown format with customizable options for handling links, images, other tags and heading styles using the markdownify library.
document_transformers.nuclia_text_transform.NucliaTextTransformer(nua)
Nuclia Text Transformer.
document_transformers.openai_functions.OpenAIMetadataTagger
Extract metadata tags from document contents using OpenAI functions.
Functions¶
document_transformers.beautiful_soup_transformer.get_navigable_strings(...)
Get all navigable strings from a BeautifulSoup element.
document_transformers.embeddings_redundant_filter.get_stateful_documents(...)
Convert a list of documents to a list of documents with state.
document_transformers.openai_functions.create_metadata_tagger(...)
Create a DocumentTransformer that uses an OpenAI function chain to automatically
langchain_community.embeddings¶
Embedding models are wrappers around embedding models
from different APIs and services.
Embedding models can be LLMs or not.
Class hierarchy:
Embeddings --> <name>Embeddings # Examples: OpenAIEmbeddings, HuggingFaceEmbeddings
Classes¶
embeddings.aleph_alpha.AlephAlphaAsymmetricSemanticEmbedding
Aleph Alpha's asymmetric semantic embedding.
embeddings.aleph_alpha.AlephAlphaSymmetricSemanticEmbedding
Symmetric version of the Aleph Alpha's semantic embeddings.
embeddings.anyscale.AnyscaleEmbeddings
Anyscale Embeddings API.
embeddings.awa.AwaEmbeddings
Embedding documents and queries with Awa DB.
embeddings.azure_openai.AzureOpenAIEmbeddings
[Deprecated] Azure OpenAI Embeddings API.
embeddings.baichuan.BaichuanTextEmbeddings
Baichuan Text Embedding models. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-42 | Baichuan Text Embedding models.
embeddings.baidu_qianfan_endpoint.QianfanEmbeddingsEndpoint
Baidu Qianfan Embeddings embedding models.
embeddings.bedrock.BedrockEmbeddings
Bedrock embedding models.
embeddings.bookend.BookendEmbeddings
Bookend AI sentence_transformers embedding models.
embeddings.clarifai.ClarifaiEmbeddings
Clarifai embedding models.
embeddings.cloudflare_workersai.CloudflareWorkersAIEmbeddings
Cloudflare Workers AI embedding model.
embeddings.clova.ClovaEmbeddings
Clova's embedding service.
embeddings.cohere.CohereEmbeddings
[Deprecated] Cohere embedding models.
embeddings.dashscope.DashScopeEmbeddings
DashScope embedding models.
embeddings.databricks.DatabricksEmbeddings
Databricks embeddings.
embeddings.deepinfra.DeepInfraEmbeddings
Deep Infra's embedding inference service.
embeddings.edenai.EdenAiEmbeddings
EdenAI embedding.
embeddings.elasticsearch.ElasticsearchEmbeddings(...)
[Deprecated] Elasticsearch embedding models.
embeddings.embaas.EmbaasEmbeddings
Embaas's embedding service.
embeddings.embaas.EmbaasEmbeddingsPayload
Payload for the Embaas embeddings API.
embeddings.ernie.ErnieEmbeddings
[Deprecated] Ernie Embeddings V1 embedding models.
embeddings.fake.DeterministicFakeEmbedding
Fake embedding model that always returns the same embedding vector for the same text.
embeddings.fake.FakeEmbeddings
Fake embedding model.
embeddings.fastembed.FastEmbedEmbeddings
Qdrant FastEmbedding models.
embeddings.gigachat.GigaChatEmbeddings
GigaChat Embeddings models.
embeddings.google_palm.GooglePalmEmbeddings
Google's PaLM Embeddings APIs. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-43 | embeddings.google_palm.GooglePalmEmbeddings
Google's PaLM Embeddings APIs.
embeddings.gpt4all.GPT4AllEmbeddings
GPT4All embedding models.
embeddings.gradient_ai.GradientEmbeddings
Gradient.ai Embedding models.
embeddings.gradient_ai.TinyAsyncGradientEmbeddingClient(...)
Deprecated, TinyAsyncGradientEmbeddingClient was removed.
embeddings.huggingface.HuggingFaceBgeEmbeddings
HuggingFace sentence_transformers embedding models.
embeddings.huggingface.HuggingFaceEmbeddings
[Deprecated] HuggingFace sentence_transformers embedding models.
embeddings.huggingface.HuggingFaceInferenceAPIEmbeddings
Embed texts using the HuggingFace API.
embeddings.huggingface.HuggingFaceInstructEmbeddings
Wrapper around sentence_transformers embedding models.
embeddings.huggingface_hub.HuggingFaceHubEmbeddings
[Deprecated] HuggingFaceHub embedding models.
embeddings.infinity.InfinityEmbeddings
Self-hosted embedding models for infinity package.
embeddings.infinity.TinyAsyncOpenAIInfinityEmbeddingClient([...])
Helper tool to embed Infinity.
embeddings.infinity_local.InfinityEmbeddingsLocal
Optimized Infinity embedding models.
embeddings.ipex_llm.IpexLLMBgeEmbeddings
Wrapper around the BGE embedding model with IPEX-LLM optimizations on Intel CPUs and GPUs.
embeddings.itrex.QuantizedBgeEmbeddings
Leverage Itrex runtime to unlock the performance of compressed NLP models.
embeddings.javelin_ai_gateway.JavelinAIGatewayEmbeddings
Javelin AI Gateway embeddings.
embeddings.jina.JinaEmbeddings
Jina embedding models.
embeddings.johnsnowlabs.JohnSnowLabsEmbeddings
JohnSnowLabs embedding models
embeddings.laser.LaserEmbeddings | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-44 | JohnSnowLabs embedding models
embeddings.laser.LaserEmbeddings
LASER Language-Agnostic SEntence Representations.
embeddings.llamacpp.LlamaCppEmbeddings
llama.cpp embedding models.
embeddings.llamafile.LlamafileEmbeddings
Llamafile lets you distribute and run large language models with a single file.
embeddings.llm_rails.LLMRailsEmbeddings
LLMRails embedding models.
embeddings.localai.LocalAIEmbeddings
LocalAI embedding models.
embeddings.minimax.MiniMaxEmbeddings
MiniMax's embedding service.
embeddings.mlflow.MlflowCohereEmbeddings
Cohere embedding LLMs in MLflow.
embeddings.mlflow.MlflowEmbeddings
Embedding LLMs in MLflow.
embeddings.mlflow_gateway.MlflowAIGatewayEmbeddings
MLflow AI Gateway embeddings.
embeddings.modelscope_hub.ModelScopeEmbeddings
ModelScopeHub embedding models.
embeddings.mosaicml.MosaicMLInstructorEmbeddings
MosaicML embedding service.
embeddings.nemo.NeMoEmbeddings
[Deprecated] NeMo embedding models.
embeddings.nlpcloud.NLPCloudEmbeddings
NLP Cloud embedding models.
embeddings.oci_generative_ai.OCIAuthType(value)
OCI authentication types as enumerator.
embeddings.oci_generative_ai.OCIGenAIEmbeddings
OCI embedding models.
embeddings.octoai_embeddings.OctoAIEmbeddings
OctoAI Compute Service embedding models.
embeddings.ollama.OllamaEmbeddings
Ollama locally runs large language models.
embeddings.openai.OpenAIEmbeddings
[Deprecated] OpenAI embedding models.
embeddings.openvino.OpenVINOBgeEmbeddings
OpenVNO BGE embedding models. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-45 | OpenVNO BGE embedding models.
embeddings.openvino.OpenVINOEmbeddings
OpenVINO embedding models.
embeddings.optimum_intel.QuantizedBiEncoderEmbeddings
Quantized bi-encoders embedding models.
embeddings.oracleai.OracleEmbeddings
Get Embeddings
embeddings.premai.PremAIEmbeddings
Prem's Embedding APIs
embeddings.sagemaker_endpoint.EmbeddingsContentHandler()
Content handler for LLM class.
embeddings.sagemaker_endpoint.SagemakerEndpointEmbeddings
Custom Sagemaker Inference Endpoints.
embeddings.sambanova.SambaStudioEmbeddings
SambaNova embedding models.
embeddings.self_hosted.SelfHostedEmbeddings
Custom embedding models on self-hosted remote hardware.
embeddings.self_hosted_hugging_face.SelfHostedHuggingFaceEmbeddings
HuggingFace embedding models on self-hosted remote hardware.
embeddings.self_hosted_hugging_face.SelfHostedHuggingFaceInstructEmbeddings
HuggingFace InstructEmbedding models on self-hosted remote hardware.
embeddings.solar.SolarEmbeddings
[Deprecated] Solar's embedding service.
embeddings.spacy_embeddings.SpacyEmbeddings
Embeddings by spaCy models.
embeddings.sparkllm.AssembleHeaderException(msg)
Exception raised for errors in the header assembly.
embeddings.sparkllm.SparkLLMTextEmbeddings
SparkLLM Text Embedding models.
embeddings.sparkllm.Url(host, path, schema)
embeddings.tensorflow_hub.TensorflowHubEmbeddings
TensorflowHub embedding models.
embeddings.text2vec.Text2vecEmbeddings
text2vec embedding models.
embeddings.titan_takeoff.Device(value)
Device to use for inference, cuda or cpu.
embeddings.titan_takeoff.MissingConsumerGroup | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-46 | embeddings.titan_takeoff.MissingConsumerGroup
Exception raised when no consumer group is provided on initialization of TitanTakeoffEmbed or in embed request.
embeddings.titan_takeoff.ReaderConfig
Configuration for the reader to be deployed in Takeoff.
embeddings.titan_takeoff.TakeoffEmbeddingException
Custom exception for interfacing with Takeoff Embedding class.
embeddings.titan_takeoff.TitanTakeoffEmbed([...])
Interface with Takeoff Inference API for embedding models.
embeddings.vertexai.VertexAIEmbeddings
[Deprecated] Google Cloud VertexAI embedding models.
embeddings.volcengine.VolcanoEmbeddings
Volcengine Embeddings embedding models.
embeddings.voyageai.VoyageEmbeddings
[Deprecated] Voyage embedding models.
embeddings.xinference.XinferenceEmbeddings([...])
Xinference embedding models.
embeddings.yandex.YandexGPTEmbeddings
YandexGPT Embeddings models.
Functions¶
embeddings.dashscope.embed_with_retry(...)
Use tenacity to retry the embedding call.
embeddings.google_palm.embed_with_retry(...)
Use tenacity to retry the completion call.
embeddings.jina.get_bytes_str(file_path)
embeddings.jina.is_local(url)
embeddings.localai.async_embed_with_retry(...)
Use tenacity to retry the embedding call.
embeddings.localai.embed_with_retry(...)
Use tenacity to retry the embedding call.
embeddings.minimax.embed_with_retry(...)
Use tenacity to retry the completion call.
embeddings.nemo.is_endpoint_live(url, ...)
Check if an endpoint is live by sending a GET request to the specified URL.
embeddings.openai.async_embed_with_retry(...)
Use tenacity to retry the embedding call.
embeddings.openai.embed_with_retry(...)
Use tenacity to retry the embedding call. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-47 | embeddings.openai.embed_with_retry(...)
Use tenacity to retry the embedding call.
embeddings.premai.create_prem_retry_decorator(...)
Create a retry decorator for PremAIEmbeddings.
embeddings.premai.embed_with_retry(embedder, ...)
Using tenacity for retry in embedding calls
embeddings.self_hosted_hugging_face.load_embedding_model(...)
Load the embedding model.
embeddings.solar.embed_with_retry(...)
Use tenacity to retry the completion call.
embeddings.voyageai.embed_with_retry(...)
Use tenacity to retry the embedding call.
langchain_community.example_selectors¶
Example selector implements logic for selecting examples to include them
in prompts.
This allows us to select examples that are most relevant to the input.
There could be multiple strategies for selecting examples. For example, one could
select examples based on the similarity of the input to the examples. Another
strategy could be to select examples based on the diversity of the examples.
Classes¶
example_selectors.ngram_overlap.NGramOverlapExampleSelector
Select and order examples based on ngram overlap score (sentence_bleu score from NLTK package).
Functions¶
example_selectors.ngram_overlap.ngram_overlap_score(...)
Compute ngram overlap score of source and example as sentence_bleu score from NLTK package.
langchain_community.graphs¶
Graphs provide a natural language interface to graph databases.
Classes¶
graphs.age_graph.AGEGraph(graph_name, conf)
Apache AGE wrapper for graph operations.
graphs.age_graph.AGEQueryException(exception)
Exception for the AGE queries.
graphs.arangodb_graph.ArangoGraph(db)
ArangoDB wrapper for graph operations.
graphs.falkordb_graph.FalkorDBGraph(database)
FalkorDB wrapper for graph operations.
graphs.graph_document.GraphDocument
Represents a graph document consisting of nodes and relationships. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-48 | graphs.graph_document.GraphDocument
Represents a graph document consisting of nodes and relationships.
graphs.graph_document.Node
Represents a node in a graph with associated properties.
graphs.graph_document.Relationship
Represents a directed relationship between two nodes in a graph.
graphs.graph_store.GraphStore()
Abstract class for graph operations.
graphs.gremlin_graph.GremlinGraph([url, ...])
Gremlin wrapper for graph operations.
graphs.hugegraph.HugeGraph([username, ...])
HugeGraph wrapper for graph operations.
graphs.index_creator.GraphIndexCreator
Functionality to create graph index.
graphs.kuzu_graph.KuzuGraph(db[, database])
Kùzu wrapper for graph operations.
graphs.memgraph_graph.MemgraphGraph(url, ...)
Memgraph wrapper for graph operations.
graphs.nebula_graph.NebulaGraph(space[, ...])
NebulaGraph wrapper for graph operations.
graphs.neo4j_graph.Neo4jGraph([url, ...])
Neo4j database wrapper for various graph operations.
graphs.neptune_graph.BaseNeptuneGraph()
Abstract base class for Neptune
graphs.neptune_graph.NeptuneAnalyticsGraph(...)
Neptune Analytics wrapper for graph operations.
graphs.neptune_graph.NeptuneGraph(host[, ...])
Neptune wrapper for graph operations.
graphs.neptune_graph.NeptuneQueryException(...)
Exception for the Neptune queries.
graphs.neptune_rdf_graph.NeptuneRdfGraph(host)
Neptune wrapper for RDF graph operations.
graphs.networkx_graph.KnowledgeTriple(...)
Knowledge triple in the graph.
graphs.networkx_graph.NetworkxEntityGraph([graph])
Networkx wrapper for entity graph operations.
graphs.ontotext_graphdb_graph.OntotextGraphDBGraph(...) | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-49 | graphs.ontotext_graphdb_graph.OntotextGraphDBGraph(...)
Ontotext GraphDB https://graphdb.ontotext.com/ wrapper for graph operations.
graphs.rdf_graph.RdfGraph([source_file, ...])
RDFlib wrapper for graph operations.
graphs.tigergraph_graph.TigerGraph(conn)
TigerGraph wrapper for graph operations.
Functions¶
graphs.arangodb_graph.get_arangodb_client([...])
Get the Arango DB client from credentials.
graphs.neo4j_graph.clean_string_values(text)
graphs.neo4j_graph.value_sanitize(d)
Sanitize the input dictionary or list.
graphs.networkx_graph.get_entities(entity_str)
Extract entities from entity string.
graphs.networkx_graph.parse_triples(...)
Parse knowledge triples from the knowledge string.
langchain_community.indexes¶
Index is used to avoid writing duplicated content
into the vectostore and to avoid over-writing content if it’s unchanged.
Indexes also :
Create knowledge graphs from data.
Support indexing workflows from LangChain data loaders to vectorstores.
Importantly, Index keeps on working even if the content being written is derived
via a set of transformations from some source content (e.g., indexing children
documents that were derived from parent documents by chunking.)
Classes¶
indexes.base.RecordManager(namespace)
Abstract base class for a record manager.
langchain_community.llms¶
LLM classes provide
access to the large language model (LLM) APIs and services.
Class hierarchy:
BaseLanguageModel --> BaseLLM --> LLM --> <name> # Examples: AI21, HuggingFaceHub, OpenAI
Main helpers:
LLMResult, PromptValue,
CallbackManagerForLLMRun, AsyncCallbackManagerForLLMRun,
CallbackManager, AsyncCallbackManager,
AIMessage, BaseMessage
Classes¶ | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-50 | CallbackManager, AsyncCallbackManager,
AIMessage, BaseMessage
Classes¶
llms.ai21.AI21
AI21 large language models.
llms.ai21.AI21PenaltyData
Parameters for AI21 penalty data.
llms.aleph_alpha.AlephAlpha
Aleph Alpha large language models.
llms.amazon_api_gateway.AmazonAPIGateway
Amazon API Gateway to access LLM models hosted on AWS.
llms.amazon_api_gateway.ContentHandlerAmazonAPIGateway()
Adapter to prepare the inputs from Langchain to a format that LLM model expects.
llms.anthropic.Anthropic
[Deprecated] Anthropic large language models.
llms.anyscale.Anyscale
Anyscale large language models.
llms.aphrodite.Aphrodite
Aphrodite language model.
llms.arcee.Arcee
Arcee's Domain Adapted Language Models (DALMs).
llms.aviary.Aviary
Aviary hosted models.
llms.aviary.AviaryBackend(backend_url, bearer)
Aviary backend.
llms.azureml_endpoint.AzureMLBaseEndpoint
Azure ML Online Endpoint models.
llms.azureml_endpoint.AzureMLEndpointApiType(value)
Azure ML endpoints API types.
llms.azureml_endpoint.AzureMLEndpointClient(...)
AzureML Managed Endpoint client.
llms.azureml_endpoint.AzureMLOnlineEndpoint
Azure ML Online Endpoint models.
llms.azureml_endpoint.ContentFormatterBase()
Transform request and response of AzureML endpoint to match with required schema.
llms.azureml_endpoint.CustomOpenAIContentFormatter()
Content formatter for models that use the OpenAI like API scheme.
llms.azureml_endpoint.DollyContentFormatter()
Content handler for the Dolly-v2-12b model
llms.azureml_endpoint.GPT2ContentFormatter()
Content handler for GPT2 | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-51 | llms.azureml_endpoint.GPT2ContentFormatter()
Content handler for GPT2
llms.azureml_endpoint.HFContentFormatter()
Content handler for LLMs from the HuggingFace catalog.
llms.azureml_endpoint.LlamaContentFormatter()
Deprecated: Kept for backwards compatibility
llms.azureml_endpoint.OSSContentFormatter()
Deprecated: Kept for backwards compatibility
llms.baichuan.BaichuanLLM
Baichuan large language models.
llms.baidu_qianfan_endpoint.QianfanLLMEndpoint
Baidu Qianfan hosted open source or customized models.
llms.bananadev.Banana
Banana large language models.
llms.baseten.Baseten
Baseten model
llms.beam.Beam
Beam API for gpt2 large language model.
llms.bedrock.Bedrock
[Deprecated] Bedrock models.
llms.bedrock.BedrockBase
Base class for Bedrock models.
llms.bedrock.LLMInputOutputAdapter()
Adapter class to prepare the inputs from Langchain to a format that LLM model expects.
llms.bigdl_llm.BigdlLLM
Wrapper around the BigdlLLM model
llms.bittensor.NIBittensorLLM
NIBittensor LLMs
llms.cerebriumai.CerebriumAI
CerebriumAI large language models.
llms.chatglm.ChatGLM
ChatGLM LLM service.
llms.chatglm3.ChatGLM3
ChatGLM3 LLM service.
llms.clarifai.Clarifai
Clarifai large language models.
llms.cloudflare_workersai.CloudflareWorkersAI
Cloudflare Workers AI service.
llms.cohere.BaseCohere
[Deprecated] Base class for Cohere models. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-52 | [Deprecated] Base class for Cohere models.
llms.cohere.Cohere
[Deprecated] Cohere large language models.
llms.ctransformers.CTransformers
C Transformers LLM models.
llms.ctranslate2.CTranslate2
CTranslate2 language model.
llms.databricks.Databricks
Databricks serving endpoint or a cluster driver proxy app for LLM.
llms.deepinfra.DeepInfra
DeepInfra models.
llms.deepsparse.DeepSparse
Neural Magic DeepSparse LLM interface.
llms.edenai.EdenAI
EdenAI models.
llms.exllamav2.ExLlamaV2
ExllamaV2 API.
llms.fake.FakeListLLM
Fake LLM for testing purposes.
llms.fake.FakeStreamingListLLM
Fake streaming list LLM for testing purposes.
llms.fireworks.Fireworks
[Deprecated] Fireworks models.
llms.forefrontai.ForefrontAI
ForefrontAI large language models.
llms.friendli.BaseFriendli
Base class of Friendli.
llms.friendli.Friendli
Friendli LLM.
llms.gigachat.GigaChat
GigaChat large language models API.
llms.google_palm.GooglePalm
[Deprecated] DEPRECATED: Use langchain_google_genai.GoogleGenerativeAI instead.
llms.gooseai.GooseAI
GooseAI large language models.
llms.gpt4all.GPT4All
GPT4All language models.
llms.gradient_ai.GradientLLM
Gradient.ai LLM Endpoints.
llms.gradient_ai.TrainResult
Train result.
llms.huggingface_endpoint.HuggingFaceEndpoint
[Deprecated] HuggingFace Endpoint.
llms.huggingface_hub.HuggingFaceHub | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-53 | [Deprecated] HuggingFace Endpoint.
llms.huggingface_hub.HuggingFaceHub
[Deprecated] HuggingFaceHub models.
llms.huggingface_pipeline.HuggingFacePipeline
[Deprecated] HuggingFace Pipeline API.
llms.huggingface_text_gen_inference.HuggingFaceTextGenInference
[Deprecated] HuggingFace text generation API.
llms.human.HumanInputLLM
User input as the response.
llms.ipex_llm.IpexLLM
IpexLLM model.
llms.javelin_ai_gateway.JavelinAIGateway
Javelin AI Gateway LLMs.
llms.javelin_ai_gateway.Params
Parameters for the Javelin AI Gateway LLM.
llms.koboldai.KoboldApiLLM
Kobold API language model.
llms.konko.Konko
Konko AI models.
llms.layerup_security.LayerupSecurity
Layerup Security LLM service.
llms.llamacpp.LlamaCpp
llama.cpp model.
llms.llamafile.Llamafile
Llamafile lets you distribute and run large language models with a single file.
llms.manifest.ManifestWrapper
HazyResearch's Manifest library.
llms.minimax.Minimax
Minimax large language models.
llms.minimax.MinimaxCommon
Common parameters for Minimax large language models.
llms.mlflow.Mlflow
MLflow LLM service.
llms.mlflow_ai_gateway.MlflowAIGateway
MLflow AI Gateway LLMs.
llms.mlflow_ai_gateway.Params
Parameters for the MLflow AI Gateway LLM.
llms.mlx_pipeline.MLXPipeline
MLX Pipeline API.
llms.modal.Modal
Modal large language models.
llms.moonshot.Moonshot | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-54 | Modal large language models.
llms.moonshot.Moonshot
Moonshot large language models.
llms.moonshot.MoonshotCommon
Common parameters for Moonshot LLMs.
llms.mosaicml.MosaicML
MosaicML LLM service.
llms.nlpcloud.NLPCloud
NLPCloud large language models.
llms.oci_data_science_model_deployment_endpoint.OCIModelDeploymentLLM
Base class for LLM deployed on OCI Data Science Model Deployment.
llms.oci_data_science_model_deployment_endpoint.OCIModelDeploymentTGI
OCI Data Science Model Deployment TGI Endpoint.
llms.oci_data_science_model_deployment_endpoint.OCIModelDeploymentVLLM
VLLM deployed on OCI Data Science Model Deployment
llms.oci_generative_ai.OCIAuthType(value)
OCI authentication types as enumerator.
llms.oci_generative_ai.OCIGenAI
OCI large language models.
llms.oci_generative_ai.OCIGenAIBase
Base class for OCI GenAI models
llms.octoai_endpoint.OctoAIEndpoint
OctoAI LLM Endpoints - OpenAI compatible.
llms.ollama.Ollama
Ollama locally runs large language models.
llms.ollama.OllamaEndpointNotFoundError
Raised when the Ollama endpoint is not found.
llms.opaqueprompts.OpaquePrompts
LLM that uses OpaquePrompts to sanitize prompts.
llms.openai.AzureOpenAI
[Deprecated] Azure-specific OpenAI large language models.
llms.openai.BaseOpenAI
Base OpenAI large language model class.
llms.openai.OpenAI
[Deprecated] OpenAI large language models.
llms.openai.OpenAIChat
[Deprecated] OpenAI Chat large language models. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-55 | llms.openai.OpenAIChat
[Deprecated] OpenAI Chat large language models.
llms.openllm.IdentifyingParams
Parameters for identifying a model as a typed dict.
llms.openllm.OpenLLM
OpenLLM, supporting both in-process model instance and remote OpenLLM servers.
llms.openlm.OpenLM
OpenLM models.
llms.pai_eas_endpoint.PaiEasEndpoint
Langchain LLM class to help to access eass llm service.
llms.petals.Petals
Petals Bloom models.
llms.pipelineai.PipelineAI
PipelineAI large language models.
llms.predibase.Predibase
Use your Predibase models with Langchain.
llms.predictionguard.PredictionGuard
Prediction Guard large language models.
llms.promptlayer_openai.PromptLayerOpenAI
PromptLayer OpenAI large language models.
llms.promptlayer_openai.PromptLayerOpenAIChat
PromptLayer OpenAI large language models.
llms.replicate.Replicate
Replicate models.
llms.rwkv.RWKV
RWKV language models.
llms.sagemaker_endpoint.ContentHandlerBase()
Handler class to transform input from LLM to a format that SageMaker endpoint expects.
llms.sagemaker_endpoint.LLMContentHandler()
Content handler for LLM class.
llms.sagemaker_endpoint.LineIterator(stream)
Parse the byte stream input.
llms.sagemaker_endpoint.SagemakerEndpoint
Sagemaker Inference Endpoint models.
llms.sambanova.SSEndpointHandler(host_url, ...)
SambaNova Systems Interface for SambaStudio model endpoints.
llms.sambanova.SVEndpointHandler(host_url)
SambaNova Systems Interface for Sambaverse endpoint.
llms.sambanova.SambaStudio | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-56 | llms.sambanova.SambaStudio
SambaStudio large language models.
llms.sambanova.Sambaverse
Sambaverse large language models.
llms.self_hosted.SelfHostedPipeline
Model inference on self-hosted remote hardware.
llms.self_hosted_hugging_face.SelfHostedHuggingFaceLLM
HuggingFace Pipeline API to run on self-hosted remote hardware.
llms.solar.Solar
Solar large language models.
llms.solar.SolarCommon
Common configuration for Solar LLMs.
llms.sparkllm.SparkLLM
iFlyTek Spark large language model.
llms.stochasticai.StochasticAI
StochasticAI large language models.
llms.symblai_nebula.Nebula
Nebula Service models.
llms.textgen.TextGen
Text generation models from WebUI.
llms.titan_takeoff.Device(value)
The device to use for inference, cuda or cpu
llms.titan_takeoff.ReaderConfig
Configuration for the reader to be deployed in Titan Takeoff API.
llms.titan_takeoff.TitanTakeoff
Titan Takeoff API LLMs.
llms.together.Together
[Deprecated] LLM models from Together.
llms.tongyi.Tongyi
Tongyi Qwen large language models.
llms.vertexai.VertexAI
[Deprecated] Google Vertex AI large language models.
llms.vertexai.VertexAIModelGarden
[Deprecated] Vertex AI Model Garden large language models.
llms.vllm.VLLM
VLLM language model.
llms.vllm.VLLMOpenAI
vLLM OpenAI-compatible API client
llms.volcengine_maas.VolcEngineMaasBase
Base class for VolcEngineMaas models. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-57 | Base class for VolcEngineMaas models.
llms.volcengine_maas.VolcEngineMaasLLM
volc engine maas hosts a plethora of models.
llms.watsonxllm.WatsonxLLM
[Deprecated] IBM watsonx.ai large language models.
llms.weight_only_quantization.WeightOnlyQuantPipeline
Weight only quantized model.
llms.writer.Writer
Writer large language models.
llms.xinference.Xinference
Xinference large-scale model inference service.
llms.yandex.YandexGPT
Yandex large language models.
llms.yuan2.Yuan2
Yuan2.0 language models.
Functions¶
llms.anyscale.create_llm_result(choices, ...)
Create the LLMResult from the choices and prompts.
llms.anyscale.update_token_usage(keys, ...)
Update token usage.
llms.aviary.get_completions(model, prompt[, ...])
Get completions from Aviary models.
llms.aviary.get_models()
List available models
llms.cohere.acompletion_with_retry(llm, **kwargs)
Use tenacity to retry the completion call.
llms.cohere.completion_with_retry(llm, **kwargs)
Use tenacity to retry the completion call.
llms.databricks.get_default_api_token()
Get the default Databricks personal access token.
llms.databricks.get_default_host()
Get the default Databricks workspace hostname.
llms.databricks.get_repl_context()
Get the notebook REPL context if running inside a Databricks notebook.
llms.fireworks.acompletion_with_retry(llm, ...)
Use tenacity to retry the completion call.
llms.fireworks.acompletion_with_retry_batching(...) | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-58 | llms.fireworks.acompletion_with_retry_batching(...)
Use tenacity to retry the completion call.
llms.fireworks.acompletion_with_retry_streaming(...)
Use tenacity to retry the completion call for streaming.
llms.fireworks.completion_with_retry(llm, ...)
Use tenacity to retry the completion call.
llms.fireworks.completion_with_retry_batching(...)
Use tenacity to retry the completion call.
llms.fireworks.conditional_decorator(...)
Conditionally apply a decorator.
llms.google_palm.completion_with_retry(llm, ...)
Use tenacity to retry the completion call.
llms.koboldai.clean_url(url)
Remove trailing slash and /api from url if present.
llms.layerup_security.default_guardrail_violation_handler(...)
Default guardrail violation handler.
llms.loading.load_llm(file, **kwargs)
Load LLM from a file.
llms.loading.load_llm_from_config(config, ...)
Load LLM from Config Dict.
llms.openai.acompletion_with_retry(llm[, ...])
Use tenacity to retry the async completion call.
llms.openai.completion_with_retry(llm[, ...])
Use tenacity to retry the completion call.
llms.openai.update_token_usage(keys, ...)
Update token usage.
llms.symblai_nebula.completion_with_retry(...)
Use tenacity to retry the completion call.
llms.symblai_nebula.make_request(self, prompt)
Generate text from the model.
llms.tongyi.agenerate_with_last_element_mark(...)
Generate elements from an async iterable, and a boolean indicating if it is the last element.
llms.tongyi.astream_generate_with_retry(llm, ...)
Async version of stream_generate_with_retry. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-59 | Async version of stream_generate_with_retry.
llms.tongyi.check_response(resp)
Check the response from the completion call.
llms.tongyi.generate_with_last_element_mark(...)
Generate elements from an iterable, and a boolean indicating if it is the last element.
llms.tongyi.generate_with_retry(llm, **kwargs)
Use tenacity to retry the completion call.
llms.tongyi.stream_generate_with_retry(llm, ...)
Use tenacity to retry the completion call.
llms.utils.enforce_stop_tokens(text, stop)
Cut off the text as soon as any stop words occur.
llms.vertexai.acompletion_with_retry(llm, prompt)
Use tenacity to retry the completion call.
llms.vertexai.completion_with_retry(llm, prompt)
Use tenacity to retry the completion call.
llms.vertexai.is_codey_model(model_name)
Return True if the model name is a Codey model.
llms.vertexai.is_gemini_model(model_name)
Return True if the model name is a Gemini model.
llms.yandex.acompletion_with_retry(llm, **kwargs)
Use tenacity to retry the async completion call.
llms.yandex.completion_with_retry(llm, **kwargs)
Use tenacity to retry the completion call.
langchain_community.memory¶
Classes¶
memory.kg.ConversationKGMemory
Knowledge graph conversation memory.
memory.motorhead_memory.MotorheadMemory
Chat message memory backed by Motorhead service.
memory.zep_cloud_memory.ZepCloudMemory()
memory.zep_memory.ZepMemory
Persist your chain history to the Zep MemoryStore.
langchain_community.output_parsers¶
OutputParser classes parse the output of an LLM call.
Class hierarchy: | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-60 | OutputParser classes parse the output of an LLM call.
Class hierarchy:
BaseLLMOutputParser --> BaseOutputParser --> <name>OutputParser # GuardrailsOutputParser
Main helpers:
Serializable, Generation, PromptValue
Classes¶
output_parsers.ernie_functions.JsonKeyOutputFunctionsParser
Parse an output as the element of the Json object.
output_parsers.ernie_functions.JsonOutputFunctionsParser
Parse an output as the Json object.
output_parsers.ernie_functions.OutputFunctionsParser
Parse an output that is one of sets of values.
output_parsers.ernie_functions.PydanticAttrOutputFunctionsParser
Parse an output as an attribute of a pydantic object.
output_parsers.ernie_functions.PydanticOutputFunctionsParser
Parse an output as a pydantic object.
output_parsers.rail_parser.GuardrailsOutputParser
Parse the output of an LLM call using Guardrails.
langchain_community.query_constructors¶
Classes¶
query_constructors.astradb.AstraDBTranslator()
Translate AstraDB internal query language elements to valid filters.
query_constructors.chroma.ChromaTranslator()
Translate Chroma internal query language elements to valid filters.
query_constructors.dashvector.DashvectorTranslator()
Logic for converting internal query language elements to valid filters.
query_constructors.databricks_vector_search.DatabricksVectorSearchTranslator()
Translate Databricks vector search internal query language elements to valid filters.
query_constructors.deeplake.DeepLakeTranslator()
Translate DeepLake internal query language elements to valid filters.
query_constructors.dingo.DingoDBTranslator()
Translate DingoDB internal query language elements to valid filters.
query_constructors.elasticsearch.ElasticsearchTranslator()
Translate Elasticsearch internal query language elements to valid filters.
query_constructors.milvus.MilvusTranslator() | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-61 | query_constructors.milvus.MilvusTranslator()
Translate Milvus internal query language elements to valid filters.
query_constructors.mongodb_atlas.MongoDBAtlasTranslator()
Translate Mongo internal query language elements to valid filters.
query_constructors.myscale.MyScaleTranslator([...])
Translate MyScale internal query language elements to valid filters.
query_constructors.opensearch.OpenSearchTranslator()
Translate OpenSearch internal query domain-specific language elements to valid filters.
query_constructors.pgvector.PGVectorTranslator()
Translate PGVector internal query language elements to valid filters.
query_constructors.pinecone.PineconeTranslator()
Translate Pinecone internal query language elements to valid filters.
query_constructors.qdrant.QdrantTranslator(...)
Translate Qdrant internal query language elements to valid filters.
query_constructors.redis.RedisTranslator(schema)
Visitor for translating structured queries to Redis filter expressions.
query_constructors.supabase.SupabaseVectorTranslator()
Translate Langchain filters to Supabase PostgREST filters.
query_constructors.tencentvectordb.TencentVectorDBTranslator([...])
Translate StructuredQuery to Tencent VectorDB query.
query_constructors.timescalevector.TimescaleVectorTranslator()
Translate the internal query language elements to valid filters.
query_constructors.vectara.VectaraTranslator()
Translate Vectara internal query language elements to valid filters.
query_constructors.weaviate.WeaviateTranslator()
Translate Weaviate internal query language elements to valid filters.
Functions¶
query_constructors.deeplake.can_cast_to_float(string)
Check if a string can be cast to a float.
query_constructors.milvus.process_value(...)
Convert a value to a string and add double quotes if it is a string.
query_constructors.vectara.process_value(value) | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-62 | query_constructors.vectara.process_value(value)
Convert a value to a string and add single quotes if it is a string.
langchain_community.retrievers¶
Retriever class returns Documents given a text query.
It is more general than a vector store. A retriever does not need to be able to
store documents, only to return (or retrieve) it. Vector stores can be used as
the backbone of a retriever, but there are other types of retrievers as well.
Class hierarchy:
BaseRetriever --> <name>Retriever # Examples: ArxivRetriever, MergerRetriever
Main helpers:
Document, Serializable, Callbacks,
CallbackManagerForRetrieverRun, AsyncCallbackManagerForRetrieverRun
Classes¶
retrievers.arcee.ArceeRetriever
Arcee Domain Adapted Language Models (DALMs) retriever.
retrievers.arxiv.ArxivRetriever
Arxiv retriever.
retrievers.asknews.AskNewsRetriever
AskNews retriever.
retrievers.azure_ai_search.AzureAISearchRetriever
Azure AI Search service retriever.
retrievers.azure_ai_search.AzureCognitiveSearchRetriever
Azure Cognitive Search service retriever.
retrievers.bedrock.AmazonKnowledgeBasesRetriever
Amazon Bedrock Knowledge Bases retrieval.
retrievers.bedrock.RetrievalConfig
Configuration for retrieval.
retrievers.bedrock.VectorSearchConfig
Configuration for vector search.
retrievers.bm25.BM25Retriever
BM25 retriever without Elasticsearch.
retrievers.breebs.BreebsRetriever
A retriever class for Breebs.
retrievers.chaindesk.ChaindeskRetriever
Chaindesk API retriever. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-63 | retrievers.chaindesk.ChaindeskRetriever
Chaindesk API retriever.
retrievers.chatgpt_plugin_retriever.ChatGPTPluginRetriever
ChatGPT plugin retriever.
retrievers.cohere_rag_retriever.CohereRagRetriever
[Deprecated] Cohere Chat API with RAG.
retrievers.databerry.DataberryRetriever
Databerry API retriever.
retrievers.docarray.DocArrayRetriever
DocArray Document Indices retriever.
retrievers.docarray.SearchType(value)
Enumerator of the types of search to perform.
retrievers.dria_index.DriaRetriever
Dria retriever using the DriaAPIWrapper.
retrievers.elastic_search_bm25.ElasticSearchBM25Retriever
Elasticsearch retriever that uses BM25.
retrievers.embedchain.EmbedchainRetriever
Embedchain retriever.
retrievers.google_cloud_documentai_warehouse.GoogleDocumentAIWarehouseRetriever
[Deprecated] A retriever based on Document AI Warehouse.
retrievers.google_vertex_ai_search.GoogleCloudEnterpriseSearchRetriever
Google Vertex Search API retriever alias for backwards compatibility.
retrievers.google_vertex_ai_search.GoogleVertexAIMultiTurnSearchRetriever
[Deprecated] Google Vertex AI Search retriever for multi-turn conversations.
retrievers.google_vertex_ai_search.GoogleVertexAISearchRetriever
[Deprecated] Google Vertex AI Search retriever.
retrievers.kay.KayAiRetriever
Retriever for Kay.ai datasets.
retrievers.kendra.AdditionalResultAttribute
Additional result attribute.
retrievers.kendra.AdditionalResultAttributeValue
Value of an additional result attribute.
retrievers.kendra.AmazonKendraRetriever
Amazon Kendra Index retriever. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-64 | Amazon Kendra Index retriever.
retrievers.kendra.DocumentAttribute
Document attribute.
retrievers.kendra.DocumentAttributeValue
Value of a document attribute.
retrievers.kendra.Highlight
Information that highlights the keywords in the excerpt.
retrievers.kendra.QueryResult
Amazon Kendra Query API search result.
retrievers.kendra.QueryResultItem
Query API result item.
retrievers.kendra.ResultItem
Base class of a result item.
retrievers.kendra.RetrieveResult
Amazon Kendra Retrieve API search result.
retrievers.kendra.RetrieveResultItem
Retrieve API result item.
retrievers.kendra.TextWithHighLights
Text with highlights.
retrievers.knn.KNNRetriever
KNN retriever.
retrievers.llama_index.LlamaIndexGraphRetriever
LlamaIndex graph data structure retriever.
retrievers.llama_index.LlamaIndexRetriever
LlamaIndex retriever.
retrievers.metal.MetalRetriever
Metal API retriever.
retrievers.milvus.MilvusRetriever
Milvus API retriever.
retrievers.outline.OutlineRetriever
Retriever for Outline API.
retrievers.pinecone_hybrid_search.PineconeHybridSearchRetriever
Pinecone Hybrid Search retriever.
retrievers.pubmed.PubMedRetriever
PubMed API retriever.
retrievers.qdrant_sparse_vector_retriever.QdrantSparseVectorRetriever
Qdrant sparse vector retriever.
retrievers.rememberizer.RememberizerRetriever
Rememberizer retriever.
retrievers.remote_retriever.RemoteLangChainRetriever
LangChain API retriever.
retrievers.svm.SVMRetriever | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-65 | LangChain API retriever.
retrievers.svm.SVMRetriever
SVM retriever.
retrievers.tavily_search_api.SearchDepth(value)
Search depth as enumerator.
retrievers.tavily_search_api.TavilySearchAPIRetriever
Tavily Search API retriever.
retrievers.tfidf.TFIDFRetriever
TF-IDF retriever.
retrievers.thirdai_neuraldb.NeuralDBRetriever
Document retriever that uses ThirdAI's NeuralDB.
retrievers.vespa_retriever.VespaRetriever
Vespa retriever.
retrievers.weaviate_hybrid_search.WeaviateHybridSearchRetriever
Weaviate hybrid search retriever.
retrievers.web_research.QuestionListOutputParser
Output parser for a list of numbered questions.
retrievers.web_research.SearchQueries
Search queries to research for the user's goal.
retrievers.web_research.WebResearchRetriever
Google Search API retriever.
retrievers.wikipedia.WikipediaRetriever
Wikipedia API retriever.
retrievers.you.YouRetriever
You.com Search API retriever.
retrievers.zep.SearchScope(value)
Which documents to search.
retrievers.zep.SearchType(value)
Enumerator of the types of search to perform.
retrievers.zep.ZepRetriever
Zep MemoryStore Retriever.
retrievers.zep_cloud.ZepCloudRetriever
Zep Cloud MemoryStore Retriever.
retrievers.zilliz.ZillizRetriever
Zilliz API retriever.
Functions¶
retrievers.bm25.default_preprocessing_func(text)
retrievers.kendra.clean_excerpt(excerpt)
Clean an excerpt from Kendra. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-66 | retrievers.kendra.clean_excerpt(excerpt)
Clean an excerpt from Kendra.
retrievers.kendra.combined_text(item)
Combine a ResultItem title and excerpt into a single string.
retrievers.knn.create_index(contexts, embeddings)
Create an index of embeddings for a list of contexts.
retrievers.milvus.MilvusRetreiver(*args, ...)
Deprecated MilvusRetreiver.
retrievers.pinecone_hybrid_search.create_index(...)
Create an index from a list of contexts.
retrievers.pinecone_hybrid_search.hash_text(text)
Hash a text using SHA256.
retrievers.svm.create_index(contexts, embeddings)
Create an index of embeddings for a list of contexts.
retrievers.zilliz.ZillizRetreiver(*args, ...)
Deprecated ZillizRetreiver.
langchain_community.storage¶
Storage is an implementation of key-value store.
Storage module provides implementations of various key-value stores that conform
to a simple key-value interface.
The primary goal of these storages is to support caching.
Class hierarchy:
BaseStore --> <name>Store # Examples: MongoDBStore, RedisStore
Classes¶
storage.astradb.AstraDBBaseStore(*args, **kwargs)
Base class for the DataStax AstraDB data store.
storage.astradb.AstraDBByteStore(collection_name)
[Deprecated]
storage.astradb.AstraDBStore(collection_name)
[Deprecated]
storage.cassandra.CassandraByteStore(table, *)
storage.mongodb.MongoDBStore(...[, ...])
BaseStore implementation using MongoDB as the underlying store.
storage.redis.RedisStore(*[, client, ...])
BaseStore implementation using Redis as the underlying store. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-67 | BaseStore implementation using Redis as the underlying store.
storage.sql.LangchainKeyValueStores(**kwargs)
Table used to save values.
storage.sql.SQLStore(*, namespace[, db_url, ...])
BaseStore interface that works on an SQL database.
storage.upstash_redis.UpstashRedisByteStore(*)
BaseStore implementation using Upstash Redis as the underlying store to store raw bytes.
storage.upstash_redis.UpstashRedisStore(*[, ...])
[Deprecated] BaseStore implementation using Upstash Redis as the underlying store to store strings.
Functions¶
storage.sql.items_equal(x, y)
langchain_community.tools¶
Tools are classes that an Agent uses to interact with the world.
Each tool has a description. Agent uses the description to choose the right
tool for the job.
Class hierarchy:
ToolMetaclass --> BaseTool --> <name>Tool # Examples: AIPluginTool, BaseGraphQLTool
<name> # Examples: BraveSearch, HumanInputRun
Main helpers:
CallbackManagerForToolRun, AsyncCallbackManagerForToolRun
Classes¶
tools.ainetwork.app.AINAppOps
Tool for app operations.
tools.ainetwork.app.AppOperationType(value)
Type of app operation as enumerator.
tools.ainetwork.app.AppSchema
Schema for app operations.
tools.ainetwork.base.AINBaseTool
Base class for the AINetwork tools.
tools.ainetwork.base.OperationType(value)
Type of operation as enumerator.
tools.ainetwork.owner.AINOwnerOps
Tool for owner operations.
tools.ainetwork.owner.RuleSchema
Schema for owner operations.
tools.ainetwork.rule.AINRuleOps
Tool for owner operations.
tools.ainetwork.rule.RuleSchema
Schema for owner operations.
tools.ainetwork.transfer.AINTransfer
Tool for transfer operations. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-68 | tools.ainetwork.transfer.AINTransfer
Tool for transfer operations.
tools.ainetwork.transfer.TransferSchema
Schema for transfer operations.
tools.ainetwork.value.AINValueOps
Tool for value operations.
tools.ainetwork.value.ValueSchema
Schema for value operations.
tools.amadeus.base.AmadeusBaseTool
Base Tool for Amadeus.
tools.amadeus.closest_airport.AmadeusClosestAirport
Tool for finding the closest airport to a particular location.
tools.amadeus.closest_airport.ClosestAirportSchema
Schema for the AmadeusClosestAirport tool.
tools.amadeus.flight_search.AmadeusFlightSearch
Tool for searching for a single flight between two airports.
tools.amadeus.flight_search.FlightSearchSchema
Schema for the AmadeusFlightSearch tool.
tools.arxiv.tool.ArxivInput
Input for the Arxiv tool.
tools.arxiv.tool.ArxivQueryRun
Tool that searches the Arxiv API.
tools.asknews.tool.AskNewsSearch
Tool that searches the AskNews API.
tools.asknews.tool.SearchInput
Input for the AskNews Search tool.
tools.audio.huggingface_text_to_speech_inference.HuggingFaceTextToSpeechModelInference
HuggingFace Text-to-Speech Model Inference.
tools.azure_ai_services.document_intelligence.AzureAiServicesDocumentIntelligenceTool
Tool that queries the Azure AI Services Document Intelligence API.
tools.azure_ai_services.image_analysis.AzureAiServicesImageAnalysisTool
Tool that queries the Azure AI Services Image Analysis API.
tools.azure_ai_services.speech_to_text.AzureAiServicesSpeechToTextTool
Tool that queries the Azure AI Services Speech to Text API.
tools.azure_ai_services.text_analytics_for_health.AzureAiServicesTextAnalyticsForHealthTool
Tool that queries the Azure AI Services Text Analytics for Health API. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-69 | Tool that queries the Azure AI Services Text Analytics for Health API.
tools.azure_ai_services.text_to_speech.AzureAiServicesTextToSpeechTool
Tool that queries the Azure AI Services Text to Speech API.
tools.azure_cognitive_services.form_recognizer.AzureCogsFormRecognizerTool
Tool that queries the Azure Cognitive Services Form Recognizer API.
tools.azure_cognitive_services.image_analysis.AzureCogsImageAnalysisTool
Tool that queries the Azure Cognitive Services Image Analysis API.
tools.azure_cognitive_services.speech2text.AzureCogsSpeech2TextTool
Tool that queries the Azure Cognitive Services Speech2Text API.
tools.azure_cognitive_services.text2speech.AzureCogsText2SpeechTool
Tool that queries the Azure Cognitive Services Text2Speech API.
tools.azure_cognitive_services.text_analytics_health.AzureCogsTextAnalyticsHealthTool
Tool that queries the Azure Cognitive Services Text Analytics for Health API.
tools.bearly.tool.BearlyInterpreterTool(api_key)
Tool for evaluating python code in a sandbox environment.
tools.bearly.tool.BearlyInterpreterToolArguments
Arguments for the BearlyInterpreterTool.
tools.bearly.tool.FileInfo
Information about a file to be uploaded.
tools.bing_search.tool.BingSearchResults
Tool that queries the Bing Search API and gets back json.
tools.bing_search.tool.BingSearchRun
Tool that queries the Bing search API.
tools.brave_search.tool.BraveSearch
Tool that queries the BraveSearch.
tools.cassandra_database.tool.BaseCassandraDatabaseTool
Base tool for interacting with an Apache Cassandra database.
tools.cassandra_database.tool.GetSchemaCassandraDatabaseTool
Tool for getting the schema of a keyspace in an Apache Cassandra database.
tools.cassandra_database.tool.GetTableDataCassandraDatabaseTool
Tool for getting data from a table in an Apache Cassandra database.
tools.cassandra_database.tool.QueryCassandraDatabaseTool | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-70 | tools.cassandra_database.tool.QueryCassandraDatabaseTool
Tool for querying an Apache Cassandra database with provided CQL.
tools.clickup.tool.ClickupAction
Tool that queries the Clickup API.
tools.cogniswitch.tool.CogniswitchKnowledgeRequest
Tool that uses the Cogniswitch service to answer questions.
tools.cogniswitch.tool.CogniswitchKnowledgeSourceFile
Tool that uses the Cogniswitch services to store data from file.
tools.cogniswitch.tool.CogniswitchKnowledgeSourceURL
Tool that uses the Cogniswitch services to store data from a URL.
tools.cogniswitch.tool.CogniswitchKnowledgeStatus
Tool that uses the Cogniswitch services to get the
tools.connery.models.Action
Connery Action model.
tools.connery.models.Parameter
Connery Action parameter model.
tools.connery.models.Validation
Connery Action parameter validation model.
tools.connery.service.ConneryService
Service for interacting with the Connery Runner API.
tools.connery.tool.ConneryAction
Connery Action tool.
tools.databricks.tool.UCFunctionToolkit
Create a new model by parsing and validating input data from keyword arguments.
tools.dataforseo_api_search.tool.DataForSeoAPISearchResults
Tool that queries the DataForSeo Google Search API and get back json.
tools.dataforseo_api_search.tool.DataForSeoAPISearchRun
Tool that queries the DataForSeo Google search API.
tools.dataherald.tool.DataheraldTextToSQL
Tool that queries using the Dataherald SDK.
tools.dataherald.tool.DataheraldTextToSQLInput
Create a new model by parsing and validating input data from keyword arguments.
tools.ddg_search.tool.DDGInput
Input for the DuckDuckGo search tool.
tools.ddg_search.tool.DuckDuckGoSearchResults | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-71 | tools.ddg_search.tool.DuckDuckGoSearchResults
Tool that queries the DuckDuckGo search API and gets back json.
tools.ddg_search.tool.DuckDuckGoSearchRun
Tool that queries the DuckDuckGo search API.
tools.e2b_data_analysis.tool.E2BDataAnalysisTool
Tool for running python code in a sandboxed environment for data analysis.
tools.e2b_data_analysis.tool.E2BDataAnalysisToolArguments
Arguments for the E2BDataAnalysisTool.
tools.e2b_data_analysis.tool.UploadedFile
Description of the uploaded path with its remote path.
tools.e2b_data_analysis.unparse.Unparser(tree)
Traverse an AST and output source code for the abstract syntax; original formatting is disregarded.
tools.edenai.audio_speech_to_text.EdenAiSpeechToTextTool
Tool that queries the Eden AI Speech To Text API.
tools.edenai.audio_text_to_speech.EdenAiTextToSpeechTool
Tool that queries the Eden AI Text to speech API.
tools.edenai.edenai_base_tool.EdenaiTool
the base tool for all the EdenAI Tools .
tools.edenai.image_explicitcontent.EdenAiExplicitImageTool
Tool that queries the Eden AI Explicit image detection.
tools.edenai.image_objectdetection.EdenAiObjectDetectionTool
Tool that queries the Eden AI Object detection API.
tools.edenai.ocr_identityparser.EdenAiParsingIDTool
Tool that queries the Eden AI Identity parsing API.
tools.edenai.ocr_invoiceparser.EdenAiParsingInvoiceTool
Tool that queries the Eden AI Invoice parsing API.
tools.edenai.text_moderation.EdenAiTextModerationTool
Tool that queries the Eden AI Explicit text detection.
tools.eleven_labs.models.ElevenLabsModel(value) | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-72 | tools.eleven_labs.models.ElevenLabsModel(value)
Models available for Eleven Labs Text2Speech.
tools.eleven_labs.text2speech.ElevenLabsModel(value)
Models available for Eleven Labs Text2Speech.
tools.eleven_labs.text2speech.ElevenLabsText2SpeechTool
Tool that queries the Eleven Labs Text2Speech API.
tools.file_management.copy.CopyFileTool
Tool that copies a file.
tools.file_management.copy.FileCopyInput
Input for CopyFileTool.
tools.file_management.delete.DeleteFileTool
Tool that deletes a file.
tools.file_management.delete.FileDeleteInput
Input for DeleteFileTool.
tools.file_management.file_search.FileSearchInput
Input for FileSearchTool.
tools.file_management.file_search.FileSearchTool
Tool that searches for files in a subdirectory that match a regex pattern.
tools.file_management.list_dir.DirectoryListingInput
Input for ListDirectoryTool.
tools.file_management.list_dir.ListDirectoryTool
Tool that lists files and directories in a specified folder.
tools.file_management.move.FileMoveInput
Input for MoveFileTool.
tools.file_management.move.MoveFileTool
Tool that moves a file.
tools.file_management.read.ReadFileInput
Input for ReadFileTool.
tools.file_management.read.ReadFileTool
Tool that reads a file.
tools.file_management.utils.BaseFileToolMixin
Mixin for file system tools.
tools.file_management.utils.FileValidationError
Error for paths outside the root directory.
tools.file_management.write.WriteFileInput
Input for WriteFileTool.
tools.file_management.write.WriteFileTool
Tool that writes a file to disk.
tools.github.tool.GitHubAction
Tool for interacting with the GitHub API.
tools.gitlab.tool.GitLabAction
Tool for interacting with the GitLab API.
tools.gmail.base.GmailBaseTool
Base class for Gmail tools. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-73 | tools.gmail.base.GmailBaseTool
Base class for Gmail tools.
tools.gmail.create_draft.CreateDraftSchema
Input for CreateDraftTool.
tools.gmail.create_draft.GmailCreateDraft
Tool that creates a draft email for Gmail.
tools.gmail.get_message.GmailGetMessage
Tool that gets a message by ID from Gmail.
tools.gmail.get_message.SearchArgsSchema
Input for GetMessageTool.
tools.gmail.get_thread.GetThreadSchema
Input for GetMessageTool.
tools.gmail.get_thread.GmailGetThread
Tool that gets a thread by ID from Gmail.
tools.gmail.search.GmailSearch
Tool that searches for messages or threads in Gmail.
tools.gmail.search.Resource(value)
Enumerator of Resources to search.
tools.gmail.search.SearchArgsSchema
Input for SearchGmailTool.
tools.gmail.send_message.GmailSendMessage
Tool that sends a message to Gmail.
tools.gmail.send_message.SendMessageSchema
Input for SendMessageTool.
tools.golden_query.tool.GoldenQueryRun
Tool that adds the capability to query using the Golden API and get back JSON.
tools.google_cloud.texttospeech.GoogleCloudTextToSpeechTool
[Deprecated] Tool that queries the Google Cloud Text to Speech API.
tools.google_finance.tool.GoogleFinanceQueryRun
Tool that queries the Google Finance API.
tools.google_jobs.tool.GoogleJobsQueryRun
Tool that queries the Google Jobs API.
tools.google_lens.tool.GoogleLensQueryRun
Tool that queries the Google Lens API.
tools.google_places.tool.GooglePlacesSchema
Input for GooglePlacesTool.
tools.google_places.tool.GooglePlacesTool
[Deprecated] Tool that queries the Google places API.
tools.google_scholar.tool.GoogleScholarQueryRun
Tool that queries the Google search API.
tools.google_search.tool.GoogleSearchResults
[Deprecated] Tool that queries the Google Search API and gets back json.
tools.google_search.tool.GoogleSearchRun | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-74 | tools.google_search.tool.GoogleSearchRun
[Deprecated] Tool that queries the Google search API.
tools.google_serper.tool.GoogleSerperResults
Tool that queries the Serper.dev Google Search API and get back json.
tools.google_serper.tool.GoogleSerperRun
Tool that queries the Serper.dev Google search API.
tools.google_trends.tool.GoogleTrendsQueryRun
Tool that queries the Google trends API.
tools.graphql.tool.BaseGraphQLTool
Base tool for querying a GraphQL API.
tools.human.tool.HumanInputRun
Tool that asks user for input.
tools.ifttt.IFTTTWebhook
IFTTT Webhook.
tools.jira.tool.JiraAction
Tool that queries the Atlassian Jira API.
tools.json.tool.JsonGetValueTool
Tool for getting a value in a JSON spec.
tools.json.tool.JsonListKeysTool
Tool for listing keys in a JSON spec.
tools.json.tool.JsonSpec
Base class for JSON spec.
tools.memorize.tool.Memorize
Tool that trains a language model.
tools.memorize.tool.TrainableLLM(*args, **kwargs)
Protocol for trainable language models.
tools.merriam_webster.tool.MerriamWebsterQueryRun
Tool that searches the Merriam-Webster API.
tools.metaphor_search.tool.MetaphorSearchResults
[Deprecated] Tool that queries the Metaphor Search API and gets back json.
tools.mojeek_search.tool.MojeekSearch
Create a new model by parsing and validating input data from keyword arguments.
tools.multion.close_session.CloseSessionSchema
Input for UpdateSessionTool.
tools.multion.close_session.MultionCloseSession
Tool that closes an existing Multion Browser Window with provided fields.
tools.multion.create_session.CreateSessionSchema
Input for CreateSessionTool. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-75 | tools.multion.create_session.CreateSessionSchema
Input for CreateSessionTool.
tools.multion.create_session.MultionCreateSession
Tool that creates a new Multion Browser Window with provided fields.
tools.multion.update_session.MultionUpdateSession
Tool that updates an existing Multion Browser Window with provided fields.
tools.multion.update_session.UpdateSessionSchema
Input for UpdateSessionTool.
tools.nasa.tool.NasaAction
Tool that queries the Atlassian Jira API.
tools.nuclia.tool.NUASchema
Input for Nuclia Understanding API.
tools.nuclia.tool.NucliaUnderstandingAPI
Tool to process files with the Nuclia Understanding API.
tools.office365.base.O365BaseTool
Base class for the Office 365 tools.
tools.office365.create_draft_message.CreateDraftMessageSchema
Input for SendMessageTool.
tools.office365.create_draft_message.O365CreateDraftMessage
Tool for creating a draft email in Office 365.
tools.office365.events_search.O365SearchEvents
Search calendar events in Office 365.
tools.office365.events_search.SearchEventsInput
Input for SearchEmails Tool.
tools.office365.messages_search.O365SearchEmails
Search email messages in Office 365.
tools.office365.messages_search.SearchEmailsInput
Input for SearchEmails Tool.
tools.office365.send_event.O365SendEvent
Tool for sending calendar events in Office 365.
tools.office365.send_event.SendEventSchema
Input for CreateEvent Tool.
tools.office365.send_message.O365SendMessage
Send an email in Office 365.
tools.office365.send_message.SendMessageSchema
Input for SendMessageTool.
tools.openai_dalle_image_generation.tool.OpenAIDALLEImageGenerationTool
Tool that generates an image using OpenAI DALLE.
tools.openapi.utils.api_models.APIOperation
A model for a single API operation.
tools.openapi.utils.api_models.APIProperty | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-76 | A model for a single API operation.
tools.openapi.utils.api_models.APIProperty
A model for a property in the query, path, header, or cookie params.
tools.openapi.utils.api_models.APIPropertyBase
Base model for an API property.
tools.openapi.utils.api_models.APIPropertyLocation(value)
The location of the property.
tools.openapi.utils.api_models.APIRequestBody
A model for a request body.
tools.openapi.utils.api_models.APIRequestBodyProperty
A model for a request body property.
tools.openweathermap.tool.OpenWeatherMapQueryRun
Tool that queries the OpenWeatherMap API.
tools.passio_nutrition_ai.tool.NutritionAI
Tool that queries the Passio Nutrition AI API.
tools.passio_nutrition_ai.tool.NutritionAIInputs
Inputs to the Passio Nutrition AI tool.
tools.playwright.base.BaseBrowserTool
Base class for browser tools.
tools.playwright.click.ClickTool
Tool for clicking on an element with the given CSS selector.
tools.playwright.click.ClickToolInput
Input for ClickTool.
tools.playwright.current_page.CurrentWebPageTool
Tool for getting the URL of the current webpage.
tools.playwright.extract_hyperlinks.ExtractHyperlinksTool
Extract all hyperlinks on the page.
tools.playwright.extract_hyperlinks.ExtractHyperlinksToolInput
Input for ExtractHyperlinksTool.
tools.playwright.extract_text.ExtractTextTool
Tool for extracting all the text on the current webpage.
tools.playwright.get_elements.GetElementsTool
Tool for getting elements in the current web page matching a CSS selector.
tools.playwright.get_elements.GetElementsToolInput
Input for GetElementsTool.
tools.playwright.navigate.NavigateTool
Tool for navigating a browser to a URL.
tools.playwright.navigate.NavigateToolInput
Input for NavigateToolInput.
tools.playwright.navigate_back.NavigateBackTool
Navigate back to the previous page in the browser history. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-77 | Navigate back to the previous page in the browser history.
tools.plugin.AIPlugin
AI Plugin Definition.
tools.plugin.AIPluginTool
Tool for getting the OpenAPI spec for an AI Plugin.
tools.plugin.AIPluginToolSchema
Schema for AIPluginTool.
tools.plugin.ApiConfig
API Configuration.
tools.polygon.aggregates.PolygonAggregates
Tool that gets aggregate bars (stock prices) over a given date range for a given ticker from Polygon.
tools.polygon.aggregates.PolygonAggregatesSchema
Input for PolygonAggregates.
tools.polygon.financials.Inputs
Inputs for Polygon's Financials API
tools.polygon.financials.PolygonFinancials
Tool that gets the financials of a ticker from Polygon
tools.polygon.last_quote.Inputs
Inputs for Polygon's Last Quote API
tools.polygon.last_quote.PolygonLastQuote
Tool that gets the last quote of a ticker from Polygon
tools.polygon.ticker_news.Inputs
Inputs for Polygon's Ticker News API
tools.polygon.ticker_news.PolygonTickerNews
Tool that gets the latest news for a given ticker from Polygon
tools.powerbi.tool.InfoPowerBITool
Tool for getting metadata about a PowerBI Dataset.
tools.powerbi.tool.ListPowerBITool
Tool for getting tables names.
tools.powerbi.tool.QueryPowerBITool
Tool for querying a Power BI Dataset.
tools.pubmed.tool.PubmedQueryRun
Tool that searches the PubMed API.
tools.reddit_search.tool.RedditSearchRun
Tool that queries for posts on a subreddit.
tools.reddit_search.tool.RedditSearchSchema
Input for Reddit search.
tools.requests.tool.BaseRequestsTool
Base class for requests tools.
tools.requests.tool.RequestsDeleteTool
Tool for making a DELETE request to an API endpoint.
tools.requests.tool.RequestsGetTool
Tool for making a GET request to an API endpoint. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-78 | tools.requests.tool.RequestsGetTool
Tool for making a GET request to an API endpoint.
tools.requests.tool.RequestsPatchTool
Tool for making a PATCH request to an API endpoint.
tools.requests.tool.RequestsPostTool
Tool for making a POST request to an API endpoint.
tools.requests.tool.RequestsPutTool
Tool for making a PUT request to an API endpoint.
tools.scenexplain.tool.SceneXplainInput
Input for SceneXplain.
tools.scenexplain.tool.SceneXplainTool
Tool that explains images.
tools.searchapi.tool.SearchAPIResults
Tool that queries the SearchApi.io search API and returns JSON.
tools.searchapi.tool.SearchAPIRun
Tool that queries the SearchApi.io search API.
tools.searx_search.tool.SearxSearchResults
Tool that queries a Searx instance and gets back json.
tools.searx_search.tool.SearxSearchRun
Tool that queries a Searx instance.
tools.semanticscholar.tool.SemanticScholarQueryRun
Tool that searches the semanticscholar API.
tools.semanticscholar.tool.SemantscholarInput
Input for the SemanticScholar tool.
tools.shell.tool.ShellInput
Commands for the Bash Shell tool.
tools.shell.tool.ShellTool
Tool to run shell commands.
tools.slack.base.SlackBaseTool
Base class for Slack tools.
tools.slack.get_channel.SlackGetChannel
Tool that gets Slack channel information.
tools.slack.get_message.SlackGetMessage
Tool that gets Slack messages.
tools.slack.get_message.SlackGetMessageSchema
Input schema for SlackGetMessages.
tools.slack.schedule_message.ScheduleMessageSchema
Input for ScheduleMessageTool.
tools.slack.schedule_message.SlackScheduleMessage
Tool for scheduling a message in Slack.
tools.slack.send_message.SendMessageSchema | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-79 | Tool for scheduling a message in Slack.
tools.slack.send_message.SendMessageSchema
Input for SendMessageTool.
tools.slack.send_message.SlackSendMessage
Tool for sending a message in Slack.
tools.sleep.tool.SleepInput
Input for CopyFileTool.
tools.sleep.tool.SleepTool
Tool that adds the capability to sleep.
tools.spark_sql.tool.BaseSparkSQLTool
Base tool for interacting with Spark SQL.
tools.spark_sql.tool.InfoSparkSQLTool
Tool for getting metadata about a Spark SQL.
tools.spark_sql.tool.ListSparkSQLTool
Tool for getting tables names.
tools.spark_sql.tool.QueryCheckerTool
Use an LLM to check if a query is correct.
tools.spark_sql.tool.QuerySparkSQLTool
Tool for querying a Spark SQL.
tools.sql_database.tool.BaseSQLDatabaseTool
Base tool for interacting with a SQL database.
tools.sql_database.tool.InfoSQLDatabaseTool
Tool for getting metadata about a SQL database.
tools.sql_database.tool.ListSQLDatabaseTool
Tool for getting tables names.
tools.sql_database.tool.QuerySQLCheckerTool
Use an LLM to check if a query is correct.
tools.sql_database.tool.QuerySQLDataBaseTool
Tool for querying a SQL database.
tools.stackexchange.tool.StackExchangeTool
Tool that uses StackExchange
tools.steam.tool.SteamWebAPIQueryRun
Tool that searches the Steam Web API.
tools.steamship_image_generation.tool.ModelName(value)
Supported Image Models for generation.
tools.steamship_image_generation.tool.SteamshipImageGenerationTool
Tool used to generate images from a text-prompt.
tools.tavily_search.tool.TavilyAnswer
Tool that queries the Tavily Search API and gets back an answer.
tools.tavily_search.tool.TavilyInput
Input for the Tavily tool.
tools.tavily_search.tool.TavilySearchResults | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-80 | tools.tavily_search.tool.TavilySearchResults
Tool that queries the Tavily Search API and gets back json.
tools.vectorstore.tool.BaseVectorStoreTool
Base class for tools that use a VectorStore.
tools.vectorstore.tool.VectorStoreQATool
Tool for the VectorDBQA chain.
tools.vectorstore.tool.VectorStoreQAWithSourcesTool
Tool for the VectorDBQAWithSources chain.
tools.wikidata.tool.WikidataQueryRun
Tool that searches the Wikidata API.
tools.wikipedia.tool.WikipediaQueryInput
Input for the WikipediaQuery tool.
tools.wikipedia.tool.WikipediaQueryRun
Tool that searches the Wikipedia API.
tools.wolfram_alpha.tool.WolframAlphaQueryRun
Tool that queries using the Wolfram Alpha SDK.
tools.yahoo_finance_news.YahooFinanceNewsInput
Input for the YahooFinanceNews tool.
tools.yahoo_finance_news.YahooFinanceNewsTool
Tool that searches financial news on Yahoo Finance.
tools.you.tool.YouInput
Input schema for the you.com tool.
tools.you.tool.YouSearchTool
Tool that searches the you.com API.
tools.youtube.search.YouTubeSearchTool
Tool that queries YouTube.
tools.zapier.tool.ZapierNLAListActions
Returns a list of all exposed (enabled) actions associated with current user (associated with the set api_key).
tools.zapier.tool.ZapierNLARunAction
Executes an action that is identified by action_id, must be exposed
Functions¶
tools.ainetwork.utils.authenticate([network])
Authenticate using the AIN Blockchain
tools.amadeus.utils.authenticate()
Authenticate using the Amadeus API
tools.azure_ai_services.utils.detect_file_src_type(...)
Detect if the file is local or remote.
tools.azure_ai_services.utils.download_audio_from_url(...)
Download audio from url to local. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-81 | tools.azure_ai_services.utils.download_audio_from_url(...)
Download audio from url to local.
tools.azure_cognitive_services.utils.detect_file_src_type(...)
Detect if the file is local or remote.
tools.azure_cognitive_services.utils.download_audio_from_url(...)
Download audio from url to local.
tools.bearly.tool.file_to_base64(path)
Convert a file to base64.
tools.bearly.tool.head_file(path, n)
Get the first n lines of a file.
tools.bearly.tool.strip_markdown_code(md_string)
Strip markdown code from a string.
tools.ddg_search.tool.DuckDuckGoSearchTool(...)
Deprecated.
tools.e2b_data_analysis.tool.add_last_line_print(code)
Add print statement to the last line if it's missing.
tools.e2b_data_analysis.unparse.interleave(...)
Call f on each item in seq, calling inter() in between.
tools.e2b_data_analysis.unparse.roundtrip(...)
Parse a file and pretty-print it to output.
tools.file_management.utils.get_validated_relative_path(...)
Resolve a relative path, raising an error if not within the root directory.
tools.file_management.utils.is_relative_to(...)
Check if path is relative to root.
tools.gmail.utils.build_resource_service([...])
Build a Gmail service.
tools.gmail.utils.clean_email_body(body)
Clean email body.
tools.gmail.utils.get_gmail_credentials([...])
Get credentials.
tools.gmail.utils.import_google()
Import google libraries.
tools.gmail.utils.import_googleapiclient_resource_builder()
Import googleapiclient.discovery.build function.
tools.gmail.utils.import_installed_app_flow()
Import InstalledAppFlow class.
tools.interaction.tool.StdInInquireTool(...)
Tool for asking the user for input.
tools.office365.utils.authenticate()
Authenticate using the Microsoft Graph API
tools.office365.utils.clean_body(body) | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-82 | Authenticate using the Microsoft Graph API
tools.office365.utils.clean_body(body)
Clean body of a message or event.
tools.playwright.base.lazy_import_playwright_browsers()
Lazy import playwright browsers.
tools.playwright.utils.aget_current_page(browser)
Asynchronously get the current page of the browser.
tools.playwright.utils.create_async_playwright_browser([...])
Create an async playwright browser.
tools.playwright.utils.create_sync_playwright_browser([...])
Create a playwright browser.
tools.playwright.utils.get_current_page(browser)
Get the current page of the browser.
tools.playwright.utils.run_async(coro)
Run an async coroutine.
tools.plugin.marshal_spec(txt)
Convert the yaml or json serialized spec to a dict.
tools.slack.utils.login()
Authenticate using the Slack API.
tools.steamship_image_generation.utils.make_image_public(...)
Upload a block to a signed URL and return the public URL.
langchain_community.utilities¶
Utilities are the integrations with third-part systems and packages.
Other LangChain classes use Utilities to interact with third-part systems
and packages.
Classes¶
utilities.alpha_vantage.AlphaVantageAPIWrapper
Wrapper for AlphaVantage API for Currency Exchange Rate.
utilities.apify.ApifyWrapper
Wrapper around Apify.
utilities.arcee.ArceeDocument
Arcee document.
utilities.arcee.ArceeDocumentAdapter()
Adapter for Arcee documents
utilities.arcee.ArceeDocumentSource
Source of an Arcee document.
utilities.arcee.ArceeRoute(value)
Routes available for the Arcee API as enumerator.
utilities.arcee.ArceeWrapper(arcee_api_key, ...)
Wrapper for Arcee API.
utilities.arcee.DALMFilter
Filters available for a DALM retrieval and generation.
utilities.arcee.DALMFilterType(value)
Filter types available for a DALM retrieval as enumerator. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-83 | Filter types available for a DALM retrieval as enumerator.
utilities.arxiv.ArxivAPIWrapper
Wrapper around ArxivAPI.
utilities.asknews.AskNewsAPIWrapper
Wrapper for AskNews API.
utilities.astradb.SetupMode(value)
Setup mode for AstraDBEnvironment as enumerator.
utilities.awslambda.LambdaWrapper
Wrapper for AWS Lambda SDK.
utilities.bibtex.BibtexparserWrapper
Wrapper around bibtexparser.
utilities.bing_search.BingSearchAPIWrapper
Wrapper for Bing Search API.
utilities.brave_search.BraveSearchWrapper
Wrapper around the Brave search engine.
utilities.cassandra.SetupMode(value)
An enumeration.
utilities.cassandra_database.CassandraDatabase([...])
Apache Cassandra® database wrapper.
utilities.cassandra_database.DatabaseError(message)
Exception raised for errors in the database schema.
utilities.cassandra_database.Table
Create a new model by parsing and validating input data from keyword arguments.
utilities.clickup.CUList(folder_id, name[, ...])
Component class for a list.
utilities.clickup.ClickupAPIWrapper
Wrapper for Clickup API.
utilities.clickup.Component()
Base class for all components.
utilities.clickup.Member(id, username, ...)
Component class for a member.
utilities.clickup.Space(id, name, private, ...)
Component class for a space.
utilities.clickup.Task(id, name, ...)
Class for a task.
utilities.clickup.Team(id, name, members)
Component class for a team.
utilities.dalle_image_generator.DallEAPIWrapper
Wrapper for OpenAI's DALL-E Image Generator.
utilities.dataforseo_api_search.DataForSeoAPIWrapper
Wrapper around the DataForSeo API.
utilities.dataherald.DataheraldAPIWrapper
Wrapper for Dataherald. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-84 | utilities.dataherald.DataheraldAPIWrapper
Wrapper for Dataherald.
utilities.dria_index.DriaAPIWrapper(api_key)
Wrapper around Dria API.
utilities.duckduckgo_search.DuckDuckGoSearchAPIWrapper
Wrapper for DuckDuckGo Search API.
utilities.github.GitHubAPIWrapper
Wrapper for GitHub API.
utilities.gitlab.GitLabAPIWrapper
Wrapper for GitLab API.
utilities.golden_query.GoldenQueryAPIWrapper
Wrapper for Golden.
utilities.google_finance.GoogleFinanceAPIWrapper
Wrapper for SerpApi's Google Finance API
utilities.google_jobs.GoogleJobsAPIWrapper
Wrapper for SerpApi's Google Scholar API
utilities.google_lens.GoogleLensAPIWrapper
Wrapper for SerpApi's Google Lens API
utilities.google_places_api.GooglePlacesAPIWrapper
[Deprecated] Wrapper around Google Places API.
utilities.google_scholar.GoogleScholarAPIWrapper
Wrapper for Google Scholar API
utilities.google_search.GoogleSearchAPIWrapper
[Deprecated] Wrapper for Google Search API.
utilities.google_serper.GoogleSerperAPIWrapper
Wrapper around the Serper.dev Google Search API.
utilities.google_trends.GoogleTrendsAPIWrapper
Wrapper for SerpApi's Google Scholar API
utilities.graphql.GraphQLAPIWrapper
Wrapper around GraphQL API.
utilities.infobip.InfobipAPIWrapper
Wrapper for Infobip API for messaging.
utilities.jira.JiraAPIWrapper
Wrapper for Jira API.
utilities.max_compute.MaxComputeAPIWrapper(client)
Interface for querying Alibaba Cloud MaxCompute tables.
utilities.merriam_webster.MerriamWebsterAPIWrapper
Wrapper for Merriam-Webster.
utilities.metaphor_search.MetaphorSearchAPIWrapper
Wrapper for Metaphor Search API.
utilities.mojeek_search.MojeekSearchAPIWrapper | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-85 | utilities.mojeek_search.MojeekSearchAPIWrapper
Create a new model by parsing and validating input data from keyword arguments.
utilities.nasa.NasaAPIWrapper
Wrapper for NASA API.
utilities.nvidia_riva.ASRInputType
alias of AudioStream
utilities.nvidia_riva.AudioStream([maxsize])
A message containing streaming audio.
utilities.nvidia_riva.NVIDIARivaASR
alias of RivaASR
utilities.nvidia_riva.NVIDIARivaStream
alias of AudioStream
utilities.nvidia_riva.NVIDIARivaTTS
alias of RivaTTS
utilities.nvidia_riva.RivaASR
A runnable that performs Automatic Speech Recognition (ASR) using NVIDIA Riva.
utilities.nvidia_riva.RivaAudioEncoding(value)
An enum of the possible choices for Riva audio encoding.
utilities.nvidia_riva.RivaAuthMixin
Configuration for the authentication to a Riva service connection.
utilities.nvidia_riva.RivaCommonConfigMixin
A collection of common Riva settings.
utilities.nvidia_riva.RivaTTS
A runnable that performs Text-to-Speech (TTS) with NVIDIA Riva.
utilities.nvidia_riva.SentinelT()
An empty Sentinel type.
utilities.openapi.HTTPVerb(value)
Enumerator of the HTTP verbs.
utilities.openapi.OpenAPISpec()
OpenAPI Model that removes mis-formatted parts of the spec.
utilities.openweathermap.OpenWeatherMapAPIWrapper
Wrapper for OpenWeatherMap API using PyOWM.
utilities.oracleai.OracleSummary(conn, params)
Get Summary :param conn: Oracle Connection, :param params: Summary parameters, :param proxy: Proxy
utilities.outline.OutlineAPIWrapper
Wrapper around OutlineAPI.
utilities.passio_nutrition_ai.ManagedPassioLifeAuth(...) | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-86 | utilities.passio_nutrition_ai.ManagedPassioLifeAuth(...)
Manage the token for the NutritionAI API.
utilities.passio_nutrition_ai.NoDiskStorage()
Mixin to prevent storing on disk.
utilities.passio_nutrition_ai.NutritionAIAPI
Wrapper for the Passio Nutrition AI API.
utilities.pebblo.App
Pebblo AI application.
utilities.pebblo.Doc
Pebblo document.
utilities.pebblo.Framework
Pebblo Framework instance.
utilities.pebblo.IndexedDocument
Pass page_content in as positional or named arg.
utilities.pebblo.Runtime
Pebblo Runtime.
utilities.polygon.PolygonAPIWrapper
Wrapper for Polygon API.
utilities.portkey.Portkey()
Portkey configuration.
utilities.powerbi.PowerBIDataset
Create PowerBI engine from dataset ID and credential or token.
utilities.pubmed.PubMedAPIWrapper
Wrapper around PubMed API.
utilities.python.PythonREPL
Simulates a standalone Python REPL.
utilities.reddit_search.RedditSearchAPIWrapper
Wrapper for Reddit API
utilities.redis.TokenEscaper([escape_chars_re])
Escape punctuation within an input string.
utilities.rememberizer.RememberizerAPIWrapper
Wrapper for Rememberizer APIs.
utilities.requests.GenericRequestsWrapper
Lightweight wrapper around requests library.
utilities.requests.JsonRequestsWrapper
Lightweight wrapper around requests library, with async support.
utilities.requests.Requests
Wrapper around requests to handle auth and async.
utilities.requests.RequestsWrapper
alias of TextRequestsWrapper
utilities.requests.TextRequestsWrapper
Lightweight wrapper around requests library, with async support.
utilities.scenexplain.SceneXplainAPIWrapper
Wrapper for SceneXplain API.
utilities.searchapi.SearchApiAPIWrapper
Wrapper around SearchApi API.
utilities.searx_search.SearxResults(data)
Dict like wrapper around search api results. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-87 | Dict like wrapper around search api results.
utilities.searx_search.SearxSearchWrapper
Wrapper for Searx API.
utilities.semanticscholar.SemanticScholarAPIWrapper
Wrapper around semanticscholar.org API.
utilities.serpapi.HiddenPrints()
Context manager to hide prints.
utilities.serpapi.SerpAPIWrapper
Wrapper around SerpAPI.
utilities.spark_sql.SparkSQL([...])
SparkSQL is a utility class for interacting with Spark SQL.
utilities.sql_database.SQLDatabase(engine[, ...])
SQLAlchemy wrapper around a database.
utilities.stackexchange.StackExchangeAPIWrapper
Wrapper for Stack Exchange API.
utilities.steam.SteamWebAPIWrapper
Wrapper for Steam API.
utilities.tavily_search.TavilySearchAPIWrapper
Wrapper for Tavily Search API.
utilities.tensorflow_datasets.TensorflowDatasets
Access to the TensorFlow Datasets.
utilities.twilio.TwilioAPIWrapper
Messaging Client using Twilio.
utilities.wikidata.WikidataAPIWrapper
Wrapper around the Wikidata API.
utilities.wikipedia.WikipediaAPIWrapper
Wrapper around WikipediaAPI.
utilities.wolfram_alpha.WolframAlphaAPIWrapper
Wrapper for Wolfram Alpha.
utilities.you.YouAPIOutput
Output from you.com API.
utilities.you.YouDocument
Output of parsing one snippet.
utilities.you.YouHit
A single hit from you.com, which may contain multiple snippets
utilities.you.YouHitMetadata
Metadata on a single hit from you.com
utilities.you.YouSearchAPIWrapper
Wrapper for you.com Search API.
utilities.zapier.ZapierNLAWrapper
Wrapper for Zapier NLA.
Functions¶
utilities.anthropic.get_num_tokens_anthropic(text)
Get the number of tokens in a string of text.
utilities.anthropic.get_token_ids_anthropic(text) | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-88 | utilities.anthropic.get_token_ids_anthropic(text)
Get the token ids for a string of text.
utilities.cassandra.aexecute_cql(session, ...)
utilities.cassandra.wrapped_response_future(...)
Wrap a Cassandra response future in an asyncio future.
utilities.clickup.extract_dict_elements_from_component_fields(...)
Extract elements from a dictionary.
utilities.clickup.fetch_data(url, access_token)
Fetch data from a URL.
utilities.clickup.fetch_first_id(data, key)
Fetch the first id from a dictionary.
utilities.clickup.fetch_folder_id(space_id, ...)
Fetch the folder id.
utilities.clickup.fetch_list_id(space_id, ...)
Fetch the list id.
utilities.clickup.fetch_space_id(team_id, ...)
Fetch the space id.
utilities.clickup.fetch_team_id(access_token)
Fetch the team id.
utilities.clickup.load_query(query[, ...])
Parse a JSON string and return the parsed object.
utilities.clickup.parse_dict_through_component(...)
Parse a dictionary by creating a component and then turning it back into a dictionary.
utilities.opaqueprompts.desanitize(...)
Restore the original sensitive data from the sanitized text.
utilities.opaqueprompts.sanitize(input)
Sanitize input string or dict of strings by replacing sensitive data with placeholders.
utilities.passio_nutrition_ai.is_http_retryable(rsp)
Check if a HTTP response is retryable.
utilities.pebblo.get_full_path(path)
Return an absolute local path for a local file/directory, for a network related path, return as is.
utilities.pebblo.get_ip()
Fetch local runtime ip address.
utilities.pebblo.get_loader_full_path(loader)
Return an absolute source path of source of loader based on the keys present in Document.
utilities.pebblo.get_loader_type(loader) | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-89 | utilities.pebblo.get_loader_type(loader)
Return loader type among, file, dir or in-memory.
utilities.pebblo.get_runtime()
Fetch the current Framework and Runtime details.
utilities.powerbi.fix_table_name(table)
Add single quotes around table names that contain spaces.
utilities.powerbi.json_to_md(json_contents)
Convert a JSON object to a markdown table.
utilities.redis.check_redis_module_exist(...)
Check if the correct Redis modules are installed.
utilities.redis.get_client(redis_url, **kwargs)
Get a redis client from the connection url given.
utilities.sql_database.truncate_word(...[, ...])
Truncate a string to a certain number of words, based on the max string length.
utilities.vertexai.create_retry_decorator(llm, *)
Create a retry decorator for Vertex / Palm LLMs.
utilities.vertexai.get_client_info([module])
Return a custom user agent header.
utilities.vertexai.init_vertexai([project, ...])
Init Vertex AI.
utilities.vertexai.load_image_from_gcs(path)
Load an image from Google Cloud Storage.
utilities.vertexai.raise_vertex_import_error([...])
Raise ImportError related to Vertex SDK being not available.
langchain_community.utils¶
Utility functions for LangChain.
Classes¶
utils.ernie_functions.FunctionDescription
Representation of a callable function to the Ernie API.
utils.ernie_functions.ToolDescription
Representation of a callable function to the Ernie API.
Functions¶
utils.ernie_functions.convert_pydantic_to_ernie_function(...)
Convert a Pydantic model to a function description for the Ernie API.
utils.ernie_functions.convert_pydantic_to_ernie_tool(...)
Convert a Pydantic model to a function description for the Ernie API.
utils.google.get_client_info([module])
Return a custom user agent header. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-90 | utils.google.get_client_info([module])
Return a custom user agent header.
utils.math.cosine_similarity(X, Y)
Row-wise cosine similarity between two equal-width matrices.
utils.math.cosine_similarity_top_k(X, Y[, ...])
Row-wise cosine similarity with optional top-k and score threshold filtering.
utils.openai.is_openai_v1()
Return whether OpenAI API is v1 or more.
utils.user_agent.get_user_agent()
Get user agent from environment variable.
langchain_community.vectorstores¶
Vector store stores embedded data and performs vector search.
One of the most common ways to store and search over unstructured data is to
embed it and store the resulting embedding vectors, and then query the store
and retrieve the data that are ‘most similar’ to the embedded query.
Class hierarchy:
VectorStore --> <name> # Examples: Annoy, FAISS, Milvus
BaseRetriever --> VectorStoreRetriever --> <name>Retriever # Example: VespaRetriever
Main helpers:
Embeddings, Document
Classes¶
vectorstores.aerospike.Aerospike(client, ...)
Aerospike vector store.
vectorstores.alibabacloud_opensearch.AlibabaCloudOpenSearch(...)
Alibaba Cloud OpenSearch vector store.
vectorstores.alibabacloud_opensearch.AlibabaCloudOpenSearchSettings(...)
Alibaba Cloud Opensearch` client configuration.
vectorstores.analyticdb.AnalyticDB(...[, ...])
AnalyticDB (distributed PostgreSQL) vector store.
vectorstores.annoy.Annoy(embedding_function, ...)
Annoy vector store.
vectorstores.apache_doris.ApacheDoris(...[, ...])
Apache Doris vector store.
vectorstores.apache_doris.ApacheDorisSettings
Apache Doris client configuration. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-91 | vectorstores.apache_doris.ApacheDorisSettings
Apache Doris client configuration.
vectorstores.astradb.AstraDB(*, embedding, ...)
[Deprecated]
vectorstores.atlas.AtlasDB(name[, ...])
Atlas vector store.
vectorstores.awadb.AwaDB([table_name, ...])
AwaDB vector store.
vectorstores.azure_cosmos_db.AzureCosmosDBVectorSearch(...)
Azure Cosmos DB for MongoDB vCore vector store.
vectorstores.azure_cosmos_db.CosmosDBSimilarityType(value)
Cosmos DB Similarity Type as enumerator.
vectorstores.azure_cosmos_db.CosmosDBVectorSearchType(value)
Cosmos DB Vector Search Type as enumerator.
vectorstores.azuresearch.AzureSearch(...[, ...])
Azure Cognitive Search vector store.
vectorstores.azuresearch.AzureSearchVectorStoreRetriever
Retriever that uses Azure Cognitive Search.
vectorstores.bagel.Bagel([cluster_name, ...])
Bagel.net Inference platform.
vectorstores.baiducloud_vector_search.BESVectorStore(...)
Baidu Elasticsearch vector store.
vectorstores.baiduvectordb.BaiduVectorDB(...)
Baidu VectorDB as a vector store.
vectorstores.baiduvectordb.ConnectionParams(...)
Baidu VectorDB Connection params.
vectorstores.baiduvectordb.TableParams(dimension)
Baidu VectorDB table params.
vectorstores.bigquery_vector_search.BigQueryVectorSearch(...)
[Deprecated] Google Cloud BigQuery vector store.
vectorstores.cassandra.Cassandra(embedding)
Apache Cassandra(R) for vector-store workloads.
vectorstores.chroma.Chroma([...])
ChromaDB vector store.
vectorstores.clarifai.Clarifai([user_id, ...])
Clarifai AI vector store.
vectorstores.clickhouse.Clickhouse(embedding) | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-92 | Clarifai AI vector store.
vectorstores.clickhouse.Clickhouse(embedding)
ClickHouse VectorSearch vector store.
vectorstores.clickhouse.ClickhouseSettings
ClickHouse client configuration.
vectorstores.couchbase.CouchbaseVectorStore(...)
[Deprecated] Couchbase Vector Store vector store.
vectorstores.dashvector.DashVector(...)
DashVector vector store.
vectorstores.databricks_vector_search.DatabricksVectorSearch(...)
Databricks Vector Search vector store.
vectorstores.deeplake.DeepLake([...])
Activeloop Deep Lake vector store.
vectorstores.dingo.Dingo(embedding, text_key, *)
Dingo vector store.
vectorstores.docarray.base.DocArrayIndex(...)
Base class for DocArray based vector stores.
vectorstores.docarray.hnsw.DocArrayHnswSearch(...)
HnswLib storage using DocArray package.
vectorstores.docarray.in_memory.DocArrayInMemorySearch(...)
In-memory DocArray storage for exact search.
vectorstores.documentdb.DocumentDBSimilarityType(value)
DocumentDB Similarity Type as enumerator.
vectorstores.documentdb.DocumentDBVectorSearch(...)
Amazon DocumentDB (with MongoDB compatibility) vector store.
vectorstores.duckdb.DuckDB(*[, connection, ...])
DuckDB vector store.
vectorstores.ecloud_vector_search.EcloudESVectorStore(...)
ecloud Elasticsearch vector store.
vectorstores.elastic_vector_search.ElasticKnnSearch(...)
[Deprecated] [DEPRECATED] Elasticsearch with k-nearest neighbor search (k-NN) vector store.
vectorstores.elastic_vector_search.ElasticVectorSearch(...)
[Deprecated] ElasticVectorSearch uses the brute force method of searching on vectors.
vectorstores.elasticsearch.ApproxRetrievalStrategy([...])
[Deprecated] Approximate retrieval strategy using the HNSW algorithm. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-93 | [Deprecated] Approximate retrieval strategy using the HNSW algorithm.
vectorstores.elasticsearch.BaseRetrievalStrategy()
Base class for Elasticsearch retrieval strategies.
vectorstores.elasticsearch.ElasticsearchStore(...)
[Deprecated] Elasticsearch vector store.
vectorstores.elasticsearch.ExactRetrievalStrategy(...)
[Deprecated] Exact retrieval strategy using the script_score query.
vectorstores.elasticsearch.SparseRetrievalStrategy([...])
[Deprecated] Sparse retrieval strategy using the text_expansion processor.
vectorstores.epsilla.Epsilla(client, embeddings)
Wrapper around Epsilla vector database.
vectorstores.faiss.FAISS(embedding_function, ...)
Meta Faiss vector store.
vectorstores.hanavector.HanaDB(connection, ...)
SAP HANA Cloud Vector Engine
vectorstores.hippo.Hippo(embedding_function)
Hippo vector store.
vectorstores.hologres.Hologres(...[, ndims, ...])
Hologres API vector store.
vectorstores.infinispanvs.Infinispan(**kwargs)
Helper class for Infinispan REST interface.
vectorstores.infinispanvs.InfinispanVS([...])
Infinispan VectorStore interface.
vectorstores.inmemory.InMemoryVectorStore(...)
In-memory implementation of VectorStore using a dictionary.
vectorstores.jaguar.Jaguar(pod, store, ...)
Jaguar API vector store.
vectorstores.kdbai.KDBAI(table, embedding[, ...])
KDB.AI vector store.
vectorstores.kinetica.Dimension(value)
Some default dimensions for known embeddings.
vectorstores.kinetica.DistanceStrategy(value)
Enumerator of the Distance strategies.
vectorstores.kinetica.Kinetica(config, ...)
Kinetica vector store.
vectorstores.kinetica.KineticaSettings
Kinetica client configuration. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-94 | vectorstores.kinetica.KineticaSettings
Kinetica client configuration.
vectorstores.lancedb.LanceDB([connection, ...])
LanceDB vector store.
vectorstores.lantern.BaseEmbeddingStore()
Base class for the Lantern embedding store.
vectorstores.lantern.DistanceStrategy(value)
Enumerator of the Distance strategies.
vectorstores.lantern.Lantern(...[, ...])
Postgres with the lantern extension as a vector store.
vectorstores.lantern.QueryResult()
Result from a query.
vectorstores.llm_rails.LLMRails([...])
Implementation of Vector Store using LLMRails.
vectorstores.llm_rails.LLMRailsRetriever
Retriever for LLMRails.
vectorstores.manticore_search.ManticoreSearch(...)
ManticoreSearch Engine vector store.
vectorstores.manticore_search.ManticoreSearchSettings
Create a new model by parsing and validating input data from keyword arguments.
vectorstores.marqo.Marqo(client, index_name)
Marqo vector store.
vectorstores.matching_engine.MatchingEngine(...)
[Deprecated] Google Vertex AI Vector Search (previously Matching Engine) vector store.
vectorstores.meilisearch.Meilisearch(embedding)
Meilisearch vector store.
vectorstores.milvus.Milvus(embedding_function)
[Deprecated] Milvus vector store.
vectorstores.momento_vector_index.MomentoVectorIndex(...)
Momento Vector Index (MVI) vector store.
vectorstores.mongodb_atlas.MongoDBAtlasVectorSearch(...)
[Deprecated] MongoDB Atlas Vector Search vector store.
vectorstores.myscale.MyScale(embedding[, config])
MyScale vector store.
vectorstores.myscale.MyScaleSettings
MyScale client configuration.
vectorstores.myscale.MyScaleWithoutJSON(...) | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-95 | MyScale client configuration.
vectorstores.myscale.MyScaleWithoutJSON(...)
MyScale vector store without metadata column
vectorstores.neo4j_vector.IndexType(value)
Enumerator of the index types.
vectorstores.neo4j_vector.Neo4jVector(...[, ...])
Neo4j vector index.
vectorstores.neo4j_vector.SearchType(value)
Enumerator of the Distance strategies.
vectorstores.nucliadb.NucliaDB(...[, ...])
NucliaDB vector store.
vectorstores.opensearch_vector_search.OpenSearchVectorSearch(...)
Amazon OpenSearch Vector Engine vector store.
vectorstores.oraclevs.OracleVS(client, ...)
OracleVS vector store.
vectorstores.pathway.PathwayVectorClient([...])
VectorStore connecting to Pathway Vector Store.
vectorstores.pgembedding.BaseModel(**kwargs)
Base model for all SQL stores.
vectorstores.pgembedding.CollectionStore(...)
Collection store.
vectorstores.pgembedding.EmbeddingStore(**kwargs)
Embedding store.
vectorstores.pgembedding.PGEmbedding(...[, ...])
Postgres with the pg_embedding extension as a vector store.
vectorstores.pgembedding.QueryResult()
Result from a query.
vectorstores.pgvecto_rs.PGVecto_rs(...[, ...])
VectorStore backed by pgvecto_rs.
vectorstores.pgvector.BaseModel(**kwargs)
Base model for the SQL stores.
vectorstores.pgvector.DistanceStrategy(value)
Enumerator of the Distance strategies.
vectorstores.pgvector.PGVector(...[, ...])
[Deprecated] Postgres/PGVector vector store.
vectorstores.pinecone.Pinecone(index, ...[, ...])
[Deprecated] Pinecone vector store.
vectorstores.qdrant.Qdrant(client, ...[, ...])
[Deprecated] Qdrant vector store. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-96 | [Deprecated] Qdrant vector store.
vectorstores.qdrant.QdrantException
Qdrant related exceptions.
vectorstores.redis.base.Redis(redis_url, ...)
Redis vector database.
vectorstores.redis.base.RedisVectorStoreRetriever
Retriever for Redis VectorStore.
vectorstores.redis.filters.RedisFilter()
Collection of RedisFilterFields.
vectorstores.redis.filters.RedisFilterExpression([...])
Logical expression of RedisFilterFields.
vectorstores.redis.filters.RedisFilterField(field)
Base class for RedisFilterFields.
vectorstores.redis.filters.RedisFilterOperator(value)
RedisFilterOperator enumerator is used to create RedisFilterExpressions.
vectorstores.redis.filters.RedisNum(field)
RedisFilterField representing a numeric field in a Redis index.
vectorstores.redis.filters.RedisTag(field)
RedisFilterField representing a tag in a Redis index.
vectorstores.redis.filters.RedisText(field)
RedisFilterField representing a text field in a Redis index.
vectorstores.redis.schema.FlatVectorField
Schema for flat vector fields in Redis.
vectorstores.redis.schema.HNSWVectorField
Schema for HNSW vector fields in Redis.
vectorstores.redis.schema.NumericFieldSchema
Schema for numeric fields in Redis.
vectorstores.redis.schema.RedisDistanceMetric(value)
Distance metrics for Redis vector fields.
vectorstores.redis.schema.RedisField
Base class for Redis fields.
vectorstores.redis.schema.RedisModel
Schema for Redis index.
vectorstores.redis.schema.RedisVectorField
Base class for Redis vector fields.
vectorstores.redis.schema.TagFieldSchema
Schema for tag fields in Redis.
vectorstores.redis.schema.TextFieldSchema
Schema for text fields in Redis.
vectorstores.relyt.Relyt(connection_string, ...)
Relyt (distributed PostgreSQL) vector store.
vectorstores.rocksetdb.Rockset(client, ...)
Rockset vector store. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-97 | vectorstores.rocksetdb.Rockset(client, ...)
Rockset vector store.
vectorstores.scann.ScaNN(embedding, index, ...)
ScaNN vector store.
vectorstores.semadb.SemaDB(collection_name, ...)
SemaDB vector store.
vectorstores.singlestoredb.SingleStoreDB(...)
SingleStore DB vector store.
vectorstores.sklearn.BaseSerializer(persist_path)
Base class for serializing data.
vectorstores.sklearn.BsonSerializer(persist_path)
Serialize data in Binary JSON using the bson python package.
vectorstores.sklearn.JsonSerializer(persist_path)
Serialize data in JSON using the json package from python standard library.
vectorstores.sklearn.ParquetSerializer(...)
Serialize data in Apache Parquet format using the pyarrow package.
vectorstores.sklearn.SKLearnVectorStore(...)
Simple in-memory vector store based on the scikit-learn library NearestNeighbors.
vectorstores.sklearn.SKLearnVectorStoreException
Exception raised by SKLearnVectorStore.
vectorstores.sqlitevss.SQLiteVSS(table, ...)
SQLite with VSS extension as a vector database.
vectorstores.starrocks.StarRocks(embedding)
StarRocks vector store.
vectorstores.starrocks.StarRocksSettings
StarRocks client configuration.
vectorstores.supabase.SupabaseVectorStore(...)
Supabase Postgres vector store.
vectorstores.surrealdb.SurrealDBStore(...)
SurrealDB as Vector Store.
vectorstores.tair.Tair(embedding_function, ...)
Tair vector store.
vectorstores.tencentvectordb.ConnectionParams(...)
Tencent vector DB Connection params.
vectorstores.tencentvectordb.IndexParams(...)
Tencent vector DB Index params.
vectorstores.tencentvectordb.MetaField
MetaData Field for Tencent vector DB. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-98 | vectorstores.tencentvectordb.MetaField
MetaData Field for Tencent vector DB.
vectorstores.tencentvectordb.TencentVectorDB(...)
Tencent VectorDB as a vector store.
vectorstores.thirdai_neuraldb.NeuralDBClientVectorStore(db)
Vectorstore that uses ThirdAI's NeuralDB Enterprise Python Client for NeuralDBs.
vectorstores.thirdai_neuraldb.NeuralDBVectorStore(db)
Vectorstore that uses ThirdAI's NeuralDB.
vectorstores.tidb_vector.TiDBVectorStore(...)
TiDB Vector Store.
vectorstores.tigris.Tigris(client, ...)
Tigris vector store.
vectorstores.tiledb.TileDB(embedding, ...[, ...])
TileDB vector store.
vectorstores.timescalevector.TimescaleVector(...)
Timescale Postgres vector store
vectorstores.typesense.Typesense(...[, ...])
Typesense vector store.
vectorstores.upstash.UpstashVectorStore([...])
Upstash Vector vector store
vectorstores.usearch.USearch(embedding, ...)
USearch vector store.
vectorstores.utils.DistanceStrategy(value)
Enumerator of the Distance strategies for calculating distances between vectors.
vectorstores.vald.Vald(embedding[, host, ...])
Vald vector database.
vectorstores.vdms.VDMS(client, *[, ...])
Intel Lab's VDMS for vector-store workloads.
vectorstores.vearch.Vearch(embedding_function)
Initialize vearch vector store flag 1 for cluster,0 for standalone
vectorstores.vectara.MMRConfig([is_enabled, ...])
Configuration for Maximal Marginal Relevance (MMR) search.
vectorstores.vectara.RerankConfig([...])
Configuration for Reranker.
vectorstores.vectara.SummaryConfig([...])
Configuration for summary generation. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-99 | vectorstores.vectara.SummaryConfig([...])
Configuration for summary generation.
vectorstores.vectara.Vectara([...])
Vectara API vector store.
vectorstores.vectara.VectaraQueryConfig([k, ...])
Configuration for Vectara query.
vectorstores.vectara.VectaraRAG(vectara, config)
vectorstores.vectara.VectaraRetriever
Vectara Retriever class.
vectorstores.vespa.VespaStore(app[, ...])
Vespa vector store.
vectorstores.vikingdb.VikingDB(...[, ...])
vikingdb as a vector store
vectorstores.vikingdb.VikingDBConfig([host, ...])
vikingdb connection config
vectorstores.vlite.VLite(embedding_function)
VLite is a simple and fast vector database for semantic search.
vectorstores.weaviate.Weaviate(client, ...)
Weaviate vector store.
vectorstores.xata.XataVectorStore(api_key, ...)
Xata vector store.
vectorstores.yellowbrick.Yellowbrick(...[, ...])
Yellowbrick as a vector database.
vectorstores.zep.CollectionConfig(name, ...)
Configuration for a Zep Collection.
vectorstores.zep.ZepVectorStore(...[, ...])
Zep vector store.
vectorstores.zep_cloud.ZepCloudVectorStore(...)
Zep vector store.
vectorstores.zilliz.Zilliz(embedding_function)
Zilliz vector store.
Functions¶
vectorstores.alibabacloud_opensearch.create_metadata(fields)
Create metadata from fields.
vectorstores.annoy.dependable_annoy_import()
Import annoy if available, otherwise raise error.
vectorstores.clickhouse.has_mul_sub_str(s, *args)
Check if a string contains multiple substrings. | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-100 | Check if a string contains multiple substrings.
vectorstores.faiss.dependable_faiss_import([...])
Import faiss if available, otherwise raise error.
vectorstores.lancedb.import_lancedb()
Import lancedb package.
vectorstores.lantern.get_embedding_store(...)
Get the embedding store class.
vectorstores.myscale.has_mul_sub_str(s, *args)
Check if a string contains multiple substrings.
vectorstores.neo4j_vector.check_if_not_null(...)
Check if the values are not None or empty string
vectorstores.neo4j_vector.collect_params(...)
Transform the input data into the desired format.
vectorstores.neo4j_vector.combine_queries(...)
Combine multiple queries with an operator.
vectorstores.neo4j_vector.construct_metadata_filter(filter)
Construct a metadata filter.
vectorstores.neo4j_vector.dict_to_yaml_str(...)
Convert a dictionary to a YAML-like string without using external libraries.
vectorstores.neo4j_vector.remove_lucene_chars(text)
Remove Lucene special characters
vectorstores.neo4j_vector.sort_by_index_name(...)
Sort first element to match the index_name if exists
vectorstores.oraclevs.create_index(client, ...)
vectorstores.oraclevs.drop_index_if_exists(...)
vectorstores.oraclevs.drop_table_purge(...)
vectorstores.qdrant.sync_call_fallback(method)
Decorator to call the synchronous method of the class if the async method is not implemented.
vectorstores.redis.base.check_index_exists(...)
Check if Redis index exists.
vectorstores.redis.filters.check_operator_misuse(func)
Decorator to check for misuse of equality operators.
vectorstores.redis.schema.read_schema(...)
Read in the index schema from a dict or yaml file.
vectorstores.scann.dependable_scann_import()
Import scann if available, otherwise raise error.
vectorstores.scann.normalize(x) | https://api.python.langchain.com/en/latest/community_api_reference.html |
5ac1b6cc5af2-101 | Import scann if available, otherwise raise error.
vectorstores.scann.normalize(x)
Normalize vectors to unit length.
vectorstores.starrocks.debug_output(s)
Print a debug message if DEBUG is True.
vectorstores.starrocks.get_named_result(...)
Get a named result from a query.
vectorstores.starrocks.has_mul_sub_str(s, *args)
Check if a string has multiple substrings.
vectorstores.tencentvectordb.translate_filter(...)
Translate LangChain filter to Tencent VectorDB filter.
vectorstores.tiledb.dependable_tiledb_import()
Import tiledb-vector-search if available, otherwise raise error.
vectorstores.tiledb.get_documents_array_uri(uri)
Get the URI of the documents array.
vectorstores.tiledb.get_documents_array_uri_from_group(group)
Get the URI of the documents array from group.
vectorstores.tiledb.get_vector_index_uri(uri)
Get the URI of the vector index.
vectorstores.tiledb.get_vector_index_uri_from_group(group)
Get the URI of the vector index.
vectorstores.usearch.dependable_usearch_import()
Import usearch if available, otherwise raise error.
vectorstores.utils.filter_complex_metadata(...)
Filter out metadata types that are not supported for a vector store.
vectorstores.utils.maximal_marginal_relevance(...)
Calculate maximal marginal relevance.
vectorstores.vdms.VDMS_Client([host, port])
VDMS client for the VDMS server.
vectorstores.vdms.embedding2bytes(embedding)
Convert embedding to bytes. | https://api.python.langchain.com/en/latest/community_api_reference.html |
6e21b44b7ec3-0 | langchain_mongodb 0.1.6¶ | https://api.python.langchain.com/en/latest/mongodb_api_reference.html |
747d29749e1f-0 | langchain_robocorp 0.0.9.post1¶
langchain_robocorp.toolkits¶
Robocorp Action Server toolkit.
Classes¶
toolkits.ActionServerRequestTool
Requests POST tool with LLM-instructed extraction of truncated responses.
toolkits.ActionServerToolkit
Toolkit exposing Robocorp Action Server provided actions as individual tools.
toolkits.RunDetailsCallbackHandler(run_details)
Callback handler to add run details to the run.
toolkits.ToolArgs
Tool arguments.
toolkits.ToolInputSchema
Tool input schema. | https://api.python.langchain.com/en/latest/robocorp_api_reference.html |
d19dc24a9dfa-0 | langchain_pinecone 0.1.1¶
langchain_pinecone.vectorstores¶
Classes¶
vectorstores.Pinecone([index, embedding, ...])
[Deprecated] Deprecated.
vectorstores.PineconeVectorStore([index, ...])
Pinecone vector store. | https://api.python.langchain.com/en/latest/pinecone_api_reference.html |
d865d3d587fa-0 | langchain_milvus 0.1.1¶
langchain_milvus.retrievers¶
Classes¶
retrievers.milvus_hybrid_search.MilvusCollectionHybridSearchRetriever
This is a hybrid search retriever that uses Milvus Collection to retrieve documents based on multiple fields.
retrievers.zilliz_cloud_pipeline_retriever.ZillizCloudPipelineRetriever
Zilliz Cloud Pipeline retriever
langchain_milvus.utils¶
Classes¶
utils.sparse.BM25SparseEmbedding(corpus[, ...])
This is a class that inherits BaseSparseEmbedding and implements a sparse vector embedding model based on BM25.
utils.sparse.BaseSparseEmbedding()
Interface for Sparse embedding models.
langchain_milvus.vectorstores¶
Classes¶
vectorstores.milvus.Milvus(embedding_function)
Milvus vector store.
vectorstores.zilliz.Zilliz(embedding_function)
Zilliz vector store.
Functions¶
vectorstores.milvus.cosine_similarity(X, Y)
Row-wise cosine similarity between two equal-width matrices.
vectorstores.milvus.maximal_marginal_relevance(...)
Calculate maximal marginal relevance. | https://api.python.langchain.com/en/latest/milvus_api_reference.html |
f44d1295a5c3-0 | langchain_ibm 0.1.7¶ | https://api.python.langchain.com/en/latest/ibm_api_reference.html |
b76c696f3bb5-0 | langchain_elasticsearch 0.2.2¶
langchain_elasticsearch.cache¶
Classes¶
cache.ElasticsearchCache(index_name[, ...])
An Elasticsearch cache integration for LLMs.
cache.ElasticsearchEmbeddingsCache(index_name)
An Elasticsearch store for caching embeddings.
langchain_elasticsearch.chat_history¶
Classes¶
chat_history.ElasticsearchChatMessageHistory(...)
Chat message history that stores history in Elasticsearch.
langchain_elasticsearch.client¶
Functions¶
client.create_elasticsearch_client([url, ...])
langchain_elasticsearch.embeddings¶
Classes¶
embeddings.ElasticsearchEmbeddings(client, ...)
Elasticsearch embedding models.
embeddings.EmbeddingServiceAdapter(...)
Adapter for LangChain Embeddings to support the EmbeddingService interface from elasticsearch.helpers.vectorstore.
langchain_elasticsearch.retrievers¶
Classes¶
retrievers.ElasticsearchRetriever
Elasticsearch retriever
langchain_elasticsearch.vectorstores¶
Classes¶
vectorstores.ApproxRetrievalStrategy([...])
[Deprecated] Approximate retrieval strategy using the HNSW algorithm.
vectorstores.BM25RetrievalStrategy([k1, b])
[Deprecated] Retrieval strategy using the native BM25 algorithm of Elasticsearch.
vectorstores.BaseRetrievalStrategy(*args, ...)
[Deprecated] Base class for Elasticsearch retrieval strategies.
vectorstores.ElasticsearchStore(index_name, ...)
Elasticsearch vector store.
vectorstores.ExactRetrievalStrategy(*args, ...)
[Deprecated] Exact retrieval strategy using the script_score query.
vectorstores.SparseRetrievalStrategy([model_id])
[Deprecated] Sparse retrieval strategy using the text_expansion processor. | https://api.python.langchain.com/en/latest/elasticsearch_api_reference.html |
ebfb0169afcf-0 | langchain_airbyte 0.1.1¶ | https://api.python.langchain.com/en/latest/airbyte_api_reference.html |
18fd61a34d1a-0 | langchain_together 0.1.3¶
langchain_together.chat_models¶
Wrapper around Together AI’s Chat Completions API.
Classes¶
chat_models.ChatTogether
ChatTogether chat model.
langchain_together.embeddings¶
Wrapper around Together AI’s Embeddings API.
Classes¶
embeddings.TogetherEmbeddings
TogetherEmbeddings embedding model.
langchain_together.llms¶
Wrapper around Together AI’s Completion API.
Classes¶
llms.Together
LLM models from Together. | https://api.python.langchain.com/en/latest/together_api_reference.html |
fdd543c40c31-0 | langchain_chroma 0.1.1¶
langchain_chroma.vectorstores¶
Classes¶
vectorstores.Chroma([collection_name, ...])
ChromaDB vector store.
Functions¶
vectorstores.cosine_similarity(X, Y)
Row-wise cosine similarity between two equal-width matrices.
vectorstores.maximal_marginal_relevance(...)
Calculate maximal marginal relevance. | https://api.python.langchain.com/en/latest/chroma_api_reference.html |
c809063b5752-0 | langchain_prompty 0.0.2¶
langchain_prompty.core¶
Classes¶
core.Frontmatter()
core.Invoker(prompty)
core.InvokerFactory()
core.ModelSettings
Create a new model by parsing and validating input data from keyword arguments.
core.NoOpParser(prompty)
core.Prompty
Create a new model by parsing and validating input data from keyword arguments.
core.PropertySettings
Create a new model by parsing and validating input data from keyword arguments.
core.SimpleModel
Create a new model by parsing and validating input data from keyword arguments.
core.TemplateSettings
Create a new model by parsing and validating input data from keyword arguments.
Functions¶
core.param_hoisting(top, bottom[, top_key])
langchain_prompty.langchain¶
Functions¶
langchain.create_chat_prompt(path[, ...])
langchain_prompty.parsers¶
Classes¶
parsers.PromptyChatParser(prompty)
langchain_prompty.renderers¶
Classes¶
renderers.MustacheRenderer(prompty)
langchain_prompty.utils¶
Functions¶
utils.execute(prompt[, configuration, ...])
utils.load(prompt_path[, configuration])
utils.prepare(prompt[, inputs])
utils.run(prompt, content[, configuration, ...]) | https://api.python.langchain.com/en/latest/prompty_api_reference.html |
410970988dfd-0 | langchain_groq 0.1.5¶
langchain_groq.chat_models¶
Groq Chat wrapper.
Classes¶
chat_models.ChatGroq
Groq Chat large language models API. | https://api.python.langchain.com/en/latest/groq_api_reference.html |
e1cacb2a7f03-0 | langchain_nomic 0.1.2¶
langchain_nomic.embeddings¶
Classes¶
embeddings.NomicEmbeddings()
NomicEmbeddings embedding model. | https://api.python.langchain.com/en/latest/nomic_api_reference.html |
eb5ace532d34-0 | langchain_openai 0.1.8¶
langchain_openai.chat_models¶
Classes¶
chat_models.azure.AzureChatOpenAI
Azure OpenAI Chat Completion API.
chat_models.base.BaseChatOpenAI
Create a new model by parsing and validating input data from keyword arguments.
chat_models.base.ChatOpenAI
OpenAI chat model integration.
langchain_openai.embeddings¶
Classes¶
embeddings.azure.AzureOpenAIEmbeddings
Azure OpenAI Embeddings API.
embeddings.base.OpenAIEmbeddings
OpenAI embedding models.
langchain_openai.llms¶
Classes¶
llms.azure.AzureOpenAI
Azure-specific OpenAI large language models.
llms.base.BaseOpenAI
Base OpenAI large language model class.
llms.base.OpenAI
OpenAI large language models. | https://api.python.langchain.com/en/latest/openai_api_reference.html |
f123fad1ea8f-0 | langchain_huggingface 0.0.3¶
langchain_huggingface.chat_models¶
Classes¶
chat_models.huggingface.ChatHuggingFace
Wrapper for using Hugging Face LLM's as ChatModels.
chat_models.huggingface.TGI_MESSAGE(role, ...)
chat_models.huggingface.TGI_RESPONSE(...)
langchain_huggingface.embeddings¶
Classes¶
embeddings.huggingface.HuggingFaceEmbeddings
HuggingFace sentence_transformers embedding models.
embeddings.huggingface_endpoint.HuggingFaceEndpointEmbeddings
HuggingFaceHub embedding models.
langchain_huggingface.llms¶
Classes¶
llms.huggingface_endpoint.HuggingFaceEndpoint
HuggingFace Endpoint.
llms.huggingface_pipeline.HuggingFacePipeline
HuggingFace Pipeline API. | https://api.python.langchain.com/en/latest/huggingface_api_reference.html |
af6afe90327e-0 | langchain_core 0.2.5¶
langchain_core.agents¶
Agent is a class that uses an LLM to choose a sequence of actions to take.
In Chains, a sequence of actions is hardcoded. In Agents,
a language model is used as a reasoning engine to determine which actions
to take and in which order.
Agents select and use Tools and Toolkits for actions.
Class hierarchy:
BaseSingleActionAgent --> LLMSingleActionAgent
OpenAIFunctionsAgent
XMLAgent
Agent --> <name>Agent # Examples: ZeroShotAgent, ChatAgent
BaseMultiActionAgent --> OpenAIMultiFunctionsAgent
Main helpers:
AgentType, AgentExecutor, AgentOutputParser, AgentExecutorIterator,
AgentAction, AgentFinish, AgentStep
Classes¶
agents.AgentAction
A full description of an action for an ActionAgent to execute.
agents.AgentActionMessageLog
Override init to support instantiation by position for backward compat.
agents.AgentFinish
The final return value of an ActionAgent.
agents.AgentStep
The result of running an AgentAction.
langchain_core.beta¶
Some beta features that are not yet ready for production.
Classes¶
beta.runnables.context.Context()
Context for a runnable.
beta.runnables.context.ContextGet
[Beta] Get a context value.
beta.runnables.context.ContextSet
[Beta] Set a context value.
beta.runnables.context.PrefixContext([prefix])
Context for a runnable with a prefix.
Functions¶
beta.runnables.context.aconfig_with_context(...)
Asynchronously patch a runnable config with context getters and setters.
beta.runnables.context.config_with_context(...)
Patch a runnable config with context getters and setters.
langchain_core.caches¶
Warning
Beta Feature!
Cache provides an optional caching layer for LLMs. | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-1 | Warning
Beta Feature!
Cache provides an optional caching layer for LLMs.
Cache is useful for two reasons:
It can save you money by reducing the number of API calls you make to the LLM
provider if you’re often requesting the same completion multiple times.
It can speed up your application by reducing the number of API calls you make
to the LLM provider.
Cache directly competes with Memory. See documentation for Pros and Cons.
Class hierarchy:
BaseCache --> <name>Cache # Examples: InMemoryCache, RedisCache, GPTCache
Classes¶
caches.BaseCache()
This interfaces provides a caching layer for LLMs and Chat models.
caches.InMemoryCache()
Cache that stores things in memory.
langchain_core.callbacks¶
Callback handlers allow listening to events in LangChain.
Class hierarchy:
BaseCallbackHandler --> <name>CallbackHandler # Example: AimCallbackHandler
Classes¶
callbacks.base.AsyncCallbackHandler()
Async callback handler that handles callbacks from LangChain.
callbacks.base.BaseCallbackHandler()
Base callback handler that handles callbacks from LangChain.
callbacks.base.BaseCallbackManager(handlers)
Base callback manager that handles callbacks from LangChain.
callbacks.base.CallbackManagerMixin()
Mixin for callback manager.
callbacks.base.ChainManagerMixin()
Mixin for chain callbacks.
callbacks.base.LLMManagerMixin()
Mixin for LLM callbacks.
callbacks.base.RetrieverManagerMixin()
Mixin for Retriever callbacks.
callbacks.base.RunManagerMixin()
Mixin for run manager.
callbacks.base.ToolManagerMixin()
Mixin for tool callbacks.
callbacks.file.FileCallbackHandler(filename)
Callback Handler that writes to a file.
callbacks.manager.AsyncCallbackManager(handlers)
Async callback manager that handles callbacks from LangChain.
callbacks.manager.AsyncCallbackManagerForChainGroup(...)
Async callback manager for the chain group. | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-2 | callbacks.manager.AsyncCallbackManagerForChainGroup(...)
Async callback manager for the chain group.
callbacks.manager.AsyncCallbackManagerForChainRun(*, ...)
Async callback manager for chain run.
callbacks.manager.AsyncCallbackManagerForLLMRun(*, ...)
Async callback manager for LLM run.
callbacks.manager.AsyncCallbackManagerForRetrieverRun(*, ...)
Async callback manager for retriever run.
callbacks.manager.AsyncCallbackManagerForToolRun(*, ...)
Async callback manager for tool run.
callbacks.manager.AsyncParentRunManager(*, ...)
Async Parent Run Manager.
callbacks.manager.AsyncRunManager(*, run_id, ...)
Async Run Manager.
callbacks.manager.BaseRunManager(*, run_id, ...)
Base class for run manager (a bound callback manager).
callbacks.manager.CallbackManager(handlers)
Callback manager that handles callbacks from LangChain.
callbacks.manager.CallbackManagerForChainGroup(...)
Callback manager for the chain group.
callbacks.manager.CallbackManagerForChainRun(*, ...)
Callback manager for chain run.
callbacks.manager.CallbackManagerForLLMRun(*, ...)
Callback manager for LLM run.
callbacks.manager.CallbackManagerForRetrieverRun(*, ...)
Callback manager for retriever run.
callbacks.manager.CallbackManagerForToolRun(*, ...)
Callback manager for tool run.
callbacks.manager.ParentRunManager(*, ...[, ...])
Sync Parent Run Manager.
callbacks.manager.RunManager(*, run_id, ...)
Sync Run Manager.
callbacks.stdout.StdOutCallbackHandler([color])
Callback Handler that prints to std out.
callbacks.streaming_stdout.StreamingStdOutCallbackHandler()
Callback handler for streaming.
Functions¶
callbacks.manager.ahandle_event(handlers, ...)
Generic event handler for AsyncCallbackManager.
callbacks.manager.atrace_as_chain_group(...) | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-3 | Generic event handler for AsyncCallbackManager.
callbacks.manager.atrace_as_chain_group(...)
Get an async callback manager for a chain group in a context manager.
callbacks.manager.handle_event(handlers, ...)
Generic event handler for CallbackManager.
callbacks.manager.shielded(func)
Makes so an awaitable method is always shielded from cancellation
callbacks.manager.trace_as_chain_group(...)
Get a callback manager for a chain group in a context manager.
langchain_core.chat_history¶
Chat message history stores a history of the message interactions in a chat.
Class hierarchy:
BaseChatMessageHistory --> <name>ChatMessageHistory # Examples: FileChatMessageHistory, PostgresChatMessageHistory
Main helpers:
AIMessage, HumanMessage, BaseMessage
Classes¶
chat_history.BaseChatMessageHistory()
Abstract base class for storing chat message history.
chat_history.InMemoryChatMessageHistory
In memory implementation of chat message history.
langchain_core.chat_loaders¶
Classes¶
chat_loaders.BaseChatLoader()
Base class for chat loaders.
langchain_core.chat_sessions¶
Chat Sessions are a collection of messages and function calls.
Classes¶
chat_sessions.ChatSession
Chat Session represents a single conversation, channel, or other group of messages.
langchain_core.document_loaders¶
Classes¶
document_loaders.base.BaseBlobParser()
Abstract interface for blob parsers.
document_loaders.base.BaseLoader()
Interface for Document Loader.
document_loaders.blob_loaders.Blob
Blob represents raw data by either reference or value.
document_loaders.blob_loaders.BlobLoader()
Abstract interface for blob loaders implementation.
langchain_core.documents¶
Document module is a collection of classes that handle documents
and their transformations.
Classes¶
documents.base.Document
Class for storing a piece of text and associated metadata.
documents.compressor.BaseDocumentCompressor | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-4 | Class for storing a piece of text and associated metadata.
documents.compressor.BaseDocumentCompressor
Base class for document compressors.
documents.transformers.BaseDocumentTransformer()
Abstract base class for document transformation systems.
langchain_core.embeddings¶
Classes¶
embeddings.embeddings.Embeddings()
Interface for embedding models.
embeddings.fake.DeterministicFakeEmbedding
Fake embedding model that always returns the same embedding vector for the same text.
embeddings.fake.FakeEmbeddings
Fake embedding model.
langchain_core.example_selectors¶
Example selector implements logic for selecting examples to include them
in prompts.
This allows us to select examples that are most relevant to the input.
Classes¶
example_selectors.base.BaseExampleSelector()
Interface for selecting examples to include in prompts.
example_selectors.length_based.LengthBasedExampleSelector
Select examples based on length.
example_selectors.semantic_similarity.MaxMarginalRelevanceExampleSelector
Select examples based on Max Marginal Relevance.
example_selectors.semantic_similarity.SemanticSimilarityExampleSelector
Select examples based on semantic similarity.
Functions¶
example_selectors.semantic_similarity.sorted_values(values)
Return a list of values in dict sorted by key.
langchain_core.exceptions¶
Custom exceptions for LangChain.
Classes¶
exceptions.LangChainException
General LangChain exception.
exceptions.OutputParserException(error[, ...])
Exception that output parsers should raise to signify a parsing error.
exceptions.TracerException
Base class for exceptions in tracers module.
langchain_core.globals¶
Global values and configuration that apply to all of LangChain.
Functions¶
globals.get_debug()
Get the value of the debug global setting.
globals.get_llm_cache()
Get the value of the llm_cache global setting.
globals.get_verbose()
Get the value of the verbose global setting.
globals.set_debug(value) | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-5 | Get the value of the verbose global setting.
globals.set_debug(value)
Set a new value for the debug global setting.
globals.set_llm_cache(value)
Set a new LLM cache, overwriting the previous value, if any.
globals.set_verbose(value)
Set a new value for the verbose global setting.
langchain_core.indexing¶
Code to help indexing data into a vectorstore.
This package contains helper logic to help deal with indexing data into
a vectorstore while avoiding duplicated content and over-writing content
if it’s unchanged.
Classes¶
indexing.api.IndexingResult
Return a detailed a breakdown of the result of the indexing operation.
indexing.base.RecordManager(namespace)
Abstract base class representing the interface for a record manager.
Functions¶
indexing.api.aindex(docs_source, ...[, ...])
Index data from the loader into the vector store.
indexing.api.index(docs_source, ...[, ...])
Index data from the loader into the vector store.
langchain_core.language_models¶
Language Model is a type of model that can generate text or complete
text prompts.
LangChain has two main classes to work with language models:
- LLM classes provide access to the large language model (LLM) APIs and services.
- Chat Models are a variation on language models.
Class hierarchy:
BaseLanguageModel --> BaseLLM --> LLM --> <name> # Examples: AI21, HuggingFaceHub, OpenAI
--> BaseChatModel --> <name> # Examples: ChatOpenAI, ChatGooglePalm
Main helpers:
LLMResult, PromptValue,
CallbackManagerForLLMRun, AsyncCallbackManagerForLLMRun,
CallbackManager, AsyncCallbackManager,
AIMessage, BaseMessage, HumanMessage
Classes¶
language_models.base.BaseLanguageModel | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-6 | AIMessage, BaseMessage, HumanMessage
Classes¶
language_models.base.BaseLanguageModel
Abstract base class for interfacing with language models.
language_models.chat_models.BaseChatModel
Base class for Chat models.
language_models.chat_models.LangSmithParams
language_models.chat_models.SimpleChatModel
Simplified implementation for a chat model to inherit from.
language_models.fake.FakeListLLM
Fake LLM for testing purposes.
language_models.fake.FakeStreamingListLLM
Fake streaming list LLM for testing purposes.
language_models.fake_chat_models.FakeChatModel
Fake Chat Model wrapper for testing purposes.
language_models.fake_chat_models.FakeListChatModel
Fake ChatModel for testing purposes.
language_models.fake_chat_models.FakeMessagesListChatModel
Fake ChatModel for testing purposes.
language_models.fake_chat_models.GenericFakeChatModel
Generic fake chat model that can be used to test the chat model interface.
language_models.fake_chat_models.ParrotFakeChatModel
Generic fake chat model that can be used to test the chat model interface.
language_models.llms.BaseLLM
Base LLM abstract interface.
language_models.llms.LLM
Simple interface for implementing a custom LLM.
Functions¶
language_models.chat_models.agenerate_from_stream(stream)
Async generate from a stream.
language_models.chat_models.generate_from_stream(stream)
Generate from a stream.
language_models.llms.aget_prompts(params, ...)
Get prompts that are already cached.
language_models.llms.aupdate_cache(cache, ...)
Update the cache and get the LLM output.
language_models.llms.create_base_retry_decorator(...)
Create a retry decorator for a given LLM and provided list of error types.
language_models.llms.get_prompts(params, prompts)
Get prompts that are already cached.
language_models.llms.update_cache(cache, ...) | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-7 | Get prompts that are already cached.
language_models.llms.update_cache(cache, ...)
Update the cache and get the LLM output.
langchain_core.load¶
Load module helps with serialization and deserialization.
Classes¶
load.load.Reviver([secrets_map, ...])
Reviver for JSON objects.
load.serializable.BaseSerialized
Base class for serialized objects.
load.serializable.Serializable
Serializable base class.
load.serializable.SerializedConstructor
Serialized constructor.
load.serializable.SerializedNotImplemented
Serialized not implemented.
load.serializable.SerializedSecret
Serialized secret.
Functions¶
load.dump.default(obj)
Return a default value for a Serializable object or a SerializedNotImplemented object.
load.dump.dumpd(obj)
Return a json dict representation of an object.
load.dump.dumps(obj, *[, pretty])
Return a json string representation of an object.
load.load.load(obj, *[, secrets_map, ...])
[Beta] Revive a LangChain class from a JSON object.
load.load.loads(text, *[, secrets_map, ...])
[Beta] Revive a LangChain class from a JSON string.
load.serializable.to_json_not_implemented(obj)
Serialize a "not implemented" object.
load.serializable.try_neq_default(value, ...)
Try to determine if a value is different from the default.
langchain_core.memory¶
Memory maintains Chain state, incorporating context from past runs.
Class hierarchy for Memory:
BaseMemory --> <name>Memory --> <name>Memory # Examples: BaseChatMemory -> MotorheadMemory
Classes¶
memory.BaseMemory
Abstract base class for memory in Chains.
langchain_core.messages¶
Messages are objects used in prompts and chat conversations.
Class hierarchy: | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-8 | Messages are objects used in prompts and chat conversations.
Class hierarchy:
BaseMessage --> SystemMessage, AIMessage, HumanMessage, ChatMessage, FunctionMessage, ToolMessage
--> BaseMessageChunk --> SystemMessageChunk, AIMessageChunk, HumanMessageChunk, ChatMessageChunk, FunctionMessageChunk, ToolMessageChunk
Main helpers:
ChatPromptTemplate
Classes¶
messages.ai.AIMessage
Message from an AI.
messages.ai.AIMessageChunk
Message chunk from an AI.
messages.ai.UsageMetadata
Usage metadata for a message, such as token counts.
messages.base.BaseMessage
Base abstract Message class.
messages.base.BaseMessageChunk
Message chunk, which can be concatenated with other Message chunks.
messages.chat.ChatMessage
Message that can be assigned an arbitrary speaker (i.e.
messages.chat.ChatMessageChunk
Chat Message chunk.
messages.function.FunctionMessage
Message for passing the result of executing a function back to a model.
messages.function.FunctionMessageChunk
Function Message chunk.
messages.human.HumanMessage
Message from a human.
messages.human.HumanMessageChunk
Human Message chunk.
messages.system.SystemMessage
Message for priming AI behavior, usually passed in as the first of a sequence of input messages.
messages.system.SystemMessageChunk
System Message chunk.
messages.tool.InvalidToolCall
Allowance for errors made by LLM.
messages.tool.ToolCall
Represents a request to call a tool.
messages.tool.ToolCallChunk
A chunk of a tool call (e.g., as part of a stream).
messages.tool.ToolMessage
Message for passing the result of executing a tool back to a model.
messages.tool.ToolMessageChunk
Tool Message chunk.
Functions¶
messages.base.get_msg_title_repr(title, *[, ...])
Get a title representation for a message.
messages.base.merge_content(first_content, ...) | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-9 | Get a title representation for a message.
messages.base.merge_content(first_content, ...)
Merge two message contents.
messages.base.message_to_dict(message)
Convert a Message to a dictionary.
messages.base.messages_to_dict(messages)
Convert a sequence of Messages to a list of dictionaries.
messages.tool.default_tool_chunk_parser(...)
Best-effort parsing of tool chunks.
messages.tool.default_tool_parser(raw_tool_calls)
Best-effort parsing of tools.
messages.utils.convert_to_messages(messages)
Convert a sequence of messages to a list of messages.
messages.utils.get_buffer_string(messages[, ...])
Convert a sequence of Messages to strings and concatenate them into one string.
messages.utils.message_chunk_to_message(chunk)
Convert a message chunk to a message.
messages.utils.messages_from_dict(messages)
Convert a sequence of messages from dicts to Message objects.
langchain_core.output_parsers¶
OutputParser classes parse the output of an LLM call.
Class hierarchy:
BaseLLMOutputParser --> BaseOutputParser --> <name>OutputParser # ListOutputParser, PydanticOutputParser
Main helpers:
Serializable, Generation, PromptValue
Classes¶
output_parsers.base.BaseGenerationOutputParser
Base class to parse the output of an LLM call.
output_parsers.base.BaseLLMOutputParser()
Abstract base class for parsing the outputs of a model.
output_parsers.base.BaseOutputParser
Base class to parse the output of an LLM call.
output_parsers.json.JsonOutputParser
Parse the output of an LLM call to a JSON object.
output_parsers.json.SimpleJsonOutputParser
alias of JsonOutputParser
output_parsers.list.CommaSeparatedListOutputParser
Parse the output of an LLM call to a comma-separated list.
output_parsers.list.ListOutputParser
Parse the output of an LLM call to a list. | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-10 | Parse the output of an LLM call to a list.
output_parsers.list.MarkdownListOutputParser
Parse a markdown list.
output_parsers.list.NumberedListOutputParser
Parse a numbered list.
output_parsers.openai_functions.JsonKeyOutputFunctionsParser
Parse an output as the element of the Json object.
output_parsers.openai_functions.JsonOutputFunctionsParser
Parse an output as the Json object.
output_parsers.openai_functions.OutputFunctionsParser
Parse an output that is one of sets of values.
output_parsers.openai_functions.PydanticAttrOutputFunctionsParser
Parse an output as an attribute of a pydantic object.
output_parsers.openai_functions.PydanticOutputFunctionsParser
Parse an output as a pydantic object.
output_parsers.openai_tools.JsonOutputKeyToolsParser
Parse tools from OpenAI response.
output_parsers.openai_tools.JsonOutputToolsParser
Parse tools from OpenAI response.
output_parsers.openai_tools.PydanticToolsParser
Parse tools from OpenAI response.
output_parsers.pydantic.PydanticOutputParser
Parse an output using a pydantic model.
output_parsers.string.StrOutputParser
OutputParser that parses LLMResult into the top likely string.
output_parsers.transform.BaseCumulativeTransformOutputParser
Base class for an output parser that can handle streaming input.
output_parsers.transform.BaseTransformOutputParser
Base class for an output parser that can handle streaming input.
output_parsers.xml.XMLOutputParser
Parse an output using xml format.
Functions¶
output_parsers.list.droplastn(iter, n)
Drop the last n elements of an iterator.
output_parsers.openai_tools.make_invalid_tool_call(...)
Create an InvalidToolCall from a raw tool call.
output_parsers.openai_tools.parse_tool_call(...) | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-11 | output_parsers.openai_tools.parse_tool_call(...)
Parse a single tool call.
output_parsers.openai_tools.parse_tool_calls(...)
Parse a list of tool calls.
output_parsers.xml.nested_element(path, elem)
Get nested element from path.
langchain_core.outputs¶
Output classes are used to represent the output of a language model call
and the output of a chat.
Classes¶
outputs.chat_generation.ChatGeneration
A single chat generation output.
outputs.chat_generation.ChatGenerationChunk
ChatGeneration chunk, which can be concatenated with other
outputs.chat_result.ChatResult
Class that contains all results for a single chat model call.
outputs.generation.Generation
A single text generation output.
outputs.generation.GenerationChunk
Generation chunk, which can be concatenated with other Generation chunks.
outputs.llm_result.LLMResult
Class that contains all results for a batched LLM call.
outputs.run_info.RunInfo
Class that contains metadata for a single execution of a Chain or model.
langchain_core.prompt_values¶
Prompt values for language model prompts.
Prompt values are used to represent different pieces of prompts.
They can be used to represent text, images, or chat message pieces.
Classes¶
prompt_values.ChatPromptValue
Chat prompt value.
prompt_values.ChatPromptValueConcrete
Chat prompt value which explicitly lists out the message types it accepts.
prompt_values.ImagePromptValue
Image prompt value.
prompt_values.ImageURL
Image URL.
prompt_values.PromptValue
Base abstract class for inputs to any language model.
prompt_values.StringPromptValue
String prompt value.
langchain_core.prompts¶
Prompt is the input to the model.
Prompt is often constructed
from multiple components and prompt values. Prompt classes and functions make constructing
and working with prompts easy.
Class hierarchy:
BasePromptTemplate --> PipelinePromptTemplate
StringPromptTemplate --> PromptTemplate | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-12 | Class hierarchy:
BasePromptTemplate --> PipelinePromptTemplate
StringPromptTemplate --> PromptTemplate
FewShotPromptTemplate
FewShotPromptWithTemplates
BaseChatPromptTemplate --> AutoGPTPrompt
ChatPromptTemplate --> AgentScratchPadChatPromptTemplate
BaseMessagePromptTemplate --> MessagesPlaceholder
BaseStringMessagePromptTemplate --> ChatMessagePromptTemplate
HumanMessagePromptTemplate
AIMessagePromptTemplate
SystemMessagePromptTemplate
Classes¶
prompts.base.BasePromptTemplate
Base class for all prompt templates, returning a prompt.
prompts.chat.AIMessagePromptTemplate
AI message prompt template.
prompts.chat.BaseChatPromptTemplate
Base class for chat prompt templates.
prompts.chat.BaseMessagePromptTemplate
Base class for message prompt templates.
prompts.chat.BaseStringMessagePromptTemplate
Base class for message prompt templates that use a string prompt template.
prompts.chat.ChatMessagePromptTemplate
Chat message prompt template.
prompts.chat.ChatPromptTemplate
Prompt template for chat models.
prompts.chat.HumanMessagePromptTemplate
Human message prompt template.
prompts.chat.MessagesPlaceholder
Prompt template that assumes variable is already list of messages.
prompts.chat.SystemMessagePromptTemplate
System message prompt template.
prompts.few_shot.FewShotChatMessagePromptTemplate
Chat prompt template that supports few-shot examples.
prompts.few_shot.FewShotPromptTemplate
Prompt template that contains few shot examples.
prompts.few_shot_with_templates.FewShotPromptWithTemplates
Prompt template that contains few shot examples.
prompts.image.ImagePromptTemplate
Image prompt template for a multimodal model.
prompts.pipeline.PipelinePromptTemplate
Prompt template for composing multiple prompt templates together.
prompts.prompt.PromptTemplate
Prompt template for a language model.
prompts.string.StringPromptTemplate
String prompt that exposes the format method, returning a prompt. | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-13 | prompts.string.StringPromptTemplate
String prompt that exposes the format method, returning a prompt.
prompts.structured.StructuredPrompt
[Beta] Structured prompt template for a language model.
Functions¶
prompts.base.aformat_document(doc, prompt)
Format a document into a string based on a prompt template.
prompts.base.format_document(doc, prompt)
Format a document into a string based on a prompt template.
prompts.loading.load_prompt(path)
Unified method for loading a prompt from LangChainHub or local fs.
prompts.loading.load_prompt_from_config(config)
Load prompt from Config Dict.
prompts.string.check_valid_template(...)
Check that template string is valid.
prompts.string.get_template_variables(...)
Get the variables from the template.
prompts.string.jinja2_formatter(template, ...)
Format a template using jinja2.
prompts.string.mustache_formatter(template, ...)
Format a template using mustache.
prompts.string.mustache_schema(template)
Get the variables from a mustache template.
prompts.string.mustache_template_vars(template)
Get the variables from a mustache template.
prompts.string.validate_jinja2(template, ...)
Validate that the input variables are valid for the template.
langchain_core.retrievers¶
Retriever class returns Documents given a text query.
It is more general than a vector store. A retriever does not need to be able to
store documents, only to return (or retrieve) it. Vector stores can be used as
the backbone of a retriever, but there are other types of retrievers as well.
Class hierarchy:
BaseRetriever --> <name>Retriever # Examples: ArxivRetriever, MergerRetriever
Main helpers: | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-14 | Main helpers:
RetrieverInput, RetrieverOutput, RetrieverLike, RetrieverOutputLike,
Document, Serializable, Callbacks,
CallbackManagerForRetrieverRun, AsyncCallbackManagerForRetrieverRun
Classes¶
retrievers.BaseRetriever
Abstract base class for a Document retrieval system.
langchain_core.runnables¶
LangChain Runnable and the LangChain Expression Language (LCEL).
The LangChain Expression Language (LCEL) offers a declarative method to build
production-grade programs that harness the power of LLMs.
Programs created using LCEL and LangChain Runnables inherently support
synchronous, asynchronous, batch, and streaming operations.
Support for async allows servers hosting LCEL based programs to scale better
for higher concurrent loads.
Batch operations allow for processing multiple inputs in parallel.
Streaming of intermediate outputs, as they’re being generated, allows for
creating more responsive UX.
This module contains schema and implementation of LangChain Runnables primitives.
Classes¶
runnables.base.Runnable()
A unit of work that can be invoked, batched, streamed, transformed and composed.
runnables.base.RunnableBinding
Wrap a Runnable with additional functionality.
runnables.base.RunnableBindingBase
Runnable that delegates calls to another Runnable with a set of kwargs.
runnables.base.RunnableEach
Runnable that delegates calls to another Runnable with each element of the input sequence.
runnables.base.RunnableEachBase
Runnable that delegates calls to another Runnable with each element of the input sequence.
runnables.base.RunnableGenerator(transform)
Runnable that runs a generator function.
runnables.base.RunnableLambda(func[, afunc, ...])
RunnableLambda converts a python callable into a Runnable.
runnables.base.RunnableMap
alias of RunnableParallel | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-15 | runnables.base.RunnableMap
alias of RunnableParallel
runnables.base.RunnableParallel
Runnable that runs a mapping of Runnables in parallel, and returns a mapping of their outputs.
runnables.base.RunnableSequence
Sequence of Runnables, where the output of each is the input of the next.
runnables.base.RunnableSerializable
Runnable that can be serialized to JSON.
runnables.branch.RunnableBranch
Runnable that selects which branch to run based on a condition.
runnables.config.ContextThreadPoolExecutor([...])
ThreadPoolExecutor that copies the context to the child thread.
runnables.config.EmptyDict
Empty dict type.
runnables.config.RunnableConfig
Configuration for a Runnable.
runnables.configurable.DynamicRunnable
Serializable Runnable that can be dynamically configured.
runnables.configurable.RunnableConfigurableAlternatives
Runnable that can be dynamically configured.
runnables.configurable.RunnableConfigurableFields
Runnable that can be dynamically configured.
runnables.configurable.StrEnum(value)
String enum.
runnables.fallbacks.RunnableWithFallbacks
Runnable that can fallback to other Runnables if it fails.
runnables.graph.Branch(condition, ends)
Branch in a graph.
runnables.graph.CurveStyle(value)
Enum for different curve styles supported by Mermaid
runnables.graph.Edge(source, target[, data, ...])
Edge in a graph.
runnables.graph.Graph(nodes, ...)
Graph of nodes and edges.
runnables.graph.LabelsDict
Dictionary of labels for nodes and edges in a graph.
runnables.graph.MermaidDrawMethod(value)
Enum for different draw methods supported by Mermaid
runnables.graph.Node(id, data)
Node in a graph. | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-16 | runnables.graph.Node(id, data)
Node in a graph.
runnables.graph.NodeColors([start, end, other])
Schema for Hexadecimal color codes for different node types
runnables.graph_ascii.AsciiCanvas(cols, lines)
Class for drawing in ASCII.
runnables.graph_ascii.VertexViewer(name)
Class to define vertex box boundaries that will be accounted for during graph building by grandalf.
runnables.graph_png.PngDrawer([fontname, labels])
Helper class to draw a state graph into a PNG file.
runnables.history.RunnableWithMessageHistory
Runnable that manages chat message history for another Runnable.
runnables.passthrough.RunnableAssign
Runnable that assigns key-value pairs to Dict[str, Any] inputs.
runnables.passthrough.RunnablePassthrough
Runnable to passthrough inputs unchanged or with additional keys.
runnables.passthrough.RunnablePick
Runnable that picks keys from Dict[str, Any] inputs.
runnables.retry.RunnableRetry
Retry a Runnable if it fails.
runnables.router.RouterInput
Router input.
runnables.router.RouterRunnable
Runnable that routes to a set of Runnables based on Input['key'].
runnables.schema.EventData
Data associated with a streaming event.
runnables.schema.StreamEvent
Streaming event.
runnables.utils.AddableDict
Dictionary that can be added to another dictionary.
runnables.utils.ConfigurableField(id[, ...])
Field that can be configured by the user.
runnables.utils.ConfigurableFieldMultiOption(id, ...)
Field that can be configured by the user with multiple default values.
runnables.utils.ConfigurableFieldSingleOption(id, ...)
Field that can be configured by the user with a default value. | https://api.python.langchain.com/en/latest/core_api_reference.html |