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 FileSearch class provides semantic file search capabilities for agents using vector stores. This builtin tool is only supported with OpenAI models and requires vector store IDs to be configured.

​
Class Definition

from klisk.core.builtin_tools import FileSearch
Defined in: src/klisk/core/builtin_tools.py:24

​
Parameters

​
vector_store_ids
list[str]
default:"[]"
required
List of vector store IDs to search through. This parameter is required and must contain at least one vector store ID.Example: ["vs_abc123", "vs_def456"]
​
max_num_results
int | None
default:"None"
Maximum number of search results to return. When None, the provider’s default limit is used.

​
Usage

​
Basic Usage with Vector Store IDs

from klisk import define_agent
from klisk.core.builtin_tools import FileSearch

agent = define_agent(
    model="gpt-4o",
    builtin_tools=[
        FileSearch(vector_store_ids=["vs_abc123"])
    ],
)

​
Multiple Vector Stores

from klisk import define_agent
from klisk.core.builtin_tools import FileSearch

agent = define_agent(
    model="gpt-4o",
    builtin_tools=[
        FileSearch(vector_store_ids=[
            "vs_abc123",
            "vs_def456",
            "vs_ghi789"
        ])
    ],
)

​
Custom Max Results

from klisk import define_agent
from klisk.core.builtin_tools import FileSearch

agent = define_agent(
    model="gpt-4o",
    builtin_tools=[
        FileSearch(
            vector_store_ids=["vs_abc123"],
            max_num_results=10
        )
    ],
)

​
Multiple Builtin Tools

from klisk import define_agent
from klisk.core.builtin_tools import FileSearch

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

​
Important Notes

The FileSearch tool is only supported with OpenAI models. Using it with non-OpenAI models will raise a ValueError.
Unlike other builtin tools, FileSearch cannot be used with the string shortcut "file_search". You must use the object form with vector_store_ids configured:
# This will raise an error:
builtin_tools=["file_search"]

# Use this instead:
builtin_tools=[FileSearch(vector_store_ids=["vs_abc123"])]
The vector_store_ids parameter must contain at least one valid vector store ID, or a ValueError will be raised at runtime.

Build docs developers (and LLMs) love

Get started for freeTalk to us