Testing API Call

Testing API Retrieval in the Conversation Playground

After configuring the Skill - API Knowledge Retrieval, you can test whether the API retrieval is working correctly in the Conversation Playground.

Steps to Test API Retrieval:

1. Navigate to the Conversation Playground:

   • In your platform, navigate to the Conversation Playground where you can simulate interactions with the AI agent.

2. Initiate a Test Conversation:

   • Start a new conversation by typing a question that matches the conditions you’ve set for the API retrieval.

   • Example Question (User):

     • User: "Can you show me the customer details for John Doe?"

3. Observe the AI’s Response:

   • If the API retrieval is correctly configured, the AI should trigger the API call and retrieve the relevant data.

   • Example Answer (AI):

     • AI: "Here is the information for John Doe: Email: [email protected], Phone: [phone], Address: 123 Main St, Anytown, USA."

     

     Example Q & A
4. Troubleshooting:

   • If the AI does not provide the expected response, revisit the API settings to ensure the URL, HTTP method, and Token are correctly configured.

   • Double-check the conditions that trigger the API call to ensure they align with the user's input.

Another Sample Question and AI Response:

• User: "What is the contact information for Jane Smith?"

• AI: "Here is the information for Jane Smith: Email: [email protected], Phone: [phone], Address: 456 Oak Avenue, Somecity, USA."

By using the Conversation Playground, you can ensure that your API retrieval is functioning as expected before deploying the agent into a live environment.