INSERTING A JSON KEY-VALUE PAIR

You can use JSON within your Chatbot Prompts to instruct your AI Agent the exact task to perform with Key-Value Pairs. Understanding how to insert and manipulate these pairs correctly in your prompts is crucial for effectively targeting specific Knowledge Base attributes.

To insert a JSON Key-Value Pair, follow these steps:

1. Start by typing Double Quote (") into the Prompt text editor:

   • Key Names will appear via a dropdown inside the Text Editor.
   • Select the Key Name that you wish to use.
     
     

2. Using Only the Key:
   Most prompts will use only the key name to apply actions to all values within a specific key without specifying a particular value.
   

   • Example: "Product Size"
   • Example Prompt: "Retrieve the Value from the "Product Size" key..."
     
     
3. Using the Key Name and Value Pair
   Target and exact Value within a Key by using Colon (:) and another Double Quote ("): 
   • Target and exact Value within a Key by using Colon (:) and another Double Quote ("):
     For example: "Product" : "Large"
   • You might with to target exact Values
     For Example you might prompt:
     "If the customer says they are size large only retrieve items from the "Product Size" : "Large" variants..."

BEST PRACTICES

• Consistent Quotation:
  Always use double quotes (") around both keys and values to maintain valid JSON syntax.
• Case Sensitivity:
  Ensure that the Key Names match exactly as defined in your platform to avoid errors.
• Valid Values:
  When replacing the value, make sure it corresponds to one of the predefined options available for that key.
• Avoid Trailing Commas:
  In JSON objects, do not place a comma after the last Key-Value Pair.
  
  

COMMON USE CASES

• Listing All Available Sizes:
  Example:

  "Product Size"
  

• Referencing a Product Size:
  Example:

  "Product Size" : "Extra Large"

• Using Multiple Keys:
  Example:

  Only retrieve products that match the exact Values for "Product Size" : "Large" and "Product Colour" : "Red" ...

SUMMARY

• Key-Value Pair Usage:
  • Specific Targeting: Use both key and value to define or modify a particular product attribute.
    Example:

    "Product Size" : "Large"

  • General Targeting: Use only the key to reference all values associated with that attribute.
    Example:

    "Product Size"

• Syntax Adherence:
  Maintain proper JSON syntax by using double quotes and avoiding unnecessary commas.
• Customisation Flexibility:
  By understanding how to manipulate JSON key-value pairs, you can effectively customise various product options to enhance user experience and product management.