id stringlengths 14 15 | text stringlengths 22 2.51k | source stringlengths 60 153 |
|---|---|---|
493969d3cea8-0 | API Reference¶
langchain.agents: Agents¶
Interface for agents.
Classes¶
agents.agent.Agent
Class responsible for calling the language model and deciding the action.
agents.agent.AgentExecutor
Consists of an agent using tools.
agents.agent.AgentOutputParser
Create a new model by parsing and validating input data from ke... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-1 | Create a new model by parsing and validating input data from keyword arguments.
agents.agent_toolkits.openapi.planner.RequestsPostToolWithParsing
Create a new model by parsing and validating input data from keyword arguments.
agents.agent_toolkits.openapi.toolkit.OpenAPIToolkit
Toolkit for interacting with an OpenAPI A... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-2 | An agent designed to hold a conversation in addition to using tools.
agents.conversational_chat.output_parser.ConvoOutputParser
Create a new model by parsing and validating input data from keyword arguments.
agents.mrkl.base.ChainConfig(action_name, ...)
Configuration for chain to use in MRKL system.
agents.mrkl.base.M... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-3 | agents.structured_chat.output_parser.StructuredChatOutputParser
Create a new model by parsing and validating input data from keyword arguments.
agents.structured_chat.output_parser.StructuredChatOutputParserWithRetries
Create a new model by parsing and validating input data from keyword arguments.
agents.tools.InvalidT... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-4 | agents.agent_toolkits.sql.base.create_sql_agent(...)
Construct a sql agent from an LLM and tools.
agents.agent_toolkits.vectorstore.base.create_vectorstore_agent(...)
Construct a vectorstore agent from an LLM and tools.
agents.agent_toolkits.vectorstore.base.create_vectorstore_router_agent(...)
Construct a vectorstore ... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-5 | Cache that uses Redis as a vector-store backend.
cache.SQLAlchemyCache(engine, cache_schema)
Cache that uses SQAlchemy as a backend.
cache.SQLiteCache([database_path])
Cache that uses SQLite as a backend.
langchain.callbacks: Callbacks¶
Callback handlers that allow listening to events in LangChain.
Classes¶
callbacks.a... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-6 | callbacks.manager.AsyncCallbackManagerForChainRun(*, ...)
Async callback manager for chain run.
callbacks.manager.AsyncCallbackManagerForLLMRun(*, ...)
Async callback manager for LLM run.
callbacks.manager.AsyncCallbackManagerForRetrieverRun(*, ...)
Async callback manager for retriever run.
callbacks.manager.AsyncCallb... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-7 | callbacks.streaming_aiter.AsyncIteratorCallbackHandler()
Callback handler that returns an async iterator.
callbacks.streaming_aiter_final_only.AsyncFinalIteratorCallbackHandler(*)
Callback handler that returns an async iterator.
callbacks.streaming_stdout.StreamingStdOutCallbackHandler()
Callback handler for streaming.... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-8 | callbacks.tracers.schemas.Run
Run schema for the V2 API in the Tracer.
callbacks.tracers.schemas.ToolRun
Class for ToolRun.
callbacks.tracers.schemas.TracerSession
TracerSessionV1 schema for the V2 API.
callbacks.tracers.schemas.TracerSessionBase
A creation class for TracerSession.
callbacks.tracers.schemas.TracerSessi... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-9 | callbacks.infino_callback.import_infino()
Import the infino client.
callbacks.manager.env_var_is_set(env_var)
Check if an environment variable is set.
callbacks.manager.get_openai_callback()
Get the OpenAI callback handler in a context manager.
callbacks.manager.trace_as_chain_group(...)
Get a callback manager for a ch... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-10 | Get the headers for the LangChain API.
callbacks.tracers.stdout.elapsed(run)
Get the elapsed time of a run.
callbacks.tracers.stdout.try_json_stringify(...)
Try to stringify an object to JSON.
callbacks.utils.flatten_dict(nested_dict[, ...])
Flattens a nested dictionary into a flat dictionary.
callbacks.utils.hash_stri... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-11 | chains.api.openapi.requests_chain.APIRequesterOutputParser
Parse the request and error tags.
chains.api.openapi.response_chain.APIResponderChain
Get the response parser.
chains.api.openapi.response_chain.APIResponderOutputParser
Parse the response and error tags.
chains.base.Chain
Abstract base class for creating struc... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-12 | Chain for having a conversation based on retrieved documents.
chains.flare.base.FlareChain
Create a new model by parsing and validating input data from keyword arguments.
chains.flare.base.QuestionGeneratorChain
Create a new model by parsing and validating input data from keyword arguments.
chains.flare.prompts.Finishe... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-13 | Chain that interprets a prompt and executes python code to do math.
chains.llm_requests.LLMRequestsChain
Chain that hits a URL and then uses an LLM to parse results.
chains.llm_summarization_checker.base.LLMSummarizationCheckerChain
Chain for question-answering with self-verification.
chains.mapreduce.MapReduceChain
Ma... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-14 | chains.qa_with_sources.retrieval.RetrievalQAWithSourcesChain
Question-answering with sources over an index.
chains.qa_with_sources.vector_db.VectorDBQAWithSourcesChain
Question-answering with sources over a vector database.
chains.query_constructor.base.StructuredQueryOutputParser
Create a new model by parsing and vali... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-15 | Chain that outputs the name of a destination chain and the inputs to it.
chains.router.embedding_router.EmbeddingRouterChain
Class that uses embeddings to route between options.
chains.router.llm_router.LLMRouterChain
A router chain that uses an LLM chain to perform routing.
chains.router.llm_router.RouterOutputParser
... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-16 | Create an LLM chain that uses OpenAI functions.
chains.openai_functions.base.create_structured_output_chain(...)
Create an LLMChain that uses an OpenAI function to get a structured output.
chains.openai_functions.citation_fuzzy_match.create_citation_fuzzy_match_chain(llm)
Create a citation fuzzy match chain.
chains.ope... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-17 | Load a query constructor chain.
chains.query_constructor.parser.get_parser([...])
Returns a parser for the query language.
chains.question_answering.__init__.load_qa_chain(llm)
Load question answering chain.
chains.summarize.__init__.load_summarize_chain(llm)
Load summarizing chain.
langchain.chat_models: Chat Models¶
... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-18 | Run the language model on the example.
client.runner_utils.run_llm_or_chain(...[, ...])
Run the Chain or language model synchronously.
client.runner_utils.run_on_dataset(...[, ...])
Run the Chain or language model on a dataset and store traces to the specified project name.
client.runner_utils.run_on_examples(...[, ...... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-19 | Loading Documents from Azure Blob Storage.
document_loaders.azure_blob_storage_file.AzureBlobStorageFileLoader(...)
Loading Documents from Azure Blob Storage.
document_loaders.base.BaseBlobParser()
Abstract interface for blob parsers.
document_loaders.base.BaseLoader()
Interface for loading Documents.
document_loaders.... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-20 | Load Confluence pages.
document_loaders.confluence.ContentFormat(value)
Enumerator of the content formats of Confluence page.
document_loaders.conllu.CoNLLULoader(file_path)
Load CoNLL-U files.
document_loaders.csv_loader.CSVLoader(file_path)
Loads a CSV file into a list of documents.
document_loaders.csv_loader.Unstru... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-21 | document_loaders.embaas.EmbaasLoader
Embaas's document loader.
document_loaders.epub.UnstructuredEPubLoader(...)
Loader that uses unstructured to load epub files.
document_loaders.evernote.EverNoteLoader(...)
EverNote Loader.
document_loaders.excel.UnstructuredExcelLoader(...)
Loader that uses unstructured to load Micr... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-22 | document_loaders.html_bs.BSHTMLLoader(file_path)
Loader that uses beautiful soup to parse HTML files.
document_loaders.hugging_face_dataset.HuggingFaceDatasetLoader(path)
Load Documents from the Hugging Face Hub.
document_loaders.ifixit.IFixitLoader(web_path)
Load iFixit repair guides, device wikis and answers.
documen... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-23 | Loader that fetches data from Modern Treasury.
document_loaders.notebook.NotebookLoader(path)
Loader that loads .ipynb notebook files.
document_loaders.notion.NotionDirectoryLoader(path)
Loader that loads Notion directory dump.
document_loaders.notiondb.NotionDBLoader(...)
Notion DB Loader.
document_loaders.obsidian.Ob... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-24 | Language parser that split code using the respective language syntax.
document_loaders.parsers.language.python.PythonSegmenter(code)
The code segmenter for Python.
document_loaders.parsers.pdf.PDFMinerParser()
Parse PDFs with PDFMiner.
document_loaders.parsers.pdf.PDFPlumberParser([...])
Parse PDFs with PDFPlumber.
doc... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-25 | document_loaders.pdf.PyPDFium2Loader(file_path)
Loads a PDF with pypdfium2 and chunks at character level.
document_loaders.pdf.UnstructuredPDFLoader(...)
Loader that uses unstructured to load PDF files.
document_loaders.powerpoint.UnstructuredPowerPointLoader(...)
Loader that uses unstructured to load powerpoint files.... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-26 | Loads a query result from Snowflake into a list of documents.
document_loaders.spreedly.SpreedlyLoader(...)
Loader that fetches data from Spreedly API.
document_loaders.srt.SRTLoader(file_path)
Loader for .srt (subtitle) files.
document_loaders.stripe.StripeLoader(resource)
Loader that fetches data from Stripe.
documen... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-27 | document_loaders.unstructured.UnstructuredFileLoader(...)
UnstructuredFileLoader uses unstructured to load files.
document_loaders.url.UnstructuredURLLoader(urls)
Loader that uses unstructured to load HTML files.
document_loaders.url_playwright.PlaywrightURLLoader(urls)
Loader that uses Playwright and to load a page an... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-28 | Combine cells information in a readable format ready to be used.
document_loaders.notebook.remove_newlines(x)
Remove recursively newlines, no matter the data structure they are stored in.
document_loaders.parsers.registry.get_parser(...)
Get a parser by parser name.
document_loaders.telegram.concatenate_rows(row)
Combi... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-29 | Interface for embedding models.
embeddings.bedrock.BedrockEmbeddings
Embeddings provider to invoke Bedrock embedding models.
embeddings.clarifai.ClarifaiEmbeddings
Wrapper around Clarifai embedding models.
embeddings.cohere.CohereEmbeddings
Wrapper around Cohere embedding models.
embeddings.dashscope.DashScopeEmbedding... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-30 | Wrapper around MosaicML's embedding inference service.
embeddings.octoai_embeddings.OctoAIEmbeddings
Wrapper around OctoAI Compute Service embedding models.
embeddings.openai.OpenAIEmbeddings
Wrapper around OpenAI embedding models.
embeddings.sagemaker_endpoint.EmbeddingsContentHandler()
Content handler for LLM class.
... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-31 | langchain.evaluation: Evaluation¶
Evaluation chains for grading LLM and Chain outputs.
This module contains off-the-shelf evaluation chains for grading the output of
LangChain primitives such as language models and chains.
To load an evaluator, you can use the load_evaluators function with the
names of the evaluators t... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-32 | A parser for the output of the PairwiseStringEvalChain.
evaluation.criteria.eval_chain.CriteriaEvalChain
LLM Chain for evaluating runs against criteria.
evaluation.criteria.eval_chain.CriteriaResultOutputParser
A parser for the output of the CriteriaEvalChain.
evaluation.qa.eval_chain.ContextQAEvalChain
LLM Chain speci... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-33 | evaluation.schema.StringEvaluator()
Protocol for evaluating strings.
Functions¶
evaluation.loading.load_dataset(uri)
Load a dataset from the LangChainDatasets HuggingFace org.
evaluation.loading.load_evaluator(evaluator, *)
Load the requested evaluation chain specified by a string.
evaluation.loading.load_evaluators(ev... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-34 | experimental.autonomous_agents.baby_agi.baby_agi.BabyAGI
Controller model for the BabyAGI agent.
experimental.autonomous_agents.baby_agi.task_creation.TaskCreationChain
Chain to generates tasks.
experimental.autonomous_agents.baby_agi.task_execution.TaskExecutionChain
Chain to execute tasks.
experimental.autonomous_age... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-35 | experimental.plan_and_execute.schema.Plan
Create a new model by parsing and validating input data from keyword arguments.
experimental.plan_and_execute.schema.PlanOutputParser
Create a new model by parsing and validating input data from keyword arguments.
experimental.plan_and_execute.schema.Step
Create a new model by ... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-36 | indexes.vectorstore.VectorstoreIndexCreator
Logic for creating indexes.
langchain.input: Input¶
Handle chained inputs.
Functions¶
input.get_bolded_text(text)
Get bolded text.
input.get_color_mapping(items[, excluded_colors])
Get mapping for items to a support color.
input.get_colored_text(text, color)
Get colored text.... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-37 | Wrapper around Banana large language models.
llms.base.BaseLLM
LLM wrapper should take in a prompt and return a string.
llms.base.LLM
LLM class that expect subclasses to implement a simpler call method.
llms.baseten.Baseten
Use your Baseten models in Langchain
llms.beam.Beam
Wrapper around Beam API for gpt2 large langu... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-38 | llms.huggingface_pipeline.HuggingFacePipeline
Wrapper around HuggingFace Pipeline API.
llms.huggingface_text_gen_inference.HuggingFaceTextGenInference
HuggingFace text generation inference API.
llms.human.HumanInputLLM
A LLM wrapper which returns user input as the response.
llms.llamacpp.LlamaCpp
Wrapper around the lla... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-39 | Wrapper around OpenAI large language models.
llms.promptlayer_openai.PromptLayerOpenAIChat
Wrapper around OpenAI large language models.
llms.replicate.Replicate
Wrapper around Replicate models.
llms.rwkv.RWKV
Wrapper around RWKV language models.
llms.sagemaker_endpoint.ContentHandlerBase()
A handler class to transform ... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-40 | llms.cohere.completion_with_retry(llm, **kwargs)
Use tenacity to retry the completion call.
llms.databricks.get_default_api_token()
Gets the default Databricks personal access token.
llms.databricks.get_default_host()
Gets the default Databricks workspace hostname.
llms.databricks.get_repl_context()
Gets the notebook R... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-41 | load.dump.dumps(obj, *[, pretty])
Return a json string representation of an object.
load.load.loads(text, *[, secrets_map])
Load a JSON object from a string.
load.serializable.to_json_not_implemented(obj)
Serialize a "not implemented" object.
langchain.math_utils: Math Utils¶
Math utils.
Functions¶
math_utils.cosine_si... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-42 | memory.chat_message_histories.mongodb.MongoDBChatMessageHistory(...)
Chat message history that stores history in MongoDB.
memory.chat_message_histories.postgres.PostgresChatMessageHistory(...)
Chat message history stored in a Postgres database.
memory.chat_message_histories.redis.RedisChatMessageHistory(...)
Chat messa... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-43 | Class for a VectorStore-backed memory object.
Functions¶
memory.chat_message_histories.sql.create_message_model(...)
Create a message model for a given table name.
memory.utils.get_prompt_input_key(inputs, ...)
Get the prompt input key.
langchain.output_parsers: Output Parsers¶
Classes¶
output_parsers.boolean.BooleanOu... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-44 | output_parsers.rail_parser.GuardrailsOutputParser
Create a new model by parsing and validating input data from keyword arguments.
output_parsers.regex.RegexParser
Class to parse the output into a dictionary.
output_parsers.regex_dict.RegexDictParser
Class to parse the output into a dictionary.
output_parsers.retry.Retr... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-45 | Create a new model by parsing and validating input data from keyword arguments.
prompts.chat.ChatPromptTemplate
Create a new model by parsing and validating input data from keyword arguments.
prompts.chat.ChatPromptValue
Create a new model by parsing and validating input data from keyword arguments.
prompts.chat.HumanM... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-46 | Validate that the input variables are valid for the template.
prompts.example_selector.ngram_overlap.ngram_overlap_score(...)
Compute ngram overlap score of source and example as sentence_bleu score.
prompts.example_selector.semantic_similarity.sorted_values(values)
Return a list of values in dict sorted by key.
prompt... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-47 | retrievers.document_compressors.chain_extract.LLMChainExtractor
Create a new model by parsing and validating input data from keyword arguments.
retrievers.document_compressors.chain_extract.NoOutputParser
Parse outputs that could return a null string of some sort.
retrievers.document_compressors.chain_filter.LLMChainFi... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-48 | retrievers.kendra.RetrieveResultItem
Create a new model by parsing and validating input data from keyword arguments.
retrievers.kendra.TextWithHighLights
Create a new model by parsing and validating input data from keyword arguments.
retrievers.knn.KNNRetriever
KNN Retriever.
retrievers.llama_index.LlamaIndexGraphRetri... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-49 | retrievers.self_query.chroma.ChromaTranslator()
Logic for converting internal query language elements to valid filters.
retrievers.self_query.myscale.MyScaleTranslator([...])
Logic for converting internal query language elements to valid filters.
retrievers.self_query.pinecone.PineconeTranslator()
Logic for converting ... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-50 | retrievers.kendra.clean_excerpt(excerpt)
Cleans an excerpt from Kendra.
retrievers.kendra.combined_text(title, excerpt)
Combines a title and an excerpt into a single string.
retrievers.knn.create_index(contexts, embeddings)
Create an index of embeddings for a list of contexts.
retrievers.milvus.MilvusRetreiver(*args, .... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-51 | A Message that can be assigned an arbitrary speaker (i.e.
schema.messages.FunctionMessage
A Message for passing the result of executing a function back to a model.
schema.messages.HumanMessage
A Message from a human.
schema.messages.SystemMessage
A Message for priming AI behavior, usually passed in as the first of a se... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-52 | Format a document into a string based on a prompt template.
langchain.server: Server¶
Script to run langchain-server locally using docker-compose.
Functions¶
server.main()
Run the langchain server locally.
langchain.sql_database: Sql Database¶
SQLAlchemy wrapper around a database.
Functions¶
sql_database.truncate_word(... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-53 | Interface for splitting text into chunks.
text_splitter.TokenTextSplitter([...])
Implementation of splitting text that looks at tokens.
Functions¶
text_splitter.split_text_on_tokens(*, text, ...)
Split incoming text and return chunks.
langchain.tools: Tools¶
Core toolkit implementations.
Classes¶
tools.arxiv.tool.Arxiv... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-54 | tools.convert_to_openai.FunctionDescription
Representation of a callable function to the OpenAI API.
tools.dataforseo_api_search.tool.DataForSeoAPISearchResults
Tool that has capability to query the DataForSeo Google Search API and get back json.
tools.dataforseo_api_search.tool.DataForSeoAPISearchRun
Tool that adds th... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-55 | Mixin for file system tools.
tools.file_management.utils.FileValidationError
Error for paths outside the root directory.
tools.file_management.write.WriteFileInput
Input for WriteFileTool.
tools.file_management.write.WriteFileTool
Create a new model by parsing and validating input data from keyword arguments.
tools.gma... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-56 | tools.google_search.tool.GoogleSearchResults
Tool that has capability to query the Google Search API and get back json.
tools.google_search.tool.GoogleSearchRun
Tool that adds the capability to query the Google search API.
tools.google_serper.tool.GoogleSerperResults
Tool that has capability to query the Serper.dev Goo... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-57 | Class for searching email messages in Office 365
tools.office365.messages_search.SearchEmailsInput
Input for SearchEmails Tool.
tools.office365.send_event.O365SendEvent
Create a new model by parsing and validating input data from keyword arguments.
tools.office365.send_event.SendEventSchema
Input for CreateEvent Tool.
... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-58 | Create a new model by parsing and validating input data from keyword arguments.
tools.playwright.get_elements.GetElementsTool
Create a new model by parsing and validating input data from keyword arguments.
tools.playwright.get_elements.GetElementsToolInput
Input for GetElementsTool.
tools.playwright.navigate.NavigateTo... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-59 | Tool for making a POST request to an API endpoint.
tools.requests.tool.RequestsPutTool
Tool for making a PUT request to an API endpoint.
tools.scenexplain.tool.SceneXplainInput
Input for SceneXplain.
tools.scenexplain.tool.SceneXplainTool
Tool that adds the capability to explain images.
tools.searx_search.tool.SearxSea... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-60 | tools.steamship_image_generation.tool.SteamshipImageGenerationTool
Tool used to generate images from a text-prompt.
tools.vectorstore.tool.BaseVectorStoreTool
Base class for tools that use a VectorStore.
tools.vectorstore.tool.VectorStoreQATool
Tool for the VectorDBQA chain.
tools.vectorstore.tool.VectorStoreQAWithSour... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-61 | tools.file_management.utils.is_relative_to(...)
Check if path is relative to root.
tools.gmail.utils.build_resource_service([...])
Build a Gmail service.
tools.gmail.utils.clean_email_body(body)
Clean email body.
tools.gmail.utils.get_gmail_credentials([...])
Get credentials.
tools.gmail.utils.import_google()
Import go... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-62 | utilities.bibtex.BibtexparserWrapper
Wrapper around bibtexparser.
utilities.bing_search.BingSearchAPIWrapper
Wrapper for Bing Search API.
utilities.brave_search.BraveSearchWrapper
Create a new model by parsing and validating input data from keyword arguments.
utilities.dataforseo_api_search.DataForSeoAPIWrapper
Create ... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-63 | Wrapper for Searx API.
utilities.serpapi.SerpAPIWrapper
Wrapper around SerpAPI.
utilities.twilio.TwilioAPIWrapper
Messaging Client using Twilio.
utilities.wikipedia.WikipediaAPIWrapper
Wrapper around WikipediaAPI.
utilities.wolfram_alpha.WolframAlphaAPIWrapper
Wrapper for Wolfram Alpha.
utilities.zapier.ZapierNLAWrappe... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-64 | utils.xor_args(*arg_groups)
Validate specified keyword args are mutually exclusive.
langchain.vectorstores: Vectorstores¶
Wrappers on top of vector stores.
Classes¶
vectorstores.alibabacloud_opensearch.AlibabaCloudOpenSearch(...)
Alibaba Cloud OpenSearch Vector Store
vectorstores.analyticdb.AnalyticDB(...[, ...])
Vecto... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-65 | Initialize a vector store from DocArray's DocIndex.
vectorstores.docarray.hnsw.DocArrayHnswSearch(...)
Wrapper around HnswLib storage.
vectorstores.docarray.in_memory.DocArrayInMemorySearch(...)
Wrapper around in-memory storage for exact search.
vectorstores.elastic_vector_search.ElasticKnnSearch(...)
A class for perfo... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-66 | A simple constructor that allows initialization from kwargs.
vectorstores.pgembedding.PGEmbedding(...[, ...])
VectorStore implementation using Postgres and the pg_embedding extension. pg_embedding uses sequential scan by default. but you can create a HNSW index using the create_hnsw_index method. - connection_string is... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-67 | Retriever for SingleStoreDB vector stores.
vectorstores.sklearn.BaseSerializer(persist_path)
Abstract base class for saving and loading data.
vectorstores.sklearn.BsonSerializer(persist_path)
Serializes data in binary json using the bson python package.
vectorstores.sklearn.JsonSerializer(persist_path)
Serializes data ... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
493969d3cea8-68 | vectorstores.alibabacloud_opensearch.create_metadata(fields)
Create metadata from fields.
vectorstores.annoy.dependable_annoy_import()
Import annoy if available, otherwise raise error.
vectorstores.clickhouse.has_mul_sub_str(s, *args)
Check if a string contains multiple substrings.
vectorstores.faiss.dependable_faiss_i... | rtdocs\api.python.langchain.com\en\latest\api_reference.html |
9490b74704e2-0 | langchain.agents.agent.Agent¶
class langchain.agents.agent.Agent(*, llm_chain: LLMChain, output_parser: AgentOutputParser, allowed_tools: Optional[List[str]] = None)[source]¶
Bases: BaseSingleActionAgent
Class responsible for calling the language model and deciding the action.
This is driven by an LLMChain. The prompt ... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.Agent.html |
9490b74704e2-1 | Construct an agent from an LLM and tools.
get_allowed_tools() → Optional[List[str]][source]¶
get_full_inputs(intermediate_steps: List[Tuple[AgentAction, str]], **kwargs: Any) → Dict[str, Any][source]¶
Create the full inputs for the LLMChain from intermediate steps.
plan(intermediate_steps: List[Tuple[AgentAction, str]]... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.Agent.html |
b305acf0700a-0 | langchain.agents.agent.AgentExecutor¶
class langchain.agents.agent.AgentExecutor(*, memory: Optional[BaseMemory] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallbackManager] = None, verbose: bool = None, tags: Optional[List[str]] = None, meta... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.AgentExecutor.html |
b305acf0700a-1 | returns AgentFinish. Either ‘force’ or ‘generate’.
“force” returns a string saying that it stopped because it met atime or iteration limit.
“generate” calls the agent’s LLM Chain one final time to generatea final answer based on the previous steps.
param handle_parsing_errors: Union[bool, str, Callable[[OutputParserExc... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.AgentExecutor.html |
b305acf0700a-2 | You can use these to eg identify a specific instance of a chain with its use case.
param return_intermediate_steps: bool = False¶
Whether to return the agent’s trajectory of intermediate steps
at the end in addition to the final output.
param tags: Optional[List[str]] = None¶
Optional list of tags associated with the c... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.AgentExecutor.html |
b305acf0700a-3 | addition to callbacks passed to the chain during construction, but only
these runtime callbacks will propagate to calls to other objects.
tags – List of string tags to pass to all callbacks. These will be passed in
addition to tags passed to the chain during construction, but only
these runtime tags will propagate to c... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.AgentExecutor.html |
b305acf0700a-4 | these runtime tags will propagate to calls to other objects.
metadata – Optional metadata associated with the chain. Defaults to None
include_run_info – Whether to include run info in the response. Defaults
to False.
Returns
A dict of named outputs. Should contain all outputs specified inChain.output_keys.
apply(input_... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.AgentExecutor.html |
b305acf0700a-5 | these runtime tags will propagate to calls to other objects.
**kwargs – If the chain expects multiple inputs, they can be passed in
directly as keyword arguments.
Returns
The chain output as a string.
Example
# Suppose we have a single-input chain that takes a 'question' string:
await chain.arun("What's the temperature... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.AgentExecutor.html |
b305acf0700a-6 | Parameters
inputs – Dictionary of raw inputs, or single input if chain expects
only one param. Should contain all inputs specified in
Chain.input_keys except for inputs that will be set by the chain’s
memory.
Returns
A dictionary of all inputs, including those added by the chain’s memory.
prep_outputs(inputs: Dict[str,... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.AgentExecutor.html |
b305acf0700a-7 | sole positional argument.
callbacks – Callbacks to use for this chain run. These will be called in
addition to callbacks passed to the chain during construction, but only
these runtime callbacks will propagate to calls to other objects.
tags – List of string tags to pass to all callbacks. These will be passed in
additi... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.AgentExecutor.html |
b305acf0700a-8 | Validate that tools are compatible with agent.
property lc_attributes: Dict¶
Return a list of attribute names that should be included in the
serialized kwargs. These attributes must be accepted by the
constructor.
property lc_namespace: List[str]¶
Return the namespace of the langchain object.
eg. [“langchain”, “llms”, ... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.AgentExecutor.html |
66247dff494a-0 | langchain.agents.agent.AgentOutputParser¶
class langchain.agents.agent.AgentOutputParser[source]¶
Bases: BaseOutputParser
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
dict(**kwargs: Any) → Dict¶
Return di... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.AgentOutputParser.html |
66247dff494a-1 | property lc_namespace: List[str]¶
Return the namespace of the langchain object.
eg. [“langchain”, “llms”, “openai”]
property lc_secrets: Dict[str, str]¶
Return a map of constructor argument names to secret ids.
eg. {“openai_api_key”: “OPENAI_API_KEY”}
property lc_serializable: bool¶
Return whether or not the class is s... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.AgentOutputParser.html |
0fb9a1466f42-0 | langchain.agents.agent.BaseMultiActionAgent¶
class langchain.agents.agent.BaseMultiActionAgent[source]¶
Bases: BaseModel
Base Agent class.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
abstract async aplan... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.BaseMultiActionAgent.html |
0fb9a1466f42-1 | Parameters
file_path – Path to file to save the agent to.
Example:
.. code-block:: python
# If working with agent executor
agent.agent.save(file_path=”path/agent.yaml”)
tool_run_logging_kwargs() → Dict[source]¶
property return_values: List[str]¶
Return values of the agent. | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.BaseMultiActionAgent.html |
246f38ec671d-0 | langchain.agents.agent.BaseSingleActionAgent¶
class langchain.agents.agent.BaseSingleActionAgent[source]¶
Bases: BaseModel
Base Agent class.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
abstract async apl... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.BaseSingleActionAgent.html |
246f38ec671d-1 | Return response when agent has been stopped due to max iterations.
save(file_path: Union[Path, str]) → None[source]¶
Save the agent.
Parameters
file_path – Path to file to save the agent to.
Example:
.. code-block:: python
# If working with agent executor
agent.agent.save(file_path=”path/agent.yaml”)
tool_run_logging_k... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.BaseSingleActionAgent.html |
2c5652af5959-0 | langchain.agents.agent.ExceptionTool¶
class langchain.agents.agent.ExceptionTool(*, name: str = '_Exception', description: str = 'Exception tool', args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.ExceptionTool.html |
2c5652af5959-1 | param name: str = '_Exception'¶
The unique name of the tool that clearly communicates its purpose.
param return_direct: bool = False¶
Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the AgentExecutor will stop looping.
param tags: Optional[List[str]] = None¶
Optio... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.ExceptionTool.html |
2c5652af5959-2 | Run the tool.
property args: dict¶
property is_single_input: bool¶
Whether the tool only accepts a single input.
model Config¶
Bases: object
Configuration for this pydantic object.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.ExceptionTool.html |
c098e47a5604-0 | langchain.agents.agent.LLMSingleActionAgent¶
class langchain.agents.agent.LLMSingleActionAgent(*, llm_chain: LLMChain, output_parser: AgentOutputParser, stop: List[str])[source]¶
Bases: BaseSingleActionAgent
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the in... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.LLMSingleActionAgent.html |
c098e47a5604-1 | Parameters
intermediate_steps – Steps the LLM has taken to date,
along with observations
callbacks – Callbacks to run.
**kwargs – User inputs.
Returns
Action specifying what tool to use.
return_stopped_response(early_stopping_method: str, intermediate_steps: List[Tuple[AgentAction, str]], **kwargs: Any) → AgentFinish¶
... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent.LLMSingleActionAgent.html |
f05dd761d0a5-0 | langchain.agents.agent_toolkits.azure_cognitive_services.toolkit.AzureCognitiveServicesToolkit¶
class langchain.agents.agent_toolkits.azure_cognitive_services.toolkit.AzureCognitiveServicesToolkit[source]¶
Bases: BaseToolkit
Toolkit for Azure Cognitive Services.
Create a new model by parsing and validating input data f... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent_toolkits.azure_cognitive_services.toolkit.AzureCognitiveServicesToolkit.html |
c9ca8b5a4ee1-0 | langchain.agents.agent_toolkits.base.BaseToolkit¶
class langchain.agents.agent_toolkits.base.BaseToolkit[source]¶
Bases: BaseModel, ABC
Class representing a collection of related tools.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be par... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent_toolkits.base.BaseToolkit.html |
6223d839e8b3-0 | langchain.agents.agent_toolkits.csv.base.create_csv_agent¶
langchain.agents.agent_toolkits.csv.base.create_csv_agent(llm: BaseLanguageModel, path: Union[str, List[str]], pandas_kwargs: Optional[dict] = None, **kwargs: Any) → AgentExecutor[source]¶
Create csv agent by loading to a dataframe and using pandas agent. | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent_toolkits.csv.base.create_csv_agent.html |
eb103b9f1a65-0 | langchain.agents.agent_toolkits.file_management.toolkit.FileManagementToolkit¶
class langchain.agents.agent_toolkits.file_management.toolkit.FileManagementToolkit(*, root_dir: Optional[str] = None, selected_tools: Optional[List[str]] = None)[source]¶
Bases: BaseToolkit
Toolkit for interacting with a Local Files.
Create... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent_toolkits.file_management.toolkit.FileManagementToolkit.html |
c950dc21722c-0 | langchain.agents.agent_toolkits.gmail.toolkit.GmailToolkit¶
class langchain.agents.agent_toolkits.gmail.toolkit.GmailToolkit(*, api_resource: Resource = None)[source]¶
Bases: BaseToolkit
Toolkit for interacting with Gmail.
Create a new model by parsing and validating input data from keyword arguments.
Raises Validation... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent_toolkits.gmail.toolkit.GmailToolkit.html |
35b1ffa5a846-0 | langchain.agents.agent_toolkits.jira.toolkit.JiraToolkit¶
class langchain.agents.agent_toolkits.jira.toolkit.JiraToolkit(*, tools: List[BaseTool] = [])[source]¶
Bases: BaseToolkit
Jira Toolkit.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data canno... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent_toolkits.jira.toolkit.JiraToolkit.html |
24a96c091141-0 | langchain.agents.agent_toolkits.json.base.create_json_agent¶ | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent_toolkits.json.base.create_json_agent.html |
24a96c091141-1 | langchain.agents.agent_toolkits.json.base.create_json_agent(llm: BaseLanguageModel, toolkit: JsonToolkit, callback_manager: Optional[BaseCallbackManager] = None, prefix: str = 'You are an agent designed to interact with JSON.\nYour goal is to return a final answer by interacting with the JSON.\nYou have access to the f... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent_toolkits.json.base.create_json_agent.html |
24a96c091141-2 | to see what keys exist at that path.\nDo not simply refer the user to the JSON or a section of the JSON, as this is not a valid answer. Keep digging until you find the answer and explicitly return it.\n', suffix: str = 'Begin!"\n\nQuestion: {input}\nThought: I should look at the keys that exist in data to see what I ha... | rtdocs\api.python.langchain.com\en\latest\agents\langchain.agents.agent_toolkits.json.base.create_json_agent.html |
End of preview. Expand in Data Studio
No dataset card yet
- Downloads last month
- 2