This guide explains how to create, configure, and integrate custom AI tools within the Discourse AI plugin, enabling administrators to extend the bot’s capabilities with user-defined JavaScript functions.
Required user level: Administrator
Summary
This documentation covers:
- Creating a new custom AI tool
- Configuring tool parameters and scripts
- Available APIs for tool scripts
- Integrating custom tools with AI personas
- Testing and troubleshooting custom tools
Creating a new custom AI tool
To create a new AI tool:
- Navigate to Admin Panel > Plugins > Discourse AI > Tools
- Click “New Tool” (you can use existing presets to learn about options)
- Fill in the following fields:
- Name: The name of the tool as presented to the LLM
- Description: The description of the tool as presented to the LLM
- Summary: Summary of what tool does to assist users (displayed in details)
- Parameters: Define the inputs your tool needs as presented to LLM
- Script: The JavaScript code that powers your tool
- Click “Save”
Configuring tool scripts
Available APIs
Your tool scripts have access to the following APIs:
-
HTTP Requests:
http.get(url, options) http.post(url, options)Use these to interact with external services. You can use
optionsto specify HTTP headers:http.get(url, { headers: { Auth: "some value" } }) http.post(url, { headers: { Auth: "some value", body: "some body" } }) http.patch(url, { headers: { Auth: "some value", body: "some body" } }) http.delete(url, { headers: ...}) http.put(url, { headers: ... , body: ...}) -
LLM (Language Model) Integration:
llm.truncate(text, length)This allows you to manipulate text within the AI model’s token limits.
-
Custom upload integration (RAG)
index.search(query, { filenames: options, limit: max_fragments_optional }) -
Upload creation support
upload.create(filename, base_64_content) -
Execution chain control
chain.setCustomRaw(raw) - sets the body of the post in the chain.
Required functions
Your script must implement:
-
invoke(params): The main function that executes when the tool is called
It may optionally implement:
-
details(): (Optional) Provides additional information about the tool’s execution
Example script:
function invoke(params) {
let result = http.get("https://api.example.com/data?query=" + params.query);
return JSON.parse(result.body);
}
function details() {
return "Fetched data from Example API";
}
Limitations and security
- Execution Timeout: Tools have a default timeout of 2 seconds
- HTTP Requests: Maximum of 20 requests per tool execution
- Sandboxed Environment: No access to server file system or Ruby libraries
Testing your tool
You should test any tool you build to ensure the results the LLM will be provided with match your expectations.
Integrating tools with AI personas
To add your custom tool to an AI Persona:
- Go to Admin Panel > Plugins > Discourse AI > Personas
- Edit an existing persona or create a new one
- In the “Tools” section, you’ll see your custom tools listed alongside built-in tools
- Select your custom tool to add it to the persona
Custom tools in action
Once you provide the custom tool to your LLM it can use it to enhance the conversation.
Troubleshooting
If your tool isn’t working as expected:
- Use the Test interface to ensure it behaves as expected for your inputs.
- Ensure your group is in
ai_bot_debugging_allowed_groups. Members of this group have full access to the bot transcripts; you can view the AI logs there. - If anything unexpected is happening, visit
https://SITENAME/logsto check for errors.
Additional resources
Last edited by @sam 2024-11-27T00:22:27Z
Last checked by @hugh 2024-08-06T02:00:12Z
Check document
Perform check on document:
