langchain-community: 0.3.8#

Main entrypoint into package.

adapters #

Classes

`adapters.openai.Chat`()	Chat.
`adapters.openai.ChatCompletion`()	Chat completion.
`adapters.openai.ChatCompletionChunk`	Chat completion chunk.
`adapters.openai.ChatCompletions`	Chat completions.
`adapters.openai.Choice`	Choice.
`adapters.openai.ChoiceChunk`	Choice chunk.
`adapters.openai.Completions`()	Completions.
`adapters.openai.IndexableBaseModel`	Allows a BaseModel to return its fields by string variable indexing.

Functions

`adapters.openai.aenumerate`(iterable[, start])	Async version of enumerate function.
`adapters.openai.convert_dict_to_message`(_dict)	Convert a dictionary to a LangChain message.
`adapters.openai.convert_message_to_dict`(message)	Convert a LangChain message to a dictionary.
`adapters.openai.convert_messages_for_finetuning`(...)	Convert messages to a list of lists of dictionaries for fine-tuning.
`adapters.openai.convert_openai_messages`(messages)	Convert dictionaries representing OpenAI messages to LangChain format.

agent_toolkits #

Classes

`agent_toolkits.ainetwork.toolkit.AINetworkToolkit`	Toolkit for interacting with AINetwork Blockchain.
`agent_toolkits.amadeus.toolkit.AmadeusToolkit`	Toolkit for interacting with Amadeus which offers APIs for travel.
`agent_toolkits.azure_ai_services.AzureAiServicesToolkit`	Toolkit for Azure AI Services.
`agent_toolkits.azure_cognitive_services.AzureCognitiveServicesToolkit`	Toolkit for Azure Cognitive Services.
`agent_toolkits.cassandra_database.toolkit.CassandraDatabaseToolkit`	Toolkit for interacting with an Apache Cassandra database.
`agent_toolkits.clickup.toolkit.ClickupToolkit`	Clickup Toolkit.
`agent_toolkits.cogniswitch.toolkit.CogniswitchToolkit`	Toolkit for CogniSwitch.
`agent_toolkits.connery.toolkit.ConneryToolkit`	Toolkit with a list of Connery Actions as tools.
`agent_toolkits.file_management.toolkit.FileManagementToolkit`	Toolkit for interacting with local files.
`agent_toolkits.financial_datasets.toolkit.FinancialDatasetsToolkit`	Toolkit for interacting with financialdatasets.ai.
`agent_toolkits.github.toolkit.BranchName`	Schema for operations that require a branch name as input.
`agent_toolkits.github.toolkit.CommentOnIssue`	Schema for operations that require a comment as input.
`agent_toolkits.github.toolkit.CreateFile`	Schema for operations that require a file path and content as input.
`agent_toolkits.github.toolkit.CreatePR`	Schema for operations that require a PR title and body as input.
`agent_toolkits.github.toolkit.CreateReviewRequest`	Schema for operations that require a username as input.
`agent_toolkits.github.toolkit.DeleteFile`	Schema for operations that require a file path as input.
`agent_toolkits.github.toolkit.DirectoryPath`	Schema for operations that require a directory path as input.
`agent_toolkits.github.toolkit.GetIssue`	Schema for operations that require an issue number as input.
`agent_toolkits.github.toolkit.GetPR`	Schema for operations that require a PR number as input.
`agent_toolkits.github.toolkit.GitHubToolkit`	GitHub Toolkit.
`agent_toolkits.github.toolkit.NoInput`	Schema for operations that do not require any input.
`agent_toolkits.github.toolkit.ReadFile`	Schema for operations that require a file path as input.
`agent_toolkits.github.toolkit.SearchCode`	Schema for operations that require a search query as input.
`agent_toolkits.github.toolkit.SearchIssuesAndPRs`	Schema for operations that require a search query as input.
`agent_toolkits.github.toolkit.UpdateFile`	Schema for operations that require a file path and content as input.
`agent_toolkits.gitlab.toolkit.GitLabToolkit`	GitLab Toolkit.
`agent_toolkits.gmail.toolkit.GmailToolkit`	Toolkit for interacting with Gmail.
`agent_toolkits.jira.toolkit.JiraToolkit`	Jira Toolkit.
`agent_toolkits.json.toolkit.JsonToolkit`	Toolkit for interacting with a JSON spec.
`agent_toolkits.multion.toolkit.MultionToolkit`	Toolkit for interacting with the Browser Agent.
`agent_toolkits.nasa.toolkit.NasaToolkit`	Nasa Toolkit.
`agent_toolkits.nla.tool.NLATool`	Natural Language API Tool.
`agent_toolkits.nla.toolkit.NLAToolkit`	Natural Language API Toolkit.
`agent_toolkits.office365.toolkit.O365Toolkit`	Toolkit for interacting with Office 365.
`agent_toolkits.openapi.planner.RequestsDeleteToolWithParsing`	Tool that sends a DELETE request and parses the response.
`agent_toolkits.openapi.planner.RequestsGetToolWithParsing`	Requests GET tool with LLM-instructed extraction of truncated responses.
`agent_toolkits.openapi.planner.RequestsPatchToolWithParsing`	Requests PATCH tool with LLM-instructed extraction of truncated responses.
`agent_toolkits.openapi.planner.RequestsPostToolWithParsing`	Requests POST tool with LLM-instructed extraction of truncated responses.
`agent_toolkits.openapi.planner.RequestsPutToolWithParsing`	Requests PUT tool with LLM-instructed extraction of truncated responses.
`agent_toolkits.openapi.spec.ReducedOpenAPISpec`(...)	A reduced OpenAPI spec.
`agent_toolkits.openapi.toolkit.OpenAPIToolkit`	Toolkit for interacting with an OpenAPI API.
`agent_toolkits.openapi.toolkit.RequestsToolkit`	Toolkit for making REST requests.
`agent_toolkits.playwright.toolkit.PlayWrightBrowserToolkit`	Toolkit for PlayWright browser tools.
`agent_toolkits.polygon.toolkit.PolygonToolkit`	Polygon Toolkit.
`agent_toolkits.powerbi.toolkit.PowerBIToolkit`	Toolkit for interacting with Power BI dataset.
`agent_toolkits.slack.toolkit.SlackToolkit`	Toolkit for interacting with Slack.
`agent_toolkits.spark_sql.toolkit.SparkSQLToolkit`	Toolkit for interacting with Spark SQL.
`agent_toolkits.sql.toolkit.SQLDatabaseToolkit`	SQLDatabaseToolkit for interacting with SQL databases.
`agent_toolkits.steam.toolkit.SteamToolkit`	Steam Toolkit.
`agent_toolkits.zapier.toolkit.ZapierToolkit`	Zapier Toolkit.

Functions

`agent_toolkits.json.base.create_json_agent`(...)	Construct a json agent from an LLM and tools.
`agent_toolkits.load_tools.get_all_tool_names`()	Get a list of all possible tool names.
`agent_toolkits.load_tools.load_huggingface_tool`(...)	Loads a tool from the HuggingFace Hub.
`agent_toolkits.load_tools.load_tools`(tool_names)	Load tools based on their name.
`agent_toolkits.load_tools.raise_dangerous_tools_exception`(name)
`agent_toolkits.openapi.base.create_openapi_agent`(...)	Construct an OpenAPI agent from an LLM and tools.
`agent_toolkits.openapi.planner.create_openapi_agent`(...)	Construct an OpenAI API planner and controller for a given spec.
`agent_toolkits.openapi.spec.reduce_openapi_spec`(spec)	Simplify/distill/minify a spec somehow.
`agent_toolkits.powerbi.base.create_pbi_agent`(llm)	Construct a Power BI agent from an LLM and tools.
`agent_toolkits.powerbi.chat_base.create_pbi_chat_agent`(llm)	Construct a Power BI agent from a Chat LLM and tools.
`agent_toolkits.spark_sql.base.create_spark_sql_agent`(...)	Construct a Spark SQL agent from an LLM and tools.
`agent_toolkits.sql.base.create_sql_agent`(llm)	Construct a SQL agent from an LLM and toolkit or database.

agents #

Classes

agents.openai_assistant.base.OpenAIAssistantV2Runnable

cache #

Classes

`cache.AsyncRedisCache`(redis_, *[, ttl])	Cache that uses Redis as a backend.
`cache.AzureCosmosDBSemanticCache`(...[, ...])	Cache that uses Cosmos DB Mongo vCore vector-store backend
`cache.CassandraCache`([session, keyspace, ...])	Cache that uses Cassandra / Astra DB as a backend.
`cache.CassandraSemanticCache`([session, ...])	Cache that uses Cassandra as a vector-store backend for semantic (i.e. similarity-based) lookup.
`cache.FullLLMCache`(**kwargs)	SQLite table for full LLM Cache (all generations).
`cache.FullMd5LLMCache`(**kwargs)	SQLite table for full LLM Cache (all generations).
`cache.GPTCache`([init_func])	Cache that uses GPTCache as a backend.
`cache.InMemoryCache`()	Cache that stores things in memory.
`cache.MemcachedCache`(client_)	Cache that uses Memcached backend through pymemcache client lib
`cache.MomentoCache`(cache_client, cache_name, *)	Cache that uses Momento as a backend.
`cache.OpenSearchSemanticCache`(...[, ...])	Cache that uses OpenSearch vector store backend
`cache.RedisCache`(redis_, *[, ttl])	Cache that uses Redis as a backend.
`cache.RedisSemanticCache`(redis_url, embedding)	Cache that uses Redis as a vector-store backend.
`cache.SQLAlchemyCache`(engine, cache_schema)	Cache that uses SQAlchemy as a backend.
`cache.SQLAlchemyMd5Cache`(engine, cache_schema)	Cache that uses SQAlchemy as a backend.
`cache.SQLiteCache`([database_path])	Cache that uses SQLite as a backend.
`cache.SingleStoreDBSemanticCache`(embedding, *)	Cache that uses SingleStore DB as a backend
`cache.UpstashRedisCache`(redis_, *[, ttl])	Cache that uses Upstash Redis as a backend.

Deprecated classes

`cache.AstraDBCache`(*[, collection_name, ...])
`cache.AstraDBSemanticCache`(*[, ...])

callbacks #

Classes

