Using agent tools

Creating agent tools

You can access the agent tools via the Administrator home screen.

To access agent tools:

1. Select the Agents tile on the Administrator home screen.

   

2. Select the Tools tab.

   

3. Select Create New.

   

4. You’re presented with the available Tool Type options. Select the relevant Tool Type, and complete the subsequent form.

Query Workday

This option allows the assistant to retrieve current information directly from Workday, based on what your organization has configured and permitted.

• Select Query Workday.

  

• Complete the following form:

  

  • Title: Create a memorable title for your agent tool
  • Description: Provide a clear description that informs AI selection of your agent tool
  • Agent inputs: Add the inputs required for this tool. These are the values collected or used by your agent during execution:

  

  • Label: Create a memorable label for your agent input
  • Description: Provide a clear description of your agent input
  • Type:
    • Text
    • Number
    • Boolean
    • Date
    • Array
  • Required: Check box
  • Create a literal: Check box
  • Delete icon: Delete your agent input
  • Add icon: Add another agent input

• End-user display:

  

  • Icon: Search for/select the appropriate icon for your end-user display
  • Type of action:
    • Fetch
    • Transact
    • Update
    • Create
  • Text: Enter the message that is shown to end users while your tool is running. You can include Agent Input tokens to display dynamic values, e.g., type @ to insert a token.
    • Token:
      • User Context()
      • User Properties()
      • Workflow Data()
      • Literal()
  • Pre query: Run an additional query to resolve a human-readable label to an internal ID value, which you can then use in your main query

• Workday:

  

  • Connection: Select workday connection test check
  • Protocol:
    • Workday Query Language (WQL)
    • REST
    • SOAP
  • WQL statement:
    • Token:
      • User Context()
      • User Properties()
      • Workflow Data()
      • Literal()

• Results filtering: Add optional filters to remove results you don't want

  

  • Field: Provide a relevant field name
  • Operator:
    • Equals
    • Not Equals
    • Contains
    • Not Contains
    • Greater Than
    • Less Than
  • Value:
  • Token: Insert a field or function
    • String To Boolean()
    • String To Number()
  • Case-insensitive: Check box
  • Delete icon: Delete your agent input
  • Add icon: Add another agent input

• Filter logic:
  • And
  • Or
• Pre item enrichment: Check box, enrich each result with data from a secondary query
  • Workday:

• Path to items: For example, data[].organizationAssignments[]
  • Per item WQL statement:
    • Token: Item - Id and click Save

3. Select Save.

   

4. A confirmation message appears, stating that your tool has been created.

   

Query or edit Applaud data

This option lets the assistant retrieve information from Applaud through approved API calls.

• Select Query or edit applaud data.

  

• Complete the following form:

  

  • Title: Create a memorable title for your agent tool
  • Description: Provide a clear description that informs AI selection of your agent tool

  • Agent inputs: Add the inputs required for this tool. These are the values collected or used by your agent during execution:

    

    • Label: Create a memorable label for your agent input
    • Description: Provide a clear description of your agent input
    • Type: Text, Number, Boolean, Date
    • Required: Check box
    • Delete icon: Delete your agent input
    • Add icon: Add another agent input

  • End-user display:

    

    • Icon: Select a relevant icon for your end-user display
    • Type of action: Fetch, Transact, Update, Create
    • Text: Enter the message that is shown to end users while your tool is running. You can include Agent Input tokens to display dynamic values, e.g., type @ to insert a token.
      • Token: Insert a field or function

  • Applaud data model:

    

    • Model:
      • User
      • ChatbotDailyAggregationStats
      • ChatbotSessionFeedbackStats
      • User reaction
      • Holiday calendar
      • Holiday calendar event
    • Action:
      • Retrieve (GET)
      • Search (GET)
      • Create (POST)
      • Update (PATCH)
      • Delete (DELETE)

3. Select Save.

   

4. A confirmation message appears, stating that your tool has been created.

   

Using an agent tool

To use an agent tool:

1. Select the Agents block on the Admin home screen.

   

2. Select the Tools tab.

   

3. Select an existing Agent.

   

4. From here, you can access the following tabs:

   

• Agent settings: interact with the agent's name, description, avatar, and conversation starters.
• Conversations: view the conversation history of your agent.
• Feedback: view detailed feedback history, including the associated thumbs-up/thumbs-down metrics.

Editing or deleting an agent tool

To edit or delete an existing agent tool:

1. Select the Agents block on the Administrator home screen.

   

2. Select the Tools tab.

   

3. Select one of the existing Tools.

   

4. Select the block options menu.

   

5. Select:
   • Edit, make your relevant changes, and Update.
   • Delete and OK to confirm your deletion.