Introduction to Entities

<!DOCTYPE html><html lang="en" style="" data-color-mode="system" class=" useReactApp "><head><script src="https://cdn.readme.io/public/js/force-firefox-anchor-jump.js?1740772393201"></script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="readme-deploy" content="5.294.0"><meta name="readme-subdomain" content="voiceflow-developer"><meta name="readme-version" content="2.0"><title>Introduction to Entities</title><meta name="description" content="In the world of conversational agents, entities are the key pieces of information that you want to extract from a user's input. Think of entities as the nouns in a sentence鈥攖he who, what, where, and when that give meaning to the conversation. Whether you're capturing a user's name, booking a date, o..."><meta property="og:title" content="Introduction to Entities"><meta property="og:description" content="In the world of conversational agents, entities are the key pieces of information that you want to extract from a user's input. Think of entities as the nouns in a sentence鈥攖he who, what, where, and when that give meaning to the conversation. Whether you're capturing a user's name, booking a date, o..."><meta property="og:site_name" content="Voiceflow"><meta name="twitter:title" content="Introduction to Entities"><meta name="twitter:description" content="In the world of conversational agents, entities are the key pieces of information that you want to extract from a user's input. Think of entities as the nouns in a sentence鈥攖he who, what, where, and when that give meaning to the conversation. Whether you're capturing a user's name, booking a date, o..."><meta name="twitter:card" content="summary_large_image"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta property="og:image" content="https://files.readme.io/d7cb562-small-square-onyx-1024.png"><meta name="twitter:image" content="https://files.readme.io/d7cb562-small-square-onyx-1024.png"><link id="favicon" rel="shortcut icon" href="https://files.readme.io/6f6abbe-round-proto-1024.ico" type="image/x-icon"><link rel="canonical" href="https://docs.voiceflow.com/docs/introduction-to-entities"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1740772393201"></script><link data-chunk="Diff" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Diff.2ffb9cc7c7d91c2876e1.css"> <link data-chunk="New" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/New.b2c21b39a87b5c42c152.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.46c7cd50bf55e4372327.css"> <link data-chunk="Page" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Page.b2c21b39a87b5c42c152.css"> <link data-chunk="routes-Discuss" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Discuss.571e99fd5e02a59c06dd.css"> <link data-chunk="routes-Changelog" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="routes-Tutorials" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.c978ddef3555c7447f00.css"> <link data-chunk="routes-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-PageNotFound" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.f7ce97dc8d07fa3e6aaa.css"> <link data-chunk="routes-Reference" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Reference.60a8dcec37a13b0b71c5.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.23606d783f007047768a.css"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.7f77cac277dcc8a3d6b8.css"> <link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.074b2cb2cc57c5a5979d.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.f1a708954fcb2985d9f6.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/7188.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/main.ef84cc15c1ff3d327657.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.15432b2b5da9013070bb.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.5291198bd71a134466e9.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6601.cef2fa12a9b5e2b9df03.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3622.30b9cb2443fabb238262.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.dcd45762ee393f583fea.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4904.df63e6b74f3878787175.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7372.4f5a59d2f86c6ece493b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/734.2949e3d7010fa5c21ffd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/954.53ce7f86793664155f78.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6903.75b9333e2c99d6924d0e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.93b03fc4eb8efabb08a7.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8161.c06bb55544d4d5ece838.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1008.4c339ef2e2b87bbd1d0b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7188.9cd5fd7fe0a05ab94dea.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5753.887d4d8ae5466a3f3b2a.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.6d52d3d479e7e6844ace.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9930.8ac6b4156bf4ee8644e6.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.2497238876f4f363107c.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.85a768f818d97858fce7.js"> <link data-chunk="core-icons-chevron-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"> <link data-chunk="core-icons-chevron-up-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"> <link data-chunk="core-icons-search-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"> <link data-chunk="core-icons-custom-pages-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7717.c3f46aef4dac129abcfb.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5359.fb0c48929b1827a8a2b2.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5948.a51402657e2eb40ab43b.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4201.fe60df69c20b2ce54513.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8230.128cfdd53c803eea12b2.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.5cae0557d05c869c77bf.js"> <link data-chunk="core-icons-book-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-book-svg.556c5a2abddd44b2284c.js"> <link data-chunk="core-icons-key-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"> <link data-chunk="core-icons-alert-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"> <link data-chunk="core-icons-more-vertical-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"> <link data-chunk="core-icons-lock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.43a913423ff21c406134.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.85c89705122f7bc8f4f3.js"> <link data-chunk="core-icons-x-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"> <link data-chunk="core-icons-suggested-edits-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.f1f59d6d6f3fec6c0a4e.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.f81f304a0f9e9f73d47e.js"> <link data-chunk="routes-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.852328ff472332820e4a.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2859.638ac41f3269eb8fe633.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4002.704e628347d37011965d.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.1ea18c7d8e69fc7252af.js"> <link data-chunk="core-icons-arrow-up-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"> <link data-chunk="routes-Tutorials" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.c491da97152573555d9f.js"> <link data-chunk="RMDX" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/RMDX.aefe00bd92fd4e78ab65.js"> <link data-chunk="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.80a45bec48d0ae892ab7.js"> <link data-chunk="Post" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Post.34fb79ca63e7ed2617d0.js"> <link data-chunk="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.dae2f8e80d2d75f106bd.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.f161cf21b4202fcf0f18.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Page.4e99fc9641c6a023c75a.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4674.6e1931c1363cea798412.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/List.a16df6acd7d10a15e9da.js"> <link data-chunk="core-icons-trending-up-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"> <link data-chunk="core-icons-callout-info-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"> <link data-chunk="core-icons-star-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"> <link data-chunk="core-icons-gauge-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-gauge-circle-svg.fff25782546fef314a09.js"> <link data-chunk="core-icons-message-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"> <link data-chunk="core-icons-eye-off-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"> <link data-chunk="core-icons-webhook-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"> <link data-chunk="core-icons-inbox-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-inbox-svg.01c2ecb759e417a98bb8.js"> <link data-chunk="New" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/New.88fc0ed9b34185288d64.js"> <link data-chunk="core-icons-megaphone-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-megaphone-svg.c4823f47f1244e78066e.js"> <link data-chunk="Diff" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5642.90129f27bfbf9bd8acd1.js"> <link data-chunk="Diff" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Diff.f4835442ecf2d8e738f9.js"> <link data-chunk="core-icons-edit-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-edit-svg.2702a4af6dbb1f7f46c5.js"> <link data-chunk="core-icons-eye-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-svg.b2103692a3c209893efe.js"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.15432b2b5da9013070bb.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.ef84cc15c1ff3d327657.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/7188.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.f1a708954fcb2985d9f6.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.074b2cb2cc57c5a5979d.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.7f77cac277dcc8a3d6b8.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.23606d783f007047768a.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.60a8dcec37a13b0b71c5.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.f7ce97dc8d07fa3e6aaa.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.c978ddef3555c7447f00.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.571e99fd5e02a59c06dd.css"> <link data-chunk="Page" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Page.b2c21b39a87b5c42c152.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.46c7cd50bf55e4372327.css"> <link data-chunk="New" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/New.b2c21b39a87b5c42c152.css"> <link data-chunk="Diff" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Diff.2ffb9cc7c7d91c2876e1.css"><style title="rm-custom-css">:root{--project-color-primary:#1F2428;--project-color-inverse:#fff;--recipe-button-color:#FFAC2F;--recipe-button-color-hover:#c87800;--recipe-button-color-active:#955a00;--recipe-button-color-focus:rgba(255, 172, 47, 0.25);--recipe-button-color-disabled:#fffdfb}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#1F2428;--project-color-inverse:#fff}a{color:var(--color-link-primary,#ffac2f)}a:hover{color:var(--color-link-primary-darken-5,#c87800)}a.text-muted:hover{color:var(--color-link-primary,#ffac2f)}.btn.btn-primary{background-color:#ffac2f}.btn.btn-primary:hover{background-color:#c87800}.theme-line #hub-landing-top h2{color:#ffac2f}#hub-landing-top .btn:hover{color:#ffac2f}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#1f2428}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#1f2428,#000)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(https://files.readme.io/d5b4013-ASCII_Black_No_Logo.png)}.theme-line header#hub-header #header-top{border-bottom-color:#1f2428}.theme-line header#hub-header #header-top .btn{background-color:#1f2428}header#hub-header #header-top #header-logo{width:218px;height:40px;margin-top:0;background-image:url(https://files.readme.io/edd48a8-Voiceflow-wordmark-light.svg)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#1f2428}#subheader-links a.active{color:#1f2428!important;box-shadow:inset 0 -2px 0 #1f2428}#subheader-links a:hover{color:#1f2428!important;box-shadow:inset 0 -2px 0 #1f2428;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#ffac2f}section#hub-discuss .discussion a .discuss-body h4{color:#ffac2f}section#hub-discuss .discussion a:hover .discuss-body h4{color:#c87800}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#ffac2f}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#ffac2f}#hub-search-results h3 em{color:#ffac2f}.main_background,.tag-item{background:#ffac2f!important}.main_background:hover{background:#c87800!important}.main_color{color:#1f2428!important}.border_bottom_main_color{border-bottom:2px solid #1f2428}.main_color_hover:hover{color:#1f2428!important}section#hub-discuss h1{color:#ffac2f}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#ffac2f;background-color:#ffac2f}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#c87800;border-color:#c87800}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#ffac2f;color:#ffac2f}#hub-reference .hub-reference .logs .logs-empty .logs-login-button,#hub-reference .hub-reference .logs .logs-login .logs-login-button{background-color:var(--project-color-primary,#ffac2f);border-color:var(--project-color-primary,#ffac2f)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#c87800;border-color:#c87800}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#ffac2f;fill:var(--project-color-primary,#ffac2f)}#hub-reference .hub-reference .logs:last-child .logs-empty,#hub-reference .hub-reference .logs:last-child .logs-login{margin-bottom:35px}#hub-reference .hub-reference .hub-reference-section .hub-reference-left header .hub-reference-edit:hover{color:#ffac2f}.main-color-accent{border-bottom:3px solid #1f2428;padding-bottom:8px}</style><meta name="loadedProject" content="voiceflow-developer"><script>var storedColorMode = `system` === 'system' ? window.localStorage.getItem('color-scheme') : `system` document.querySelector('[data-color-mode]').setAttribute('data-color-mode', storedColorMode)</script><script id="config" type="application/json" data-json="{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.294.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script></head><body class="body-none theme-solid header-custom header-bg-size-cover header-bg-pos-tr header-overlay-triangles reference-layout-row lumosity-dark "><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark " style="--color-primary:#1F2428;--color-primary-inverse:#fff;--color-primary-alt:#000000;--color-primary-darken-10:#090a0b;--color-primary-darken-20:#000000;--color-primary-alpha-25:rgba(31, 36, 40, 0.25);--color-link-primary:#FFAC2F;--color-link-primary-darken-5:#ffa215;--color-link-primary-darken-10:#fb9700;--color-link-primary-darken-20:#c87800;--color-link-primary-alpha-50:rgba(255, 172, 47, 0.5);--color-link-primary-alpha-25:rgba(255, 172, 47, 0.25);--color-link-background:rgba(255, 172, 47, 0.09);--color-link-text:#384248;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"><header class="Header3zzata9F_ZPQ rm-Header rm-Header_overlay rm-Header_overlay-custom rm-Header_custom rm-Header_custom-pos-top-right rm-Header_custom-size-cover" style="background-image:url(https://files.readme.io/d5b4013-ASCII_Black_No_Logo.png)"><div class="rm-Header-top Header-topuTMpygDG4e1V"><div class="rm-Container rm-Container_flex"><div style="outline:none" tabindex="-1"><a href="#content" target="_self" class="Button Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary">Jump to Content</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU"><a class="rm-Logo Header-logo1Xy41PtkzbdG" href="/docs" target="_self"><img alt="Voiceflow" class="rm-Logo-img Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/edd48a8-Voiceflow-wordmark-light.svg"/></a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF"><div><button aria-label="Toggle navigation menu" class="icon-menu menu3d6DYNDa3tk5" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><div class="MobileFlyout1hHJpUd-nYkd"><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/docs" target="_self"><i class="icon-guides NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Guides</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/reference" target="_self"><i class="icon-references NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">API Reference</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/changelog" target="_self"><i class="icon-changelog NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Changelog</span></a><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://link.voiceflow.com/community" rel="noopener" target="_blank" to="https://link.voiceflow.com/community">Join Discord</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://trust.voiceflow.com/" rel="noopener" target="_blank" to="https://trust.voiceflow.com/">Trust Center</a><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="/docs" target="_self"><img alt="Voiceflow" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/edd48a8-Voiceflow-wordmark-light.svg"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-guides Header-left-nav-icon10glJKFwewOv"></i>Guides</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://link.voiceflow.com/community" target="_self" to="https://link.voiceflow.com/community">Join Discord</a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://trust.voiceflow.com/" target="_self" to="https://trust.voiceflow.com/">Trust Center</a></span><div class="ThemeToggle-wrapper1M_iJESXCpGR Dropdown Dropdown_closed"><button aria-label="Toggle to light mode" id="ThemeToggle-button-static-id-placeholder" aria-haspopup="dialog" class="Button Button_slate_text Button_sm rm-ThemeToggle ThemeToggle2tVPbUyQbWDo Dropdown-toggle Button_primary" type="button"><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv " role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Moon (Dark Mode)</title><path d="M19 14.79C18.8427 16.4922 18.2039 18.1144 17.1582 19.4668C16.1126 20.8192 14.7035 21.8458 13.0957 22.4265C11.4879 23.0073 9.74798 23.1181 8.0795 22.7461C6.41102 22.3741 4.88299 21.5345 3.67423 20.3258C2.46546 19.117 1.62594 17.589 1.25391 15.9205C0.881876 14.252 0.992717 12.5121 1.57346 10.9043C2.1542 9.29651 3.18083 7.88737 4.53321 6.84175C5.8856 5.79614 7.5078 5.15731 9.21 5C8.21341 6.34827 7.73385 8.00945 7.85853 9.68141C7.98322 11.3534 8.70386 12.9251 9.8894 14.1106C11.0749 15.2961 12.6466 16.0168 14.3186 16.1415C15.9906 16.2662 17.6517 15.7866 19 14.79Z"></path><path class="ThemeToggle-Icon-star3wweJby1gM4w" d="M18.3707 1C18.3707 3.22825 16.2282 5.37069 14 5.37069C16.2282 5.37069 18.3707 7.51313 18.3707 9.74138C18.3707 7.51313 20.5132 5.37069 22.7414 5.37069C20.5132 5.37069 18.3707 3.22825 18.3707 1Z"></path></svg><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv ThemeToggle-Icon_active18I2-19CkbgD" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Sun (Light Mode)</title><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 1V3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 5.64L19.78 4.22"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M21 12H23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 18.36L19.78 19.78"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 21V23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 19.78L5.64 18.36"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M1 12H3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 4.22L5.64 5.64"></path><path d="M12 17C14.7614 17 17 14.7614 17 12C17 9.23858 14.7614 7 12 7C9.23858 7 7 9.23858 7 12C7 14.7614 9.23858 17 12 17Z"></path></svg></button></div></div></div></div><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom rm-Header-bottom_withOwlbot Header-bottom_withOwlbot3wuKp8NLXCqs"><div class="rm-Container rm-Container_flex"><nav class="Header-leftADQdGVqx1wqU"><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile active" href="/docs" target="_self"><i class="icon-guides"></i><span>Guides</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/reference" target="_self"><i class="icon-references"></i><span>API Reference</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/changelog" target="_self"><i class="icon-changelog"></i><span>Changelog</span></a></nav><button align="center" justify="between" style="--flex-gap:var(--xs)" class="Button Button_sm Flex Flex_row MobileSubnav1DsTfasXloM2 Button_contrast Button_contrast_outline" type="button"><span class="Button-label">Introduction to Entities</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="chevron-up-down" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="m6 16 6 6 6-6M18 8l-6-6-6 6" class="icon-stroke-width"></path></svg></span></button><div class="rm-Header-search Header-searchtb6Foi0-D9Vx Header-search_owlbot2iEpu0FSLYUx "></div></div></div><div class="hub-search-results--reactApp " id="hub-search-results"><div class="hub-container"><div class="modal-backdrop show-modal rm-SearchModal" role="button" tabindex="0"></div></div></div></header><main class="rm-Guides"><div class="rm-Container rm-Container_flex"><nav aria-label="Page navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj rm-Sidebar_guides" id="hub-sidebar"><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Getting Started</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/welcome"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Welcome to the docs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/voiceflow-in-your-stack"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">How Voiceflow fits in your tech stack</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/step-1"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Quick start guide" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Quick start guide</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/step-1"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Step 1: Create your agent</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/step-2"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Step 2: Get your API key</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/step-3"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Step 3: Deploy your agent</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/building-a-telecom-customer-support-agents-to-troubleshoot-complex-questions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Use cases" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Use cases</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/building-a-telecom-customer-support-agents-to-troubleshoot-complex-questions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Building a telecom customer support agent</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/removing-hallucinations-for-a-banking-customer-support-bot"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Removing hallucinations for a banking customer support agent</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/a-nyt-cooking-recipe-agent-using-rag"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">A NYT Cooking recipe agent using RAG</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/rebuilding-a-retail-stores-digital-agent"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Rebuilding Sephora's digital agent</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/managing-workspaces-teams"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Admin and support" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Admin and support</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/managing-workspaces-teams"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Managing workspaces and team members</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/sso"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Single Sign-On (SSO) and SAML support</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/roles-permissions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Roles and permissions</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/billing-plans"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Billing and plans</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/token-top-up"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Token Top-up</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/get-help"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get help</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/agent-settings"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Important Agent Settings</span></span></a></li></ul></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Courses</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/voiceflow-basics"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Voiceflow Basics" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Voiceflow Basics</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voiceflow-basics"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Part 1: Get Setup</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voiceflow-basics-workflows"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Part 2: Get Familiar with Workflows</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voiceflow-basics-user-input"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Part 3: Accept User Input</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/part-1-advanced-faq"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Build an AI Support Agent" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Build an AI Support Agent</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/part-1-advanced-faq"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Part 1: Answer Questions</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/part-2-sending-a-ticket-to-zendesk"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Part 2: Sending a Ticket to Zendesk</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/part-3-book-a-demo"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Part 3: Book a Demo</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/part-4-debugging"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Part 4: Deploy & Customize Webchat</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/guide-qna-chatbot-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Plan, Build, and Launch a Production Q&A Slack Agent" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Plan, Build, and Launch a Production Q&A Slack Agent</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/guide-qna-chatbot-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/guide-qna-chatbot-planning"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Planning</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/guide-qna-chatbot-building"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Building</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/guide-qna-chatbot-deploying"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">QA and Deploying</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/guide-qna-chatbot-technical-walkthrough"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Full Technical Walkthrough</span></span></a></li></ul></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Building Agents</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/building-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/workspaces-agents"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Platform fundamentals" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Platform fundamentals</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/workspaces-agents"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Workspaces and Agents</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/cms"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Content Management System (CMS)</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/canvas"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Canvas</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/steps-blocks"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Steps and Blocks</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/workflows"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Workflows</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/components"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Components</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/template-library"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Template Library</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/test-tool"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Test Tool</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/teams"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Collaboration features</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/sharing-prototypes"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Sharing Prototypes</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/publishing-environments-backups"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Publishing, Environments and Backups</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/languages"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Languages</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/importing-exporting"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Importing or exporting projects and functions</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/secrets-manager"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Secrets Manager</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/listen-fundamentals"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Understand" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Understand</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/listen-fundamentals"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Understanding: How AI Agents Understand User Inputs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/intents"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Intents" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Intents</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/intents"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Introduction to Intents</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/using-the-intent-cms"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Using the Intent CMS</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/llm-intent-classification-method"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Intent Classification using LLMs (Hybrid)</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/nlu-classification-method"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Intent Classification using NLU</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/previewing-intent-classification-and-improvements"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Previewing Intent Classification and Improvements</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/introduction-to-entities"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Entities" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Entities</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link active" target="_self" href="/docs/introduction-to-entities"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Introduction to Entities</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/using-the-entity-cms"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Using the Entities CMS</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/introduction-to-events"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Events" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Events</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/introduction-to-events"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Introduction to Events</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/using-the-events-cms"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Using Events</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/trigger"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Steps & Tools" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Steps & Tools</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/trigger"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Trigger</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/choice-v2"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Choice</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/capture-v2"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Capture</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/buttons-v2"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Buttons</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/memory"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Memory</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/understanding-heirarchy"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Improving understanding</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/decide-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Decide" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Decide</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/decide-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/variables-set"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Set</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/set-ai"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Set AI step</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/logic"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Conditions</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/actions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Actions</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/api-step"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">API step</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/javascript-step"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">JavaScript step</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/custom-functions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Functions" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Functions</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/custom-functions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Introduction to developing functions</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/developing-functions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Implementing function code</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/functions-listen"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Supporting listen in functions</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/function-step"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Function step</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/kb-search"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">KB Search</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/respond-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Respond" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Respond</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/respond-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/message"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Messages</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/images"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Images</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/cards-carousels"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Cards and Carousels</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/response-ai"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Response AI step</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/knowledge-base"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Knowledge Base</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/advanced-knowledge-base"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Advanced Knowledge Base</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/custom-actions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Custom Actions</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/no-match"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">No Match handling</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/no-reply-response"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">No Reply handling</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/prompt-step"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Prompt</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/general-best-practices"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Best Practices" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Best Practices</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/general-best-practices"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Getting started</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/knowledge-base-best-practices"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Knowledge Base</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/workflow-builder"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Workflow Builder</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/llm-fallback-system-beta"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">LLM Fallback (Beta)</span></span></a></li></ul></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Deploying Agents</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/deploying-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/web-chat-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Web Widget" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Web Widget</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/web-chat-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/web-chat-migration"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Webchat migration</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/chat-persistence"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Chat persistence</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/proactive-messages"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Proactive messages</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/custom-web-chat-widgets"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Custom forms and extensions</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/advanced-styling"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Custom styling</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/customization-configuration"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Adding custom variables</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/custom-configurations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Modify configurations</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/web-chat-api"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Custom triggers</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/embed-customize-styling"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Legacy Webchat" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Legacy Webchat</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/embed-customize-styling"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Embed and customize styling</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/react-chat"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Open sourced react-chat</span></span></a></li></ul></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/setting-up-twilio-integration"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Voice (Phone Number)" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Voice (Phone Number)</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/setting-up-twilio-integration"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Setting up Twilio integration</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/configuring-voice-settings"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Configuring voice settings</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/advanced-using-custom-voice-actions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Advanced - Using custom voice actions" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Advanced - Using custom voice actions</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/sip-functionality"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">SIP Functionality</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/outbound-calls"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Outbound Calls</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/interruption-behavior"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Interruption Behavior</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/examples"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Examples</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/text-deployment-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Text-based interfaces" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text-based interfaces</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/text-deployment-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/deploy-whatsapp"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">WhatsApp</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/deploy-discord"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Discord</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/deploy-slack"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Slack</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/deploy-telegram"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Telegram</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/deploy-twilio-sms"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Twilio SMS</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/deploy-ms-teams"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Microsoft Teams</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-deployment-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Voice-based interfaces" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Voice-based interfaces</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-deployment-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" rel="noopener" target="_blank" data-active="" href="https://xavidop.me/alexa/2023-11-21-voiceflow-alexa/"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Alexa</span></span><i aria-hidden="true" class="Sidebar-link-externalIcon1RcnjKm-3Ft8 icon-arrow-up-right"></i></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/elevenlabs-api-integration"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Custom TTS (ElevenLabs)</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/deploy-whisper-asr"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Custom ASR (Whisper)</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/custom-interfaces-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Custom interfaces and deploying through APIs" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Custom interfaces and deploying through APIs</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/custom-interfaces-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/custom-channel-api"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Custom deployment channel (API)</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/custom-interface-unity"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Unity AI Powered NPC</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/custom-interface-shopify"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Shopify In-Store Copilot</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/react-embedded-educhat"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Documentation Copilot</span></span></a></li></ul></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Improving Agents</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/custom-llm"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Agent enhancement cookbook" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Agent enhancement cookbook</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/custom-llm"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Bring your own LLM</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/langchain-knowledge-base"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Custom Knowledge Base</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/live-chat-handoff"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Live Chat Handoff</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/building-advanced-analytics"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Building Advanced Analytics</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/advanced-rag-filtering-and-tagging"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Advanced RAG Filtering and Tagging</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/adding-live-internet-search-to-your-rag-solution"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Adding live internet search to your RAG solution</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/pii-redaction-for-ai-agents"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">PII redaction for AI Agents</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/llmlingua2-prompt-compression"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">LLMLingua2 Prompt Compression</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/gpt4o-fallback-claude3-aigateway"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">GPT-4o with fallback to Claude 3 Sonnet</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/integrating-perplexity-into-voiceflow"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Integrating Perplexity into Voiceflow</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/automated-emails-with-user-transcripts"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Generate Automated Emails with User Transcripts</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/using-voiceflow-with-open-source-models"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Using Voiceflow with Open Source Models</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/custom-voices-for-your-agent-using-elevenlabs"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Custom Voices for your Agent using ElevenLabs</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/transcripts"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Transcripts</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/analytics"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Analytics</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Prompting and LLMs</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/prompts-cms-and-editor"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Prompts" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Prompts</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/prompts-cms-and-editor"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Prompts CMS</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/prompt-library"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Prompt Library</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/types-of-prompts"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Types of prompts</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/crafting-great-prompts"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Crafting great prompts</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/using-large-language-models-llms-in-voiceflow"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">What are LLMs?</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/prompting"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Prompting</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/hallucination-prevention"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Hallucinations" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Hallucinations</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/hallucination-reduction"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Hallucination reduction</span></span></a></li></ul></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">RESOURCES</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/what-are-tokens"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for FAQ" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">FAQ</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/what-are-tokens"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">What are Tokens?</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/how-to-find-the-sitemap-for-a-website"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">How to find the Sitemap for a website</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/ai-token-purchase-confirmation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">AI Token Purchase Confirmation</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/how-to-find-your-assistant-version-id-and-project-id"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">How to find your Assistant version ID and project ID</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/how-to-fix-a-loading-screen-error"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">How to Fix a Loading Screen Error</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/missing-steps"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">I'm missing steps?</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/how-voiceflows-nlu-exports-work"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">How Voiceflow's NLU Exports Work</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/adjusting-the-nlu-intent-confidence-threshold"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Adjusting the NLU Intent Confidence Threshold</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/how-do-i-log-out-of-voiceflow"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">How do I log out of Voiceflow?</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/using-specific-models-in-voiceflow-kb-query-api"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Using Specific Models in Voiceflow KB Query API</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" rel="noopener" target="_blank" data-active="" href="https://link.voiceflow.com/community"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Join our Discord Community</span></span><i aria-hidden="true" class="Sidebar-link-externalIcon1RcnjKm-3Ft8 icon-arrow-up-right"></i></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" rel="noopener" target="_blank" data-active="" href="https://www.voiceflow.com/security"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Security at Voiceflow</span></span><i aria-hidden="true" class="Sidebar-link-externalIcon1RcnjKm-3Ft8 icon-arrow-up-right"></i></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" rel="noopener" target="_blank" data-active="" href="https://www.voiceflow.com/templates"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Templates</span></span><i aria-hidden="true" class="Sidebar-link-externalIcon1RcnjKm-3Ft8 icon-arrow-up-right"></i></a></li></ul></section></div></nav><article class="rm-Article " id="content"><header id="content-head"><div class="row clearfix"><div class="col-xs-9"><h1>Introduction to Entities</h1></div><div class="col-xs-3"><a class="suggestEdits" rel="nofollow" href="/edit/introduction-to-entities"><i aria-hidden="true" class="icon icon-edit"></i> Suggest Edits</a></div></div></header><div class="grid-container-fluid" id="content-container"><section class="content-body grid-75"><div dehydrated="<p>In the world of conversational agents, <strong>entities</strong> are the key pieces of information that you want to extract from a user&#x27;s input. Think of entities as the nouns in a sentence鈥攖he who, what, where, and when that give meaning to the conversation. Whether you&#x27;re capturing a user&#x27;s name, booking a date, or retrieving a product code, entities enable your agent to recognize and process this crucial information accurately.</p> <p>In Voiceflow, entities serve as placeholders or variables that store specific data collected during a conversation. They make your agent dynamic and responsive, allowing it to handle a wide range of user inputs and ensuring that the conversation flows naturally.</p> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="how-entities-work-in-voiceflow"></div><div class="heading-text"><div id="section-how-entities-work-in-voiceflow" class="heading-anchor_backwardsCompatibility"></div>How Entities Work in Voiceflow</div><a aria-label="Skip link to How Entities Work in Voiceflow" class="heading-anchor-icon fa fa-anchor" href="#how-entities-work-in-voiceflow"></a></h2> <p>When a user interacts with your agent, the system listens for specific pieces of information鈥攜our defined entities鈥攁nd uses Large Language Models (LLMs) to extract them from the user&#x27;s input. Here&#x27;s how the process works:</p> <ol> <li><strong>Recognition</strong>: The LLM analyzes the user&#x27;s input to identify the presence of any entities you&#x27;ve specified.</li> <li><strong>Extraction and Validation</strong>: The system extracts the relevant data and applies any rules you&#x27;ve set to validate the input.</li> <li><strong>Storage</strong>: Validated entities are stored for use later in the conversation, such as personalizing responses or fulfilling requests.</li> </ol> <p>This LLM-driven approach enhances accuracy and adaptability, allowing your agent to understand user inputs more effectively than traditional methods.</p> <hr/> <blockquote class="callout callout_info" theme="馃摌"><h2 class="callout-heading empty"><span class="callout-icon">馃摌</span></h2><p>Rules, exit scenarios and automatic reprompt features are included as part of <a href="https://docs.voiceflow.com/changelog/ai-entity-collection" target="" title="">new AI-powered entity collection</a> feature being rolled out to users.</p></blockquote> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="entity-extraction-rules-fine-tuning-data-capture"></div><div class="heading-text"><div id="section-entity-extraction-rules-fine-tuning-data-capture" class="heading-anchor_backwardsCompatibility"></div>Entity Extraction Rules: Fine-Tuning Data Capture</div><a aria-label="Skip link to Entity Extraction Rules: Fine-Tuning Data Capture" class="heading-anchor-icon fa fa-anchor" href="#entity-extraction-rules-fine-tuning-data-capture"></a></h2> <p><strong>Entity Rules</strong> allow you to specify exact criteria that the user&#x27;s input must meet for the entity to be considered valid. These rules are written in natural language, making them easy to create and understand.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="why-use-entity-rules"></div><div class="heading-text"><div id="section-why-use-entity-rules" class="heading-anchor_backwardsCompatibility"></div>Why Use Entity Rules?</div><a aria-label="Skip link to Why Use Entity Rules?" class="heading-anchor-icon fa fa-anchor" href="#why-use-entity-rules"></a></h3> <ul> <li><strong>Precision</strong>: Define specific formats or content requirements.</li> <li><strong>Validation</strong>: Ensure data integrity by accepting only valid inputs.</li> <li><strong>Guidance</strong>: Help the LLM accurately interpret user responses.</li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="how-to-set-entity-rules"></div><div class="heading-text"><div id="section-how-to-set-entity-rules" class="heading-anchor_backwardsCompatibility"></div>How to Set Entity Rules</div><a aria-label="Skip link to How to Set Entity Rules" class="heading-anchor-icon fa fa-anchor" href="#how-to-set-entity-rules"></a></h3> <p><strong>Navigate to Your Entity</strong>: In the Entity CMS, select the entity you want to configure.</p> <ul> <li><strong>Add a Rule</strong>: Write a natural language statement that describes the validation criteria.</li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="examples-of-good-entity-capture-rules"></div><div class="heading-text"><div id="section-examples-of-good-entity-capture-rules" class="heading-anchor_backwardsCompatibility"></div>Examples of Good Entity Capture Rules</div><a aria-label="Skip link to Examples of Good Entity Capture Rules" class="heading-anchor-icon fa fa-anchor" href="#examples-of-good-entity-capture-rules"></a></h3> <ul> <li><strong>Zip Code</strong>: &quot;Must be exactly 5 digits long.&quot;</li> <li><strong>Email Address</strong>: &quot;Must be a valid business email, not a personal email like Gmail or Yahoo.&quot;</li> <li><strong>Phone Number</strong>: &quot;Should be a 10-digit number, possibly formatted with dashes or spaces.&quot;</li> <li><strong>Order Number</strong>: &quot;Must start with &#x27;ORD&#x27; followed by 7 digits.&quot;</li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="best-practices-for-entity-rules"></div><div class="heading-text"><div id="section-best-practices-for-entity-rules" class="heading-anchor_backwardsCompatibility"></div>Best Practices for Entity Rules</div><a aria-label="Skip link to Best Practices for Entity Rules" class="heading-anchor-icon fa fa-anchor" href="#best-practices-for-entity-rules"></a></h3> <ol> <li><strong>Be Specific but User-Friendly</strong>: Clearly define what you need without making it hard for the user to comply.</li> <li><strong>Use Natural Language</strong>: Write rules as you would explain them to a person.</li> <li><strong>Avoid Overcomplication</strong>: Don&#x27;t add unnecessary complexity that could confuse the LLM or the user.</li> </ol> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="automatic-reprompts-enhancing-user-experience"></div><div class="heading-text"><div id="section-automatic-reprompts-enhancing-user-experience" class="heading-anchor_backwardsCompatibility"></div>Automatic Reprompts: Enhancing User Experience</div><a aria-label="Skip link to Automatic Reprompts: Enhancing User Experience" class="heading-anchor-icon fa fa-anchor" href="#automatic-reprompts-enhancing-user-experience"></a></h2> <p><strong>Automatic Reprompts</strong> are dynamic follow-up messages that the system generates when a user&#x27;s input doesn&#x27;t meet the entity&#x27;s requirements. This feature ensures that the conversation remains fluid and user-friendly.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="how-automatic-reprompts-work"></div><div class="heading-text"><div id="section-how-automatic-reprompts-work" class="heading-anchor_backwardsCompatibility"></div>How Automatic Reprompts Work</div><a aria-label="Skip link to How Automatic Reprompts Work" class="heading-anchor-icon fa fa-anchor" href="#how-automatic-reprompts-work"></a></h3> <ul> <li><strong>Detection</strong>: If the user&#x27;s input is invalid or incomplete based on your entity rules, the system recognizes this.</li> <li><strong>Generation</strong>: The LLM crafts a personalized message prompting the user to provide the correct information.</li> <li><strong>Response</strong>: The user provides the needed input, and the conversation continues smoothly.</li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="example-of-an-automatic-reprompt"></div><div class="heading-text"><div id="section-example-of-an-automatic-reprompt" class="heading-anchor_backwardsCompatibility"></div>Example of an Automatic Reprompt</div><a aria-label="Skip link to Example of an Automatic Reprompt" class="heading-anchor-icon fa fa-anchor" href="#example-of-an-automatic-reprompt"></a></h3> <ul> <li><strong>Scenario</strong>: You&#x27;re capturing an email address, and the user says, &quot;It&#x27;s john at email dot com.&quot;</li> <li><strong>Reprompt</strong>: &quot;It seems there&#x27;s a typo in the email address. Could you please provide a valid email in the format &#x27;<a href="mailto:example@domain.com" target="" title="">example@domain.com</a>&#x27;?&quot;</li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="benefits-of-automatic-reprompts"></div><div class="heading-text"><div id="section-benefits-of-automatic-reprompts" class="heading-anchor_backwardsCompatibility"></div>Benefits of Automatic Reprompts</div><a aria-label="Skip link to Benefits of Automatic Reprompts" class="heading-anchor-icon fa fa-anchor" href="#benefits-of-automatic-reprompts"></a></h3> <ul> <li><strong>Personalization</strong>: Messages are tailored to the specific issue, making them more helpful.</li> <li><strong>Efficiency</strong>: Reduces the need for manual error handling in your design.</li> <li><strong>User Satisfaction</strong>: Keeps users engaged by promptly addressing and resolving input issues.</li> </ul> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="exit-scenarios-managing-conversation-flow"></div><div class="heading-text"><div id="section-exit-scenarios-managing-conversation-flow" class="heading-anchor_backwardsCompatibility"></div>Exit Scenarios: Managing Conversation Flow</div><a aria-label="Skip link to Exit Scenarios: Managing Conversation Flow" class="heading-anchor-icon fa fa-anchor" href="#exit-scenarios-managing-conversation-flow"></a></h2> <p>Sometimes, a user may be unable or unwilling to provide the information you&#x27;re requesting. <strong>Exit Scenarios</strong> allow your agent to handle such situations gracefully.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="what-are-exit-scenarios"></div><div class="heading-text"><div id="section-what-are-exit-scenarios" class="heading-anchor_backwardsCompatibility"></div>What Are Exit Scenarios?</div><a aria-label="Skip link to What Are Exit Scenarios?" class="heading-anchor-icon fa fa-anchor" href="#what-are-exit-scenarios"></a></h3> <p>Exit scenarios are predefined conditions under which the system stops attempting to collect a particular entity and moves on in the conversation.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="how-to-set-up-exit-scenarios"></div><div class="heading-text"><div id="section-how-to-set-up-exit-scenarios" class="heading-anchor_backwardsCompatibility"></div>How to Set Up Exit Scenarios</div><a aria-label="Skip link to How to Set Up Exit Scenarios" class="heading-anchor-icon fa fa-anchor" href="#how-to-set-up-exit-scenarios"></a></h3> <ul> <li><strong>Define Trigger Phrases</strong>: Specify phrases or responses that indicate the user wants to skip or cannot provide the information (e.g., &quot;I don&#x27;t know,&quot; &quot;I&#x27;d rather not say&quot;).</li> <li><strong>Configure the Exit Path</strong>: Decide where the conversation should go next. This could be: <ul> <li><strong>Main Path</strong>: Proceed as if the entity was captured, perhaps with a default value.</li> <li><strong>Alternate Path</strong>: Redirect to a different part of the conversation that doesn&#x27;t require the entity.</li> </ul> </li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="example-of-an-exit-scenario"></div><div class="heading-text"><div id="section-example-of-an-exit-scenario" class="heading-anchor_backwardsCompatibility"></div>Example of an Exit Scenario</div><a aria-label="Skip link to Example of an Exit Scenario" class="heading-anchor-icon fa fa-anchor" href="#example-of-an-exit-scenario"></a></h3> <ul> <li><strong>Entity</strong>: <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">PhoneNumber</code></li> <li><strong>Trigger Phrase</strong>: &quot;I don&#x27;t have a phone.&quot;</li> <li><strong>Exit Action</strong>: The agent replies, &quot;No problem, we&#x27;ll proceed without a phone number,&quot; and continues the conversation.</li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="benefits-of-using-exit-scenarios"></div><div class="heading-text"><div id="section-benefits-of-using-exit-scenarios" class="heading-anchor_backwardsCompatibility"></div>Benefits of Using Exit Scenarios</div><a aria-label="Skip link to Benefits of Using Exit Scenarios" class="heading-anchor-icon fa fa-anchor" href="#benefits-of-using-exit-scenarios"></a></h3> <ul> <li><strong>Conversation Flow</strong>: Prevents the conversation from stalling due to repeated, unwanted prompts.</li> <li><strong>Flexibility</strong>: Allows your agent to handle various user behaviors smoothly.</li> </ul> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="putting-it-all-together-a-practical-example"></div><div class="heading-text"><div id="section-putting-it-all-together-a-practical-example" class="heading-anchor_backwardsCompatibility"></div>Putting It All Together: A Practical Example</div><a aria-label="Skip link to Putting It All Together: A Practical Example" class="heading-anchor-icon fa fa-anchor" href="#putting-it-all-together-a-practical-example"></a></h2> <p>Let&#x27;s create a scenario to illustrate how entities, types, rules, automatic reprompts, and exit scenarios work together.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="scenario-capturing-a-delivery-address"></div><div class="heading-text"><div id="section-scenario-capturing-a-delivery-address" class="heading-anchor_backwardsCompatibility"></div>Scenario: Capturing a Delivery Address</div><a aria-label="Skip link to Scenario: Capturing a Delivery Address" class="heading-anchor-icon fa fa-anchor" href="#scenario-capturing-a-delivery-address"></a></h3> <p><strong>Step 1: Create Entities</strong></p> <ul> <li><strong><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">StreetAddress</code></strong> (Custom)</li> <li><strong><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">City</code></strong> (Custom)</li> <li><strong><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">ZipCode</code></strong> (Number)</li> </ul> <p><strong>Step 2: Apply Entity Rules</strong></p> <ul> <li><strong> Rule</strong>: &quot;Should include the street number and name.&quot;</li> <li><strong>Rule</strong>: &quot;Must be exactly 5 digits.&quot;</li> </ul> <p><strong>Step 3: Configure Automatic Reprompts</strong></p> <ul> <li>If the <strong><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">StreetAddress</code></strong> is missing or incomplete: <ul> <li><strong>Reprompt</strong>: &quot;Could you please provide your full street address, including the number and street name?&quot;</li> </ul> </li> <li>If the <strong><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">ZipCode</code></strong> is invalid: <ul> <li><strong>Reprompt</strong>: &quot;The zip code should be 5 digits. Could you double-check and provide it again?&quot;</li> </ul> </li> </ul> <p><strong>Step 4: Set Up Exit Scenarios</strong></p> <ul> <li>If the user says, &quot;I don&#x27;t feel comfortable sharing my address&quot;: <ul> <li><strong>Exit Scenario</strong>: Reply with &quot;I understand. Would you like to proceed without scheduling a delivery?&quot; and redirect the conversation accordingly.</li> </ul> </li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="conversation-flow-example"></div><div class="heading-text"><div id="section-conversation-flow-example" class="heading-anchor_backwardsCompatibility"></div>Conversation Flow Example</div><a aria-label="Skip link to Conversation Flow Example" class="heading-anchor-icon fa fa-anchor" href="#conversation-flow-example"></a></h3> <ol> <li><strong>Agent</strong>: &quot;Please provide your delivery address.&quot;</li> <li><strong>User</strong>: &quot;It&#x27;s 123 Main.&quot;</li> <li><strong>Agent</strong>: &quot;Thanks! Could you also include the street name in your address?&quot;</li> <li><strong>User</strong>: &quot;Oh, sorry. It&#x27;s 123 Main Street.&quot;</li> <li><strong>Agent</strong>: &quot;Got it. And your city?&quot;</li> <li><strong>User</strong>: &quot;Springfield.&quot;</li> <li><strong>Agent</strong>: &quot;Perfect. Lastly, could you provide your 5-digit zip code?&quot;</li> <li><strong>User</strong>: &quot;6270.&quot;</li> <li><strong>Agent</strong>: &quot;It looks like the zip code should be 5 digits. Could you double-check and provide it again?&quot;</li> <li><strong>User</strong>: &quot;Oops, it&#x27;s 62704.&quot;</li> <li><strong>Agent</strong>: &quot;Thank you! Your delivery address is all set.&quot;</li> </ol> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="recommendations-and-best-practices"></div><div class="heading-text"><div id="section-recommendations-and-best-practices" class="heading-anchor_backwardsCompatibility"></div>Recommendations and Best Practices</div><a aria-label="Skip link to Recommendations and Best Practices" class="heading-anchor-icon fa fa-anchor" href="#recommendations-and-best-practices"></a></h2> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="1-prioritize-entity-rules-over-entity-types"></div><div class="heading-text"><div id="section-1-prioritize-entity-rules-over-entity-types" class="heading-anchor_backwardsCompatibility"></div>1. Prioritize Entity Rules Over Entity Types</div><a aria-label="Skip link to 1. Prioritize Entity Rules Over Entity Types" class="heading-anchor-icon fa fa-anchor" href="#1-prioritize-entity-rules-over-entity-types"></a></h3> <p>While assigning an entity type can be helpful, relying on <strong>Entity Rules</strong> gives you more control and precision. Use rules to specify exact formats or criteria, especially for custom entities.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="2-use-custom-entities-for-flexibility"></div><div class="heading-text"><div id="section-2-use-custom-entities-for-flexibility" class="heading-anchor_backwardsCompatibility"></div>2. Use Custom Entities for Flexibility</div><a aria-label="Skip link to 2. Use Custom Entities for Flexibility" class="heading-anchor-icon fa fa-anchor" href="#2-use-custom-entities-for-flexibility"></a></h3> <p>Custom entities allow you to define exactly what data you want to capture without being constrained by predefined types. This is particularly useful when dealing with unique identifiers or specific formats.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="3-write-clear-and-concise-rules"></div><div class="heading-text"><div id="section-3-write-clear-and-concise-rules" class="heading-anchor_backwardsCompatibility"></div>3. Write Clear and Concise Rules</div><a aria-label="Skip link to 3. Write Clear and Concise Rules" class="heading-anchor-icon fa fa-anchor" href="#3-write-clear-and-concise-rules"></a></h3> <p>Ensure your entity rules are easy to understand for both the LLM and the user. Avoid ambiguity and keep the language straightforward.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="4-handle-exit-scenarios-gracefully"></div><div class="heading-text"><div id="section-4-handle-exit-scenarios-gracefully" class="heading-anchor_backwardsCompatibility"></div>4. Handle Exit Scenarios Gracefully</div><a aria-label="Skip link to 4. Handle Exit Scenarios Gracefully" class="heading-anchor-icon fa fa-anchor" href="#4-handle-exit-scenarios-gracefully"></a></h3> <p>Plan for situations where the user can&#x27;t or won&#x27;t provide certain information. Use exit scenarios to maintain a positive user experience by adjusting the conversation flow appropriately.</p>" style="margin-left:31px" class="rm-Markdown markdown-body rm-Markdown markdown-body ng-non-bindable" data-testid="RDMD"><p>In the world of conversational agents, <strong>entities</strong> are the key pieces of information that you want to extract from a user's input. Think of entities as the nouns in a sentence鈥攖he who, what, where, and when that give meaning to the conversation. Whether you're capturing a user's name, booking a date, or retrieving a product code, entities enable your agent to recognize and process this crucial information accurately.</p> <p>In Voiceflow, entities serve as placeholders or variables that store specific data collected during a conversation. They make your agent dynamic and responsive, allowing it to handle a wide range of user inputs and ensuring that the conversation flows naturally.</p> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="how-entities-work-in-voiceflow"></div><div class="heading-text"><div id="section-how-entities-work-in-voiceflow" class="heading-anchor_backwardsCompatibility"></div>How Entities Work in Voiceflow</div><a aria-label="Skip link to How Entities Work in Voiceflow" class="heading-anchor-icon fa fa-anchor" href="#how-entities-work-in-voiceflow"></a></h2> <p>When a user interacts with your agent, the system listens for specific pieces of information鈥攜our defined entities鈥攁nd uses Large Language Models (LLMs) to extract them from the user's input. Here's how the process works:</p> <ol> <li><strong>Recognition</strong>: The LLM analyzes the user's input to identify the presence of any entities you've specified.</li> <li><strong>Extraction and Validation</strong>: The system extracts the relevant data and applies any rules you've set to validate the input.</li> <li><strong>Storage</strong>: Validated entities are stored for use later in the conversation, such as personalizing responses or fulfilling requests.</li> </ol> <p>This LLM-driven approach enhances accuracy and adaptability, allowing your agent to understand user inputs more effectively than traditional methods.</p> <hr/> <blockquote class="callout callout_info" theme="馃摌"><h2 class="callout-heading empty"><span class="callout-icon">馃摌</span></h2><p>Rules, exit scenarios and automatic reprompt features are included as part of <a target="_self" href="/changelog/ai-entity-collection">new AI-powered entity collection</a> feature being rolled out to users.</p></blockquote> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="entity-extraction-rules-fine-tuning-data-capture"></div><div class="heading-text"><div id="section-entity-extraction-rules-fine-tuning-data-capture" class="heading-anchor_backwardsCompatibility"></div>Entity Extraction Rules: Fine-Tuning Data Capture</div><a aria-label="Skip link to Entity Extraction Rules: Fine-Tuning Data Capture" class="heading-anchor-icon fa fa-anchor" href="#entity-extraction-rules-fine-tuning-data-capture"></a></h2> <p><strong>Entity Rules</strong> allow you to specify exact criteria that the user's input must meet for the entity to be considered valid. These rules are written in natural language, making them easy to create and understand.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="why-use-entity-rules"></div><div class="heading-text"><div id="section-why-use-entity-rules" class="heading-anchor_backwardsCompatibility"></div>Why Use Entity Rules?</div><a aria-label="Skip link to Why Use Entity Rules?" class="heading-anchor-icon fa fa-anchor" href="#why-use-entity-rules"></a></h3> <ul> <li><strong>Precision</strong>: Define specific formats or content requirements.</li> <li><strong>Validation</strong>: Ensure data integrity by accepting only valid inputs.</li> <li><strong>Guidance</strong>: Help the LLM accurately interpret user responses.</li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="how-to-set-entity-rules"></div><div class="heading-text"><div id="section-how-to-set-entity-rules" class="heading-anchor_backwardsCompatibility"></div>How to Set Entity Rules</div><a aria-label="Skip link to How to Set Entity Rules" class="heading-anchor-icon fa fa-anchor" href="#how-to-set-entity-rules"></a></h3> <p><strong>Navigate to Your Entity</strong>: In the Entity CMS, select the entity you want to configure.</p> <ul> <li><strong>Add a Rule</strong>: Write a natural language statement that describes the validation criteria.</li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="examples-of-good-entity-capture-rules"></div><div class="heading-text"><div id="section-examples-of-good-entity-capture-rules" class="heading-anchor_backwardsCompatibility"></div>Examples of Good Entity Capture Rules</div><a aria-label="Skip link to Examples of Good Entity Capture Rules" class="heading-anchor-icon fa fa-anchor" href="#examples-of-good-entity-capture-rules"></a></h3> <ul> <li><strong>Zip Code</strong>: "Must be exactly 5 digits long."</li> <li><strong>Email Address</strong>: "Must be a valid business email, not a personal email like Gmail or Yahoo."</li> <li><strong>Phone Number</strong>: "Should be a 10-digit number, possibly formatted with dashes or spaces."</li> <li><strong>Order Number</strong>: "Must start with 'ORD' followed by 7 digits."</li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="best-practices-for-entity-rules"></div><div class="heading-text"><div id="section-best-practices-for-entity-rules" class="heading-anchor_backwardsCompatibility"></div>Best Practices for Entity Rules</div><a aria-label="Skip link to Best Practices for Entity Rules" class="heading-anchor-icon fa fa-anchor" href="#best-practices-for-entity-rules"></a></h3> <ol> <li><strong>Be Specific but User-Friendly</strong>: Clearly define what you need without making it hard for the user to comply.</li> <li><strong>Use Natural Language</strong>: Write rules as you would explain them to a person.</li> <li><strong>Avoid Overcomplication</strong>: Don't add unnecessary complexity that could confuse the LLM or the user.</li> </ol> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="automatic-reprompts-enhancing-user-experience"></div><div class="heading-text"><div id="section-automatic-reprompts-enhancing-user-experience" class="heading-anchor_backwardsCompatibility"></div>Automatic Reprompts: Enhancing User Experience</div><a aria-label="Skip link to Automatic Reprompts: Enhancing User Experience" class="heading-anchor-icon fa fa-anchor" href="#automatic-reprompts-enhancing-user-experience"></a></h2> <p><strong>Automatic Reprompts</strong> are dynamic follow-up messages that the system generates when a user's input doesn't meet the entity's requirements. This feature ensures that the conversation remains fluid and user-friendly.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="how-automatic-reprompts-work"></div><div class="heading-text"><div id="section-how-automatic-reprompts-work" class="heading-anchor_backwardsCompatibility"></div>How Automatic Reprompts Work</div><a aria-label="Skip link to How Automatic Reprompts Work" class="heading-anchor-icon fa fa-anchor" href="#how-automatic-reprompts-work"></a></h3> <ul> <li><strong>Detection</strong>: If the user's input is invalid or incomplete based on your entity rules, the system recognizes this.</li> <li><strong>Generation</strong>: The LLM crafts a personalized message prompting the user to provide the correct information.</li> <li><strong>Response</strong>: The user provides the needed input, and the conversation continues smoothly.</li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="example-of-an-automatic-reprompt"></div><div class="heading-text"><div id="section-example-of-an-automatic-reprompt" class="heading-anchor_backwardsCompatibility"></div>Example of an Automatic Reprompt</div><a aria-label="Skip link to Example of an Automatic Reprompt" class="heading-anchor-icon fa fa-anchor" href="#example-of-an-automatic-reprompt"></a></h3> <ul> <li><strong>Scenario</strong>: You're capturing an email address, and the user says, "It's john at email dot com."</li> <li><strong>Reprompt</strong>: "It seems there's a typo in the email address. Could you please provide a valid email in the format '<a target="_self" href="/cdn-cgi/l/email-protection#7b1e031a160b171e3b1f14161a121555181416"><span class="__cf_email__" data-cfemail="45203d242835292005212a28242c2b6b262a28">[email protected]</span></a>'?"</li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="benefits-of-automatic-reprompts"></div><div class="heading-text"><div id="section-benefits-of-automatic-reprompts" class="heading-anchor_backwardsCompatibility"></div>Benefits of Automatic Reprompts</div><a aria-label="Skip link to Benefits of Automatic Reprompts" class="heading-anchor-icon fa fa-anchor" href="#benefits-of-automatic-reprompts"></a></h3> <ul> <li><strong>Personalization</strong>: Messages are tailored to the specific issue, making them more helpful.</li> <li><strong>Efficiency</strong>: Reduces the need for manual error handling in your design.</li> <li><strong>User Satisfaction</strong>: Keeps users engaged by promptly addressing and resolving input issues.</li> </ul> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="exit-scenarios-managing-conversation-flow"></div><div class="heading-text"><div id="section-exit-scenarios-managing-conversation-flow" class="heading-anchor_backwardsCompatibility"></div>Exit Scenarios: Managing Conversation Flow</div><a aria-label="Skip link to Exit Scenarios: Managing Conversation Flow" class="heading-anchor-icon fa fa-anchor" href="#exit-scenarios-managing-conversation-flow"></a></h2> <p>Sometimes, a user may be unable or unwilling to provide the information you're requesting. <strong>Exit Scenarios</strong> allow your agent to handle such situations gracefully.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="what-are-exit-scenarios"></div><div class="heading-text"><div id="section-what-are-exit-scenarios" class="heading-anchor_backwardsCompatibility"></div>What Are Exit Scenarios?</div><a aria-label="Skip link to What Are Exit Scenarios?" class="heading-anchor-icon fa fa-anchor" href="#what-are-exit-scenarios"></a></h3> <p>Exit scenarios are predefined conditions under which the system stops attempting to collect a particular entity and moves on in the conversation.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="how-to-set-up-exit-scenarios"></div><div class="heading-text"><div id="section-how-to-set-up-exit-scenarios" class="heading-anchor_backwardsCompatibility"></div>How to Set Up Exit Scenarios</div><a aria-label="Skip link to How to Set Up Exit Scenarios" class="heading-anchor-icon fa fa-anchor" href="#how-to-set-up-exit-scenarios"></a></h3> <ul> <li><strong>Define Trigger Phrases</strong>: Specify phrases or responses that indicate the user wants to skip or cannot provide the information (e.g., "I don't know," "I'd rather not say").</li> <li><strong>Configure the Exit Path</strong>: Decide where the conversation should go next. This could be: <ul> <li><strong>Main Path</strong>: Proceed as if the entity was captured, perhaps with a default value.</li> <li><strong>Alternate Path</strong>: Redirect to a different part of the conversation that doesn't require the entity.</li> </ul> </li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="example-of-an-exit-scenario"></div><div class="heading-text"><div id="section-example-of-an-exit-scenario" class="heading-anchor_backwardsCompatibility"></div>Example of an Exit Scenario</div><a aria-label="Skip link to Example of an Exit Scenario" class="heading-anchor-icon fa fa-anchor" href="#example-of-an-exit-scenario"></a></h3> <ul> <li><strong>Entity</strong>: <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">PhoneNumber</code></li> <li><strong>Trigger Phrase</strong>: "I don't have a phone."</li> <li><strong>Exit Action</strong>: The agent replies, "No problem, we'll proceed without a phone number," and continues the conversation.</li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="benefits-of-using-exit-scenarios"></div><div class="heading-text"><div id="section-benefits-of-using-exit-scenarios" class="heading-anchor_backwardsCompatibility"></div>Benefits of Using Exit Scenarios</div><a aria-label="Skip link to Benefits of Using Exit Scenarios" class="heading-anchor-icon fa fa-anchor" href="#benefits-of-using-exit-scenarios"></a></h3> <ul> <li><strong>Conversation Flow</strong>: Prevents the conversation from stalling due to repeated, unwanted prompts.</li> <li><strong>Flexibility</strong>: Allows your agent to handle various user behaviors smoothly.</li> </ul> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="putting-it-all-together-a-practical-example"></div><div class="heading-text"><div id="section-putting-it-all-together-a-practical-example" class="heading-anchor_backwardsCompatibility"></div>Putting It All Together: A Practical Example</div><a aria-label="Skip link to Putting It All Together: A Practical Example" class="heading-anchor-icon fa fa-anchor" href="#putting-it-all-together-a-practical-example"></a></h2> <p>Let's create a scenario to illustrate how entities, types, rules, automatic reprompts, and exit scenarios work together.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="scenario-capturing-a-delivery-address"></div><div class="heading-text"><div id="section-scenario-capturing-a-delivery-address" class="heading-anchor_backwardsCompatibility"></div>Scenario: Capturing a Delivery Address</div><a aria-label="Skip link to Scenario: Capturing a Delivery Address" class="heading-anchor-icon fa fa-anchor" href="#scenario-capturing-a-delivery-address"></a></h3> <p><strong>Step 1: Create Entities</strong></p> <ul> <li><strong><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">StreetAddress</code></strong> (Custom)</li> <li><strong><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">City</code></strong> (Custom)</li> <li><strong><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">ZipCode</code></strong> (Number)</li> </ul> <p><strong>Step 2: Apply Entity Rules</strong></p> <ul> <li><strong> Rule</strong>: "Should include the street number and name."</li> <li><strong>Rule</strong>: "Must be exactly 5 digits."</li> </ul> <p><strong>Step 3: Configure Automatic Reprompts</strong></p> <ul> <li>If the <strong><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">StreetAddress</code></strong> is missing or incomplete: <ul> <li><strong>Reprompt</strong>: "Could you please provide your full street address, including the number and street name?"</li> </ul> </li> <li>If the <strong><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">ZipCode</code></strong> is invalid: <ul> <li><strong>Reprompt</strong>: "The zip code should be 5 digits. Could you double-check and provide it again?"</li> </ul> </li> </ul> <p><strong>Step 4: Set Up Exit Scenarios</strong></p> <ul> <li>If the user says, "I don't feel comfortable sharing my address": <ul> <li><strong>Exit Scenario</strong>: Reply with "I understand. Would you like to proceed without scheduling a delivery?" and redirect the conversation accordingly.</li> </ul> </li> </ul> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="conversation-flow-example"></div><div class="heading-text"><div id="section-conversation-flow-example" class="heading-anchor_backwardsCompatibility"></div>Conversation Flow Example</div><a aria-label="Skip link to Conversation Flow Example" class="heading-anchor-icon fa fa-anchor" href="#conversation-flow-example"></a></h3> <ol> <li><strong>Agent</strong>: "Please provide your delivery address."</li> <li><strong>User</strong>: "It's 123 Main."</li> <li><strong>Agent</strong>: "Thanks! Could you also include the street name in your address?"</li> <li><strong>User</strong>: "Oh, sorry. It's 123 Main Street."</li> <li><strong>Agent</strong>: "Got it. And your city?"</li> <li><strong>User</strong>: "Springfield."</li> <li><strong>Agent</strong>: "Perfect. Lastly, could you provide your 5-digit zip code?"</li> <li><strong>User</strong>: "6270."</li> <li><strong>Agent</strong>: "It looks like the zip code should be 5 digits. Could you double-check and provide it again?"</li> <li><strong>User</strong>: "Oops, it's 62704."</li> <li><strong>Agent</strong>: "Thank you! Your delivery address is all set."</li> </ol> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="recommendations-and-best-practices"></div><div class="heading-text"><div id="section-recommendations-and-best-practices" class="heading-anchor_backwardsCompatibility"></div>Recommendations and Best Practices</div><a aria-label="Skip link to Recommendations and Best Practices" class="heading-anchor-icon fa fa-anchor" href="#recommendations-and-best-practices"></a></h2> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="1-prioritize-entity-rules-over-entity-types"></div><div class="heading-text"><div id="section-1-prioritize-entity-rules-over-entity-types" class="heading-anchor_backwardsCompatibility"></div>1. Prioritize Entity Rules Over Entity Types</div><a aria-label="Skip link to 1. Prioritize Entity Rules Over Entity Types" class="heading-anchor-icon fa fa-anchor" href="#1-prioritize-entity-rules-over-entity-types"></a></h3> <p>While assigning an entity type can be helpful, relying on <strong>Entity Rules</strong> gives you more control and precision. Use rules to specify exact formats or criteria, especially for custom entities.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="2-use-custom-entities-for-flexibility"></div><div class="heading-text"><div id="section-2-use-custom-entities-for-flexibility" class="heading-anchor_backwardsCompatibility"></div>2. Use Custom Entities for Flexibility</div><a aria-label="Skip link to 2. Use Custom Entities for Flexibility" class="heading-anchor-icon fa fa-anchor" href="#2-use-custom-entities-for-flexibility"></a></h3> <p>Custom entities allow you to define exactly what data you want to capture without being constrained by predefined types. This is particularly useful when dealing with unique identifiers or specific formats.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="3-write-clear-and-concise-rules"></div><div class="heading-text"><div id="section-3-write-clear-and-concise-rules" class="heading-anchor_backwardsCompatibility"></div>3. Write Clear and Concise Rules</div><a aria-label="Skip link to 3. Write Clear and Concise Rules" class="heading-anchor-icon fa fa-anchor" href="#3-write-clear-and-concise-rules"></a></h3> <p>Ensure your entity rules are easy to understand for both the LLM and the user. Avoid ambiguity and keep the language straightforward.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="4-handle-exit-scenarios-gracefully"></div><div class="heading-text"><div id="section-4-handle-exit-scenarios-gracefully" class="heading-anchor_backwardsCompatibility"></div>4. Handle Exit Scenarios Gracefully</div><a aria-label="Skip link to 4. Handle Exit Scenarios Gracefully" class="heading-anchor-icon fa fa-anchor" href="#4-handle-exit-scenarios-gracefully"></a></h3> <p>Plan for situations where the user can't or won't provide certain information. Use exit scenarios to maintain a positive user experience by adjusting the conversation flow appropriately.</p></div><div class="UpdatedAt"><p class="DateLine "><i class="icon icon-watch"></i>Updated 5 months ago </p></div><hr class="NextStepsDivider"/><nav aria-label="Pagination Controls" class="PaginationControlsjDYuqu8pBMUy rm-Pagination"></nav></section><section class="content-toc grid-25"><nav><ul class="toc-list"><li><a class="tocHeader" href="#"><i class="icon icon-text-align-left"></i>Table of Contents</a></li><li class="toc-children"><ul> <li> <a href="#how-entities-work-in-voiceflow">How Entities Work in Voiceflow</a> </li> <li> <a href="#entity-extraction-rules-fine-tuning-data-capture">Entity Extraction Rules: Fine-Tuning Data Capture</a> <ul> <li><a href="#why-use-entity-rules">Why Use Entity Rules?</a></li> <li><a href="#how-to-set-entity-rules">How to Set Entity Rules</a></li> <li><a href="#examples-of-good-entity-capture-rules">Examples of Good Entity Capture Rules</a></li> <li><a href="#best-practices-for-entity-rules">Best Practices for Entity Rules</a></li> </ul> </li> <li> <a href="#automatic-reprompts-enhancing-user-experience">Automatic Reprompts: Enhancing User Experience</a> <ul> <li><a href="#how-automatic-reprompts-work">How Automatic Reprompts Work</a></li> <li><a href="#example-of-an-automatic-reprompt">Example of an Automatic Reprompt</a></li> <li><a href="#benefits-of-automatic-reprompts">Benefits of Automatic Reprompts</a></li> </ul> </li> <li> <a href="#exit-scenarios-managing-conversation-flow">Exit Scenarios: Managing Conversation Flow</a> <ul> <li><a href="#what-are-exit-scenarios">What Are Exit Scenarios?</a></li> <li><a href="#how-to-set-up-exit-scenarios">How to Set Up Exit Scenarios</a></li> <li><a href="#example-of-an-exit-scenario">Example of an Exit Scenario</a></li> <li><a href="#benefits-of-using-exit-scenarios">Benefits of Using Exit Scenarios</a></li> </ul> </li> <li> <a href="#putting-it-all-together-a-practical-example">Putting It All Together: A Practical Example</a> <ul> <li><a href="#scenario-capturing-a-delivery-address">Scenario: Capturing a Delivery Address</a></li> <li><a href="#conversation-flow-example">Conversation Flow Example</a></li> </ul> </li> <li> <a href="#recommendations-and-best-practices">Recommendations and Best Practices</a> <ul> <li><a href="#1-prioritize-entity-rules-over-entity-types">1. Prioritize Entity Rules Over Entity Types</a></li> <li><a href="#2-use-custom-entities-for-flexibility">2. Use Custom Entities for Flexibility</a></li> <li><a href="#3-write-clear-and-concise-rules">3. Write Clear and Concise Rules</a></li> <li><a href="#4-handle-exit-scenarios-gracefully">4. Handle Exit Scenarios Gracefully</a></li> </ul> </li> </ul></li></ul></nav></section></div><div class="ModalWrapper" id="tutorialmodal-root"></div></article></div></main><footer aria-label="Status banner" class="AppFooter rm-Banners"></footer><div class="ModalWrapper" id="ChatGPT-modal"></div></div></div><div class="ng-non-bindable"><script data-cfasync="false" src="/cdn-cgi/scripts/5c5dd728/cloudflare-static/email-decode.min.js"></script><script id="ssr-props" data-initial-props="{"sidebars":{"docs":[{"_id":"6659cc0ab80ec2004f1aa17c","title":"Getting Started","slug":"send-first-message","order":0,"reference":false,"isAPI":false,"project":"61f2f6237da66107c6124fbe","version":"6659cc0ab80ec2004f1aa284","createdAt":"2022-01-27T21:49:22.527Z","__v":0,"pages":[{"_id":"665e1e7f5425ce005157cb6d","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Welcome to the docs","icon":"","type":"basic","slug":"welcome","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"welcome-to-the-docs-1","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2024-06-03T19:50:23.894Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"665e1e95a34e450011bb23c4","api":{"method":"get","url":"","auth":"required","params":[]},"title":"How Voiceflow fits in your tech stack","icon":"","type":"basic","slug":"voiceflow-in-your-stack","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"how-voiceflow-fits-in-your-tech-stack-1","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2024-06-03T19:50:45.766Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa1a1","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Quick start guide","type":"basic","slug":"get-started","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"send-first-message","createdAt":"2022-01-31T00:03:34.212Z","category":"6659cc0ab80ec2004f1aa17c","parentDoc":null,"icon":"","isBodyEmpty":true,"children":[{"_id":"6659cc0ab80ec2004f1aa219","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Step 1: Create your agent","icon":"","type":"basic","slug":"step-1","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"step-2-create-assistant","parentDoc":"6659cc0ab80ec2004f1aa1a1","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2023-07-14T18:29:13.588Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa218","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Step 2: Get your API key","icon":"","type":"basic","slug":"step-2","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"step-1-get-api-key","parentDoc":"6659cc0ab80ec2004f1aa1a1","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2023-07-14T18:28:52.776Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa21a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Step 3: Deploy your agent","icon":"","type":"basic","slug":"step-3","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"step-3-deploy-assistant","parentDoc":"6659cc0ab80ec2004f1aa1a1","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2023-07-14T18:29:33.042Z","isBodyEmpty":false,"children":[]}]},{"_id":"6659cc0ab80ec2004f1aa27a","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Use cases","icon":"","type":"basic","slug":"use-cases-2","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"breaking-bots","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2024-05-12T12:29:38.211Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"6659cc0ab80ec2004f1aa27b","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Building a telecom customer support agent","icon":"","type":"basic","slug":"building-a-telecom-customer-support-agents-to-troubleshoot-complex-questions","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa27a","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2024-05-12T16:24:43.477Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa27c","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Removing hallucinations for a banking customer support agent","icon":"","type":"basic","slug":"removing-hallucinations-for-a-banking-customer-support-bot","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa27a","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2024-05-12T19:26:17.241Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa27d","api":{"method":"get","url":"","auth":"required","params":[]},"title":"A NYT Cooking recipe agent using RAG","icon":"","type":"basic","slug":"a-nyt-cooking-recipe-agent-using-rag","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa27a","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2024-05-12T19:30:56.501Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa27e","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Rebuilding Sephora's digital agent","icon":"","type":"basic","slug":"rebuilding-a-retail-stores-digital-agent","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa27a","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2024-05-12T19:34:14.496Z","isBodyEmpty":false,"children":[]}]},{"_id":"665e269982567000204dece4","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Admin and support","icon":"","type":"basic","slug":"admin-support","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"admin-and-support","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2024-06-03T20:24:57.453Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"665f64475c3a4700252cac19","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Managing workspaces and team members","icon":"","type":"basic","slug":"managing-workspaces-teams","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"managing-workspace-and-team-members","parentDoc":"665e269982567000204dece4","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2024-06-04T19:00:23.595Z","isBodyEmpty":false,"children":[]},{"_id":"665e26ac14eedc0030debc5a","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Single Sign-On (SSO) and SAML support","icon":"","type":"basic","slug":"sso","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2024-06-03T20:25:16.258Z","parentDoc":"665e269982567000204dece4","isBodyEmpty":false,"children":[]},{"_id":"665f646385aff60057a5e783","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Roles and permissions","icon":"","type":"basic","slug":"roles-permissions","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"roles-and-permissions","parentDoc":"665e269982567000204dece4","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2024-06-04T19:00:51.871Z","isBodyEmpty":false,"children":[]},{"_id":"665e26b6d994e80014088949","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Billing and plans","icon":"","type":"basic","slug":"billing-plans","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"billing-and-plans","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2024-06-03T20:25:26.212Z","parentDoc":"665e269982567000204dece4","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"668ff2120def6b0018c388ec","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Token Top-up","icon":"","type":"basic","slug":"token-top-up","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e269982567000204dece4","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2024-07-11T14:54:10.395Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"665e26bc803577006a988492","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Get help","icon":"","type":"basic","slug":"get-help","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2024-06-03T20:25:32.202Z","parentDoc":"665e269982567000204dece4","isBodyEmpty":false,"children":[]},{"_id":"6759d703f12c2a0068d890e7","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Important Agent Settings","icon":"","type":"basic","slug":"agent-settings","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e269982567000204dece4","category":"6659cc0ab80ec2004f1aa17c","createdAt":"2024-12-11T18:16:35.418Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"66d1de5b700490004b9e6e82","title":"Courses","slug":"guides","order":1,"reference":false,"project":"61f2f6237da66107c6124fbe","version":"6659cc0ab80ec2004f1aa284","createdAt":"2024-08-30T14:59:39.405Z","__v":0,"pages":[{"_id":"674490386102c2007c1b7194","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Voiceflow Basics","icon":"","type":"basic","slug":"voiceflow-basics-category","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"voiceflow-basics","category":"66d1de5b700490004b9e6e82","createdAt":"2024-11-25T14:56:56.467Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"67449687fba7a300671fd542","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Part 1: Get Setup","icon":"","type":"basic","slug":"voiceflow-basics","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"part-1-get-setup","parentDoc":"674490386102c2007c1b7194","category":"66d1de5b700490004b9e6e82","createdAt":"2024-11-25T15:23:51.908Z","isBodyEmpty":false,"children":[]},{"_id":"67449246586f500011d7c6f8","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Part 2: Get Familiar with Workflows","icon":"","type":"basic","slug":"voiceflow-basics-workflows","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"part-1-getting-familar-with-workflows","parentDoc":"674490386102c2007c1b7194","category":"66d1de5b700490004b9e6e82","createdAt":"2024-11-25T15:05:42.130Z","isBodyEmpty":false,"children":[]},{"_id":"6744932d97fd85003f0a882e","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Part 3: Accept User Input","icon":"","type":"basic","slug":"voiceflow-basics-user-input","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"part-2-accept-user-input","parentDoc":"674490386102c2007c1b7194","category":"66d1de5b700490004b9e6e82","createdAt":"2024-11-25T15:09:33.692Z","isBodyEmpty":false,"children":[]}]},{"_id":"66da16b6cd90cc006e6def00","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Build an AI Support Agent","icon":"","type":"basic","slug":"build-an-ai-support-agent","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"66d1de5b700490004b9e6e82","createdAt":"2024-09-05T20:38:14.435Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"66da1c5c58a5dc0012fc7720","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Part 1: Answer Questions","icon":"","type":"basic","slug":"part-1-advanced-faq","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66da16b6cd90cc006e6def00","category":"66d1de5b700490004b9e6e82","createdAt":"2024-09-05T21:02:20.354Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66da1fc5e67217005303cc88","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Part 2: Sending a Ticket to Zendesk","icon":"","type":"basic","slug":"part-2-sending-a-ticket-to-zendesk","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66da16b6cd90cc006e6def00","category":"66d1de5b700490004b9e6e82","createdAt":"2024-09-05T21:16:53.487Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66da22249e0967003da17431","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Part 3: Book a Demo","icon":"","type":"basic","slug":"part-3-book-a-demo","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66da16b6cd90cc006e6def00","category":"66d1de5b700490004b9e6e82","createdAt":"2024-09-05T21:27:00.694Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66da23e44842cc004a44da59","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Part 4: Deploy & Customize Webchat","icon":"","type":"basic","slug":"part-4-debugging","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66da16b6cd90cc006e6def00","category":"66d1de5b700490004b9e6e82","createdAt":"2024-09-05T21:34:28.231Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"66d1debfb561f60061590387","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Plan, Build, and Launch a Production Q&A Slack Agent","icon":"","type":"basic","slug":"guide-qna-chatbot","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"plan-build-and-launch-a-production-qa-slack-agent","category":"66d1de5b700490004b9e6e82","createdAt":"2024-08-30T15:01:19.264Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"66d1decff1f32600100650d5","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Overview","icon":"","type":"basic","slug":"guide-qna-chatbot-overview","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"overview-3","parentDoc":"66d1debfb561f60061590387","category":"66d1de5b700490004b9e6e82","createdAt":"2024-08-30T15:01:35.119Z","isBodyEmpty":false,"children":[]},{"_id":"66d1e0e30ed1ae006889067c","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Planning","icon":"","type":"basic","slug":"guide-qna-chatbot-planning","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"planning","parentDoc":"66d1debfb561f60061590387","category":"66d1de5b700490004b9e6e82","createdAt":"2024-08-30T15:10:27.664Z","isBodyEmpty":false,"children":[]},{"_id":"66d1e10014ef3a0012956f24","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Building","icon":"","type":"basic","slug":"guide-qna-chatbot-building","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"building","parentDoc":"66d1debfb561f60061590387","category":"66d1de5b700490004b9e6e82","createdAt":"2024-08-30T15:10:56.437Z","isBodyEmpty":false,"children":[]},{"_id":"66d1e1263e2d2a001236b8e5","api":{"method":"get","url":"","auth":"required","params":[]},"title":"QA and Deploying","icon":"","type":"basic","slug":"guide-qna-chatbot-deploying","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"qa-and-deploying","parentDoc":"66d1debfb561f60061590387","category":"66d1de5b700490004b9e6e82","createdAt":"2024-08-30T15:11:34.356Z","isBodyEmpty":false,"children":[]},{"_id":"66d1e14b6335c10010320fa1","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Full Technical Walkthrough","icon":"","type":"basic","slug":"guide-qna-chatbot-technical-walkthrough","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"full-technical-walkthrough","parentDoc":"66d1debfb561f60061590387","category":"66d1de5b700490004b9e6e82","createdAt":"2024-08-30T15:12:11.665Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"6659cc0ab80ec2004f1aa190","title":"Building Agents","slug":"agent-building","order":2,"reference":false,"project":"61f2f6237da66107c6124fbe","version":"6659cc0ab80ec2004f1aa284","createdAt":"2024-05-12T00:55:22.223Z","__v":0,"pages":[{"_id":"665e276e3ce8930011547705","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Overview","icon":"","type":"basic","slug":"building-overview","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"platform-overview","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-03T20:28:30.514Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"665e276191d18500425738e3","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Platform fundamentals","icon":"","type":"basic","slug":"platform","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-03T20:28:17.192Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"665e29bc24393b00127d8631","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Workspaces and Agents","icon":"","type":"basic","slug":"workspaces-agents","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"workspaces-projects","parentDoc":"665e276191d18500425738e3","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-03T20:38:20.601Z","isBodyEmpty":false,"children":[]},{"_id":"665e29e2940bab006a9d9ec9","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Content Management System (CMS)","icon":"","type":"basic","slug":"cms","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-03T20:38:00.000Z","parentDoc":"665e276191d18500425738e3","category":"6659cc0ab80ec2004f1aa190","isBodyEmpty":false,"children":[]},{"_id":"665f65d59b34d0003da22070","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Canvas","icon":"","type":"basic","slug":"canvas","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"designer-and-canvas","parentDoc":"665e276191d18500425738e3","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-04T19:07:01.107Z","isBodyEmpty":false,"children":[]},{"_id":"665f2ee23f611e002b5fe7e2","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Steps and Blocks","icon":"","type":"basic","slug":"steps-blocks","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-04T15:12:00.000Z","parentDoc":"665e276191d18500425738e3","category":"6659cc0ab80ec2004f1aa190","isBodyEmpty":false,"children":[]},{"_id":"6660d9fb87f1a50059dfc2b2","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Workflows","icon":"","type":"basic","slug":"workflows","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e276191d18500425738e3","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-05T21:34:51.452Z","isBodyEmpty":false,"children":[]},{"_id":"6671a558159635001422a88c","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Components","icon":"","type":"basic","slug":"components","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e276191d18500425738e3","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-18T15:18:48.391Z","isBodyEmpty":false,"children":[]},{"_id":"6660d04a62e8c700572bdf20","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Template Library","icon":"","type":"basic","slug":"template-library","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e276191d18500425738e3","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-05T20:53:30.939Z","isBodyEmpty":false,"children":[]},{"_id":"66620f57f887d9004f7681f2","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Test Tool","icon":"","type":"basic","slug":"test-tool","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e276191d18500425738e3","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-06T19:34:47.409Z","isBodyEmpty":false,"children":[]},{"_id":"665e2a3959a08100105fd12f","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Collaboration features","icon":"","type":"basic","slug":"teams","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-03T20:40:00.000Z","parentDoc":"665e276191d18500425738e3","category":"6659cc0ab80ec2004f1aa190","isBodyEmpty":false,"children":[]},{"_id":"665f663ea4c44e00361be16b","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Sharing Prototypes","icon":"","type":"basic","slug":"sharing-prototypes","order":10,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e276191d18500425738e3","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-04T19:08:46.960Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"665f665e3139ed00119b74c6","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Publishing, Environments and Backups","icon":"","type":"basic","slug":"publishing-environments-backups","order":11,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"publishing-environments-and-backups","parentDoc":"665e276191d18500425738e3","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-04T19:09:18.802Z","isBodyEmpty":false,"children":[]},{"_id":"665f4cbf501f760057be003a","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Languages","icon":"","type":"basic","slug":"languages","order":12,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e276191d18500425738e3","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-04T17:19:59.563Z","isBodyEmpty":false,"children":[]},{"_id":"665e2a002095d2003271c7cc","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Importing or exporting projects and functions","icon":"","type":"basic","slug":"importing-exporting","order":14,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"exporting","createdAt":"2024-06-03T20:39:00.000Z","parentDoc":"665e276191d18500425738e3","category":"6659cc0ab80ec2004f1aa190","isBodyEmpty":false,"children":[]},{"_id":"66fda4b092653c000fd8d184","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Secrets Manager","icon":"","type":"basic","slug":"secrets-manager","order":15,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e276191d18500425738e3","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-10-02T19:53:20.108Z","isBodyEmpty":false,"children":[]}]},{"_id":"665e29123018ce002ae5b6d2","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Understand","icon":"","type":"basic","slug":"understand","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-03T20:35:00.000Z","category":"6659cc0ab80ec2004f1aa190","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"66f5c749f9c4bb001fc0f0c3","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Understanding: How AI Agents Understand User Inputs","icon":"","type":"basic","slug":"listen-fundamentals","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"understanding-how-ai-agents-understand-user-inputs","parentDoc":"665e29123018ce002ae5b6d2","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-26T20:42:49.363Z","isBodyEmpty":false,"children":[]},{"_id":"66fad16179410c001084ffca","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Intents","icon":"","type":"basic","slug":"intents-1","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e29123018ce002ae5b6d2","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-30T16:27:13.991Z","isBodyEmpty":true,"children":[{"_id":"66fad1c39f03f500103dec47","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Introduction to Intents","icon":"","type":"basic","slug":"intents","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"introduction-to-intents","parentDoc":"66fad16179410c001084ffca","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-30T16:28:51.736Z","isBodyEmpty":false,"children":[]},{"_id":"66fad1f9b93bfa0043d18933","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Using the Intent CMS","icon":"","type":"basic","slug":"using-the-intent-cms","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66fad16179410c001084ffca","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-30T16:29:45.892Z","isBodyEmpty":false,"children":[]},{"_id":"66fad27328451200128f5696","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Intent Classification using LLMs (Hybrid)","icon":"","type":"basic","slug":"llm-intent-classification-method","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"intent-classification-methods","parentDoc":"66fad16179410c001084ffca","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-30T16:31:47.328Z","isBodyEmpty":false,"children":[]},{"_id":"66fad6f9eeed59003cb447d1","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Intent Classification using NLU","icon":"","type":"basic","slug":"nlu-classification-method","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"intent-classification-using-nlu-1","parentDoc":"66fad16179410c001084ffca","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-30T16:51:05.624Z","isBodyEmpty":false,"children":[]},{"_id":"66fad24248919000313c45c1","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Previewing Intent Classification and Improvements","icon":"","type":"basic","slug":"previewing-intent-classification-and-improvements","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66fad16179410c001084ffca","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-30T16:30:58.094Z","isBodyEmpty":false,"children":[]}]},{"_id":"66f5c4766aafa40012990662","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Entities","icon":"","type":"basic","slug":"entities-1","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e29123018ce002ae5b6d2","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-26T20:30:46.669Z","isBodyEmpty":true,"children":[{"_id":"66fae4cee474c4a449963935","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Introduction to Entities","icon":"","type":"basic","slug":"introduction-to-entities","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66f5c4766aafa40012990662","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-30T17:50:06.569Z","isBodyEmpty":false,"children":[]},{"_id":"66fae0bc687b070013718192","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Using the Entities CMS","icon":"","type":"basic","slug":"using-the-entity-cms","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66f5c4766aafa40012990662","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-30T17:32:44.248Z","isBodyEmpty":false,"children":[]}]},{"_id":"66fc07208791370010019b9f","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Events","icon":"","type":"basic","slug":"events","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e29123018ce002ae5b6d2","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-10-01T14:28:48.962Z","isBodyEmpty":true,"children":[{"_id":"66fc072f863df1000ff316d6","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Introduction to Events","icon":"","type":"basic","slug":"introduction-to-events","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66fc07208791370010019b9f","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-10-01T14:29:03.566Z","isBodyEmpty":false,"children":[]},{"_id":"66fc073c8791370010019ba6","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Using Events","icon":"","type":"basic","slug":"using-the-events-cms","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66fc07208791370010019b9f","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-10-01T14:29:16.497Z","isBodyEmpty":false,"children":[]}]},{"_id":"66fab685b67087001026e488","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Steps & Tools","icon":"","type":"basic","slug":"steps","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-30T14:32:37.466Z","parentDoc":"665e29123018ce002ae5b6d2","isBodyEmpty":true,"children":[{"_id":"6660d33f1676a800109a5f50","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Trigger","icon":"","type":"basic","slug":"trigger","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"trigger-step","parentDoc":"66fab685b67087001026e488","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-05T21:06:07.231Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66f2d62e8db0690036104323","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Choice","icon":"","type":"basic","slug":"choice-v2","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-09-24T15:09:00.000Z","parentDoc":"66fab685b67087001026e488","category":"6659cc0ab80ec2004f1aa190","isBodyEmpty":false,"children":[]},{"_id":"66f2d643f5c74f27e39c13e0","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Capture","icon":"","type":"basic","slug":"capture-v2","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-09-24T15:09:00.000Z","parentDoc":"66fab685b67087001026e488","category":"6659cc0ab80ec2004f1aa190","isBodyEmpty":false,"children":[]},{"_id":"66f2f2cb3df8e80011b6cfcf","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Buttons","icon":"","type":"basic","slug":"buttons-v2","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-09-24T17:11:00.000Z","parentDoc":"66fab685b67087001026e488","category":"6659cc0ab80ec2004f1aa190","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa25e","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Memory","icon":"","type":"basic","slug":"memory","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"chat-history","parentDoc":"66fab685b67087001026e488","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-05-07T15:24:38.916Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"66745fef2d16b3003d9555b3","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Improving understanding","icon":"","type":"basic","slug":"understanding-heirarchy","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e29123018ce002ae5b6d2","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-20T16:59:27.087Z","isBodyEmpty":false,"children":[]}]},{"_id":"665e2cb6801248001f3a36ee","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Decide","icon":"","type":"basic","slug":"decide-category","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-03T20:43:00.000Z","category":"6659cc0ab80ec2004f1aa190","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"665e2cd36d12da007670f00e","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Overview","icon":"","type":"basic","slug":"decide-overview","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-03T20:51:00.000Z","parentDoc":"665e2cb6801248001f3a36ee","category":"6659cc0ab80ec2004f1aa190","isBodyEmpty":false,"children":[]},{"_id":"665e2d08df553600110814ec","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Set","icon":"","type":"basic","slug":"variables-set","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"variables","createdAt":"2024-06-03T20:51:00.000Z","parentDoc":"665e2cb6801248001f3a36ee","category":"6659cc0ab80ec2004f1aa190","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"668c41e5c20e0f002a53be92","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Set AI step","icon":"","type":"basic","slug":"set-ai","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"set-ai-step","parentDoc":"665e2cb6801248001f3a36ee","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-07-08T19:45:41.019Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"665e2d29803577006a990111","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Conditions","icon":"","type":"basic","slug":"logic","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-03T20:52:00.000Z","parentDoc":"665e2cb6801248001f3a36ee","category":"6659cc0ab80ec2004f1aa190","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"665e2d895425ce005158dc5c","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Actions","icon":"","type":"basic","slug":"actions","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-03T20:54:00.000Z","parentDoc":"665e2cb6801248001f3a36ee","category":"6659cc0ab80ec2004f1aa190","isBodyEmpty":false,"children":[]},{"_id":"665e2e0b75d0a00071ecc8c6","api":{"method":"get","url":"","auth":"required","params":[]},"title":"API step","icon":"","type":"basic","slug":"api-step","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e2cb6801248001f3a36ee","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-03T20:56:43.574Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"665e2deaa0554f003788f3b9","api":{"method":"get","url":"","auth":"required","params":[]},"title":"JavaScript step","icon":"","type":"basic","slug":"javascript-step","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e2cb6801248001f3a36ee","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-03T20:56:10.979Z","isBodyEmpty":false,"children":[]},{"_id":"6724d1585353c8003cbfba0f","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Functions","icon":"","type":"basic","slug":"functions","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"functions-1","parentDoc":"665e2cb6801248001f3a36ee","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-11-01T13:02:16.941Z","isBodyEmpty":true,"children":[{"_id":"665e2df73a1244002bc62a4f","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Introduction to developing functions","icon":"","type":"basic","slug":"custom-functions","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6724d1585353c8003cbfba0f","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-03T20:56:23.338Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6724d209dbfd5500759c24c3","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Implementing function code","icon":"","type":"basic","slug":"developing-functions","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"developing-functions-copy-1","parentDoc":"6724d1585353c8003cbfba0f","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-11-01T13:05:13.522Z","isBodyEmpty":false,"children":[]},{"_id":"6724dc8a1b1e3d005e801352","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Supporting listen in functions","icon":"","type":"basic","slug":"functions-listen","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"implementing-function-code-copy","parentDoc":"6724d1585353c8003cbfba0f","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-11-01T13:50:02.209Z","isBodyEmpty":false,"children":[]},{"_id":"668bff58773c42001a362934","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Function step","icon":"","type":"basic","slug":"function-step","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"functions","parentDoc":"6724d1585353c8003cbfba0f","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-07-08T15:01:44.380Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"66d71ea978455200630578d6","api":{"method":"get","url":"","auth":"required","params":[]},"title":"KB Search","icon":"","type":"basic","slug":"kb-search","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e2cb6801248001f3a36ee","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-03T14:35:21.997Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"665e2f2e803577006a992ea4","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Respond","icon":"","type":"basic","slug":"respond","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-03T21:01:00.000Z","category":"6659cc0ab80ec2004f1aa190","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"665e2f3c1b6376001eba06a4","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Overview","icon":"","type":"basic","slug":"respond-overview","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"overview-3","parentDoc":"665e2f2e803577006a992ea4","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-03T21:01:48.613Z","isBodyEmpty":false,"children":[]},{"_id":"669016b2df60bc000f418c3d","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Messages","icon":"","type":"basic","slug":"message","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e2f2e803577006a992ea4","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-07-11T17:30:26.447Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"665e2f6a1a457c0018d49c88","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Images","icon":"","type":"basic","slug":"images","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e2f2e803577006a992ea4","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-03T21:02:34.586Z","isBodyEmpty":false,"children":[]},{"_id":"665e2f78e7386f00125ab3f3","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Cards and Carousels","icon":"","type":"basic","slug":"cards-carousels","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cards-and-carousels","parentDoc":"665e2f2e803577006a992ea4","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-03T21:02:48.627Z","isBodyEmpty":false,"children":[]},{"_id":"665e2fa46e43c90024ca7902","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Response AI step","icon":"","type":"basic","slug":"response-ai","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"response-ai-set-ai","parentDoc":"665e2f2e803577006a992ea4","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-03T21:03:32.011Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"665e2fc03004c500523bec78","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Knowledge Base","icon":"","type":"basic","slug":"knowledge-base","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e2f2e803577006a992ea4","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-03T21:04:00.109Z","isBodyEmpty":false,"children":[]},{"_id":"668d7ab3e1d622001023c78a","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Advanced Knowledge Base","icon":"","type":"basic","slug":"advanced-knowledge-base","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e2f2e803577006a992ea4","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-07-09T18:00:19.144Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa1d9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Custom Actions","icon":"","type":"basic","slug":"custom-actions","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"custom-actions-1","createdAt":"2022-07-26T17:18:15.698Z","category":"6659cc0ab80ec2004f1aa190","parentDoc":"665e2f2e803577006a992ea4","isBodyEmpty":false,"children":[]},{"_id":"66745cc82cbf78000f9ece6a","api":{"method":"get","url":"","auth":"required","params":[]},"title":"No Match handling","icon":"","type":"basic","slug":"no-match","order":10,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e2f2e803577006a992ea4","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-06-20T16:46:00.830Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa1db","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"No Reply handling","icon":"","type":"basic","slug":"no-reply-response","order":11,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"no-reply-response-1","createdAt":"2022-07-26T17:19:13.105Z","category":"6659cc0ab80ec2004f1aa190","parentDoc":"665e2f2e803577006a992ea4","isBodyEmpty":false,"children":[]},{"_id":"66f6834a9a806d0068145a22","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Prompt","icon":"","type":"basic","slug":"prompt-step","order":13,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"prompts","parentDoc":"665e2f2e803577006a992ea4","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-27T10:04:58.620Z","isBodyEmpty":false,"children":[]}]},{"_id":"66df9d154ee05f0010c80e67","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Best Practices","icon":"","type":"basic","slug":"voiceflow-best-practices","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-10T01:12:53.225Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"66dfaafa94d36500110916ce","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Getting started","icon":"","type":"basic","slug":"general-best-practices","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66df9d154ee05f0010c80e67","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-10T02:12:10.379Z","isBodyEmpty":false,"children":[]},{"_id":"66df9e7494d3650011091561","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Knowledge Base","icon":"","type":"basic","slug":"knowledge-base-best-practices","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66df9d154ee05f0010c80e67","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-10T01:18:44.614Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66dfa31fa9931b001ac10da0","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Workflow Builder","icon":"","type":"basic","slug":"workflow-builder","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66df9d154ee05f0010c80e67","category":"6659cc0ab80ec2004f1aa190","createdAt":"2024-09-10T01:38:39.599Z","isBodyEmpty":false,"children":[]},{"_id":"67b4b6151beb7096b7237b56","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"LLM Fallback (Beta)","icon":"","type":"basic","slug":"llm-fallback-system-beta","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66df9d154ee05f0010c80e67","category":"6659cc0ab80ec2004f1aa190","createdAt":"2025-02-18T16:32:21.090Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"665e31b3803577006a9958c9","title":"Deploying Agents","slug":"deploying-agents","order":3,"reference":false,"project":"61f2f6237da66107c6124fbe","version":"6659cc0ab80ec2004f1aa284","createdAt":"2024-06-03T21:12:19.981Z","__v":0,"pages":[{"_id":"665f676caf14420055a5bab5","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Overview","icon":"","type":"basic","slug":"deploying-overview","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"overview-6","category":"665e31b3803577006a9958c9","createdAt":"2024-06-04T19:13:48.784Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa1ea","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Web Widget","icon":"","type":"basic","slug":"chat-widget","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-12-07T14:28:52.025Z","category":"665e31b3803577006a9958c9","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"66673afd644da6002a8a8886","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Overview","icon":"","type":"basic","slug":"web-chat-overview","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa1ea","category":"665e31b3803577006a9958c9","createdAt":"2024-06-10T17:42:21.049Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"678ff35c757b720010c6f45e","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Webchat migration","icon":"","type":"basic","slug":"web-chat-migration","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa1ea","category":"665e31b3803577006a9958c9","createdAt":"2025-01-21T19:19:56.910Z","isBodyEmpty":false,"children":[]},{"_id":"67c1cea1fa256f003e829faa","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Chat persistence","icon":"","type":"basic","slug":"chat-persistence","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa1ea","category":"665e31b3803577006a9958c9","createdAt":"2025-02-28T14:56:33.881Z","isBodyEmpty":false,"children":[]},{"_id":"67c1cef1cdb6bb002a2348d8","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Proactive messages","icon":"","type":"basic","slug":"proactive-messages","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa1ea","category":"665e31b3803577006a9958c9","createdAt":"2025-02-28T14:57:53.122Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa252","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Custom forms and extensions","icon":"","type":"basic","slug":"custom-web-chat-widgets","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"custom-webchat-widgets","parentDoc":"6659cc0ab80ec2004f1aa1ea","category":"665e31b3803577006a9958c9","createdAt":"2024-03-06T21:53:54.316Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6791350cc0b8130053ef0e1a","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Custom styling","icon":"","type":"basic","slug":"advanced-styling","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa1ea","category":"665e31b3803577006a9958c9","createdAt":"2025-01-22T18:12:28.596Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa24e","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Adding custom variables","icon":"","type":"basic","slug":"customization-configuration","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa1ea","category":"665e31b3803577006a9958c9","createdAt":"2024-03-06T21:05:12.358Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa250","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Modify configurations","icon":"","type":"basic","slug":"custom-configurations","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa1ea","category":"665e31b3803577006a9958c9","createdAt":"2024-03-06T21:22:33.311Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa251","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Custom triggers","icon":"","type":"basic","slug":"web-chat-api","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa1ea","category":"665e31b3803577006a9958c9","createdAt":"2024-03-06T21:24:42.777Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6791348f2edb6900127d6f7f","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Legacy Webchat","icon":"","type":"basic","slug":"legacy-webchat","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa1ea","category":"665e31b3803577006a9958c9","createdAt":"2025-01-22T18:10:23.380Z","isBodyEmpty":true,"children":[{"_id":"6659cc0ab80ec2004f1aa24f","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Embed and customize styling","icon":"","type":"basic","slug":"embed-customize-styling","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6791348f2edb6900127d6f7f","category":"665e31b3803577006a9958c9","createdAt":"2024-03-06T21:16:26.511Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa216","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Open sourced react-chat","icon":"","type":"basic","slug":"react-chat","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"advanced-webchat","category":"665e31b3803577006a9958c9","createdAt":"2023-07-07T20:21:24.755Z","parentDoc":"6791348f2edb6900127d6f7f","mdx":{},"isBodyEmpty":false,"children":[]}]}]},{"_id":"674db8d2750ad30011377d05","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Voice (Phone Number)","icon":"","type":"basic","slug":"telephony","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"665e31b3803577006a9958c9","createdAt":"2024-12-02T13:40:34.969Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"674dbae60f78d3004670ba36","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Setting up Twilio integration","icon":"","type":"basic","slug":"setting-up-twilio-integration","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"674db8d2750ad30011377d05","category":"665e31b3803577006a9958c9","createdAt":"2024-12-02T13:49:26.663Z","isBodyEmpty":false,"children":[]},{"_id":"674dcec3352afc005f4c24a8","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Configuring voice settings","icon":"","type":"basic","slug":"configuring-voice-settings","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"674db8d2750ad30011377d05","category":"665e31b3803577006a9958c9","createdAt":"2024-12-02T15:14:11.628Z","isBodyEmpty":false,"children":[]},{"_id":"674dd03fe8ecae0010121b66","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Advanced - Using custom voice actions","icon":"","type":"basic","slug":"advanced-using-custom-voice-actions","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"674db8d2750ad30011377d05","category":"665e31b3803577006a9958c9","createdAt":"2024-12-02T15:20:31.604Z","isBodyEmpty":false,"children":[{"_id":"67acd373f354ce00127e4dc7","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"SIP Functionality","icon":"","type":"basic","slug":"sip-functionality","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"674dd03fe8ecae0010121b66","category":"665e31b3803577006a9958c9","createdAt":"2025-02-12T16:59:31.858Z","isBodyEmpty":false,"children":[]}]},{"_id":"6764ac22e61cb5003204ce72","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Outbound Calls","icon":"","type":"basic","slug":"outbound-calls","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"674db8d2750ad30011377d05","category":"665e31b3803577006a9958c9","createdAt":"2024-12-19T23:28:34.155Z","isBodyEmpty":false,"children":[]},{"_id":"6764cd2cfa9a7d0052ad0e6c","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Interruption Behavior","icon":"","type":"basic","slug":"interruption-behavior","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"674db8d2750ad30011377d05","category":"665e31b3803577006a9958c9","createdAt":"2024-12-20T01:49:32.232Z","isBodyEmpty":false,"children":[]},{"_id":"6750b7c2f87a9d0012645eea","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Examples","icon":"","type":"basic","slug":"examples","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"674db8d2750ad30011377d05","category":"665e31b3803577006a9958c9","createdAt":"2024-12-04T20:12:50.971Z","isBodyEmpty":false,"children":[]}]},{"_id":"6659cc0ab80ec2004f1aa239","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Text-based interfaces","icon":"","type":"basic","slug":"text-based-interfaces","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"665e31b3803577006a9958c9","createdAt":"2023-11-23T15:27:42.866Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"666c9df889b795006406658f","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Overview","icon":"","type":"basic","slug":"text-deployment-overview","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-14T19:45:00.000Z","parentDoc":"6659cc0ab80ec2004f1aa239","category":"665e31b3803577006a9958c9","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa211","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"WhatsApp","icon":"","type":"basic","slug":"deploy-whatsapp","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://github.com/voiceflow/example-integration-whatsapp","link_external":true,"previousSlug":"advanced-whatsapp","category":"665e31b3803577006a9958c9","createdAt":"2023-07-07T19:32:54.289Z","parentDoc":"6659cc0ab80ec2004f1aa239","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa20e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Discord","icon":"","type":"basic","slug":"deploy-discord","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://github.com/voiceflow/demos-n-examples/tree/master/voiceflow-discord","link_external":true,"previousSlug":"discord","category":"665e31b3803577006a9958c9","createdAt":"2023-07-07T19:29:40.261Z","parentDoc":"6659cc0ab80ec2004f1aa239","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa20f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Slack","icon":"","type":"basic","slug":"deploy-slack","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://github.com/voiceflow/demos-n-examples/tree/master/voiceflow-slack","link_external":true,"previousSlug":"slack","category":"665e31b3803577006a9958c9","createdAt":"2023-07-07T19:30:11.742Z","parentDoc":"6659cc0ab80ec2004f1aa239","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa1a0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Telegram","type":"basic","slug":"deploy-telegram","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"how-to-telegram","createdAt":"2022-01-31T00:02:34.931Z","category":"665e31b3803577006a9958c9","parentDoc":"6659cc0ab80ec2004f1aa239","icon":"","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa247","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Twilio SMS","icon":"","type":"basic","slug":"deploy-twilio-sms","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://github.com/voiceflow/demos-n-examples/tree/master/voiceflow-discord","link_external":true,"previousSlug":"twilio-sms","parentDoc":"6659cc0ab80ec2004f1aa239","category":"665e31b3803577006a9958c9","createdAt":"2023-12-08T21:24:40.013Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa248","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Microsoft Teams","icon":"","type":"basic","slug":"deploy-ms-teams","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"microsoft-teams-copy","parentDoc":"6659cc0ab80ec2004f1aa239","category":"665e31b3803577006a9958c9","createdAt":"2023-12-18T19:19:23.071Z","isBodyEmpty":false,"children":[]}]},{"_id":"6659cc0ab80ec2004f1aa23a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Voice-based interfaces","icon":"","type":"basic","slug":"voice-based-interfaces","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"665e31b3803577006a9958c9","createdAt":"2023-11-23T15:29:02.856Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"666c9de76cd8c00030ddfe55","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Overview","icon":"","type":"basic","slug":"voice-deployment-overview","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-14T19:45:00.000Z","parentDoc":"6659cc0ab80ec2004f1aa23a","category":"665e31b3803577006a9958c9","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa23e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Alexa","icon":"","type":"link","slug":"alexa-1","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://xavidop.me/alexa/2023-11-21-voiceflow-alexa/","link_external":true,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa23a","category":"665e31b3803577006a9958c9","createdAt":"2023-11-23T19:08:20.693Z","isBodyEmpty":true,"children":[]},{"_id":"6659cc0ab80ec2004f1aa212","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Custom TTS (ElevenLabs)","icon":"","type":"basic","slug":"elevenlabs-api-integration","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"665e31b3803577006a9958c9","createdAt":"2023-07-07T19:47:11.294Z","parentDoc":"6659cc0ab80ec2004f1aa23a","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa213","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Custom ASR (Whisper)","icon":"","type":"basic","slug":"deploy-whisper-asr","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"voiceflow-asr-demo-whisper-base-model","category":"665e31b3803577006a9958c9","createdAt":"2023-07-07T20:09:23.866Z","parentDoc":"6659cc0ab80ec2004f1aa23a","isBodyEmpty":false,"children":[]}]},{"_id":"665f67be563fbf006b149cf3","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Custom interfaces and deploying through APIs","icon":"","type":"basic","slug":"custom-interfaces","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-04T19:14:00.000Z","category":"665e31b3803577006a9958c9","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"665f67d50dc7ec0010eec412","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Overview","icon":"","type":"basic","slug":"custom-interfaces-overview","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-04T19:15:00.000Z","category":"665e31b3803577006a9958c9","parentDoc":"665f67be563fbf006b149cf3","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa1fc","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Custom deployment channel (API)","icon":"","type":"basic","slug":"custom-channel-api","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"665e31b3803577006a9958c9","createdAt":"2023-05-02T04:20:44.547Z","parentDoc":"665f67be563fbf006b149cf3","isBodyEmpty":false,"children":[]},{"_id":"66aa495630365a0067333948","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Unity AI Powered NPC","icon":"","type":"basic","slug":"custom-interface-unity","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-07-31T14:24:00.000Z","parentDoc":"665f67be563fbf006b149cf3","category":"665e31b3803577006a9958c9","isBodyEmpty":false,"children":[]},{"_id":"66aa49177e69ed004a736308","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Shopify In-Store Copilot","icon":"","type":"basic","slug":"custom-interface-shopify","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"shopify","parentDoc":"665f67be563fbf006b149cf3","category":"665e31b3803577006a9958c9","createdAt":"2024-07-31T14:24:23.102Z","isBodyEmpty":false,"children":[]},{"_id":"66ab9151557ed2001979dbda","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Documentation Copilot","icon":"","type":"basic","slug":"react-embedded-educhat","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"react-embedded-article-reading-ai","parentDoc":"665f67be563fbf006b149cf3","category":"665e31b3803577006a9958c9","createdAt":"2024-08-01T13:44:49.798Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"665e31bbbe0e2d005c658727","title":"Improving Agents","slug":"improving-agents","order":4,"reference":false,"project":"61f2f6237da66107c6124fbe","version":"6659cc0ab80ec2004f1aa284","createdAt":"2024-06-03T21:12:27.565Z","__v":0,"pages":[{"_id":"6659cc0ab80ec2004f1aa271","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Agent enhancement cookbook","icon":"","type":"basic","slug":"ai-agent-recipes","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"agent-building-copy","category":"665e31bbbe0e2d005c658727","createdAt":"2024-05-08T18:06:32.872Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"6659cc0ab80ec2004f1aa215","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Bring your own LLM","icon":"","type":"basic","slug":"custom-llm","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"665e31bbbe0e2d005c658727","createdAt":"2023-07-07T20:15:55.735Z","parentDoc":"6659cc0ab80ec2004f1aa271","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa214","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Custom Knowledge Base","icon":"","type":"basic","slug":"langchain-knowledge-base","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"665e31bbbe0e2d005c658727","createdAt":"2023-07-07T20:11:50.313Z","parentDoc":"6659cc0ab80ec2004f1aa271","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa217","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Live Chat Handoff","icon":"","type":"basic","slug":"live-chat-handoff","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"665e31bbbe0e2d005c658727","createdAt":"2023-07-07T20:28:13.172Z","parentDoc":"6659cc0ab80ec2004f1aa271","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa273","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Building Advanced Analytics","icon":"","type":"basic","slug":"building-advanced-analytics","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa271","category":"665e31bbbe0e2d005c658727","createdAt":"2024-05-10T19:09:04.441Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa274","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Advanced RAG Filtering and Tagging","icon":"","type":"basic","slug":"advanced-rag-filtering-and-tagging","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa271","category":"665e31bbbe0e2d005c658727","createdAt":"2024-05-12T00:05:23.089Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa275","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Adding live internet search to your RAG solution","icon":"","type":"basic","slug":"adding-live-internet-search-to-your-rag-solution","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa271","category":"665e31bbbe0e2d005c658727","createdAt":"2024-05-12T00:09:46.847Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa276","api":{"method":"get","url":"","auth":"required","params":[]},"title":"PII redaction for AI Agents","icon":"","type":"basic","slug":"pii-redaction-for-ai-agents","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa271","category":"665e31bbbe0e2d005c658727","createdAt":"2024-05-12T00:34:28.055Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa281","api":{"method":"get","url":"","auth":"required","params":[]},"title":"LLMLingua2 Prompt Compression","icon":"","type":"basic","slug":"llmlingua2-prompt-compression","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"custom-voices-for-your-agent-using-elevenlabs-copy","parentDoc":"6659cc0ab80ec2004f1aa271","category":"665e31bbbe0e2d005c658727","createdAt":"2024-05-14T17:47:17.640Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa283","api":{"method":"get","url":"","auth":"required","params":[]},"title":"GPT-4o with fallback to Claude 3 Sonnet","icon":"","type":"basic","slug":"gpt4o-fallback-claude3-aigateway","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"llmlingua2-prompt-compression-copy","parentDoc":"6659cc0ab80ec2004f1aa271","category":"665e31bbbe0e2d005c658727","createdAt":"2024-05-15T08:01:56.940Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa279","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Integrating Perplexity into Voiceflow","icon":"","type":"basic","slug":"integrating-perplexity-into-voiceflow","order":10,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa271","category":"665e31bbbe0e2d005c658727","createdAt":"2024-05-12T00:47:25.653Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa277","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Generate Automated Emails with User Transcripts","icon":"","type":"basic","slug":"automated-emails-with-user-transcripts","order":11,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa271","category":"665e31bbbe0e2d005c658727","createdAt":"2024-05-12T00:39:16.971Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa278","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Using Voiceflow with Open Source Models","icon":"","type":"basic","slug":"using-voiceflow-with-open-source-models","order":12,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa271","category":"665e31bbbe0e2d005c658727","createdAt":"2024-05-12T00:42:19.273Z","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa280","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Custom Voices for your Agent using ElevenLabs","icon":"","type":"basic","slug":"custom-voices-for-your-agent-using-elevenlabs","order":13,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6659cc0ab80ec2004f1aa271","category":"665e31bbbe0e2d005c658727","createdAt":"2024-05-12T23:30:13.185Z","isBodyEmpty":false,"children":[]}]},{"_id":"665f69f2f35ab3005991de8f","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Transcripts","icon":"","type":"basic","slug":"transcripts","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"665e31bbbe0e2d005c658727","createdAt":"2024-06-04T19:24:34.691Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"665f6a02b5ec7c005b6315e3","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Analytics","icon":"","type":"basic","slug":"analytics","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"665e31bbbe0e2d005c658727","createdAt":"2024-06-04T19:24:50.646Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"66dccbc9cdc97b0042135bce","title":"Prompting and LLMs","slug":"building-best-practices","order":5,"reference":false,"project":"61f2f6237da66107c6124fbe","version":"6659cc0ab80ec2004f1aa284","createdAt":"2024-09-07T21:55:21.532Z","__v":0,"pages":[{"_id":"67296eb1ff97a80013952e81","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Prompts","icon":"","type":"basic","slug":"prompts-1","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"66dccbc9cdc97b0042135bce","createdAt":"2024-11-05T01:02:41.787Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"671f9d4038a4f0001eec24c0","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Prompts CMS","icon":"","type":"basic","slug":"prompts-cms-and-editor","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"66dccbc9cdc97b0042135bce","createdAt":"2024-10-28T14:18:40.198Z","parentDoc":"67296eb1ff97a80013952e81","isBodyEmpty":false,"children":[]},{"_id":"675b0e6006a80e002fada538","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Prompt Library","icon":"","type":"basic","slug":"prompt-library","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"67296eb1ff97a80013952e81","category":"66dccbc9cdc97b0042135bce","createdAt":"2024-12-12T16:25:04.751Z","isBodyEmpty":false,"children":[]},{"_id":"66ddccad635d670056a9bc4f","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Types of prompts","icon":"","type":"basic","slug":"types-of-prompts","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"67296eb1ff97a80013952e81","category":"66dccbc9cdc97b0042135bce","createdAt":"2024-09-08T16:11:25.939Z","isBodyEmpty":false,"children":[]},{"_id":"66ddccdb967390005af3e800","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Crafting great prompts","icon":"","type":"basic","slug":"crafting-great-prompts","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"67296eb1ff97a80013952e81","category":"66dccbc9cdc97b0042135bce","createdAt":"2024-09-08T16:12:11.020Z","isBodyEmpty":false,"children":[]}]},{"_id":"66dccd146625e80030660e4c","api":{"method":"get","url":"","auth":"required","params":[]},"title":"What are LLMs?","icon":"","type":"basic","slug":"using-large-language-models-llms-in-voiceflow","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"66dccbc9cdc97b0042135bce","createdAt":"2024-09-07T22:00:52.294Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66dccddc1176c5001f6d70e8","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Prompting","icon":"","type":"basic","slug":"prompting","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"66dccbc9cdc97b0042135bce","createdAt":"2024-09-07T22:04:12.852Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66ddc99c967390005af3e7b0","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Hallucinations","icon":"","type":"basic","slug":"hallucination-prevention","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"66dccbc9cdc97b0042135bce","createdAt":"2024-09-08T15:58:20.403Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"66ddcc26dc793d00101c88bc","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Hallucination reduction","icon":"","type":"basic","slug":"hallucination-reduction","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66ddc99c967390005af3e7b0","category":"66dccbc9cdc97b0042135bce","createdAt":"2024-09-08T16:09:10.522Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"6659cc0ab80ec2004f1aa18a","title":"RESOURCES","slug":"resources","order":7,"reference":false,"project":"61f2f6237da66107c6124fbe","version":"6659cc0ab80ec2004f1aa284","createdAt":"2023-11-23T16:18:10.960Z","__v":0,"pages":[{"_id":"665e25f2803577006a9883f1","api":{"method":"get","url":"","auth":"required","params":[]},"title":"FAQ","icon":"","type":"basic","slug":"faq","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa18a","createdAt":"2024-06-03T20:22:10.014Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"6660b40ebcab540035935294","api":{"method":"get","url":"","auth":"required","params":[]},"title":"What are Tokens?","icon":"","type":"basic","slug":"what-are-tokens","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e25f2803577006a9883f1","category":"6659cc0ab80ec2004f1aa18a","createdAt":"2024-06-05T18:53:02.641Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6660b4bedd98c7001149fc72","api":{"method":"get","url":"","auth":"required","params":[]},"title":"How to find the Sitemap for a website","icon":"","type":"basic","slug":"how-to-find-the-sitemap-for-a-website","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e25f2803577006a9883f1","category":"6659cc0ab80ec2004f1aa18a","createdAt":"2024-06-05T18:55:58.790Z","isBodyEmpty":false,"children":[]},{"_id":"6660b58584d4a1005bd97eaa","api":{"method":"get","url":"","auth":"required","params":[]},"title":"AI Token Purchase Confirmation","icon":"","type":"basic","slug":"ai-token-purchase-confirmation","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e25f2803577006a9883f1","category":"6659cc0ab80ec2004f1aa18a","createdAt":"2024-06-05T18:59:17.664Z","isBodyEmpty":false,"children":[]},{"_id":"6660b61a996dc80062e95318","api":{"method":"get","url":"","auth":"required","params":[]},"title":"How to find your Assistant version ID and project ID","icon":"","type":"basic","slug":"how-to-find-your-assistant-version-id-and-project-id","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e25f2803577006a9883f1","category":"6659cc0ab80ec2004f1aa18a","createdAt":"2024-06-05T19:01:46.155Z","isBodyEmpty":false,"children":[]},{"_id":"6660b6645e516c001102ce48","api":{"method":"get","url":"","auth":"required","params":[]},"title":"How to Fix a Loading Screen Error","icon":"","type":"basic","slug":"how-to-fix-a-loading-screen-error","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e25f2803577006a9883f1","category":"6659cc0ab80ec2004f1aa18a","createdAt":"2024-06-05T19:03:00.077Z","isBodyEmpty":false,"children":[]},{"_id":"6660b76cc674cf0018d5ef45","api":{"method":"get","url":"","auth":"required","params":[]},"title":"I'm missing steps?","icon":"","type":"basic","slug":"missing-steps","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"my-sidebar-is-missing-steps","parentDoc":"665e25f2803577006a9883f1","category":"6659cc0ab80ec2004f1aa18a","createdAt":"2024-06-05T19:07:24.237Z","isBodyEmpty":false,"children":[]},{"_id":"6660b7f96992c3002fce2b26","api":{"method":"get","url":"","auth":"required","params":[]},"title":"How Voiceflow's NLU Exports Work","icon":"","type":"basic","slug":"how-voiceflows-nlu-exports-work","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e25f2803577006a9883f1","category":"6659cc0ab80ec2004f1aa18a","createdAt":"2024-06-05T19:09:45.513Z","isBodyEmpty":false,"children":[]},{"_id":"6660c7484090c1000f3a9ca4","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Adjusting the NLU Intent Confidence Threshold","icon":"","type":"basic","slug":"adjusting-the-nlu-intent-confidence-threshold","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e25f2803577006a9883f1","category":"6659cc0ab80ec2004f1aa18a","createdAt":"2024-06-05T20:15:04.434Z","isBodyEmpty":false,"children":[]},{"_id":"6660ae28996dc80062e92da2","api":{"method":"get","url":"","auth":"required","params":[]},"title":"How do I log out of Voiceflow?","icon":"","type":"basic","slug":"how-do-i-log-out-of-voiceflow","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e25f2803577006a9883f1","category":"6659cc0ab80ec2004f1aa18a","createdAt":"2024-06-05T18:27:52.388Z","isBodyEmpty":false,"children":[]},{"_id":"66bf1f05bae4c2003d88d553","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Using Specific Models in Voiceflow KB Query API","icon":"","type":"basic","slug":"using-specific-models-in-voiceflow-kb-query-api","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e25f2803577006a9883f1","category":"6659cc0ab80ec2004f1aa18a","createdAt":"2024-08-16T09:42:29.885Z","isBodyEmpty":false,"children":[]}]},{"_id":"6659cc0ab80ec2004f1aa23c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Join our Discord Community","icon":"","type":"link","slug":"join-our-discord-community","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://link.voiceflow.com/community","link_external":true,"previousSlug":"","category":"6659cc0ab80ec2004f1aa18a","createdAt":"2023-11-23T16:23:32.609Z","parentDoc":null,"isBodyEmpty":true,"children":[]},{"_id":"6659cc0ab80ec2004f1aa23b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Security at Voiceflow","icon":"","type":"link","slug":"security-at-voiceflow","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://www.voiceflow.com/security","link_external":true,"previousSlug":"","category":"6659cc0ab80ec2004f1aa18a","createdAt":"2023-11-23T16:20:49.870Z","parentDoc":null,"isBodyEmpty":true,"children":[]},{"_id":"665e36a224393b00127e3a7e","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Templates","icon":"","type":"link","slug":"templates","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://www.voiceflow.com/templates","link_external":true,"previousSlug":"","category":"6659cc0ab80ec2004f1aa18a","createdAt":"2024-06-03T21:33:22.620Z","parentDoc":null,"isBodyEmpty":true,"children":[]}]}],"refs":[{"_id":"6659cc0ab80ec2004f1aa188","title":"Using the APIs","slug":"get-started","order":1,"reference":true,"project":"61f2f6237da66107c6124fbe","version":"6659cc0ab80ec2004f1aa284","createdAt":"2023-11-13T16:49:31.522Z","__v":0,"pages":[{"_id":"665e3dd359a0810010614efb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Voiceflow API Overview","icon":"","type":"basic","slug":"api-overview","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"voiceflow-api-overview","category":"6659cc0ab80ec2004f1aa188","createdAt":"2024-06-03T22:04:03.397Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"665e3dfb940bab006a9efeaa","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Getting started with Voiceflow APIs","icon":"","type":"basic","slug":"getting-started-with-apis","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa188","createdAt":"2024-06-03T22:04:43.683Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"6696777ef2dad20045782652","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Overview and setup","icon":"","type":"basic","slug":"api-guide-start","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-07-16T13:36:00.000Z","parentDoc":"665e3dfb940bab006a9efeaa","category":"6659cc0ab80ec2004f1aa188","isBodyEmpty":false,"children":[]},{"_id":"6696775a71c1400061a59a1b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"How to get your Voiceflow Project API key","icon":"","type":"basic","slug":"how-to-get-your-voiceflow-project-api-key","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e3dfb940bab006a9efeaa","category":"6659cc0ab80ec2004f1aa188","createdAt":"2024-07-16T13:36:26.106Z","isBodyEmpty":false,"children":[]},{"_id":"669677c316f491001e847b03","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Using the Dialog Manager API (DM API)","icon":"","type":"basic","slug":"api-guide-dmapi-setup","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-07-16T13:37:00.000Z","parentDoc":"665e3dfb940bab006a9efeaa","category":"6659cc0ab80ec2004f1aa188","isBodyEmpty":false,"children":[]},{"_id":"669677a0e66524006ead3ed8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"How to send requests to Voiceflow APIs","icon":"","type":"basic","slug":"api-guide-send-requests","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-07-16T13:37:00.000Z","parentDoc":"665e3dfb940bab006a9efeaa","category":"6659cc0ab80ec2004f1aa188","isBodyEmpty":false,"children":[]},{"_id":"669677db8577f5004d73a9cb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"How to start a conversation","icon":"","type":"basic","slug":"api-guide-start-convo","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-07-16T13:38:00.000Z","parentDoc":"665e3dfb940bab006a9efeaa","category":"6659cc0ab80ec2004f1aa188","isBodyEmpty":false,"children":[]},{"_id":"669677f37d630f005d8efac0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"How to parse the output traces","icon":"","type":"basic","slug":"api-guide-parse-traces","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-07-16T13:38:00.000Z","parentDoc":"665e3dfb940bab006a9efeaa","category":"6659cc0ab80ec2004f1aa188","isBodyEmpty":false,"children":[]},{"_id":"6696780309f6800012c481b2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"How to send user replies","icon":"","type":"basic","slug":"api-guide-user-reply","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-07-16T13:39:00.000Z","parentDoc":"665e3dfb940bab006a9efeaa","category":"6659cc0ab80ec2004f1aa188","isBodyEmpty":false,"children":[]},{"_id":"6696781c2cc1900044f39195","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"How to deal with other traces (button, end, and more)","icon":"","type":"basic","slug":"api-guide-other-traces","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-07-16T13:39:00.000Z","parentDoc":"665e3dfb940bab006a9efeaa","category":"6659cc0ab80ec2004f1aa188","isBodyEmpty":false,"children":[]},{"_id":"6696784512b3a3002f7f112c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Using the Transcripts API","icon":"","type":"basic","slug":"using-the-transcripts-api","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"665e3dfb940bab006a9efeaa","category":"6659cc0ab80ec2004f1aa188","createdAt":"2024-07-16T13:40:21.060Z","isBodyEmpty":false,"children":[]},{"_id":"669678677ea068000f42f538","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Saving your user transcript","icon":"","type":"basic","slug":"api-guide-saving-transcripts","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-07-16T13:40:00.000Z","parentDoc":"665e3dfb940bab006a9efeaa","category":"6659cc0ab80ec2004f1aa188","isBodyEmpty":false,"children":[]},{"_id":"66967881716f7a002ffd1955","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Next steps","icon":"","type":"basic","slug":"api-guide-next-steps","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-07-16T13:41:00.000Z","parentDoc":"665e3dfb940bab006a9efeaa","category":"6659cc0ab80ec2004f1aa188","isBodyEmpty":false,"children":[]}]},{"_id":"6659cc0ab80ec2004f1aa1ab","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Authentication","type":"basic","slug":"authentication","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"project","createdAt":"2022-02-23T18:15:40.549Z","parentDoc":null,"category":"6659cc0ab80ec2004f1aa188","icon":"","isBodyEmpty":false,"children":[]},{"_id":"665e3e0f7bbac5005187c3c2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Versions and Project IDs","icon":"","type":"basic","slug":"project-ids-and-versions","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa188","createdAt":"2024-06-03T22:05:03.483Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"6659cc0ab80ec2004f1aa180","title":"Voiceflow Dialog Management API","slug":"voiceflow-dialog-management-api","order":2,"reference":true,"isAPI":true,"project":"61f2f6237da66107c6124fbe","version":"6659cc0ab80ec2004f1aa284","createdAt":"2022-02-08T20:43:00.744Z","__v":0,"pages":[{"_id":"6659cc0ab80ec2004f1aa1aa","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Overview","type":"basic","slug":"overview","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-02-23T17:40:16.716Z","category":"6659cc0ab80ec2004f1aa180","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa235","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Trace Types","icon":"","type":"basic","slug":"trace-types","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa180","createdAt":"2023-11-16T21:20:26.497Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"665f6dee3a8dd1005abec17a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Dialog API Endpoints","icon":"","type":"basic","slug":"dialog-api","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa180","createdAt":"2024-06-04T19:41:34.743Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"66f4878daea74000428af4c2","mdx":{},"api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa191"},"title":"Interact Stream","icon":"","type":"endpoint","slug":"interact-stream","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"stateInteractStream","link_url":"","link_external":false,"previousSlug":"stateinteractstream","category":"6659cc0ab80ec2004f1aa180","createdAt":"2024-09-25T21:58:37.146Z","parentDoc":"665f6dee3a8dd1005abec17a","isBodyEmpty":false,"children":[{"_id":"66f4bdb54140fc006d5820a2","mdx":{},"api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Stream Completion Events","icon":"","type":"basic","slug":"completion-events","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"stream-completion-events-1","parentDoc":"66f4878daea74000428af4c2","category":"6659cc0ab80ec2004f1aa180","createdAt":"2024-09-26T01:49:41.708Z","isBodyEmpty":false,"children":[]}]},{"_id":"6659cc0ab80ec2004f1aa1c2","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa191"},"title":"Interact","type":"endpoint","slug":"stateinteract-1","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"stateInteract","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa180","createdAt":"2022-06-24T14:04:05.090Z","parentDoc":"665f6dee3a8dd1005abec17a","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6659cc0ab80ec2004f1aa1c6","api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa191"},"title":"Update variables","type":"endpoint","slug":"updatestatevariables-1","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"updateStateVariables","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa180","createdAt":"2022-06-24T14:04:05.094Z","parentDoc":"665f6dee3a8dd1005abec17a","icon":"","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"668d56895306e900120282e6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"State API Endpoints","icon":"","type":"basic","slug":"state-api-endpoints","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa180","createdAt":"2024-07-09T15:26:01.568Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"6659cc0ab80ec2004f1aa1b2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Understanding the dialog state stack","type":"basic","slug":"state","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-02-26T17:28:16.647Z","category":"6659cc0ab80ec2004f1aa180","parentDoc":"668d56895306e900120282e6","icon":"","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa1c3","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa191"},"title":"Fetch state","type":"endpoint","slug":"getstate-1","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getState","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa180","createdAt":"2022-06-24T14:04:05.091Z","parentDoc":"668d56895306e900120282e6","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6659cc0ab80ec2004f1aa1c4","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa191"},"title":"Update state","type":"endpoint","slug":"poststate-1","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"postState","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa180","createdAt":"2022-06-24T14:04:05.092Z","parentDoc":"668d56895306e900120282e6","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6659cc0ab80ec2004f1aa1c5","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa191"},"title":"Delete state","type":"endpoint","slug":"deletestate-1","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"deleteState","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa180","createdAt":"2022-06-24T14:04:05.093Z","parentDoc":"668d56895306e900120282e6","icon":"","mdx":{},"isBodyEmpty":true,"children":[]}]}]},{"_id":"6659cc0ab80ec2004f1aa187","title":"Knowledge Base API","slug":"knowledge-base","order":3,"reference":true,"project":"61f2f6237da66107c6124fbe","version":"6659cc0ab80ec2004f1aa284","createdAt":"2023-11-13T15:59:17.412Z","__v":0,"pages":[{"_id":"665e3d6f6125c3008297503a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Overview","icon":"","type":"basic","slug":"knowledge-overview","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"overview-4","category":"6659cc0ab80ec2004f1aa187","createdAt":"2024-06-03T22:02:23.638Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"673f956c8b93d800768f49be","mdx":{},"api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Query API","icon":"","type":"basic","slug":"query-api","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2024-11-21T20:17:48.124Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"673f9535a968890071572ea5","mdx":{},"api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"673f9533a968890071572ea0"},"title":"Query","icon":"","type":"endpoint","slug":"post_knowledge-base-query-1","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_knowledge-base-query","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2024-11-21T20:16:53.086Z","parentDoc":"673f956c8b93d800768f49be","isBodyEmpty":false,"children":[]},{"_id":"66b3bf931cee44005112109d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Filtering with Metadata","icon":"","type":"basic","slug":"filter-with-metadata","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"filtering-with-metadata","parentDoc":"673f956c8b93d800768f49be","category":"6659cc0ab80ec2004f1aa187","createdAt":"2024-08-07T18:40:19.234Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"673e496312b6e40054a57b36","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"673e496212b6e40054a57b33"},"title":"Document API Reference","icon":"","type":"basic","slug":"api-reference-1","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__API Reference","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2024-11-20T20:41:07.831Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"673fd65f89875b00684c1fdf","mdx":{},"api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"673fd65e89875b00684c1fda"},"title":"Upload Document (url)","icon":"","type":"endpoint","slug":"post_v1-knowledge-base-docs-upload-1","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v1-knowledge-base-docs-upload","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2024-11-22T00:54:55.418Z","parentDoc":"673e496312b6e40054a57b36","isBodyEmpty":false,"children":[]},{"_id":"675094690cd0ce003b02757a","mdx":{},"api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"675094680cd0ce003b027575"},"title":"Upload Document (File)","icon":"","type":"endpoint","slug":"post_v1-knowledge-base-docs-upload-2","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v1-knowledge-base-docs-upload","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2024-12-04T17:42:01.663Z","parentDoc":"673e496312b6e40054a57b36","isBodyEmpty":false,"children":[]},{"_id":"673e496312b6e40054a57b3a","mdx":{},"api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"673e496212b6e40054a57b33"},"title":"Delete Document","icon":"","type":"endpoint","slug":"delete_v1-knowledge-base-docs-documentid","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_v1-knowledge-base-docs-documentid","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2024-11-20T20:41:07.862Z","parentDoc":"673e496312b6e40054a57b36","isBodyEmpty":true,"children":[]},{"_id":"673e496312b6e40054a57b3b","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"673e496212b6e40054a57b33"},"title":"Document Chunk Retrieval","icon":"","type":"endpoint","slug":"get_v1-knowledge-base-docs-documentid","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-knowledge-base-docs-documentid","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2024-11-20T20:41:07.863Z","parentDoc":"673e496312b6e40054a57b36","isBodyEmpty":true,"children":[]},{"_id":"673e496312b6e40054a57b3c","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"673e496212b6e40054a57b33"},"title":"Document List","icon":"","type":"endpoint","slug":"get_v1-knowledge-base-docs","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-knowledge-base-docs","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2024-11-20T20:41:07.863Z","parentDoc":"673e496312b6e40054a57b36","isBodyEmpty":true,"children":[]},{"_id":"675094690cd0ce003b02757b","mdx":{},"api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"675094680cd0ce003b027575"},"title":"Update Document Metadata","icon":"","type":"endpoint","slug":"patch_v1-knowledge-base-docs-documentid","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patch_v1-knowledge-base-docs-documentid","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2024-12-04T17:42:01.663Z","parentDoc":"673e496312b6e40054a57b36","isBodyEmpty":false,"children":[]},{"_id":"675094690cd0ce003b027580","mdx":{},"api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"675094680cd0ce003b027575"},"title":"Update Chunk Metadata","icon":"","type":"endpoint","slug":"patch_v1-knowledge-base-docs-documentid-chunk-chunkid","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patch_v1-knowledge-base-docs-documentid-chunk-chunkid","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2024-12-04T17:42:01.665Z","parentDoc":"673e496312b6e40054a57b36","isBodyEmpty":false,"children":[]},{"_id":"675094690cd0ce003b02757f","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"675094680cd0ce003b027575"},"title":"Replace Document (File)","icon":"","type":"endpoint","slug":"put_v1-knowledge-base-docs-documentid-upload-2","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_v1-knowledge-base-docs-documentid-upload","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2024-12-04T17:42:01.665Z","parentDoc":"673e496312b6e40054a57b36","isBodyEmpty":true,"children":[]},{"_id":"673fd65f89875b00684c1fe0","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"673fd65e89875b00684c1fda"},"title":"Replace Document (url)","icon":"","type":"endpoint","slug":"put_v1-knowledge-base-docs-documentid-upload-1","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_v1-knowledge-base-docs-documentid-upload","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2024-11-22T00:54:55.419Z","parentDoc":"673e496312b6e40054a57b36","isBodyEmpty":true,"children":[]},{"_id":"673e496312b6e40054a57b3f","mdx":{},"api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"673e496212b6e40054a57b33"},"title":"Upload Table Data","icon":"","type":"endpoint","slug":"post_v1-knowledge-base-docs-upload-table-1","order":11,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v1-knowledge-base-docs-upload-table","link_url":"","link_external":false,"previousSlug":"post_v1-knowledge-base-docs-upload-table-2","category":"6659cc0ab80ec2004f1aa187","createdAt":"2024-11-20T20:41:07.866Z","parentDoc":"673e496312b6e40054a57b36","isBodyEmpty":true,"children":[]}]},{"_id":"6659cc0ab80ec2004f1aa227","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"6659cc0ab80ec2004f1aa198"},"title":"Tags API (Legacy)","icon":"","type":"basic","slug":"api-reference-6","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__API Reference","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2023-10-05T00:28:53.430Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"6659cc0ab80ec2004f1aa228","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa198"},"title":"Create KB tag","icon":"","type":"endpoint","slug":"post_v3alpha-knowledge-base-tags","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v3alpha-knowledge-base-tags","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2023-10-05T00:28:53.596Z","parentDoc":"6659cc0ab80ec2004f1aa227","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa229","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa198"},"title":"KB tag list","icon":"","type":"endpoint","slug":"get_v3alpha-knowledge-base-tags","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v3alpha-knowledge-base-tags","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2023-10-05T00:28:53.597Z","parentDoc":"6659cc0ab80ec2004f1aa227","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa22a","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa198"},"title":"Get KB tag label","icon":"","type":"endpoint","slug":"get_v3alpha-knowledge-base-tags-tagid","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v3alpha-knowledge-base-tags-tagid","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2023-10-05T00:28:53.597Z","parentDoc":"6659cc0ab80ec2004f1aa227","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa22b","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa198"},"title":"Delete KB tag","icon":"","type":"endpoint","slug":"delete_v3alpha-knowledge-base-tags-tagid","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_v3alpha-knowledge-base-tags-tagid","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2023-10-05T00:28:53.598Z","parentDoc":"6659cc0ab80ec2004f1aa227","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa22c","api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa198"},"title":"Update KB tag label","icon":"","type":"endpoint","slug":"patch_v3alpha-knowledge-base-tags-tagid","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patch_v3alpha-knowledge-base-tags-tagid","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2023-10-05T00:28:53.598Z","parentDoc":"6659cc0ab80ec2004f1aa227","isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa22d","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa198"},"title":"Attaches KB tags to a document.","icon":"","type":"endpoint","slug":"post_v3alpha-knowledge-base-docs-documentid-tags-attach","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v3alpha-knowledge-base-docs-documentid-tags-attach","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2023-10-20T11:02:33.309Z","parentDoc":"6659cc0ab80ec2004f1aa227","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6659cc0ab80ec2004f1aa22e","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa198"},"title":"Detaches KB tags from a document.","icon":"","type":"endpoint","slug":"post_v3alpha-knowledge-base-docs-documentid-tags-detach","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v3alpha-knowledge-base-docs-documentid-tags-detach","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa187","createdAt":"2023-10-20T11:02:33.310Z","parentDoc":"6659cc0ab80ec2004f1aa227","isBodyEmpty":false,"children":[]}]}]},{"_id":"6659cc0ab80ec2004f1aa181","title":"Project API","slug":"project-api","order":5,"reference":true,"project":"61f2f6237da66107c6124fbe","version":"6659cc0ab80ec2004f1aa284","createdAt":"2022-04-14T15:44:38.250Z","__v":0,"pages":[{"_id":"6659cc0ab80ec2004f1aa202","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"6659cc0ab80ec2004f1aa192"},"title":"Project API","icon":"","type":"basic","slug":"project-api","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Project API","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa181","createdAt":"2023-06-06T18:56:00.388Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"6659cc0ab80ec2004f1aa1e8","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa192"},"title":"Fetch Project","icon":"","type":"endpoint","slug":"fetchproject","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"fetchProject","link_url":"","link_external":false,"previousSlug":"fetchproject-1","category":"6659cc0ab80ec2004f1aa181","createdAt":"2022-09-27T12:05:14.097Z","parentDoc":"6659cc0ab80ec2004f1aa202","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"6659cc0ab80ec2004f1aa226","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"6659cc0ab80ec2004f1aa193"},"title":"Analytics API Endpoints","icon":"","type":"basic","slug":"api-reference-3","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__API Reference","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa181","createdAt":"2023-09-01T19:29:30.805Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"6659cc0ab80ec2004f1aa22f","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa193"},"title":"Query assistant usage","icon":"","type":"endpoint","slug":"querypubliccontroller_queryusage","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"QueryPublicController_queryUsage","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa181","createdAt":"2023-10-20T17:40:28.932Z","parentDoc":"6659cc0ab80ec2004f1aa226","isBodyEmpty":true,"children":[]}]},{"_id":"6659cc0ab80ec2004f1aa203","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"6659cc0ab80ec2004f1aa192"},"title":"Transcripts API","icon":"","type":"basic","slug":"transcripts-api","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Transcripts API","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa181","createdAt":"2023-06-06T18:56:00.389Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"6659cc0ab80ec2004f1aa204","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa192"},"title":"Fetch Project Transcripts","icon":"","type":"endpoint","slug":"fetchtranscripts","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"fetchTranscripts","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa181","createdAt":"2023-06-06T18:56:00.910Z","parentDoc":"6659cc0ab80ec2004f1aa203","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6659cc0ab80ec2004f1aa205","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa192"},"title":"Check Transcripts Status","icon":"","type":"endpoint","slug":"get_transcripts-projectid-hasunreadtranscripts","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_transcripts-projectid-hasunreadtranscripts","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa181","createdAt":"2023-06-06T18:56:00.911Z","parentDoc":"6659cc0ab80ec2004f1aa203","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6659cc0ab80ec2004f1aa206","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa192"},"title":"Create Transcript","icon":"","type":"endpoint","slug":"put_transcripts","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_transcripts","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa181","createdAt":"2023-06-06T18:56:00.911Z","parentDoc":"6659cc0ab80ec2004f1aa203","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6659cc0ab80ec2004f1aa207","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa192"},"title":"Create Utterance Annotation","icon":"","type":"endpoint","slug":"put_transcripts-projectid-transcriptid-annotation-utteranceaddedto","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_transcripts-projectid-transcriptid-annotation-utteranceaddedto","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa181","createdAt":"2023-06-06T18:56:00.912Z","parentDoc":"6659cc0ab80ec2004f1aa203","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"67b4a1474b4547af5f614413","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa192"},"title":"Get Transcript Data","icon":"","type":"endpoint","slug":"get_transcripts-projectid-transcriptid-data","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_transcripts-projectid-transcriptid-data","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa181","createdAt":"2025-02-18T15:03:35.455Z","parentDoc":"6659cc0ab80ec2004f1aa203","isBodyEmpty":true,"children":[]},{"_id":"6659cc0ab80ec2004f1aa208","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa192"},"title":"Get Transcript Dialog","icon":"","type":"endpoint","slug":"get_transcripts-projectid-transcriptid","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_transcripts-projectid-transcriptid","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa181","createdAt":"2023-06-06T18:56:00.912Z","parentDoc":"6659cc0ab80ec2004f1aa203","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6659cc0ab80ec2004f1aa209","api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa192"},"title":"Update Transcript","icon":"","type":"endpoint","slug":"patch_transcripts-projectid-transcriptid","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patch_transcripts-projectid-transcriptid","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa181","createdAt":"2023-06-06T18:56:00.913Z","parentDoc":"6659cc0ab80ec2004f1aa203","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6659cc0ab80ec2004f1aa20a","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa192"},"title":"Delete Transcript","icon":"","type":"endpoint","slug":"delete_transcripts-projectid-transcriptid","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_transcripts-projectid-transcriptid","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa181","createdAt":"2023-06-06T18:56:00.913Z","parentDoc":"6659cc0ab80ec2004f1aa203","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6659cc0ab80ec2004f1aa20b","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa192"},"title":"Export Transcript Dialog","icon":"","type":"endpoint","slug":"get_transcripts-projectid-transcriptid-export","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_transcripts-projectid-transcriptid-export","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa181","createdAt":"2023-06-06T18:56:00.913Z","parentDoc":"6659cc0ab80ec2004f1aa203","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6659cc0ab80ec2004f1aa20c","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa192"},"title":"Delete Transcript Tag","icon":"","type":"endpoint","slug":"delete_transcripts-projectid-transcriptid-report-tag-reporttagid","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_transcripts-projectid-transcriptid-report-tag-reporttagid","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa181","createdAt":"2023-06-06T18:56:00.914Z","parentDoc":"6659cc0ab80ec2004f1aa203","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6659cc0ab80ec2004f1aa20d","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6659cc0ab80ec2004f1aa192"},"title":"Create Transcript Tag","icon":"","type":"endpoint","slug":"put_transcripts-projectid-transcriptid-report-tag-reporttagid","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_transcripts-projectid-transcriptid-report-tag-reporttagid","link_url":"","link_external":false,"previousSlug":"","category":"6659cc0ab80ec2004f1aa181","createdAt":"2023-06-06T18:56:00.914Z","parentDoc":"6659cc0ab80ec2004f1aa203","mdx":{},"isBodyEmpty":false,"children":[]}]}]}]},"baseUrl":"/","apiBaseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"NTMzODI1YTU1YWVmOTZhNzU4NmM2OWI5MzcwMTY4ZjU4ODFlY2U4MTlkMTllZDhkNGM0ZTVmMmY0YWMyNzY0OXRhZ0ZpbHRlcnM9KHByb2plY3Q6NjFmMmY2MjM3ZGE2NjEwN2M2MTI0ZmJlKSwodmVyc2lvbjpub25lLHZlcnNpb246NjY1OWNjMGFiODBlYzIwMDRmMWFhMjg0KSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2cp","indexName":"readme_search_v2","projectsMeta":[{"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"graphql":false,"changelog":true,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":false},"id":"61f2f6237da66107c6124fbe","name":"Voiceflow","subdomain":"voiceflow-developer","subpath":"","nav_names":{"docs":"","reference":"API Reference","changelog":"Changelog","discuss":"","tutorials":"","recipes":""}}],"UrlManager":{"options":{"child":false,"parent":null,"hasOneChild":false,"project":null,"version":null,"lang":"en"},"defaults":{"lang":"en"}},"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":[]},"project":{"subdomain":"voiceflow-developer"},"version":"2.0"}},"activeDoc":"introduction-to-entities","rdmd":{"baseUrl":"/","body":"In the world of conversational agents, **entities** are the key pieces of information that you want to extract from a user's input. Think of entities as the nouns in a sentence鈥攖he who, what, where, and when that give meaning to the conversation. Whether you're capturing a user's name, booking a date, or retrieving a product code, entities enable your agent to recognize and process this crucial information accurately.\n\nIn Voiceflow, entities serve as placeholders or variables that store specific data collected during a conversation. They make your agent dynamic and responsive, allowing it to handle a wide range of user inputs and ensuring that the conversation flows naturally.\n\n***\n\n## How Entities Work in Voiceflow\n\nWhen a user interacts with your agent, the system listens for specific pieces of information鈥攜our defined entities鈥攁nd uses Large Language Models (LLMs) to extract them from the user's input. Here's how the process works:\n\n1. **Recognition**: The LLM analyzes the user's input to identify the presence of any entities you've specified.\n2. **Extraction and Validation**: The system extracts the relevant data and applies any rules you've set to validate the input.\n3. **Storage**: Validated entities are stored for use later in the conversation, such as personalizing responses or fulfilling requests.\n\nThis LLM-driven approach enhances accuracy and adaptability, allowing your agent to understand user inputs more effectively than traditional methods.\n\n***\n\n> 馃摌 \n> \n> Rules, exit scenarios and automatic reprompt features are included as part of [new AI-powered entity collection](https://docs.voiceflow.com/changelog/ai-entity-collection) feature being rolled out to users. \n\n## Entity Extraction Rules: Fine-Tuning Data Capture\n\n**Entity Rules** allow you to specify exact criteria that the user's input must meet for the entity to be considered valid. These rules are written in natural language, making them easy to create and understand.\n\n### Why Use Entity Rules?\n\n- **Precision**: Define specific formats or content requirements.\n- **Validation**: Ensure data integrity by accepting only valid inputs.\n- **Guidance**: Help the LLM accurately interpret user responses.\n\n### How to Set Entity Rules\n\n**Navigate to Your Entity**: In the Entity CMS, select the entity you want to configure.\n\n- **Add a Rule**: Write a natural language statement that describes the validation criteria.\n\n### Examples of Good Entity Capture Rules\n\n- **Zip Code**: \"Must be exactly 5 digits long.\"\n- **Email Address**: \"Must be a valid business email, not a personal email like Gmail or Yahoo.\"\n- **Phone Number**: \"Should be a 10-digit number, possibly formatted with dashes or spaces.\"\n- **Order Number**: \"Must start with 'ORD' followed by 7 digits.\"\n\n### Best Practices for Entity Rules\n\n1. **Be Specific but User-Friendly**: Clearly define what you need without making it hard for the user to comply.\n2. **Use Natural Language**: Write rules as you would explain them to a person.\n3. **Avoid Overcomplication**: Don't add unnecessary complexity that could confuse the LLM or the user.\n\n***\n\n## Automatic Reprompts: Enhancing User Experience\n\n**Automatic Reprompts** are dynamic follow-up messages that the system generates when a user's input doesn't meet the entity's requirements. This feature ensures that the conversation remains fluid and user-friendly.\n\n### How Automatic Reprompts Work\n\n- **Detection**: If the user's input is invalid or incomplete based on your entity rules, the system recognizes this.\n- **Generation**: The LLM crafts a personalized message prompting the user to provide the correct information.\n- **Response**: The user provides the needed input, and the conversation continues smoothly.\n\n### Example of an Automatic Reprompt\n\n- **Scenario**: You're capturing an email address, and the user says, \"It's john at email dot com.\"\n- **Reprompt**: \"It seems there's a typo in the email address. Could you please provide a valid email in the format '[example@domain.com](mailto:example@domain.com)'?\"\n\n### Benefits of Automatic Reprompts\n\n- **Personalization**: Messages are tailored to the specific issue, making them more helpful.\n- **Efficiency**: Reduces the need for manual error handling in your design.\n- **User Satisfaction**: Keeps users engaged by promptly addressing and resolving input issues.\n\n***\n\n## Exit Scenarios: Managing Conversation Flow\n\nSometimes, a user may be unable or unwilling to provide the information you're requesting. **Exit Scenarios** allow your agent to handle such situations gracefully.\n\n### What Are Exit Scenarios?\n\nExit scenarios are predefined conditions under which the system stops attempting to collect a particular entity and moves on in the conversation.\n\n### How to Set Up Exit Scenarios\n\n- **Define Trigger Phrases**: Specify phrases or responses that indicate the user wants to skip or cannot provide the information (e.g., \"I don't know,\" \"I'd rather not say\").\n- **Configure the Exit Path**: Decide where the conversation should go next. This could be:\n - **Main Path**: Proceed as if the entity was captured, perhaps with a default value.\n - **Alternate Path**: Redirect to a different part of the conversation that doesn't require the entity.\n\n### Example of an Exit Scenario\n\n- **Entity**: `PhoneNumber`\n- **Trigger Phrase**: \"I don't have a phone.\"\n- **Exit Action**: The agent replies, \"No problem, we'll proceed without a phone number,\" and continues the conversation.\n\n### Benefits of Using Exit Scenarios\n\n- **Conversation Flow**: Prevents the conversation from stalling due to repeated, unwanted prompts.\n- **Flexibility**: Allows your agent to handle various user behaviors smoothly.\n\n***\n\n## Putting It All Together: A Practical Example\n\nLet's create a scenario to illustrate how entities, types, rules, automatic reprompts, and exit scenarios work together.\n\n### Scenario: Capturing a Delivery Address\n\n**Step 1: Create Entities**\n\n- **`StreetAddress`** (Custom)\n- **`City`** (Custom)\n- **`ZipCode`** (Number)\n\n**Step 2: Apply Entity Rules**\n\n- ** Rule**: \"Should include the street number and name.\"\n- **Rule**: \"Must be exactly 5 digits.\"\n\n**Step 3: Configure Automatic Reprompts**\n\n- If the **`StreetAddress`** is missing or incomplete:\n - **Reprompt**: \"Could you please provide your full street address, including the number and street name?\"\n- If the **`ZipCode`** is invalid:\n - **Reprompt**: \"The zip code should be 5 digits. Could you double-check and provide it again?\"\n\n**Step 4: Set Up Exit Scenarios**\n\n- If the user says, \"I don't feel comfortable sharing my address\":\n - **Exit Scenario**: Reply with \"I understand. Would you like to proceed without scheduling a delivery?\" and redirect the conversation accordingly.\n\n### Conversation Flow Example\n\n1. **Agent**: \"Please provide your delivery address.\"\n2. **User**: \"It's 123 Main.\"\n3. **Agent**: \"Thanks! Could you also include the street name in your address?\"\n4. **User**: \"Oh, sorry. It's 123 Main Street.\"\n5. **Agent**: \"Got it. And your city?\"\n6. **User**: \"Springfield.\"\n7. **Agent**: \"Perfect. Lastly, could you provide your 5-digit zip code?\"\n8. **User**: \"6270.\"\n9. **Agent**: \"It looks like the zip code should be 5 digits. Could you double-check and provide it again?\"\n10. **User**: \"Oops, it's 62704.\"\n11. **Agent**: \"Thank you! Your delivery address is all set.\"\n\n***\n\n## Recommendations and Best Practices\n\n### 1. Prioritize Entity Rules Over Entity Types\n\nWhile assigning an entity type can be helpful, relying on **Entity Rules** gives you more control and precision. Use rules to specify exact formats or criteria, especially for custom entities.\n\n### 2. Use Custom Entities for Flexibility\n\nCustom entities allow you to define exactly what data you want to capture without being constrained by predefined types. This is particularly useful when dealing with unique identifiers or specific formats.\n\n### 3. Write Clear and Concise Rules\n\nEnsure your entity rules are easy to understand for both the LLM and the user. Avoid ambiguity and keep the language straightforward.\n\n### 4. Handle Exit Scenarios Gracefully\n\nPlan for situations where the user can't or won't provide certain information. Use exit scenarios to maintain a positive user experience by adjusting the conversation flow appropriately.","dehydrated":{"toc":"<nav><ul class=\"toc-list\"><li><a class=\"tocHeader\" href=\"#\"><i class=\"icon icon-text-align-left\"></i>Table of Contents</a></li><li class=\"toc-children\"><ul>\n<li>\n<a href=\"#how-entities-work-in-voiceflow\">How Entities Work in Voiceflow</a>\n</li>\n<li>\n<a href=\"#entity-extraction-rules-fine-tuning-data-capture\">Entity Extraction Rules: Fine-Tuning Data Capture</a>\n<ul>\n<li><a href=\"#why-use-entity-rules\">Why Use Entity Rules?</a></li>\n<li><a href=\"#how-to-set-entity-rules\">How to Set Entity Rules</a></li>\n<li><a href=\"#examples-of-good-entity-capture-rules\">Examples of Good Entity Capture Rules</a></li>\n<li><a href=\"#best-practices-for-entity-rules\">Best Practices for Entity Rules</a></li>\n</ul>\n</li>\n<li>\n<a href=\"#automatic-reprompts-enhancing-user-experience\">Automatic Reprompts: Enhancing User Experience</a>\n<ul>\n<li><a href=\"#how-automatic-reprompts-work\">How Automatic Reprompts Work</a></li>\n<li><a href=\"#example-of-an-automatic-reprompt\">Example of an Automatic Reprompt</a></li>\n<li><a href=\"#benefits-of-automatic-reprompts\">Benefits of Automatic Reprompts</a></li>\n</ul>\n</li>\n<li>\n<a href=\"#exit-scenarios-managing-conversation-flow\">Exit Scenarios: Managing Conversation Flow</a>\n<ul>\n<li><a href=\"#what-are-exit-scenarios\">What Are Exit Scenarios?</a></li>\n<li><a href=\"#how-to-set-up-exit-scenarios\">How to Set Up Exit Scenarios</a></li>\n<li><a href=\"#example-of-an-exit-scenario\">Example of an Exit Scenario</a></li>\n<li><a href=\"#benefits-of-using-exit-scenarios\">Benefits of Using Exit Scenarios</a></li>\n</ul>\n</li>\n<li>\n<a href=\"#putting-it-all-together-a-practical-example\">Putting It All Together: A Practical Example</a>\n<ul>\n<li><a href=\"#scenario-capturing-a-delivery-address\">Scenario: Capturing a Delivery Address</a></li>\n<li><a href=\"#conversation-flow-example\">Conversation Flow Example</a></li>\n</ul>\n</li>\n<li>\n<a href=\"#recommendations-and-best-practices\">Recommendations and Best Practices</a>\n<ul>\n<li><a href=\"#1-prioritize-entity-rules-over-entity-types\">1. Prioritize Entity Rules Over Entity Types</a></li>\n<li><a href=\"#2-use-custom-entities-for-flexibility\">2. Use Custom Entities for Flexibility</a></li>\n<li><a href=\"#3-write-clear-and-concise-rules\">3. Write Clear and Concise Rules</a></li>\n<li><a href=\"#4-handle-exit-scenarios-gracefully\">4. Handle Exit Scenarios Gracefully</a></li>\n</ul>\n</li>\n</ul></li></ul></nav>","body":"<p>In the world of conversational agents, <strong>entities</strong> are the key pieces of information that you want to extract from a user&#x27;s input. Think of entities as the nouns in a sentence鈥攖he who, what, where, and when that give meaning to the conversation. Whether you&#x27;re capturing a user&#x27;s name, booking a date, or retrieving a product code, entities enable your agent to recognize and process this crucial information accurately.</p>\n<p>In Voiceflow, entities serve as placeholders or variables that store specific data collected during a conversation. They make your agent dynamic and responsive, allowing it to handle a wide range of user inputs and ensuring that the conversation flows naturally.</p>\n<hr/>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"how-entities-work-in-voiceflow\"></div><div class=\"heading-text\"><div id=\"section-how-entities-work-in-voiceflow\" class=\"heading-anchor_backwardsCompatibility\"></div>How Entities Work in Voiceflow</div><a aria-label=\"Skip link to How Entities Work in Voiceflow\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#how-entities-work-in-voiceflow\"></a></h2>\n<p>When a user interacts with your agent, the system listens for specific pieces of information鈥攜our defined entities鈥攁nd uses Large Language Models (LLMs) to extract them from the user&#x27;s input. Here&#x27;s how the process works:</p>\n<ol>\n<li><strong>Recognition</strong>: The LLM analyzes the user&#x27;s input to identify the presence of any entities you&#x27;ve specified.</li>\n<li><strong>Extraction and Validation</strong>: The system extracts the relevant data and applies any rules you&#x27;ve set to validate the input.</li>\n<li><strong>Storage</strong>: Validated entities are stored for use later in the conversation, such as personalizing responses or fulfilling requests.</li>\n</ol>\n<p>This LLM-driven approach enhances accuracy and adaptability, allowing your agent to understand user inputs more effectively than traditional methods.</p>\n<hr/>\n<blockquote class=\"callout callout_info\" theme=\"馃摌\"><h2 class=\"callout-heading empty\"><span class=\"callout-icon\">馃摌</span></h2><p>Rules, exit scenarios and automatic reprompt features are included as part of <a href=\"https://docs.voiceflow.com/changelog/ai-entity-collection\" target=\"\" title=\"\">new AI-powered entity collection</a> feature being rolled out to users.</p></blockquote>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"entity-extraction-rules-fine-tuning-data-capture\"></div><div class=\"heading-text\"><div id=\"section-entity-extraction-rules-fine-tuning-data-capture\" class=\"heading-anchor_backwardsCompatibility\"></div>Entity Extraction Rules: Fine-Tuning Data Capture</div><a aria-label=\"Skip link to Entity Extraction Rules: Fine-Tuning Data Capture\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#entity-extraction-rules-fine-tuning-data-capture\"></a></h2>\n<p><strong>Entity Rules</strong> allow you to specify exact criteria that the user&#x27;s input must meet for the entity to be considered valid. These rules are written in natural language, making them easy to create and understand.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"why-use-entity-rules\"></div><div class=\"heading-text\"><div id=\"section-why-use-entity-rules\" class=\"heading-anchor_backwardsCompatibility\"></div>Why Use Entity Rules?</div><a aria-label=\"Skip link to Why Use Entity Rules?\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#why-use-entity-rules\"></a></h3>\n<ul>\n<li><strong>Precision</strong>: Define specific formats or content requirements.</li>\n<li><strong>Validation</strong>: Ensure data integrity by accepting only valid inputs.</li>\n<li><strong>Guidance</strong>: Help the LLM accurately interpret user responses.</li>\n</ul>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"how-to-set-entity-rules\"></div><div class=\"heading-text\"><div id=\"section-how-to-set-entity-rules\" class=\"heading-anchor_backwardsCompatibility\"></div>How to Set Entity Rules</div><a aria-label=\"Skip link to How to Set Entity Rules\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#how-to-set-entity-rules\"></a></h3>\n<p><strong>Navigate to Your Entity</strong>: In the Entity CMS, select the entity you want to configure.</p>\n<ul>\n<li><strong>Add a Rule</strong>: Write a natural language statement that describes the validation criteria.</li>\n</ul>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"examples-of-good-entity-capture-rules\"></div><div class=\"heading-text\"><div id=\"section-examples-of-good-entity-capture-rules\" class=\"heading-anchor_backwardsCompatibility\"></div>Examples of Good Entity Capture Rules</div><a aria-label=\"Skip link to Examples of Good Entity Capture Rules\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#examples-of-good-entity-capture-rules\"></a></h3>\n<ul>\n<li><strong>Zip Code</strong>: &quot;Must be exactly 5 digits long.&quot;</li>\n<li><strong>Email Address</strong>: &quot;Must be a valid business email, not a personal email like Gmail or Yahoo.&quot;</li>\n<li><strong>Phone Number</strong>: &quot;Should be a 10-digit number, possibly formatted with dashes or spaces.&quot;</li>\n<li><strong>Order Number</strong>: &quot;Must start with &#x27;ORD&#x27; followed by 7 digits.&quot;</li>\n</ul>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"best-practices-for-entity-rules\"></div><div class=\"heading-text\"><div id=\"section-best-practices-for-entity-rules\" class=\"heading-anchor_backwardsCompatibility\"></div>Best Practices for Entity Rules</div><a aria-label=\"Skip link to Best Practices for Entity Rules\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#best-practices-for-entity-rules\"></a></h3>\n<ol>\n<li><strong>Be Specific but User-Friendly</strong>: Clearly define what you need without making it hard for the user to comply.</li>\n<li><strong>Use Natural Language</strong>: Write rules as you would explain them to a person.</li>\n<li><strong>Avoid Overcomplication</strong>: Don&#x27;t add unnecessary complexity that could confuse the LLM or the user.</li>\n</ol>\n<hr/>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"automatic-reprompts-enhancing-user-experience\"></div><div class=\"heading-text\"><div id=\"section-automatic-reprompts-enhancing-user-experience\" class=\"heading-anchor_backwardsCompatibility\"></div>Automatic Reprompts: Enhancing User Experience</div><a aria-label=\"Skip link to Automatic Reprompts: Enhancing User Experience\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#automatic-reprompts-enhancing-user-experience\"></a></h2>\n<p><strong>Automatic Reprompts</strong> are dynamic follow-up messages that the system generates when a user&#x27;s input doesn&#x27;t meet the entity&#x27;s requirements. This feature ensures that the conversation remains fluid and user-friendly.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"how-automatic-reprompts-work\"></div><div class=\"heading-text\"><div id=\"section-how-automatic-reprompts-work\" class=\"heading-anchor_backwardsCompatibility\"></div>How Automatic Reprompts Work</div><a aria-label=\"Skip link to How Automatic Reprompts Work\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#how-automatic-reprompts-work\"></a></h3>\n<ul>\n<li><strong>Detection</strong>: If the user&#x27;s input is invalid or incomplete based on your entity rules, the system recognizes this.</li>\n<li><strong>Generation</strong>: The LLM crafts a personalized message prompting the user to provide the correct information.</li>\n<li><strong>Response</strong>: The user provides the needed input, and the conversation continues smoothly.</li>\n</ul>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"example-of-an-automatic-reprompt\"></div><div class=\"heading-text\"><div id=\"section-example-of-an-automatic-reprompt\" class=\"heading-anchor_backwardsCompatibility\"></div>Example of an Automatic Reprompt</div><a aria-label=\"Skip link to Example of an Automatic Reprompt\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#example-of-an-automatic-reprompt\"></a></h3>\n<ul>\n<li><strong>Scenario</strong>: You&#x27;re capturing an email address, and the user says, &quot;It&#x27;s john at email dot com.&quot;</li>\n<li><strong>Reprompt</strong>: &quot;It seems there&#x27;s a typo in the email address. Could you please provide a valid email in the format &#x27;<a href=\"mailto:example@domain.com\" target=\"\" title=\"\">example@domain.com</a>&#x27;?&quot;</li>\n</ul>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"benefits-of-automatic-reprompts\"></div><div class=\"heading-text\"><div id=\"section-benefits-of-automatic-reprompts\" class=\"heading-anchor_backwardsCompatibility\"></div>Benefits of Automatic Reprompts</div><a aria-label=\"Skip link to Benefits of Automatic Reprompts\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#benefits-of-automatic-reprompts\"></a></h3>\n<ul>\n<li><strong>Personalization</strong>: Messages are tailored to the specific issue, making them more helpful.</li>\n<li><strong>Efficiency</strong>: Reduces the need for manual error handling in your design.</li>\n<li><strong>User Satisfaction</strong>: Keeps users engaged by promptly addressing and resolving input issues.</li>\n</ul>\n<hr/>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"exit-scenarios-managing-conversation-flow\"></div><div class=\"heading-text\"><div id=\"section-exit-scenarios-managing-conversation-flow\" class=\"heading-anchor_backwardsCompatibility\"></div>Exit Scenarios: Managing Conversation Flow</div><a aria-label=\"Skip link to Exit Scenarios: Managing Conversation Flow\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#exit-scenarios-managing-conversation-flow\"></a></h2>\n<p>Sometimes, a user may be unable or unwilling to provide the information you&#x27;re requesting. <strong>Exit Scenarios</strong> allow your agent to handle such situations gracefully.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"what-are-exit-scenarios\"></div><div class=\"heading-text\"><div id=\"section-what-are-exit-scenarios\" class=\"heading-anchor_backwardsCompatibility\"></div>What Are Exit Scenarios?</div><a aria-label=\"Skip link to What Are Exit Scenarios?\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#what-are-exit-scenarios\"></a></h3>\n<p>Exit scenarios are predefined conditions under which the system stops attempting to collect a particular entity and moves on in the conversation.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"how-to-set-up-exit-scenarios\"></div><div class=\"heading-text\"><div id=\"section-how-to-set-up-exit-scenarios\" class=\"heading-anchor_backwardsCompatibility\"></div>How to Set Up Exit Scenarios</div><a aria-label=\"Skip link to How to Set Up Exit Scenarios\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#how-to-set-up-exit-scenarios\"></a></h3>\n<ul>\n<li><strong>Define Trigger Phrases</strong>: Specify phrases or responses that indicate the user wants to skip or cannot provide the information (e.g., &quot;I don&#x27;t know,&quot; &quot;I&#x27;d rather not say&quot;).</li>\n<li><strong>Configure the Exit Path</strong>: Decide where the conversation should go next. This could be:\n<ul>\n<li><strong>Main Path</strong>: Proceed as if the entity was captured, perhaps with a default value.</li>\n<li><strong>Alternate Path</strong>: Redirect to a different part of the conversation that doesn&#x27;t require the entity.</li>\n</ul>\n</li>\n</ul>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"example-of-an-exit-scenario\"></div><div class=\"heading-text\"><div id=\"section-example-of-an-exit-scenario\" class=\"heading-anchor_backwardsCompatibility\"></div>Example of an Exit Scenario</div><a aria-label=\"Skip link to Example of an Exit Scenario\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#example-of-an-exit-scenario\"></a></h3>\n<ul>\n<li><strong>Entity</strong>: <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">PhoneNumber</code></li>\n<li><strong>Trigger Phrase</strong>: &quot;I don&#x27;t have a phone.&quot;</li>\n<li><strong>Exit Action</strong>: The agent replies, &quot;No problem, we&#x27;ll proceed without a phone number,&quot; and continues the conversation.</li>\n</ul>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"benefits-of-using-exit-scenarios\"></div><div class=\"heading-text\"><div id=\"section-benefits-of-using-exit-scenarios\" class=\"heading-anchor_backwardsCompatibility\"></div>Benefits of Using Exit Scenarios</div><a aria-label=\"Skip link to Benefits of Using Exit Scenarios\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#benefits-of-using-exit-scenarios\"></a></h3>\n<ul>\n<li><strong>Conversation Flow</strong>: Prevents the conversation from stalling due to repeated, unwanted prompts.</li>\n<li><strong>Flexibility</strong>: Allows your agent to handle various user behaviors smoothly.</li>\n</ul>\n<hr/>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"putting-it-all-together-a-practical-example\"></div><div class=\"heading-text\"><div id=\"section-putting-it-all-together-a-practical-example\" class=\"heading-anchor_backwardsCompatibility\"></div>Putting It All Together: A Practical Example</div><a aria-label=\"Skip link to Putting It All Together: A Practical Example\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#putting-it-all-together-a-practical-example\"></a></h2>\n<p>Let&#x27;s create a scenario to illustrate how entities, types, rules, automatic reprompts, and exit scenarios work together.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"scenario-capturing-a-delivery-address\"></div><div class=\"heading-text\"><div id=\"section-scenario-capturing-a-delivery-address\" class=\"heading-anchor_backwardsCompatibility\"></div>Scenario: Capturing a Delivery Address</div><a aria-label=\"Skip link to Scenario: Capturing a Delivery Address\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#scenario-capturing-a-delivery-address\"></a></h3>\n<p><strong>Step 1: Create Entities</strong></p>\n<ul>\n<li><strong><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">StreetAddress</code></strong> (Custom)</li>\n<li><strong><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">City</code></strong> (Custom)</li>\n<li><strong><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">ZipCode</code></strong> (Number)</li>\n</ul>\n<p><strong>Step 2: Apply Entity Rules</strong></p>\n<ul>\n<li><strong> Rule</strong>: &quot;Should include the street number and name.&quot;</li>\n<li><strong>Rule</strong>: &quot;Must be exactly 5 digits.&quot;</li>\n</ul>\n<p><strong>Step 3: Configure Automatic Reprompts</strong></p>\n<ul>\n<li>If the <strong><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">StreetAddress</code></strong> is missing or incomplete:\n<ul>\n<li><strong>Reprompt</strong>: &quot;Could you please provide your full street address, including the number and street name?&quot;</li>\n</ul>\n</li>\n<li>If the <strong><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">ZipCode</code></strong> is invalid:\n<ul>\n<li><strong>Reprompt</strong>: &quot;The zip code should be 5 digits. Could you double-check and provide it again?&quot;</li>\n</ul>\n</li>\n</ul>\n<p><strong>Step 4: Set Up Exit Scenarios</strong></p>\n<ul>\n<li>If the user says, &quot;I don&#x27;t feel comfortable sharing my address&quot;:\n<ul>\n<li><strong>Exit Scenario</strong>: Reply with &quot;I understand. Would you like to proceed without scheduling a delivery?&quot; and redirect the conversation accordingly.</li>\n</ul>\n</li>\n</ul>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"conversation-flow-example\"></div><div class=\"heading-text\"><div id=\"section-conversation-flow-example\" class=\"heading-anchor_backwardsCompatibility\"></div>Conversation Flow Example</div><a aria-label=\"Skip link to Conversation Flow Example\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#conversation-flow-example\"></a></h3>\n<ol>\n<li><strong>Agent</strong>: &quot;Please provide your delivery address.&quot;</li>\n<li><strong>User</strong>: &quot;It&#x27;s 123 Main.&quot;</li>\n<li><strong>Agent</strong>: &quot;Thanks! Could you also include the street name in your address?&quot;</li>\n<li><strong>User</strong>: &quot;Oh, sorry. It&#x27;s 123 Main Street.&quot;</li>\n<li><strong>Agent</strong>: &quot;Got it. And your city?&quot;</li>\n<li><strong>User</strong>: &quot;Springfield.&quot;</li>\n<li><strong>Agent</strong>: &quot;Perfect. Lastly, could you provide your 5-digit zip code?&quot;</li>\n<li><strong>User</strong>: &quot;6270.&quot;</li>\n<li><strong>Agent</strong>: &quot;It looks like the zip code should be 5 digits. Could you double-check and provide it again?&quot;</li>\n<li><strong>User</strong>: &quot;Oops, it&#x27;s 62704.&quot;</li>\n<li><strong>Agent</strong>: &quot;Thank you! Your delivery address is all set.&quot;</li>\n</ol>\n<hr/>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"recommendations-and-best-practices\"></div><div class=\"heading-text\"><div id=\"section-recommendations-and-best-practices\" class=\"heading-anchor_backwardsCompatibility\"></div>Recommendations and Best Practices</div><a aria-label=\"Skip link to Recommendations and Best Practices\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#recommendations-and-best-practices\"></a></h2>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"1-prioritize-entity-rules-over-entity-types\"></div><div class=\"heading-text\"><div id=\"section-1-prioritize-entity-rules-over-entity-types\" class=\"heading-anchor_backwardsCompatibility\"></div>1. Prioritize Entity Rules Over Entity Types</div><a aria-label=\"Skip link to 1. Prioritize Entity Rules Over Entity Types\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#1-prioritize-entity-rules-over-entity-types\"></a></h3>\n<p>While assigning an entity type can be helpful, relying on <strong>Entity Rules</strong> gives you more control and precision. Use rules to specify exact formats or criteria, especially for custom entities.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"2-use-custom-entities-for-flexibility\"></div><div class=\"heading-text\"><div id=\"section-2-use-custom-entities-for-flexibility\" class=\"heading-anchor_backwardsCompatibility\"></div>2. Use Custom Entities for Flexibility</div><a aria-label=\"Skip link to 2. Use Custom Entities for Flexibility\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#2-use-custom-entities-for-flexibility\"></a></h3>\n<p>Custom entities allow you to define exactly what data you want to capture without being constrained by predefined types. This is particularly useful when dealing with unique identifiers or specific formats.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"3-write-clear-and-concise-rules\"></div><div class=\"heading-text\"><div id=\"section-3-write-clear-and-concise-rules\" class=\"heading-anchor_backwardsCompatibility\"></div>3. Write Clear and Concise Rules</div><a aria-label=\"Skip link to 3. Write Clear and Concise Rules\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#3-write-clear-and-concise-rules\"></a></h3>\n<p>Ensure your entity rules are easy to understand for both the LLM and the user. Avoid ambiguity and keep the language straightforward.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"4-handle-exit-scenarios-gracefully\"></div><div class=\"heading-text\"><div id=\"section-4-handle-exit-scenarios-gracefully\" class=\"heading-anchor_backwardsCompatibility\"></div>4. Handle Exit Scenarios Gracefully</div><a aria-label=\"Skip link to 4. Handle Exit Scenarios Gracefully\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#4-handle-exit-scenarios-gracefully\"></a></h3>\n<p>Plan for situations where the user can&#x27;t or won&#x27;t provide certain information. Use exit scenarios to maintain a positive user experience by adjusting the conversation flow appropriately.</p>"},"opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"normalize":true,"lazyImages":true,"reusableContent":{"tags":{}},"safeMode":false,"settings":{"position":true},"theme":"light","customBlocks":{},"resourceID":"66fae4cee474c4a449963935","resourceType":"page","baseUrl":"/","terms":[{"_id":"655fad103facf3004c288f20","term":"agent","definition":"Refers to one 'project', 'assistant', or 'bot' in your workspace"}],"variables":{"user":{},"defaults":[{"source":"security","_id":"652eaab69e0e88197bcf3b85","name":"authorization","type":"apiKey","apiSetting":"638914e738c0e800aac362b1"},{"source":"security","_id":"6541048b1a4e17099759a54d","name":"Authorization","type":"apiKey","apiSetting":"6202d5d4b858c90049050339"}]}},"terms":[{"_id":"655fad103facf3004c288f20","term":"agent","definition":"Refers to one 'project', 'assistant', or 'bot' in your workspace"}],"variables":{"user":{},"defaults":[{"source":"security","_id":"652eaab69e0e88197bcf3b85","name":"authorization","type":"apiKey","apiSetting":"638914e738c0e800aac362b1"},{"source":"security","_id":"6541048b1a4e17099759a54d","name":"Authorization","type":"apiKey","apiSetting":"6202d5d4b858c90049050339"}]},"mdx":false},"doc":{"metadata":{"image":[],"title":"","description":"","keywords":"","robots":"index"},"mdx":{"altBody":"","status":"rdmd"},"api":{"method":"get","url":"","auth":"required","params":[]},"next":{"description":"","pages":[]},"algolia":{"recordCount":24,"publishPending":false,"translationFailure":false,"updatedAt":"2024-10-01T19:33:38.760Z"},"title":"Introduction to Entities","icon":"","updates":[],"type":"basic","slug":"introduction-to-entities","excerpt":"","body":"In the world of conversational agents, **entities** are the key pieces of information that you want to extract from a user's input. Think of entities as the nouns in a sentence鈥攖he who, what, where, and when that give meaning to the conversation. Whether you're capturing a user's name, booking a date, or retrieving a product code, entities enable your agent to recognize and process this crucial information accurately.\n\nIn Voiceflow, entities serve as placeholders or variables that store specific data collected during a conversation. They make your agent dynamic and responsive, allowing it to handle a wide range of user inputs and ensuring that the conversation flows naturally.\n\n***\n\n## How Entities Work in Voiceflow\n\nWhen a user interacts with your agent, the system listens for specific pieces of information鈥攜our defined entities鈥攁nd uses Large Language Models (LLMs) to extract them from the user's input. Here's how the process works:\n\n1. **Recognition**: The LLM analyzes the user's input to identify the presence of any entities you've specified.\n2. **Extraction and Validation**: The system extracts the relevant data and applies any rules you've set to validate the input.\n3. **Storage**: Validated entities are stored for use later in the conversation, such as personalizing responses or fulfilling requests.\n\nThis LLM-driven approach enhances accuracy and adaptability, allowing your agent to understand user inputs more effectively than traditional methods.\n\n***\n\n> 馃摌 \n> \n> Rules, exit scenarios and automatic reprompt features are included as part of [new AI-powered entity collection](https://docs.voiceflow.com/changelog/ai-entity-collection) feature being rolled out to users. \n\n## Entity Extraction Rules: Fine-Tuning Data Capture\n\n**Entity Rules** allow you to specify exact criteria that the user's input must meet for the entity to be considered valid. These rules are written in natural language, making them easy to create and understand.\n\n### Why Use Entity Rules?\n\n- **Precision**: Define specific formats or content requirements.\n- **Validation**: Ensure data integrity by accepting only valid inputs.\n- **Guidance**: Help the LLM accurately interpret user responses.\n\n### How to Set Entity Rules\n\n**Navigate to Your Entity**: In the Entity CMS, select the entity you want to configure.\n\n- **Add a Rule**: Write a natural language statement that describes the validation criteria.\n\n### Examples of Good Entity Capture Rules\n\n- **Zip Code**: \"Must be exactly 5 digits long.\"\n- **Email Address**: \"Must be a valid business email, not a personal email like Gmail or Yahoo.\"\n- **Phone Number**: \"Should be a 10-digit number, possibly formatted with dashes or spaces.\"\n- **Order Number**: \"Must start with 'ORD' followed by 7 digits.\"\n\n### Best Practices for Entity Rules\n\n1. **Be Specific but User-Friendly**: Clearly define what you need without making it hard for the user to comply.\n2. **Use Natural Language**: Write rules as you would explain them to a person.\n3. **Avoid Overcomplication**: Don't add unnecessary complexity that could confuse the LLM or the user.\n\n***\n\n## Automatic Reprompts: Enhancing User Experience\n\n**Automatic Reprompts** are dynamic follow-up messages that the system generates when a user's input doesn't meet the entity's requirements. This feature ensures that the conversation remains fluid and user-friendly.\n\n### How Automatic Reprompts Work\n\n- **Detection**: If the user's input is invalid or incomplete based on your entity rules, the system recognizes this.\n- **Generation**: The LLM crafts a personalized message prompting the user to provide the correct information.\n- **Response**: The user provides the needed input, and the conversation continues smoothly.\n\n### Example of an Automatic Reprompt\n\n- **Scenario**: You're capturing an email address, and the user says, \"It's john at email dot com.\"\n- **Reprompt**: \"It seems there's a typo in the email address. Could you please provide a valid email in the format '[example@domain.com](mailto:example@domain.com)'?\"\n\n### Benefits of Automatic Reprompts\n\n- **Personalization**: Messages are tailored to the specific issue, making them more helpful.\n- **Efficiency**: Reduces the need for manual error handling in your design.\n- **User Satisfaction**: Keeps users engaged by promptly addressing and resolving input issues.\n\n***\n\n## Exit Scenarios: Managing Conversation Flow\n\nSometimes, a user may be unable or unwilling to provide the information you're requesting. **Exit Scenarios** allow your agent to handle such situations gracefully.\n\n### What Are Exit Scenarios?\n\nExit scenarios are predefined conditions under which the system stops attempting to collect a particular entity and moves on in the conversation.\n\n### How to Set Up Exit Scenarios\n\n- **Define Trigger Phrases**: Specify phrases or responses that indicate the user wants to skip or cannot provide the information (e.g., \"I don't know,\" \"I'd rather not say\").\n- **Configure the Exit Path**: Decide where the conversation should go next. This could be:\n - **Main Path**: Proceed as if the entity was captured, perhaps with a default value.\n - **Alternate Path**: Redirect to a different part of the conversation that doesn't require the entity.\n\n### Example of an Exit Scenario\n\n- **Entity**: `PhoneNumber`\n- **Trigger Phrase**: \"I don't have a phone.\"\n- **Exit Action**: The agent replies, \"No problem, we'll proceed without a phone number,\" and continues the conversation.\n\n### Benefits of Using Exit Scenarios\n\n- **Conversation Flow**: Prevents the conversation from stalling due to repeated, unwanted prompts.\n- **Flexibility**: Allows your agent to handle various user behaviors smoothly.\n\n***\n\n## Putting It All Together: A Practical Example\n\nLet's create a scenario to illustrate how entities, types, rules, automatic reprompts, and exit scenarios work together.\n\n### Scenario: Capturing a Delivery Address\n\n**Step 1: Create Entities**\n\n- **`StreetAddress`** (Custom)\n- **`City`** (Custom)\n- **`ZipCode`** (Number)\n\n**Step 2: Apply Entity Rules**\n\n- ** Rule**: \"Should include the street number and name.\"\n- **Rule**: \"Must be exactly 5 digits.\"\n\n**Step 3: Configure Automatic Reprompts**\n\n- If the **`StreetAddress`** is missing or incomplete:\n - **Reprompt**: \"Could you please provide your full street address, including the number and street name?\"\n- If the **`ZipCode`** is invalid:\n - **Reprompt**: \"The zip code should be 5 digits. Could you double-check and provide it again?\"\n\n**Step 4: Set Up Exit Scenarios**\n\n- If the user says, \"I don't feel comfortable sharing my address\":\n - **Exit Scenario**: Reply with \"I understand. Would you like to proceed without scheduling a delivery?\" and redirect the conversation accordingly.\n\n### Conversation Flow Example\n\n1. **Agent**: \"Please provide your delivery address.\"\n2. **User**: \"It's 123 Main.\"\n3. **Agent**: \"Thanks! Could you also include the street name in your address?\"\n4. **User**: \"Oh, sorry. It's 123 Main Street.\"\n5. **Agent**: \"Got it. And your city?\"\n6. **User**: \"Springfield.\"\n7. **Agent**: \"Perfect. Lastly, could you provide your 5-digit zip code?\"\n8. **User**: \"6270.\"\n9. **Agent**: \"It looks like the zip code should be 5 digits. Could you double-check and provide it again?\"\n10. **User**: \"Oops, it's 62704.\"\n11. **Agent**: \"Thank you! Your delivery address is all set.\"\n\n***\n\n## Recommendations and Best Practices\n\n### 1. Prioritize Entity Rules Over Entity Types\n\nWhile assigning an entity type can be helpful, relying on **Entity Rules** gives you more control and precision. Use rules to specify exact formats or criteria, especially for custom entities.\n\n### 2. Use Custom Entities for Flexibility\n\nCustom entities allow you to define exactly what data you want to capture without being constrained by predefined types. This is particularly useful when dealing with unique identifiers or specific formats.\n\n### 3. Write Clear and Concise Rules\n\nEnsure your entity rules are easy to understand for both the LLM and the user. Avoid ambiguity and keep the language straightforward.\n\n### 4. Handle Exit Scenarios Gracefully\n\nPlan for situations where the user can't or won't provide certain information. Use exit scenarios to maintain a positive user experience by adjusting the conversation flow appropriately.","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"reusableContent":[],"previousSlug":"","slugUpdatedAt":"2024-09-30T01:06:30.282Z","revision":13,"_id":"66fae4cee474c4a449963935","user":"61f2f6029da79900713a151a","project":"61f2f6237da66107c6124fbe","parentDoc":"66f5c4766aafa40012990662","category":{"title":"Building Agents","slug":"agent-building","order":2,"reference":false,"_id":"6659cc0ab80ec2004f1aa190","project":"61f2f6237da66107c6124fbe","version":"6659cc0ab80ec2004f1aa284","createdAt":"2024-05-12T00:55:22.223Z","__v":0,"type":"guide","id":"6659cc0ab80ec2004f1aa190"},"createdAt":"2024-09-30T17:50:06.569Z","updatedAt":"2024-10-01T19:33:38.767Z","version":{"version":"2.0","version_clean":"2.0.0","codename":"Unified Docs V2","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61f2f6247da66107c6124fc5","61f2f6247da66107c6124fc5","61f2f6247da66107c6124fcb","61f2f6999da79900713a1545","61f2f70874ef2b0752601f0c","61f2f7377fbd78082f8076ba","61f3061d4b5403002b2e9e72","6659cc0ab80ec2004f1aa17b","6659cc0ab80ec2004f1aa17c","61f727d2ab06cb006a703c87","6659cc0ab80ec2004f1aa17d","61f72867a9238c005bd98078","6659cc0ab80ec2004f1aa17e","6659cc0ab80ec2004f1aa17f","6202d20f67fbe3006243cc8f","6202d2d1b5a9c800248c6176","6659cc0ab80ec2004f1aa180","6202d8e4ee121f0042cd1ae5","6202d9bc054a69001060cc95","6214fe421f9844002ea68d4a","6214ff4839bf05009a5ada80","6215033c25d5340044c10ba4","621cc14e856cc10040f1a34f","625832af2980cb008dd94dac","62583384f1e0c902d4224de8","62583bba0518f40872a8d6d3","62583d332cffb6001454982c","62583dea61c5e801050d5c98","625840ab47f8c403978351d0","6659cc0ab80ec2004f1aa181","6258453bf22e3e026616a23a","625848e7e33427002063920a","6258494261c5e801050d6e12","62b5c43611db8c0013e042d6","62b5cf89a882bb00af6fe674","6659cc0ab80ec2004f1aa182","63fd4a1164ec13002607c246","6306a4928e1562009d162f88","6659cc0ab80ec2004f1aa183","63fd4a1164ec13002607c248","6376bf59127d990003173b41","63fd4a1164ec13002607c249","638914a970b9ad0017194624","63fd4a1164ec13002607c24a","63891b7f618fd1001e9f87b1","63bc99721c609f004caebb5d","63bc9dd887e5a900401bce00","63bc9e7779fca00017dace8f","63bcb03e9f777c0031fb7d0b","63bcb3ccd4cb4e0046b7e317","63bcb65875966000160e9477","63bcb6f8cef48a00268651c6","63bcb98a843cf10035c6aa7e","63bcbf2d46946b00a806cc2f","63bcc02e060bbb00a56f3f1b","63bcc1adfc4ffa0033d1db41","63bcc375739223001e1351f5","63bcd83381dcaf0024a003ce","63bdd69ef975a20026301b53","63fd4a1164ec13002607c24b","63fd4a1164ec13002607c2c1","6659cc0ab80ec2004f1aa184","645046d4fcddec00e2e39e29","655f687fc3b1c2001104512f","646f5f4a5ca88a0057c77e58","6493615a6fbdbf02925084a1","6493616b729d1f030c86f7d0","649453586b434f0f6e06339f","649456feb63d310024c7f106","649457601d95fd0f722d274e","655f687fc3b1c20011045130","64b541ffcb0425000b1dd432","64b54256e3cb50006c944288","64b5456f8de8c30074a36315","64d26aa8ba939c0049d17a1b","64d2b4f2e4a98a004a398ebd","64d39bd6732c31005d35e4a6","64d39e9bfec62b0074bb5402","64d3a4a700ea0d0023a7d528","64d3a9bd515df5001d0f1d6f","64d3ab69ed30b00063048bc5","64d3e00a1521040022602d75","64d3e064c35ad200257b4a17","655f687fc3b1c20011045131","64d3f19e80be73006d797865","64d3f1c4831ce8005c3ac2de","64d3f6fb7f2854004e88e449","64d5041597840318dcdc0f35","64d52c0a4672ee001218dbc2","64da4680bd209a0ba3dee183","64dba326e432d4001e09cb06","64e3fc69bf594200758c3eef","64e4ad167b6027003f2390e1","64e4d2351d078100716f1d17","6659cc0ab80ec2004f1aa185","64eccf56e85983005428b337","651e00b10374a40044aad9ce","651e01be343ebc004534d094","651e021901026a0058d1e512","655f687fc3b1c20011045133","655f687fc3b1c20011045134","65522a0ff040d102a7b4c86d","655233e16aab1900249f287f","655234dd81ac8b02e09b284b","6552355a05c2fc00189e5f49","65524073f2a03e00532557c1","6659cc0ab80ec2004f1aa186","655246248804de00e0b94212","6659cc0ab80ec2004f1aa187","6659cc0ab80ec2004f1aa188","6554c8a65a821d0010b65f4f","6554cac27de17200442ec052","6554cc725cacdc093eb1c0f7","6554cc94e311fe00172b70c3","6659cc0ab80ec2004f1aa189","6659cc0ab80ec2004f1aa18a","6659cc0ab80ec2004f1aa18b","6565ff9a838b51005260ad26","65a6c92c493fc5001cb4d158","65f9bfb405207c00296bd5d0","65fcf9cd32f7c30011155d91","6659cc0ab80ec2004f1aa18c","6659cc0ab80ec2004f1aa18d","66311ced0407170027c6fd1a","663240c79e3a9f003cc7a7f3","663388eb271d62000fc35bf6","6635399056c75d00127ab16c","6659cc0ab80ec2004f1aa18e","6659cc0ab80ec2004f1aa18f","6659cc0ab80ec2004f1aa190","665e23a43018ce002ae55a85","665e31b3803577006a9958c9","665e31bbbe0e2d005c658727","6661f51ba80a54006ae74684","66901894a73ee3002e5b4f71","6690193be167350043819dbf","66d1de5b700490004b9e6e82","66dccbc9cdc97b0042135bce","66df9be5a9931b001ac0fcf8","66f223f6827ec6002b615d7a","66f45f5e6946532ab0423a7a","66f47249a16fb5001fb9a6d6","66f4728385a535001fded04f","66f4748014205c001374d367","66f4850814205c001374e10d","66fef9f54e2d150018d34112","66fefac81e58df00617ba329","66fefd5270490400116f1ca0","66fefe38225d6c000f076480","67243d2d929ff0003ec69b3f","6724f33f6824f50075462fa1","6724f3a025616f00111331af","672bd78955e7ff006dcc43cb","673e3cbaba6622002b76755a","673e40944f9f5c0012f61b00","673e42bdf273c00012395c1a","673e44f0de8021002bf3f82b","673e473002138d00184ee7f5","673e479d219d370055ad8c27","673e496212b6e40054a57b35","673f9533a968890071572ea2","673fd65e89875b00684c1fdc","6744dc5722785d001012cc1d","6744e72ab64acf002fb9a95c","67509409f2071c0018b7fcac","675094680cd0ce003b027577","676075c455689c0032090420","67607f04c5479773a6155f0c"],"pdfStatus":"","_id":"6659cc0ab80ec2004f1aa284","project":"61f2f6237da66107c6124fbe","releaseDate":"2022-01-27T19:44:36.369Z","createdAt":"2024-05-31T13:09:30.461Z","__v":0,"forked_from":"655f687fc3b1c200110451e6","updatedAt":"2024-12-16T19:27:00.318Z"},"lastUpdatedHash":"0536798d12cbd0c3cfc6fdd6095d7048e0e47601","__v":0,"isApi":false,"tutorials":[],"id":"66fae4cee474c4a449963935"},"hideTOC":false,"meta":{"_id":"66fae4cee474c4a449963935","description":"In the world of conversational agents, entities are the key pieces of information that you want to extract from a user's input. Think of entities as the nouns in a sentence鈥攖he who, what, where, and when that give meaning to the conversation. Whether you're capturing a user's name, booking a date, o...","hidden":false,"image":[],"keywords":"","metaTitle":"Introduction to Entities","parent":"66f5c4766aafa40012990662","robots":"index","slug":"introduction-to-entities","title":"Introduction to Entities","type":"docs"},"slugUrl":"/docs/introduction-to-entities","config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.294.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[{"_id":"655fad103facf3004c288f20","term":"agent","definition":"Refers to one 'project', 'assistant', or 'bot' in your workspace"}],"variables":{"user":{},"defaults":[{"source":"security","_id":"652eaab69e0e88197bcf3b85","name":"authorization","type":"apiKey","apiSetting":"638914e738c0e800aac362b1"},{"source":"security","_id":"6541048b1a4e17099759a54d","name":"Authorization","type":"apiKey","apiSetting":"6202d5d4b858c90049050339"}]},"project":{"_id":"61f2f6237da66107c6124fbe","appearance":{"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#1F2428","main_alt":"","header_text":"","body_highlight":"#FFAC2F","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"style":"custom","img":["https://files.readme.io/d5b4013-ASCII_Black_No_Logo.png","d5b4013-ASCII_Black_No_Logo.png",1920,1080,"#000000","665f700dc6021f0011de0e01"],"img_size":"cover","img_pos":"tr"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":""},"referenceSimpleMode":false,"referenceLayout":"row","link_logo_to_url":false,"theme":"solid","overlay":"triangles","landing":true,"sticky":false,"hide_logo":true,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":false,"showMetricsInReference":false,"logo":["https://files.readme.io/d7cb562-small-square-onyx-1024.png","d7cb562-small-square-onyx-1024.png",80,80,"#242c2c","https://files.readme.io/74f5eaf-square-onyx-1024.png","668fec65df60bc000f3f6696"],"logo_white":["https://files.readme.io/edd48a8-Voiceflow-wordmark-light.svg","edd48a8-Voiceflow-wordmark-light.svg",218,40,"#000000","65f98dc8f015400060e42354"],"logo_white_use":true,"favicon":["https://files.readme.io/6f6abbe-round-proto-1024.ico","6f6abbe-round-proto-1024.ico",256,256,"#000000","65f9849580c10f0012e3e449"],"stylesheet":"","stylesheet_hub2":"","stylesheet_hub3":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"","html_footer_meta":"","html_hidelinks":false,"showVersion":false,"hideTableOfContents":false,"nextStepsLabel":"","promos":[{"extras":{"type":"buttons","buttonPrimary":"get-started","buttonSecondary":"reference"},"title":"The Voiceflow Developer Hub","text":"Welcome to the Voiceflow developer hub. You'll find comprehensive guides and documentation to help you start working with Voiceflow as quickly as possible, as well as support if you get stuck. Let's jump right in!","_id":"61f2f6237da66107c6124fc0"}],"loginLogo":[],"logo_large":false,"colorScheme":"system","changelog":{"layoutExpanded":true,"showAuthor":true,"showExactDate":true},"allowApiExplorerJsonEditor":false},"custom_domain":"docs.voiceflow.com","childrenProjects":[],"derivedPlan":"startup2018","description":"Voiceflow developer and user documentation.","error404":"","experiments":[],"first_page":"docs","flags":{"allow_hub2":false,"enterprise":false,"alwaysShowDocPublishStatus":false,"hub2":true,"migrationRun":false,"migrationSwaggerRun":false,"oauth":false,"swagger":false,"correctnewlines":false,"rdmdCompatibilityMode":false,"speedyRender":false,"allowXFrame":false,"newEditor":true,"newEditorDash":true,"oldMarkdown":false,"newMarkdownBetaProgram":true,"useReactApp":true,"disableAnonForum":false,"directGoogleToStableVersion":false,"translation":false,"staging":false,"newSearch":true,"graphql":false,"allowApiExplorerJsonEditor":false,"singleProjectEnterprise":false,"dashReact":false,"metricsV2":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":false,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":false,"superHub":false,"allowReusableOTPs":false,"dashHomeRefresh":false,"developerDashboard":false,"owlbotAi":false,"apiV2":false,"dashQuickstart":false,"git":{"read":false,"write":false},"superHubBeta":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":false,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":false,"superHubMigrationSelfServeFlow":true,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":false,"gitSidebar":false},"fullBaseUrl":"https://docs.voiceflow.com/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"connectedRepository":{"organization":{},"privacy":{}},"installationRequest":{},"github":[]}},"glossaryTerms":[{"_id":"655fad103facf3004c288f20","term":"agent","definition":"Refers to one 'project', 'assistant', or 'bot' in your workspace"}],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"docs","alignment":"left","pageType":"Documentation"}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"planLimit":2000000,"thumbsEnabled":true,"usageLastChecked":"2022-02-10T14:57:47.369Z","realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"graphql":false,"changelog":true,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":false},"name":"Voiceflow","nav_names":{"docs":"","reference":"API Reference","changelog":"Changelog","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":false,"api":true,"logs":true,"domain":true,"metricsSDK":false},"owlbot":{"enabled":true,"isPaying":true,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""},"lastIndexed":"2025-03-03T05:47:30.328Z"},"owner":{"id":null,"email":null,"name":null},"plan":"startup2018","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"startup2018","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":true,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":true,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":true,"points":2}},"totalScore":174},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":true,"defaultExpandResponseSchema":true,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":true},"stable":{"_id":"6659cc0ab80ec2004f1aa284","version":"2.0","version_clean":"2.0.0","codename":"Unified Docs V2","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61f2f6247da66107c6124fc5","61f2f6247da66107c6124fc5","61f2f6247da66107c6124fcb","61f2f6999da79900713a1545","61f2f70874ef2b0752601f0c","61f2f7377fbd78082f8076ba","61f3061d4b5403002b2e9e72","6659cc0ab80ec2004f1aa17b","6659cc0ab80ec2004f1aa17c","61f727d2ab06cb006a703c87","6659cc0ab80ec2004f1aa17d","61f72867a9238c005bd98078","6659cc0ab80ec2004f1aa17e","6659cc0ab80ec2004f1aa17f","6202d20f67fbe3006243cc8f","6202d2d1b5a9c800248c6176","6659cc0ab80ec2004f1aa180","6202d8e4ee121f0042cd1ae5","6202d9bc054a69001060cc95","6214fe421f9844002ea68d4a","6214ff4839bf05009a5ada80","6215033c25d5340044c10ba4","621cc14e856cc10040f1a34f","625832af2980cb008dd94dac","62583384f1e0c902d4224de8","62583bba0518f40872a8d6d3","62583d332cffb6001454982c","62583dea61c5e801050d5c98","625840ab47f8c403978351d0","6659cc0ab80ec2004f1aa181","6258453bf22e3e026616a23a","625848e7e33427002063920a","6258494261c5e801050d6e12","62b5c43611db8c0013e042d6","62b5cf89a882bb00af6fe674","6659cc0ab80ec2004f1aa182","63fd4a1164ec13002607c246","6306a4928e1562009d162f88","6659cc0ab80ec2004f1aa183","63fd4a1164ec13002607c248","6376bf59127d990003173b41","63fd4a1164ec13002607c249","638914a970b9ad0017194624","63fd4a1164ec13002607c24a","63891b7f618fd1001e9f87b1","63bc99721c609f004caebb5d","63bc9dd887e5a900401bce00","63bc9e7779fca00017dace8f","63bcb03e9f777c0031fb7d0b","63bcb3ccd4cb4e0046b7e317","63bcb65875966000160e9477","63bcb6f8cef48a00268651c6","63bcb98a843cf10035c6aa7e","63bcbf2d46946b00a806cc2f","63bcc02e060bbb00a56f3f1b","63bcc1adfc4ffa0033d1db41","63bcc375739223001e1351f5","63bcd83381dcaf0024a003ce","63bdd69ef975a20026301b53","63fd4a1164ec13002607c24b","63fd4a1164ec13002607c2c1","6659cc0ab80ec2004f1aa184","645046d4fcddec00e2e39e29","655f687fc3b1c2001104512f","646f5f4a5ca88a0057c77e58","6493615a6fbdbf02925084a1","6493616b729d1f030c86f7d0","649453586b434f0f6e06339f","649456feb63d310024c7f106","649457601d95fd0f722d274e","655f687fc3b1c20011045130","64b541ffcb0425000b1dd432","64b54256e3cb50006c944288","64b5456f8de8c30074a36315","64d26aa8ba939c0049d17a1b","64d2b4f2e4a98a004a398ebd","64d39bd6732c31005d35e4a6","64d39e9bfec62b0074bb5402","64d3a4a700ea0d0023a7d528","64d3a9bd515df5001d0f1d6f","64d3ab69ed30b00063048bc5","64d3e00a1521040022602d75","64d3e064c35ad200257b4a17","655f687fc3b1c20011045131","64d3f19e80be73006d797865","64d3f1c4831ce8005c3ac2de","64d3f6fb7f2854004e88e449","64d5041597840318dcdc0f35","64d52c0a4672ee001218dbc2","64da4680bd209a0ba3dee183","64dba326e432d4001e09cb06","64e3fc69bf594200758c3eef","64e4ad167b6027003f2390e1","64e4d2351d078100716f1d17","6659cc0ab80ec2004f1aa185","64eccf56e85983005428b337","651e00b10374a40044aad9ce","651e01be343ebc004534d094","651e021901026a0058d1e512","655f687fc3b1c20011045133","655f687fc3b1c20011045134","65522a0ff040d102a7b4c86d","655233e16aab1900249f287f","655234dd81ac8b02e09b284b","6552355a05c2fc00189e5f49","65524073f2a03e00532557c1","6659cc0ab80ec2004f1aa186","655246248804de00e0b94212","6659cc0ab80ec2004f1aa187","6659cc0ab80ec2004f1aa188","6554c8a65a821d0010b65f4f","6554cac27de17200442ec052","6554cc725cacdc093eb1c0f7","6554cc94e311fe00172b70c3","6659cc0ab80ec2004f1aa189","6659cc0ab80ec2004f1aa18a","6659cc0ab80ec2004f1aa18b","6565ff9a838b51005260ad26","65a6c92c493fc5001cb4d158","65f9bfb405207c00296bd5d0","65fcf9cd32f7c30011155d91","6659cc0ab80ec2004f1aa18c","6659cc0ab80ec2004f1aa18d","66311ced0407170027c6fd1a","663240c79e3a9f003cc7a7f3","663388eb271d62000fc35bf6","6635399056c75d00127ab16c","6659cc0ab80ec2004f1aa18e","6659cc0ab80ec2004f1aa18f","6659cc0ab80ec2004f1aa190","665e23a43018ce002ae55a85","665e31b3803577006a9958c9","665e31bbbe0e2d005c658727","6661f51ba80a54006ae74684","66901894a73ee3002e5b4f71","6690193be167350043819dbf","66d1de5b700490004b9e6e82","66dccbc9cdc97b0042135bce","66df9be5a9931b001ac0fcf8","66f223f6827ec6002b615d7a","66f45f5e6946532ab0423a7a","66f47249a16fb5001fb9a6d6","66f4728385a535001fded04f","66f4748014205c001374d367","66f4850814205c001374e10d","66fef9f54e2d150018d34112","66fefac81e58df00617ba329","66fefd5270490400116f1ca0","66fefe38225d6c000f076480","67243d2d929ff0003ec69b3f","6724f33f6824f50075462fa1","6724f3a025616f00111331af","672bd78955e7ff006dcc43cb","673e3cbaba6622002b76755a","673e40944f9f5c0012f61b00","673e42bdf273c00012395c1a","673e44f0de8021002bf3f82b","673e473002138d00184ee7f5","673e479d219d370055ad8c27","673e496212b6e40054a57b35","673f9533a968890071572ea2","673fd65e89875b00684c1fdc","6744dc5722785d001012cc1d","6744e72ab64acf002fb9a95c","67509409f2071c0018b7fcac","675094680cd0ce003b027577","676075c455689c0032090420","67607f04c5479773a6155f0c"],"project":"61f2f6237da66107c6124fbe","releaseDate":"2022-01-27T19:44:36.369Z","createdAt":"2024-05-31T13:09:30.461Z","__v":0,"forked_from":"655f687fc3b1c200110451e6","updatedAt":"2024-12-16T19:27:00.318Z"},"subdomain":"voiceflow-developer","subpath":"","superHubWaitlist":true,"topnav":{"left":[],"right":[{"type":"url","text":"Join Discord","url":"https://link.voiceflow.com/community"},{"type":"url","page":"video-tutorials","text":"Trust Center","url":"https://trust.voiceflow.com/"}],"bottom":[],"edited":true},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2024-09-09T14:49:51.761Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://www.voiceflow.com/","versions":[{"_id":"61f2f6247da66107c6124fc3","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":false,"categories":["61f2f6247da66107c6124fc5","61f2f6247da66107c6124fc5","61f2f6247da66107c6124fcb","61f2f6999da79900713a1545","61f2f70874ef2b0752601f0c","61f2f7377fbd78082f8076ba","61f3061d4b5403002b2e9e72","61f3098e30fa7a001073ac36","61f3136236d63e001f90be51","61f727d2ab06cb006a703c87","61f7281833d2ec005c23ab19","61f72867a9238c005bd98078","61f732cdd5cd52000fb8caac","61fc130827ec8e0055004484","6202d20f67fbe3006243cc8f","6202d2d1b5a9c800248c6176","6202d5d4b858c9004905033a","6202d8e4ee121f0042cd1ae5","6202d9bc054a69001060cc95","6214fe421f9844002ea68d4a","6214ff4839bf05009a5ada80","6215033c25d5340044c10ba4","621cc14e856cc10040f1a34f","625832af2980cb008dd94dac","62583384f1e0c902d4224de8","62583bba0518f40872a8d6d3","62583d332cffb6001454982c","62583dea61c5e801050d5c98","625840ab47f8c403978351d0","62584166e9eb0d03e6864da7","6258453bf22e3e026616a23a","625848e7e33427002063920a","6258494261c5e801050d6e12","62b5c43611db8c0013e042d6","62b5cf89a882bb00af6fe674","62ce1c47260739003db0806c","62fcf62b5fd4030043ebe8b9","6306a4928e1562009d162f88","63112cd6e55b1c0043a57e40","6334486167a8ec006c1b8502","6376bf59127d990003173b41","6388d3d70814840044725209","638914a970b9ad0017194624","638914e738c0e800aac362b2","63891b7f618fd1001e9f87b1","63bc99721c609f004caebb5d","63bc9dd887e5a900401bce00","63bc9e7779fca00017dace8f","63bcb03e9f777c0031fb7d0b","63bcb3ccd4cb4e0046b7e317","63bcb65875966000160e9477","63bcb6f8cef48a00268651c6","63bcb98a843cf10035c6aa7e","63bcbf2d46946b00a806cc2f","63bcc02e060bbb00a56f3f1b","63bcc1adfc4ffa0033d1db41","63bcc375739223001e1351f5","63bcd83381dcaf0024a003ce","63bdd69ef975a20026301b53","63c0b0a04e1d95003893b3bb"],"project":"61f2f6237da66107c6124fbe","releaseDate":"2022-01-27T19:44:36.369Z","createdAt":"2022-01-27T19:44:36.369Z","__v":1},{"_id":"63fd4a1164ec13002607c2bf","version":"1.1","version_clean":"1.1.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":false,"categories":["61f2f6247da66107c6124fc5","61f2f6247da66107c6124fc5","61f2f6247da66107c6124fcb","61f2f6999da79900713a1545","61f2f70874ef2b0752601f0c","61f2f7377fbd78082f8076ba","61f3061d4b5403002b2e9e72","63fd4a1164ec13002607c23e","63fd4a1164ec13002607c23f","61f727d2ab06cb006a703c87","63fd4a1164ec13002607c240","61f72867a9238c005bd98078","63fd4a1164ec13002607c241","63fd4a1164ec13002607c242","6202d20f67fbe3006243cc8f","6202d2d1b5a9c800248c6176","63fd4a1164ec13002607c243","6202d8e4ee121f0042cd1ae5","6202d9bc054a69001060cc95","6214fe421f9844002ea68d4a","6214ff4839bf05009a5ada80","6215033c25d5340044c10ba4","621cc14e856cc10040f1a34f","625832af2980cb008dd94dac","62583384f1e0c902d4224de8","62583bba0518f40872a8d6d3","62583d332cffb6001454982c","62583dea61c5e801050d5c98","625840ab47f8c403978351d0","63fd4a1164ec13002607c244","6258453bf22e3e026616a23a","625848e7e33427002063920a","6258494261c5e801050d6e12","62b5c43611db8c0013e042d6","62b5cf89a882bb00af6fe674","63fd4a1164ec13002607c245","63fd4a1164ec13002607c246","6306a4928e1562009d162f88","63fd4a1164ec13002607c247","63fd4a1164ec13002607c248","6376bf59127d990003173b41","63fd4a1164ec13002607c249","638914a970b9ad0017194624","63fd4a1164ec13002607c24a","63891b7f618fd1001e9f87b1","63bc99721c609f004caebb5d","63bc9dd887e5a900401bce00","63bc9e7779fca00017dace8f","63bcb03e9f777c0031fb7d0b","63bcb3ccd4cb4e0046b7e317","63bcb65875966000160e9477","63bcb6f8cef48a00268651c6","63bcb98a843cf10035c6aa7e","63bcbf2d46946b00a806cc2f","63bcc02e060bbb00a56f3f1b","63bcc1adfc4ffa0033d1db41","63bcc375739223001e1351f5","63bcd83381dcaf0024a003ce","63bdd69ef975a20026301b53","63fd4a1164ec13002607c24b","63fd4a1164ec13002607c2c1","642237b92bc4750045160f46","645046d4fcddec00e2e39e29","645047351bca4c03dc35e486","646f5f4a5ca88a0057c77e58","6493615a6fbdbf02925084a1","6493616b729d1f030c86f7d0","649453586b434f0f6e06339f","649456feb63d310024c7f106","649457601d95fd0f722d274e","64a867913ae9ca000b863a65","64b541ffcb0425000b1dd432","64b54256e3cb50006c944288","64b5456f8de8c30074a36315","64d26aa8ba939c0049d17a1b","64d2b4f2e4a98a004a398ebd","64d39bd6732c31005d35e4a6","64d39e9bfec62b0074bb5402","64d3a4a700ea0d0023a7d528","64d3a9bd515df5001d0f1d6f","64d3ab69ed30b00063048bc5","64d3e00a1521040022602d75","64d3e064c35ad200257b4a17","64d3e096d2c4fc0066575d81","64d3f19e80be73006d797865","64d3f1c4831ce8005c3ac2de","64d3f6fb7f2854004e88e449","64d5041597840318dcdc0f35","64d52c0a4672ee001218dbc2","64da4680bd209a0ba3dee183","64dba326e432d4001e09cb06","64e3fc69bf594200758c3eef","64e4ad167b6027003f2390e1","64e4d2351d078100716f1d17","64eccf3a677364156fa039c8","64eccf56e85983005428b337","651e00b10374a40044aad9ce","651e01be343ebc004534d094","651e021901026a0058d1e512","651e0344d28bf80043c61aff","65331affeab70505469815fe","65522a0ff040d102a7b4c86d","655233e16aab1900249f287f","655234dd81ac8b02e09b284b","6552355a05c2fc00189e5f49","65524073f2a03e00532557c1","655242d31712210017338f25","655246248804de00e0b94212","655247d5beafb5001135e0d7","6552539b8a0901004eff3d81","6554c8a65a821d0010b65f4f","6554cac27de17200442ec052","6554cc725cacdc093eb1c0f7","6554cc94e311fe00172b70c3"],"project":"61f2f6237da66107c6124fbe","releaseDate":"2022-01-27T19:44:36.369Z","createdAt":"2022-01-27T19:44:36.369Z","__v":0,"forked_from":"61f2f6247da66107c6124fc3","updatedAt":"2024-05-29T15:25:37.002Z"},{"_id":"655f687fc3b1c200110451e6","version":"1.2","version_clean":"1.2.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61f2f6247da66107c6124fc5","61f2f6247da66107c6124fc5","61f2f6247da66107c6124fcb","61f2f6999da79900713a1545","61f2f70874ef2b0752601f0c","61f2f7377fbd78082f8076ba","61f3061d4b5403002b2e9e72","655f687fc3b1c20011045125","655f687fc3b1c20011045126","61f727d2ab06cb006a703c87","655f687fc3b1c20011045127","61f72867a9238c005bd98078","655f687fc3b1c20011045128","655f687fc3b1c20011045129","6202d20f67fbe3006243cc8f","6202d2d1b5a9c800248c6176","655f687fc3b1c2001104512a","6202d8e4ee121f0042cd1ae5","6202d9bc054a69001060cc95","6214fe421f9844002ea68d4a","6214ff4839bf05009a5ada80","6215033c25d5340044c10ba4","621cc14e856cc10040f1a34f","625832af2980cb008dd94dac","62583384f1e0c902d4224de8","62583bba0518f40872a8d6d3","62583d332cffb6001454982c","62583dea61c5e801050d5c98","625840ab47f8c403978351d0","655f687fc3b1c2001104512b","6258453bf22e3e026616a23a","625848e7e33427002063920a","6258494261c5e801050d6e12","62b5c43611db8c0013e042d6","62b5cf89a882bb00af6fe674","655f687fc3b1c2001104512c","63fd4a1164ec13002607c246","6306a4928e1562009d162f88","655f687fc3b1c2001104512d","63fd4a1164ec13002607c248","6376bf59127d990003173b41","63fd4a1164ec13002607c249","638914a970b9ad0017194624","63fd4a1164ec13002607c24a","63891b7f618fd1001e9f87b1","63bc99721c609f004caebb5d","63bc9dd887e5a900401bce00","63bc9e7779fca00017dace8f","63bcb03e9f777c0031fb7d0b","63bcb3ccd4cb4e0046b7e317","63bcb65875966000160e9477","63bcb6f8cef48a00268651c6","63bcb98a843cf10035c6aa7e","63bcbf2d46946b00a806cc2f","63bcc02e060bbb00a56f3f1b","63bcc1adfc4ffa0033d1db41","63bcc375739223001e1351f5","63bcd83381dcaf0024a003ce","63bdd69ef975a20026301b53","63fd4a1164ec13002607c24b","63fd4a1164ec13002607c2c1","655f687fc3b1c2001104512e","645046d4fcddec00e2e39e29","655f687fc3b1c2001104512f","646f5f4a5ca88a0057c77e58","6493615a6fbdbf02925084a1","6493616b729d1f030c86f7d0","649453586b434f0f6e06339f","649456feb63d310024c7f106","649457601d95fd0f722d274e","655f687fc3b1c20011045130","64b541ffcb0425000b1dd432","64b54256e3cb50006c944288","64b5456f8de8c30074a36315","64d26aa8ba939c0049d17a1b","64d2b4f2e4a98a004a398ebd","64d39bd6732c31005d35e4a6","64d39e9bfec62b0074bb5402","64d3a4a700ea0d0023a7d528","64d3a9bd515df5001d0f1d6f","64d3ab69ed30b00063048bc5","64d3e00a1521040022602d75","64d3e064c35ad200257b4a17","655f687fc3b1c20011045131","64d3f19e80be73006d797865","64d3f1c4831ce8005c3ac2de","64d3f6fb7f2854004e88e449","64d5041597840318dcdc0f35","64d52c0a4672ee001218dbc2","64da4680bd209a0ba3dee183","64dba326e432d4001e09cb06","64e3fc69bf594200758c3eef","64e4ad167b6027003f2390e1","64e4d2351d078100716f1d17","655f687fc3b1c20011045132","64eccf56e85983005428b337","651e00b10374a40044aad9ce","651e01be343ebc004534d094","651e021901026a0058d1e512","655f687fc3b1c20011045133","655f687fc3b1c20011045134","65522a0ff040d102a7b4c86d","655233e16aab1900249f287f","655234dd81ac8b02e09b284b","6552355a05c2fc00189e5f49","65524073f2a03e00532557c1","655f687fc3b1c20011045135","655246248804de00e0b94212","655f687fc3b1c20011045136","655f687fc3b1c20011045137","6554c8a65a821d0010b65f4f","6554cac27de17200442ec052","6554cc725cacdc093eb1c0f7","6554cc94e311fe00172b70c3","655f6880c3b1c200110451e8","655f7b42ecbcee0010fdbb26","6565faaf60c3310058e55ed7","6565ff9a838b51005260ad26","65a6c92c493fc5001cb4d158","65f9bfb405207c00296bd5d0","65fcf9cd32f7c30011155d91","65fcfadb02070e0018924354","6622ab8af75ee0001339627a","66311ced0407170027c6fd1a","663240c79e3a9f003cc7a7f3","663388eb271d62000fc35bf6","6635399056c75d00127ab16c","663a2cac734fe20069d4378c","664012ffc78c1f006e94a5d6","6640137a45a5460011617551","6659e5addcca8300674b9229","6659e840e0a8990030c70c1e","6659e88f51e6de003192d669","6682f978b545200053fff3af","66842ef95d5b130039b86810","66844f6a69bedc00585e7cde","66849f99d3dd850010c90660","6684a1fb59500e0043e94bf4","6684a3c695bc11001fc1ccd6","6684a54842dc40005ae5db5c","6684a5f5b79694001127c8c9","6684a80259500e0043e9507e","6684a8ca2db153001279cb6b","6684a9b0a1eb85003d6349cf","6684aa3c716cdf0070a815d2","668c1976566d94002fff0ac0"],"project":"61f2f6237da66107c6124fbe","releaseDate":"2022-01-27T19:44:36.369Z","createdAt":"2023-11-23T14:58:07.806Z","__v":0,"forked_from":"63fd4a1164ec13002607c2bf","updatedAt":"2024-07-11T18:00:44.914Z"},{"_id":"6659cc0ab80ec2004f1aa284","version":"2.0","version_clean":"2.0.0","codename":"Unified Docs V2","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61f2f6247da66107c6124fc5","61f2f6247da66107c6124fc5","61f2f6247da66107c6124fcb","61f2f6999da79900713a1545","61f2f70874ef2b0752601f0c","61f2f7377fbd78082f8076ba","61f3061d4b5403002b2e9e72","6659cc0ab80ec2004f1aa17b","6659cc0ab80ec2004f1aa17c","61f727d2ab06cb006a703c87","6659cc0ab80ec2004f1aa17d","61f72867a9238c005bd98078","6659cc0ab80ec2004f1aa17e","6659cc0ab80ec2004f1aa17f","6202d20f67fbe3006243cc8f","6202d2d1b5a9c800248c6176","6659cc0ab80ec2004f1aa180","6202d8e4ee121f0042cd1ae5","6202d9bc054a69001060cc95","6214fe421f9844002ea68d4a","6214ff4839bf05009a5ada80","6215033c25d5340044c10ba4","621cc14e856cc10040f1a34f","625832af2980cb008dd94dac","62583384f1e0c902d4224de8","62583bba0518f40872a8d6d3","62583d332cffb6001454982c","62583dea61c5e801050d5c98","625840ab47f8c403978351d0","6659cc0ab80ec2004f1aa181","6258453bf22e3e026616a23a","625848e7e33427002063920a","6258494261c5e801050d6e12","62b5c43611db8c0013e042d6","62b5cf89a882bb00af6fe674","6659cc0ab80ec2004f1aa182","63fd4a1164ec13002607c246","6306a4928e1562009d162f88","6659cc0ab80ec2004f1aa183","63fd4a1164ec13002607c248","6376bf59127d990003173b41","63fd4a1164ec13002607c249","638914a970b9ad0017194624","63fd4a1164ec13002607c24a","63891b7f618fd1001e9f87b1","63bc99721c609f004caebb5d","63bc9dd887e5a900401bce00","63bc9e7779fca00017dace8f","63bcb03e9f777c0031fb7d0b","63bcb3ccd4cb4e0046b7e317","63bcb65875966000160e9477","63bcb6f8cef48a00268651c6","63bcb98a843cf10035c6aa7e","63bcbf2d46946b00a806cc2f","63bcc02e060bbb00a56f3f1b","63bcc1adfc4ffa0033d1db41","63bcc375739223001e1351f5","63bcd83381dcaf0024a003ce","63bdd69ef975a20026301b53","63fd4a1164ec13002607c24b","63fd4a1164ec13002607c2c1","6659cc0ab80ec2004f1aa184","645046d4fcddec00e2e39e29","655f687fc3b1c2001104512f","646f5f4a5ca88a0057c77e58","6493615a6fbdbf02925084a1","6493616b729d1f030c86f7d0","649453586b434f0f6e06339f","649456feb63d310024c7f106","649457601d95fd0f722d274e","655f687fc3b1c20011045130","64b541ffcb0425000b1dd432","64b54256e3cb50006c944288","64b5456f8de8c30074a36315","64d26aa8ba939c0049d17a1b","64d2b4f2e4a98a004a398ebd","64d39bd6732c31005d35e4a6","64d39e9bfec62b0074bb5402","64d3a4a700ea0d0023a7d528","64d3a9bd515df5001d0f1d6f","64d3ab69ed30b00063048bc5","64d3e00a1521040022602d75","64d3e064c35ad200257b4a17","655f687fc3b1c20011045131","64d3f19e80be73006d797865","64d3f1c4831ce8005c3ac2de","64d3f6fb7f2854004e88e449","64d5041597840318dcdc0f35","64d52c0a4672ee001218dbc2","64da4680bd209a0ba3dee183","64dba326e432d4001e09cb06","64e3fc69bf594200758c3eef","64e4ad167b6027003f2390e1","64e4d2351d078100716f1d17","6659cc0ab80ec2004f1aa185","64eccf56e85983005428b337","651e00b10374a40044aad9ce","651e01be343ebc004534d094","651e021901026a0058d1e512","655f687fc3b1c20011045133","655f687fc3b1c20011045134","65522a0ff040d102a7b4c86d","655233e16aab1900249f287f","655234dd81ac8b02e09b284b","6552355a05c2fc00189e5f49","65524073f2a03e00532557c1","6659cc0ab80ec2004f1aa186","655246248804de00e0b94212","6659cc0ab80ec2004f1aa187","6659cc0ab80ec2004f1aa188","6554c8a65a821d0010b65f4f","6554cac27de17200442ec052","6554cc725cacdc093eb1c0f7","6554cc94e311fe00172b70c3","6659cc0ab80ec2004f1aa189","6659cc0ab80ec2004f1aa18a","6659cc0ab80ec2004f1aa18b","6565ff9a838b51005260ad26","65a6c92c493fc5001cb4d158","65f9bfb405207c00296bd5d0","65fcf9cd32f7c30011155d91","6659cc0ab80ec2004f1aa18c","6659cc0ab80ec2004f1aa18d","66311ced0407170027c6fd1a","663240c79e3a9f003cc7a7f3","663388eb271d62000fc35bf6","6635399056c75d00127ab16c","6659cc0ab80ec2004f1aa18e","6659cc0ab80ec2004f1aa18f","6659cc0ab80ec2004f1aa190","665e23a43018ce002ae55a85","665e31b3803577006a9958c9","665e31bbbe0e2d005c658727","6661f51ba80a54006ae74684","66901894a73ee3002e5b4f71","6690193be167350043819dbf","66d1de5b700490004b9e6e82","66dccbc9cdc97b0042135bce","66df9be5a9931b001ac0fcf8","66f223f6827ec6002b615d7a","66f45f5e6946532ab0423a7a","66f47249a16fb5001fb9a6d6","66f4728385a535001fded04f","66f4748014205c001374d367","66f4850814205c001374e10d","66fef9f54e2d150018d34112","66fefac81e58df00617ba329","66fefd5270490400116f1ca0","66fefe38225d6c000f076480","67243d2d929ff0003ec69b3f","6724f33f6824f50075462fa1","6724f3a025616f00111331af","672bd78955e7ff006dcc43cb","673e3cbaba6622002b76755a","673e40944f9f5c0012f61b00","673e42bdf273c00012395c1a","673e44f0de8021002bf3f82b","673e473002138d00184ee7f5","673e479d219d370055ad8c27","673e496212b6e40054a57b35","673f9533a968890071572ea2","673fd65e89875b00684c1fdc","6744dc5722785d001012cc1d","6744e72ab64acf002fb9a95c","67509409f2071c0018b7fcac","675094680cd0ce003b027577","676075c455689c0032090420","67607f04c5479773a6155f0c"],"project":"61f2f6237da66107c6124fbe","releaseDate":"2022-01-27T19:44:36.369Z","createdAt":"2024-05-31T13:09:30.461Z","__v":0,"forked_from":"655f687fc3b1c200110451e6","updatedAt":"2024-12-16T19:27:00.318Z"}],"variableDefaults":[null,{"source":"security","_id":"652eaab69e0e88197bcf3b85","name":"authorization","type":"apiKey","apiSetting":"638914e738c0e800aac362b1"},{"source":"security","_id":"6541048b1a4e17099759a54d","name":"Authorization","type":"apiKey","apiSetting":"6202d5d4b858c90049050339"}],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","glossary":[{"_id":"655fad103facf3004c288f20","term":"agent","definition":"Refers to one 'project', 'assistant', or 'bot' in your workspace"}],"canonical_url":null,"default_version":{"name":"2.0"},"description":"Voiceflow developer and user documentation.","homepage_url":"https://www.voiceflow.com/","id":"61f2f6237da66107c6124fbe","name":"Voiceflow","parent":null,"redirects":[],"sitemap":"disabled","subdomain":"voiceflow-developer","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[{"name":"authorization","source":"security","type":"apiKey","id":"652eaab69e0e88197bcf3b85"},{"name":"Authorization","source":"security","type":"apiKey","id":"6541048b1a4e17099759a54d"}],"webhooks":[],"api_designer":{"allow_editing":"enabled"},"custom_login":{"login_url":null,"logout_url":null},"features":{"custom_components":"disabled","mdx":"disabled"},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":false,"logs":true,"metricsSDK":false},"pages":{"not_found":null},"privacy":{"view":"public","password":null},"refactored":{"status":"disabled","migrated":"unknown"},"reference":{"api_sdk_snippets":"disabled","defaults":"always_use","json_editor":"disabled","oauth_flows":"disabled","request_history":"disabled","response_examples":"expanded","response_schemas":"expanded"},"seo":{"overwrite_title_tag":"enabled"},"plan":{"type":"startup2018","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2024-09-09T14:49:51.761Z"}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"integrations":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":null,"secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"disabled","custom_code":{"css":"disabled","html":"disabled","js":"disabled"}}},"appearance":{"brand":{"primary_color":"#1F2428","link_color":"#FFAC2F","theme":"system"},"changelog":{"layout":"continuous","show_author":true,"show_exact_date":true},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"footer":{"readme_logo":"hide"},"logo":{"size":"default","dark_mode":{"uri":null,"url":"https://files.readme.io/edd48a8-Voiceflow-wordmark-light.svg","name":"edd48a8-Voiceflow-wordmark-light.svg","width":218,"height":40,"color":"#000000","links":{"original_url":null}},"main":{"uri":"/images/668fec65df60bc000f3f6696","url":"https://files.readme.io/d7cb562-small-square-onyx-1024.png","name":"d7cb562-small-square-onyx-1024.png","width":80,"height":80,"color":"#242c2c","links":{"original_url":"https://files.readme.io/74f5eaf-square-onyx-1024.png"}},"favicon":{"uri":null,"url":"https://files.readme.io/6f6abbe-round-proto-1024.ico","name":"6f6abbe-round-proto-1024.ico","width":256,"height":256,"color":"#000000","links":{"original_url":null}}},"custom_code":{"css":null,"js":null,"html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"overlay","gradient_color":null,"overlay":{"fill":"cover","type":"custom","position":"top-right","image":{"uri":null,"url":"https://files.readme.io/d5b4013-ASCII_Black_No_Logo.png","name":"d5b4013-ASCII_Black_No_Logo.png","width":1920,"height":1080,"color":"#000000","links":{"original_url":null}}}},"navigation":{"first_page":"documentation","left":[],"logo_link":"landing_page","right":[{"type":"link_url","title":"Join Discord","url":"https://link.voiceflow.com/community","custom_page":null},{"type":"link_url","title":"Trust Center","url":"https://trust.voiceflow.com/","custom_page":"video-tutorials"}],"sub_nav":[],"subheader_layout":"links","version":"disabled","links":{"home":{"label":"Home","visibility":"disabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":null,"visibility":"enabled"},"reference":{"label":"API Reference","alias":"API Reference","visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":"Changelog","visibility":"enabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}}}},"version":{"_id":"6659cc0ab80ec2004f1aa284","version":"2.0","version_clean":"2.0.0","codename":"Unified Docs V2","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61f2f6247da66107c6124fc5","61f2f6247da66107c6124fc5","61f2f6247da66107c6124fcb","61f2f6999da79900713a1545","61f2f70874ef2b0752601f0c","61f2f7377fbd78082f8076ba","61f3061d4b5403002b2e9e72","6659cc0ab80ec2004f1aa17b","6659cc0ab80ec2004f1aa17c","61f727d2ab06cb006a703c87","6659cc0ab80ec2004f1aa17d","61f72867a9238c005bd98078","6659cc0ab80ec2004f1aa17e","6659cc0ab80ec2004f1aa17f","6202d20f67fbe3006243cc8f","6202d2d1b5a9c800248c6176","6659cc0ab80ec2004f1aa180","6202d8e4ee121f0042cd1ae5","6202d9bc054a69001060cc95","6214fe421f9844002ea68d4a","6214ff4839bf05009a5ada80","6215033c25d5340044c10ba4","621cc14e856cc10040f1a34f","625832af2980cb008dd94dac","62583384f1e0c902d4224de8","62583bba0518f40872a8d6d3","62583d332cffb6001454982c","62583dea61c5e801050d5c98","625840ab47f8c403978351d0","6659cc0ab80ec2004f1aa181","6258453bf22e3e026616a23a","625848e7e33427002063920a","6258494261c5e801050d6e12","62b5c43611db8c0013e042d6","62b5cf89a882bb00af6fe674","6659cc0ab80ec2004f1aa182","63fd4a1164ec13002607c246","6306a4928e1562009d162f88","6659cc0ab80ec2004f1aa183","63fd4a1164ec13002607c248","6376bf59127d990003173b41","63fd4a1164ec13002607c249","638914a970b9ad0017194624","63fd4a1164ec13002607c24a","63891b7f618fd1001e9f87b1","63bc99721c609f004caebb5d","63bc9dd887e5a900401bce00","63bc9e7779fca00017dace8f","63bcb03e9f777c0031fb7d0b","63bcb3ccd4cb4e0046b7e317","63bcb65875966000160e9477","63bcb6f8cef48a00268651c6","63bcb98a843cf10035c6aa7e","63bcbf2d46946b00a806cc2f","63bcc02e060bbb00a56f3f1b","63bcc1adfc4ffa0033d1db41","63bcc375739223001e1351f5","63bcd83381dcaf0024a003ce","63bdd69ef975a20026301b53","63fd4a1164ec13002607c24b","63fd4a1164ec13002607c2c1","6659cc0ab80ec2004f1aa184","645046d4fcddec00e2e39e29","655f687fc3b1c2001104512f","646f5f4a5ca88a0057c77e58","6493615a6fbdbf02925084a1","6493616b729d1f030c86f7d0","649453586b434f0f6e06339f","649456feb63d310024c7f106","649457601d95fd0f722d274e","655f687fc3b1c20011045130","64b541ffcb0425000b1dd432","64b54256e3cb50006c944288","64b5456f8de8c30074a36315","64d26aa8ba939c0049d17a1b","64d2b4f2e4a98a004a398ebd","64d39bd6732c31005d35e4a6","64d39e9bfec62b0074bb5402","64d3a4a700ea0d0023a7d528","64d3a9bd515df5001d0f1d6f","64d3ab69ed30b00063048bc5","64d3e00a1521040022602d75","64d3e064c35ad200257b4a17","655f687fc3b1c20011045131","64d3f19e80be73006d797865","64d3f1c4831ce8005c3ac2de","64d3f6fb7f2854004e88e449","64d5041597840318dcdc0f35","64d52c0a4672ee001218dbc2","64da4680bd209a0ba3dee183","64dba326e432d4001e09cb06","64e3fc69bf594200758c3eef","64e4ad167b6027003f2390e1","64e4d2351d078100716f1d17","6659cc0ab80ec2004f1aa185","64eccf56e85983005428b337","651e00b10374a40044aad9ce","651e01be343ebc004534d094","651e021901026a0058d1e512","655f687fc3b1c20011045133","655f687fc3b1c20011045134","65522a0ff040d102a7b4c86d","655233e16aab1900249f287f","655234dd81ac8b02e09b284b","6552355a05c2fc00189e5f49","65524073f2a03e00532557c1","6659cc0ab80ec2004f1aa186","655246248804de00e0b94212","6659cc0ab80ec2004f1aa187","6659cc0ab80ec2004f1aa188","6554c8a65a821d0010b65f4f","6554cac27de17200442ec052","6554cc725cacdc093eb1c0f7","6554cc94e311fe00172b70c3","6659cc0ab80ec2004f1aa189","6659cc0ab80ec2004f1aa18a","6659cc0ab80ec2004f1aa18b","6565ff9a838b51005260ad26","65a6c92c493fc5001cb4d158","65f9bfb405207c00296bd5d0","65fcf9cd32f7c30011155d91","6659cc0ab80ec2004f1aa18c","6659cc0ab80ec2004f1aa18d","66311ced0407170027c6fd1a","663240c79e3a9f003cc7a7f3","663388eb271d62000fc35bf6","6635399056c75d00127ab16c","6659cc0ab80ec2004f1aa18e","6659cc0ab80ec2004f1aa18f","6659cc0ab80ec2004f1aa190","665e23a43018ce002ae55a85","665e31b3803577006a9958c9","665e31bbbe0e2d005c658727","6661f51ba80a54006ae74684","66901894a73ee3002e5b4f71","6690193be167350043819dbf","66d1de5b700490004b9e6e82","66dccbc9cdc97b0042135bce","66df9be5a9931b001ac0fcf8","66f223f6827ec6002b615d7a","66f45f5e6946532ab0423a7a","66f47249a16fb5001fb9a6d6","66f4728385a535001fded04f","66f4748014205c001374d367","66f4850814205c001374e10d","66fef9f54e2d150018d34112","66fefac81e58df00617ba329","66fefd5270490400116f1ca0","66fefe38225d6c000f076480","67243d2d929ff0003ec69b3f","6724f33f6824f50075462fa1","6724f3a025616f00111331af","672bd78955e7ff006dcc43cb","673e3cbaba6622002b76755a","673e40944f9f5c0012f61b00","673e42bdf273c00012395c1a","673e44f0de8021002bf3f82b","673e473002138d00184ee7f5","673e479d219d370055ad8c27","673e496212b6e40054a57b35","673f9533a968890071572ea2","673fd65e89875b00684c1fdc","6744dc5722785d001012cc1d","6744e72ab64acf002fb9a95c","67509409f2071c0018b7fcac","675094680cd0ce003b027577","676075c455689c0032090420","67607f04c5479773a6155f0c"],"project":"61f2f6237da66107c6124fbe","releaseDate":"2022-01-27T19:44:36.369Z","createdAt":"2024-05-31T13:09:30.461Z","__v":0,"forked_from":"655f687fc3b1c200110451e6","updatedAt":"2024-12-16T19:27:00.318Z"}},"reqUrl":"/docs/introduction-to-entities","version":{"_id":"6659cc0ab80ec2004f1aa284","version":"2.0","version_clean":"2.0.0","codename":"Unified Docs V2","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61f2f6247da66107c6124fc5","61f2f6247da66107c6124fc5","61f2f6247da66107c6124fcb","61f2f6999da79900713a1545","61f2f70874ef2b0752601f0c","61f2f7377fbd78082f8076ba","61f3061d4b5403002b2e9e72","6659cc0ab80ec2004f1aa17b","6659cc0ab80ec2004f1aa17c","61f727d2ab06cb006a703c87","6659cc0ab80ec2004f1aa17d","61f72867a9238c005bd98078","6659cc0ab80ec2004f1aa17e","6659cc0ab80ec2004f1aa17f","6202d20f67fbe3006243cc8f","6202d2d1b5a9c800248c6176","6659cc0ab80ec2004f1aa180","6202d8e4ee121f0042cd1ae5","6202d9bc054a69001060cc95","6214fe421f9844002ea68d4a","6214ff4839bf05009a5ada80","6215033c25d5340044c10ba4","621cc14e856cc10040f1a34f","625832af2980cb008dd94dac","62583384f1e0c902d4224de8","62583bba0518f40872a8d6d3","62583d332cffb6001454982c","62583dea61c5e801050d5c98","625840ab47f8c403978351d0","6659cc0ab80ec2004f1aa181","6258453bf22e3e026616a23a","625848e7e33427002063920a","6258494261c5e801050d6e12","62b5c43611db8c0013e042d6","62b5cf89a882bb00af6fe674","6659cc0ab80ec2004f1aa182","63fd4a1164ec13002607c246","6306a4928e1562009d162f88","6659cc0ab80ec2004f1aa183","63fd4a1164ec13002607c248","6376bf59127d990003173b41","63fd4a1164ec13002607c249","638914a970b9ad0017194624","63fd4a1164ec13002607c24a","63891b7f618fd1001e9f87b1","63bc99721c609f004caebb5d","63bc9dd887e5a900401bce00","63bc9e7779fca00017dace8f","63bcb03e9f777c0031fb7d0b","63bcb3ccd4cb4e0046b7e317","63bcb65875966000160e9477","63bcb6f8cef48a00268651c6","63bcb98a843cf10035c6aa7e","63bcbf2d46946b00a806cc2f","63bcc02e060bbb00a56f3f1b","63bcc1adfc4ffa0033d1db41","63bcc375739223001e1351f5","63bcd83381dcaf0024a003ce","63bdd69ef975a20026301b53","63fd4a1164ec13002607c24b","63fd4a1164ec13002607c2c1","6659cc0ab80ec2004f1aa184","645046d4fcddec00e2e39e29","655f687fc3b1c2001104512f","646f5f4a5ca88a0057c77e58","6493615a6fbdbf02925084a1","6493616b729d1f030c86f7d0","649453586b434f0f6e06339f","649456feb63d310024c7f106","649457601d95fd0f722d274e","655f687fc3b1c20011045130","64b541ffcb0425000b1dd432","64b54256e3cb50006c944288","64b5456f8de8c30074a36315","64d26aa8ba939c0049d17a1b","64d2b4f2e4a98a004a398ebd","64d39bd6732c31005d35e4a6","64d39e9bfec62b0074bb5402","64d3a4a700ea0d0023a7d528","64d3a9bd515df5001d0f1d6f","64d3ab69ed30b00063048bc5","64d3e00a1521040022602d75","64d3e064c35ad200257b4a17","655f687fc3b1c20011045131","64d3f19e80be73006d797865","64d3f1c4831ce8005c3ac2de","64d3f6fb7f2854004e88e449","64d5041597840318dcdc0f35","64d52c0a4672ee001218dbc2","64da4680bd209a0ba3dee183","64dba326e432d4001e09cb06","64e3fc69bf594200758c3eef","64e4ad167b6027003f2390e1","64e4d2351d078100716f1d17","6659cc0ab80ec2004f1aa185","64eccf56e85983005428b337","651e00b10374a40044aad9ce","651e01be343ebc004534d094","651e021901026a0058d1e512","655f687fc3b1c20011045133","655f687fc3b1c20011045134","65522a0ff040d102a7b4c86d","655233e16aab1900249f287f","655234dd81ac8b02e09b284b","6552355a05c2fc00189e5f49","65524073f2a03e00532557c1","6659cc0ab80ec2004f1aa186","655246248804de00e0b94212","6659cc0ab80ec2004f1aa187","6659cc0ab80ec2004f1aa188","6554c8a65a821d0010b65f4f","6554cac27de17200442ec052","6554cc725cacdc093eb1c0f7","6554cc94e311fe00172b70c3","6659cc0ab80ec2004f1aa189","6659cc0ab80ec2004f1aa18a","6659cc0ab80ec2004f1aa18b","6565ff9a838b51005260ad26","65a6c92c493fc5001cb4d158","65f9bfb405207c00296bd5d0","65fcf9cd32f7c30011155d91","6659cc0ab80ec2004f1aa18c","6659cc0ab80ec2004f1aa18d","66311ced0407170027c6fd1a","663240c79e3a9f003cc7a7f3","663388eb271d62000fc35bf6","6635399056c75d00127ab16c","6659cc0ab80ec2004f1aa18e","6659cc0ab80ec2004f1aa18f","6659cc0ab80ec2004f1aa190","665e23a43018ce002ae55a85","665e31b3803577006a9958c9","665e31bbbe0e2d005c658727","6661f51ba80a54006ae74684","66901894a73ee3002e5b4f71","6690193be167350043819dbf","66d1de5b700490004b9e6e82","66dccbc9cdc97b0042135bce","66df9be5a9931b001ac0fcf8","66f223f6827ec6002b615d7a","66f45f5e6946532ab0423a7a","66f47249a16fb5001fb9a6d6","66f4728385a535001fded04f","66f4748014205c001374d367","66f4850814205c001374e10d","66fef9f54e2d150018d34112","66fefac81e58df00617ba329","66fefd5270490400116f1ca0","66fefe38225d6c000f076480","67243d2d929ff0003ec69b3f","6724f33f6824f50075462fa1","6724f3a025616f00111331af","672bd78955e7ff006dcc43cb","673e3cbaba6622002b76755a","673e40944f9f5c0012f61b00","673e42bdf273c00012395c1a","673e44f0de8021002bf3f82b","673e473002138d00184ee7f5","673e479d219d370055ad8c27","673e496212b6e40054a57b35","673f9533a968890071572ea2","673fd65e89875b00684c1fdc","6744dc5722785d001012cc1d","6744e72ab64acf002fb9a95c","67509409f2071c0018b7fcac","675094680cd0ce003b027577","676075c455689c0032090420","67607f04c5479773a6155f0c"],"project":"61f2f6237da66107c6124fbe","releaseDate":"2022-01-27T19:44:36.369Z","createdAt":"2024-05-31T13:09:30.461Z","__v":0,"forked_from":"655f687fc3b1c200110451e6","updatedAt":"2024-12-16T19:27:00.318Z"},"lang":"en","langFull":"Default","isDetachedProductionSite":false}"></script></div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div><script>!function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","group","track","ready","alias","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+ "cdn.segment.com" +"/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="3.0.1"; analytics.load("F0MhCGM2MvAhamS96JowXoMfrjUblmD6"); }}(); </script><script>var is_hub = true; var is_hub2 = true; var is_hub_edit = true; </script><div id="ssr-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[6601,3622,9772,4904,7449,7372,9082,734,954,6903,2395,8161,1008,7188,5753,2852,9930,7783,1456,3859,4935,3221,7327,7717,4287,5359,5948,4201,8230,3307,3626,3556,1202,1343,6060,5798,1080,9852,8684,1313,1936,1666,6922,2859,9575,4002,3787,8063,4467,7356,2144,9141,5408,2637,2402,4674,1731,2616,3412,4793,7779,7031,2578,678,7289,8899,9111,5642,7438,2813,4778]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","core-icons-chevron-down-svg","core-icons-chevron-up-down-svg","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","core-icons-book-svg","core-icons-key-svg","core-icons-alert-circle-svg","core-icons-more-vertical-svg","core-icons-lock-svg","Footer","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","routes-Reference","routes-Doc","routes-PageNotFound","CustomPage","core-icons-arrow-right-svg","routes-Landing","core-icons-arrow-up-right-svg","routes-Tutorials","RMDX","routes-Changelog","Post","routes-Discuss","Page","List","core-icons-trending-up-svg","core-icons-callout-info-svg","core-icons-star-svg","core-icons-gauge-circle-svg","core-icons-message-circle-svg","core-graphics-json-svg","routes-CustomPage","core-icons-eye-off-svg","core-icons-webhook-svg","core-icons-inbox-svg","New","core-icons-megaphone-svg","Diff","core-icons-edit-svg","core-icons-eye-svg"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.5291198bd71a134466e9.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6601.cef2fa12a9b5e2b9df03.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3622.30b9cb2443fabb238262.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.dcd45762ee393f583fea.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/4904.df63e6b74f3878787175.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7372.4f5a59d2f86c6ece493b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/734.2949e3d7010fa5c21ffd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/954.53ce7f86793664155f78.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6903.75b9333e2c99d6924d0e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.93b03fc4eb8efabb08a7.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/8161.c06bb55544d4d5ece838.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1008.4c339ef2e2b87bbd1d0b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7188.9cd5fd7fe0a05ab94dea.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5753.887d4d8ae5466a3f3b2a.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.6d52d3d479e7e6844ace.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/9930.8ac6b4156bf4ee8644e6.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.2497238876f4f363107c.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.85a768f818d97858fce7.js"></script> <script async data-chunk="core-icons-chevron-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"></script> <script async data-chunk="core-icons-chevron-up-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"></script> <script async data-chunk="core-icons-search-svg" src="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"></script> <script async data-chunk="core-icons-custom-pages-svg" src="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/7717.c3f46aef4dac129abcfb.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/5359.fb0c48929b1827a8a2b2.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/5948.a51402657e2eb40ab43b.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/4201.fe60df69c20b2ce54513.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/8230.128cfdd53c803eea12b2.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.5cae0557d05c869c77bf.js"></script> <script async data-chunk="core-icons-book-svg" src="https://cdn.readme.io/public/hub/web/core-icons-book-svg.556c5a2abddd44b2284c.js"></script> <script async data-chunk="core-icons-key-svg" src="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"></script> <script async data-chunk="core-icons-alert-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"></script> <script async data-chunk="core-icons-more-vertical-svg" src="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"></script> <script async data-chunk="core-icons-lock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.43a913423ff21c406134.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.85c89705122f7bc8f4f3.js"></script> <script async data-chunk="core-icons-x-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"></script> <script async data-chunk="core-icons-suggested-edits-svg" src="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.f1f59d6d6f3fec6c0a4e.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.f81f304a0f9e9f73d47e.js"></script> <script async data-chunk="routes-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.852328ff472332820e4a.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/2859.638ac41f3269eb8fe633.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/4002.704e628347d37011965d.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.1ea18c7d8e69fc7252af.js"></script> <script async data-chunk="core-icons-arrow-up-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"></script> <script async data-chunk="routes-Tutorials" src="https://cdn.readme.io/public/hub/web/routes-Tutorials.c491da97152573555d9f.js"></script> <script async data-chunk="RMDX" src="https://cdn.readme.io/public/hub/web/RMDX.aefe00bd92fd4e78ab65.js"></script> <script async data-chunk="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.80a45bec48d0ae892ab7.js"></script> <script async data-chunk="Post" src="https://cdn.readme.io/public/hub/web/Post.34fb79ca63e7ed2617d0.js"></script> <script async data-chunk="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.dae2f8e80d2d75f106bd.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/2637.f161cf21b4202fcf0f18.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/Page.4e99fc9641c6a023c75a.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/4674.6e1931c1363cea798412.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/List.a16df6acd7d10a15e9da.js"></script> <script async data-chunk="core-icons-trending-up-svg" src="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"></script> <script async data-chunk="core-icons-callout-info-svg" src="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"></script> <script async data-chunk="core-icons-star-svg" src="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"></script> <script async data-chunk="core-icons-gauge-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-gauge-circle-svg.fff25782546fef314a09.js"></script> <script async data-chunk="core-icons-message-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"></script> <script async data-chunk="core-icons-eye-off-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"></script> <script async data-chunk="core-icons-webhook-svg" src="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"></script> <script async data-chunk="core-icons-inbox-svg" src="https://cdn.readme.io/public/hub/web/core-icons-inbox-svg.01c2ecb759e417a98bb8.js"></script> <script async data-chunk="New" src="https://cdn.readme.io/public/hub/web/New.88fc0ed9b34185288d64.js"></script> <script async data-chunk="core-icons-megaphone-svg" src="https://cdn.readme.io/public/hub/web/core-icons-megaphone-svg.c4823f47f1244e78066e.js"></script> <script async data-chunk="Diff" src="https://cdn.readme.io/public/hub/web/5642.90129f27bfbf9bd8acd1.js"></script> <script async data-chunk="Diff" src="https://cdn.readme.io/public/hub/web/Diff.f4835442ecf2d8e738f9.js"></script> <script async data-chunk="core-icons-edit-svg" src="https://cdn.readme.io/public/hub/web/core-icons-edit-svg.2702a4af6dbb1f7f46c5.js"></script> <script async data-chunk="core-icons-eye-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-svg.b2103692a3c209893efe.js"></script></div><script>$(window).on('pageLoad', function(e, state){ analytics.page(window.location.pathname, state.meta.title, { "context": { "plugin": { "name": "readme_io", "version": "1.0.0" } } }) }); </script><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"NTMzODI1YTU1YWVmOTZhNzU4NmM2OWI5MzcwMTY4ZjU4ODFlY2U4MTlkMTllZDhkNGM0ZTVmMmY0YWMyNzY0OXRhZ0ZpbHRlcnM9KHByb2plY3Q6NjFmMmY2MjM3ZGE2NjEwN2M2MTI0ZmJlKSwodmVyc2lvbjpub25lLHZlcnNpb246NjY1OWNjMGFiODBlYzIwMDRmMWFhMjg0KSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2cp","filters":"tagFilters=(project:61f2f6237da66107c6124fbe),(version:none,version:6659cc0ab80ec2004f1aa284),(hidden:none,hidden:false),(index:CustomPage,index:Page,index:Blog)","metaData":[{"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"graphql":false,"changelog":true,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":false},"id":"61f2f6237da66107c6124fbe","name":"Voiceflow","subdomain":"voiceflow-developer","subpath":"","nav_names":{"docs":"","reference":"API Reference","changelog":"Changelog","discuss":"","tutorials":"","recipes":""}}]}}"></script><script id="readme-data-baseUrl" type="application/json" data-json=""/""></script></body></html>

CINXE.COM

Introduction to Entities