`callbacks.aim_callback.AimCallbackHandler`([...])	Callback Handler that logs to Aim.
`callbacks.aim_callback.BaseMetadataCallbackHandler`()	Callback handler for the metadata and associated function states for callbacks.
`callbacks.argilla_callback.ArgillaCallbackHandler`(...)	Callback Handler that logs into Argilla.
`callbacks.arize_callback.ArizeCallbackHandler`([...])	Callback Handler that logs to Arize.
`callbacks.arthur_callback.ArthurCallbackHandler`(...)	Callback Handler that logs to Arthur platform.
`callbacks.bedrock_anthropic_callback.BedrockAnthropicTokenUsageCallbackHandler`()	Callback Handler that tracks bedrock anthropic info.
`callbacks.clearml_callback.ClearMLCallbackHandler`([...])	Callback Handler that logs to ClearML.
`callbacks.comet_ml_callback.CometCallbackHandler`([...])	Callback Handler that logs to Comet.
`callbacks.confident_callback.DeepEvalCallbackHandler`(metrics)	Callback Handler that logs into deepeval.
`callbacks.context_callback.ContextCallbackHandler`([...])	Callback Handler that records transcripts to the Context service.
`callbacks.fiddler_callback.FiddlerCallbackHandler`(...)	Initialize Fiddler callback handler.
`callbacks.flyte_callback.FlyteCallbackHandler`()	Callback handler that is used within a Flyte task.
`callbacks.human.AsyncHumanApprovalCallbackHandler`(...)	Asynchronous callback for manually validating values.
`callbacks.human.HumanApprovalCallbackHandler`(...)	Callback for manually validating values.
`callbacks.human.HumanRejectedException`	Exception to raise when a person manually review and rejects a value.
`callbacks.infino_callback.InfinoCallbackHandler`([...])	Callback Handler that logs to Infino.
`callbacks.labelstudio_callback.LabelStudioCallbackHandler`([...])	Label Studio callback handler.
`callbacks.labelstudio_callback.LabelStudioMode`(value)	Label Studio mode enumerator.
`callbacks.llmonitor_callback.LLMonitorCallbackHandler`([...])	Callback Handler for LLMonitor`.
`callbacks.llmonitor_callback.UserContextManager`(user_id)	Context manager for LLMonitor user context.
`callbacks.mlflow_callback.MlflowCallbackHandler`([...])	Callback Handler that logs metrics and artifacts to mlflow server.
`callbacks.mlflow_callback.MlflowLogger`(**kwargs)	Callback Handler that logs metrics and artifacts to mlflow server.
`callbacks.openai_info.OpenAICallbackHandler`()	Callback Handler that tracks OpenAI info.
`callbacks.promptlayer_callback.PromptLayerCallbackHandler`([...])	Callback handler for promptlayer.
`callbacks.sagemaker_callback.SageMakerCallbackHandler`(run)	Callback Handler that logs prompt artifacts and metrics to SageMaker Experiments.
`callbacks.streamlit.mutable_expander.ChildRecord`(...)	Child record as a NamedTuple.
`callbacks.streamlit.mutable_expander.ChildType`(value)	Enumerator of the child type.
`callbacks.streamlit.mutable_expander.MutableExpander`(...)	Streamlit expander that can be renamed and dynamically expanded/collapsed.
`callbacks.streamlit.streamlit_callback_handler.LLMThought`(...)	A thought in the LLM's thought stream.
`callbacks.streamlit.streamlit_callback_handler.LLMThoughtLabeler`()	Generates markdown labels for LLMThought containers.
`callbacks.streamlit.streamlit_callback_handler.LLMThoughtState`(value)	Enumerator of the LLMThought state.
`callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler`(...)	Callback handler that writes to a Streamlit app.
`callbacks.streamlit.streamlit_callback_handler.ToolRecord`(...)	Tool record as a NamedTuple.
`callbacks.tracers.comet.CometTracer`(**kwargs)	Comet Tracer.
`callbacks.tracers.wandb.WandbRunArgs`	Arguments for the WandbTracer.
`callbacks.tracers.wandb.WandbTracer`(...)	Callback Handler that logs to Weights and Biases.
`callbacks.trubrics_callback.TrubricsCallbackHandler`([...])	Callback handler for Trubrics.
`callbacks.upstash_ratelimit_callback.UpstashRatelimitError`(...)	Upstash Ratelimit Error
`callbacks.upstash_ratelimit_callback.UpstashRatelimitHandler`(...)	Callback to handle rate limiting based on the number of requests or the number of tokens in the input.
`callbacks.uptrain_callback.UpTrainCallbackHandler`(*)	Callback Handler that logs evaluation results to uptrain and the console.
`callbacks.uptrain_callback.UpTrainDataSchema`(...)	The UpTrain data schema for tracking evaluation results.
`callbacks.utils.BaseMetadataCallbackHandler`()	Handle the metadata and associated function states for callbacks.
`callbacks.wandb_callback.WandbCallbackHandler`([...])	Callback Handler that logs to Weights and Biases.
`callbacks.whylabs_callback.WhyLabsCallbackHandler`(...)	Callback Handler for logging to WhyLabs.

Functions

`callbacks.aim_callback.import_aim`()	Import the aim python package and raise an error if it is not installed.
`callbacks.clearml_callback.import_clearml`()	Import the clearml python package and raise an error if it is not installed.
`callbacks.comet_ml_callback.import_comet_ml`()	Import comet_ml and raise an error if it is not installed.
`callbacks.context_callback.import_context`()	Import the getcontext package.
`callbacks.fiddler_callback.import_fiddler`()	Import the fiddler python package and raise an error if it is not installed.
`callbacks.flyte_callback.analyze_text`(text)	Analyze text using textstat and spacy.
`callbacks.flyte_callback.import_flytekit`()	Import flytekit and flytekitplugins-deck-standard.
`callbacks.infino_callback.get_num_tokens`(...)	Calculate num tokens for OpenAI with tiktoken package.
`callbacks.infino_callback.import_infino`()	Import the infino client.
`callbacks.infino_callback.import_tiktoken`()	Import tiktoken for counting tokens for OpenAI models.
`callbacks.labelstudio_callback.get_default_label_configs`(mode)	Get default Label Studio configs for the given mode.
`callbacks.llmonitor_callback.identify`(user_id)	Builds an LLMonitor UserContextManager
`callbacks.manager.get_bedrock_anthropic_callback`()	Get the Bedrock anthropic callback handler in a context manager.
`callbacks.manager.get_openai_callback`()	Get the OpenAI callback handler in a context manager.
`callbacks.manager.wandb_tracing_enabled`([...])	Get the WandbTracer in a context manager.
`callbacks.mlflow_callback.analyze_text`(text)	Analyze text using textstat and spacy.
`callbacks.mlflow_callback.construct_html_from_prompt_and_generation`(...)	Construct an html element from a prompt and a generation.
`callbacks.mlflow_callback.get_text_complexity_metrics`()	Get the text complexity metrics from textstat.
`callbacks.mlflow_callback.import_mlflow`()	Import the mlflow python package and raise an error if it is not installed.
`callbacks.mlflow_callback.mlflow_callback_metrics`()	Get the metrics to log to MLFlow.
`callbacks.openai_info.get_openai_token_cost_for_model`(...)	Get the cost in USD for a given model and number of tokens.
`callbacks.openai_info.standardize_model_name`(...)	Standardize the model name to a format that can be used in the OpenAI API.
`callbacks.sagemaker_callback.save_json`(data, ...)	Save dict to local file path.
`callbacks.tracers.comet.import_comet_llm_api`()	Import comet_llm api and raise an error if it is not installed.
`callbacks.tracers.wandb.build_tree`(runs)	Builds a nested dictionary from a list of runs. :param runs: The list of runs to build the tree from. :return: The nested dictionary representing the langchain Run in a tree structure compatible with WBTraceTree.
`callbacks.tracers.wandb.flatten_run`(run)	Utility to flatten a nest run object into a list of runs.
`callbacks.tracers.wandb.modify_serialized_iterative`(runs)	Utility to modify the serialized field of a list of runs dictionaries. removes any keys that match the exact_keys and any keys that contain any of the partial_keys. recursively moves the dictionaries under the kwargs key to the top level. changes the "id" field to a string "_kind" field that tells WBTraceTree how to visualize the run. promotes the "serialized" field to the top level. :param runs: The list of runs to modify. :param exact_keys: A tuple of keys to remove from the serialized field. :param partial_keys: A tuple of partial keys to remove from the serialized field. :return: The modified list of runs.
`callbacks.tracers.wandb.truncate_run_iterative`(runs)	Utility to truncate a list of runs dictionaries to only keep the specified
`callbacks.uptrain_callback.import_uptrain`()	Import the uptrain package.
`callbacks.utils.flatten_dict`(nested_dict[, ...])	Flatten a nested dictionary into a flat dictionary.
`callbacks.utils.hash_string`(s)	Hash a string using sha1.
`callbacks.utils.import_pandas`()	Import the pandas python package and raise an error if it is not installed.
`callbacks.utils.import_spacy`()	Import the spacy python package and raise an error if it is not installed.
`callbacks.utils.import_textstat`()	Import the textstat python package and raise an error if it is not installed.
`callbacks.utils.load_json`(json_path)	Load json file to a string.
`callbacks.wandb_callback.analyze_text`(text)	Analyze text using textstat and spacy.
`callbacks.wandb_callback.construct_html_from_prompt_and_generation`(...)	Construct an html element from a prompt and a generation.
`callbacks.wandb_callback.import_wandb`()	Import the wandb python package and raise an error if it is not installed.
`callbacks.wandb_callback.load_json_to_dict`(...)	Load json file to a dictionary.
`callbacks.whylabs_callback.import_langkit`([...])	Import the langkit python package and raise an error if it is not installed.

chains #

Classes

`chains.graph_qa.arangodb.ArangoGraphQAChain`	Chain for question-answering against a graph by generating AQL statements.
`chains.graph_qa.base.GraphQAChain`	Chain for question-answering against a graph.
`chains.graph_qa.cypher_utils.Schema`(...)	Create new instance of Schema(left_node, relation, right_node)
`chains.graph_qa.falkordb.FalkorDBQAChain`	Chain for question-answering against a graph by generating Cypher statements.
`chains.graph_qa.gremlin.GremlinQAChain`	Chain for question-answering against a graph by generating gremlin statements.
`chains.graph_qa.hugegraph.HugeGraphQAChain`	Chain for question-answering against a graph by generating gremlin statements.
`chains.graph_qa.kuzu.KuzuQAChain`	Question-answering against a graph by generating Cypher statements for Kùzu.
`chains.graph_qa.nebulagraph.NebulaGraphQAChain`	Chain for question-answering against a graph by generating nGQL statements.
`chains.graph_qa.neptune_cypher.NeptuneOpenCypherQAChain`	Chain for question-answering against a Neptune graph by generating openCypher statements.
`chains.graph_qa.neptune_sparql.NeptuneSparqlQAChain`	Chain for question-answering against a Neptune graph by generating SPARQL statements.
`chains.graph_qa.ontotext_graphdb.OntotextGraphDBQAChain`	Question-answering against Ontotext GraphDB
`chains.graph_qa.sparql.GraphSparqlQAChain`	Question-answering against an RDF or OWL graph by generating SPARQL statements.
`chains.llm_requests.LLMRequestsChain`	Chain that requests a URL and then uses an LLM to parse results.
`chains.openapi.chain.OpenAPIEndpointChain`	Chain interacts with an OpenAPI endpoint using natural language.
`chains.openapi.requests_chain.APIRequesterChain`	Get the request parser.
`chains.openapi.requests_chain.APIRequesterOutputParser`	Parse the request and error tags.
`chains.openapi.response_chain.APIResponderChain`	Get the response parser.
`chains.openapi.response_chain.APIResponderOutputParser`	Parse the response and error tags.
`chains.pebblo_retrieval.base.PebbloRetrievalQA`	Retrieval Chain with Identity & Semantic Enforcement for question-answering against a vector database.
`chains.pebblo_retrieval.models.App`	Create a new model by parsing and validating input data from keyword arguments.
`chains.pebblo_retrieval.models.AuthContext`	Class for an authorization context.
`chains.pebblo_retrieval.models.ChainInfo`	Create a new model by parsing and validating input data from keyword arguments.
`chains.pebblo_retrieval.models.ChainInput`	Input for PebbloRetrievalQA chain.
`chains.pebblo_retrieval.models.Context`	Create a new model by parsing and validating input data from keyword arguments.
`chains.pebblo_retrieval.models.Framework`	Langchain framework details
`chains.pebblo_retrieval.models.Model`	Create a new model by parsing and validating input data from keyword arguments.
`chains.pebblo_retrieval.models.PkgInfo`	Create a new model by parsing and validating input data from keyword arguments.
`chains.pebblo_retrieval.models.Prompt`	Create a new model by parsing and validating input data from keyword arguments.
`chains.pebblo_retrieval.models.Qa`	Create a new model by parsing and validating input data from keyword arguments.
`chains.pebblo_retrieval.models.Runtime`	OS, language details
`chains.pebblo_retrieval.models.SemanticContext`	Class for a semantic context.
`chains.pebblo_retrieval.models.SemanticEntities`	Class for a semantic entity filter.
`chains.pebblo_retrieval.models.SemanticTopics`	Class for a semantic topic filter.
`chains.pebblo_retrieval.models.VectorDB`	Create a new model by parsing and validating input data from keyword arguments.
`chains.pebblo_retrieval.utilities.PebbloRetrievalAPIWrapper`	Wrapper for Pebblo Retrieval API.
`chains.pebblo_retrieval.utilities.Routes`(value)	Routes available for the Pebblo API as enumerator.

Functions

`chains.ernie_functions.base.convert_python_function_to_ernie_function`(...)	Convert a Python function to an Ernie function-calling API compatible dict.
`chains.ernie_functions.base.convert_to_ernie_function`(...)	Convert a raw function/class to an Ernie function.
`chains.ernie_functions.base.create_ernie_fn_chain`(...)	[Legacy] Create an LLM chain that uses Ernie functions.
`chains.ernie_functions.base.create_ernie_fn_runnable`(...)	Create a runnable sequence that uses Ernie functions.
`chains.ernie_functions.base.create_structured_output_chain`(...)	[Legacy] Create an LLMChain that uses an Ernie function to get a structured output.
`chains.ernie_functions.base.create_structured_output_runnable`(...)	Create a runnable that uses an Ernie function to get a structured output.
`chains.ernie_functions.base.get_ernie_output_parser`(...)	Get the appropriate function output parser given the user functions.
`chains.graph_qa.falkordb.extract_cypher`(text)	Extract Cypher code from a text.
`chains.graph_qa.gremlin.extract_gremlin`(text)	Extract Gremlin code from a text.
`chains.graph_qa.kuzu.extract_cypher`(text)	Extract Cypher code from a text.
`chains.graph_qa.kuzu.remove_prefix`(text, prefix)	Remove a prefix from a text.
`chains.graph_qa.neptune_cypher.extract_cypher`(text)	Extract Cypher code from text using Regex.
`chains.graph_qa.neptune_cypher.trim_query`(query)	Trim the query to only include Cypher keywords.
`chains.graph_qa.neptune_cypher.use_simple_prompt`(llm)	Decides whether to use the simple prompt
`chains.graph_qa.neptune_sparql.extract_sparql`(query)	Extract SPARQL code from a text.
`chains.pebblo_retrieval.enforcement_filters.clear_enforcement_filters`(...)	Clear the identity and semantic enforcement filters in the retriever search_kwargs.
`chains.pebblo_retrieval.enforcement_filters.set_enforcement_filters`(...)	Set identity and semantic enforcement filters in the retriever.
`chains.pebblo_retrieval.utilities.get_ip`()	Fetch local runtime ip address.
`chains.pebblo_retrieval.utilities.get_runtime`()	Fetch the current Framework and Runtime details.

Deprecated classes

`chains.graph_qa.cypher.GraphCypherQAChain`
`chains.graph_qa.cypher_utils.CypherQueryCorrector`(schemas)

Deprecated functions

`chains.graph_qa.cypher.construct_schema`(...)
`chains.graph_qa.cypher.extract_cypher`(text)
`chains.graph_qa.cypher.get_function_response`(...)

chat_loaders #

Classes

`chat_loaders.facebook_messenger.FolderFacebookMessengerChatLoader`(path)	Load Facebook Messenger chat data from a folder.
`chat_loaders.facebook_messenger.SingleFileFacebookMessengerChatLoader`(path)	Load Facebook Messenger chat data from a single file.
`chat_loaders.imessage.IMessageChatLoader`([path])	Load chat sessions from the iMessage chat.db SQLite file.
`chat_loaders.langsmith.LangSmithDatasetChatLoader`(*, ...)	Load chat sessions from a LangSmith dataset with the "chat" data type.
`chat_loaders.langsmith.LangSmithRunChatLoader`(runs)	Load chat sessions from a list of LangSmith "llm" runs.
`chat_loaders.slack.SlackChatLoader`(path)	Load Slack conversations from a dump zip file.
`chat_loaders.telegram.TelegramChatLoader`(path)	Load telegram conversations to LangChain chat messages.
`chat_loaders.whatsapp.WhatsAppChatLoader`(path)	Load WhatsApp conversations from a dump zip file or directory.

Functions

`chat_loaders.imessage.nanoseconds_from_2001_to_datetime`(...)	Convert nanoseconds since 2001 to a datetime object.
`chat_loaders.utils.map_ai_messages`(...)	Convert messages from the specified 'sender' to AI messages.
`chat_loaders.utils.map_ai_messages_in_session`(...)	Convert messages from the specified 'sender' to AI messages.
`chat_loaders.utils.merge_chat_runs`(chat_sessions)	Merge chat runs together.
`chat_loaders.utils.merge_chat_runs_in_session`(...)	Merge chat runs together in a chat session.

Deprecated classes

chat_loaders.gmail.GMailLoader(creds[, n, ...])

chat_message_histories #

Classes

`chat_message_histories.cassandra.CassandraChatMessageHistory`(...)	Chat message history that is backed by Cassandra.
`chat_message_histories.cosmos_db.CosmosDBChatMessageHistory`(...)	Chat message history backed by Azure CosmosDB.
`chat_message_histories.dynamodb.DynamoDBChatMessageHistory`(...)	Chat message history that stores history in AWS DynamoDB.
`chat_message_histories.file.FileChatMessageHistory`(...)	Chat message history that stores history in a local file.
`chat_message_histories.firestore.FirestoreChatMessageHistory`(...)	Chat message history backed by Google Firestore.
`chat_message_histories.kafka.ConsumeStartPosition`(value)	Consume start position for Kafka consumer to get chat history messages.
`chat_message_histories.kafka.KafkaChatMessageHistory`(...)	Chat message history stored in Kafka.
`chat_message_histories.momento.MomentoChatMessageHistory`(...)	Chat message history cache that uses Momento as a backend.
`chat_message_histories.redis.RedisChatMessageHistory`(...)	Chat message history stored in a Redis database.
`chat_message_histories.rocksetdb.RocksetChatMessageHistory`(...)	Uses Rockset to store chat messages.
`chat_message_histories.singlestoredb.SingleStoreDBChatMessageHistory`(...)	Chat message history stored in a SingleStoreDB database.
`chat_message_histories.sql.BaseMessageConverter`()	Convert BaseMessage to the SQLAlchemy model.
`chat_message_histories.sql.DefaultMessageConverter`(...)	The default message converter for SQLChatMessageHistory.
`chat_message_histories.sql.SQLChatMessageHistory`(...)	Chat message history stored in an SQL database.
`chat_message_histories.streamlit.StreamlitChatMessageHistory`([key])	Chat message history that stores messages in Streamlit session state.
`chat_message_histories.tidb.TiDBChatMessageHistory`(...)	Represents a chat message history stored in a TiDB database.
`chat_message_histories.upstash_redis.UpstashRedisChatMessageHistory`(...)	Chat message history stored in an Upstash Redis database.
`chat_message_histories.xata.XataChatMessageHistory`(...)	Chat message history stored in a Xata database.
`chat_message_histories.zep.SearchScope`(value)	Scope for the document search.
`chat_message_histories.zep.SearchType`(value)	Enumerator of the types of search to perform.
`chat_message_histories.zep.ZepChatMessageHistory`(...)	Chat message history that uses Zep as a backend.
`chat_message_histories.zep_cloud.ZepCloudChatMessageHistory`(...)	Chat message history that uses Zep Cloud as a backend.

Functions

`chat_message_histories.kafka.ensure_topic_exists`(...)	Create topic if it doesn't exist, and return the number of partitions.
`chat_message_histories.sql.create_message_model`(...)	Create a message model for a given table name.
`chat_message_histories.zep_cloud.condense_zep_memory_into_human_message`(...)	Condense Zep memory into a human message.
`chat_message_histories.zep_cloud.get_zep_message_role_type`(role)	Get the Zep role type from the role string.

Deprecated classes

`chat_message_histories.astradb.AstraDBChatMessageHistory`(*, ...)
`chat_message_histories.elasticsearch.ElasticsearchChatMessageHistory`(...)
`chat_message_histories.mongodb.MongoDBChatMessageHistory`(...)
`chat_message_histories.neo4j.Neo4jChatMessageHistory`(...)
`chat_message_histories.postgres.PostgresChatMessageHistory`(...)

chat_models #

Classes

`chat_models.anyscale.ChatAnyscale`	Anyscale Chat large language models.
`chat_models.azureml_endpoint.AzureMLChatOnlineEndpoint`	Azure ML Online Endpoint chat models.
`chat_models.azureml_endpoint.CustomOpenAIChatContentFormatter`()	Chat Content formatter for models with OpenAI like API scheme.
`chat_models.azureml_endpoint.LlamaChatContentFormatter`()	Deprecated: Kept for backwards compatibility
`chat_models.azureml_endpoint.LlamaContentFormatter`()	Content formatter for LLaMA.
`chat_models.azureml_endpoint.MistralChatContentFormatter`()	Content formatter for Mistral.
`chat_models.baichuan.ChatBaichuan`	Baichuan chat model integration.
`chat_models.baidu_qianfan_endpoint.QianfanChatEndpoint`	Baidu Qianfan chat model integration.
`chat_models.bedrock.ChatPromptAdapter`()	Adapter class to prepare the inputs from Langchain to prompt format that Chat model expects.
`chat_models.cloudflare_workersai.ChatCloudflareWorkersAI`	Custom chat model for Cloudflare Workers AI
`chat_models.coze.ChatCoze`	ChatCoze chat models API by coze.com
`chat_models.dappier.ChatDappierAI`	Dappier chat large language models.
`chat_models.deepinfra.ChatDeepInfra`	A chat model that uses the DeepInfra API.
`chat_models.deepinfra.ChatDeepInfraException`	Exception raised when the DeepInfra API returns an error.
`chat_models.edenai.ChatEdenAI`	EdenAI chat large language models.
`chat_models.everlyai.ChatEverlyAI`	EverlyAI Chat large language models.
`chat_models.fake.FakeListChatModel`	Fake ChatModel for testing purposes.
`chat_models.fake.FakeMessagesListChatModel`	Fake ChatModel for testing purposes.
`chat_models.friendli.ChatFriendli`	Friendli LLM for chat.
`chat_models.google_palm.ChatGooglePalm`	Google PaLM Chat models API.
`chat_models.google_palm.ChatGooglePalmError`	Error with the Google PaLM API.
`chat_models.gpt_router.GPTRouter`	GPTRouter by Writesonic Inc.
`chat_models.gpt_router.GPTRouterException`	Error with the GPTRouter APIs
`chat_models.gpt_router.GPTRouterModel`	GPTRouter model.
`chat_models.human.HumanInputChatModel`	ChatModel which returns user input as the response.
`chat_models.hunyuan.ChatHunyuan`	Tencent Hunyuan chat models API by Tencent.
`chat_models.javelin_ai_gateway.ChatJavelinAIGateway`	Javelin AI Gateway chat models API.
`chat_models.javelin_ai_gateway.ChatParams`	Parameters for the Javelin AI Gateway LLM.
`chat_models.jinachat.JinaChat`	Jina AI Chat models API.
`chat_models.kinetica.ChatKinetica`	Kinetica LLM Chat Model API.
`chat_models.kinetica.KineticaSqlOutputParser`	Fetch and return data from the Kinetica LLM.
`chat_models.kinetica.KineticaSqlResponse`	Response containing SQL and the fetched data.
`chat_models.kinetica.KineticaUtil`()	Kinetica utility functions.
`chat_models.konko.ChatKonko`	ChatKonko Chat large language models API.
`chat_models.litellm.ChatLiteLLM`	Chat model that uses the LiteLLM API.
`chat_models.litellm.ChatLiteLLMException`	Error with the LiteLLM I/O library
`chat_models.litellm_router.ChatLiteLLMRouter`	LiteLLM Router as LangChain Model.
`chat_models.llama_edge.LlamaEdgeChatService`	Chat with LLMs via llama-api-server
`chat_models.llamacpp.ChatLlamaCpp`	llama.cpp model.
`chat_models.maritalk.ChatMaritalk`	MariTalk Chat models API.
`chat_models.maritalk.MaritalkHTTPError`(...)	Initialize RequestException with request and response objects.
`chat_models.minimax.MiniMaxChat`	MiniMax chat model integration.
`chat_models.mlflow.ChatMlflow`	MLflow chat models API.
`chat_models.mlflow_ai_gateway.ChatMLflowAIGateway`	MLflow AI Gateway chat models API.
`chat_models.mlflow_ai_gateway.ChatParams`	Parameters for the MLflow AI Gateway LLM.
`chat_models.mlx.ChatMLX`	MLX chat models.
`chat_models.moonshot.MoonshotChat`	Moonshot large language models.
`chat_models.naver.ChatClovaX`	NCP ClovaStudio Chat Completion API.
`chat_models.oci_data_science.ChatOCIModelDeployment`	OCI Data Science Model Deployment chat model integration.
`chat_models.oci_data_science.ChatOCIModelDeploymentTGI`	OCI large language chat models deployed with Text Generation Inference.
`chat_models.oci_data_science.ChatOCIModelDeploymentVLLM`	OCI large language chat models deployed with vLLM.
`chat_models.oci_generative_ai.ChatOCIGenAI`	ChatOCIGenAI chat model integration.
`chat_models.oci_generative_ai.CohereProvider`()
`chat_models.oci_generative_ai.MetaProvider`()
`chat_models.oci_generative_ai.Provider`()
`chat_models.octoai.ChatOctoAI`	OctoAI Chat large language models.
`chat_models.outlines.ChatOutlines`	Outlines chat model integration.
`chat_models.pai_eas_endpoint.PaiEasChatEndpoint`	Alibaba Cloud PAI-EAS LLM Service chat model API.
`chat_models.perplexity.ChatPerplexity`	Perplexity AI Chat models API.
`chat_models.premai.ChatPremAI`	PremAI Chat models.
`chat_models.premai.ChatPremAPIError`	Error with the PremAI API.
`chat_models.promptlayer_openai.PromptLayerChatOpenAI`	PromptLayer and OpenAI Chat large language models API.
`chat_models.reka.ChatReka`	Reka chat large language models.
`chat_models.sambanova.ChatSambaNovaCloud`	SambaNova Cloud chat model.
`chat_models.sambanova.ChatSambaStudio`	SambaStudio chat model.
`chat_models.snowflake.ChatSnowflakeCortex`	Snowflake Cortex based Chat model
`chat_models.snowflake.ChatSnowflakeCortexError`	Error with Snowpark client.
`chat_models.sparkllm.ChatSparkLLM`	IFlyTek Spark chat model integration.
`chat_models.symblai_nebula.ChatNebula`	Nebula chat large language model - https://docs.symbl.ai/docs/nebula-llm
`chat_models.tongyi.ChatTongyi`	Alibaba Tongyi Qwen chat model integration.
`chat_models.volcengine_maas.VolcEngineMaasChat`	Volc Engine Maas hosts a plethora of models.
`chat_models.writer.ChatWriter`	Writer chat model.
`chat_models.yandex.ChatYandexGPT`	YandexGPT large language models.
`chat_models.yi.ChatYi`	Yi chat models API.
`chat_models.yuan2.ChatYuan2`	Yuan2.0 Chat models API.
`chat_models.zhipuai.ChatZhipuAI`	ZhipuAI chat model integration.

Functions

`chat_models.anthropic.convert_messages_to_prompt_anthropic`(...)	Format a list of messages into a full prompt for the Anthropic model
`chat_models.baichuan.aconnect_httpx_sse`(...)	Async context manager for connecting to an SSE stream.
`chat_models.baidu_qianfan_endpoint.convert_message_to_dict`(message)	Convert a message to a dictionary that can be passed to the API.
`chat_models.bedrock.convert_messages_to_prompt_mistral`(...)	Convert a list of messages to a prompt for mistral.
`chat_models.cohere.get_cohere_chat_request`(...)	Get the request for the Cohere chat API.
`chat_models.cohere.get_role`(message)	Get the role of the message.
`chat_models.fireworks.acompletion_with_retry`(...)	Use tenacity to retry the async completion call.
`chat_models.fireworks.acompletion_with_retry_streaming`(...)	Use tenacity to retry the completion call for streaming.
`chat_models.fireworks.completion_with_retry`(...)	Use tenacity to retry the completion call.
`chat_models.fireworks.conditional_decorator`(...)	Define conditional decorator.
`chat_models.fireworks.convert_dict_to_message`(_dict)	Convert a dict response to a message.
`chat_models.friendli.get_chat_request`(messages)	Get a request of the Friendli chat API.
`chat_models.friendli.get_role`(message)	Get role of the message.
`chat_models.google_palm.achat_with_retry`(...)	Use tenacity to retry the async completion call.
`chat_models.google_palm.chat_with_retry`(llm, ...)	Use tenacity to retry the completion call.
`chat_models.gpt_router.acompletion_with_retry`(...)	Use tenacity to retry the async completion call.
`chat_models.gpt_router.completion_with_retry`(...)	Use tenacity to retry the completion call.
`chat_models.gpt_router.get_ordered_generation_requests`(...)	Return the body for the model router input.
`chat_models.jinachat.acompletion_with_retry`(...)	Use tenacity to retry the async completion call.
`chat_models.litellm.acompletion_with_retry`(llm)	Use tenacity to retry the async completion call.
`chat_models.litellm_router.get_llm_output`(...)	Get llm output from usage and params.
`chat_models.meta.convert_messages_to_prompt_llama`(...)	Convert a list of messages to a prompt for llama.
`chat_models.minimax.aconnect_httpx_sse`(...)	Async context manager for connecting to an SSE stream.
`chat_models.minimax.connect_httpx_sse`(...)	Context manager for connecting to an SSE stream.
`chat_models.openai.acompletion_with_retry`(llm)	Use tenacity to retry the async completion call.
`chat_models.premai.chat_with_retry`(llm, ...)	Using tenacity for retry in completion call
`chat_models.premai.create_prem_retry_decorator`(llm, *)	Create a retry decorator for PremAI API errors.
`chat_models.reka.convert_to_reka_messages`(...)	Convert LangChain messages to Reka message format.
`chat_models.reka.process_content`(content)	Process content to handle both text and media inputs, returning a list of content items.
`chat_models.reka.process_content_item`(item)	Process a single content item.
`chat_models.sparkllm.convert_dict_to_message`(_dict)
`chat_models.sparkllm.convert_message_to_dict`(message)
`chat_models.tongyi.convert_dict_to_message`(_dict)	Convert a dict to a message.
`chat_models.tongyi.convert_message_chunk_to_message`(...)	Convert a message chunk to a message.
`chat_models.tongyi.convert_message_to_dict`(message)	Convert a message to a dict.
`chat_models.volcengine_maas.convert_dict_to_message`(_dict)	Convert a dict to a message.
`chat_models.yandex.acompletion_with_retry`(...)	Use tenacity to retry the async completion call.
`chat_models.yandex.completion_with_retry`(...)	Use tenacity to retry the completion call.
`chat_models.yi.aconnect_httpx_sse`(client, ...)
`chat_models.yuan2.acompletion_with_retry`(...)	Use tenacity to retry the async completion call.
`chat_models.zhipuai.aconnect_sse`(client, ...)	Async context manager for connecting to an SSE stream.
`chat_models.zhipuai.connect_sse`(client, ...)	Context manager for connecting to an SSE stream.

Deprecated classes

`chat_models.anthropic.ChatAnthropic`
`chat_models.azure_openai.AzureChatOpenAI`
`chat_models.bedrock.BedrockChat`
`chat_models.cohere.ChatCohere`
`chat_models.databricks.ChatDatabricks`
`chat_models.ernie.ErnieBotChat`
`chat_models.fireworks.ChatFireworks`
`chat_models.gigachat.GigaChat`
`chat_models.huggingface.ChatHuggingFace`
`chat_models.ollama.ChatOllama`
`chat_models.openai.ChatOpenAI`
`chat_models.solar.SolarChat`
`chat_models.vertexai.ChatVertexAI`

cross_encoders #

Classes

`cross_encoders.fake.FakeCrossEncoder`	Fake cross encoder model.
`cross_encoders.huggingface.HuggingFaceCrossEncoder`	HuggingFace cross encoder models.
`cross_encoders.sagemaker_endpoint.CrossEncoderContentHandler`()	Content handler for CrossEncoder class.
`cross_encoders.sagemaker_endpoint.SagemakerEndpointCrossEncoder`	SageMaker Inference CrossEncoder endpoint.

docstore #

Classes

`docstore.arbitrary_fn.DocstoreFn`(lookup_fn)	Docstore via arbitrary lookup function.
`docstore.base.AddableMixin`()	Mixin class that supports adding texts.
`docstore.base.Docstore`()	Interface to access to place that stores documents.
`docstore.in_memory.InMemoryDocstore`([_dict])	Simple in memory docstore in the form of a dict.
`docstore.wikipedia.Wikipedia`()	Wikipedia API.

document_compressors #

Classes

`document_compressors.dashscope_rerank.DashScopeRerank`	Document compressor that uses DashScope Rerank API.
`document_compressors.flashrank_rerank.FlashrankRerank`	Document compressor using Flashrank interface.
`document_compressors.infinity_rerank.InfinityRerank`	Document compressor that uses Infinity Rerank API.
`document_compressors.jina_rerank.JinaRerank`	Document compressor that uses Jina Rerank API.
`document_compressors.llmlingua_filter.LLMLinguaCompressor`	Compress using LLMLingua Project.
`document_compressors.openvino_rerank.OpenVINOReranker`	OpenVINO rerank models.
`document_compressors.openvino_rerank.RerankRequest`([...])	Request for reranking.
`document_compressors.rankllm_rerank.ModelType`(value)
`document_compressors.rankllm_rerank.RankLLMRerank`	Document compressor using Flashrank interface.
`document_compressors.volcengine_rerank.VolcengineRerank`	Document compressor that uses Volcengine Rerank API.

document_loaders #

Classes

`document_loaders.acreom.AcreomLoader`(path[, ...])	Load acreom vault from a directory.
`document_loaders.airbyte.AirbyteCDKLoader`(...)	Load with an Airbyte source connector implemented using the CDK.
`document_loaders.airbyte.AirbyteGongLoader`(...)	Load from Gong using an Airbyte source connector.
`document_loaders.airbyte.AirbyteHubspotLoader`(...)	Load from Hubspot using an Airbyte source connector.
`document_loaders.airbyte.AirbyteSalesforceLoader`(...)	Load from Salesforce using an Airbyte source connector.
`document_loaders.airbyte.AirbyteShopifyLoader`(...)	Load from Shopify using an Airbyte source connector.
`document_loaders.airbyte.AirbyteStripeLoader`(...)	Load from Stripe using an Airbyte source connector.
`document_loaders.airbyte.AirbyteTypeformLoader`(...)	Load from Typeform using an Airbyte source connector.
`document_loaders.airbyte.AirbyteZendeskSupportLoader`(...)	Load from Zendesk Support using an Airbyte source connector.
`document_loaders.airbyte_json.AirbyteJSONLoader`(...)	Load local Airbyte json files.
`document_loaders.airtable.AirtableLoader`(...)	Load the Airtable tables.
`document_loaders.apify_dataset.ApifyDatasetLoader`	Load datasets from Apify web scraping, crawling, and data extraction platform.
`document_loaders.arcgis_loader.ArcGISLoader`(layer)	Load records from an ArcGIS FeatureLayer.
`document_loaders.arxiv.ArxivLoader`(query[, ...])	Load a query result from Arxiv.
`document_loaders.assemblyai.AssemblyAIAudioLoaderById`(...)	Load AssemblyAI audio transcripts.
`document_loaders.assemblyai.AssemblyAIAudioTranscriptLoader`(...)	Load AssemblyAI audio transcripts.
`document_loaders.assemblyai.TranscriptFormat`(value)	Transcript format to use for the document loader.
`document_loaders.async_html.AsyncHtmlLoader`(...)	Load HTML asynchronously.
`document_loaders.athena.AthenaLoader`(query, ...)	Load documents from AWS Athena.
`document_loaders.azlyrics.AZLyricsLoader`([...])	Load AZLyrics webpages.
`document_loaders.azure_ai_data.AzureAIDataLoader`(url)	Load from Azure AI Data.
`document_loaders.azure_blob_storage_container.AzureBlobStorageContainerLoader`(...)	Load from Azure Blob Storage container.
`document_loaders.azure_blob_storage_file.AzureBlobStorageFileLoader`(...)	Load from Azure Blob Storage files.
`document_loaders.baiducloud_bos_directory.BaiduBOSDirectoryLoader`(...)	Load from Baidu BOS directory.
`document_loaders.baiducloud_bos_file.BaiduBOSFileLoader`(...)	Load from Baidu Cloud BOS file.
`document_loaders.base_o365.O365BaseLoader`	Base class for all loaders that uses O365 Package
`document_loaders.bibtex.BibtexLoader`(...[, ...])	Load a bibtex file.
`document_loaders.bilibili.BiliBiliLoader`(...)	Load fetching transcripts from BiliBili videos.
`document_loaders.blackboard.BlackboardLoader`(...)	Load a Blackboard course.
`document_loaders.blob_loaders.cloud_blob_loader.CloudBlobLoader`(url, *)	Load blobs from cloud URL or file:.
`document_loaders.blob_loaders.file_system.FileSystemBlobLoader`(path, *)	Load blobs in the local file system.
`document_loaders.blob_loaders.youtube_audio.YoutubeAudioLoader`(...)	Load YouTube urls as audio file(s).
`document_loaders.blockchain.BlockchainDocumentLoader`(...)	Load elements from a blockchain smart contract.
`document_loaders.blockchain.BlockchainType`(value)	Enumerator of the supported blockchains.
`document_loaders.brave_search.BraveSearchLoader`(...)	Load with Brave Search engine.
`document_loaders.browserbase.BrowserbaseLoader`(urls)	Load pre-rendered web pages using a headless browser hosted on Browserbase.
`document_loaders.browserless.BrowserlessLoader`(...)	Load webpages with Browserless /content endpoint.
`document_loaders.cassandra.CassandraLoader`(...)	Document Loader for Apache Cassandra.
`document_loaders.chatgpt.ChatGPTLoader`(log_file)	Load conversations from exported ChatGPT data.
`document_loaders.chm.CHMParser`(path)	Microsoft Compiled HTML Help (CHM) Parser.
`document_loaders.chm.UnstructuredCHMLoader`(...)	Load CHM files using Unstructured.
`document_loaders.chromium.AsyncChromiumLoader`(urls, *)	Scrape HTML pages from URLs using a headless instance of the Chromium.
`document_loaders.college_confidential.CollegeConfidentialLoader`([...])	Load College Confidential webpages.
`document_loaders.concurrent.ConcurrentLoader`(...)	Load and pars Documents concurrently.
`document_loaders.confluence.ConfluenceLoader`(url)	Load Confluence pages.
`document_loaders.confluence.ContentFormat`(value)	Enumerator of the content formats of Confluence page.
`document_loaders.conllu.CoNLLULoader`(file_path)	Load CoNLL-U files.
`document_loaders.couchbase.CouchbaseLoader`(...)	Load documents from Couchbase.
`document_loaders.csv_loader.CSVLoader`(file_path)	Load a CSV file into a list of Documents.
`document_loaders.csv_loader.UnstructuredCSVLoader`(...)	Load CSV files using Unstructured.
`document_loaders.cube_semantic.CubeSemanticLoader`(...)	Load Cube semantic layer metadata.
`document_loaders.datadog_logs.DatadogLogsLoader`(...)	Load Datadog logs.
`document_loaders.dataframe.BaseDataFrameLoader`(...)	Initialize with dataframe object.
`document_loaders.dataframe.DataFrameLoader`(...)	Load Pandas DataFrame.
`document_loaders.dedoc.DedocAPIFileLoader`(...)	Load files using dedoc API. The file loader automatically detects the file type (even with the wrong extension). By default, the loader makes a call to the locally hosted dedoc API. More information about dedoc API can be found in dedoc documentation: https://dedoc.readthedocs.io/en/latest/dedoc_api_usage/api.html.
`document_loaders.dedoc.DedocBaseLoader`(...)	Base Loader that uses dedoc (https://dedoc.readthedocs.io).
`document_loaders.dedoc.DedocFileLoader`(...)	DedocFileLoader document loader integration to load files using dedoc.
`document_loaders.diffbot.DiffbotLoader`(...)	Load Diffbot json file.
`document_loaders.directory.DirectoryLoader`(...)	Load from a directory.
`document_loaders.discord.DiscordChatLoader`(...)	Load Discord chat logs.
`document_loaders.doc_intelligence.AzureAIDocumentIntelligenceLoader`(...)	Load a PDF with Azure Document Intelligence.
`document_loaders.docusaurus.DocusaurusLoader`(url)	Load from Docusaurus Documentation.
`document_loaders.dropbox.DropboxLoader`	Load files from Dropbox.
`document_loaders.duckdb_loader.DuckDBLoader`(query)	Load from DuckDB.
`document_loaders.email.OutlookMessageLoader`(...)	Loads Outlook Message files using extract_msg.
`document_loaders.email.UnstructuredEmailLoader`(...)	Load email files using Unstructured.
`document_loaders.epub.UnstructuredEPubLoader`(...)	Load EPub files using Unstructured.
`document_loaders.etherscan.EtherscanLoader`(...)	Load transactions from Ethereum mainnet.
`document_loaders.evernote.EverNoteLoader`(...)	Load from EverNote.
`document_loaders.excel.UnstructuredExcelLoader`(...)	Load Microsoft Excel files using Unstructured.
`document_loaders.facebook_chat.FacebookChatLoader`(path)	Load Facebook Chat messages directory dump.
`document_loaders.fauna.FaunaLoader`(query, ...)	Load from FaunaDB.
`document_loaders.figma.FigmaFileLoader`(...)	Load Figma file.
`document_loaders.firecrawl.FireCrawlLoader`(url, *)	FireCrawlLoader document loader integration
`document_loaders.generic.GenericLoader`(...)	Generic Document Loader.
`document_loaders.geodataframe.GeoDataFrameLoader`(...)	Load geopandas Dataframe.
`document_loaders.git.GitLoader`(repo_path[, ...])	Load Git repository files.
`document_loaders.gitbook.GitbookLoader`(web_page)	Load GitBook data.
`document_loaders.github.BaseGitHubLoader`	Load GitHub repository Issues.
`document_loaders.github.GitHubIssuesLoader`	Load issues of a GitHub repository.
`document_loaders.github.GithubFileLoader`	Load GitHub File
`document_loaders.glue_catalog.GlueCatalogLoader`(...)	Load table schemas from AWS Glue.
`document_loaders.gutenberg.GutenbergLoader`(...)	Load from Gutenberg.org.
`document_loaders.helpers.FileEncoding`(...)	File encoding as the NamedTuple.
`document_loaders.hn.HNLoader`([web_path, ...])	Load Hacker News data.
`document_loaders.html.UnstructuredHTMLLoader`(...)	Load HTML files using Unstructured.
`document_loaders.html_bs.BSHTMLLoader`(file_path)	__ModuleName__ document loader integration
`document_loaders.hugging_face_dataset.HuggingFaceDatasetLoader`(path)	Load from Hugging Face Hub datasets.
`document_loaders.hugging_face_model.HuggingFaceModelLoader`(*)	Load model information from Hugging Face Hub, including README content.
`document_loaders.ifixit.IFixitLoader`(web_path)	Load iFixit repair guides, device wikis and answers.
`document_loaders.image.UnstructuredImageLoader`(...)	Load PNG and JPG files using Unstructured.
`document_loaders.image_captions.ImageCaptionLoader`(images)	Load image captions.
`document_loaders.imsdb.IMSDbLoader`([...])	Load IMSDb webpages.
`document_loaders.iugu.IuguLoader`(resource[, ...])	Load from IUGU.
`document_loaders.joplin.JoplinLoader`([...])	Load notes from Joplin.
`document_loaders.json_loader.JSONLoader`(...)	Load a JSON file using a jq schema.
`document_loaders.kinetica_loader.KineticaLoader`(...)	Load from Kinetica API.
`document_loaders.lakefs.LakeFSClient`(...)	Client for lakeFS.
`document_loaders.lakefs.LakeFSLoader`(...[, ...])	Load from lakeFS.
`document_loaders.lakefs.UnstructuredLakeFSLoader`(...)	Load from lakeFS as unstructured data.
`document_loaders.larksuite.LarkSuiteDocLoader`(...)	Load from LarkSuite (FeiShu).
`document_loaders.larksuite.LarkSuiteWikiLoader`(...)	Load from LarkSuite (FeiShu) wiki.
`document_loaders.llmsherpa.LLMSherpaFileLoader`(...)	Load Documents using LLMSherpa.
`document_loaders.markdown.UnstructuredMarkdownLoader`(...)	Load Markdown files using Unstructured.
`document_loaders.mastodon.MastodonTootsLoader`(...)	Load the Mastodon 'toots'.
`document_loaders.max_compute.MaxComputeLoader`(...)	Load from Alibaba Cloud MaxCompute table.
`document_loaders.mediawikidump.MWDumpLoader`(...)	Load MediaWiki dump from an XML file.
`document_loaders.merge.MergedDataLoader`(loaders)	Merge documents from a list of loaders
`document_loaders.mhtml.MHTMLLoader`(file_path)	Parse MHTML files with BeautifulSoup.
`document_loaders.mintbase.MintbaseDocumentLoader`(...)	Load elements from a blockchain smart contract.
`document_loaders.modern_treasury.ModernTreasuryLoader`(...)	Load from Modern Treasury.
`document_loaders.mongodb.MongodbLoader`(...)	Load MongoDB documents.
`document_loaders.news.NewsURLLoader`(urls[, ...])	Load news articles from URLs using Unstructured.
`document_loaders.notebook.NotebookLoader`(path)	Load Jupyter notebook (.ipynb) files.
`document_loaders.notion.NotionDirectoryLoader`(path, *)	Load Notion directory dump.
`document_loaders.notiondb.NotionDBLoader`(...)	Load from Notion DB.
`document_loaders.nuclia.NucliaLoader`(path, ...)	Load from any file type using Nuclia Understanding API.
`document_loaders.obs_directory.OBSDirectoryLoader`(...)	Load from Huawei OBS directory.
`document_loaders.obs_file.OBSFileLoader`(...)	Load from the Huawei OBS file.
`document_loaders.obsidian.ObsidianLoader`(path)	Load Obsidian files from directory.
`document_loaders.odt.UnstructuredODTLoader`(...)	Load OpenOffice ODT files using Unstructured.
`document_loaders.onedrive.OneDriveLoader`	Load documents from Microsoft OneDrive.
`document_loaders.onedrive_file.OneDriveFileLoader`	Load a file from Microsoft OneDrive.
`document_loaders.onenote.OneNoteLoader`	Load pages from OneNote notebooks.
`document_loaders.open_city_data.OpenCityDataLoader`(...)	Load from Open City.
`document_loaders.oracleadb_loader.OracleAutonomousDatabaseLoader`(...)	Load from oracle adb
`document_loaders.oracleai.OracleDocLoader`(...)	Read documents using OracleDocLoader :param conn: Oracle Connection, :param params: Loader parameters.
`document_loaders.oracleai.OracleDocReader`()	Read a file
`document_loaders.oracleai.OracleTextSplitter`(...)	Splitting text using Oracle chunker.
`document_loaders.oracleai.ParseOracleDocMetadata`()	Parse Oracle doc metadata...
`document_loaders.org_mode.UnstructuredOrgModeLoader`(...)	Load Org-Mode files using Unstructured.
`document_loaders.parsers.audio.AzureOpenAIWhisperParser`(*)	Transcribe and parse audio files using Azure OpenAI Whisper.
`document_loaders.parsers.audio.FasterWhisperParser`(*)	Transcribe and parse audio files with faster-whisper.
`document_loaders.parsers.audio.OpenAIWhisperParser`([...])	Transcribe and parse audio files.
`document_loaders.parsers.audio.OpenAIWhisperParserLocal`([...])	Transcribe and parse audio files with OpenAI Whisper model.
`document_loaders.parsers.audio.YandexSTTParser`(*)	Transcribe and parse audio files.
`document_loaders.parsers.doc_intelligence.AzureAIDocumentIntelligenceParser`(...)	Loads a PDF with Azure Document Intelligence (formerly Forms Recognizer).
`document_loaders.parsers.docai.DocAIParsingResults`(...)	Dataclass to store Document AI parsing results.
`document_loaders.parsers.generic.MimeTypeBasedParser`(...)	Parser that uses mime-types to parse a blob.
`document_loaders.parsers.grobid.GrobidParser`(...)	Load article PDF files using Grobid.
`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.elixir.ElixirSegmenter`(code)	Code segmenter for Elixir.
`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.
`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.DedocPDFLoader`(file_path, *)	DedocPDFLoader document loader integration to load PDF files using dedoc. The file loader can automatically detect the correctness of a textual layer in the PDF document. Note that __init__ method supports parameters that differ from ones of DedocBaseLoader.
`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`(...[, ...])	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)	PyPDFLoader document loader integration
`document_loaders.pdf.PyPDFium2Loader`(...[, ...])	Load PDF using pypdfium2 and chunks at character level.
`document_loaders.pdf.UnstructuredPDFLoader`(...)	Load PDF files using Unstructured.
`document_loaders.pdf.ZeroxPDFLoader`(file_path)	Document loader utilizing Zerox library: getomni-ai/zerox
`document_loaders.pebblo.PebbloSafeLoader`(...)	Pebblo Safe Loader class is a wrapper around document loaders enabling the data to be scrutinized.
`document_loaders.pebblo.PebbloTextLoader`(...)	Loader for text data.
`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.
`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)	Recursively load all child links from a root URL.
`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.scrapingant.ScrapingAntLoader`(urls, *)	Turn an url to LLM accessible markdown with ScrapingAnt.
`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`(...)	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.
`document_loaders.unstructured.UnstructuredBaseLoader`([...])	Base Loader that uses 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`([...])	WebBaseLoader document loader integration
`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.
`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)	Output formats of transcripts from YoutubeLoader.
`document_loaders.youtube.YoutubeLoader`(video_id)	Load YouTube video transcripts.
`document_loaders.yuque.YuqueLoader`(access_token)	Load documents from Yuque.

Functions

`document_loaders.base_o365.fetch_extensions`(...)	Fetch the mime types for the specified file types.
`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.
`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.

Deprecated classes

`document_loaders.astradb.AstraDBLoader`(...)
`document_loaders.bigquery.BigQueryLoader`(query)
`document_loaders.docugami.DocugamiLoader`
`document_loaders.gcs_directory.GCSDirectoryLoader`(...)
`document_loaders.gcs_file.GCSFileLoader`(...)
`document_loaders.google_speech_to_text.GoogleSpeechToTextLoader`(...)
`document_loaders.googledrive.GoogleDriveLoader`
`document_loaders.parsers.docai.DocAIParser`(*)
`document_loaders.unstructured.UnstructuredAPIFileIOLoader`(file, *)
`document_loaders.unstructured.UnstructuredAPIFileLoader`(...)
`document_loaders.unstructured.UnstructuredFileIOLoader`(file, *)
`document_loaders.unstructured.UnstructuredFileLoader`(...)

document_transformers #

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.html2text.Html2TextTransformer`([...])	Replace occurrences of a particular search pattern with a replacement string
`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

Deprecated classes

document_transformers.google_translate.GoogleTranslateTransformer(...)

embeddings #

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.ascend.AscendEmbeddings`	Ascend NPU accelerate Embedding model
`embeddings.awa.AwaEmbeddings`	Embedding documents and queries with Awa DB.
`embeddings.baichuan.BaichuanTextEmbeddings`	Baichuan Text Embedding models.
`embeddings.baidu_qianfan_endpoint.QianfanEmbeddingsEndpoint`	Baidu Qianfan Embeddings 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.dashscope.DashScopeEmbeddings`	DashScope embedding models.
`embeddings.deepinfra.DeepInfraEmbeddings`	Deep Infra's embedding inference service.
`embeddings.edenai.EdenAiEmbeddings`	EdenAI embedding.
`embeddings.embaas.EmbaasEmbeddings`	Embaas's embedding service.
`embeddings.embaas.EmbaasEmbeddingsPayload`	Payload for the Embaas embeddings API.
`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.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.HuggingFaceInferenceAPIEmbeddings`	Embed texts using the HuggingFace API.
`embeddings.huggingface.HuggingFaceInstructEmbeddings`	Wrapper around sentence_transformers 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`	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 embedding model integration.
`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.naver.ClovaXEmbeddings`	NCP ClovaStudio Embedding API.
`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.openvino.OpenVINOBgeEmbeddings`	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.ovhcloud.OVHCloudEmbeddings`	OVHcloud AI Endpoints 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.spacy_embeddings.SpacyEmbeddings`	Embeddings by spaCy models.
`embeddings.sparkllm.AssembleHeaderException`(msg)	Exception raised for errors in the header assembly.
`embeddings.sparkllm.SparkLLMTextEmbeddings`	SparkLLM embedding model integration.
`embeddings.sparkllm.Url`(host, path, schema)	URL class for parsing the URL.
`embeddings.tensorflow_hub.TensorflowHubEmbeddings`	TensorflowHub embedding models.
`embeddings.text2vec.Text2vecEmbeddings`	text2vec embedding models.
`embeddings.textembed.AsyncOpenAITextEmbedEmbeddingClient`([...])	A client to handle synchronous and asynchronous requests to the TextEmbed API.
`embeddings.textembed.TextEmbedEmbeddings`	A class to handle embedding requests to the TextEmbed API.
`embeddings.titan_takeoff.Device`(value[, ...])	Device to use for inference, cuda or cpu.
`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.volcengine.VolcanoEmbeddings`	Volcengine Embeddings embedding models.
`embeddings.xinference.XinferenceEmbeddings`([...])	Xinference embedding models.
`embeddings.yandex.YandexGPTEmbeddings`	YandexGPT Embeddings models.
`embeddings.zhipuai.ZhipuAIEmbeddings`	ZhipuAI embedding model integration.

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)	Get the bytes string of a file.
`embeddings.jina.is_local`(url)	Check if a URL is a local file.
`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.
`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.

