PaisKnowledgeBaseIndexSearchToolLink

PaisKnowledgeBaseIndexSearchToolLink

A link to an internal PAIS knowledge base index search tool with search-specific configuration.

This extends GenericToolLink with additional search parameters (top_n, similarity_cutoff). PAIS search tools can be linked either as GenericToolLink (without search configuration) or as PaisKnowledgeBaseIndexSearchToolLink (with search configuration).

JSON Example

{
    "link_type": "string",
    "tool_id": "string",
    "top_n": 0,
    "similarity_cutoff": "number",
    "force_static_execution": false
}

string

link_type

Required  

Type of tool link, which is always PAIS_KNOWLEDGE_BASE_INDEX_SEARCH_TOOL_LINK for PAIS search tools.

string As uuid As uuid

tool_id

Required  

A UUID of a tool to be used by the agent.

integer

top_n

Required  

Constraints: minimum: 1

Number of top results to retrieve when using this tool for search.

number

similarity_cutoff

Optional

Constraints: minimum: 0 default: 0

Minimum similarity score for search results when using this tool.

boolean

force_static_execution

Optional

Force execution of this tool statically without relying on the LLM to decide if/when/how to invoke the tool.