Setup Box Client

# Setup Box Client
from box_sdk_gen import DeveloperTokenConfig, BoxDeveloperTokenAuth, BoxClient

BOX_DEV_TOKEN = "your_box_dev_token"

config = DeveloperTokenConfig(BOX_DEV_TOKEN)
auth = BoxDeveloperTokenAuth(config)
box_client = BoxClient(auth)

import os
os.environ["OPENAI_API_KEY"] = "your-key"

from llama_index.core.agent.workflow import FunctionAgent
from llama_index.llms.openai import OpenAI

from llama_index.tools.box import (
    BoxSearchByMetadataToolSpec,
    BoxSearchByMetadataOptions,
)

# Define your metadata search query
# This must be done when instantiating the tool because the AI agent wont have a clue how to execute the search

# Parameters
from_ = "enterprise_" + "your_box_enterprise_id" + "." + "your_metadata_template_key"
ancestor_folder_id = "your_starting_folder_id"
query = "documentType = :docType "  # Your metadata query string
query_params = '{"docType": "Invoice"}'  # Your metadata query parameters

# Search options
options = BoxSearchByMetadataOptions(
    from_=from_,
    ancestor_folder_id=ancestor_folder_id,
    query=query,
)

box_tool = BoxSearchByMetadataToolSpec(box_client=box_client, options=options)

agent = FunctionAgent(
    tools=box_tool.to_tool_list(),
    llm=OpenAI(model="gpt-4.1"),
)

answer = await agent.run(
    f"search all documents using the query_params as the key value pair of  {query_params} "
)
print(answer)

tests/test_tools_box_search_by_metadata.py Added user message to memory: search all documents using the query_params as the key value pair of  {"docType": "Invoice"} 
=== Calling Function ===
Calling function: search with args: {"query_params":"{\"docType\": \"Invoice\"}"}
========================
I found the following documents with the query parameter "docType: Invoice":

1. Document ID: ee053400-e501-49d0-9e9f-e021bd86d9c6
   - Name: Invoice-B1234.txt
   - Size: 168 bytes
   - Created By: RB Admin
   - Created At: 2024-04-30 06:22:15

2. Document ID: 475cfee1-557a-4a3b-bc7c-18634d3a5d99
   - Name: Invoice-C9876.txt
   - Size: 189 bytes
   - Created By: RB Admin
   - Created At: 2024-04-30 06:22:17

3. Document ID: 9dbfd4ec-639f-4c7e-8045-645866e780a3
   - Name: Invoice-Q2468.txt
   - Size: 176 bytes
   - Created By: RB Admin
   - Created At: 2024-04-30 06:22:19

These are the documents matching the query parameter. Let me know if you need more information or assistance.