Deprecated classes

`embeddings.azure_openai.AzureOpenAIEmbeddings`
`embeddings.bedrock.BedrockEmbeddings`
`embeddings.clova.ClovaEmbeddings`
`embeddings.cohere.CohereEmbeddings`
`embeddings.databricks.DatabricksEmbeddings`
`embeddings.elasticsearch.ElasticsearchEmbeddings`(...)
`embeddings.ernie.ErnieEmbeddings`
`embeddings.gigachat.GigaChatEmbeddings`
`embeddings.huggingface.HuggingFaceEmbeddings`
`embeddings.huggingface_hub.HuggingFaceHubEmbeddings`
`embeddings.nemo.NeMoEmbeddings`
`embeddings.ollama.OllamaEmbeddings`
`embeddings.openai.OpenAIEmbeddings`
`embeddings.solar.SolarEmbeddings`
`embeddings.vertexai.VertexAIEmbeddings`
`embeddings.voyageai.VoyageEmbeddings`

example_selectors #

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.

graph_vectorstores #

Classes

`graph_vectorstores.base.GraphVectorStore`(...)
`graph_vectorstores.base.GraphVectorStoreRetriever`
`graph_vectorstores.base.Node`
`graph_vectorstores.cassandra.AdjacentNode`(...)	Create an Adjacent Node.
`graph_vectorstores.cassandra.CassandraGraphVectorStore`(...)
`graph_vectorstores.extractors.gliner_link_extractor.GLiNERLinkExtractor`(...)
`graph_vectorstores.extractors.hierarchy_link_extractor.HierarchyLinkExtractor`(*)
`graph_vectorstores.extractors.html_link_extractor.HtmlInput`(...)
`graph_vectorstores.extractors.html_link_extractor.HtmlLinkExtractor`(*)
`graph_vectorstores.extractors.keybert_link_extractor.KeybertLinkExtractor`(*)
`graph_vectorstores.extractors.link_extractor.LinkExtractor`(...)
`graph_vectorstores.extractors.link_extractor_adapter.LinkExtractorAdapter`(...)
`graph_vectorstores.extractors.link_extractor_transformer.LinkExtractorTransformer`(...)
`graph_vectorstores.links.Link`(kind, ...)
`graph_vectorstores.mmr_helper.MmrHelper`(k, ...)	Helper for executing an MMR traversal query.

