pengjunjie/langflow
1
0
Fork 1
mirror of https://github.com/langflow-ai/langflow.git synced 2026-07-24 02:47:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
01cb51f39f77bb500f0a61459546dfdb9f5e916e
langflow/components-embedding-models.html
github-merge-queue[bot] 01cb51f39f deploy: 24facbe2a6
2025-03-13 00:44:58 +00:00

157 lines
58 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-Components/components-embedding-models" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.7.0">
<title data-rh="true">Embeddings | Langflow Documentation</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.langflow.org/components-embedding-models"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Embeddings | Langflow Documentation"><meta data-rh="true" name="description" content="Embeddings models convert text into numerical vectors. These embeddings capture semantic meaning of the input text, and allow LLMs to understand context."><meta data-rh="true" property="og:description" content="Embeddings models convert text into numerical vectors. These embeddings capture semantic meaning of the input text, and allow LLMs to understand context."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.langflow.org/components-embedding-models"><link data-rh="true" rel="alternate" href="https://docs.langflow.org/components-embedding-models" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.langflow.org/components-embedding-models" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://UZK6BDPCVY-dsn.algolia.net" crossorigin="anonymous"><link rel="preconnect" href="https://www.google-analytics.com">
<link rel="preconnect" href="https://www.googletagmanager.com">
<script async src="https://www.googletagmanager.com/gtag/js?id=G-XHC7G628ZP"></script>
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-XHC7G628ZP",{anonymize_ip:!0})</script>
<link rel="preconnect" href="https://www.googletagmanager.com">
<script>window.dataLayer=window.dataLayer||[]</script>
<script>!function(e,t,a,n){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var g=t.getElementsByTagName(a)[0],m=t.createElement(a);m.async=!0,m.src="https://www.googletagmanager.com/gtm.js?id=GTM-NK5M4ZT8",g.parentNode.insertBefore(m,g)}(window,document,"script","dataLayer")</script>
<link rel="search" type="application/opensearchdescription+xml" title="Langflow Documentation" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e5a88218.css">
<script src="/assets/js/runtime~main.9cd9b5e5.js" defer="defer"></script>
<script src="/assets/js/main.a4980296.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NK5M4ZT8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();null!==e?t(e):window.matchMedia("(prefers-color-scheme: dark)").matches?t("dark"):(window.matchMedia("(prefers-color-scheme: light)").matches,t("light"))}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top navbarHideable_m1mJ"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/langflow-logo-black.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/langflow-logo-white.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/langflow-ai/langflow" target="_blank" class="navbar__item navbar__link header-github-link"></a><a href="https://twitter.com/langflow_ai" target="_blank" class="navbar__item navbar__link header-twitter-link"></a><a href="https://discord.gg/EqksyE2EX9" target="_blank" class="navbar__item navbar__link header-discord-link"></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite" aria-pressed="false"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search (Command+K)"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd sidebarWithHideableNavbar_wUlq"><a tabindex="-1" class="sidebarLogo_isFc" href="/"><img src="/img/langflow-logo-black.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/langflow-logo-white.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--dark_xIcU"></a><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/">Welcome to Langflow</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/get-started-installation">Get started</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/starter-projects-basic-prompting">Starter projects</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/tutorials-blog-writer">Tutorials</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/concepts-overview">Concepts</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/components-agents">Components</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-agents">Agents</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-custom-components">Create custom Python components</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-data">Data</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/components-embedding-models">Embeddings</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-helpers">Helpers</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-io">Inputs and outputs</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-loaders">Loaders</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-logic">Logic</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-memories">Memories</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-models">Models</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-processing">Processing</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-prompts">Prompts</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-tools">Tools</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-vector-stores">Vector stores</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/agents-overview">Agents</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/configuration-api-keys">Configuration</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/deployment-docker">Deployment</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/api">API reference</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/integrations-apify">Integrations</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/contributing-community">Contributing</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a href="https://github.com/langflow-ai/langflow/releases/latest" target="_blank" rel="noopener noreferrer" class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false">Changelog</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/luna-for-langflow">Support</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Components</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Embeddings</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Embeddings models in Langflow</h1></header>
<p>Embeddings models convert text into numerical vectors. These embeddings capture semantic meaning of the input text, and allow LLMs to understand context.</p>
<p>Refer to your specific component&#x27;s documentation for more information on parameters.</p>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="use-an-embeddings-model-component-in-a-flow">Use an embeddings model component in a flow<a href="#use-an-embeddings-model-component-in-a-flow" class="hash-link" aria-label="Direct link to Use an embeddings model component in a flow" title="Direct link to Use an embeddings model component in a flow">​</a></h2>
<p>In this example of a document ingestion pipeline, the <strong>OpenAI</strong> embeddings model is connected to a vector database. The component converts the text chunks into vectors and stores them in the vector database. The vectorized data can be used to inform AI workloads like chatbots, similarity searches, and agents.</p>
<p>This embeddings component uses an OpenAI API key for authentication. Refer to your specific embeddings component&#x27;s documentation for more information on authentication.</p>
<p><img decoding="async" loading="lazy" alt="URL component in a data ingestion pipeline" src="/assets/images/url-component-0ced1fa00ee3b97582421254b6d5be78.png" width="2586" height="1550" class="img_ev3q"></p>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="aiml">AI/ML<a href="#aiml" class="hash-link" aria-label="Direct link to AI/ML" title="Direct link to AI/ML">​</a></h2>
<p>This component generates embeddings using the <a href="https://docs.aimlapi.com/api-overview/embeddings" target="_blank" rel="noopener noreferrer">AI/ML API</a>.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs">Inputs<a href="#inputs" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>model_name</td><td>String</td><td>The name of the AI/ML embedding model to use</td></tr><tr><td>aiml_api_key</td><td>SecretString</td><td>API key for authenticating with the AI/ML service</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs">Outputs<a href="#outputs" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>embeddings</td><td>Embeddings</td><td>An instance of AIMLEmbeddingsImpl for generating embeddings</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="amazon-bedrock-embeddings">Amazon Bedrock Embeddings<a href="#amazon-bedrock-embeddings" class="hash-link" aria-label="Direct link to Amazon Bedrock Embeddings" title="Direct link to Amazon Bedrock Embeddings">​</a></h2>
<p>This component is used to load embedding models from <a href="https://aws.amazon.com/bedrock/" target="_blank" rel="noopener noreferrer">Amazon Bedrock</a>.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-1">Inputs<a href="#inputs-1" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>credentials_profile_name</td><td>String</td><td>Name of the AWS credentials profile in ~/.aws/credentials or ~/.aws/config, which has access keys or role information</td></tr><tr><td>model_id</td><td>String</td><td>ID of the model to call, e.g., <code>amazon.titan-embed-text-v1</code>. This is equivalent to the <code>modelId</code> property in the <code>list-foundation-models</code> API</td></tr><tr><td>endpoint_url</td><td>String</td><td>URL to set a specific service endpoint other than the default AWS endpoint</td></tr><tr><td>region_name</td><td>String</td><td>AWS region to use, e.g., <code>us-west-2</code>. Falls back to <code>AWS_DEFAULT_REGION</code> environment variable or region specified in ~/.aws/config if not provided</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-1">Outputs<a href="#outputs-1" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>embeddings</td><td>Embeddings</td><td>An instance for generating embeddings using Amazon Bedrock</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="astra-db-vectorize">Astra DB vectorize<a href="#astra-db-vectorize" class="hash-link" aria-label="Direct link to Astra DB vectorize" title="Direct link to Astra DB vectorize">​</a></h2>
<div class="theme-admonition theme-admonition-important admonition_xJq3 alert alert--info"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>important</div><div class="admonitionContent_BuS1"><p>This component is deprecated as of Langflow version 1.1.2.
Instead, use the <a href="/components-vector-stores#astra-db-vector-store">Astra DB vector store component</a></p></div></div>
<p>Connect this component to the <strong>Embeddings</strong> port of the <a href="/components-vector-stores#astra-db-vector-store">Astra DB vector store component</a> to generate embeddings.</p>
<p>This component requires that your Astra DB database has a collection that uses a vectorize embedding provider integration.
For more information and instructions, see <a href="https://docs.datastax.com/en/astra-db-serverless/databases/embedding-generation.html" target="_blank" rel="noopener noreferrer">Embedding Generation</a>.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-2">Inputs<a href="#inputs-2" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>provider</td><td>Embedding Provider</td><td>The embedding provider to use</td></tr><tr><td>model_name</td><td>Model Name</td><td>The embedding model to use</td></tr><tr><td>authentication</td><td>Authentication</td><td>The name of the API key in Astra that stores your <a href="https://docs.datastax.com/en/astra-db-serverless/databases/embedding-generation.html#embedding-provider-authentication" target="_blank" rel="noopener noreferrer">vectorize embedding provider credentials</a>. (Not required if using an <a href="https://docs.datastax.com/en/astra-db-serverless/databases/embedding-generation.html#supported-embedding-providers" target="_blank" rel="noopener noreferrer">Astra-hosted embedding provider</a>.)</td></tr><tr><td>provider_api_key</td><td>Provider API Key</td><td>As an alternative to <code>authentication</code>, directly provide your embedding provider credentials.</td></tr><tr><td>model_parameters</td><td>Model Parameters</td><td>Additional model parameters</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-2">Outputs<a href="#outputs-2" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>embeddings</td><td>Embeddings</td><td>An instance for generating embeddings using Astra vectorize</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="azure-openai-embeddings">Azure OpenAI Embeddings<a href="#azure-openai-embeddings" class="hash-link" aria-label="Direct link to Azure OpenAI Embeddings" title="Direct link to Azure OpenAI Embeddings">​</a></h2>
<p>This component generates embeddings using Azure OpenAI models.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-3">Inputs<a href="#inputs-3" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>Model</td><td>String</td><td>Name of the model to use (default: <code>text-embedding-3-small</code>)</td></tr><tr><td>Azure Endpoint</td><td>String</td><td>Your Azure endpoint, including the resource. Example: <code>https://example-resource.azure.openai.com/</code></td></tr><tr><td>Deployment Name</td><td>String</td><td>The name of the deployment</td></tr><tr><td>API Version</td><td>String</td><td>The API version to use, options include various dates</td></tr><tr><td>API Key</td><td>String</td><td>The API key to access the Azure OpenAI service</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-3">Outputs<a href="#outputs-3" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>embeddings</td><td>Embeddings</td><td>An instance for generating embeddings using Azure OpenAI</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="cloudflare-workers-ai-embeddings">Cloudflare Workers AI Embeddings<a href="#cloudflare-workers-ai-embeddings" class="hash-link" aria-label="Direct link to Cloudflare Workers AI Embeddings" title="Direct link to Cloudflare Workers AI Embeddings">​</a></h2>
<p>This component generates embeddings using <a href="https://developers.cloudflare.com/workers-ai/" target="_blank" rel="noopener noreferrer">Cloudflare Workers AI models</a>.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-4">Inputs<a href="#inputs-4" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>account_id</td><td>Cloudflare account ID</td><td><a href="https://developers.cloudflare.com/fundamentals/setup/find-account-and-zone-ids/#find-account-id-workers-and-pages" target="_blank" rel="noopener noreferrer">Find your Cloudflare account ID</a></td></tr><tr><td>api_token</td><td>Cloudflare API token</td><td><a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/" target="_blank" rel="noopener noreferrer">Create an API token</a></td></tr><tr><td>model_name</td><td>Model Name</td><td><a href="https://developers.cloudflare.com/workers-ai/models/#text-embeddings" target="_blank" rel="noopener noreferrer">List of supported models</a></td></tr><tr><td>strip_new_lines</td><td>Strip New Lines</td><td>Whether to strip new lines from the input text</td></tr><tr><td>batch_size</td><td>Batch Size</td><td>Number of texts to embed in each batch</td></tr><tr><td>api_base_url</td><td>Cloudflare API base URL</td><td>Base URL for the Cloudflare API</td></tr><tr><td>headers</td><td>Headers</td><td>Additional request headers</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-4">Outputs<a href="#outputs-4" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>embeddings</td><td>Embeddings</td><td>An instance for generating embeddings using Cloudflare Workers</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="cohere-embeddings">Cohere Embeddings<a href="#cohere-embeddings" class="hash-link" aria-label="Direct link to Cohere Embeddings" title="Direct link to Cohere Embeddings">​</a></h2>
<p>This component is used to load embedding models from <a href="https://cohere.com/" target="_blank" rel="noopener noreferrer">Cohere</a>.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-5">Inputs<a href="#inputs-5" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>cohere_api_key</td><td>String</td><td>API key required to authenticate with the Cohere service</td></tr><tr><td>model</td><td>String</td><td>Language model used for embedding text documents and performing queries (default: <code>embed-english-v2.0</code>)</td></tr><tr><td>truncate</td><td>Boolean</td><td>Whether to truncate the input text to fit within the model&#x27;s constraints (default: <code>False</code>)</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-5">Outputs<a href="#outputs-5" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>embeddings</td><td>Embeddings</td><td>An instance for generating embeddings using Cohere</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="embedding-similarity">Embedding similarity<a href="#embedding-similarity" class="hash-link" aria-label="Direct link to Embedding similarity" title="Direct link to Embedding similarity">​</a></h2>
<p>This component computes selected forms of similarity between two embedding vectors.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-6">Inputs<a href="#inputs-6" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>embedding_vectors</td><td>Embedding Vectors</td><td>A list containing exactly two data objects with embedding vectors to compare.</td></tr><tr><td>similarity_metric</td><td>Similarity Metric</td><td>Select the similarity metric to use. Options: &quot;Cosine Similarity&quot;, &quot;Euclidean Distance&quot;, &quot;Manhattan Distance&quot;.</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-6">Outputs<a href="#outputs-6" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>similarity_data</td><td>Similarity Data</td><td>Data object containing the computed similarity score and additional information.</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="google-generative-ai-embeddings">Google generative AI embeddings<a href="#google-generative-ai-embeddings" class="hash-link" aria-label="Direct link to Google generative AI embeddings" title="Direct link to Google generative AI embeddings">​</a></h2>
<p>This component connects to Google&#x27;s generative AI embedding service using the GoogleGenerativeAIEmbeddings class from the <code>langchain-google-genai</code> package.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-7">Inputs<a href="#inputs-7" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>api_key</td><td>API Key</td><td>Secret API key for accessing Google&#x27;s generative AI service (required)</td></tr><tr><td>model_name</td><td>Model Name</td><td>Name of the embedding model to use (default: &quot;models/text-embedding-004&quot;)</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-7">Outputs<a href="#outputs-7" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>embeddings</td><td>Embeddings</td><td>Built GoogleGenerativeAIEmbeddings object</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="hugging-face-embeddings">Hugging Face Embeddings<a href="#hugging-face-embeddings" class="hash-link" aria-label="Direct link to Hugging Face Embeddings" title="Direct link to Hugging Face Embeddings">​</a></h2>
<div class="theme-admonition theme-admonition-note admonition_xJq3 alert alert--secondary"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>note</div><div class="admonitionContent_BuS1"><p>This component is deprecated as of Langflow version 1.0.18.
Instead, use the <a href="#hugging-face-embeddings-inference">Hugging Face Embeddings Inference component</a>.</p></div></div>
<p>This component loads embedding models from HuggingFace.</p>
<p>Use this component to generate embeddings using locally downloaded Hugging Face models. Ensure you have sufficient computational resources to run the models.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-8">Inputs<a href="#inputs-8" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>Cache Folder</td><td>Cache Folder</td><td>Folder path to cache HuggingFace models</td></tr><tr><td>Encode Kwargs</td><td>Encoding Arguments</td><td>Additional arguments for the encoding process</td></tr><tr><td>Model Kwargs</td><td>Model Arguments</td><td>Additional arguments for the model</td></tr><tr><td>Model Name</td><td>Model Name</td><td>Name of the HuggingFace model to use</td></tr><tr><td>Multi Process</td><td>Multi-Process</td><td>Whether to use multiple processes</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-8">Outputs<a href="#outputs-8" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>embeddings</td><td>Embeddings</td><td>The generated embeddings</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="hugging-face-embeddings-inference">Hugging Face embeddings inference<a href="#hugging-face-embeddings-inference" class="hash-link" aria-label="Direct link to Hugging Face embeddings inference" title="Direct link to Hugging Face embeddings inference">​</a></h2>
<p>This component generates embeddings using <a href="https://huggingface.co/" target="_blank" rel="noopener noreferrer">Hugging Face Inference API models</a> and requires a <a href="https://huggingface.co/docs/hub/security-tokens" target="_blank" rel="noopener noreferrer">Hugging Face API token</a> to authenticate. Local inference models do not require an API key.</p>
<p>Use this component to create embeddings with Hugging Face&#x27;s hosted models, or to connect to your own locally hosted models.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-9">Inputs<a href="#inputs-9" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>API Key</td><td>API Key</td><td>The API key for accessing the Hugging Face Inference API.</td></tr><tr><td>API URL</td><td>API URL</td><td>The URL of the Hugging Face Inference API.</td></tr><tr><td>Model Name</td><td>Model Name</td><td>The name of the model to use for embeddings.</td></tr><tr><td>Cache Folder</td><td>Cache Folder</td><td>The folder path to cache Hugging Face models.</td></tr><tr><td>Encode Kwargs</td><td>Encoding Arguments</td><td>Additional arguments for the encoding process.</td></tr><tr><td>Model Kwargs</td><td>Model Arguments</td><td>Additional arguments for the model.</td></tr><tr><td>Multi Process</td><td>Multi-Process</td><td>Whether to use multiple processes.</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-9">Outputs<a href="#outputs-9" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>embeddings</td><td>Embeddings</td><td>The generated embeddings.</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="connect-the-hugging-face-component-to-a-local-embeddings-model">Connect the Hugging Face component to a local embeddings model<a href="#connect-the-hugging-face-component-to-a-local-embeddings-model" class="hash-link" aria-label="Direct link to Connect the Hugging Face component to a local embeddings model" title="Direct link to Connect the Hugging Face component to a local embeddings model">​</a></h3>
<p>To run an embeddings inference locally, see the <a href="https://huggingface.co/docs/text-embeddings-inference/local_cpu" target="_blank" rel="noopener noreferrer">HuggingFace documentation</a>.</p>
<p>To connect the local Hugging Face model to the <strong>Hugging Face embeddings inference</strong> component and use it in a flow, follow these steps:</p>
<ol>
<li>Create a <a href="/starter-projects-vector-store-rag">Vector store RAG flow</a>.
There are two embeddings models in this flow that you can replace with <strong>Hugging Face</strong> embeddings inference components.</li>
<li>Replace both <strong>OpenAI</strong> embeddings model components with <strong>Hugging Face</strong> model components.</li>
<li>Connect both <strong>Hugging Face</strong> components to the <strong>Embeddings</strong> ports of the <strong>Astra DB vector store</strong> components.</li>
<li>In the <strong>Hugging Face</strong> components, set the <strong>Inference Endpoint</strong> field to the URL of your local inference model. <strong>The <strong>API Key</strong> field is not required for local inference.</strong></li>
<li>Run the flow. The local inference models generate embeddings for the input text.</li>
</ol>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="lm-studio-embeddings">LM Studio Embeddings<a href="#lm-studio-embeddings" class="hash-link" aria-label="Direct link to LM Studio Embeddings" title="Direct link to LM Studio Embeddings">​</a></h2>
<p>This component generates embeddings using <a href="https://lmstudio.ai/docs" target="_blank" rel="noopener noreferrer">LM Studio</a> models.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-10">Inputs<a href="#inputs-10" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>model</td><td>Model</td><td>The LM Studio model to use for generating embeddings</td></tr><tr><td>base_url</td><td>LM Studio Base URL</td><td>The base URL for the LM Studio API</td></tr><tr><td>api_key</td><td>LM Studio API Key</td><td>API key for authentication with LM Studio</td></tr><tr><td>temperature</td><td>Model Temperature</td><td>Temperature setting for the model</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-10">Outputs<a href="#outputs-10" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>embeddings</td><td>Embeddings</td><td>The generated embeddings</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="mistralai">MistralAI<a href="#mistralai" class="hash-link" aria-label="Direct link to MistralAI" title="Direct link to MistralAI">​</a></h2>
<p>This component generates embeddings using <a href="https://docs.mistral.ai/" target="_blank" rel="noopener noreferrer">MistralAI</a> models.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-11">Inputs<a href="#inputs-11" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>model</td><td>String</td><td>The MistralAI model to use (default: &quot;mistral-embed&quot;)</td></tr><tr><td>mistral_api_key</td><td>SecretString</td><td>API key for authenticating with MistralAI</td></tr><tr><td>max_concurrent_requests</td><td>Integer</td><td>Maximum number of concurrent API requests (default: 64)</td></tr><tr><td>max_retries</td><td>Integer</td><td>Maximum number of retry attempts for failed requests (default: 5)</td></tr><tr><td>timeout</td><td>Integer</td><td>Request timeout in seconds (default: 120)</td></tr><tr><td>endpoint</td><td>String</td><td>Custom API endpoint URL (default: <code>https://api.mistral.ai/v1/</code>)</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-11">Outputs<a href="#outputs-11" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>embeddings</td><td>Embeddings</td><td>MistralAIEmbeddings instance for generating embeddings</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="nvidia">NVIDIA<a href="#nvidia" class="hash-link" aria-label="Direct link to NVIDIA" title="Direct link to NVIDIA">​</a></h2>
<p>This component generates embeddings using <a href="https://docs.nvidia.com" target="_blank" rel="noopener noreferrer">NVIDIA models</a>.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-12">Inputs<a href="#inputs-12" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>model</td><td>String</td><td>The NVIDIA model to use for embeddings (e.g., <code>nvidia/nv-embed-v1</code>)</td></tr><tr><td>base_url</td><td>String</td><td>Base URL for the NVIDIA API (default: <code>https://integrate.api.nvidia.com/v1</code>)</td></tr><tr><td>nvidia_api_key</td><td>SecretString</td><td>API key for authenticating with NVIDIA&#x27;s service</td></tr><tr><td>temperature</td><td>Float</td><td>Model temperature for embedding generation (default: <code>0.1</code>)</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-12">Outputs<a href="#outputs-12" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>embeddings</td><td>Embeddings</td><td>NVIDIAEmbeddings instance for generating embeddings</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="ollama-embeddings">Ollama Embeddings<a href="#ollama-embeddings" class="hash-link" aria-label="Direct link to Ollama Embeddings" title="Direct link to Ollama Embeddings">​</a></h2>
<p>This component generates embeddings using <a href="https://ollama.com/" target="_blank" rel="noopener noreferrer">Ollama models</a>.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-13">Inputs<a href="#inputs-13" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>Ollama Model</td><td>String</td><td>Name of the Ollama model to use (default: <code>llama2</code>)</td></tr><tr><td>Ollama Base URL</td><td>String</td><td>Base URL of the Ollama API (default: <code>http://localhost:11434</code>)</td></tr><tr><td>Model Temperature</td><td>Float</td><td>Temperature parameter for the model. Adjusts the randomness in the generated embeddings</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-13">Outputs<a href="#outputs-13" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>embeddings</td><td>Embeddings</td><td>An instance for generating embeddings using Ollama</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="openai-embeddings">OpenAI Embeddings<a href="#openai-embeddings" class="hash-link" aria-label="Direct link to OpenAI Embeddings" title="Direct link to OpenAI Embeddings">​</a></h2>
<p>This component is used to load embedding models from <a href="https://openai.com/" target="_blank" rel="noopener noreferrer">OpenAI</a>.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-14">Inputs<a href="#inputs-14" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>OpenAI API Key</td><td>String</td><td>The API key to use for accessing the OpenAI API</td></tr><tr><td>Default Headers</td><td>Dict</td><td>Default headers for the HTTP requests</td></tr><tr><td>Default Query</td><td>NestedDict</td><td>Default query parameters for the HTTP requests</td></tr><tr><td>Allowed Special</td><td>List</td><td>Special tokens allowed for processing (default: <code>[]</code>)</td></tr><tr><td>Disallowed Special</td><td>List</td><td>Special tokens disallowed for processing (default: <code>[&quot;all&quot;]</code>)</td></tr><tr><td>Chunk Size</td><td>Integer</td><td>Chunk size for processing (default: <code>1000</code>)</td></tr><tr><td>Client</td><td>Any</td><td>HTTP client for making requests</td></tr><tr><td>Deployment</td><td>String</td><td>Deployment name for the model (default: <code>text-embedding-3-small</code>)</td></tr><tr><td>Embedding Context Length</td><td>Integer</td><td>Length of embedding context (default: <code>8191</code>)</td></tr><tr><td>Max Retries</td><td>Integer</td><td>Maximum number of retries for failed requests (default: <code>6</code>)</td></tr><tr><td>Model</td><td>String</td><td>Name of the model to use (default: <code>text-embedding-3-small</code>)</td></tr><tr><td>Model Kwargs</td><td>NestedDict</td><td>Additional keyword arguments for the model</td></tr><tr><td>OpenAI API Base</td><td>String</td><td>Base URL of the OpenAI API</td></tr><tr><td>OpenAI API Type</td><td>String</td><td>Type of the OpenAI API</td></tr><tr><td>OpenAI API Version</td><td>String</td><td>Version of the OpenAI API</td></tr><tr><td>OpenAI Organization</td><td>String</td><td>Organization associated with the API key</td></tr><tr><td>OpenAI Proxy</td><td>String</td><td>Proxy server for the requests</td></tr><tr><td>Request Timeout</td><td>Float</td><td>Timeout for the HTTP requests</td></tr><tr><td>Show Progress Bar</td><td>Boolean</td><td>Whether to show a progress bar for processing (default: <code>False</code>)</td></tr><tr><td>Skip Empty</td><td>Boolean</td><td>Whether to skip empty inputs (default: <code>False</code>)</td></tr><tr><td>TikToken Enable</td><td>Boolean</td><td>Whether to enable TikToken (default: <code>True</code>)</td></tr><tr><td>TikToken Model Name</td><td>String</td><td>Name of the TikToken model</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-14">Outputs<a href="#outputs-14" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>embeddings</td><td>Embeddings</td><td>An instance for generating embeddings using OpenAI</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="text-embedder">Text embedder<a href="#text-embedder" class="hash-link" aria-label="Direct link to Text embedder" title="Direct link to Text embedder">​</a></h2>
<p>This component generates embeddings for a given message using a specified embedding model.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-15">Inputs<a href="#inputs-15" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>embedding_model</td><td>Embedding Model</td><td>The embedding model to use for generating embeddings.</td></tr><tr><td>message</td><td>Message</td><td>The message for which to generate embeddings.</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-15">Outputs<a href="#outputs-15" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>embeddings</td><td>Embedding Data</td><td>Data object containing the original text and its embedding vector.</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="vertexai-embeddings">VertexAI Embeddings<a href="#vertexai-embeddings" class="hash-link" aria-label="Direct link to VertexAI Embeddings" title="Direct link to VertexAI Embeddings">​</a></h2>
<p>This component is a wrapper around <a href="https://cloud.google.com/vertex-ai" target="_blank" rel="noopener noreferrer">Google Vertex AI</a> <a href="https://cloud.google.com/vertex-ai/docs/generative-ai/embeddings/get-text-embeddings" target="_blank" rel="noopener noreferrer">Embeddings API</a>.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-16">Inputs<a href="#inputs-16" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>credentials</td><td>Credentials</td><td>The default custom credentials to use</td></tr><tr><td>location</td><td>String</td><td>The default location to use when making API calls (default: <code>us-central1</code>)</td></tr><tr><td>max_output_tokens</td><td>Integer</td><td>Token limit determines the maximum amount of text output from one prompt (default: <code>128</code>)</td></tr><tr><td>model_name</td><td>String</td><td>The name of the Vertex AI large language model (default: <code>text-bison</code>)</td></tr><tr><td>project</td><td>String</td><td>The default GCP project to use when making Vertex API calls</td></tr><tr><td>request_parallelism</td><td>Integer</td><td>The amount of parallelism allowed for requests issued to VertexAI models (default: <code>5</code>)</td></tr><tr><td>temperature</td><td>Float</td><td>Tunes the degree of randomness in text generations. Should be a non-negative value (default: <code>0</code>)</td></tr><tr><td>top_k</td><td>Integer</td><td>How the model selects tokens for output, the next token is selected from the top <code>k</code> tokens (default: <code>40</code>)</td></tr><tr><td>top_p</td><td>Float</td><td>Tokens are selected from the most probable to least until the sum of their probabilities exceeds the top <code>p</code> value (default: <code>0.95</code>)</td></tr><tr><td>tuned_model_name</td><td>String</td><td>The name of a tuned model. If provided, <code>model_name</code> is ignored</td></tr><tr><td>verbose</td><td>Boolean</td><td>This parameter controls the level of detail in the output. When set to <code>True</code>, it prints internal states of the chain to help debug (default: <code>False</code>)</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-16">Outputs<a href="#outputs-16" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>embeddings</td><td>Embeddings</td><td>An instance for generating embeddings using VertexAI</td></tr></tbody></table></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/components-data"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Data</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/components-helpers"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Helpers</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#use-an-embeddings-model-component-in-a-flow" class="table-of-contents__link toc-highlight">Use an embeddings model component in a flow</a></li><li><a href="#aiml" class="table-of-contents__link toc-highlight">AI/ML</a><ul><li><a href="#inputs" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#amazon-bedrock-embeddings" class="table-of-contents__link toc-highlight">Amazon Bedrock Embeddings</a><ul><li><a href="#inputs-1" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-1" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#astra-db-vectorize" class="table-of-contents__link toc-highlight">Astra DB vectorize</a><ul><li><a href="#inputs-2" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-2" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#azure-openai-embeddings" class="table-of-contents__link toc-highlight">Azure OpenAI Embeddings</a><ul><li><a href="#inputs-3" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-3" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#cloudflare-workers-ai-embeddings" class="table-of-contents__link toc-highlight">Cloudflare Workers AI Embeddings</a><ul><li><a href="#inputs-4" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-4" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#cohere-embeddings" class="table-of-contents__link toc-highlight">Cohere Embeddings</a><ul><li><a href="#inputs-5" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-5" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#embedding-similarity" class="table-of-contents__link toc-highlight">Embedding similarity</a><ul><li><a href="#inputs-6" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-6" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#google-generative-ai-embeddings" class="table-of-contents__link toc-highlight">Google generative AI embeddings</a><ul><li><a href="#inputs-7" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-7" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#hugging-face-embeddings" class="table-of-contents__link toc-highlight">Hugging Face Embeddings</a><ul><li><a href="#inputs-8" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-8" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#hugging-face-embeddings-inference" class="table-of-contents__link toc-highlight">Hugging Face embeddings inference</a><ul><li><a href="#inputs-9" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-9" class="table-of-contents__link toc-highlight">Outputs</a></li><li><a href="#connect-the-hugging-face-component-to-a-local-embeddings-model" class="table-of-contents__link toc-highlight">Connect the Hugging Face component to a local embeddings model</a></li></ul></li><li><a href="#lm-studio-embeddings" class="table-of-contents__link toc-highlight">LM Studio Embeddings</a><ul><li><a href="#inputs-10" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-10" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#mistralai" class="table-of-contents__link toc-highlight">MistralAI</a><ul><li><a href="#inputs-11" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-11" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#nvidia" class="table-of-contents__link toc-highlight">NVIDIA</a><ul><li><a href="#inputs-12" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-12" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#ollama-embeddings" class="table-of-contents__link toc-highlight">Ollama Embeddings</a><ul><li><a href="#inputs-13" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-13" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#openai-embeddings" class="table-of-contents__link toc-highlight">OpenAI Embeddings</a><ul><li><a href="#inputs-14" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-14" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#text-embedder" class="table-of-contents__link toc-highlight">Text embedder</a><ul><li><a href="#inputs-15" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-15" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#vertexai-embeddings" class="table-of-contents__link toc-highlight">VertexAI Embeddings</a><ul><li><a href="#inputs-16" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-16" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li></ul></div></div></div></div></main></div></div></div><div style="position:fixed;right:20px;bottom:20px;z-index:100;display:flex;align-items:center;gap:10px;cursor:pointer"><div style="background-color:#f6f6f6;border-radius:50%;width:48px;height:48px;display:flex;align-items:center;justify-content:center;box-shadow:0 2px 4px rgba(0,0,0,0.1)"><img src="/img/langflow-icon-black-transparent.svg" style="width:40px" alt="Search"></div></div></div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink