How-to guides
Source: langchain

---sidebar_position: 0sidebar_class_name: hidden---# How-to guidesHere you’ll find answers to “How do I....?” types of questions.These guides are *goal-oriented* and *concrete*; they're meant to help you complete a specific task.For conceptual explanations see the [Conceptual guide](/docs/concepts/).For end-to-end walkthroughs see [Tutorials](/docs/tutorials).For comprehensive descriptions of every class and function see the [API Reference](https://python.langchain.com/v0.2/api_reference/).## Installation- [How to: install LangChain packages](/docs/how_to/installation/)- [How to: use LangChain with different Pydantic versions](/docs/how_to/pydantic_compatibility)## Key featuresThis highlights functionality that is core to using LangChain.- [How to: return structured data from a model](/docs/how_to/structured_output/)- [How to: use a model to call tools](/docs/how_to/tool_calling)- [How to: stream runnables](/docs/how_to/streaming)- [How to: debug your LLM apps](/docs/how_to/debugging/)## LangChain Expression Language (LCEL)[LangChain Expression Language](/docs/concepts/#langchain-expression-language-lcel) is a way to create arbitrary custom chains. It is built on the [Runnable](https://python.langchain.com/v0.2/api_reference/core/runnables/langchain_core.runnables.base.Runnable.html) protocol.[**LCEL cheatsheet**](/docs/how_to/lcel_cheatsheet/): For a quick overview of how to use the main LCEL primitives.[**Migration guide**](/docs/versions/migrating_chains): For migrating legacy chain abstractions to LCEL.- [How to: chain runnables](/docs/how_to/sequence)- [How to: stream runnables](/docs/how_to/streaming)- [How to: invoke runnables in parallel](/docs/how_to/parallel/)- [How to: add default invocation args to runnables](/docs/how_to/binding/)- [How to: turn any function into a runnable](/docs/how_to/functions)- [How to: pass through inputs from one chain step to the next](/docs/how_to/passthrough)- [How to: configure runnable behavior at runtime](/docs/how_to/configure)- [How to: add message history (memory) to a chain](/docs/how_to/message_history)- [How to: route between sub-chains](/docs/how_to/routing)- [How to: create a dynamic (self-constructing) chain](/docs/how_to/dynamic_chain/)- [How to: inspect runnables](/docs/how_to/inspect)- [How to: add fallbacks to a runnable](/docs/how_to/fallbacks)- [How to: pass runtime secrets to a runnable](/docs/how_to/runnable_runtime_secrets)## ComponentsThese are the core building blocks you can use when building applications.### Prompt templates[Prompt Templates](/docs/concepts/#prompt-templates) are responsible for formatting user input into a format that can be passed to a language model.- [How to: use few shot examples](/docs/how_to/few_shot_examples)- [How to: use few shot examples in chat models](/docs/how_to/few_shot_examples_chat/)- [How to: partially format prompt templates](/docs/how_to/prompts_partial)- [How to: compose prompts together](/docs/how_to/prompts_composition)### Example selectors[Example Selectors](/docs/concepts/#example-selectors) are responsible for selecting the correct few shot examples to pass to the prompt.- [How to: use example selectors](/docs/how_to/example_selectors)- [How to: select examples by length](/docs/how_to/example_selectors_length_based)- [How to: select examples by semantic similarity](/docs/how_to/example_selectors_similarity)- [How to: select examples by semantic ngram overlap](/docs/how_to/example_selectors_ngram)- [How to: select examples by maximal marginal relevance](/docs/how_to/example_selectors_mmr)- [How to: select examples from LangSmith few-shot datasets](/docs/how_to/example_selectors_langsmith/)### Chat models[Chat Models](/docs/concepts/#chat-models) are newer forms of language models that take messages in and output a message.- [How to: do function/tool calling](/docs/how_to/tool_calling)- [How to: get models to return structured output](/docs/how_to/structured_output)- [How to: cache model responses](/docs/how_to/chat_model_caching)- [How to: get log probabilities](/docs/how_to/logprobs)- [How to: create a custom chat model class](/docs/how_to/custom_chat_model)- [How to: stream a response back](/docs/how_to/chat_streaming)- [How to: track token usage](/docs/how_to/chat_token_usage_tracking)- [How to: track response metadata across providers](/docs/how_to/response_metadata)- [How to: use chat model to call tools](/docs/how_to/tool_calling)- [How to: stream tool calls](/docs/how_to/tool_streaming)- [How to: handle rate limits](/docs/how_to/chat_model_rate_limiting)- [How to: few shot prompt tool behavior](/docs/how_to/tools_few_shot)- [How to: bind model-specific formatted tools](/docs/how_to/tools_model_specific)- [How to: force a specific tool call](/docs/how_to/tool_choice)- [How to: work with local models](/docs/how_to/local_llms)- [How to: init any model in one line](/docs/how_to/chat_models_universal_init/)### Messages[Messages](/docs/concepts/#messages) are the input and output of chat models. They have some `content` and a `role`, which describes the source of the message.- [How to: trim messages](/docs/how_to/trim_messages/)- [How to: filter messages](/docs/how_to/filter_messages/)- [How to: merge consecutive messages of the same type](/docs/how_to/merge_message_runs/)### LLMsWhat LangChain calls [LLMs](/docs/concepts/#llms) are older forms of language models that take a string in and output a string.- [How to: cache model responses](/docs/how_to/llm_caching)- [How to: create a custom LLM class](/docs/how_to/custom_llm)- [How to: stream a response back](/docs/how_to/streaming_llm)- [How to: track token usage](/docs/how_to/llm_token_usage_tracking)- [How to: work with local models](/docs/how_to/local_llms)### Output parsers[Output Parsers](/docs/concepts/#output-parsers) are responsible for taking the output of an LLM and parsing into more structured format.- [How to: use output parsers to parse an LLM response into structured format](/docs/how_to/output_parser_structured)- [How to: parse JSON output](/docs/how_to/output_parser_json)- [How to: parse XML output](/docs/how_to/output_parser_xml)- [How to: parse YAML output](/docs/how_to/output_parser_yaml)- [How to: retry when output parsing errors occur](/docs/how_to/output_parser_retry)- [How to: try to fix errors in output parsing](/docs/how_to/output_parser_fixing)- [How to: write a custom output parser class](/docs/how_to/output_parser_custom)### Document loaders[Document Loaders](/docs/concepts/#document-loaders) are responsible for loading documents from a variety of sources.- [How to: load CSV data](/docs/how_to/document_loader_csv)- [How to: load data from a directory](/docs/how_to/document_loader_directory)- [How to: load HTML data](/docs/how_to/document_loader_html)- [How to: load JSON data](/docs/how_to/document_loader_json)- [How to: load Markdown data](/docs/how_to/document_loader_markdown)- [How to: load Microsoft Office data](/docs/how_to/document_loader_office_file)- [How to: load PDF files](/docs/how_to/document_loader_pdf)- [How to: write a custom document loader](/docs/how_to/document_loader_custom)### Text splitters[Text Splitters](/docs/concepts/#text-splitters) take a document and split into chunks that can be used for retrieval.- [How to: recursively split text](/docs/how_to/recursive_text_splitter)- [How to: split by HTML headers](/docs/how_to/HTML_header_metadata_splitter)- [How to: split by HTML sections](/docs/how_to/HTML_section_aware_splitter)- [How to: split by character](/docs/how_to/character_text_splitter)- [How to: split code](/docs/how_to/code_splitter)- [How to: split Markdown by headers](/docs/how_to/markdown_header_metadata_splitter)- [How to: recursively split JSON](/docs/how_to/recursive_json_splitter)- [How to: split text into semantic chunks](/docs/how_to/semantic-chunker)- [How to: split by tokens](/docs/how_to/split_by_token)### Embedding models[Embedding Models](/docs/concepts/#embedding-models) take a piece of text and create a numerical representation of it.- [How to: embed text data](/docs/how_to/embed_text)- [How to: cache embedding results](/docs/how_to/caching_embeddings)### Vector stores[Vector stores](/docs/concepts/#vector-stores) are databases that can efficiently store and retrieve embeddings.- [How to: use a vector store to retrieve data](/docs/how_to/vectorstores)### Retrievers[Retrievers](/docs/concepts/#retrievers) are responsible for taking a query and returning relevant documents.- [How to: use a vector store to retrieve data](/docs/how_to/vectorstore_retriever)- [How to: generate multiple queries to retrieve data for](/docs/how_to/MultiQueryRetriever)- [How to: use contextual compression to compress the data retrieved](/docs/how_to/contextual_compression)- [How to: write a custom retriever class](/docs/how_to/custom_retriever)- [How to: add similarity scores to retriever results](/docs/how_to/add_scores_retriever)- [How to: combine the results from multiple retrievers](/docs/how_to/ensemble_retriever)- [How to: reorder retrieved results to mitigate the "lost in the middle" effect](/docs/how_to/long_context_reorder)- [How to: generate multiple embeddings per document](/docs/how_to/multi_vector)- [How to: retrieve the whole document for a chunk](/docs/how_to/parent_document_retriever)- [How to: generate metadata filters](/docs/how_to/self_query)- [How to: create a time-weighted retriever](/docs/how_to/time_weighted_vectorstore)- [How to: use hybrid vector and keyword retrieval](/docs/how_to/hybrid)### IndexingIndexing is the process of keeping your vectorstore in-sync with the underlying data source.- [How to: reindex data to keep your vectorstore in-sync with the underlying data source](/docs/how_to/indexing)### ToolsLangChain [Tools](/docs/concepts/#tools) contain a description of the tool (to pass to the language model) as well as the implementation of the function to call. Refer [here](/docs/integrations/tools/) for a list of pre-buit tools. - [How to: create tools](/docs/how_to/custom_tools)- [How to: use built-in tools and toolkits](/docs/how_to/tools_builtin)- [How to: use chat models to call tools](/docs/how_to/tool_calling)- [How to: pass tool outputs to chat models](/docs/how_to/tool_results_pass_to_model)- [How to: pass run time values to tools](/docs/how_to/tool_runtime)- [How to: add a human-in-the-loop for tools](/docs/how_to/tools_human)- [How to: handle tool errors](/docs/how_to/tools_error)- [How to: force models to call a tool](/docs/how_to/tool_choice)- [How to: disable parallel tool calling](/docs/how_to/tool_calling_parallel)- [How to: access the `RunnableConfig` from a tool](/docs/how_to/tool_configure)- [How to: stream events from a tool](/docs/how_to/tool_stream_events)- [How to: return artifacts from a tool](/docs/how_to/tool_artifacts/)- [How to: convert Runnables to tools](/docs/how_to/convert_runnable_to_tool)- [How to: add ad-hoc tool calling capability to models](/docs/how_to/tools_prompting)- [How to: pass in runtime secrets](/docs/how_to/runnable_runtime_secrets)### Multimodal- [How to: pass multimodal data directly to models](/docs/how_to/multimodal_inputs/)- [How to: use multimodal prompts](/docs/how_to/multimodal_prompts/)### Agents:::noteFor in depth how-to guides for agents, please check out [LangGraph](https://langchain-ai.github.io/langgraph/) documentation.:::- [How to: use legacy LangChain Agents (AgentExecutor)](/docs/how_to/agent_executor)- [How to: migrate from legacy LangChain agents to LangGraph](/docs/how_to/migrate_agent)### Callbacks[Callbacks](/docs/concepts/#callbacks) allow you to hook into the various stages of your LLM application's execution.- [How to: pass in callbacks at runtime](/docs/how_to/callbacks_runtime)- [How to: attach callbacks to a module](/docs/how_to/callbacks_attach)- [How to: pass callbacks into a module constructor](/docs/how_to/callbacks_constructor)- [How to: create custom callback handlers](/docs/how_to/custom_callbacks)- [How to: use callbacks in async environments](/docs/how_to/callbacks_async)- [How to: dispatch custom callback events](/docs/how_to/callbacks_custom_events)### CustomAll of LangChain components can easily be extended to support your own versions.- [How to: create a custom chat model class](/docs/how_to/custom_chat_model)- [How to: create a custom LLM class](/docs/how_to/custom_llm)- [How to: write a custom retriever class](/docs/how_to/custom_retriever)- [How to: write a custom document loader](/docs/how_to/document_loader_custom)- [How to: write a custom output parser class](/docs/how_to/output_parser_custom)- [How to: create custom callback handlers](/docs/how_to/custom_callbacks)- [How to: define a custom tool](/docs/how_to/custom_tools)- [How to: dispatch custom callback events](/docs/how_to/callbacks_custom_events)### Serialization- [How to: save and load LangChain objects](/docs/how_to/serialization)## Use casesThese guides cover use-case specific details.### Q&A with RAGRetrieval Augmented Generation (RAG) is a way to connect LLMs to external sources of data.For a high-level tutorial on RAG, check out [this guide](/docs/tutorials/rag/).- [How to: add chat history](/docs/how_to/qa_chat_history_how_to/)- [How to: stream](/docs/how_to/qa_streaming/)- [How to: return sources](/docs/how_to/qa_sources/)- [How to: return citations](/docs/how_to/qa_citations/)- [How to: do per-user retrieval](/docs/how_to/qa_per_user/)### ExtractionExtraction is when you use LLMs to extract structured information from unstructured text.For a high level tutorial on extraction, check out [this guide](/docs/tutorials/extraction/).- [How to: use reference examples](/docs/how_to/extraction_examples/)- [How to: handle long text](/docs/how_to/extraction_long_text/)- [How to: do extraction without using function calling](/docs/how_to/extraction_parse)### ChatbotsChatbots involve using an LLM to have a conversation.For a high-level tutorial on building chatbots, check out [this guide](/docs/tutorials/chatbot/).- [How to: manage memory](/docs/how_to/chatbots_memory)- [How to: do retrieval](/docs/how_to/chatbots_retrieval)- [How to: use tools](/docs/how_to/chatbots_tools)- [How to: manage large chat history](/docs/how_to/trim_messages/)### Query analysisQuery Analysis is the task of using an LLM to generate a query to send to a retriever.For a high-level tutorial on query analysis, check out [this guide](/docs/tutorials/query_analysis/).- [How to: add examples to the prompt](/docs/how_to/query_few_shot)- [How to: handle cases where no queries are generated](/docs/how_to/query_no_queries)- [How to: handle multiple queries](/docs/how_to/query_multiple_queries)- [How to: handle multiple retrievers](/docs/how_to/query_multiple_retrievers)- [How to: construct filters](/docs/how_to/query_constructing_filters)- [How to: deal with high cardinality categorical variables](/docs/how_to/query_high_cardinality)### Q&A over SQL + CSVYou can use LLMs to do question answering over tabular data.For a high-level tutorial, check out [this guide](/docs/tutorials/sql_qa/).- [How to: use prompting to improve results](/docs/how_to/sql_prompting)- [How to: do query validation](/docs/how_to/sql_query_checking)- [How to: deal with large databases](/docs/how_to/sql_large_db)- [How to: deal with CSV files](/docs/how_to/sql_csv)### Q&A over graph databasesYou can use an LLM to do question answering over graph databases.For a high-level tutorial, check out [this guide](/docs/tutorials/graph/).- [How to: map values to a database](/docs/how_to/graph_mapping)- [How to: add a semantic layer over the database](/docs/how_to/graph_semantic)- [How to: improve results with prompting](/docs/how_to/graph_prompting)- [How to: construct knowledge graphs](/docs/how_to/graph_constructing)### SummarizationLLMs can summarize and otherwise distill desired information from text, includinglarge volumes of text. For a high-level tutorial, check out [this guide](/docs/tutorials/summarization).- [How to: summarize text in a single LLM call](/docs/how_to/summarize_stuff)- [How to: summarize text through parallelization](/docs/how_to/summarize_map_reduce)- [How to: summarize text through iterative refinement](/docs/how_to/summarize_refine)## [LangGraph](https://langchain-ai.github.io/langgraph)LangGraph is an extension of LangChain aimed atbuilding robust and stateful multi-actor applications with LLMs by modeling steps as edges and nodes in a graph.LangGraph documentation is currently hosted on a separate site.You can peruse [LangGraph how-to guides here](https://langchain-ai.github.io/langgraph/how-tos/).## [LangSmith](https://docs.smith.langchain.com/)LangSmith allows you to closely trace, monitor and evaluate your LLM application.It seamlessly integrates with LangChain and LangGraph, and you can use it to inspect and debug individual steps of your chains and agents as you build.LangSmith documentation is hosted on a separate site.You can peruse [LangSmith how-to guides here](https://docs.smith.langchain.com/how_to_guides/), but we'll highlight a few sections that are particularlyrelevant to LangChain below:### Evaluation<span data-heading-keywords="evaluation,evaluate"></span>Evaluating performance is a vital part of building LLM-powered applications.LangSmith helps with every step of the process from creating a dataset to defining metrics to running evaluators.To learn more, check out the [LangSmith evaluation how-to guides](https://docs.smith.langchain.com/how_to_guides#evaluation).### Tracing<span data-heading-keywords="trace,tracing"></span>Tracing gives you observability inside your chains and agents, and is vital in diagnosing issues.- [How to: trace with LangChain](https://docs.smith.langchain.com/how_to_guides/tracing/trace_with_langchain)- [How to: add metadata and tags to traces](https://docs.smith.langchain.com/how_to_guides/tracing/trace_with_langchain#add-metadata-and-tags-to-traces)You can see general tracing-related how-tos [in this section of the LangSmith docs](https://docs.smith.langchain.com/how_to_guides/tracing).