Functions

`graph_vectorstores.base.nodes_to_documents`(nodes)
`graph_vectorstores.links.add_links`(doc, *links)
`graph_vectorstores.links.copy_with_links`(...)
`graph_vectorstores.links.get_links`(doc)
`graph_vectorstores.networkx.documents_to_networkx`(...)	Return the networkx directed graph corresponding to the documents.

graphs #

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.
`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.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`(...)	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.networkx_graph.get_entities`(entity_str)	Extract entities from entity string.
`graphs.networkx_graph.parse_triples`(...)	Parse knowledge triples from the knowledge string.

Deprecated classes

graphs.neo4j_graph.Neo4jGraph([url, ...])

Deprecated functions

`graphs.neo4j_graph.clean_string_values`(text)
`graphs.neo4j_graph.value_sanitize`(d)

indexes #

Classes

indexes.base.RecordManager(namespace)

Abstract base class for a record manager.

llms #

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.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
`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 completion model integration.
`llms.bananadev.Banana`	Banana large language models.
`llms.baseten.Baseten`	Baseten model
`llms.beam.Beam`	Beam API for gpt2 large language model.
`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.ctransformers.CTransformers`	C Transformers LLM models.
`llms.ctranslate2.CTranslate2`	CTranslate2 language model.
`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.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.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.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`	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.BaseOCIModelDeployment`	Base class for LLM deployed on OCI Data Science Model Deployment.
`llms.oci_data_science_model_deployment_endpoint.OCIModelDeploymentLLM`	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_data_science_model_deployment_endpoint.ServerError`	Raises when encounter server error when making inference.
`llms.oci_data_science_model_deployment_endpoint.TokenExpiredError`	Raises when token expired.
`llms.oci_generative_ai.CohereProvider`()
`llms.oci_generative_ai.MetaProvider`()
`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.oci_generative_ai.Provider`()
`llms.octoai_endpoint.OctoAIEndpoint`	OctoAI LLM Endpoints - OpenAI compatible.
`llms.ollama.OllamaEndpointNotFoundError`	Raised when the Ollama endpoint is not found.
`llms.opaqueprompts.OpaquePrompts`	LLM that uses OpaquePrompts to sanitize prompts.
`llms.openai.BaseOpenAI`	Base OpenAI large language model class.
`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.outlines.Outlines`	LLM wrapper for the Outlines library.
`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.SambaNovaCloud`	SambaNova Cloud large language models.
`llms.sambanova.SambaStudio`	SambaStudio 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 completion model integration.
`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[, names, ...])	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.tongyi.Tongyi`	Tongyi completion model integration.
`llms.vllm.VLLM`	VLLM language model.
`llms.vllm.VLLMOpenAI`	vLLM OpenAI-compatible API client
`llms.volcengine_maas.VolcEngineMaasBase`	Base class for VolcEngineMaas models.
`llms.volcengine_maas.VolcEngineMaasLLM`	volc engine maas hosts a plethora of 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.yi.YiLLM`	Yi large language models.
`llms.you.You`	Wrapper around You.com's conversational Smart and Research APIs.
`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`(...)	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.
`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.

