.. community_api_reference:

=======================
``langchain_community`` API Reference
=======================

:mod:`langchain_community.adapters`
====================================

.. automodule:: langchain_community.adapters
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: adapters
    :template: class.rst
    
    adapters.openai.Chat
    
    :template: class.rst
    
    adapters.openai.ChatCompletion
    
    :template: pydantic.rst
    
    adapters.openai.ChatCompletionChunk
    
    :template: pydantic.rst
    
    adapters.openai.ChatCompletions
    
    :template: pydantic.rst
    
    adapters.openai.Choice
    
    :template: pydantic.rst
    
    adapters.openai.ChoiceChunk
    
    :template: class.rst
    
    adapters.openai.Completions
    
    :template: pydantic.rst
    
    adapters.openai.IndexableBaseModel
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: adapters
    :template: function.rst

    adapters.openai.aenumerate
    adapters.openai.convert_dict_to_message
    adapters.openai.convert_message_to_dict
    adapters.openai.convert_messages_for_finetuning
    adapters.openai.convert_openai_messages

:mod:`langchain_community.agent_toolkits`
==========================================

.. automodule:: langchain_community.agent_toolkits
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: agent_toolkits
    :template: pydantic.rst
    
    agent_toolkits.ainetwork.toolkit.AINetworkToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.amadeus.toolkit.AmadeusToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.azure_cognitive_services.AzureCognitiveServicesToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.base.BaseToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.clickup.toolkit.ClickupToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.file_management.toolkit.FileManagementToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.github.toolkit.BranchName
    
    :template: pydantic.rst
    
    agent_toolkits.github.toolkit.CommentOnIssue
    
    :template: pydantic.rst
    
    agent_toolkits.github.toolkit.CreateFile
    
    :template: pydantic.rst
    
    agent_toolkits.github.toolkit.CreatePR
    
    :template: pydantic.rst
    
    agent_toolkits.github.toolkit.CreateReviewRequest
    
    :template: pydantic.rst
    
    agent_toolkits.github.toolkit.DeleteFile
    
    :template: pydantic.rst
    
    agent_toolkits.github.toolkit.DirectoryPath
    
    :template: pydantic.rst
    
    agent_toolkits.github.toolkit.GetIssue
    
    :template: pydantic.rst
    
    agent_toolkits.github.toolkit.GetPR
    
    :template: pydantic.rst
    
    agent_toolkits.github.toolkit.GitHubToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.github.toolkit.NoInput
    
    :template: pydantic.rst
    
    agent_toolkits.github.toolkit.ReadFile
    
    :template: pydantic.rst
    
    agent_toolkits.github.toolkit.SearchCode
    
    :template: pydantic.rst
    
    agent_toolkits.github.toolkit.SearchIssuesAndPRs
    
    :template: pydantic.rst
    
    agent_toolkits.github.toolkit.UpdateFile
    
    :template: pydantic.rst
    
    agent_toolkits.gitlab.toolkit.GitLabToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.gmail.toolkit.GmailToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.jira.toolkit.JiraToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.json.toolkit.JsonToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.multion.toolkit.MultionToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.nasa.toolkit.NasaToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.nla.tool.NLATool
    
    :template: pydantic.rst
    
    agent_toolkits.nla.toolkit.NLAToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.office365.toolkit.O365Toolkit
    
    :template: pydantic.rst
    
    agent_toolkits.openapi.planner.RequestsDeleteToolWithParsing
    
    :template: pydantic.rst
    
    agent_toolkits.openapi.planner.RequestsGetToolWithParsing
    
    :template: pydantic.rst
    
    agent_toolkits.openapi.planner.RequestsPatchToolWithParsing
    
    :template: pydantic.rst
    
    agent_toolkits.openapi.planner.RequestsPostToolWithParsing
    
    :template: pydantic.rst
    
    agent_toolkits.openapi.planner.RequestsPutToolWithParsing
    
    :template: class.rst
    
    agent_toolkits.openapi.spec.ReducedOpenAPISpec
    
    :template: pydantic.rst
    
    agent_toolkits.openapi.toolkit.OpenAPIToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.openapi.toolkit.RequestsToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.playwright.toolkit.PlayWrightBrowserToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.powerbi.toolkit.PowerBIToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.slack.toolkit.SlackToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.spark_sql.toolkit.SparkSQLToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.sql.toolkit.SQLDatabaseToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.steam.toolkit.SteamToolkit
    
    :template: pydantic.rst
    
    agent_toolkits.zapier.toolkit.ZapierToolkit
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: agent_toolkits
    :template: function.rst

    agent_toolkits.json.base.create_json_agent
    agent_toolkits.openapi.base.create_openapi_agent
    agent_toolkits.openapi.planner.create_openapi_agent
    agent_toolkits.openapi.spec.reduce_openapi_spec
    agent_toolkits.powerbi.base.create_pbi_agent
    agent_toolkits.powerbi.chat_base.create_pbi_chat_agent
    agent_toolkits.spark_sql.base.create_spark_sql_agent
    agent_toolkits.sql.base.create_sql_agent

:mod:`langchain_community.cache`
=================================

.. automodule:: langchain_community.cache
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: cache
    :template: class.rst
    
    cache.AstraDBCache
    
    :template: class.rst
    
    cache.AstraDBSemanticCache
    
    :template: class.rst
    
    cache.CassandraCache
    
    :template: class.rst
    
    cache.CassandraSemanticCache
    
    :template: class.rst
    
    cache.FullLLMCache
    
    :template: class.rst
    
    cache.FullMd5LLMCache
    
    :template: class.rst
    
    cache.GPTCache
    
    :template: class.rst
    
    cache.InMemoryCache
    
    :template: class.rst
    
    cache.MomentoCache
    
    :template: class.rst
    
    cache.RedisCache
    
    :template: class.rst
    
    cache.RedisSemanticCache
    
    :template: class.rst
    
    cache.SQLAlchemyCache
    
    :template: class.rst
    
    cache.SQLAlchemyMd5Cache
    
    :template: class.rst
    
    cache.SQLiteCache
    
    :template: class.rst
    
    cache.UpstashRedisCache
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: cache
    :template: function.rst

    

:mod:`langchain_community.callbacks`
=====================================

.. automodule:: langchain_community.callbacks
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: callbacks
    :template: class.rst
    
    callbacks.aim_callback.AimCallbackHandler
    
    :template: class.rst
    
    callbacks.aim_callback.BaseMetadataCallbackHandler
    
    :template: class.rst
    
    callbacks.argilla_callback.ArgillaCallbackHandler
    
    :template: class.rst
    
    callbacks.arize_callback.ArizeCallbackHandler
    
    :template: class.rst
    
    callbacks.arthur_callback.ArthurCallbackHandler
    
    :template: class.rst
    
    callbacks.clearml_callback.ClearMLCallbackHandler
    
    :template: class.rst
    
    callbacks.comet_ml_callback.CometCallbackHandler
    
    :template: class.rst
    
    callbacks.confident_callback.DeepEvalCallbackHandler
    
    :template: class.rst
    
    callbacks.context_callback.ContextCallbackHandler
    
    :template: class.rst
    
    callbacks.flyte_callback.FlyteCallbackHandler
    
    :template: class.rst
    
    callbacks.human.AsyncHumanApprovalCallbackHandler
    
    :template: class.rst
    
    callbacks.human.HumanApprovalCallbackHandler
    
    :template: class.rst
    
    callbacks.human.HumanRejectedException
    
    :template: class.rst
    
    callbacks.infino_callback.InfinoCallbackHandler
    
    :template: class.rst
    
    callbacks.labelstudio_callback.LabelStudioCallbackHandler
    
    :template: enum.rst
    
    callbacks.labelstudio_callback.LabelStudioMode
    
    :template: class.rst
    
    callbacks.llmonitor_callback.LLMonitorCallbackHandler
    
    :template: class.rst
    
    callbacks.llmonitor_callback.UserContextManager
    
    :template: class.rst
    
    callbacks.mlflow_callback.MlflowCallbackHandler
    
    :template: class.rst
    
    callbacks.mlflow_callback.MlflowLogger
    
    :template: class.rst
    
    callbacks.openai_info.OpenAICallbackHandler
    
    :template: class.rst
    
    callbacks.promptlayer_callback.PromptLayerCallbackHandler
    
    :template: class.rst
    
    callbacks.sagemaker_callback.SageMakerCallbackHandler
    
    :template: class.rst
    
    callbacks.streamlit.mutable_expander.ChildRecord
    
    :template: enum.rst
    
    callbacks.streamlit.mutable_expander.ChildType
    
    :template: class.rst
    
    callbacks.streamlit.mutable_expander.MutableExpander
    
    :template: class.rst
    
    callbacks.streamlit.streamlit_callback_handler.LLMThought
    
    :template: class.rst
    
    callbacks.streamlit.streamlit_callback_handler.LLMThoughtLabeler
    
    :template: enum.rst
    
    callbacks.streamlit.streamlit_callback_handler.LLMThoughtState
    
    :template: class.rst
    
    callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler
    
    :template: class.rst
    
    callbacks.streamlit.streamlit_callback_handler.ToolRecord
    
    :template: class.rst
    
    callbacks.tracers.comet.CometTracer
    
    :template: class.rst
    
    callbacks.tracers.wandb.RunProcessor
    
    :template: typeddict.rst
    
    callbacks.tracers.wandb.WandbRunArgs
    
    :template: class.rst
    
    callbacks.tracers.wandb.WandbTracer
    
    :template: class.rst
    
    callbacks.trubrics_callback.TrubricsCallbackHandler
    
    :template: class.rst
    
    callbacks.utils.BaseMetadataCallbackHandler
    
    :template: class.rst
    
    callbacks.wandb_callback.WandbCallbackHandler
    
    :template: class.rst
    
    callbacks.whylabs_callback.WhyLabsCallbackHandler
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: callbacks
    :template: function.rst

    callbacks.aim_callback.import_aim
    callbacks.clearml_callback.import_clearml
    callbacks.comet_ml_callback.import_comet_ml
    callbacks.context_callback.import_context
    callbacks.flyte_callback.analyze_text
    callbacks.flyte_callback.import_flytekit
    callbacks.infino_callback.get_num_tokens
    callbacks.infino_callback.import_infino
    callbacks.infino_callback.import_tiktoken
    callbacks.labelstudio_callback.get_default_label_configs
    callbacks.llmonitor_callback.identify
    callbacks.manager.get_openai_callback
    callbacks.manager.wandb_tracing_enabled
    callbacks.mlflow_callback.analyze_text
    callbacks.mlflow_callback.construct_html_from_prompt_and_generation
    callbacks.mlflow_callback.import_mlflow
    callbacks.openai_info.get_openai_token_cost_for_model
    callbacks.openai_info.standardize_model_name
    callbacks.sagemaker_callback.save_json
    callbacks.tracers.comet.import_comet_llm_api
    callbacks.utils.flatten_dict
    callbacks.utils.hash_string
    callbacks.utils.import_pandas
    callbacks.utils.import_spacy
    callbacks.utils.import_textstat
    callbacks.utils.load_json
    callbacks.wandb_callback.analyze_text
    callbacks.wandb_callback.construct_html_from_prompt_and_generation
    callbacks.wandb_callback.import_wandb
    callbacks.wandb_callback.load_json_to_dict
    callbacks.whylabs_callback.import_langkit

:mod:`langchain_community.chat_loaders`
========================================

.. automodule:: langchain_community.chat_loaders
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: chat_loaders
    :template: class.rst
    
    chat_loaders.base.BaseChatLoader
    
    :template: class.rst
    
    chat_loaders.facebook_messenger.FolderFacebookMessengerChatLoader
    
    :template: class.rst
    
    chat_loaders.facebook_messenger.SingleFileFacebookMessengerChatLoader
    
    :template: class.rst
    
    chat_loaders.gmail.GMailLoader
    
    :template: class.rst
    
    chat_loaders.imessage.IMessageChatLoader
    
    :template: class.rst
    
    chat_loaders.langsmith.LangSmithDatasetChatLoader
    
    :template: class.rst
    
    chat_loaders.langsmith.LangSmithRunChatLoader
    
    :template: class.rst
    
    chat_loaders.slack.SlackChatLoader
    
    :template: class.rst
    
    chat_loaders.telegram.TelegramChatLoader
    
    :template: class.rst
    
    chat_loaders.whatsapp.WhatsAppChatLoader
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: chat_loaders
    :template: function.rst

    chat_loaders.utils.map_ai_messages
    chat_loaders.utils.map_ai_messages_in_session
    chat_loaders.utils.merge_chat_runs
    chat_loaders.utils.merge_chat_runs_in_session

:mod:`langchain_community.chat_message_histories`
==================================================

