Files
wehub-resource-sync bbfc60cd69
Publish BFCL to PyPI / build_and_publish (push) Has been cancelled
Update API Zoo Data / send-updates (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:37:27 +08:00

362 lines
13 KiB
Python

import os
import time
from typing import Any
from bfcl_eval.constants.type_mappings import GORILLA_TO_OPENAPI
from bfcl_eval.model_handler.base_handler import BaseHandler
from bfcl_eval.constants.enums import ModelStyle
from bfcl_eval.model_handler.utils import (
convert_to_tool,
default_decode_ast_prompting,
default_decode_execute_prompting,
extract_system_prompt,
format_execution_results_prompting,
retry_with_backoff,
system_prompt_pre_processing_chat_model,
)
from google import genai
from google.genai.types import (
AutomaticFunctionCallingConfig,
Content,
GenerateContentConfig,
Part,
ThinkingConfig,
Tool,
)
class GeminiHandler(BaseHandler):
def __init__(
self,
model_name,
temperature,
registry_name,
is_fc_model,
**kwargs,
) -> None:
super().__init__(model_name, temperature, registry_name, is_fc_model, **kwargs)
self.model_style = ModelStyle.GOOGLE
api_key = os.getenv("GOOGLE_API_KEY")
if not api_key:
raise ValueError(
"GOOGLE_API_KEY environment variable must be set for Gemini models"
)
self.client = genai.Client(api_key=api_key)
@staticmethod
def _substitute_prompt_role(prompts: list[dict]) -> list[dict]:
# Allowed roles: user, model
for prompt in prompts:
if prompt["role"] == "user":
prompt["role"] = "user"
elif prompt["role"] == "assistant":
prompt["role"] = "model"
return prompts
def decode_ast(self, result, language, has_tool_call_tag):
if not self.is_fc_model:
result = result.replace("```tool_code\n", "").replace("\n```", "")
return default_decode_ast_prompting(result, language, has_tool_call_tag)
else:
if type(result) is not list:
result = [result]
return result
def decode_execute(self, result, has_tool_call_tag):
if not self.is_fc_model:
result = result.replace("```tool_code\n", "").replace("\n```", "")
return default_decode_execute_prompting(result, has_tool_call_tag)
else:
func_call_list = []
for function_call in result:
for func_name, func_args in function_call.items():
func_call_list.append(
f"{func_name}({','.join([f'{k}={repr(v)}' for k, v in func_args.items()])})"
)
return func_call_list
# We can't retry on ClientError because it's too broad.
# Both rate limit and invalid function description will trigger google.genai.errors.ClientError
@retry_with_backoff(
error_message_pattern=r".*(RESOURCE_EXHAUSTED|The model is overloaded).*"
)
def generate_with_backoff(self, **kwargs):
start_time = time.time()
api_response = self.client.models.generate_content(**kwargs)
end_time = time.time()
return api_response, end_time - start_time
#### FC methods ####
def _query_FC(self, inference_data: dict):
inference_data["inference_input_log"] = {
"message": repr(inference_data["message"]),
"tools": inference_data["tools"],
"system_prompt": inference_data.get("system_prompt", None),
}
config = GenerateContentConfig(
temperature=self.temperature,
automatic_function_calling=AutomaticFunctionCallingConfig(disable=True),
thinking_config=ThinkingConfig(include_thoughts=True),
)
if "system_prompt" in inference_data:
config.system_instruction = inference_data["system_prompt"]
if len(inference_data["tools"]) > 0:
config.tools = [Tool(function_declarations=inference_data["tools"])]
return self.generate_with_backoff(
model=self.model_name,
contents=inference_data["message"],
config=config,
)
def _pre_query_processing_FC(self, inference_data: dict, test_entry: dict) -> dict:
for round_idx in range(len(test_entry["question"])):
test_entry["question"][round_idx] = self._substitute_prompt_role(
test_entry["question"][round_idx]
)
inference_data["message"] = []
system_prompt = extract_system_prompt(test_entry["question"][0])
if system_prompt:
inference_data["system_prompt"] = system_prompt
return inference_data
def _compile_tools(self, inference_data: dict, test_entry: dict) -> dict:
functions: list = test_entry["function"]
tools = convert_to_tool(functions, GORILLA_TO_OPENAPI, self.model_style)
inference_data["tools"] = tools
return inference_data
def _parse_query_response_FC(self, api_response: Any) -> dict:
tool_call_func_names = []
fc_parts = []
text_parts = []
reasoning_content = []
if (
len(api_response.candidates) > 0
and api_response.candidates[0].content
and api_response.candidates[0].content.parts
and len(api_response.candidates[0].content.parts) > 0
):
response_function_call_content = api_response.candidates[0].content
for part in api_response.candidates[0].content.parts:
# part.function_call is a FunctionCall object, so it will always be True even if it contains no function call
# So we need to check if the function name is empty `""` to determine if Gemini returned a function call
if part.function_call and part.function_call.name:
part_func_name = part.function_call.name
part_func_args = part.function_call.args
part_func_args_dict = {k: v for k, v in part_func_args.items()}
fc_parts.append({part_func_name: part_func_args_dict})
tool_call_func_names.append(part_func_name)
# Aggregate reasoning content
elif part.thought:
reasoning_content.append(part.text)
else:
text_parts.append(part.text)
else:
response_function_call_content = Content(
role="model",
parts=[
Part(text="The model did not return any response."),
],
)
model_responses = fc_parts if fc_parts else text_parts
return {
"model_responses": model_responses,
"model_responses_message_for_chat_history": response_function_call_content,
"tool_call_func_names": tool_call_func_names,
"reasoning_content": "\n".join(reasoning_content),
"input_token": api_response.usage_metadata.prompt_token_count,
"output_token": api_response.usage_metadata.candidates_token_count,
}
def add_first_turn_message_FC(
self, inference_data: dict, first_turn_message: list[dict]
) -> dict:
for message in first_turn_message:
inference_data["message"].append(
Content(
role=message["role"],
parts=[
Part(text=message["content"]),
],
)
)
return inference_data
def _add_next_turn_user_message_FC(
self, inference_data: dict, user_message: list[dict]
) -> dict:
return self.add_first_turn_message_FC(inference_data, user_message)
def _add_assistant_message_FC(
self, inference_data: dict, model_response_data: dict
) -> dict:
inference_data["message"].append(
model_response_data["model_responses_message_for_chat_history"]
)
return inference_data
def _add_execution_results_FC(
self,
inference_data: dict,
execution_results: list[str],
model_response_data: dict,
) -> dict:
# Tool response needs to be converted to Content object as well.
# One Content object for all tool responses.
tool_response_parts = []
for execution_result, tool_call_func_name in zip(
execution_results, model_response_data["tool_call_func_names"]
):
tool_response_parts.append(
Part.from_function_response(
name=tool_call_func_name,
response={
"result": execution_result,
},
)
)
tool_response_content = Content(role="user", parts=tool_response_parts)
inference_data["message"].append(tool_response_content)
return inference_data
#### Prompting methods ####
def _query_prompting(self, inference_data: dict):
inference_data["inference_input_log"] = {
"message": repr(inference_data["message"]),
"system_prompt": inference_data.get("system_prompt", None),
}
config = GenerateContentConfig(
temperature=self.temperature,
thinking_config=ThinkingConfig(include_thoughts=True),
)
if "system_prompt" in inference_data:
config.system_instruction = inference_data["system_prompt"]
api_response = self.generate_with_backoff(
model=self.model_name,
contents=inference_data["message"],
config=config,
)
return api_response
def _pre_query_processing_prompting(self, test_entry: dict) -> dict:
functions: list = test_entry["function"]
test_entry_id: str = test_entry["id"]
for round_idx in range(len(test_entry["question"])):
test_entry["question"][round_idx] = self._substitute_prompt_role(
test_entry["question"][round_idx]
)
test_entry["question"][0] = system_prompt_pre_processing_chat_model(
test_entry["question"][0], functions, test_entry_id
)
# Gemini has system prompt in a specific field
system_prompt = extract_system_prompt(test_entry["question"][0])
if system_prompt:
return {"message": [], "system_prompt": system_prompt}
else:
return {"message": []}
def _parse_query_response_prompting(self, api_response: Any) -> dict:
if (
len(api_response.candidates) > 0
and api_response.candidates[0].content
and api_response.candidates[0].content.parts
and len(api_response.candidates[0].content.parts) > 0
):
assert (
len(api_response.candidates[0].content.parts) <= 2
), f"Length of response parts should be less than or equal to 2. {api_response.candidates[0].content.parts}"
model_responses = ""
reasoning_content = ""
for part in api_response.candidates[0].content.parts:
if part.thought:
reasoning_content = part.text
else:
model_responses = part.text
else:
model_responses = "The model did not return any response."
reasoning_content = ""
return {
"model_responses": model_responses,
"reasoning_content": reasoning_content,
"input_token": api_response.usage_metadata.prompt_token_count,
"output_token": api_response.usage_metadata.candidates_token_count,
}
def add_first_turn_message_prompting(
self, inference_data: dict, first_turn_message: list[dict]
) -> dict:
for message in first_turn_message:
inference_data["message"].append(
Content(
role=message["role"],
parts=[
Part(text=message["content"]),
],
)
)
return inference_data
def _add_next_turn_user_message_prompting(
self, inference_data: dict, user_message: list[dict]
) -> dict:
return self.add_first_turn_message_prompting(inference_data, user_message)
def _add_assistant_message_prompting(
self, inference_data: dict, model_response_data: dict
) -> dict:
inference_data["message"].append(
Content(
role="model",
parts=[
Part(text=model_response_data["model_responses"]),
],
)
)
return inference_data
def _add_execution_results_prompting(
self, inference_data: dict, execution_results: list[str], model_response_data: dict
) -> dict:
formatted_results_message = format_execution_results_prompting(
inference_data, execution_results, model_response_data
)
tool_message = Content(
role="user",
parts=[
Part(text=formatted_results_message),
],
)
inference_data["message"].append(tool_message)
return inference_data