Deprecated classes

`llms.anthropic.Anthropic`
`llms.bedrock.Bedrock`
`llms.cohere.BaseCohere`
`llms.cohere.Cohere`
`llms.databricks.Databricks`
`llms.fireworks.Fireworks`
`llms.google_palm.GooglePalm`
`llms.huggingface_endpoint.HuggingFaceEndpoint`
`llms.huggingface_hub.HuggingFaceHub`
`llms.huggingface_pipeline.HuggingFacePipeline`
`llms.huggingface_text_gen_inference.HuggingFaceTextGenInference`
`llms.ollama.Ollama`
`llms.openai.AzureOpenAI`
`llms.openai.OpenAI`
`llms.openai.OpenAIChat`
`llms.together.Together`
`llms.vertexai.VertexAI`
`llms.vertexai.VertexAIModelGarden`
`llms.watsonxllm.WatsonxLLM`

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.

output_parsers #

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.

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.hanavector.HanaTranslator`()	Translate internal query language elements to valid filters params for HANA vectorstore.
`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)	Convert a value to a string and add single quotes if it is a string.

Deprecated classes

query_constructors.neo4j.Neo4jTranslator(...)

retrievers #

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 retriever.
`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.
`retrievers.chatgpt_plugin_retriever.ChatGPTPluginRetriever`	ChatGPT plugin retriever.
`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_vertex_ai_search.GoogleCloudEnterpriseSearchRetriever`	Google Vertex Search API retriever alias for backwards compatibility.
`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.
`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.nanopq.NanoPQRetriever`	`NanoPQ retriever.
`retrievers.outline.OutlineRetriever`	Retriever for Outline API.
`retrievers.pinecone_hybrid_search.PineconeHybridSearchRetriever`	Pinecone Hybrid Search retriever.
`retrievers.pubmed.PubMedRetriever`	PubMed API retriever.
`retrievers.rememberizer.RememberizerRetriever`	Rememberizer retriever.
`retrievers.remote_retriever.RemoteLangChainRetriever`	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[, names, ...])	Which documents to search.
`retrievers.zep.SearchType`(value[, names, ...])	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.
`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.nanopq.create_index`(contexts, ...)	Create an index of embeddings for a list of contexts.
`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.

