integration
Словарь ↗Схема функции
Схема функции — машиночитаемое описание инструмента: имя, назначение и JSON Schema параметров, включая обязательные поля и допустимые значения. Именно её читает модель, прежде чем решить, вызывать ли что-то и как. Она выполняет две задачи сразу, поэтому её стоит писать внимательно. Это документация для читателя, который не может задать уточняющий вопрос, и одновременно контракт валидации, который ваш код применит до исполнения. Перечисления лучше свободных строк, обязательные поля лучше необязательных со значениями по умолчанию, а параметр, у которого осмысленны только три значения, должен говорить об этом в схеме, а не в описании. Типичная ошибка — схема, формально валидная и смыслово размытая. «query: string» не даёт модели представления о хорошем запросе; «query: string — полнотекстовый поиск по позициям счетов, например „неоплаченные счета за март“» даёт вызовы, которые вы реально сможете обслужить. Версионируйте схемы, как версионируете API: поле, тихо сменившее смысл, ломает каждый промпт, выучивший прежний.
Похожие термины