Files
langflow/components-embedding-models.html
2024-07-12 21:10:12 +00:00

526 lines
40 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.

This file contains Unicode characters that might be confused with other characters. 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.4.0">
<title data-rh="true">Embedding Models | 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://langflow-ai.github.io/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="Embedding Models | Langflow Documentation"><meta data-rh="true" name="description" content="Amazon Bedrock Embeddings"><meta data-rh="true" property="og:description" content="Amazon Bedrock Embeddings"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://langflow-ai.github.io/components-embedding-models"><link data-rh="true" rel="alternate" href="https://langflow-ai.github.io/components-embedding-models" hreflang="en"><link data-rh="true" rel="alternate" href="https://langflow-ai.github.io/components-embedding-models" hreflang="x-default"><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="stylesheet" href="/assets/css/styles.0752b4d1.css">
<script src="/assets/js/runtime~main.6f36853e.js" defer="defer"></script>
<script src="/assets/js/main.85ea0f63.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<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/chain.png" alt="Langflow" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/chain.png" alt="Langflow" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">Langflow</b></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"><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"></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/chain.png" alt="Langflow" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/chain.png" alt="Langflow" class="themedComponent_mlkZ themedComponent--dark_xIcU"><b>Langflow</b></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-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" role="button" aria-expanded="true" href="/whats-new-a-new-chapter-langflow">Whats New?</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="/whats-new-a-new-chapter-langflow">1.0 - A new chapter for Langflow</a></li></ul></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" role="button" aria-expanded="true" href="/">Getting Started</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="/">👋 Welcome to Langflow</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="/getting-started-installation">📦 Installation</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="/getting-started-quickstart">⚡️ Quickstart</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="/getting-started-common-installation-issues">❗️ Common Installation Issues</a></li></ul></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" role="button" aria-expanded="true" href="/starter-projects-basic-prompting">Starter Projects</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="/starter-projects-basic-prompting">Basic Prompting</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="/starter-projects-blog-writer">Blog Writer</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="/starter-projects-document-qa">Document QA</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="/starter-projects-memory-chatbot">Memory Chatbot</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="/starter-projects-vector-store-rag">Vector Store RAG</a></li></ul></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" role="button" aria-expanded="true" href="/guides-new-to-llms">Guides</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="/guides-new-to-llms">📚 New to LLMs?</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="/guides-chat-memory">Chat Memory</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="/guides-data-message">Data &amp; Message</a></li></ul></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" href="/workspace">Workspace</a><button aria-label="Collapse sidebar category &#x27;Workspace&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></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="/workspace-playground">Playground</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="/workspace-api">API</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="/workspace-logs">Logs</a></li></ul></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--active" href="/components">Components</a><button aria-label="Collapse sidebar category &#x27;Components&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></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-io">Inputs &amp; 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-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-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" 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-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 menu__link--active" aria-current="page" tabindex="0" href="/components-embedding-models">Embedding 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-vector-stores">Vector Stores</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">Custom Components</a></li></ul></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" role="button" aria-expanded="true" href="/deployment-hugging-face-spaces">Deployment</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="/deployment-hugging-face-spaces">🤗 Spaces</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="/deployment-kubernetes">Kubernetes</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="/deployment-docker">Docker</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="/deployment-gcp">GCP</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="/deployment-render">Render</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="/deployment-railway">Railway</a></li></ul></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" role="button" aria-expanded="true" href="/settings-global-variables">Settings</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="/settings-global-variables">Global Variables</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="/settings-project-general-settings">Project &amp; General Settings</a></li></ul></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" role="button" aria-expanded="true" href="/configuration-authentication">Configuration</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="/configuration-authentication">Authentication</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="/configuration-api-keys">API Keys</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="/configuration-cli">Command Line Interface (CLI)</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="/365085a8-a90a-43f9-a779-f8769ec7eca1">Folders</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="/configuration-backend-only">Backend-Only</a></li></ul></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" role="button" aria-expanded="true" href="/integrations-langsmith">Integrations</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="/integrations-langsmith">LangSmith</a></li></ul></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" role="button" aria-expanded="true" href="/contributing-telemetry">Contributing</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="/contributing-telemetry">Telemetry</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="/contributing-how-to-contribute">How to contribute?</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="/contributing-github-issues">GitHub Issues</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="/contributing-community">Community</a></li></ul></li></ul></nav><button type="button" title="Collapse sidebar" aria-label="Collapse sidebar" class="button button--secondary button--outline collapseSidebarButton_PEFL"><svg width="20" height="20" aria-hidden="true" class="collapseSidebarButtonIcon_kv0_"><g fill="#7a7a7a"><path d="M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"></path><path d="M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"></path></g></svg></button></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 itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/components"><span itemprop="name">Components</span></a><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">Embedding Models</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>Embedding Models</h1></header><h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="4ddcfde8c1664e358d3f16d718e944d8">Amazon Bedrock Embeddings<a class="hash-link" aria-label="Direct link to Amazon Bedrock Embeddings" title="Direct link to Amazon Bedrock Embeddings" href="/components-embedding-models#4ddcfde8c1664e358d3f16d718e944d8"></a></h2>
<p>Used to load embedding models from <a href="https://aws.amazon.com/bedrock/" target="_blank" rel="noopener noreferrer">Amazon Bedrock</a>.</p>
<table><thead><tr><th><strong>Parameter</strong></th><th><strong>Type</strong></th><th><strong>Description</strong></th><th><strong>Default</strong></th></tr></thead><tbody><tr><td><code>credentials_profile_name</code></td><td><code>str</code></td><td>Name of the AWS credentials profile in ~/.aws/credentials or ~/.aws/config, which has access keys or role information.</td><td></td></tr><tr><td><code>model_id</code></td><td><code>str</code></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><td></td></tr><tr><td><code>endpoint_url</code></td><td><code>str</code></td><td>URL to set a specific service endpoint other than the default AWS endpoint.</td><td></td></tr><tr><td><code>region_name</code></td><td><code>str</code></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><td></td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="c1e6d1373824424ea130e052ba0f46af">Astra vectorize<a class="hash-link" aria-label="Direct link to Astra vectorize" title="Direct link to Astra vectorize" href="/components-embedding-models#c1e6d1373824424ea130e052ba0f46af"></a></h2>
<p>Used to generate server-side embeddings using <a href="https://docs.datastax.com/en/astra-db-serverless/databases/embedding-generation.html" target="_blank" rel="noopener noreferrer">DataStax Astra</a>.</p>
<table><thead><tr><th><strong>Parameter</strong></th><th><strong>Type</strong></th><th><strong>Description</strong></th><th><strong>Default</strong></th></tr></thead><tbody><tr><td><code>provider</code></td><td><code>str</code></td><td>The embedding provider to use.</td><td></td></tr><tr><td><code>model_name</code></td><td><code>str</code></td><td>The embedding model to use.</td><td></td></tr><tr><td><code>authentication</code></td><td><code>dict</code></td><td>Authentication parameters. Use the Astra Portal to add the embedding provider integration to your Astra organization.</td><td></td></tr><tr><td><code>provider_api_key</code></td><td><code>str</code></td><td>An alternative to the Astra Authentication that let you use directly the API key of the provider.</td><td></td></tr><tr><td><code>model_parameters</code></td><td><code>dict</code></td><td>Additional model parameters.</td><td></td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="0c5b7b8790da448fabd4c5ddba1fcbde">Cohere Embeddings<a class="hash-link" aria-label="Direct link to Cohere Embeddings" title="Direct link to Cohere Embeddings" href="/components-embedding-models#0c5b7b8790da448fabd4c5ddba1fcbde"></a></h2>
<p>Used to load embedding models from <a href="https://cohere.com/" target="_blank" rel="noopener noreferrer">Cohere</a>.</p>
<table><thead><tr><th><strong>Parameter</strong></th><th><strong>Type</strong></th><th><strong>Description</strong></th><th><strong>Default</strong></th></tr></thead><tbody><tr><td><code>cohere_api_key</code></td><td><code>str</code></td><td>API key required to authenticate with the Cohere service.</td><td></td></tr><tr><td><code>model</code></td><td><code>str</code></td><td>Language model used for embedding text documents and performing queries.</td><td><code>embed-english-v2.0</code></td></tr><tr><td><code>truncate</code></td><td><code>bool</code></td><td>Whether to truncate the input text to fit within the model&#x27;s constraints.</td><td><code>False</code></td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="8ffb790d5a6c484dab3fe6c777638a44">Azure OpenAI Embeddings<a class="hash-link" aria-label="Direct link to Azure OpenAI Embeddings" title="Direct link to Azure OpenAI Embeddings" href="/components-embedding-models#8ffb790d5a6c484dab3fe6c777638a44"></a></h2>
<p>Generate embeddings using Azure OpenAI models.</p>
<table><thead><tr><th><strong>Parameter</strong></th><th><strong>Type</strong></th><th><strong>Description</strong></th><th><strong>Default</strong></th></tr></thead><tbody><tr><td><code>Azure Endpoint</code></td><td><code>str</code></td><td>Your Azure endpoint, including the resource. Example: <code>https://example-resource.azure.openai.com/</code></td><td></td></tr><tr><td><code>Deployment Name</code></td><td><code>str</code></td><td>The name of the deployment.</td><td></td></tr><tr><td><code>API Version</code></td><td><code>str</code></td><td>The API version to use, options include various dates.</td><td></td></tr><tr><td><code>API Key</code></td><td><code>str</code></td><td>The API key to access the Azure OpenAI service.</td><td></td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="8536e4ee907b48688e603ae9bf7822cb">Hugging Face API Embeddings<a class="hash-link" aria-label="Direct link to Hugging Face API Embeddings" title="Direct link to Hugging Face API Embeddings" href="/components-embedding-models#8536e4ee907b48688e603ae9bf7822cb"></a></h2>
<p>Generate embeddings using Hugging Face Inference API models.</p>
<table><thead><tr><th><strong>Parameter</strong></th><th><strong>Type</strong></th><th><strong>Description</strong></th><th><strong>Default</strong></th></tr></thead><tbody><tr><td><code>API Key</code></td><td><code>str</code></td><td>API key for accessing the Hugging Face Inference API.</td><td></td></tr><tr><td><code>API URL</code></td><td><code>str</code></td><td>URL of the Hugging Face Inference API.</td><td><code>http://localhost:8080</code></td></tr><tr><td><code>Model Name</code></td><td><code>str</code></td><td>Name of the model to use for embeddings.</td><td><code>BAAI/bge-large-en-v1.5</code></td></tr><tr><td><code>Cache Folder</code></td><td><code>str</code></td><td>Folder path to cache Hugging Face models.</td><td></td></tr><tr><td><code>Encode Kwargs</code></td><td><code>dict</code></td><td>Additional arguments for the encoding process.</td><td></td></tr><tr><td><code>Model Kwargs</code></td><td><code>dict</code></td><td>Additional arguments for the model.</td><td></td></tr><tr><td><code>Multi Process</code></td><td><code>bool</code></td><td>Whether to use multiple processes.</td><td><code>False</code></td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="b2b74732874743d3be6fdf8aae049e74">Hugging Face Embeddings<a class="hash-link" aria-label="Direct link to Hugging Face Embeddings" title="Direct link to Hugging Face Embeddings" href="/components-embedding-models#b2b74732874743d3be6fdf8aae049e74"></a></h2>
<p>Used to load embedding models from <a href="https://huggingface.co/" target="_blank" rel="noopener noreferrer">HuggingFace</a>.</p>
<table><thead><tr><th><strong>Parameter</strong></th><th><strong>Type</strong></th><th><strong>Description</strong></th><th><strong>Default</strong></th></tr></thead><tbody><tr><td><code>Cache Folder</code></td><td><code>str</code></td><td>Folder path to cache HuggingFace models.</td><td></td></tr><tr><td><code>Encode Kwargs</code></td><td><code>dict</code></td><td>Additional arguments for the encoding process.</td><td></td></tr><tr><td><code>Model Kwargs</code></td><td><code>dict</code></td><td>Additional arguments for the model.</td><td></td></tr><tr><td><code>Model Name</code></td><td><code>str</code></td><td>Name of the HuggingFace model to use.</td><td><code>sentence-transformers/all-mpnet-base-v2</code></td></tr><tr><td><code>Multi Process</code></td><td><code>bool</code></td><td>Whether to use multiple processes.</td><td><code>False</code></td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="af7630df05a245d1a632e1bf6db2a4c5">OpenAI Embeddings<a class="hash-link" aria-label="Direct link to OpenAI Embeddings" title="Direct link to OpenAI Embeddings" href="/components-embedding-models#af7630df05a245d1a632e1bf6db2a4c5"></a></h2>
<p>Used to load embedding models from <a href="https://openai.com/" target="_blank" rel="noopener noreferrer">OpenAI</a>.</p>
<table><thead><tr><th><strong>Parameter</strong></th><th><strong>Type</strong></th><th><strong>Description</strong></th><th><strong>Default</strong></th></tr></thead><tbody><tr><td><code>OpenAI API Key</code></td><td><code>str</code></td><td>The API key to use for accessing the OpenAI API.</td><td></td></tr><tr><td><code>Default Headers</code></td><td><code>Dict[str, str]</code></td><td>Default headers for the HTTP requests.</td><td></td></tr><tr><td><code>Default Query</code></td><td><code>NestedDict</code></td><td>Default query parameters for the HTTP requests.</td><td></td></tr><tr><td><code>Allowed Special</code></td><td><code>List[str]</code></td><td>Special tokens allowed for processing.</td><td><code>[]</code></td></tr><tr><td><code>Disallowed Special</code></td><td><code>List[str]</code></td><td>Special tokens disallowed for processing.</td><td><code>[&quot;all&quot;]</code></td></tr><tr><td><code>Chunk Size</code></td><td><code>int</code></td><td>Chunk size for processing.</td><td><code>1000</code></td></tr><tr><td><code>Client</code></td><td><code>Any</code></td><td>HTTP client for making requests.</td><td></td></tr><tr><td><code>Deployment</code></td><td><code>str</code></td><td>Deployment name for the model.</td><td><code>text-embedding-3-small</code></td></tr><tr><td><code>Embedding Context Length</code></td><td><code>int</code></td><td>Length of embedding context.</td><td><code>8191</code></td></tr><tr><td><code>Max Retries</code></td><td><code>int</code></td><td>Maximum number of retries for failed requests.</td><td><code>6</code></td></tr><tr><td><code>Model</code></td><td><code>str</code></td><td>Name of the model to use.</td><td><code>text-embedding-3-small</code></td></tr><tr><td><code>Model Kwargs</code></td><td><code>NestedDict</code></td><td>Additional keyword arguments for the model.</td><td></td></tr><tr><td><code>OpenAI API Base</code></td><td><code>str</code></td><td>Base URL of the OpenAI API.</td><td></td></tr><tr><td><code>OpenAI API Type</code></td><td><code>str</code></td><td>Type of the OpenAI API.</td><td></td></tr><tr><td><code>OpenAI API Version</code></td><td><code>str</code></td><td>Version of the OpenAI API.</td><td></td></tr><tr><td><code>OpenAI Organization</code></td><td><code>str</code></td><td>Organization associated with the API key.</td><td></td></tr><tr><td><code>OpenAI Proxy</code></td><td><code>str</code></td><td>Proxy server for the requests.</td><td></td></tr><tr><td><code>Request Timeout</code></td><td><code>float</code></td><td>Timeout for the HTTP requests.</td><td></td></tr><tr><td><code>Show Progress Bar</code></td><td><code>bool</code></td><td>Whether to show a progress bar for processing.</td><td><code>False</code></td></tr><tr><td><code>Skip Empty</code></td><td><code>bool</code></td><td>Whether to skip empty inputs.</td><td><code>False</code></td></tr><tr><td><code>TikToken Enable</code></td><td><code>bool</code></td><td>Whether to enable TikToken.</td><td><code>True</code></td></tr><tr><td><code>TikToken Model Name</code></td><td><code>str</code></td><td>Name of the TikToken model.</td><td></td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="a26d2cb92e6d44669c2cfff71a5e9431">Ollama Embeddings<a class="hash-link" aria-label="Direct link to Ollama Embeddings" title="Direct link to Ollama Embeddings" href="/components-embedding-models#a26d2cb92e6d44669c2cfff71a5e9431"></a></h2>
<p>Generate embeddings using Ollama models.</p>
<table><thead><tr><th><strong>Parameter</strong></th><th><strong>Type</strong></th><th><strong>Description</strong></th><th><strong>Default</strong></th></tr></thead><tbody><tr><td><code>Ollama Model</code></td><td><code>str</code></td><td>Name of the Ollama model to use.</td><td><code>llama2</code></td></tr><tr><td><code>Ollama Base URL</code></td><td><code>str</code></td><td>Base URL of the Ollama API.</td><td><code>http://localhost:11434</code></td></tr><tr><td><code>Model Temperature</code></td><td><code>float</code></td><td>Temperature parameter for the model. Adjusts the randomness in the generated embeddings.</td><td></td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="707b38c23cb9413fbbaab1ae7b872311">VertexAI Embeddings<a class="hash-link" aria-label="Direct link to VertexAI Embeddings" title="Direct link to VertexAI Embeddings" href="/components-embedding-models#707b38c23cb9413fbbaab1ae7b872311"></a></h2>
<p>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>
<table><thead><tr><th><strong>Parameter</strong></th><th><strong>Type</strong></th><th><strong>Description</strong></th><th><strong>Default</strong></th></tr></thead><tbody><tr><td><code>credentials</code></td><td><code>Credentials</code></td><td>The default custom credentials to use.</td><td></td></tr><tr><td><code>location</code></td><td><code>str</code></td><td>The default location to use when making API calls.</td><td><code>us-central1</code></td></tr><tr><td><code>max_output_tokens</code></td><td><code>int</code></td><td>Token limit determines the maximum amount of text output from one prompt.</td><td><code>128</code></td></tr><tr><td><code>model_name</code></td><td><code>str</code></td><td>The name of the Vertex AI large language model.</td><td><code>text-bison</code></td></tr><tr><td><code>project</code></td><td><code>str</code></td><td>The default GCP project to use when making Vertex API calls.</td><td></td></tr><tr><td><code>request_parallelism</code></td><td><code>int</code></td><td>The amount of parallelism allowed for requests issued to VertexAI models.</td><td><code>5</code></td></tr><tr><td><code>temperature</code></td><td><code>float</code></td><td>Tunes the degree of randomness in text generations. Should be a non-negative value.</td><td><code>0</code></td></tr><tr><td><code>top_k</code></td><td><code>int</code></td><td>How the model selects tokens for output, the next token is selected from the top <code>k</code> tokens.</td><td><code>40</code></td></tr><tr><td><code>top_p</code></td><td><code>float</code></td><td>Tokens are selected from the most probable to least until the sum of their probabilities exceeds the top <code>p</code> value.</td><td><code>0.95</code></td></tr><tr><td><code>tuned_model_name</code></td><td><code>str</code></td><td>The name of a tuned model. If provided, <code>model_name</code> is ignored.</td><td></td></tr><tr><td><code>verbose</code></td><td><code>bool</code></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.</td><td><code>False</code></td></tr></tbody></table>
<p><a href="/components-vector-stores">Previous Vector Stores</a></p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/components-models"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Models</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/components-vector-stores"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Vector Stores</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 class="table-of-contents__link toc-highlight" href="/components-embedding-models#4ddcfde8c1664e358d3f16d718e944d8">Amazon Bedrock Embeddings</a></li><li><a class="table-of-contents__link toc-highlight" href="/components-embedding-models#c1e6d1373824424ea130e052ba0f46af">Astra vectorize</a></li><li><a class="table-of-contents__link toc-highlight" href="/components-embedding-models#0c5b7b8790da448fabd4c5ddba1fcbde">Cohere Embeddings</a></li><li><a class="table-of-contents__link toc-highlight" href="/components-embedding-models#8ffb790d5a6c484dab3fe6c777638a44">Azure OpenAI Embeddings</a></li><li><a class="table-of-contents__link toc-highlight" href="/components-embedding-models#8536e4ee907b48688e603ae9bf7822cb">Hugging Face API Embeddings</a></li><li><a class="table-of-contents__link toc-highlight" href="/components-embedding-models#b2b74732874743d3be6fdf8aae049e74">Hugging Face Embeddings</a></li><li><a class="table-of-contents__link toc-highlight" href="/components-embedding-models#af7630df05a245d1a632e1bf6db2a4c5">OpenAI Embeddings</a></li><li><a class="table-of-contents__link toc-highlight" href="/components-embedding-models#a26d2cb92e6d44669c2cfff71a5e9431">Ollama Embeddings</a></li><li><a class="table-of-contents__link toc-highlight" href="/components-embedding-models#707b38c23cb9413fbbaab1ae7b872311">VertexAI Embeddings</a></li></ul></div></div></div></div></main></div></div></div><div id="ms-floating-button" class="ms-fixed ms-bottom-4 ms-right-8 ms-z-[100] ms-flex ms-flex-col ms-items-end hover:ms-cursor-pointer"><div class="ms-relative ms-mb-4"><div style="background-color:#f6f6f6" class="ms-absolute -ms-bottom-1 ms-right-6 -ms-z-10 ms-h-4 ms-w-4 ms-rotate-45"></div><div style="background-color:#f6f6f6" class="ms-z-10 ms-flex ms-items-center ms-justify-center ms-rounded-lg ms-px-3 ms-py-2"><p style="color:#000000;margin:0" class="ms-text-sm">Hi, how can I help you?</p></div></div><div style="background-color:#f6f6f6" class="ms-flex ms-h-16 ms-w-16 ms-flex-col ms-items-center ms-justify-center ms-self-end ms-rounded-full ms-p-2 ms-transition"><div class="ms-rotate-0 ms-flex ms-h-full ms-w-full ms-transform ms-cursor-pointer ms-items-center ms-justify-center ms-rounded-full ms-transition-all ms-delay-75 ms-duration-100 ms-ease-in-out"><div style="color:#000000;font-size:22px;width:48px;height:48px;margin:0px;padding:0px;display:flex;align-items:center;justify-content:center;text-align:center"><img src="/img/chain.png" style="width:40px"></div></div></div><div></div></div></div>
</body>
</html>