Docs/Using Plugins/Function Tool Settings

Function Tool Settings

The function tool settings define how the AI identifies the Public Documents plugin, when to call it, and how search results are selected and returned. These settings apply to the plugin as a whole — not to individual documents.

Navigate to Actions → Plugins → Public Documents → Settings in the agent sidebar.


Function Name

The function name is the internal identifier the AI uses to invoke this plugin. It is generated automatically when you create the plugin instance and must be unique across all plugins configured for this agent.

Naming rules:

  • Must start with a letter.
  • May contain letters, digits, and underscores only.
  • No spaces, hyphens, or special characters.

Valid examples: get_company_policies, searchKnowledgeBase, retrieve_hr_docs

You can regenerate the name if needed. Changing it after deployment causes the AI to re-register the function on the next request.


Function Description

The description tells the AI what this plugin covers and when to call it. When a user sends a message, the AI reads this description to decide whether to invoke the plugin.

The description is automatically enriched with the names, descriptions, and any additional context of all activated documents — you do not need to list them manually.

Default behavior: The AI is instructed to always call this plugin before answering any question, treating your documents as the authoritative source over its general knowledge.

Write the description from the agent's perspective — describe the scope of content available:

Retrieve company policies, HR guidelines, and benefits documentation to answer employee questions.

Search the product knowledge base to answer questions about features, configuration, and troubleshooting.


Rules

Instructions the AI must follow when using this plugin. Use this field to enforce constraints on how the plugin is invoked and how results are used.

Common rules:

If no relevant results are found, say so clearly and do not invent an answer.
Only reference content that appears in the search results.
If the user's question is ambiguous, ask for clarification before searching.
Do not combine results from this plugin with your general knowledge.

Search Settings

Search settings control how the underlying vector search and reranking pipeline behaves. These apply globally across all activated documents.

SettingDescriptionDefault
Top Candidate CountNumber of passages fetched across all active documents before reranking.20
Max Search ResultsNumber of final passages returned to the AI after reranking.5

Top Candidate Count

Controls the size of the candidate pool that the reranker evaluates. Fetching more candidates before reranking improves recall — useful when relevant content may be spread across many documents or when queries are broad. The default of 20 is appropriate for most setups.

Increasing this value raises the quality of reranking but also increases processing cost and latency.

Max Search Results

Controls how many passages the AI receives after reranking. Lower values keep responses focused on the most relevant content. Higher values give the AI more context to work with, which helps for complex questions, but may introduce less relevant content.


Saving the Configuration

Click Save after making changes. The updated settings apply to all subsequent conversations.