LogoLogo
  • GETTING STARTED
    • Welcome to the NLX platform
    • How NLX works
    • Guides
      • Analytics dashboard
      • Chat
      • Generative Journey (Slots)
      • Model Context Protocol
      • Voice
      • Voice+
      • Touchpoint components
        • Carousel modality
        • Video modality
    • Terms & concepts
    • Generative AI
    • Developer
  • Build
    • Workspace setup
    • Flows
      • Intro to flows & variables
      • The Canvas
      • Flow settings
      • Nodes
      • Flow appearance
    • Resources
      • Actions
        • Implementation
        • Request model
      • Analytics tags
      • Context variables
      • Data requests
        • Implementation
        • Response model
        • Request model
      • Knowledge bases
        • Ingest content
        • Add metadata (beta)
        • Apply KB
      • Lifecycle hooks
        • Implementation
      • Modalities
      • Secrets
      • Slots (custom)
        • Adding values
        • Translating slots
      • Voice+ scripts
        • Add + download script
        • Deploy script + install SDK
        • Create Voice+ flow
    • Integrations
      • Channels
        • Alexa
        • Amazon Chime SDK
        • Amazon Connect
        • AWS End User Messaging SMS
        • AWS End User Messaging Social
        • Bandwidth
        • Genesys
        • Twilio
        • Zendesk Sunshine
      • LLM services
        • Amazon Bedrock
        • Anthropic
        • Azure OpenAI
        • Cerebras
        • Cohere
        • Google Vertex AI
        • Groq
        • NVIDIA
        • OpenAI
        • xAI
      • NLP
        • Amazon Lex
        • Google Dialogflow
        • Google Dialogflow CX
        • Custom NLP
    • Translations
  • Test & Deploy
    • Applications
      • Attach flows
      • Assign default behavior
      • Add channels
        • API
          • REST API
        • Alexa
        • Amazon Chime SDK
        • Amazon Connect
        • AWS End User Messaging SMS
        • AWS End User Messaging Social
        • Genesys
        • Genesys SMS
        • Messenger
        • Microsoft Teams
        • Slack
        • SMS via Bandwidth
        • Twilio SMS
        • Twilio Voice
        • WhatsApp via Twilio
        • Zendesk Sunshine
      • Deploy
      • Optional: Set lifecycle
      • Optional: Set languages
    • Test
      • Test a conversation
      • Automated tests
      • Test an external integration
  • Analyze
    • Conversations
    • Analytics
      • Creating dashboards
      • Formulas & multi-metrics
      • Canvas analytics
    • Training
  • Workspace Settings
    • Escalation channels
    • Resource tags
    • Audit
  • Admin
    • Access control
      • Roles & permissions
    • Notifications
    • FAQ
    • Contact support
Powered by GitBook
On this page
  • What's the Response model of a Data request?
  • Data property types
  • Auto-generate response schema
  • Manually enter response schema
  1. Build
  2. Resources
  3. Data requests

Response model

Define the information sent or retrieved from data requests in your NLX workspace

Last updated 5 days ago

What's the Response model of a Data request?

The Response model of your Data request allows you to specify and shape the response body of your external data to be retrieved for relay during a conversation. This could include a user's name registered in a profile, a list of available appointment times, and so on.


Data property types

  • String: A simple text value, such as a customer's name

  • Number: An integer, such as a customer's age

  • Boolean: A value consisting of true or false

  • List: A list of values that can have other response types nested within

  • List: A list of values that can have other response types nested within


Auto-generate response schema

The simplest method for inputting your response schema is to use the model generation tool:

  • Enter/paste sample JSON response

  • Click Set response model

  • Click Save


Manually enter response schema

When selecting Object or List response schemas, a sub-items section will display to specify the multiple values you may want to reference:

  • Expand Items section > Click + Add property

  • Expand new property section > Enter Field name matching the value's name

  • Choose the specific value's schema type using the dropdown

  • Repeat steps to add properties, as needed

  • Click Save

Optional:

  • Sensitive: Enable if you would like the values to be scrubbed from any resulting conversation logs

  • Description: Provide a statement describing the response model or intended function of the setup

Object: A well-defined structure of multiple values, such as name, age, occupation. Use if wanting to reference the values in the payload of the

Use if wanting to provide the values to a user for selection when employing a in your flow. Either set your overall schema to List or set it to an Object with a nested List type of the properties you want to provide as choices (you will need to use the to process properties in a List schema when wanting to reference those values in messaging or in a User choice node of your flow)

Select Auto-generate

✨
Data request node
User choice node
Loop node
Response model tab of a Data request