Deprecated classes

`retrievers.cohere_rag_retriever.CohereRagRetriever`
`retrievers.google_cloud_documentai_warehouse.GoogleDocumentAIWarehouseRetriever`
`retrievers.google_vertex_ai_search.GoogleVertexAIMultiTurnSearchRetriever`
`retrievers.google_vertex_ai_search.GoogleVertexAISearchRetriever`
`retrievers.qdrant_sparse_vector_retriever.QdrantSparseVectorRetriever`

storage #

Classes

`storage.astradb.AstraDBBaseStore`(args, *kwargs)	Base class for the DataStax AstraDB data store.
`storage.cassandra.CassandraByteStore`(table, *)	A ByteStore implementation using Cassandra as the backend.
`storage.mongodb.MongoDBByteStore`(...[, ...])	BaseStore implementation using MongoDB as the underlying store.
`storage.mongodb.MongoDBStore`(...[, ...])	BaseStore implementation using MongoDB as the underlying store.
`storage.redis.RedisStore`(*[, client, ...])	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.

Functions

storage.sql.items_equal(x, y)

Deprecated classes

`storage.astradb.AstraDBByteStore`(collection_name)
`storage.astradb.AstraDBStore`(collection_name)
`storage.upstash_redis.UpstashRedisStore`(*[, ...])

