langchain.chains.hyde.base.HypotheticalDocumentEmbedder

Note

HypotheticalDocumentEmbedder implements the standard Runnable Interface. 🏃

class langchain.chains.hyde.base.HypotheticalDocumentEmbedder[source]

Bases: Chain, Embeddings

Generate hypothetical document for query, and then embed that.

Based on https://arxiv.org/abs/2212.10496

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.

param base_embeddings: Embeddings [Required]
param callback_manager: Optional[BaseCallbackManager] = None

[DEPRECATED] Use callbacks instead.

param 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 can optionally call additional callback methods, see Callback docs for full details.

param llm_chain: LLMChain [Required]
param 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 different types of memory - please see memory docs for the full catalog.

param metadata: Optional[Dict[str, Any]] = None

Optional metadata associated with the chain. Defaults to None. This metadata 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.

param 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 with its use case.

param verbose: bool [Optional]

Whether or not run in verbose mode. In verbose mode, some intermediate logs will be printed to the console. Defaults to the global verbose value, accessible via langchain.globals.get_verbose().

__call__(inputs: Union[Dict[str, Any], Any], return_only_outputs: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, include_run_info: bool = False) Dict[str, Any]

[Deprecated] Execute the chain.

Parameters
  • inputs (Union[Dict[str, Any], Any]) – Dictionary of 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.

  • return_only_outputs (bool) – 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[BaseCallbackHandler], BaseCallbackManager]]) – 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 (Optional[List[str]]) – 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 calls to other objects.

  • metadata (Optional[Dict[str, Any]]) – Optional metadata associated with the chain. Defaults to None

  • include_run_info (bool) – Whether to include run info in the response. Defaults to False.

  • run_name (Optional[str]) –

Returns

A dict of named outputs. Should contain all outputs specified in

Chain.output_keys.

Return type

Dict[str, Any]

Notes

Deprecated since version langchain==0.1.0: Use invoke instead.

async acall(inputs: Union[Dict[str, Any], Any], return_only_outputs: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, include_run_info: bool = False) Dict[str, Any]

[Deprecated] Asynchronously execute the chain.

Parameters
  • inputs (Union[Dict[str, Any], Any]) – Dictionary of 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.

  • return_only_outputs (bool) – 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[BaseCallbackHandler], BaseCallbackManager]]) – 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 (Optional[List[str]]) – 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 calls to other objects.

  • metadata (Optional[Dict[str, Any]]) – Optional metadata associated with the chain. Defaults to None

  • include_run_info (bool) – Whether to include run info in the response. Defaults to False.

  • run_name (Optional[str]) –

Returns

A dict of named outputs. Should contain all outputs specified in

Chain.output_keys.

Return type

Dict[str, Any]

Notes

Deprecated since version langchain==0.1.0: Use ainvoke instead.

async aembed_documents(texts: List[str]) List[List[float]]

Asynchronous Embed search docs.

Parameters

texts (List[str]) –

Return type

List[List[float]]

async aembed_query(text: str) List[float]

Asynchronous Embed query text.

Parameters

text (str) –

Return type

List[float]

apply(input_list: List[Dict[str, Any]], callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) List[Dict[str, str]]

[Deprecated] Call the chain on all inputs in the list.

Notes

Deprecated since version langchain==0.1.0: Use batch instead.

Parameters
Return type

List[Dict[str, str]]

async aprep_inputs(inputs: Union[Dict[str, Any], Any]) Dict[str, str]

Prepare chain inputs, including adding inputs from memory.

Parameters

inputs (Union[Dict[str, Any], Any]) – 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.

Return type

Dict[str, str]

async aprep_outputs(inputs: Dict[str, str], outputs: Dict[str, str], return_only_outputs: bool = False) Dict[str, str]

Validate and prepare chain outputs, and save info about this run to memory.

Parameters
  • inputs (Dict[str, str]) – Dictionary of chain inputs, including any inputs added by chain memory.

  • outputs (Dict[str, str]) – Dictionary of initial chain outputs.

  • return_only_outputs (bool) – Whether to only return the chain outputs. If False, inputs are also added to the final outputs.

Returns

A dict of the final chain outputs.

Return type

Dict[str, str]

async arun(*args: Any, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) Any

[Deprecated] Convenience method for executing chain.

