Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Evincere/klisk/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The WebSearch class provides web search capabilities for agents. This builtin tool is only supported with OpenAI models and allows agents to search the web for information.

​
Class Definition

from klisk.core.builtin_tools import WebSearch
Defined in: src/klisk/core/builtin_tools.py:9

​
Parameters

​
search_context_size
Literal['low', 'medium', 'high']
default:"medium"
Controls the amount of search context returned. Options:
  • "low" - Minimal search context
  • "medium" - Balanced search context (default)
  • "high" - Maximum search context

​
Usage

​
Basic Usage (String Shortcut)

from klisk import define_agent

agent = define_agent(
    model="gpt-4o",
    builtin_tools=["web_search"],
)

​
Object Form with Custom Configuration

from klisk import define_agent
from klisk.core.builtin_tools import WebSearch

agent = define_agent(
    model="gpt-4o",
    builtin_tools=[
        WebSearch(search_context_size="high")
    ],
)

​
Multiple Builtin Tools

from klisk import define_agent
from klisk.core.builtin_tools import WebSearch

agent = define_agent(
    model="gpt-4o",
    builtin_tools=[
        WebSearch(search_context_size="medium"),
        "code_interpreter",
    ],
)

​
Important Notes

The WebSearch tool is only supported with OpenAI models. Using it with non-OpenAI models will raise a ValueError.
When using the string shortcut "web_search", the default search_context_size of "medium" is used.

Build docs developers (and LLMs) love

Get started for freeTalk to us