.. automodule:: langchain_community.chat_message_histories
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: chat_message_histories
    :template: class.rst
    
    chat_message_histories.astradb.AstraDBChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.cassandra.CassandraChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.cosmos_db.CosmosDBChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.dynamodb.DynamoDBChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.elasticsearch.ElasticsearchChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.file.FileChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.firestore.FirestoreChatMessageHistory
    
    :template: pydantic.rst
    
    chat_message_histories.in_memory.ChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.momento.MomentoChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.mongodb.MongoDBChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.neo4j.Neo4jChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.postgres.PostgresChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.redis.RedisChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.rocksetdb.RocksetChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.singlestoredb.SingleStoreDBChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.sql.BaseMessageConverter
    
    :template: class.rst
    
    chat_message_histories.sql.DefaultMessageConverter
    
    :template: class.rst
    
    chat_message_histories.sql.SQLChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.streamlit.StreamlitChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.upstash_redis.UpstashRedisChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.xata.XataChatMessageHistory
    
    :template: class.rst
    
    chat_message_histories.zep.ZepChatMessageHistory
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: chat_message_histories
    :template: function.rst

    chat_message_histories.sql.create_message_model

:mod:`langchain_community.chat_models`
=======================================

.. automodule:: langchain_community.chat_models
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: chat_models
    :template: pydantic.rst
    
    chat_models.anthropic.ChatAnthropic
    
    :template: pydantic.rst
    
    chat_models.anyscale.ChatAnyscale
    
    :template: pydantic.rst
    
    chat_models.azure_openai.AzureChatOpenAI
    
    :template: pydantic.rst
    
    chat_models.azureml_endpoint.AzureMLChatOnlineEndpoint
    
    :template: class.rst
    
    chat_models.azureml_endpoint.LlamaContentFormatter
    
    :template: pydantic.rst
    
    chat_models.baichuan.ChatBaichuan
    
    :template: pydantic.rst
    
    chat_models.baidu_qianfan_endpoint.QianfanChatEndpoint
    
    :template: pydantic.rst
    
    chat_models.bedrock.BedrockChat
    
    :template: class.rst
    
    chat_models.bedrock.ChatPromptAdapter
    
    :template: pydantic.rst
    
    chat_models.cohere.ChatCohere
    
    :template: pydantic.rst
    
    chat_models.databricks.ChatDatabricks
    
    :template: pydantic.rst
    
    chat_models.ernie.ErnieBotChat
    
    :template: pydantic.rst
    
    chat_models.everlyai.ChatEverlyAI
    
    :template: pydantic.rst
    
    chat_models.fake.FakeListChatModel
    
    :template: pydantic.rst
    
    chat_models.fake.FakeMessagesListChatModel
    
    :template: pydantic.rst
    
    chat_models.fireworks.ChatFireworks
    
    :template: pydantic.rst
    
    chat_models.gigachat.GigaChat
    
    :template: pydantic.rst
    
    chat_models.google_palm.ChatGooglePalm
    
    :template: class.rst
    
    chat_models.google_palm.ChatGooglePalmError
    
    :template: pydantic.rst
    
    chat_models.human.HumanInputChatModel
    
    :template: pydantic.rst
    
    chat_models.hunyuan.ChatHunyuan
    
    :template: pydantic.rst
    
    chat_models.javelin_ai_gateway.ChatJavelinAIGateway
    
    :template: pydantic.rst
    
    chat_models.javelin_ai_gateway.ChatParams
    
    :template: pydantic.rst
    
    chat_models.jinachat.JinaChat
    
    :template: pydantic.rst
    
    chat_models.konko.ChatKonko
    
    :template: pydantic.rst
    
    chat_models.litellm.ChatLiteLLM
    
    :template: class.rst
    
    chat_models.litellm.ChatLiteLLMException
    
    :template: pydantic.rst
    
    chat_models.minimax.MiniMaxChat
    
    :template: pydantic.rst
    
    chat_models.mlflow.ChatMlflow
    
    :template: pydantic.rst
    
    chat_models.mlflow_ai_gateway.ChatMLflowAIGateway
    
    :template: pydantic.rst
    
    chat_models.mlflow_ai_gateway.ChatParams
    
    :template: pydantic.rst
    
    chat_models.ollama.ChatOllama
    
    :template: pydantic.rst
    
    chat_models.openai.ChatOpenAI
    
    :template: pydantic.rst
    
    chat_models.pai_eas_endpoint.PaiEasChatEndpoint
    
    :template: pydantic.rst
    
    chat_models.promptlayer_openai.PromptLayerChatOpenAI
    
    :template: pydantic.rst
    
    chat_models.tongyi.ChatTongyi
    
    :template: pydantic.rst
    
    chat_models.vertexai.ChatVertexAI
    
    :template: pydantic.rst
    
    chat_models.volcengine_maas.VolcEngineMaasChat
    
    :template: pydantic.rst
    
    chat_models.yandex.ChatYandexGPT
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: chat_models
    :template: function.rst

    chat_models.anthropic.convert_messages_to_prompt_anthropic
    chat_models.baidu_qianfan_endpoint.convert_message_to_dict
    chat_models.cohere.get_cohere_chat_request
    chat_models.cohere.get_role
    chat_models.fireworks.acompletion_with_retry
    chat_models.fireworks.acompletion_with_retry_streaming
    chat_models.fireworks.completion_with_retry
    chat_models.fireworks.conditional_decorator
    chat_models.fireworks.convert_dict_to_message
    chat_models.google_palm.achat_with_retry
    chat_models.google_palm.chat_with_retry
    chat_models.jinachat.acompletion_with_retry
    chat_models.litellm.acompletion_with_retry
    chat_models.meta.convert_messages_to_prompt_llama
    chat_models.openai.acompletion_with_retry
    chat_models.tongyi.convert_dict_to_message
    chat_models.tongyi.convert_message_to_dict
    chat_models.volcengine_maas.convert_dict_to_message

:mod:`langchain_community.docstore`
====================================

.. automodule:: langchain_community.docstore
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: docstore
    :template: class.rst
    
    docstore.arbitrary_fn.DocstoreFn
    
    :template: class.rst
    
    docstore.base.AddableMixin
    
    :template: class.rst
    
    docstore.base.Docstore
    
    :template: class.rst
    
    docstore.in_memory.InMemoryDocstore
    
    :template: class.rst
    
    docstore.wikipedia.Wikipedia
    
:mod:`langchain_community.document_loaders`
============================================

