Skip to main content

Custom Agent LLM Parameters

User Documentation for Add/Edit Parameter Dialog​

Overview​

The LLM can pass the agent parameters. You need to define the parameters that will be passed to the agent. Note there is one parameter set by default that does not need to be defined, that is llm_query

Adding LLM parameters to the Agent

The Add/Edit Parameter dialog is used to configure parameters for the parameters of a custom agent. This dialog allows you to specify details such as the parameter name, type, parameter type, description, enum values, default value, and whether the parameter is required.

The Add/Edit Parameter dialog is used to configure parameters for the parameters of a custom agent. This dialog allows you to specify details such as the parameter name, type, parameter type, description, enum values, default value, and whether the parameter is required.

Screen Elements​

  1. Header Section:

    • Title: "Update Parameter" (or "Add parameter" when adding a new parameter)

  2. Fields:

    • Parameter Name:
      • Description: The name of the parameter.
      • Input: Text field.
    • Type:
      • Description: The data type of the parameter (e.g., String, Interger, Number, Boolean, Array).
      • Input: Dropdown menu.
    • Parameter Type:
      • Description: Indicates whether the parameter is a query parameter, path, or body
      • Query: The parameter is appended to the end of the URL as a query string. For example:
        GET https://api.example.com/resource?search=keyword
        This means the parameter is visible in the URL after a ? (and potentially additional parameters after &).
      • Path: The parameter is part of the URL path itself, often indicated by a placeholder. For example:
        GET https://api.example.com/users/{username}
        Here, {username} is replaced with the actual value, rather than being added as a query string.
      • Body: The parameter is included in the request body (often for POST or PUT requests) instead of the URL. For example:

This approach keeps the data out of the URL and is commonly used for sending larger or more sensitive information.

  • Input: Dropdown menu.
  • Description:
    • Description: A brief description of the parameter and its usage.
    • Input: Text area.
  • Enum (comma separated, optional):
    • Description: A comma-separated list of acceptable values for the parameter.
    • Input: Text field.
  • Default Value (optional):
    • Description: The default value for the parameter if none is provided.
    • Input: Text field.
  • Required:
    • Description: Specifies whether the parameter is mandatory.
    • Input: Dropdown menu (True/False).
  1. Action Buttons:
    • Save:
      • Function: Saves the parameter configuration.
    • Cancel:
      • Function: Discards changes and closes the dialog.

How to Use​

  1. Adding a New Parameter:

    • Click on "Add Parameter" from the Edit Agent screen.
    • Fill in the details in the dialog:
      • Enter the Parameter Name.
      • Select the Type from the dropdown.
      • Choose the Parameter Type from the dropdown.
      • Provide a Description for the parameter.
      • If applicable, enter acceptable values in the Enum field, separated by commas.
      • Set a Default Value if needed.
      • Indicate whether the parameter is Required by selecting True or False.
    • Click "Save" to add the parameter.

  2. Editing an Existing Parameter:

    • Click on the three vertical dots in the Action column next to the parameter and select "Edit".
    • Update the necessary details in the dialog:
      • Modify the Parameter Name if required.
      • Change the Type if necessary.
      • Update the Parameter Type if applicable.
      • Edit the Description to better explain the parameter’s purpose.
      • Adjust the Enum values if needed.
      • Change the Default Value if applicable.
      • Update the Required field to True or False as necessary.
    • Click "Save" to apply the changes.

  3. Discarding Changes:

    • If you do not wish to save the changes, click "Cancel" to close the dialog without saving.

Notes​

  • Ensure all required fields are filled out correctly before saving.
  • Use the Description field to clearly explain the purpose and usage of the parameter.
  • Enum values should be provided only if the parameter can take specific, predefined values.

This documentation should help you effectively use the Add/Edit Parameter dialog to configure parameters for your custom agents. If you have any further questions or need assistance, please refer to the help section or contact support.