Полное руководство по API ChatGPT

Выпустив свой API, OpenAI открыл возможности ChatGPT для всех. Теперь вы можете легко интегрировать мощь ChatGPT в свое приложение.

Выполните эти начальные шаги, чтобы начать работу, независимо от того, хотите ли вы интегрировать ChatGPT в существующее приложение или разработать с его помощью новые приложения.

Получение доступа к ключам API OpenAI

Чтобы начать использовать API ChatGPT, сначала необходимо получить ключи API OpenAI. Зарегистрируйтесь или авторизуйтесь на официальном OpenAI Платформа.

После того, как вы вошли в систему, нажмите кнопку Личный вкладку в правом верхнем углу. Выберите Просмотр ключей API вариант из раскрывающегося списка, и вы попадете на ключи API страница. Нажать на Создать новый секретный ключ кнопку для генерации ключа API.

Вы больше не сможете просмотреть ключ, поэтому храните его в безопасном месте.

Код, используемый в этом проекте, доступен в Репозиторий GitHub и вы можете использовать его бесплатно по лицензии MIT.

Как использовать API ChatGPT

API OpenAI ГПТ-3,5-турбо и gpt-4 модели — это те же модели, которые используют ChatGPT и ChatGPT+ соответственно. Эти мощные модели способны понимать и генерировать текст на естественном языке.

Обратите внимание, что ChatGPT API — это общий термин, который относится к API OpenAI, которые используют модели на основе GPT для разработки чат-ботов, включая ГПТ-3,5-турбо и gpt-4 модели.

API ChatGPT в первую очередь оптимизирован для чата, но он также хорошо работает для задач завершения текста. ГПТ-3,5-турбо и gpt-4 модели мощнее и дешевле предыдущих моделей ГПТ-3. Однако на момент написания вы не можете настроить модели GPT-3.5. Вы можете настроить только базовые модели GPT-3, т.е. Да Винчи, кюри, ада, и капуста.

На момент написания API GPT-4 находится в списке ожидания. Но модели GPT-3.5 доступны всем, поэтому в этой статье мы будем использовать их. Хотя, вы можете использовать GPT-4 прямо сейчас путем обновления до ChatGPT+.

Использование ChatGPT API для завершения чата

Вам нужно настроить модель чата, чтобы подготовить ее к вызову API. Это можно лучше понять с помощью примера:

Импортировать опенай
openai.api_key = "ВАШ_API_KEY"
завершение = опенай. ЧатЗавершение.создать(
 модель = "ГПТ-3,5-турбо",
 температура = 0.8,
 макс_токены = 2000,
 сообщения = [
 {"роль": "система", "содержание": «Ты забавный комик, который рассказывает анекдоты папе».},
 {"роль": "пользователь", "содержание": «Напиши анекдот про папу, связанный с числами».},
 {"роль": "помощник", "содержание": "В: Как сделать 7 четным? A: Уберите s."},
 {"роль": "пользователь", "содержание": «Напишите что-нибудь, связанное с программистами».}
 ]
)
печать (завершение.выбор[0].сообщение)

Выполнение этого кода приводит к следующему выводу:

Приведенный выше код демонстрирует вызов API ChatGPT с использованием Python. Обратите внимание, что модель смогла понять контекст («отцовская шутка») и тип ответа (форма вопросов и ответов), который мы ожидали, даже если мы не упомянули это явно в последнем запросе пользователя.

Таким образом, при создании приложений вы можете заранее указать контекст, и модель соответствующим образом адаптируется к вашим требованиям.

Здесь наиболее важной частью является Сообщения параметр, который принимает массив объектов сообщения. Каждый объект сообщения содержит роль и содержание. Вы можете предоставить три типа ролей объектам сообщения:

• система: устанавливает контекст и поведение помощника.
• пользователь: Используется, чтобы давать инструкции помощнику. Обычно он создается конечным пользователем. Но вы, как разработчик, также можете заранее предоставить потенциальным пользователям подсказки.
• помощник: мы заранее предоставляем помощнику некоторую информацию, чтобы он дал нам ответ, который мы ожидаем от API.

Вы можете дополнительно настроить температура и max_tokens параметры модели, чтобы получить результат в соответствии с вашими требованиями.

Чем выше температура, тем выше случайность вывода, и наоборот. Если вы хотите, чтобы ваши ответы были более сфокусированными и детерминированными, выберите более низкое значение температуры. И если вы хотите, чтобы это было более креативно, выберите более высокое значение. Значение температуры находится в диапазоне от 0 до 2.

Как и ChatGPT, его API также имеет ограничение на количество слов. Использовать max_tokens параметр для ограничения длины ответов. Однако установка более низкого max_tokens значение может вызвать потенциальные проблемы, поскольку оно может отключить вывод на полпути. На момент написания ГПТ-3,5-турбо модель имеет лимит токенов 4096, в то время как gpt-4 модель имеет ограничение в 8 192 токена.

Вы можете дополнительно настроить модель, используя другие параметры, предоставленные OpenAI.

Использование ChatGPT API для завершения текста

Помимо задач завершения чата, ГПТ-3,5-турбо модель также хорошо справляется с завершением текста. Он превосходит предыдущий текст-davinci-003 модели и стоит всего одну десятую от ее стоимости.