.. automodule:: langchain_community.document_loaders
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: document_loaders
    :template: class.rst
    
    document_loaders.acreom.AcreomLoader
    
    :template: class.rst
    
    document_loaders.airbyte.AirbyteCDKLoader
    
    :template: class.rst
    
    document_loaders.airbyte.AirbyteGongLoader
    
    :template: class.rst
    
    document_loaders.airbyte.AirbyteHubspotLoader
    
    :template: class.rst
    
    document_loaders.airbyte.AirbyteSalesforceLoader
    
    :template: class.rst
    
    document_loaders.airbyte.AirbyteShopifyLoader
    
    :template: class.rst
    
    document_loaders.airbyte.AirbyteStripeLoader
    
    :template: class.rst
    
    document_loaders.airbyte.AirbyteTypeformLoader
    
    :template: class.rst
    
    document_loaders.airbyte.AirbyteZendeskSupportLoader
    
    :template: class.rst
    
    document_loaders.airbyte_json.AirbyteJSONLoader
    
    :template: class.rst
    
    document_loaders.airtable.AirtableLoader
    
    :template: pydantic.rst
    
    document_loaders.apify_dataset.ApifyDatasetLoader
    
    :template: class.rst
    
    document_loaders.arcgis_loader.ArcGISLoader
    
    :template: class.rst
    
    document_loaders.arxiv.ArxivLoader
    
    :template: class.rst
    
    document_loaders.assemblyai.AssemblyAIAudioTranscriptLoader
    
    :template: enum.rst
    
    document_loaders.assemblyai.TranscriptFormat
    
    :template: class.rst
    
    document_loaders.async_html.AsyncHtmlLoader
    
    :template: class.rst
    
    document_loaders.azlyrics.AZLyricsLoader
    
    :template: class.rst
    
    document_loaders.azure_ai_data.AzureAIDataLoader
    
    :template: class.rst
    
    document_loaders.azure_blob_storage_container.AzureBlobStorageContainerLoader
    
    :template: class.rst
    
    document_loaders.azure_blob_storage_file.AzureBlobStorageFileLoader
    
    :template: class.rst
    
    document_loaders.baiducloud_bos_directory.BaiduBOSDirectoryLoader
    
    :template: class.rst
    
    document_loaders.baiducloud_bos_file.BaiduBOSFileLoader
    
    :template: class.rst
    
    document_loaders.base.BaseBlobParser
    
    :template: class.rst
    
    document_loaders.base.BaseLoader
    
    :template: pydantic.rst
    
    document_loaders.base_o365.O365BaseLoader
    
    :template: class.rst
    
    document_loaders.bibtex.BibtexLoader
    
    :template: class.rst
    
    document_loaders.bigquery.BigQueryLoader
    
    :template: class.rst
    
    document_loaders.bilibili.BiliBiliLoader
    
    :template: class.rst
    
    document_loaders.blackboard.BlackboardLoader
    
    :template: class.rst
    
    document_loaders.blob_loaders.file_system.FileSystemBlobLoader
    
    :template: pydantic.rst
    
    document_loaders.blob_loaders.schema.Blob
    
    :template: class.rst
    
    document_loaders.blob_loaders.schema.BlobLoader
    
    :template: class.rst
    
    document_loaders.blob_loaders.youtube_audio.YoutubeAudioLoader
    
    :template: class.rst
    
    document_loaders.blockchain.BlockchainDocumentLoader
    
    :template: enum.rst
    
    document_loaders.blockchain.BlockchainType
    
    :template: class.rst
    
    document_loaders.brave_search.BraveSearchLoader
    
    :template: class.rst
    
    document_loaders.browserless.BrowserlessLoader
    
    :template: class.rst
    
    document_loaders.chatgpt.ChatGPTLoader
    
    :template: class.rst
    
    document_loaders.chromium.AsyncChromiumLoader
    
    :template: class.rst
    
    document_loaders.college_confidential.CollegeConfidentialLoader
    
    :template: class.rst
    
    document_loaders.concurrent.ConcurrentLoader
    
    :template: class.rst
    
    document_loaders.confluence.ConfluenceLoader
    
    :template: enum.rst
    
    document_loaders.confluence.ContentFormat
    
    :template: class.rst
    
    document_loaders.conllu.CoNLLULoader
    
    :template: class.rst
    
    document_loaders.couchbase.CouchbaseLoader
    
    :template: class.rst
    
    document_loaders.csv_loader.CSVLoader
    
    :template: class.rst
    
    document_loaders.csv_loader.UnstructuredCSVLoader
    
    :template: class.rst
    
    document_loaders.cube_semantic.CubeSemanticLoader
    
    :template: class.rst
    
    document_loaders.datadog_logs.DatadogLogsLoader
    
    :template: class.rst
    
    document_loaders.dataframe.BaseDataFrameLoader
    
    :template: class.rst
    
    document_loaders.dataframe.DataFrameLoader
    
    :template: class.rst
    
    document_loaders.diffbot.DiffbotLoader
    
    :template: class.rst
    
    document_loaders.directory.DirectoryLoader
    
    :template: class.rst
    
    document_loaders.discord.DiscordChatLoader
    
    :template: pydantic.rst
    
    document_loaders.docugami.DocugamiLoader
    
    :template: class.rst
    
    document_loaders.docusaurus.DocusaurusLoader
    
    :template: pydantic.rst
    
    document_loaders.dropbox.DropboxLoader
    
    :template: class.rst
    
    document_loaders.duckdb_loader.DuckDBLoader
    
    :template: class.rst
    
    document_loaders.email.OutlookMessageLoader
    
    :template: class.rst
    
    document_loaders.email.UnstructuredEmailLoader
    
    :template: class.rst
    
    document_loaders.epub.UnstructuredEPubLoader
    
    :template: class.rst
    
    document_loaders.etherscan.EtherscanLoader
    
    :template: class.rst
    
    document_loaders.evernote.EverNoteLoader
    
    :template: class.rst
    
    document_loaders.excel.UnstructuredExcelLoader
    
    :template: class.rst
    
    document_loaders.facebook_chat.FacebookChatLoader
    
    :template: class.rst
    
    document_loaders.fauna.FaunaLoader
    
    :template: class.rst
    
    document_loaders.figma.FigmaFileLoader
    
    :template: class.rst
    
    document_loaders.gcs_directory.GCSDirectoryLoader
    
    :template: class.rst
    
    document_loaders.gcs_file.GCSFileLoader
    
    :template: class.rst
    
    document_loaders.generic.GenericLoader
    
    :template: class.rst
    
    document_loaders.geodataframe.GeoDataFrameLoader
    
    :template: class.rst
    
    document_loaders.git.GitLoader
    
    :template: class.rst
    
    document_loaders.gitbook.GitbookLoader
    
    :template: pydantic.rst
    
    document_loaders.github.BaseGitHubLoader
    
    :template: pydantic.rst
    
    document_loaders.github.GitHubIssuesLoader
    
    :template: class.rst
    
    document_loaders.google_speech_to_text.GoogleSpeechToTextLoader
    
    :template: pydantic.rst
    
    document_loaders.googledrive.GoogleDriveLoader
    
    :template: class.rst
    
    document_loaders.gutenberg.GutenbergLoader
    
    :template: class.rst
    
    document_loaders.helpers.FileEncoding
    
    :template: class.rst
    
    document_loaders.hn.HNLoader
    
    :template: class.rst
    
    document_loaders.html.UnstructuredHTMLLoader
    
    :template: class.rst
    
    document_loaders.html_bs.BSHTMLLoader
    
    :template: class.rst
    
    document_loaders.hugging_face_dataset.HuggingFaceDatasetLoader
    
    :template: class.rst
    
    document_loaders.ifixit.IFixitLoader
    
    :template: class.rst
    
    document_loaders.image.UnstructuredImageLoader
    
    :template: class.rst
    
    document_loaders.image_captions.ImageCaptionLoader
    
    :template: class.rst
    
    document_loaders.imsdb.IMSDbLoader
    
    :template: class.rst
    
    document_loaders.iugu.IuguLoader
    
    :template: class.rst
    
    document_loaders.joplin.JoplinLoader
    
    :template: class.rst
    
    document_loaders.json_loader.JSONLoader
    
    :template: class.rst
    
    document_loaders.lakefs.LakeFSClient
    
    :template: class.rst
    
    document_loaders.lakefs.LakeFSLoader
    
    :template: class.rst
    
    document_loaders.lakefs.UnstructuredLakeFSLoader
    
    :template: class.rst
    
    document_loaders.larksuite.LarkSuiteDocLoader
    
    :template: class.rst
    
    document_loaders.markdown.UnstructuredMarkdownLoader
    
    :template: class.rst
    
    document_loaders.mastodon.MastodonTootsLoader
    
    :template: class.rst
    
    document_loaders.max_compute.MaxComputeLoader
    
    :template: class.rst
    
    document_loaders.mediawikidump.MWDumpLoader
    
    :template: class.rst
    
    document_loaders.merge.MergedDataLoader
    
    :template: class.rst
    
    document_loaders.mhtml.MHTMLLoader
    
    :template: class.rst
    
    document_loaders.modern_treasury.ModernTreasuryLoader
    
    :template: class.rst
    
    document_loaders.mongodb.MongodbLoader
    
    :template: class.rst
    
    document_loaders.news.NewsURLLoader
    
    :template: class.rst
    
    document_loaders.notebook.NotebookLoader
    
    :template: class.rst
    
    document_loaders.notion.NotionDirectoryLoader
    
    :template: class.rst
    
    document_loaders.notiondb.NotionDBLoader
    
    :template: class.rst
    
    document_loaders.nuclia.NucliaLoader
    
    :template: class.rst
    
    document_loaders.obs_directory.OBSDirectoryLoader
    
    :template: class.rst
    
    document_loaders.obs_file.OBSFileLoader
    
    :template: class.rst
    
    document_loaders.obsidian.ObsidianLoader
    
    :template: class.rst
    
    document_loaders.odt.UnstructuredODTLoader
    
    :template: pydantic.rst
    
    document_loaders.onedrive.OneDriveLoader
    
    :template: pydantic.rst
    
    document_loaders.onedrive_file.OneDriveFileLoader
    
    :template: pydantic.rst
    
    document_loaders.onenote.OneNoteLoader
    
    :template: class.rst
    
    document_loaders.open_city_data.OpenCityDataLoader
    
    :template: class.rst
    
    document_loaders.org_mode.UnstructuredOrgModeLoader
    
    :template: class.rst
    
    document_loaders.parsers.audio.OpenAIWhisperParser
    
    :template: class.rst
    
    document_loaders.parsers.audio.OpenAIWhisperParserLocal
    
    :template: class.rst
    
    document_loaders.parsers.audio.YandexSTTParser
    
    :template: class.rst
    
    document_loaders.parsers.docai.DocAIParser
    
    :template: class.rst
    
    document_loaders.parsers.docai.DocAIParsingResults
    
    :template: class.rst
    
    document_loaders.parsers.generic.MimeTypeBasedParser
    
    :template: class.rst
    
    document_loaders.parsers.grobid.GrobidParser
    
    :template: class.rst
    
    document_loaders.parsers.grobid.ServerUnavailableException
    
    :template: class.rst
    
    document_loaders.parsers.html.bs4.BS4HTMLParser
    
    :template: class.rst
    
    document_loaders.parsers.language.cobol.CobolSegmenter
    
    :template: class.rst
    
    document_loaders.parsers.language.code_segmenter.CodeSegmenter
    
    :template: class.rst
    
    document_loaders.parsers.language.javascript.JavaScriptSegmenter
    
    :template: class.rst
    
    document_loaders.parsers.language.language_parser.LanguageParser
    
    :template: class.rst
    
    document_loaders.parsers.language.python.PythonSegmenter
    
    :template: class.rst
    
    document_loaders.parsers.msword.MsWordParser
    
    :template: class.rst
    
    document_loaders.parsers.pdf.AmazonTextractPDFParser
    
    :template: class.rst
    
    document_loaders.parsers.pdf.DocumentIntelligenceParser
    
    :template: class.rst
    
    document_loaders.parsers.pdf.PDFMinerParser
    
    :template: class.rst
    
    document_loaders.parsers.pdf.PDFPlumberParser
    
    :template: class.rst
    
    document_loaders.parsers.pdf.PyMuPDFParser
    
    :template: class.rst
    
    document_loaders.parsers.pdf.PyPDFParser
    
    :template: class.rst
    
    document_loaders.parsers.pdf.PyPDFium2Parser
    
    :template: class.rst
    
    document_loaders.parsers.txt.TextParser
    
    :template: class.rst
    
    document_loaders.pdf.AmazonTextractPDFLoader
    
    :template: class.rst
    
    document_loaders.pdf.BasePDFLoader
    
    :template: class.rst
    
    document_loaders.pdf.DocumentIntelligenceLoader
    
    :template: class.rst
    
    document_loaders.pdf.MathpixPDFLoader
    
    :template: class.rst
    
    document_loaders.pdf.OnlinePDFLoader
    
    :template: class.rst
    
    document_loaders.pdf.PDFMinerLoader
    
    :template: class.rst
    
    document_loaders.pdf.PDFMinerPDFasHTMLLoader
    
    :template: class.rst
    
    document_loaders.pdf.PDFPlumberLoader
    
    :template: class.rst
    
    document_loaders.pdf.PyMuPDFLoader
    
    :template: class.rst
    
    document_loaders.pdf.PyPDFDirectoryLoader
    
    :template: class.rst
    
    document_loaders.pdf.PyPDFLoader
    
    :template: class.rst
    
    document_loaders.pdf.PyPDFium2Loader
    
    :template: class.rst
    
    document_loaders.pdf.UnstructuredPDFLoader
    
    :template: class.rst
    
    document_loaders.polars_dataframe.PolarsDataFrameLoader
    
    :template: class.rst
    
    document_loaders.powerpoint.UnstructuredPowerPointLoader
    
    :template: class.rst
    
    document_loaders.psychic.PsychicLoader
    
    :template: class.rst
    
    document_loaders.pubmed.PubMedLoader
    
    :template: class.rst
    
    document_loaders.pyspark_dataframe.PySparkDataFrameLoader
    
    :template: class.rst
    
    document_loaders.python.PythonLoader
    
    :template: class.rst
    
    document_loaders.quip.QuipLoader
    
    :template: class.rst
    
    document_loaders.readthedocs.ReadTheDocsLoader
    
    :template: class.rst
    
    document_loaders.recursive_url_loader.RecursiveUrlLoader
    
    :template: class.rst
    
    document_loaders.reddit.RedditPostsLoader
    
    :template: class.rst
    
    document_loaders.roam.RoamLoader
    
    :template: class.rst
    
    document_loaders.rocksetdb.ColumnNotFoundError
    
    :template: class.rst
    
    document_loaders.rocksetdb.RocksetLoader
    
    :template: class.rst
    
    document_loaders.rspace.RSpaceLoader
    
    :template: class.rst
    
    document_loaders.rss.RSSFeedLoader
    
    :template: class.rst
    
    document_loaders.rst.UnstructuredRSTLoader
    
    :template: class.rst
    
    document_loaders.rtf.UnstructuredRTFLoader
    
    :template: class.rst
    
    document_loaders.s3_directory.S3DirectoryLoader
    
    :template: class.rst
    
    document_loaders.s3_file.S3FileLoader
    
    :template: pydantic.rst
    
    document_loaders.sharepoint.SharePointLoader
    
    :template: class.rst
    
    document_loaders.sitemap.SitemapLoader
    
    :template: class.rst
    
    document_loaders.slack_directory.SlackDirectoryLoader
    
    :template: class.rst
    
    document_loaders.snowflake_loader.SnowflakeLoader
    
    :template: class.rst
    
    document_loaders.spreedly.SpreedlyLoader
    
    :template: class.rst
    
    document_loaders.srt.SRTLoader
    
    :template: class.rst
    
    document_loaders.stripe.StripeLoader
    
    :template: class.rst
    
    document_loaders.telegram.TelegramChatApiLoader
    
    :template: class.rst
    
    document_loaders.telegram.TelegramChatFileLoader
    
    :template: class.rst
    
    document_loaders.tencent_cos_directory.TencentCOSDirectoryLoader
    
    :template: class.rst
    
    document_loaders.tencent_cos_file.TencentCOSFileLoader
    
    :template: class.rst
    
    document_loaders.tensorflow_datasets.TensorflowDatasetLoader
    
    :template: class.rst
    
    document_loaders.text.TextLoader
    
    :template: class.rst
    
    document_loaders.tomarkdown.ToMarkdownLoader
    
    :template: class.rst
    
    document_loaders.toml.TomlLoader
    
    :template: class.rst
    
    document_loaders.trello.TrelloLoader
    
    :template: class.rst
    
    document_loaders.tsv.UnstructuredTSVLoader
    
    :template: class.rst
    
    document_loaders.twitter.TwitterTweetLoader
    
    :template: class.rst
    
    document_loaders.unstructured.UnstructuredAPIFileIOLoader
    
    :template: class.rst
    
    document_loaders.unstructured.UnstructuredAPIFileLoader
    
    :template: class.rst
    
    document_loaders.unstructured.UnstructuredBaseLoader
    
    :template: class.rst
    
    document_loaders.unstructured.UnstructuredFileIOLoader
    
    :template: class.rst
    
    document_loaders.unstructured.UnstructuredFileLoader
    
    :template: class.rst
    
    document_loaders.url.UnstructuredURLLoader
    
    :template: class.rst
    
    document_loaders.url_playwright.PlaywrightEvaluator
    
    :template: class.rst
    
    document_loaders.url_playwright.PlaywrightURLLoader
    
    :template: class.rst
    
    document_loaders.url_playwright.UnstructuredHtmlEvaluator
    
    :template: class.rst
    
    document_loaders.url_selenium.SeleniumURLLoader
    
    :template: class.rst
    
    document_loaders.weather.WeatherDataLoader
    
    :template: class.rst
    
    document_loaders.web_base.WebBaseLoader
    
    :template: class.rst
    
    document_loaders.whatsapp_chat.WhatsAppChatLoader
    
    :template: class.rst
    
    document_loaders.wikipedia.WikipediaLoader
    
    :template: class.rst
    
    document_loaders.word_document.Docx2txtLoader
    
    :template: class.rst
    
    document_loaders.word_document.UnstructuredWordDocumentLoader
    
    :template: class.rst
    
    document_loaders.xml.UnstructuredXMLLoader
    
    :template: class.rst
    
    document_loaders.xorbits.XorbitsLoader
    
    :template: class.rst
    
    document_loaders.youtube.GoogleApiClient
    
    :template: class.rst
    
    document_loaders.youtube.GoogleApiYoutubeLoader
    
    :template: class.rst
    
    document_loaders.youtube.YoutubeLoader
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: document_loaders
    :template: function.rst

    document_loaders.base_o365.fetch_mime_types
    document_loaders.chatgpt.concatenate_rows
    document_loaders.facebook_chat.concatenate_rows
    document_loaders.helpers.detect_file_encodings
    document_loaders.notebook.concatenate_cells
    document_loaders.notebook.remove_newlines
    document_loaders.parsers.pdf.extract_from_images_with_rapidocr
    document_loaders.parsers.registry.get_parser
    document_loaders.rocksetdb.default_joiner
    document_loaders.telegram.concatenate_rows
    document_loaders.telegram.text_to_docs
    document_loaders.unstructured.get_elements_from_api
    document_loaders.unstructured.satisfies_min_unstructured_version
    document_loaders.unstructured.validate_unstructured_version
    document_loaders.whatsapp_chat.concatenate_rows

:mod:`langchain_community.document_transformers`
=================================================

.. automodule:: langchain_community.document_transformers
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: document_transformers
    :template: class.rst
    
    document_transformers.beautiful_soup_transformer.BeautifulSoupTransformer
    
    :template: class.rst
    
    document_transformers.doctran_text_extract.DoctranPropertyExtractor
    
    :template: class.rst
    
    document_transformers.doctran_text_qa.DoctranQATransformer
    
    :template: class.rst
    
    document_transformers.doctran_text_translate.DoctranTextTranslator
    
    :template: pydantic.rst
    
    document_transformers.embeddings_redundant_filter.EmbeddingsClusteringFilter
    
    :template: pydantic.rst
    
    document_transformers.embeddings_redundant_filter.EmbeddingsRedundantFilter
    
    :template: class.rst
    
    document_transformers.google_translate.GoogleTranslateTransformer
    
    :template: class.rst
    
    document_transformers.html2text.Html2TextTransformer
    
    :template: pydantic.rst
    
    document_transformers.long_context_reorder.LongContextReorder
    
    :template: class.rst
    
    document_transformers.nuclia_text_transform.NucliaTextTransformer
    
    :template: pydantic.rst
    
    document_transformers.openai_functions.OpenAIMetadataTagger
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: document_transformers
    :template: function.rst

    document_transformers.beautiful_soup_transformer.get_navigable_strings
    document_transformers.embeddings_redundant_filter.get_stateful_documents
    document_transformers.openai_functions.create_metadata_tagger

:mod:`langchain_community.embeddings`
======================================

.. automodule:: langchain_community.embeddings
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: embeddings
    :template: pydantic.rst
    
    embeddings.aleph_alpha.AlephAlphaAsymmetricSemanticEmbedding
    
    :template: pydantic.rst
    
    embeddings.aleph_alpha.AlephAlphaSymmetricSemanticEmbedding
    
    :template: pydantic.rst
    
    embeddings.awa.AwaEmbeddings
    
    :template: pydantic.rst
    
    embeddings.azure_openai.AzureOpenAIEmbeddings
    
    :template: pydantic.rst
    
    embeddings.baidu_qianfan_endpoint.QianfanEmbeddingsEndpoint
    
    :template: pydantic.rst
    
    embeddings.bedrock.BedrockEmbeddings
    
    :template: pydantic.rst
    
    embeddings.bookend.BookendEmbeddings
    
    :template: pydantic.rst
    
    embeddings.clarifai.ClarifaiEmbeddings
    
    :template: pydantic.rst
    
    embeddings.cloudflare_workersai.CloudflareWorkersAIEmbeddings
    
    :template: pydantic.rst
    
    embeddings.cohere.CohereEmbeddings
    
    :template: pydantic.rst
    
    embeddings.dashscope.DashScopeEmbeddings
    
    :template: pydantic.rst
    
    embeddings.databricks.DatabricksEmbeddings
    
    :template: pydantic.rst
    
    embeddings.deepinfra.DeepInfraEmbeddings
    
    :template: pydantic.rst
    
    embeddings.edenai.EdenAiEmbeddings
    
    :template: class.rst
    
    embeddings.elasticsearch.ElasticsearchEmbeddings
    
    :template: pydantic.rst
    
    embeddings.embaas.EmbaasEmbeddings
    
    :template: class.rst
    
    embeddings.embaas.EmbaasEmbeddingsPayload
    
    :template: pydantic.rst
    
    embeddings.ernie.ErnieEmbeddings
    
    :template: pydantic.rst
    
    embeddings.fake.DeterministicFakeEmbedding
    
    :template: pydantic.rst
    
    embeddings.fake.FakeEmbeddings
    
    :template: pydantic.rst
    
    embeddings.fastembed.FastEmbedEmbeddings
    
    :template: pydantic.rst
    
    embeddings.google_palm.GooglePalmEmbeddings
    
    :template: pydantic.rst
    
    embeddings.gpt4all.GPT4AllEmbeddings
    
    :template: pydantic.rst
    
    embeddings.gradient_ai.GradientEmbeddings
    
    :template: class.rst
    
    embeddings.gradient_ai.TinyAsyncGradientEmbeddingClient
    
    :template: pydantic.rst
    
    embeddings.huggingface.HuggingFaceBgeEmbeddings
    
    :template: pydantic.rst
    
    embeddings.huggingface.HuggingFaceEmbeddings
    
    :template: pydantic.rst
    
    embeddings.huggingface.HuggingFaceInferenceAPIEmbeddings
    
    :template: pydantic.rst
    
    embeddings.huggingface.HuggingFaceInstructEmbeddings
    
    :template: pydantic.rst
    
    embeddings.huggingface_hub.HuggingFaceHubEmbeddings
    
    :template: pydantic.rst
    
    embeddings.infinity.InfinityEmbeddings
    
    :template: class.rst
    
    embeddings.infinity.TinyAsyncOpenAIInfinityEmbeddingClient
    
    :template: pydantic.rst
    
    embeddings.javelin_ai_gateway.JavelinAIGatewayEmbeddings
    
    :template: pydantic.rst
    
    embeddings.jina.JinaEmbeddings
    
    :template: pydantic.rst
    
    embeddings.johnsnowlabs.JohnSnowLabsEmbeddings
    
    :template: pydantic.rst
    
    embeddings.llamacpp.LlamaCppEmbeddings
    
    :template: pydantic.rst
    
    embeddings.llm_rails.LLMRailsEmbeddings
    
    :template: pydantic.rst
    
    embeddings.localai.LocalAIEmbeddings
    
    :template: pydantic.rst
    
    embeddings.minimax.MiniMaxEmbeddings
    
    :template: pydantic.rst
    
    embeddings.mlflow.MlflowEmbeddings
    
    :template: pydantic.rst
    
    embeddings.mlflow_gateway.MlflowAIGatewayEmbeddings
    
    :template: pydantic.rst
    
    embeddings.modelscope_hub.ModelScopeEmbeddings
    
    :template: pydantic.rst
    
    embeddings.mosaicml.MosaicMLInstructorEmbeddings
    
    :template: pydantic.rst
    
    embeddings.nlpcloud.NLPCloudEmbeddings
    
    :template: pydantic.rst
    
    embeddings.octoai_embeddings.OctoAIEmbeddings
    
    :template: pydantic.rst
    
    embeddings.ollama.OllamaEmbeddings
    
    :template: pydantic.rst
    
    embeddings.openai.OpenAIEmbeddings
    
    :template: class.rst
    
    embeddings.sagemaker_endpoint.EmbeddingsContentHandler
    
    :template: pydantic.rst
    
    embeddings.sagemaker_endpoint.SagemakerEndpointEmbeddings
    
    :template: pydantic.rst
    
    embeddings.self_hosted.SelfHostedEmbeddings
    
    :template: pydantic.rst
    
    embeddings.self_hosted_hugging_face.SelfHostedHuggingFaceEmbeddings
    
    :template: pydantic.rst
    
    embeddings.self_hosted_hugging_face.SelfHostedHuggingFaceInstructEmbeddings
    
    :template: pydantic.rst
    
    embeddings.spacy_embeddings.SpacyEmbeddings
    
    :template: pydantic.rst
    
    embeddings.tensorflow_hub.TensorflowHubEmbeddings
    
    :template: pydantic.rst
    
    embeddings.vertexai.VertexAIEmbeddings
    
    :template: pydantic.rst
    
    embeddings.voyageai.VoyageEmbeddings
    
    :template: class.rst
    
    embeddings.xinference.XinferenceEmbeddings
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: embeddings
    :template: function.rst

    embeddings.dashscope.embed_with_retry
    embeddings.google_palm.embed_with_retry
    embeddings.localai.async_embed_with_retry
    embeddings.localai.embed_with_retry
    embeddings.minimax.embed_with_retry
    embeddings.openai.async_embed_with_retry
    embeddings.openai.embed_with_retry
    embeddings.self_hosted_hugging_face.load_embedding_model
    embeddings.voyageai.embed_with_retry

:mod:`langchain_community.graphs`
==================================

.. automodule:: langchain_community.graphs
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: graphs
    :template: class.rst
    
    graphs.arangodb_graph.ArangoGraph
    
    :template: class.rst
    
    graphs.falkordb_graph.FalkorDBGraph
    
    :template: pydantic.rst
    
    graphs.graph_document.GraphDocument
    
    :template: pydantic.rst
    
    graphs.graph_document.Node
    
    :template: pydantic.rst
    
    graphs.graph_document.Relationship
    
    :template: class.rst
    
    graphs.graph_store.GraphStore
    
    :template: class.rst
    
    graphs.hugegraph.HugeGraph
    
    :template: class.rst
    
    graphs.kuzu_graph.KuzuGraph
    
    :template: class.rst
    
    graphs.memgraph_graph.MemgraphGraph
    
    :template: class.rst
    
    graphs.nebula_graph.NebulaGraph
    
    :template: class.rst
    
    graphs.neo4j_graph.Neo4jGraph
    
    :template: class.rst
    
    graphs.neptune_graph.NeptuneGraph
    
    :template: class.rst
    
    graphs.neptune_graph.NeptuneQueryException
    
    :template: class.rst
    
    graphs.networkx_graph.KnowledgeTriple
    
    :template: class.rst
    
    graphs.networkx_graph.NetworkxEntityGraph
    
    :template: class.rst
    
    graphs.rdf_graph.RdfGraph
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: graphs
    :template: function.rst

    graphs.arangodb_graph.get_arangodb_client
    graphs.networkx_graph.get_entities
    graphs.networkx_graph.parse_triples

:mod:`langchain_community.indexes`
===================================

.. automodule:: langchain_community.indexes
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: indexes
    :template: class.rst
    
    indexes.base.RecordManager
    
:mod:`langchain_community.llms`
================================