The main difference between this method and Chain.__call__ is that this method expects inputs to be passed directly in as positional arguments or keyword arguments, whereas Chain.__call__ expects a single input dictionary with all the inputs

Parameters
  • *args (Any) – If the chain expects a single input, it can be passed in as the sole positional argument.

  • callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 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 (Optional[List[str]]) – 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 calls to other objects.

  • **kwargs (Any) – If the chain expects multiple inputs, they can be passed in directly as keyword arguments.

  • metadata (Optional[Dict[str, Any]]) –

  • **kwargs

Returns

The chain output.

Return type

Any

Example

# Suppose we have a single-input chain that takes a 'question' string:
await chain.arun("What's the temperature in Boise, Idaho?")
# -> "The temperature in Boise is..."

# Suppose we have a multi-input chain that takes a 'question' string
# and 'context' string:
question = "What's the temperature in Boise, Idaho?"
context = "Weather report for Boise, Idaho on 07/03/23..."
await chain.arun(question=question, context=context)
# -> "The temperature in Boise is..."

Notes

Deprecated since version langchain==0.1.0: Use ainvoke instead.

combine_embeddings(embeddings: List[List[float]]) List[float][source]

Combine embeddings into final embeddings.

Parameters

embeddings (List[List[float]]) –

Return type

List[float]

embed_documents(texts: List[str]) List[List[float]][source]

Call the base embeddings.

Parameters

texts (List[str]) –

Return type

List[List[float]]

embed_query(text: str) List[float][source]

Generate a hypothetical document and embedded it.

Parameters

text (str) –

Return type

List[float]

classmethod from_llm(llm: BaseLanguageModel, base_embeddings: Embeddings, prompt_key: Optional[str] = None, custom_prompt: Optional[BasePromptTemplate] = None, **kwargs: Any) HypotheticalDocumentEmbedder[source]

Load and use LLMChain with either a specific prompt key or custom prompt.

Parameters
Return type

HypotheticalDocumentEmbedder

prep_inputs(inputs: Union[Dict[str, Any], Any]) Dict[str, str]

Prepare chain inputs, including adding inputs from memory.

Parameters

inputs (Union[Dict[str, Any], Any]) – 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.

Return type

Dict[str, str]

prep_outputs(inputs: Dict[str, str], outputs: Dict[str, str], return_only_outputs: bool = False) Dict[str, str]

Validate and prepare chain outputs, and save info about this run to memory.

Parameters
  • inputs (Dict[str, str]) – Dictionary of chain inputs, including any inputs added by chain memory.

  • outputs (Dict[str, str]) – Dictionary of initial chain outputs.

  • return_only_outputs (bool) – Whether to only return the chain outputs. If False, inputs are also added to the final outputs.

Returns

A dict of the final chain outputs.

Return type

Dict[str, str]

run(*args: Any, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) Any

[Deprecated] Convenience method for executing chain.

The main difference between this method and Chain.__call__ is that this method expects inputs to be passed directly in as positional arguments or keyword arguments, whereas Chain.__call__ expects a single input dictionary with all the inputs

Parameters
  • *args (Any) – If the chain expects a single input, it can be passed in as the sole positional argument.

  • callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 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 (Optional[List[str]]) – 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 calls to other objects.

  • **kwargs (Any) – If the chain expects multiple inputs, they can be passed in directly as keyword arguments.

  • metadata (Optional[Dict[str, Any]]) –

  • **kwargs

Returns

The chain output.

Return type

Any

Example

# Suppose we have a single-input chain that takes a 'question' string:
chain.run("What's the temperature in Boise, Idaho?")
# -> "The temperature in Boise is..."

# Suppose we have a multi-input chain that takes a 'question' string
# and 'context' string:
question = "What's the temperature in Boise, Idaho?"
context = "Weather report for Boise, Idaho on 07/03/23..."
chain.run(question=question, context=context)
# -> "The temperature in Boise is..."

Notes

Deprecated since version langchain==0.1.0: Use invoke instead.

save(file_path: Union[Path, str]) None

Save the chain.

Expects Chain._chain_type property to be implemented and for memory to be

null.

Parameters

file_path (Union[Path, str]) – Path to file to save the chain to.

Return type

None

Example

chain.save(file_path="path/chain.yaml")
property input_keys: List[str]

Input keys for Hyde’s LLM chain.

property output_keys: List[str]

Output keys for Hyde’s LLM chain.