Zendesk

ZendeskTools enable an Agent to access Zendesk API to search for articles.

Prerequisites

The following example requires the requests library and auth credentials.

1uv pip install -U requests

1export ZENDESK_USERNAME=***
2export ZENDESK_PW=***
3export ZENDESK_COMPANY_NAME=***

Example

The following agent will run seach Zendesk for "How do I login?" and print the response.

1from kern.agent import Agent
2from kern.tools.zendesk import ZendeskTools
3
4agent = Agent(tools=[ZendeskTools()])
5agent.print_response("How do I login?", markdown=True)

Toolkit Params

Parameter	Type	Default	Description
`username`	`str`	-	The username used for authentication or identification purposes.
`password`	`str`	-	The password associated with the username for authentication purposes.
`company_name`	`str`	-	The name of the company related to the user or the data being accessed.
`enable_search_zendesk`	`bool`	`True`	Enable the search Zendesk functionality.
`all`	`bool`	`False`	Enable all functionality.

Toolkit Functions

Function	Description
`search_zendesk`	This function searches for articles in Zendesk Help Center that match the given search string.

Developer Resources

View Tools