.. automodule:: langchain_community.llms
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: llms
    :template: pydantic.rst
    
    llms.ai21.AI21
    
    :template: pydantic.rst
    
    llms.ai21.AI21PenaltyData
    
    :template: pydantic.rst
    
    llms.aleph_alpha.AlephAlpha
    
    :template: pydantic.rst
    
    llms.amazon_api_gateway.AmazonAPIGateway
    
    :template: class.rst
    
    llms.amazon_api_gateway.ContentHandlerAmazonAPIGateway
    
    :template: pydantic.rst
    
    llms.anthropic.Anthropic
    
    :template: pydantic.rst
    
    llms.anyscale.Anyscale
    
    :template: pydantic.rst
    
    llms.arcee.Arcee
    
    :template: pydantic.rst
    
    llms.aviary.Aviary
    
    :template: class.rst
    
    llms.aviary.AviaryBackend
    
    :template: class.rst
    
    llms.azureml_endpoint.AzureMLEndpointClient
    
    :template: pydantic.rst
    
    llms.azureml_endpoint.AzureMLOnlineEndpoint
    
    :template: class.rst
    
    llms.azureml_endpoint.ContentFormatterBase
    
    :template: class.rst
    
    llms.azureml_endpoint.DollyContentFormatter
    
    :template: class.rst
    
    llms.azureml_endpoint.GPT2ContentFormatter
    
    :template: class.rst
    
    llms.azureml_endpoint.HFContentFormatter
    
    :template: class.rst
    
    llms.azureml_endpoint.LlamaContentFormatter
    
    :template: class.rst
    
    llms.azureml_endpoint.OSSContentFormatter
    
    :template: pydantic.rst
    
    llms.baidu_qianfan_endpoint.QianfanLLMEndpoint
    
    :template: pydantic.rst
    
    llms.bananadev.Banana
    
    :template: pydantic.rst
    
    llms.baseten.Baseten
    
    :template: pydantic.rst
    
    llms.beam.Beam
    
    :template: pydantic.rst
    
    llms.bedrock.Bedrock
    
    :template: pydantic.rst
    
    llms.bedrock.BedrockBase
    
    :template: class.rst
    
    llms.bedrock.LLMInputOutputAdapter
    
    :template: pydantic.rst
    
    llms.bittensor.NIBittensorLLM
    
    :template: pydantic.rst
    
    llms.cerebriumai.CerebriumAI
    
    :template: pydantic.rst
    
    llms.chatglm.ChatGLM
    
    :template: pydantic.rst
    
    llms.clarifai.Clarifai
    
    :template: pydantic.rst
    
    llms.cloudflare_workersai.CloudflareWorkersAI
    
    :template: pydantic.rst
    
    llms.cohere.BaseCohere
    
    :template: pydantic.rst
    
    llms.cohere.Cohere
    
    :template: pydantic.rst
    
    llms.ctransformers.CTransformers
    
    :template: pydantic.rst
    
    llms.ctranslate2.CTranslate2
    
    :template: pydantic.rst
    
    llms.databricks.Databricks
    
    :template: pydantic.rst
    
    llms.deepinfra.DeepInfra
    
    :template: pydantic.rst
    
    llms.deepsparse.DeepSparse
    
    :template: pydantic.rst
    
    llms.edenai.EdenAI
    
    :template: pydantic.rst
    
    llms.fake.FakeListLLM
    
    :template: pydantic.rst
    
    llms.fake.FakeStreamingListLLM
    
    :template: pydantic.rst
    
    llms.fireworks.Fireworks
    
    :template: pydantic.rst
    
    llms.forefrontai.ForefrontAI
    
    :template: pydantic.rst
    
    llms.gigachat.GigaChat
    
    :template: pydantic.rst
    
    llms.google_palm.GooglePalm
    
    :template: pydantic.rst
    
    llms.gooseai.GooseAI
    
    :template: pydantic.rst
    
    llms.gpt4all.GPT4All
    
    :template: pydantic.rst
    
    llms.gradient_ai.GradientLLM
    
    :template: typeddict.rst
    
    llms.gradient_ai.TrainResult
    
    :template: pydantic.rst
    
    llms.huggingface_endpoint.HuggingFaceEndpoint
    
    :template: pydantic.rst
    
    llms.huggingface_hub.HuggingFaceHub
    
    :template: pydantic.rst
    
    llms.huggingface_pipeline.HuggingFacePipeline
    
    :template: pydantic.rst
    
    llms.huggingface_text_gen_inference.HuggingFaceTextGenInference
    
    :template: pydantic.rst
    
    llms.human.HumanInputLLM
    
    :template: pydantic.rst
    
    llms.javelin_ai_gateway.JavelinAIGateway
    
    :template: pydantic.rst
    
    llms.javelin_ai_gateway.Params
    
    :template: pydantic.rst
    
    llms.koboldai.KoboldApiLLM
    
    :template: pydantic.rst
    
    llms.llamacpp.LlamaCpp
    
    :template: pydantic.rst
    
    llms.manifest.ManifestWrapper
    
    :template: pydantic.rst
    
    llms.minimax.Minimax
    
    :template: pydantic.rst
    
    llms.minimax.MinimaxCommon
    
    :template: pydantic.rst
    
    llms.mlflow.Mlflow
    
    :template: pydantic.rst
    
    llms.mlflow.Params
    
    :template: pydantic.rst
    
    llms.mlflow_ai_gateway.MlflowAIGateway
    
    :template: pydantic.rst
    
    llms.mlflow_ai_gateway.Params
    
    :template: pydantic.rst
    
    llms.modal.Modal
    
    :template: pydantic.rst
    
    llms.mosaicml.MosaicML
    
    :template: pydantic.rst
    
    llms.nlpcloud.NLPCloud
    
    :template: pydantic.rst
    
    llms.octoai_endpoint.OctoAIEndpoint
    
    :template: pydantic.rst
    
    llms.ollama.Ollama
    
    :template: pydantic.rst
    
    llms.opaqueprompts.OpaquePrompts
    
    :template: pydantic.rst
    
    llms.openai.AzureOpenAI
    
    :template: pydantic.rst
    
    llms.openai.BaseOpenAI
    
    :template: pydantic.rst
    
    llms.openai.OpenAI
    
    :template: pydantic.rst
    
    llms.openai.OpenAIChat
    
    :template: typeddict.rst
    
    llms.openllm.IdentifyingParams
    
    :template: pydantic.rst
    
    llms.openllm.OpenLLM
    
    :template: pydantic.rst
    
    llms.openlm.OpenLM
    
    :template: pydantic.rst
    
    llms.pai_eas_endpoint.PaiEasEndpoint
    
    :template: pydantic.rst
    
    llms.petals.Petals
    
    :template: pydantic.rst
    
    llms.pipelineai.PipelineAI
    
    :template: pydantic.rst
    
    llms.predibase.Predibase
    
    :template: pydantic.rst
    
    llms.predictionguard.PredictionGuard
    
    :template: pydantic.rst
    
    llms.promptlayer_openai.PromptLayerOpenAI
    
    :template: pydantic.rst
    
    llms.promptlayer_openai.PromptLayerOpenAIChat
    
    :template: pydantic.rst
    
    llms.replicate.Replicate
    
    :template: pydantic.rst
    
    llms.rwkv.RWKV
    
    :template: class.rst
    
    llms.sagemaker_endpoint.ContentHandlerBase
    
    :template: class.rst
    
    llms.sagemaker_endpoint.LLMContentHandler
    
    :template: class.rst
    
    llms.sagemaker_endpoint.LineIterator
    
    :template: pydantic.rst
    
    llms.sagemaker_endpoint.SagemakerEndpoint
    
    :template: pydantic.rst
    
    llms.self_hosted.SelfHostedPipeline
    
    :template: pydantic.rst
    
    llms.self_hosted_hugging_face.SelfHostedHuggingFaceLLM
    
    :template: pydantic.rst
    
    llms.stochasticai.StochasticAI
    
    :template: pydantic.rst
    
    llms.symblai_nebula.Nebula
    
    :template: pydantic.rst
    
    llms.textgen.TextGen
    
    :template: pydantic.rst
    
    llms.titan_takeoff.TitanTakeoff
    
    :template: pydantic.rst
    
    llms.titan_takeoff_pro.TitanTakeoffPro
    
    :template: pydantic.rst
    
    llms.together.Together
    
    :template: pydantic.rst
    
    llms.tongyi.Tongyi
    
    :template: pydantic.rst
    
    llms.vertexai.VertexAI
    
    :template: pydantic.rst
    
    llms.vertexai.VertexAIModelGarden
    
    :template: pydantic.rst
    
    llms.vllm.VLLM
    
    :template: pydantic.rst
    
    llms.vllm.VLLMOpenAI
    
    :template: pydantic.rst
    
    llms.volcengine_maas.VolcEngineMaasBase
    
    :template: pydantic.rst
    
    llms.volcengine_maas.VolcEngineMaasLLM
    
    :template: pydantic.rst
    
    llms.watsonxllm.WatsonxLLM
    
    :template: pydantic.rst
    
    llms.writer.Writer
    
    :template: pydantic.rst
    
    llms.xinference.Xinference
    
    :template: pydantic.rst
    
    llms.yandex.YandexGPT
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: llms
    :template: function.rst

    llms.anyscale.create_llm_result
    llms.anyscale.update_token_usage
    llms.aviary.get_completions
    llms.aviary.get_models
    llms.cohere.acompletion_with_retry
    llms.cohere.completion_with_retry
    llms.databricks.get_default_api_token
    llms.databricks.get_default_host
    llms.databricks.get_repl_context
    llms.fireworks.acompletion_with_retry
    llms.fireworks.acompletion_with_retry_batching
    llms.fireworks.acompletion_with_retry_streaming
    llms.fireworks.completion_with_retry
    llms.fireworks.completion_with_retry_batching
    llms.fireworks.conditional_decorator
    llms.google_palm.completion_with_retry
    llms.koboldai.clean_url
    llms.loading.load_llm
    llms.loading.load_llm_from_config
    llms.openai.acompletion_with_retry
    llms.openai.completion_with_retry
    llms.openai.update_token_usage
    llms.symblai_nebula.completion_with_retry
    llms.symblai_nebula.make_request
    llms.tongyi.generate_with_retry
    llms.tongyi.stream_generate_with_retry
    llms.utils.enforce_stop_tokens
    llms.vertexai.acompletion_with_retry
    llms.vertexai.completion_with_retry
    llms.vertexai.is_codey_model
    llms.vertexai.stream_completion_with_retry

:mod:`langchain_community.retrievers`
======================================

.. automodule:: langchain_community.retrievers
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: retrievers
    :template: pydantic.rst
    
    retrievers.arcee.ArceeRetriever
    
    :template: pydantic.rst
    
    retrievers.arxiv.ArxivRetriever
    
    :template: pydantic.rst
    
    retrievers.azure_cognitive_search.AzureCognitiveSearchRetriever
    
    :template: pydantic.rst
    
    retrievers.bedrock.AmazonKnowledgeBasesRetriever
    
    :template: pydantic.rst
    
    retrievers.bedrock.RetrievalConfig
    
    :template: pydantic.rst
    
    retrievers.bedrock.VectorSearchConfig
    
    :template: pydantic.rst
    
    retrievers.bm25.BM25Retriever
    
    :template: pydantic.rst
    
    retrievers.chaindesk.ChaindeskRetriever
    
    :template: pydantic.rst
    
    retrievers.chatgpt_plugin_retriever.ChatGPTPluginRetriever
    
    :template: pydantic.rst
    
    retrievers.cohere_rag_retriever.CohereRagRetriever
    
    :template: pydantic.rst
    
    retrievers.databerry.DataberryRetriever
    
    :template: pydantic.rst
    
    retrievers.docarray.DocArrayRetriever
    
    :template: enum.rst
    
    retrievers.docarray.SearchType
    
    :template: pydantic.rst
    
    retrievers.elastic_search_bm25.ElasticSearchBM25Retriever
    
    :template: pydantic.rst
    
    retrievers.embedchain.EmbedchainRetriever
    
    :template: pydantic.rst
    
    retrievers.google_cloud_documentai_warehouse.GoogleDocumentAIWarehouseRetriever
    
    :template: pydantic.rst
    
    retrievers.google_vertex_ai_search.GoogleCloudEnterpriseSearchRetriever
    
    :template: pydantic.rst
    
    retrievers.google_vertex_ai_search.GoogleVertexAIMultiTurnSearchRetriever
    
    :template: pydantic.rst
    
    retrievers.google_vertex_ai_search.GoogleVertexAISearchRetriever
    
    :template: pydantic.rst
    
    retrievers.kay.KayAiRetriever
    
    :template: pydantic.rst
    
    retrievers.kendra.AdditionalResultAttribute
    
    :template: pydantic.rst
    
    retrievers.kendra.AdditionalResultAttributeValue
    
    :template: pydantic.rst
    
    retrievers.kendra.AmazonKendraRetriever
    
    :template: pydantic.rst
    
    retrievers.kendra.DocumentAttribute
    
    :template: pydantic.rst
    
    retrievers.kendra.DocumentAttributeValue
    
    :template: pydantic.rst
    
    retrievers.kendra.Highlight
    
    :template: pydantic.rst
    
    retrievers.kendra.QueryResult
    
    :template: pydantic.rst
    
    retrievers.kendra.QueryResultItem
    
    :template: pydantic.rst
    
    retrievers.kendra.ResultItem
    
    :template: pydantic.rst
    
    retrievers.kendra.RetrieveResult
    
    :template: pydantic.rst
    
    retrievers.kendra.RetrieveResultItem
    
    :template: pydantic.rst
    
    retrievers.kendra.TextWithHighLights
    
    :template: pydantic.rst
    
    retrievers.knn.KNNRetriever
    
    :template: pydantic.rst
    
    retrievers.llama_index.LlamaIndexGraphRetriever
    
    :template: pydantic.rst
    
    retrievers.llama_index.LlamaIndexRetriever
    
    :template: pydantic.rst
    
    retrievers.metal.MetalRetriever
    
    :template: pydantic.rst
    
    retrievers.milvus.MilvusRetriever
    
    :template: pydantic.rst
    
    retrievers.outline.OutlineRetriever
    
    :template: pydantic.rst
    
    retrievers.pinecone_hybrid_search.PineconeHybridSearchRetriever
    
    :template: pydantic.rst
    
    retrievers.pubmed.PubMedRetriever
    
    :template: pydantic.rst
    
    retrievers.remote_retriever.RemoteLangChainRetriever
    
    :template: pydantic.rst
    
    retrievers.svm.SVMRetriever
    
    :template: enum.rst
    
    retrievers.tavily_search_api.SearchDepth
    
    :template: pydantic.rst
    
    retrievers.tavily_search_api.TavilySearchAPIRetriever
    
    :template: pydantic.rst
    
    retrievers.tfidf.TFIDFRetriever
    
    :template: pydantic.rst
    
    retrievers.vespa_retriever.VespaRetriever
    
    :template: pydantic.rst
    
    retrievers.weaviate_hybrid_search.WeaviateHybridSearchRetriever
    
    :template: pydantic.rst
    
    retrievers.wikipedia.WikipediaRetriever
    
    :template: pydantic.rst
    
    retrievers.you.YouRetriever
    
    :template: enum.rst
    
    retrievers.zep.SearchScope
    
    :template: enum.rst
    
    retrievers.zep.SearchType
    
    :template: pydantic.rst
    
    retrievers.zep.ZepRetriever
    
    :template: pydantic.rst
    
    retrievers.zilliz.ZillizRetriever
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: retrievers
    :template: function.rst

    retrievers.bm25.default_preprocessing_func
    retrievers.kendra.clean_excerpt
    retrievers.kendra.combined_text
    retrievers.knn.create_index
    retrievers.milvus.MilvusRetreiver
    retrievers.pinecone_hybrid_search.create_index
    retrievers.pinecone_hybrid_search.hash_text
    retrievers.svm.create_index
    retrievers.zilliz.ZillizRetreiver

:mod:`langchain_community.storage`
===================================

.. automodule:: langchain_community.storage
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: storage
    :template: class.rst
    
    storage.exceptions.InvalidKeyException
    
    :template: class.rst
    
    storage.redis.RedisStore
    
    :template: class.rst
    
    storage.upstash_redis.UpstashRedisByteStore
    
    :template: class.rst
    
    storage.upstash_redis.UpstashRedisStore
    
:mod:`langchain_community.tools`
=================================

