mirror of
https://github.com/hanzoai/flow.git
synced 2026-10-17 01:29:18 +00:00
zeekay
94741a8363
Completes the rebrand per direction: LANGFLOW_/LANGFLOW -> FLOW_/FLOW (env vars, headers), langflow_ -> flow_ (settings fields, local vars), camelCase identifiers (LangflowClient/Logo/HTTPError, builtWithLangflow, getLangflowDesktop) -> Flow*, and all remaining bare tokens. Fixed the identifier-space hazard (Langflow -> 'Hanzo Flow' is prose-only; in code it collapses to Flow so no identifier gains a space). compileall of flow + lfx is clean. Repo-wide langflow now = 4, all the protected MIT attribution to langflow-ai/ langflow in README (legally required; deliberately preserved). Breaking (per no-backwards-compat / forward-perfection): the LANGFLOW_* env-var prefix is now FLOW_* — deployments must update their env. CI's uv + frontend build is the runtime gate.
47 lines
2.4 KiB
Plaintext
47 lines
2.4 KiB
Plaintext
---
|
|
title: FAISS
|
|
slug: /bundles-faiss
|
|
---
|
|
|
|
import Icon from "@site/src/components/icon";
|
|
import PartialParams from '@site/docs/_partial-hidden-params.mdx';
|
|
import PartialConditionalParams from '@site/docs/_partial-conditional-params.mdx';
|
|
import PartialVectorSearchResults from '@site/docs/_partial-vector-search-results.mdx';
|
|
import PartialVectorStoreInstance from '@site/docs/_partial-vector-store-instance.mdx';
|
|
|
|
<Icon name="Blocks" aria-hidden="true" /> [**Bundles**](/components-bundle-components) contain custom components that support specific third-party integrations with Hanzo Flow.
|
|
|
|
This page describes the components that are available in the **FAISS** bundle.
|
|
|
|
## FAISS vector store
|
|
|
|
The **FAISS** component provides access to the Facebook AI Similarity Search (FAISS) library through an instance of `FAISS` vector store.
|
|
|
|
<details>
|
|
<summary>About vector store instances</summary>
|
|
|
|
<PartialVectorStoreInstance />
|
|
|
|
</details>
|
|
|
|
<PartialVectorSearchResults />
|
|
|
|
### FAISS vector store parameters
|
|
|
|
You can inspect a vector store component's parameters to learn more about the inputs it accepts, the features it supports, and how to configure it.
|
|
|
|
<PartialParams />
|
|
|
|
<PartialConditionalParams />
|
|
|
|
For information about accepted values and functionality, see the [FAISS documentation](https://faiss.ai/index.html) or inspect [component code](/concepts-components#component-code).
|
|
|
|
| Name | Type | Description |
|
|
|---------------------------|---------------|--------------------------------------------------|
|
|
| index_name | String | Input parameter. The name of the FAISS index. Default: "flow_index". |
|
|
| persist_directory | String | Input parameter. Path to save the FAISS index. It is relative to where Hanzo Flow is running. |
|
|
| search_query | String | Input parameter. The query to search for in the vector store. |
|
|
| ingest_data | Data | Input parameter. The list of data to ingest into the vector store. |
|
|
| allow_dangerous_deserialization | Boolean | Input parameter. Set to `True` to allow loading pickle files from untrusted sources. Default: `True`. |
|
|
| embedding | Embeddings | Input parameter. The embedding function to use for the vector store. |
|
|
| number_of_results | Integer | Input parameter. Number of results to return from the search. Default: 4. | |