Виклик функцій в API OpenAI

Виклик функцій дає змогу підключати моделі OpenAI до зовнішніх інструментів і систем. Це корисно для багатьох завдань, зокрема для розширення можливостей ШІ-помічників і глибокої інтеграції ваших застосунків із великими мовними моделями.

Докладніше читайте в нашому посібнику з виклику функцій для розробників.

У червні 2024 року ми запустили структуровані результати. Для підтримуваних моделей і конфігурацій запитів, коли модель генерує виклик функції, параметр strict: true у визначенні функції гарантує відповідність згенерованих аргументів наданій схемі за умови, що вона використовує підтримувану підмножину JSON Schema й відповідає вимогам суворого режиму. Запити з непідтримуваними або невідповідними схемами відхиляються з повідомленням про помилку.

У жовтні 2024 року ми запустили функцію «Створити будь-що», яка дає розробникам змогу описати функцію, безпосередньо вставити її опис або свій код і згенерувати дійсну схему функції. Докладніше про функцію «Створити будь-що» читайте в цій статті довідкового центру

Як використовувати виклик функцій?

Виклик функцій корисний для багатьох сценаріїв використання, як-от:

• Надання асистентам змоги отримувати дані:

• Надання асистентам змоги виконувати дії:

• Надання асистентам змоги виконувати обчислення:

• Побудова насичених робочих процесів:

• конвеєр вилучення даних, який отримує необроблений текст, потім перетворює його на структуровані дані та зберігає в базі даних.

Виклик функцій підтримується в API Responses, який об’єднує можливості, що раніше були розділені між API завершення чатів і API Assistants.

Як використовувати режим JSON?

Коли режим JSON увімкнено, гарантується, що результат моделі буде дійсним JSON, за винятком деяких граничних випадків, які слід виявляти й обробляти належним чином.

Щоб запросити режим JSON за допомогою API завершення чатів, установіть response_format на { "type": "json_object" } у підтримуваних моделях. В API Responses установіть text.format на { "type": "json_object" }, наприклад text: { "format": { "type": "json_object" } }, де це застосовно. У будь-якому з API режим JSON працює лише тоді, коли виконано передумови щодо моделі, повідомлення й інструмента (наприклад, модель підтримує json_object, розмова містить інструкції створювати JSON, а будь-які обмеження інструментів сумісні). Принаймні одне повідомлення запиту або вхідне повідомлення в ефективному контексті введення має містити json у формі без урахування регістру, як-от JSON, json або Json; інакше API поверне помилку. У Responses саме лише поле інструкцій верхнього рівня не проходить цю перевірку. Коли виклик функцій використовується в сумісних моделях або шляхах, обмеження JSON автоматично застосовуються до аргументів виклику функції; несумісні моделі або комбінації інструмента й формату відповіді можуть бути відхилені або не використовувати вибірку з обмеженнями JSON.

Важливі примітки:

• Під час використання режиму JSON ви завжди маєте наказати моделі створювати JSON через певне повідомлення в розмові, наприклад через системне повідомлення. Якщо не додати явну інструкцію генерувати JSON, модель може створювати нескінченний потік пробілів, а запит може виконуватися безперервно, доки не досягне ліміту токенів. Щоб ви не забули про це, режим JSON відхиляє запити, якщо відповідні вхідні повідомлення або інструкції не містять слова json у будь-якій формі, без урахування регістру.

• Режим JSON не гарантує, що результат відповідатиме певній схемі, а лише що він є дійсним і аналізується без помилок. Використовуйте структуровані результати, щоб забезпечити відповідність вашій схемі, або, якщо це неможливо, бібліотеку валідації та, за потреби, повторні спроби, щоб результат відповідав бажаній схемі.

• Ваш застосунок має виявляти й обробляти граничні випадки, через які результат моделі може бути неповним об’єктом JSON (див. нижче)