Repository Public
1#!/usr/bin/env python32# =============================================================================3# SP BOUCHER | SOFTWARE & RESEARCH4# ARTIFICIAL INTELLIGENCE • FINANCE • ENGINEERING5# =============================================================================6#7# PROJECT METADATA8# -----------------------------------------------------------------------------9# Project : API Atlas10# File : examples/openai/tools/custom-tools/custom_tools.py11# Description : Custom tool with a regex grammar (CFG) — the model must12# answer via the tool with `yes` or `no`.13# Module : examples14# Repository : https://git.spboucher.ai/doc-api15# Created : 2026-09-1816# Last Modified : 2026-09-1817#18# =============================================================================19# AUTHOR & PROFESSIONAL AFFILIATION20# =============================================================================21#22# Author : Simon-Pierre Boucher23# Position : Professor of Finance24# Institution : Université du Québec en Outaouais (UQO)25# Department : Département des sciences administratives26# Organization : SP Boucher27#28# Website : https://spboucher.ai29# Git : https://git.spboucher.ai30#31# =============================================================================32# OFFICIAL CONTACT DIRECTORY33# =============================================================================34#35# General : info@spboucher.ai36# Professional : contact@spboucher.ai37# Direct : simon@spboucher.ai38# Research : research@spboucher.ai39# Development : dev@spboucher.ai40# Support : support@spboucher.ai41# Security/Admin : admin@spboucher.ai42# Notifications : notifications@spboucher.ai43#44# Preferred Contact: contact@spboucher.ai45#46# =============================================================================47# COPYRIGHT & INTELLECTUAL PROPERTY48# =============================================================================49#50# Copyright (c) 202651# Simon-Pierre Boucher52#53# All rights reserved where applicable.54#55# This file is governed by the applicable project license,56# copyright notices, institutional agreements and relevant law.57#58# Unless expressly authorized by the applicable license or59# rights holder, copying, redistribution, sublicensing,60# publication and commercial exploitation are not permitted.61#62# Existing third-party rights and notices remain unaffected.63#64# =============================================================================65# CONFIDENTIALITY & SECURITY66# =============================================================================67#68# Classification : Public69# Distribution : Public repository; use is governed by the project license70# Security Contact : admin@spboucher.ai71#72# Access to this source does not independently grant permission73# to redistribute or disclose confidential materials.74#75# Do not embed credentials, private keys, access tokens,76# certificates or confidential personal information.77#78# =============================================================================79# LICENSE & MAINTENANCE80# =============================================================================81#82# License : None specified (no license file in this repository)83# Maintainer : Simon-Pierre Boucher84# Technical Contact: dev@spboucher.ai85#86# =============================================================================87# END OF SP BOUCHER SOURCE HEADER88# =============================================================================8990"""Custom tool with a regex grammar (CFG) — the model must answer via the tool with `yes` or `no`.91STATUS: LIVE_VERIFIED 2026-09-18 (gpt-5.4-nano -> custom_tool_call input='yes'). Run: .venv/bin/python examples/openai/tools/custom-tools/custom_tools.py92"""93import sys94from pathlib import Path95ROOT = Path(__file__).resolve().parents[4]; sys.path.insert(0, str(ROOT))96from scripts.live import load_env, log_request; load_env()97from openai import OpenAI98client = OpenAI(); MODEL = "gpt-5.4-nano"99100tool = {"type": "custom", "name": "answer_yes_no", "description": "Reply with exactly yes or no.",101 "format": {"type": "grammar", "syntax": "regex", "definition": r"^(yes|no)$"}}102r = client.responses.create(model=MODEL, input="Is 2+2 equal to 4? Use the tool.", tools=[tool], max_output_tokens=32,103 tool_choice={"type": "custom", "name": "answer_yes_no"}, reasoning={"effort": "low"})104log_request("openai", "POST", "/v1/responses", 200, 0.0001, "custom_tools.py regex grammar")105call = next(i for i in r.output if i.type == "custom_tool_call")106print("custom_tool_call:", call.name, repr(call.input), call.call_id)107assert call.input in ("yes", "no")108