tools #

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.
`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.
`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`	Bing Search tool.
`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`	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`	Tool that queries the DuckDuckGo search API and returns the results in output_format.
`tools.ddg_search.tool.DuckDuckGoSearchRun`	DuckDuckGo tool.
`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_speech_to_text.SpeechToTextInput`	Create a new model by parsing and validating input data from keyword arguments.
`tools.edenai.audio_text_to_speech.EdenAiTextToSpeechTool`	Tool that queries the Eden AI Text to speech API.
`tools.edenai.audio_text_to_speech.TextToSpeechInput`	Create a new model by parsing and validating input data from keyword arguments.
`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_explicitcontent.ExplicitImageInput`	Create a new model by parsing and validating input data from keyword arguments.
`tools.edenai.image_objectdetection.EdenAiObjectDetectionTool`	Tool that queries the Eden AI Object detection API.
`tools.edenai.image_objectdetection.ObjectDetectionInput`	Create a new model by parsing and validating input data from keyword arguments.
`tools.edenai.ocr_identityparser.EdenAiParsingIDTool`	Tool that queries the Eden AI Identity parsing API.
`tools.edenai.ocr_identityparser.IDParsingInput`	Create a new model by parsing and validating input data from keyword arguments.
`tools.edenai.ocr_invoiceparser.EdenAiParsingInvoiceTool`	Tool that queries the Eden AI Invoice parsing API.
`tools.edenai.ocr_invoiceparser.InvoiceParsingInput`	Create a new model by parsing and validating input data from keyword arguments.
`tools.edenai.text_moderation.EdenAiTextModerationTool`	Tool that queries the Eden AI Explicit text detection.
`tools.edenai.text_moderation.TextModerationInput`	Create a new model by parsing and validating input data from keyword arguments.
`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.financial_datasets.balance_sheets.BalanceSheets`	Tool that gets balance sheets for a given ticker over a given period.
`tools.financial_datasets.balance_sheets.BalanceSheetsSchema`	Input for BalanceSheets.
`tools.financial_datasets.cash_flow_statements.CashFlowStatements`	Tool that gets cash flow statements for a given ticker over a given period.
`tools.financial_datasets.cash_flow_statements.CashFlowStatementsSchema`	Input for CashFlowStatements.
`tools.financial_datasets.income_statements.IncomeStatements`	Tool that gets income statements for a given ticker over a given period.
`tools.financial_datasets.income_statements.IncomeStatementsSchema`	Input for IncomeStatements.
`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.
`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[, names, ...])	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_books.GoogleBooksQueryInput`	Input for the GoogleBooksQuery tool.
`tools.google_books.GoogleBooksQueryRun`	Tool that searches the Google Books 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_scholar.tool.GoogleScholarQueryRun`	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.jina_search.tool.JinaInput`	Input for the Jina search tool.
`tools.jina_search.tool.JinaSearch`	Tool that queries the JinaSearch.
`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.mojeek_search.tool.MojeekSearch`	Initialize the tool.
`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.
`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`	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.current_page.CurrentWebPageToolInput`	Explicit no-args input for CurrentWebPageTool.
`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.extract_text.ExtractTextToolInput`	Explicit no-args input for ExtractTextTool.
`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.
`tools.playwright.navigate_back.NavigateBackToolInput`	Explicit no-args input for NavigateBackTool.
`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.
`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.riza.command.ExecJavaScript`	A tool implementation to execute JavaScript via Riza's Code Interpreter API.
`tools.riza.command.ExecJavaScriptInput`	Create a new model by parsing and validating input data from keyword arguments.
`tools.riza.command.ExecPython`	Riza Code tool.
`tools.riza.command.ExecPythonInput`	Create a new model by parsing and validating input data from keyword arguments.
`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.SearxSearchQueryInput`	Input for the SearxSearch tool.
`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`	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`	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
`tools.zenguard.tool.Detector`(value[, names, ...])
`tools.zenguard.tool.DetectorAPI`(value[, ...])
`tools.zenguard.tool.ZenGuardInput`	Create a new model by parsing and validating input data from keyword arguments.
`tools.zenguard.tool.ZenGuardTool`	Initialize the tool.

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.
`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)	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.

Deprecated classes

`tools.google_cloud.texttospeech.GoogleCloudTextToSpeechTool`
`tools.google_places.tool.GooglePlacesTool`
`tools.google_search.tool.GoogleSearchResults`
`tools.google_search.tool.GoogleSearchRun`
`tools.metaphor_search.tool.MetaphorSearchResults`

utilities #

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[, names, ...])	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.
`utilities.arxiv.ArxivAPIWrapper`	Wrapper around ArxivAPI.
`utilities.asknews.AskNewsAPIWrapper`	Wrapper for AskNews API.
`utilities.astradb.SetupMode`(value[, names, ...])	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 Web Search API.
`utilities.brave_search.BraveSearchWrapper`	Wrapper around the Brave search engine.
`utilities.cassandra.SetupMode`(value[, ...])
`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.
`utilities.dria_index.DriaAPIWrapper`(api_key)	Wrapper around Dria API.
`utilities.duckduckgo_search.DuckDuckGoSearchAPIWrapper`	Wrapper for DuckDuckGo Search API.
`utilities.financial_datasets.FinancialDatasetsAPIWrapper`	Wrapper for financial datasets API.
`utilities.github.GitHubAPIWrapper`	Wrapper for GitHub API.
`utilities.gitlab.GitLabAPIWrapper`	Wrapper for GitLab API.
`utilities.golden_query.GoldenQueryAPIWrapper`	Wrapper for Golden.
`utilities.google_books.GoogleBooksAPIWrapper`	Wrapper around Google Books API.
`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_scholar.GoogleScholarAPIWrapper`	Wrapper for Google Scholar 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.jina_search.JinaSearchAPIWrapper`	Wrapper around the Jina search engine.
`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`	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[, names, ...])	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`(...)	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`	Pebblo Indexed Document.
`utilities.pebblo.PebbloLoaderAPIWrapper`	Wrapper for Pebblo Loader API.
`utilities.pebblo.Routes`(value[, names, ...])	Routes available for the Pebblo API as enumerator.
`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.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.
`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 and News 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)	Get the token ids for a string of text.
`utilities.cassandra.aexecute_cql`(session, ...)	Execute a CQL query asynchronously.
`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.calculate_content_size`(data)	Calculate the content size in bytes: - Encode the string to bytes using a specific encoding (e.g., UTF-8) - Get the length of the encoded bytes.
`utilities.pebblo.generate_size_based_batches`(docs)	Generate batches of documents based on page_content size.
`utilities.pebblo.get_file_owner_from_path`(...)	Fetch owner of local file path.
`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)	Return loader type among, file, dir or in-memory.
`utilities.pebblo.get_runtime`()	Fetch the current Framework and Runtime details.
`utilities.pebblo.get_source_size`(source_path)	Fetch size of source path.
`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.

Deprecated classes

`utilities.google_places_api.GooglePlacesAPIWrapper`
`utilities.google_search.GoogleSearchAPIWrapper`

utils #

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.
`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.

