Skip to main content

Test Custom Agent

User Documentation for Testing a Custom Agent​

Overview​

The Test Property dialog allows you to test the configuration of your custom agent. This feature is useful for verifying that the agent's parameters, request, and response handling are set up correctly. You can enter test values for the parameters and see the corresponding API response.

The Test Property dialog allows you to test the configuration of your custom agent. This feature is useful for verifying that the agent's parameters, request, and response handling are set up correctly. You can enter test values for the parameters and see the corresponding API response.

Screen Elements​

  1. Header Section:

    • Title: "Test Property"

  2. Fields:

    • Parameters:
      • q: An input field to enter the location query (e.g., city name).
      • units: A dropdown to select the unit system (e.g., imperial or metric).

  3. Response:

    • Description: Displays the JSON response from the API based on the provided parameters.

  4. Action Buttons:

    • Send:
      • Function: Sends the test request with the entered parameters and displays the response.
    • Cancel:
      • Function: Closes the dialog without sending a request.

How to Use​

  1. Opening the Test Property Dialog:

    • From the Edit Agent screen, click the "Test" button to open the Test Property dialog.

  2. Entering Parameters:

    • In the q field, enter the location you want to query (e.g., "Boston,MA,US").
    • In the units dropdown, select the desired unit system (e.g., "imperial").

  3. Sending the Test Request:

    • Click the "Send" button to send the test request to the API with the entered parameters.
    • The Response section will display the JSON response from the API. This response includes details such as headers, method, parameters, and the response body.

  4. Reviewing the Response:

    • Inspect the JSON response to verify that the API call is working as expected.
    • Check the response data to ensure it aligns with the configuration of your custom agent.

  5. Closing the Dialog:

    • If you need to make further changes based on the test results, click "Cancel" to close the dialog and return to the Edit Agent screen.

Notes​

  • Ensure that you enter valid test values for the parameters to get an accurate response.
  • Use the JSON response to debug and fine-tune your custom agent configuration if necessary.
  • The Response section provides a detailed view of the API call, including headers, method, parameters, and the full response body.

This documentation should help you effectively use the Test Property dialog to test and validate your custom agents. If you have any further questions or need assistance, please refer to the help section or contact support.