В следующем примере показано, как можно настроить ChatGPT API для завершения текста:

Импортировать опенай
openai.api_key = "ВАШ_API_KEY"
завершение = опенай. ЧатЗавершение.создать(
 модель = "ГПТ-3,5-турбо",
 температура = 0.8,
 макс_токены = 2000,
 сообщения = [
 {"роль": "система", "содержание": «Вы поэт, который создает стихи, которые вызывают эмоции».},
 {"роль": "пользователь", "содержание": «Напишите короткое стихотворение для программистов».}
 ]
)
печать (завершение.выбор[0].сообщение.содержимое)

Вам даже не нужно указывать системную роль и ее содержимое. Предоставление только пользовательского приглашения сделает всю работу за вас.

сообщения = [
 {"роль": "пользователь", "содержание": «Напишите короткое стихотворение для программистов».}
]

Запуск приведенного выше кода сгенерирует стихотворение для программистов:

Формат ответа ChatGPT API

API ChatGPT отправляет ответ в следующем формате:

Вам также необходимо извлечь ответ помощника, который хранится в содержание.

Создание приложений с использованием ChatGPT API

Вы можете напрямую использовать конечную точку API или опенай Библиотека Python/Node.js для начала создания приложений на базе ChatGPT API. Помимо официального опенай библиотеку, вы также можете разрабатывать приложения, используя поддерживаемые сообществом библиотеки, рекомендованные OpenAI.

Однако OpenAI не проверяет безопасность этих поддерживаемых сообществом библиотек, поэтому лучше либо напрямую использовать конечную точку API, либо использовать официальную опенай Библиотека Python/Node.js.

Способ 1: использование конечной точки API

Вам необходимо использовать /v1/chat/completions конечная точка для использования ГПТ-3,5-турбо и gpt-4 модели.

Импортировать Запросы
openai.api_key = "ВАШ_API_KEY"
URL = " https://api.openai.com/v1/chat/completions"
полезная нагрузка = {
"модель": "ГПТ-3,5-турбо",
"температура": 1.0,
"Сообщения": [
 {"роль": "система", "содержание": f"Вы помощник, который рассказывает любой случайный и очень короткий забавный факт об этом мире."},
 {"роль": "пользователь", "содержание": f"Напишите забавный факт о программистах".},
 {"роль": "помощник", "содержание": f"Программисты пьют много кофе!"},
 {"роль": "пользователь", "содержание": f"Напишите один, связанный с языком программирования Python."}
 ]
}
заголовки = {
"Тип содержимого": "приложение/json",
"Авторизация": f"Предъявитель {openai.api_key}"
}
ответ = запросы. сообщение (URL, заголовки = заголовки, json = полезная нагрузка)
ответ = ответ.json()
распечатать (ответ[«выбор»][0]['сообщение']['содержание'])

Приведенный выше пример кода демонстрирует, как вы можете напрямую использовать конечную точку для выполнения вызова API с помощью Запросы библиотека.

Сначала назначьте ключ API переменной. Затем вам нужно указать имя модели для модель параметр полезная нагрузка объект. После этого мы предоставили историю разговора Сообщения параметр.

Здесь мы сохранили более высокий температура значение, чтобы наш ответ был более случайным и, следовательно, более творческим.

Вот вывод ответа:

Обратите внимание, что есть некоторые проблемы с ChatGPT OpenAI, поэтому вы также можете получить оскорбительные или предвзятые ответы от его API.

Способ 2: использование официальной библиотеки openai

Установите опенай Библиотека Python с использованием pip:

пип установить опенай

Теперь вы готовы генерировать текст или завершение чата.

Импортировать опенай
openai.api_key = "ВАШ_API_KEY"
ответ = опенай. ЧатЗавершение.создать(
 модель = "ГПТ-3,5-турбо",
 температура = 0.2,
 макс_токены = 1000,
 сообщения = [
 {"роль": "пользователь", "содержание": «Кто выиграл чемпионат мира по футболу 2018 года?»}
 ]
)
распечатать (ответ[«выбор»][0]['сообщение']['содержание'])

В этом коде мы предоставили только одно приглашение пользователя. Мы сохранили значение температуры на низком уровне, чтобы реакция была более детерминированной, а не творческой.

Вы получите следующий ответ после запуска кода:

Ответы ChatGPT могут показаться волшебными и могут заставить любого задуматься как работает ChatGPT. Но за кулисами он поддерживается языковой моделью Generative Pre-trained Transformer (GPT), которая выполняет всю тяжелую работу.

Создавайте приложения следующего поколения с помощью ChatGPT API

Вы узнали, как настроить ChatGPT API. ChatGPT API открыл вам и разработчикам по всему миру возможности для создания инновационных продуктов, использующих мощь ИИ.

Вы можете использовать этот инструмент для разработки таких приложений, как авторы историй, переводчики кода, авторы электронной почты, генераторы маркетинговых копий, обобщающие тексты и т. д. Ваше воображение — это предел для создания приложений, использующих эту технологию.

Помимо ChatGPT API, вы также можете использовать другие модели OpenAI для разработки интересных приложений.