id stringlengths 14 16 | text stringlengths 31 2.41k | source stringlengths 53 121 |
|---|---|---|
5d97bfd0cb46-159 | inputs (Dict[str, str]) –
outputs (Dict[str, str]) –
return_only_outputs (bool) –
Return type
Dict[str, str]
run(*args, callbacks=None, tags=None, **kwargs)
Run the chain as text in, text out or multiple variables, text out.
Parameters
args (Any) –
callbacks (Optional[Union[List[langchain.callbacks.base.BaseCallba... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-160 | property lc_serializable: bool
Return whether or not the class is serializable.
property output_keys: List[str]
Output keys this chain expects.
class langchain.chains.QAWithSourcesChain(*, memory=None, callbacks=None, callback_manager=None, verbose=None, tags=None, combine_documents_chain, question_key='question', in... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-161 | Chain to use to combine documents.
attribute memory: Optional[BaseMemory] = None
Optional memory object. Defaults to None.
Memory is a class that gets called at the start
and at the end of every chain. At the start, memory loads variables and passes
them along in the chain. At the end, it saves any returned variables.... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-162 | use the callbacks provided to the chain.
include_run_info (bool) – Whether to include run info in the response. Defaults
to False.
tags (Optional[List[str]]) –
Return type
Dict[str, Any]
apply(input_list, callbacks=None)
Call the chain on all inputs in the list.
Parameters
input_list (List[Dict[str, Any]]) –
callbac... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-163 | classmethod from_llm(llm, document_prompt=PromptTemplate(input_variables=['page_content', 'source'], output_parser=None, partial_variables={}, template='Content: {page_content}\nSource: {source}', template_format='f-string', validate_template=True), question_prompt=PromptTemplate(input_variables=['context', 'question']... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-164 | of this Agreement shall not affect the continuation in force of the remainder of the term (if any) and this Agreement.\n\n11.8 No Agency. Except as expressly stated otherwise, nothing in this Agreement shall create an agency, partnership or joint venture of any kind between the parties.\n\n11.9 No Third-Party Benefic... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-165 | their fearlessness, their courage, their determination, inspires the world. \n\nGroups of citizens blocking tanks with their bodies. Everyone from students to retirees teachers turned soldiers defending their homeland.\nSource: 0-pl\nContent: And we won’t stop. \n\nWe have lost so much to COVID-19. Time with one anothe... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-166 | you, as I’ve always promised. A Russian dictator, invading a foreign country, has costs around the world. \n\nAnd I’m taking robust action to make sure the pain of our sanctions is targeted at Russia’s economy. And I will use every tool at our disposal to protect American businesses and consumers. \n\nTonight, I can a... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-167 | \n\nNow is the hour. \n\nOur moment of responsibility. \n\nOur test of resolve and conscience, of history itself. \n\nIt is in this moment that our character is formed. Our purpose is found. Our future is forged. \n\nWell I know this nation.\nSource: 34-pl\n=========\nFINAL ANSWER: The president did not mention Michael... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-168 | Construct the chain from an LLM.
Parameters
llm (langchain.base_language.BaseLanguageModel) –
document_prompt (langchain.prompts.base.BasePromptTemplate) –
question_prompt (langchain.prompts.base.BasePromptTemplate) –
combine_prompt (langchain.prompts.base.BasePromptTemplate) –
kwargs (Any) –
Return type
langchain... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-169 | Return type
langchain.load.serializable.SerializedNotImplemented
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. [“la... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-170 | verbose (bool) –
tags (Optional[List[str]]) –
combine_documents_chain (langchain.chains.combine_documents.base.BaseCombineDocumentsChain) –
input_key (str) –
output_key (str) –
return_source_documents (bool) –
retriever (langchain.schema.BaseRetriever) –
Return type
None
attribute callback_manager: Optional[Base... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-171 | attribute verbose: bool [Optional]
Whether or not run in verbose mode. In verbose mode, some intermediate logs
will be printed to the console. Defaults to langchain.verbose value.
async acall(inputs, return_only_outputs=False, callbacks=None, *, tags=None, include_run_info=False)
Run the logic of this chain and add t... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-172 | tags (Optional[List[str]]) –
kwargs (Any) –
Return type
str
dict(**kwargs)
Return dictionary representation of chain.
Parameters
kwargs (Any) –
Return type
Dict
classmethod from_chain_type(llm, chain_type='stuff', chain_type_kwargs=None, **kwargs)
Load chain from chain type.
Parameters
llm (langchain.base_language... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-173 | tags (Optional[List[str]]) –
kwargs (Any) –
Return type
str
save(file_path)
Save the chain.
Parameters
file_path (Union[pathlib.Path, str]) – Path to file to save the chain to.
Return type
None
Example:
.. code-block:: python
chain.save(file_path=”path/chain.yaml”)
to_json()
Return type
Union[langchain.load.seriali... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-174 | Parameters
memory (Optional[langchain.schema.BaseMemory]) –
callbacks (Optional[Union[List[langchain.callbacks.base.BaseCallbackHandler], langchain.callbacks.base.BaseCallbackManager]]) –
callback_manager (Optional[langchain.callbacks.base.BaseCallbackManager]) –
verbose (bool) –
tags (Optional[List[str]]) –
combi... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-175 | and at the end of every chain. At the start, memory loads variables and passes
them along in the chain. At the end, it saves any returned variables.
There are many different types of memory - please see memory docs
for the full catalog.
attribute reduce_k_below_max_tokens: bool = False
Reduce the number of results to ... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-176 | use the callbacks provided to the chain.
include_run_info (bool) – Whether to include run info in the response. Defaults
to False.
tags (Optional[List[str]]) –
Return type
Dict[str, Any]
apply(input_list, callbacks=None)
Call the chain on all inputs in the list.
Parameters
input_list (List[Dict[str, Any]]) –
callbac... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-177 | classmethod from_llm(llm, document_prompt=PromptTemplate(input_variables=['page_content', 'source'], output_parser=None, partial_variables={}, template='Content: {page_content}\nSource: {source}', template_format='f-string', validate_template=True), question_prompt=PromptTemplate(input_variables=['context', 'question']... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-178 | of this Agreement shall not affect the continuation in force of the remainder of the term (if any) and this Agreement.\n\n11.8 No Agency. Except as expressly stated otherwise, nothing in this Agreement shall create an agency, partnership or joint venture of any kind between the parties.\n\n11.9 No Third-Party Benefic... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-179 | their fearlessness, their courage, their determination, inspires the world. \n\nGroups of citizens blocking tanks with their bodies. Everyone from students to retirees teachers turned soldiers defending their homeland.\nSource: 0-pl\nContent: And we won’t stop. \n\nWe have lost so much to COVID-19. Time with one anothe... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-180 | you, as I’ve always promised. A Russian dictator, invading a foreign country, has costs around the world. \n\nAnd I’m taking robust action to make sure the pain of our sanctions is targeted at Russia’s economy. And I will use every tool at our disposal to protect American businesses and consumers. \n\nTonight, I can a... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-181 | \n\nNow is the hour. \n\nOur moment of responsibility. \n\nOur test of resolve and conscience, of history itself. \n\nIt is in this moment that our character is formed. Our purpose is found. Our future is forged. \n\nWell I know this nation.\nSource: 34-pl\n=========\nFINAL ANSWER: The president did not mention Michael... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-182 | Construct the chain from an LLM.
Parameters
llm (langchain.base_language.BaseLanguageModel) –
document_prompt (langchain.prompts.base.BasePromptTemplate) –
question_prompt (langchain.prompts.base.BasePromptTemplate) –
combine_prompt (langchain.prompts.base.BasePromptTemplate) –
kwargs (Any) –
Return type
langchain... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-183 | Return type
langchain.load.serializable.SerializedNotImplemented
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. [“la... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-184 | for full details.
attribute memory: Optional[BaseMemory] = None
Optional memory object. Defaults to None.
Memory is a class that gets called at the start
and at the end of every chain. At the start, memory loads variables and passes
them along in the chain. At the end, it saves any returned variables.
There are many d... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-185 | to False.
tags (Optional[List[str]]) –
Return type
Dict[str, Any]
apply(input_list, callbacks=None)
Call the chain on all inputs in the list.
Parameters
input_list (List[Dict[str, Any]]) –
callbacks (Optional[Union[List[langchain.callbacks.base.BaseCallbackHandler], langchain.callbacks.base.BaseCallbackManager]]) – ... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-186 | Parameters
inputs (Dict[str, Any]) –
callbacks (Optional[Union[List[langchain.callbacks.base.BaseCallbackHandler], langchain.callbacks.base.BaseCallbackManager]]) –
Return type
langchain.chains.router.base.Route
run(*args, callbacks=None, tags=None, **kwargs)
Run the chain as text in, text out or multiple variables,... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-187 | property lc_serializable: bool
Return whether or not the class is serializable.
property output_keys: List[str]
Output keys this chain expects.
class langchain.chains.SQLDatabaseChain(*, memory=None, callbacks=None, callback_manager=None, verbose=None, tags=None, llm_chain, llm=None, database, prompt=None, top_k=5, i... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-188 | Return type
None
attribute callback_manager: Optional[BaseCallbackManager] = None
Deprecated, use callbacks instead.
attribute callbacks: Callbacks = None
Optional list of callback handlers (or callback manager). Defaults to None.
Callback handlers are called throughout the lifecycle of a call to a chain,
starting wi... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-189 | These tags will be associated with each call to this chain,
and passed as arguments to the handlers defined in callbacks.
You can use these to eg identify a specific instance of a chain with its use case.
attribute top_k: int = 5
Number of results to return from the query
attribute use_query_checker: bool = False
Whe... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-190 | Parameters
input_list (List[Dict[str, Any]]) –
callbacks (Optional[Union[List[langchain.callbacks.base.BaseCallbackHandler], langchain.callbacks.base.BaseCallbackManager]]) –
Return type
List[Dict[str, str]]
async arun(*args, callbacks=None, tags=None, **kwargs)
Run the chain as text in, text out or multiple variabl... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-191 | Parameters
args (Any) –
callbacks (Optional[Union[List[langchain.callbacks.base.BaseCallbackHandler], langchain.callbacks.base.BaseCallbackManager]]) –
tags (Optional[List[str]]) –
kwargs (Any) –
Return type
str
save(file_path)
Save the chain.
Parameters
file_path (Union[pathlib.Path, str]) – Path to file to save ... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-192 | Chain for querying SQL database that is a sequential chain.
The chain is as follows:
1. Based on the query, determine which tables to use.
2. Based on those tables, call the normal SQL database chain.
This is useful in cases where the number of tables in the database is large.
Parameters
memory (Optional[langchain.sche... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-193 | There are many different types of memory - please see memory docs
for the full catalog.
attribute return_intermediate_steps: bool = False
attribute sql_chain: SQLDatabaseChain [Required]
attribute tags: Optional[List[str]] = None
Optional list of tags associated with the chain. Defaults to None
These tags will be as... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-194 | Call the chain on all inputs in the list.
Parameters
input_list (List[Dict[str, Any]]) –
callbacks (Optional[Union[List[langchain.callbacks.base.BaseCallbackHandler], langchain.callbacks.base.BaseCallbackManager]]) –
Return type
List[Dict[str, str]]
async arun(*args, callbacks=None, tags=None, **kwargs)
Run the chai... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-195 | Parameters
kwargs (Any) –
Return type
Dict
classmethod from_llm(llm, database, query_prompt=PromptTemplate(input_variables=['input', 'table_info', 'dialect', 'top_k'], output_parser=None, partial_variables={}, template='Given an input question, first create a syntactically correct {dialect} query to run, then look at ... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-196 | Parameters
llm (langchain.base_language.BaseLanguageModel) –
database (langchain.sql_database.SQLDatabase) –
query_prompt (langchain.prompts.base.BasePromptTemplate) –
decider_prompt (langchain.prompts.base.BasePromptTemplate) –
kwargs (Any) –
Return type
langchain.chains.sql_database.base.SQLDatabaseSequentialCha... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-197 | langchain.load.serializable.SerializedNotImplemented
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”, “l... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-198 | Callback handlers are called throughout the lifecycle of a call to a chain,
starting with on_chain_start, ending with on_chain_end or on_chain_error.
Each custom chain can optionally call additional callback methods, see Callback docs
for full details.
attribute chains: List[langchain.chains.base.Chain] [Required]
att... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-199 | response. If True, only new keys generated by this chain will be
returned. If False, both input keys and new keys generated by this
chain will be returned. Defaults to False.
callbacks (Optional[Union[List[langchain.callbacks.base.BaseCallbackHandler], langchain.callbacks.base.BaseCallbackManager]]) – Callbacks to use ... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-200 | inputs (Dict[str, str]) –
outputs (Dict[str, str]) –
return_only_outputs (bool) –
Return type
Dict[str, str]
run(*args, callbacks=None, tags=None, **kwargs)
Run the chain as text in, text out or multiple variables, text out.
Parameters
args (Any) –
callbacks (Optional[Union[List[langchain.callbacks.base.BaseCallba... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-201 | property lc_serializable: bool
Return whether or not the class is serializable.
class langchain.chains.SimpleSequentialChain(*, memory=None, callbacks=None, callback_manager=None, verbose=None, tags=None, chains, strip_outputs=False, input_key='input', output_key='output')[source]
Bases: langchain.chains.base.Chain
S... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-202 | them along in the chain. At the end, it saves any returned variables.
There are many different types of memory - please see memory docs
for the full catalog.
attribute strip_outputs: bool = False
attribute tags: Optional[List[str]] = None
Optional list of tags associated with the chain. Defaults to None
These tags wi... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-203 | Call the chain on all inputs in the list.
Parameters
input_list (List[Dict[str, Any]]) –
callbacks (Optional[Union[List[langchain.callbacks.base.BaseCallbackHandler], langchain.callbacks.base.BaseCallbackManager]]) –
Return type
List[Dict[str, str]]
async arun(*args, callbacks=None, tags=None, **kwargs)
Run the chai... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-204 | Return type
str
save(file_path)
Save the chain.
Parameters
file_path (Union[pathlib.Path, str]) – Path to file to save the chain to.
Return type
None
Example:
.. code-block:: python
chain.save(file_path=”path/chain.yaml”)
to_json()
Return type
Union[langchain.load.serializable.SerializedConstructor, langchain.load.se... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-205 | verbose (bool) –
tags (Optional[List[str]]) –
input_variables (List[str]) –
output_variables (List[str]) –
transform (Callable[[Dict[str, str]], Dict[str, str]]) –
Return type
None
attribute callback_manager: Optional[BaseCallbackManager] = None
Deprecated, use callbacks instead.
attribute callbacks: Callbacks = ... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-206 | will be printed to the console. Defaults to langchain.verbose value.
async acall(inputs, return_only_outputs=False, callbacks=None, *, tags=None, include_run_info=False)
Run the logic of this chain and add to output if desired.
Parameters
inputs (Union[Dict[str, Any], Any]) – Dictionary of inputs, or single input if c... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-207 | kwargs (Any) –
Return type
str
dict(**kwargs)
Return dictionary representation of chain.
Parameters
kwargs (Any) –
Return type
Dict
prep_inputs(inputs)
Validate and prep inputs.
Parameters
inputs (Union[Dict[str, Any], Any]) –
Return type
Dict[str, str]
prep_outputs(inputs, outputs, return_only_outputs=False)
Val... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-208 | 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... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-209 | Deprecated, use callbacks instead.
attribute callbacks: Callbacks = None
Optional list of callback handlers (or callback manager). Defaults to None.
Callback handlers are called throughout the lifecycle of a call to a chain,
starting with on_chain_start, ending with on_chain_end or on_chain_error.
Each custom chain ca... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-210 | Whether or not run in verbose mode. In verbose mode, some intermediate logs
will be printed to the console. Defaults to langchain.verbose value.
async acall(inputs, return_only_outputs=False, callbacks=None, *, tags=None, include_run_info=False)
Run the logic of this chain and add to output if desired.
Parameters
inpu... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-211 | tags (Optional[List[str]]) –
kwargs (Any) –
Return type
str
dict(**kwargs)
Return dictionary representation of chain.
Parameters
kwargs (Any) –
Return type
Dict
classmethod from_chain_type(llm, chain_type='stuff', chain_type_kwargs=None, **kwargs)
Load chain from chain type.
Parameters
llm (langchain.base_language... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-212 | tags (Optional[List[str]]) –
kwargs (Any) –
Return type
str
save(file_path)
Save the chain.
Parameters
file_path (Union[pathlib.Path, str]) – Path to file to save the chain to.
Return type
None
Example:
.. code-block:: python
chain.save(file_path=”path/chain.yaml”)
to_json()
Return type
Union[langchain.load.seriali... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-213 | Question-answering with sources over a vector database.
Parameters
memory (Optional[langchain.schema.BaseMemory]) –
callbacks (Optional[Union[List[langchain.callbacks.base.BaseCallbackHandler], langchain.callbacks.base.BaseCallbackManager]]) –
callback_manager (Optional[langchain.callbacks.base.BaseCallbackManager]) ... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-214 | enforced only for StuffDocumentChain and if reduce_k_below_max_tokens is to true
attribute memory: Optional[BaseMemory] = None
Optional memory object. Defaults to None.
Memory is a class that gets called at the start
and at the end of every chain. At the start, memory loads variables and passes
them along in the chain... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-215 | return_only_outputs (bool) – boolean for whether to return only outputs in the
response. If True, only new keys generated by this chain will be
returned. If False, both input keys and new keys generated by this
chain will be returned. Defaults to False.
callbacks (Optional[Union[List[langchain.callbacks.base.BaseCallba... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-216 | chain_type (str) –
chain_type_kwargs (Optional[dict]) –
kwargs (Any) –
Return type
langchain.chains.qa_with_sources.base.BaseQAWithSourcesChain | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-217 | classmethod from_llm(llm, document_prompt=PromptTemplate(input_variables=['page_content', 'source'], output_parser=None, partial_variables={}, template='Content: {page_content}\nSource: {source}', template_format='f-string', validate_template=True), question_prompt=PromptTemplate(input_variables=['context', 'question']... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-218 | of this Agreement shall not affect the continuation in force of the remainder of the term (if any) and this Agreement.\n\n11.8 No Agency. Except as expressly stated otherwise, nothing in this Agreement shall create an agency, partnership or joint venture of any kind between the parties.\n\n11.9 No Third-Party Benefic... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-219 | their fearlessness, their courage, their determination, inspires the world. \n\nGroups of citizens blocking tanks with their bodies. Everyone from students to retirees teachers turned soldiers defending their homeland.\nSource: 0-pl\nContent: And we won’t stop. \n\nWe have lost so much to COVID-19. Time with one anothe... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-220 | you, as I’ve always promised. A Russian dictator, invading a foreign country, has costs around the world. \n\nAnd I’m taking robust action to make sure the pain of our sanctions is targeted at Russia’s economy. And I will use every tool at our disposal to protect American businesses and consumers. \n\nTonight, I can a... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-221 | \n\nNow is the hour. \n\nOur moment of responsibility. \n\nOur test of resolve and conscience, of history itself. \n\nIt is in this moment that our character is formed. Our purpose is found. Our future is forged. \n\nWell I know this nation.\nSource: 34-pl\n=========\nFINAL ANSWER: The president did not mention Michael... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-222 | Construct the chain from an LLM.
Parameters
llm (langchain.base_language.BaseLanguageModel) –
document_prompt (langchain.prompts.base.BasePromptTemplate) –
question_prompt (langchain.prompts.base.BasePromptTemplate) –
combine_prompt (langchain.prompts.base.BasePromptTemplate) –
kwargs (Any) –
Return type
langchain... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-223 | Return type
langchain.load.serializable.SerializedNotImplemented
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. [“la... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-224 | Parameters
schema (dict) – The schema of the entities to extract.
llm (langchain.base_language.BaseLanguageModel) – The language model to use.
Returns
Chain (LLMChain) that can be used to extract information from a passage.
Return type
langchain.chains.base.Chain
langchain.chains.create_tagging_chain_pydantic(pydantic_... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-225 | schema (Union[dict, Type[pydantic.main.BaseModel]]) – Pydantic schema to use for the output.
output_parser (str) – Output parser to use. Should be one of pydantic or base.
Default to base.
prompt (Optional[Union[langchain.prompts.prompt.PromptTemplate, langchain.prompts.chat.ChatPromptTemplate]]) – Optional prompt to u... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-226 | input_key (str) –
output_key (str) –
llm_chain (langchain.chains.llm.LLMChain) –
document_prompt (langchain.prompts.base.BasePromptTemplate) –
document_variable_name (str) –
document_separator (str) –
Return type
None
attribute callback_manager: Optional[BaseCallbackManager] = None
Deprecated, use callbacks inst... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-227 | for the full catalog.
attribute tags: Optional[List[str]] = None
Optional list of tags associated with the chain. Defaults to None
These tags will be associated with each call to this chain,
and passed as arguments to the handlers defined in callbacks.
You can use these to eg identify a specific instance of a chain wi... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-228 | kwargs (Any) –
Return type
Tuple[str, dict]
apply(input_list, callbacks=None)
Call the chain on all inputs in the list.
Parameters
input_list (List[Dict[str, Any]]) –
callbacks (Optional[Union[List[langchain.callbacks.base.BaseCallbackHandler], langchain.callbacks.base.BaseCallbackManager]]) –
Return type
List[Dict... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-229 | return_only_outputs (bool) –
Return type
Dict[str, str]
prompt_length(docs, **kwargs)[source]
Get the prompt length by formatting the prompt.
Parameters
docs (List[langchain.schema.Document]) –
kwargs (Any) –
Return type
Optional[int]
run(*args, callbacks=None, tags=None, **kwargs)
Run the chain as text in, text o... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-230 | property lc_serializable: bool
Return whether or not the class is serializable.
class langchain.chains.MapRerankDocumentsChain(*, memory=None, callbacks=None, callback_manager=None, verbose=None, tags=None, input_key='input_documents', output_key='output_text', llm_chain, document_variable_name, rank_key, answer_key, ... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-231 | Each custom chain can optionally call additional callback methods, see Callback docs
for full details.
attribute document_variable_name: str [Required]
The variable name in the llm_chain to put the documents in.
If only one variable in the llm_chain, this need not be provided.
attribute llm_chain: LLMChain [Required]... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-232 | only one param.
return_only_outputs (bool) – boolean for whether to return only outputs in the
response. If True, only new keys generated by this chain will be
returned. If False, both input keys and new keys generated by this
chain will be returned. Defaults to False.
callbacks (Optional[Union[List[langchain.callbacks... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-233 | tags (Optional[List[str]]) –
kwargs (Any) –
Return type
str
combine_docs(docs, callbacks=None, **kwargs)[source]
Combine documents in a map rerank manner.
Combine by mapping first chain over all documents, then reranking the results.
Parameters
docs (List[langchain.schema.Document]) –
callbacks (Optional[Union[List... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-234 | kwargs (Any) –
Return type
str
save(file_path)
Save the chain.
Parameters
file_path (Union[pathlib.Path, str]) – Path to file to save the chain to.
Return type
None
Example:
.. code-block:: python
chain.save(file_path=”path/chain.yaml”)
to_json()
Return type
Union[langchain.load.serializable.SerializedConstructor, l... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-235 | callback_manager (Optional[langchain.callbacks.base.BaseCallbackManager]) –
verbose (bool) –
tags (Optional[List[str]]) –
input_key (str) –
output_key (str) –
llm_chain (langchain.chains.llm.LLMChain) –
combine_document_chain (langchain.chains.combine_documents.base.BaseCombineDocumentsChain) –
collapse_document... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-236 | Optional memory object. Defaults to None.
Memory is a class that gets called at the start
and at the end of every chain. At the start, memory loads variables and passes
them along in the chain. At the end, it saves any returned variables.
There are many different types of memory - please see memory docs
for the full ca... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-237 | include_run_info (bool) – Whether to include run info in the response. Defaults
to False.
tags (Optional[List[str]]) –
Return type
Dict[str, Any]
async acombine_docs(docs, callbacks=None, **kwargs)[source]
Combine documents in a map reduce manner.
Combine by mapping first chain over all documents, then reducing the r... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-238 | docs (List[langchain.schema.Document]) –
token_max (int) –
callbacks (Optional[Union[List[langchain.callbacks.base.BaseCallbackHandler], langchain.callbacks.base.BaseCallbackManager]]) –
kwargs (Any) –
Return type
Tuple[str, dict]
dict(**kwargs)
Return dictionary representation of chain.
Parameters
kwargs (Any) – ... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-239 | Example:
.. code-block:: python
chain.save(file_path=”path/chain.yaml”)
to_json()
Return type
Union[langchain.load.serializable.SerializedConstructor, langchain.load.serializable.SerializedNotImplemented]
to_json_not_implemented()
Return type
langchain.load.serializable.SerializedNotImplemented
property lc_attributes... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-240 | input_key (str) –
output_key (str) –
initial_llm_chain (langchain.chains.llm.LLMChain) –
refine_llm_chain (langchain.chains.llm.LLMChain) –
document_variable_name (str) –
initial_response_name (str) –
document_prompt (langchain.prompts.base.BasePromptTemplate) –
return_intermediate_steps (bool) –
Return type
No... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-241 | There are many different types of memory - please see memory docs
for the full catalog.
attribute refine_llm_chain: LLMChain [Required]
LLM chain to use when refining.
attribute return_intermediate_steps: bool = False
Return the results of the refine steps in the output.
attribute tags: Optional[List[str]] = None
Op... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-242 | tags (Optional[List[str]]) –
Return type
Dict[str, Any]
async acombine_docs(docs, callbacks=None, **kwargs)[source]
Combine by mapping first chain over all, then stuffing into final chain.
Parameters
docs (List[langchain.schema.Document]) –
callbacks (Optional[Union[List[langchain.callbacks.base.BaseCallbackHandler]... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-243 | Return type
Dict
prep_inputs(inputs)
Validate and prep inputs.
Parameters
inputs (Union[Dict[str, Any], Any]) –
Return type
Dict[str, str]
prep_outputs(inputs, outputs, return_only_outputs=False)
Validate and prep outputs.
Parameters
inputs (Dict[str, str]) –
outputs (Dict[str, str]) –
return_only_outputs (bool) –... | https://api.python.langchain.com/en/stable/modules/chains.html |
5d97bfd0cb46-244 | 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”, “openai”]
property lc_secrets: Dict[str, str]
Return a map of constructor argument names to secret ids.
eg. {“openai_api_key”: “OPENAI_API_K... | https://api.python.langchain.com/en/stable/modules/chains.html |
76417e48a30b-0 | Base classes
Common schema objects.
langchain.schema.get_buffer_string(messages, human_prefix='Human', ai_prefix='AI')[source]
Get buffer string of messages.
Parameters
messages (List[langchain.schema.BaseMessage]) –
human_prefix (str) –
ai_prefix (str) –
Return type
str
class langchain.schema.AgentAction(tool, to... | https://api.python.langchain.com/en/stable/modules/base_classes.html |
76417e48a30b-1 | Default values are respected, but no other validation is performed.
Behaves as if Config.extra = ‘allow’ was set since it adds all passed values
Parameters
_fields_set (Optional[SetStr]) –
values (Any) –
Return type
Model
copy(*, include=None, exclude=None, update=None, deep=False)
Duplicate a model, optionally choo... | https://api.python.langchain.com/en/stable/modules/base_classes.html |
76417e48a30b-2 | exclude_none (bool) –
Return type
DictStrAny
json(*, include=None, exclude=None, by_alias=False, skip_defaults=None, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=None, models_as_dict=True, **dumps_kwargs)
Generate a JSON representation of the model, include and exclude arguments as per dic... | https://api.python.langchain.com/en/stable/modules/base_classes.html |
76417e48a30b-3 | property lc_serializable: bool
This class is LangChain serializable.
class langchain.schema.BaseMessage(*, content, additional_kwargs=None)[source]
Bases: langchain.load.serializable.Serializable
Message object.
Parameters
content (str) –
additional_kwargs (dict) –
Return type
None
classmethod construct(_fields_set... | https://api.python.langchain.com/en/stable/modules/base_classes.html |
76417e48a30b-4 | Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
Parameters
include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –
exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –
by_alias (bool) –
skip_defaults (Optional[bool]) –
exclude_unset (... | https://api.python.langchain.com/en/stable/modules/base_classes.html |
76417e48a30b-5 | constructor.
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
This class is LangChain... | https://api.python.langchain.com/en/stable/modules/base_classes.html |
76417e48a30b-6 | update (Optional[DictStrAny]) – values to change/add in the new model. Note: the data is not validated before creating
the new model: you should trust this data
deep (bool) – set to True to make a deep copy of the model
self (Model) –
Returns
new model instance
Return type
Model
dict(*, include=None, exclude=None, by_... | https://api.python.langchain.com/en/stable/modules/base_classes.html |
76417e48a30b-7 | models_as_dict (bool) –
dumps_kwargs (Any) –
Return type
unicode
classmethod update_forward_refs(**localns)
Try to update ForwardRefs on fields based on this Model, globalns and localns.
Parameters
localns (Any) –
Return type
None
property lc_attributes: Dict
Return a list of attribute names that should be include... | https://api.python.langchain.com/en/stable/modules/base_classes.html |
76417e48a30b-8 | Model
copy(*, include=None, exclude=None, update=None, deep=False)
Duplicate a model, optionally choose which fields to include, exclude and change.
Parameters
include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to include in new model
exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) ... | https://api.python.langchain.com/en/stable/modules/base_classes.html |
76417e48a30b-9 | Parameters
include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –
exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –
by_alias (bool) –
skip_defaults (Optional[bool]) –
exclude_unset (bool) –
exclude_defaults (bool) –
exclude_none (bool) –
encoder (Optional[Callable[[Any], Any]]) –
models... | https://api.python.langchain.com/en/stable/modules/base_classes.html |
76417e48a30b-10 | Return type
None
classmethod construct(_fields_set=None, **values)
Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
Default values are respected, but no other validation is performed.
Behaves as if Config.extra = ‘allow’ was set since it adds all passed values
Parameters
_fie... | https://api.python.langchain.com/en/stable/modules/base_classes.html |
76417e48a30b-11 | exclude_defaults (bool) –
exclude_none (bool) –
Return type
DictStrAny
json(*, include=None, exclude=None, by_alias=False, skip_defaults=None, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=None, models_as_dict=True, **dumps_kwargs)
Generate a JSON representation of the model, include and e... | https://api.python.langchain.com/en/stable/modules/base_classes.html |
76417e48a30b-12 | property lc_serializable: bool
This class is LangChain serializable.
property type: str
Type of the message, used for serialization.
class langchain.schema.FunctionMessage(*, content, additional_kwargs=None, name)[source]
Bases: langchain.schema.BaseMessage
Parameters
content (str) –
additional_kwargs (dict) –
nam... | https://api.python.langchain.com/en/stable/modules/base_classes.html |
76417e48a30b-13 | Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
Parameters
include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –
exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –
by_alias (bool) –
skip_defaults (Optional[bool]) –
exclude_unset (... | https://api.python.langchain.com/en/stable/modules/base_classes.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.