.. automodule:: langchain_community.tools
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: tools
    :template: pydantic.rst
    
    tools.ainetwork.app.AINAppOps
    
    :template: enum.rst
    
    tools.ainetwork.app.AppOperationType
    
    :template: pydantic.rst
    
    tools.ainetwork.app.AppSchema
    
    :template: pydantic.rst
    
    tools.ainetwork.base.AINBaseTool
    
    :template: enum.rst
    
    tools.ainetwork.base.OperationType
    
    :template: pydantic.rst
    
    tools.ainetwork.owner.AINOwnerOps
    
    :template: pydantic.rst
    
    tools.ainetwork.owner.RuleSchema
    
    :template: pydantic.rst
    
    tools.ainetwork.rule.AINRuleOps
    
    :template: pydantic.rst
    
    tools.ainetwork.rule.RuleSchema
    
    :template: pydantic.rst
    
    tools.ainetwork.transfer.AINTransfer
    
    :template: pydantic.rst
    
    tools.ainetwork.transfer.TransferSchema
    
    :template: pydantic.rst
    
    tools.ainetwork.value.AINValueOps
    
    :template: pydantic.rst
    
    tools.ainetwork.value.ValueSchema
    
    :template: pydantic.rst
    
    tools.amadeus.base.AmadeusBaseTool
    
    :template: pydantic.rst
    
    tools.amadeus.closest_airport.AmadeusClosestAirport
    
    :template: pydantic.rst
    
    tools.amadeus.closest_airport.ClosestAirportSchema
    
    :template: pydantic.rst
    
    tools.amadeus.flight_search.AmadeusFlightSearch
    
    :template: pydantic.rst
    
    tools.amadeus.flight_search.FlightSearchSchema
    
    :template: pydantic.rst
    
    tools.arxiv.tool.ArxivInput
    
    :template: pydantic.rst
    
    tools.arxiv.tool.ArxivQueryRun
    
    :template: pydantic.rst
    
    tools.azure_cognitive_services.form_recognizer.AzureCogsFormRecognizerTool
    
    :template: pydantic.rst
    
    tools.azure_cognitive_services.image_analysis.AzureCogsImageAnalysisTool
    
    :template: pydantic.rst
    
    tools.azure_cognitive_services.speech2text.AzureCogsSpeech2TextTool
    
    :template: pydantic.rst
    
    tools.azure_cognitive_services.text2speech.AzureCogsText2SpeechTool
    
    :template: pydantic.rst
    
    tools.azure_cognitive_services.text_analytics_health.AzureCogsTextAnalyticsHealthTool
    
    :template: class.rst
    
    tools.bearly.tool.BearlyInterpreterTool
    
    :template: pydantic.rst
    
    tools.bearly.tool.BearlyInterpreterToolArguments
    
    :template: pydantic.rst
    
    tools.bearly.tool.FileInfo
    
    :template: pydantic.rst
    
    tools.bing_search.tool.BingSearchResults
    
    :template: pydantic.rst
    
    tools.bing_search.tool.BingSearchRun
    
    :template: pydantic.rst
    
    tools.brave_search.tool.BraveSearch
    
    :template: pydantic.rst
    
    tools.clickup.tool.ClickupAction
    
    :template: pydantic.rst
    
    tools.dataforseo_api_search.tool.DataForSeoAPISearchResults
    
    :template: pydantic.rst
    
    tools.dataforseo_api_search.tool.DataForSeoAPISearchRun
    
    :template: pydantic.rst
    
    tools.ddg_search.tool.DDGInput
    
    :template: pydantic.rst
    
    tools.ddg_search.tool.DuckDuckGoSearchResults
    
    :template: pydantic.rst
    
    tools.ddg_search.tool.DuckDuckGoSearchRun
    
    :template: pydantic.rst
    
    tools.e2b_data_analysis.tool.E2BDataAnalysisTool
    
    :template: pydantic.rst
    
    tools.e2b_data_analysis.tool.E2BDataAnalysisToolArguments
    
    :template: pydantic.rst
    
    tools.e2b_data_analysis.tool.UploadedFile
    
    :template: class.rst
    
    tools.e2b_data_analysis.unparse.Unparser
    
    :template: pydantic.rst
    
    tools.edenai.audio_speech_to_text.EdenAiSpeechToTextTool
    
    :template: pydantic.rst
    
    tools.edenai.audio_text_to_speech.EdenAiTextToSpeechTool
    
    :template: pydantic.rst
    
    tools.edenai.edenai_base_tool.EdenaiTool
    
    :template: pydantic.rst
    
    tools.edenai.image_explicitcontent.EdenAiExplicitImageTool
    
    :template: pydantic.rst
    
    tools.edenai.image_objectdetection.EdenAiObjectDetectionTool
    
    :template: pydantic.rst
    
    tools.edenai.ocr_identityparser.EdenAiParsingIDTool
    
    :template: pydantic.rst
    
    tools.edenai.ocr_invoiceparser.EdenAiParsingInvoiceTool
    
    :template: pydantic.rst
    
    tools.edenai.text_moderation.EdenAiTextModerationTool
    
    :template: enum.rst
    
    tools.eleven_labs.models.ElevenLabsModel
    
    :template: enum.rst
    
    tools.eleven_labs.text2speech.ElevenLabsModel
    
    :template: pydantic.rst
    
    tools.eleven_labs.text2speech.ElevenLabsText2SpeechTool
    
    :template: pydantic.rst
    
    tools.file_management.copy.CopyFileTool
    
    :template: pydantic.rst
    
    tools.file_management.copy.FileCopyInput
    
    :template: pydantic.rst
    
    tools.file_management.delete.DeleteFileTool
    
    :template: pydantic.rst
    
    tools.file_management.delete.FileDeleteInput
    
    :template: pydantic.rst
    
    tools.file_management.file_search.FileSearchInput
    
    :template: pydantic.rst
    
    tools.file_management.file_search.FileSearchTool
    
    :template: pydantic.rst
    
    tools.file_management.list_dir.DirectoryListingInput
    
    :template: pydantic.rst
    
    tools.file_management.list_dir.ListDirectoryTool
    
    :template: pydantic.rst
    
    tools.file_management.move.FileMoveInput
    
    :template: pydantic.rst
    
    tools.file_management.move.MoveFileTool
    
    :template: pydantic.rst
    
    tools.file_management.read.ReadFileInput
    
    :template: pydantic.rst
    
    tools.file_management.read.ReadFileTool
    
    :template: pydantic.rst
    
    tools.file_management.utils.BaseFileToolMixin
    
    :template: class.rst
    
    tools.file_management.utils.FileValidationError
    
    :template: pydantic.rst
    
    tools.file_management.write.WriteFileInput
    
    :template: pydantic.rst
    
    tools.file_management.write.WriteFileTool
    
    :template: pydantic.rst
    
    tools.github.tool.GitHubAction
    
    :template: pydantic.rst
    
    tools.gitlab.tool.GitLabAction
    
    :template: pydantic.rst
    
    tools.gmail.base.GmailBaseTool
    
    :template: pydantic.rst
    
    tools.gmail.create_draft.CreateDraftSchema
    
    :template: pydantic.rst
    
    tools.gmail.create_draft.GmailCreateDraft
    
    :template: pydantic.rst
    
    tools.gmail.get_message.GmailGetMessage
    
    :template: pydantic.rst
    
    tools.gmail.get_message.SearchArgsSchema
    
    :template: pydantic.rst
    
    tools.gmail.get_thread.GetThreadSchema
    
    :template: pydantic.rst
    
    tools.gmail.get_thread.GmailGetThread
    
    :template: pydantic.rst
    
    tools.gmail.search.GmailSearch
    
    :template: enum.rst
    
    tools.gmail.search.Resource
    
    :template: pydantic.rst
    
    tools.gmail.search.SearchArgsSchema
    
    :template: pydantic.rst
    
    tools.gmail.send_message.GmailSendMessage
    
    :template: pydantic.rst
    
    tools.gmail.send_message.SendMessageSchema
    
    :template: pydantic.rst
    
    tools.golden_query.tool.GoldenQueryRun
    
    :template: pydantic.rst
    
    tools.google_cloud.texttospeech.GoogleCloudTextToSpeechTool
    
    :template: pydantic.rst
    
    tools.google_finance.tool.GoogleFinanceQueryRun
    
    :template: pydantic.rst
    
    tools.google_jobs.tool.GoogleJobsQueryRun
    
    :template: pydantic.rst
    
    tools.google_lens.tool.GoogleLensQueryRun
    
    :template: pydantic.rst
    
    tools.google_places.tool.GooglePlacesSchema
    
    :template: pydantic.rst
    
    tools.google_places.tool.GooglePlacesTool
    
    :template: pydantic.rst
    
    tools.google_scholar.tool.GoogleScholarQueryRun
    
    :template: pydantic.rst
    
    tools.google_search.tool.GoogleSearchResults
    
    :template: pydantic.rst
    
    tools.google_search.tool.GoogleSearchRun
    
    :template: pydantic.rst
    
    tools.google_serper.tool.GoogleSerperResults
    
    :template: pydantic.rst
    
    tools.google_serper.tool.GoogleSerperRun
    
    :template: pydantic.rst
    
    tools.google_trends.tool.GoogleTrendsQueryRun
    
    :template: pydantic.rst
    
    tools.graphql.tool.BaseGraphQLTool
    
    :template: pydantic.rst
    
    tools.human.tool.HumanInputRun
    
    :template: pydantic.rst
    
    tools.ifttt.IFTTTWebhook
    
    :template: pydantic.rst
    
    tools.jira.tool.JiraAction
    
    :template: pydantic.rst
    
    tools.json.tool.JsonGetValueTool
    
    :template: pydantic.rst
    
    tools.json.tool.JsonListKeysTool
    
    :template: pydantic.rst
    
    tools.json.tool.JsonSpec
    
    :template: pydantic.rst
    
    tools.memorize.tool.Memorize
    
    :template: class.rst
    
    tools.memorize.tool.TrainableLLM
    
    :template: pydantic.rst
    
    tools.merriam_webster.tool.MerriamWebsterQueryRun
    
    :template: pydantic.rst
    
    tools.metaphor_search.tool.MetaphorSearchResults
    
    :template: pydantic.rst
    
    tools.multion.close_session.CloseSessionSchema
    
    :template: pydantic.rst
    
    tools.multion.close_session.MultionCloseSession
    
    :template: pydantic.rst
    
    tools.multion.create_session.CreateSessionSchema
    
    :template: pydantic.rst
    
    tools.multion.create_session.MultionCreateSession
    
    :template: pydantic.rst
    
    tools.multion.update_session.MultionUpdateSession
    
    :template: pydantic.rst
    
    tools.multion.update_session.UpdateSessionSchema
    
    :template: pydantic.rst
    
    tools.nasa.tool.NasaAction
    
    :template: pydantic.rst
    
    tools.nuclia.tool.NUASchema
    
    :template: pydantic.rst
    
    tools.nuclia.tool.NucliaUnderstandingAPI
    
    :template: pydantic.rst
    
    tools.office365.base.O365BaseTool
    
    :template: pydantic.rst
    
    tools.office365.create_draft_message.CreateDraftMessageSchema
    
    :template: pydantic.rst
    
    tools.office365.create_draft_message.O365CreateDraftMessage
    
    :template: pydantic.rst
    
    tools.office365.events_search.O365SearchEvents
    
    :template: pydantic.rst
    
    tools.office365.events_search.SearchEventsInput
    
    :template: pydantic.rst
    
    tools.office365.messages_search.O365SearchEmails
    
    :template: pydantic.rst
    
    tools.office365.messages_search.SearchEmailsInput
    
    :template: pydantic.rst
    
    tools.office365.send_event.O365SendEvent
    
    :template: pydantic.rst
    
    tools.office365.send_event.SendEventSchema
    
    :template: pydantic.rst
    
    tools.office365.send_message.O365SendMessage
    
    :template: pydantic.rst
    
    tools.office365.send_message.SendMessageSchema
    
    :template: pydantic.rst
    
    tools.openapi.utils.api_models.APIOperation
    
    :template: pydantic.rst
    
    tools.openapi.utils.api_models.APIProperty
    
    :template: pydantic.rst
    
    tools.openapi.utils.api_models.APIPropertyBase
    
    :template: enum.rst
    
    tools.openapi.utils.api_models.APIPropertyLocation
    
    :template: pydantic.rst
    
    tools.openapi.utils.api_models.APIRequestBody
    
    :template: pydantic.rst
    
    tools.openapi.utils.api_models.APIRequestBodyProperty
    
    :template: pydantic.rst
    
    tools.openweathermap.tool.OpenWeatherMapQueryRun
    
    :template: pydantic.rst
    
    tools.playwright.base.BaseBrowserTool
    
    :template: pydantic.rst
    
    tools.playwright.click.ClickTool
    
    :template: pydantic.rst
    
    tools.playwright.click.ClickToolInput
    
    :template: pydantic.rst
    
    tools.playwright.current_page.CurrentWebPageTool
    
    :template: pydantic.rst
    
    tools.playwright.extract_hyperlinks.ExtractHyperlinksTool
    
    :template: pydantic.rst
    
    tools.playwright.extract_hyperlinks.ExtractHyperlinksToolInput
    
    :template: pydantic.rst
    
    tools.playwright.extract_text.ExtractTextTool
    
    :template: pydantic.rst
    
    tools.playwright.get_elements.GetElementsTool
    
    :template: pydantic.rst
    
    tools.playwright.get_elements.GetElementsToolInput
    
    :template: pydantic.rst
    
    tools.playwright.navigate.NavigateTool
    
    :template: pydantic.rst
    
    tools.playwright.navigate.NavigateToolInput
    
    :template: pydantic.rst
    
    tools.playwright.navigate_back.NavigateBackTool
    
    :template: pydantic.rst
    
    tools.plugin.AIPlugin
    
    :template: pydantic.rst
    
    tools.plugin.AIPluginTool
    
    :template: pydantic.rst
    
    tools.plugin.AIPluginToolSchema
    
    :template: pydantic.rst
    
    tools.plugin.ApiConfig
    
    :template: pydantic.rst
    
    tools.powerbi.tool.InfoPowerBITool
    
    :template: pydantic.rst
    
    tools.powerbi.tool.ListPowerBITool
    
    :template: pydantic.rst
    
    tools.powerbi.tool.QueryPowerBITool
    
    :template: pydantic.rst
    
    tools.pubmed.tool.PubmedQueryRun
    
    :template: pydantic.rst
    
    tools.reddit_search.tool.RedditSearchRun
    
    :template: pydantic.rst
    
    tools.reddit_search.tool.RedditSearchSchema
    
    :template: pydantic.rst
    
    tools.requests.tool.BaseRequestsTool
    
    :template: pydantic.rst
    
    tools.requests.tool.RequestsDeleteTool
    
    :template: pydantic.rst
    
    tools.requests.tool.RequestsGetTool
    
    :template: pydantic.rst
    
    tools.requests.tool.RequestsPatchTool
    
    :template: pydantic.rst
    
    tools.requests.tool.RequestsPostTool
    
    :template: pydantic.rst
    
    tools.requests.tool.RequestsPutTool
    
    :template: pydantic.rst
    
    tools.scenexplain.tool.SceneXplainInput
    
    :template: pydantic.rst
    
    tools.scenexplain.tool.SceneXplainTool
    
    :template: pydantic.rst
    
    tools.searchapi.tool.SearchAPIResults
    
    :template: pydantic.rst
    
    tools.searchapi.tool.SearchAPIRun
    
    :template: pydantic.rst
    
    tools.searx_search.tool.SearxSearchResults
    
    :template: pydantic.rst
    
    tools.searx_search.tool.SearxSearchRun
    
    :template: pydantic.rst
    
    tools.shell.tool.ShellInput
    
    :template: pydantic.rst
    
    tools.shell.tool.ShellTool
    
    :template: pydantic.rst
    
    tools.slack.base.SlackBaseTool
    
    :template: pydantic.rst
    
    tools.slack.get_channel.SlackGetChannel
    
    :template: pydantic.rst
    
    tools.slack.get_message.SlackGetMessage
    
    :template: pydantic.rst
    
    tools.slack.get_message.SlackGetMessageSchema
    
    :template: pydantic.rst
    
    tools.slack.schedule_message.ScheduleMessageSchema
    
    :template: pydantic.rst
    
    tools.slack.schedule_message.SlackScheduleMessage
    
    :template: pydantic.rst
    
    tools.slack.send_message.SendMessageSchema
    
    :template: pydantic.rst
    
    tools.slack.send_message.SlackSendMessage
    
    :template: pydantic.rst
    
    tools.sleep.tool.SleepInput
    
    :template: pydantic.rst
    
    tools.sleep.tool.SleepTool
    
    :template: pydantic.rst
    
    tools.spark_sql.tool.BaseSparkSQLTool
    
    :template: pydantic.rst
    
    tools.spark_sql.tool.InfoSparkSQLTool
    
    :template: pydantic.rst
    
    tools.spark_sql.tool.ListSparkSQLTool
    
    :template: pydantic.rst
    
    tools.spark_sql.tool.QueryCheckerTool
    
    :template: pydantic.rst
    
    tools.spark_sql.tool.QuerySparkSQLTool
    
    :template: pydantic.rst
    
    tools.sql_database.tool.BaseSQLDatabaseTool
    
    :template: pydantic.rst
    
    tools.sql_database.tool.InfoSQLDatabaseTool
    
    :template: pydantic.rst
    
    tools.sql_database.tool.ListSQLDatabaseTool
    
    :template: pydantic.rst
    
    tools.sql_database.tool.QuerySQLCheckerTool
    
    :template: pydantic.rst
    
    tools.sql_database.tool.QuerySQLDataBaseTool
    
    :template: pydantic.rst
    
    tools.stackexchange.tool.StackExchangeTool
    
    :template: pydantic.rst
    
    tools.steam.tool.SteamWebAPIQueryRun
    
    :template: enum.rst
    
    tools.steamship_image_generation.tool.ModelName
    
    :template: pydantic.rst
    
    tools.steamship_image_generation.tool.SteamshipImageGenerationTool
    
    :template: pydantic.rst
    
    tools.tavily_search.tool.TavilyAnswer
    
    :template: pydantic.rst
    
    tools.tavily_search.tool.TavilyInput
    
    :template: pydantic.rst
    
    tools.tavily_search.tool.TavilySearchResults
    
    :template: pydantic.rst
    
    tools.vectorstore.tool.BaseVectorStoreTool
    
    :template: pydantic.rst
    
    tools.vectorstore.tool.VectorStoreQATool
    
    :template: pydantic.rst
    
    tools.vectorstore.tool.VectorStoreQAWithSourcesTool
    
    :template: pydantic.rst
    
    tools.wikipedia.tool.WikipediaQueryRun
    
    :template: pydantic.rst
    
    tools.wolfram_alpha.tool.WolframAlphaQueryRun
    
    :template: pydantic.rst
    
    tools.yahoo_finance_news.YahooFinanceNewsTool
    
    :template: pydantic.rst
    
    tools.youtube.search.YouTubeSearchTool
    
    :template: pydantic.rst
    
    tools.zapier.tool.ZapierNLAListActions
    
    :template: pydantic.rst
    
    tools.zapier.tool.ZapierNLARunAction
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: tools
    :template: function.rst

    tools.ainetwork.utils.authenticate
    tools.amadeus.utils.authenticate
    tools.azure_cognitive_services.utils.detect_file_src_type
    tools.azure_cognitive_services.utils.download_audio_from_url
    tools.bearly.tool.file_to_base64
    tools.bearly.tool.head_file
    tools.bearly.tool.strip_markdown_code
    tools.ddg_search.tool.DuckDuckGoSearchTool
    tools.e2b_data_analysis.tool.add_last_line_print
    tools.e2b_data_analysis.unparse.interleave
    tools.e2b_data_analysis.unparse.roundtrip
    tools.file_management.utils.get_validated_relative_path
    tools.file_management.utils.is_relative_to
    tools.gmail.utils.build_resource_service
    tools.gmail.utils.clean_email_body
    tools.gmail.utils.get_gmail_credentials
    tools.gmail.utils.import_google
    tools.gmail.utils.import_googleapiclient_resource_builder
    tools.gmail.utils.import_installed_app_flow
    tools.interaction.tool.StdInInquireTool
    tools.office365.utils.authenticate
    tools.office365.utils.clean_body
    tools.playwright.base.lazy_import_playwright_browsers
    tools.playwright.utils.aget_current_page
    tools.playwright.utils.create_async_playwright_browser
    tools.playwright.utils.create_sync_playwright_browser
    tools.playwright.utils.get_current_page
    tools.playwright.utils.run_async
    tools.plugin.marshal_spec
    tools.render.format_tool_to_openai_function
    tools.render.format_tool_to_openai_tool
    tools.render.render_text_description
    tools.render.render_text_description_and_args
    tools.slack.utils.login
    tools.steamship_image_generation.utils.make_image_public