vectorstores #

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.
`vectorstores.aperturedb.ApertureDB`(embeddings)	Create a vectorstore backed by ApertureDB
`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.azure_cosmos_db_no_sql.AzureCosmosDBNoSqlVectorSearch`(*, ...)	Azure Cosmos DB for NoSQL vector store.
`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.cassandra.Cassandra`(embedding)	Apache Cassandra(R) for vector-store workloads.
`vectorstores.clarifai.Clarifai`([user_id, ...])	Clarifai AI vector store.
`vectorstores.clickhouse.Clickhouse`(embedding)	ClickHouse vector store integration.
`vectorstores.clickhouse.ClickhouseSettings`	ClickHouse client configuration.
`vectorstores.dashvector.DashVector`(...)	DashVector 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.elasticsearch.BaseRetrievalStrategy`()	Base class for Elasticsearch retrieval strategies.
`vectorstores.epsilla.Epsilla`(client, embeddings)	Wrapper around Epsilla vector database.
`vectorstores.faiss.FAISS`(embedding_function, ...)	FAISS vector store integration.
`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`([...])	Helper class for Infinispan REST interface.
`vectorstores.infinispanvs.InfinispanVS`([...])	Infinispan VectorStore interface.
`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.
`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.meilisearch.Meilisearch`(embedding)	Meilisearch vector store.
`vectorstores.momento_vector_index.MomentoVectorIndex`(...)	Momento Vector Index (MVI) vector store.
`vectorstores.myscale.MyScale`(embedding[, config])	MyScale vector store.
`vectorstores.myscale.MyScaleSettings`	MyScale client configuration.
`vectorstores.myscale.MyScaleWithoutJSON`(...)	MyScale vector store without metadata column
`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.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.
`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.sqlitevec.SQLiteVec`(table, ...)	SQLite with Vec extension as a vector database.
`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.
`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.
`vectorstores.vectara.Vectara`([...])	Vectara API vector store.
`vectorstores.vectara.VectaraQueryConfig`([k, ...])	Configuration for Vectara query.
`vectorstores.vectara.VectaraRAG`(vectara, config)	Vectara RAG runnable.
`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.
`vectorstores.faiss.dependable_faiss_import`([...])	Import faiss if available, otherwise raise error.
`vectorstores.lancedb.import_lancedb`()	Import lancedb package.
`vectorstores.lancedb.to_lance_filter`(filter)	Converts a dict filter to a LanceDB filter string.
`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.oraclevs.create_index`(client, ...)	Create an index on the vector store.
`vectorstores.oraclevs.drop_index_if_exists`(...)	Drop an index if it exists.
`vectorstores.oraclevs.drop_table_purge`(...)	Drop a table and purge it from the database.
`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)	Normalize vectors to unit length.
`vectorstores.sqlitevec.serialize_f32`(vector)	Serializes a list of floats into a compact "raw bytes" format
`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.

Deprecated classes

`vectorstores.astradb.AstraDB`(*, embedding, ...)
`vectorstores.bigquery_vector_search.BigQueryVectorSearch`(...)
`vectorstores.chroma.Chroma`([...])
`vectorstores.couchbase.CouchbaseVectorStore`(...)
`vectorstores.databricks_vector_search.DatabricksVectorSearch`(...)
`vectorstores.elastic_vector_search.ElasticKnnSearch`(...)
`vectorstores.elastic_vector_search.ElasticVectorSearch`(...)
`vectorstores.elasticsearch.ApproxRetrievalStrategy`([...])
`vectorstores.elasticsearch.ElasticsearchStore`(...)
`vectorstores.elasticsearch.ExactRetrievalStrategy`(...)
`vectorstores.elasticsearch.SparseRetrievalStrategy`([...])
`vectorstores.matching_engine.MatchingEngine`(...)
`vectorstores.milvus.Milvus`(embedding_function)
`vectorstores.mongodb_atlas.MongoDBAtlasVectorSearch`(...)
`vectorstores.neo4j_vector.IndexType`(value[, ...])
`vectorstores.neo4j_vector.Neo4jVector`(...[, ...])
`vectorstores.neo4j_vector.SearchType`(value)
`vectorstores.pgvector.PGVector`(...[, ...])
`vectorstores.pinecone.Pinecone`(index, ...[, ...])
`vectorstores.qdrant.Qdrant`(client, ...[, ...])

Deprecated functions

`vectorstores.neo4j_vector.check_if_not_null`(...)
`vectorstores.neo4j_vector.collect_params`(...)
`vectorstores.neo4j_vector.combine_queries`(...)
`vectorstores.neo4j_vector.construct_metadata_filter`(filter)
`vectorstores.neo4j_vector.dict_to_yaml_str`(...)
`vectorstores.neo4j_vector.remove_lucene_chars`(text)
`vectorstores.neo4j_vector.sort_by_index_name`(...)