:mod:`langchain_community.utilities`
=====================================

.. automodule:: langchain_community.utilities
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: utilities
    :template: pydantic.rst
    
    utilities.alpha_vantage.AlphaVantageAPIWrapper
    
    :template: pydantic.rst
    
    utilities.apify.ApifyWrapper
    
    :template: pydantic.rst
    
    utilities.arcee.ArceeDocument
    
    :template: class.rst
    
    utilities.arcee.ArceeDocumentAdapter
    
    :template: pydantic.rst
    
    utilities.arcee.ArceeDocumentSource
    
    :template: enum.rst
    
    utilities.arcee.ArceeRoute
    
    :template: class.rst
    
    utilities.arcee.ArceeWrapper
    
    :template: pydantic.rst
    
    utilities.arcee.DALMFilter
    
    :template: enum.rst
    
    utilities.arcee.DALMFilterType
    
    :template: pydantic.rst
    
    utilities.arxiv.ArxivAPIWrapper
    
    :template: pydantic.rst
    
    utilities.awslambda.LambdaWrapper
    
    :template: pydantic.rst
    
    utilities.bibtex.BibtexparserWrapper
    
    :template: pydantic.rst
    
    utilities.bing_search.BingSearchAPIWrapper
    
    :template: pydantic.rst
    
    utilities.brave_search.BraveSearchWrapper
    
    :template: class.rst
    
    utilities.clickup.CUList
    
    :template: pydantic.rst
    
    utilities.clickup.ClickupAPIWrapper
    
    :template: class.rst
    
    utilities.clickup.Component
    
    :template: class.rst
    
    utilities.clickup.Member
    
    :template: class.rst
    
    utilities.clickup.Space
    
    :template: class.rst
    
    utilities.clickup.Task
    
    :template: class.rst
    
    utilities.clickup.Team
    
    :template: pydantic.rst
    
    utilities.dalle_image_generator.DallEAPIWrapper
    
    :template: pydantic.rst
    
    utilities.dataforseo_api_search.DataForSeoAPIWrapper
    
    :template: pydantic.rst
    
    utilities.duckduckgo_search.DuckDuckGoSearchAPIWrapper
    
    :template: pydantic.rst
    
    utilities.github.GitHubAPIWrapper
    
    :template: pydantic.rst
    
    utilities.gitlab.GitLabAPIWrapper
    
    :template: pydantic.rst
    
    utilities.golden_query.GoldenQueryAPIWrapper
    
    :template: pydantic.rst
    
    utilities.google_finance.GoogleFinanceAPIWrapper
    
    :template: pydantic.rst
    
    utilities.google_jobs.GoogleJobsAPIWrapper
    
    :template: pydantic.rst
    
    utilities.google_lens.GoogleLensAPIWrapper
    
    :template: pydantic.rst
    
    utilities.google_places_api.GooglePlacesAPIWrapper
    
    :template: pydantic.rst
    
    utilities.google_scholar.GoogleScholarAPIWrapper
    
    :template: pydantic.rst
    
    utilities.google_search.GoogleSearchAPIWrapper
    
    :template: pydantic.rst
    
    utilities.google_serper.GoogleSerperAPIWrapper
    
    :template: pydantic.rst
    
    utilities.google_trends.GoogleTrendsAPIWrapper
    
    :template: pydantic.rst
    
    utilities.graphql.GraphQLAPIWrapper
    
    :template: pydantic.rst
    
    utilities.jira.JiraAPIWrapper
    
    :template: class.rst
    
    utilities.max_compute.MaxComputeAPIWrapper
    
    :template: pydantic.rst
    
    utilities.merriam_webster.MerriamWebsterAPIWrapper
    
    :template: pydantic.rst
    
    utilities.metaphor_search.MetaphorSearchAPIWrapper
    
    :template: pydantic.rst
    
    utilities.nasa.NasaAPIWrapper
    
    :template: enum.rst
    
    utilities.openapi.HTTPVerb
    
    :template: class.rst
    
    utilities.openapi.OpenAPISpec
    
    :template: pydantic.rst
    
    utilities.openweathermap.OpenWeatherMapAPIWrapper
    
    :template: pydantic.rst
    
    utilities.outline.OutlineAPIWrapper
    
    :template: class.rst
    
    utilities.portkey.Portkey
    
    :template: pydantic.rst
    
    utilities.powerbi.PowerBIDataset
    
    :template: pydantic.rst
    
    utilities.pubmed.PubMedAPIWrapper
    
    :template: pydantic.rst
    
    utilities.python.PythonREPL
    
    :template: pydantic.rst
    
    utilities.reddit_search.RedditSearchAPIWrapper
    
    :template: class.rst
    
    utilities.redis.TokenEscaper
    
    :template: pydantic.rst
    
    utilities.requests.Requests
    
    :template: pydantic.rst
    
    utilities.requests.RequestsWrapper
    
    :template: pydantic.rst
    
    utilities.requests.TextRequestsWrapper
    
    :template: pydantic.rst
    
    utilities.scenexplain.SceneXplainAPIWrapper
    
    :template: pydantic.rst
    
    utilities.searchapi.SearchApiAPIWrapper
    
    :template: class.rst
    
    utilities.searx_search.SearxResults
    
    :template: pydantic.rst
    
    utilities.searx_search.SearxSearchWrapper
    
    :template: class.rst
    
    utilities.serpapi.HiddenPrints
    
    :template: pydantic.rst
    
    utilities.serpapi.SerpAPIWrapper
    
    :template: class.rst
    
    utilities.spark_sql.SparkSQL
    
    :template: class.rst
    
    utilities.sql_database.SQLDatabase
    
    :template: pydantic.rst
    
    utilities.stackexchange.StackExchangeAPIWrapper
    
    :template: pydantic.rst
    
    utilities.steam.SteamWebAPIWrapper
    
    :template: pydantic.rst
    
    utilities.tavily_search.TavilySearchAPIWrapper
    
    :template: pydantic.rst
    
    utilities.tensorflow_datasets.TensorflowDatasets
    
    :template: pydantic.rst
    
    utilities.twilio.TwilioAPIWrapper
    
    :template: pydantic.rst
    
    utilities.wikipedia.WikipediaAPIWrapper
    
    :template: pydantic.rst
    
    utilities.wolfram_alpha.WolframAlphaAPIWrapper
    
    :template: pydantic.rst
    
    utilities.zapier.ZapierNLAWrapper
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: utilities
    :template: function.rst

    utilities.anthropic.get_num_tokens_anthropic
    utilities.anthropic.get_token_ids_anthropic
    utilities.clickup.extract_dict_elements_from_component_fields
    utilities.clickup.fetch_data
    utilities.clickup.fetch_first_id
    utilities.clickup.fetch_folder_id
    utilities.clickup.fetch_list_id
    utilities.clickup.fetch_space_id
    utilities.clickup.fetch_team_id
    utilities.clickup.load_query
    utilities.clickup.parse_dict_through_component
    utilities.opaqueprompts.desanitize
    utilities.opaqueprompts.sanitize
    utilities.powerbi.fix_table_name
    utilities.powerbi.json_to_md
    utilities.redis.check_redis_module_exist
    utilities.redis.get_client
    utilities.sql_database.truncate_word
    utilities.vertexai.create_retry_decorator
    utilities.vertexai.get_client_info
    utilities.vertexai.init_vertexai
    utilities.vertexai.raise_vertex_import_error

:mod:`langchain_community.utils`
=================================

.. automodule:: langchain_community.utils
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: utils
    :template: typeddict.rst
    
    utils.openai_functions.FunctionDescription
    
    :template: typeddict.rst
    
    utils.openai_functions.ToolDescription
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: utils
    :template: function.rst

    utils.math.cosine_similarity
    utils.math.cosine_similarity_top_k
    utils.openai.is_openai_v1
    utils.openai_functions.convert_pydantic_to_openai_function
    utils.openai_functions.convert_pydantic_to_openai_tool

:mod:`langchain_community.vectorstores`
========================================

.. automodule:: langchain_community.vectorstores
    :no-members:
    :no-inherited-members:

Classes
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: vectorstores
    :template: class.rst
    
    vectorstores.alibabacloud_opensearch.AlibabaCloudOpenSearch
    
    :template: class.rst
    
    vectorstores.alibabacloud_opensearch.AlibabaCloudOpenSearchSettings
    
    :template: class.rst
    
    vectorstores.analyticdb.AnalyticDB
    
    :template: class.rst
    
    vectorstores.annoy.Annoy
    
    :template: class.rst
    
    vectorstores.astradb.AstraDB
    
    :template: class.rst
    
    vectorstores.atlas.AtlasDB
    
    :template: class.rst
    
    vectorstores.awadb.AwaDB
    
    :template: class.rst
    
    vectorstores.azure_cosmos_db.AzureCosmosDBVectorSearch
    
    :template: enum.rst
    
    vectorstores.azure_cosmos_db.CosmosDBSimilarityType
    
    :template: class.rst
    
    vectorstores.azuresearch.AzureSearch
    
    :template: pydantic.rst
    
    vectorstores.azuresearch.AzureSearchVectorStoreRetriever
    
    :template: class.rst
    
    vectorstores.bageldb.Bagel
    
    :template: class.rst
    
    vectorstores.baiducloud_vector_search.BESVectorStore
    
    :template: class.rst
    
    vectorstores.cassandra.Cassandra
    
    :template: class.rst
    
    vectorstores.chroma.Chroma
    
    :template: class.rst
    
    vectorstores.clarifai.Clarifai
    
    :template: class.rst
    
    vectorstores.clickhouse.Clickhouse
    
    :template: pydantic.rst
    
    vectorstores.clickhouse.ClickhouseSettings
    
    :template: class.rst
    
    vectorstores.dashvector.DashVector
    
    :template: class.rst
    
    vectorstores.databricks_vector_search.DatabricksVectorSearch
    
    :template: class.rst
    
    vectorstores.deeplake.DeepLake
    
    :template: class.rst
    
    vectorstores.dingo.Dingo
    
    :template: class.rst
    
    vectorstores.docarray.base.DocArrayIndex
    
    :template: class.rst
    
    vectorstores.docarray.hnsw.DocArrayHnswSearch
    
    :template: class.rst
    
    vectorstores.docarray.in_memory.DocArrayInMemorySearch
    
    :template: class.rst
    
    vectorstores.elastic_vector_search.ElasticKnnSearch
    
    :template: class.rst
    
    vectorstores.elastic_vector_search.ElasticVectorSearch
    
    :template: class.rst
    
    vectorstores.elasticsearch.ApproxRetrievalStrategy
    
    :template: class.rst
    
    vectorstores.elasticsearch.BaseRetrievalStrategy
    
    :template: class.rst
    
    vectorstores.elasticsearch.ElasticsearchStore
    
    :template: class.rst
    
    vectorstores.elasticsearch.ExactRetrievalStrategy
    
    :template: class.rst
    
    vectorstores.elasticsearch.SparseRetrievalStrategy
    
    :template: class.rst
    
    vectorstores.epsilla.Epsilla
    
    :template: class.rst
    
    vectorstores.faiss.FAISS
    
    :template: class.rst
    
    vectorstores.hippo.Hippo
    
    :template: class.rst
    
    vectorstores.hologres.Hologres
    
    :template: class.rst
    
    vectorstores.lancedb.LanceDB
    
    :template: class.rst
    
    vectorstores.llm_rails.LLMRails
    
    :template: pydantic.rst
    
    vectorstores.llm_rails.LLMRailsRetriever
    
    :template: class.rst
    
    vectorstores.marqo.Marqo
    
    :template: class.rst
    
    vectorstores.matching_engine.MatchingEngine
    
    :template: class.rst
    
    vectorstores.meilisearch.Meilisearch
    
    :template: class.rst
    
    vectorstores.milvus.Milvus
    
    :template: class.rst
    
    vectorstores.momento_vector_index.MomentoVectorIndex
    
    :template: class.rst
    
    vectorstores.mongodb_atlas.MongoDBAtlasVectorSearch
    
    :template: class.rst
    
    vectorstores.myscale.MyScale
    
    :template: pydantic.rst
    
    vectorstores.myscale.MyScaleSettings
    
    :template: class.rst
    
    vectorstores.myscale.MyScaleWithoutJSON
    
    :template: class.rst
    
    vectorstores.neo4j_vector.Neo4jVector
    
    :template: enum.rst
    
    vectorstores.neo4j_vector.SearchType
    
    :template: class.rst
    
    vectorstores.nucliadb.NucliaDB
    
    :template: class.rst
    
    vectorstores.opensearch_vector_search.OpenSearchVectorSearch
    
    :template: class.rst
    
    vectorstores.pgembedding.BaseModel
    
    :template: class.rst
    
    vectorstores.pgembedding.CollectionStore
    
    :template: class.rst
    
    vectorstores.pgembedding.EmbeddingStore
    
    :template: class.rst
    
    vectorstores.pgembedding.PGEmbedding
    
    :template: class.rst
    
    vectorstores.pgembedding.QueryResult
    
    :template: class.rst
    
    vectorstores.pgvecto_rs.PGVecto_rs
    
    :template: class.rst
    
    vectorstores.pgvector.BaseModel
    
    :template: enum.rst
    
    vectorstores.pgvector.DistanceStrategy
    
    :template: class.rst
    
    vectorstores.pgvector.PGVector
    
    :template: class.rst
    
    vectorstores.pinecone.Pinecone
    
    :template: class.rst
    
    vectorstores.qdrant.Qdrant
    
    :template: class.rst
    
    vectorstores.qdrant.QdrantException
    
    :template: class.rst
    
    vectorstores.redis.base.Redis
    
    :template: pydantic.rst
    
    vectorstores.redis.base.RedisVectorStoreRetriever
    
    :template: class.rst
    
    vectorstores.redis.filters.RedisFilter
    
    :template: class.rst
    
    vectorstores.redis.filters.RedisFilterExpression
    
    :template: class.rst
    
    vectorstores.redis.filters.RedisFilterField
    
    :template: enum.rst
    
    vectorstores.redis.filters.RedisFilterOperator
    
    :template: class.rst
    
    vectorstores.redis.filters.RedisNum
    
    :template: class.rst
    
    vectorstores.redis.filters.RedisTag
    
    :template: class.rst
    
    vectorstores.redis.filters.RedisText
    
    :template: pydantic.rst
    
    vectorstores.redis.schema.FlatVectorField
    
    :template: pydantic.rst
    
    vectorstores.redis.schema.HNSWVectorField
    
    :template: pydantic.rst
    
    vectorstores.redis.schema.NumericFieldSchema
    
    :template: enum.rst
    
    vectorstores.redis.schema.RedisDistanceMetric
    
    :template: pydantic.rst
    
    vectorstores.redis.schema.RedisField
    
    :template: pydantic.rst
    
    vectorstores.redis.schema.RedisModel
    
    :template: pydantic.rst
    
    vectorstores.redis.schema.RedisVectorField
    
    :template: pydantic.rst
    
    vectorstores.redis.schema.TagFieldSchema
    
    :template: pydantic.rst
    
    vectorstores.redis.schema.TextFieldSchema
    
    :template: class.rst
    
    vectorstores.rocksetdb.Rockset
    
    :template: class.rst
    
    vectorstores.scann.ScaNN
    
    :template: class.rst
    
    vectorstores.semadb.SemaDB
    
    :template: class.rst
    
    vectorstores.singlestoredb.SingleStoreDB
    
    :template: class.rst
    
    vectorstores.sklearn.BaseSerializer
    
    :template: class.rst
    
    vectorstores.sklearn.BsonSerializer
    
    :template: class.rst
    
    vectorstores.sklearn.JsonSerializer
    
    :template: class.rst
    
    vectorstores.sklearn.ParquetSerializer
    
    :template: class.rst
    
    vectorstores.sklearn.SKLearnVectorStore
    
    :template: class.rst
    
    vectorstores.sklearn.SKLearnVectorStoreException
    
    :template: class.rst
    
    vectorstores.sqlitevss.SQLiteVSS
    
    :template: class.rst
    
    vectorstores.starrocks.StarRocks
    
    :template: pydantic.rst
    
    vectorstores.starrocks.StarRocksSettings
    
    :template: class.rst
    
    vectorstores.supabase.SupabaseVectorStore
    
    :template: class.rst
    
    vectorstores.tair.Tair
    
    :template: class.rst
    
    vectorstores.tencentvectordb.ConnectionParams
    
    :template: class.rst
    
    vectorstores.tencentvectordb.IndexParams
    
    :template: class.rst
    
    vectorstores.tencentvectordb.TencentVectorDB
    
    :template: class.rst
    
    vectorstores.tigris.Tigris
    
    :template: class.rst
    
    vectorstores.tiledb.TileDB
    
    :template: class.rst
    
    vectorstores.timescalevector.TimescaleVector
    
    :template: class.rst
    
    vectorstores.typesense.Typesense
    
    :template: class.rst
    
    vectorstores.usearch.USearch
    
    :template: enum.rst
    
    vectorstores.utils.DistanceStrategy
    
    :template: class.rst
    
    vectorstores.vald.Vald
    
    :template: class.rst
    
    vectorstores.vearch.Vearch
    
    :template: class.rst
    
    vectorstores.vectara.Vectara
    
    :template: pydantic.rst
    
    vectorstores.vectara.VectaraRetriever
    
    :template: class.rst
    
    vectorstores.vespa.VespaStore
    
    :template: class.rst
    
    vectorstores.weaviate.Weaviate
    
    :template: class.rst
    
    vectorstores.xata.XataVectorStore
    
    :template: class.rst
    
    vectorstores.yellowbrick.Yellowbrick
    
    :template: class.rst
    
    vectorstores.zep.CollectionConfig
    
    :template: class.rst
    
    vectorstores.zep.ZepVectorStore
    
    :template: class.rst
    
    vectorstores.zilliz.Zilliz
    
Functions
--------------
.. currentmodule:: langchain_community

.. autosummary::
    :toctree: vectorstores
    :template: function.rst

    vectorstores.alibabacloud_opensearch.create_metadata
    vectorstores.annoy.dependable_annoy_import
    vectorstores.clickhouse.has_mul_sub_str
    vectorstores.faiss.dependable_faiss_import
    vectorstores.myscale.has_mul_sub_str
    vectorstores.neo4j_vector.check_if_not_null
    vectorstores.neo4j_vector.sort_by_index_name
    vectorstores.qdrant.sync_call_fallback
    vectorstores.redis.base.check_index_exists
    vectorstores.redis.filters.check_operator_misuse
    vectorstores.redis.schema.read_schema
    vectorstores.scann.dependable_scann_import
    vectorstores.scann.normalize
    vectorstores.starrocks.debug_output
    vectorstores.starrocks.get_named_result
    vectorstores.starrocks.has_mul_sub_str
    vectorstores.tiledb.dependable_tiledb_import
    vectorstores.tiledb.get_documents_array_uri
    vectorstores.tiledb.get_documents_array_uri_from_group
    vectorstores.tiledb.get_vector_index_uri
    vectorstores.tiledb.get_vector_index_uri_from_group
    vectorstores.usearch.dependable_usearch_import
    vectorstores.utils.filter_complex_metadata
    vectorstores.utils.maximal_marginal_relevance