API F5AI

ВВЕДЕНИЕ

API F5AI облегчает использование передовых AI моделей, для улучшения и автоматизации бизнес-процессов с помощью API.

Почему стоит использовать API F5AI?

Доступность

Используя сервис F5AI, вы получаете возможность обойти ограничения, присущие доступу к API OpenAI в России, без использования VPN или других методов обхода блокировок.

Безопасность

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

Гибкость и масштабируемость

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

Удобство оплаты

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

НАЧАЛО РАБОТЫ

Получите API-ключ

Чтобы получить токен доступа F5AI, вам необходимо авторизоваться войти в https://app.f5ai.ru и перейти по адресу https://app.f5ai.ru/keys/

Введите имя ключа и выберете вендор - Open AI.

Вот и все! Теперь вы можете скопировать этот ключ и использовать наш API.

СОВЕРШЕНИЕ ЗАПРОСОВ

Отправить синхронный запрос и получить ответ от ChatGPT

🚩 Чтобы отправлять авторизованные запросы нужно получить API ключ, как это сделать написано в разделе «Начало работы»

POST

https://api.f5ai.ru/v1/chat/completions

Синхронный запрос к моделям ChatGPT

Headers

X-Auth-Token*

string

API ключ

Request Body

model*

string

ID модели чата

messages*

array

Контекст сообщений

max_tokens

number

Длина ответа (MAX 4096)

temperature

number

Креативность (от 0 до 1)

Пример запроса, который можно отправить с помощью curl:

curl https://api.f5ai.ru/v1/chat/completions \
-H "Content-Type: application/json" \
-H "X-Auth-Token: $F5AI_API_KEY" \
-d '{

	"model": "gpt-4o-mini",
	"max_tokens": 100,
	"messages": [
		{
			"role": "system",
			"content": "Твое имя Андрей."
		},
		{
			"role": "user",
			"content": "Как тебя зовут?"
		}
	]
}'

В ответ вы получите JSON-структуру с результатами обработки вашего запроса, который выглядит вот так:

{
 "id": "chatcmpl-8FheRf68Hi4pnuiRqYPHyZJr3UlAU",
 "object": "chat.completion",
 "created": 1698753407,
 "model": "gpt-4о-mini-2024-07-18",
 "choices": [
   {
     "index": 0,
     "message": {
     	"role": "assistant",
       "content": ""Меня зовут Андрей, чем я могу сегодня помочь?"
     },
     "finish_reason": "stop"
   }
 ],
 "usage": {
   "prompt_tokens": 24,
   "completion_tokens": 8,
   "total_tokens": 32,
   "prompt_cost": 0.01608,
   "completion_cost": 0.007200000000000001,
   "total_cost": 0.023280000000000002
   }
}

Если вы хотите указать чату конкретную роль, профессию или дать четкую инструкцию, то используйте следующий content:

content= [
    {
        "role": "system",
        "content": "Ты программист, отвечай на все вопросы только как программист. Твои ответы должны быть в виде кода на python или на js."
    },
    {
        "role": "user",
        "content": "Расскажи о своих навыках"
    }
]

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

 "role": "assistant",
        "content": "Я искусственный интеллект, программируемый на Python и JS. Могу помочь с написанием кода, отладкой, объяснением алгоритмов и учебой программирования.",

Возможные ошибки

Код: 400

Сообщение: Invalid key
Описание: Неверный формат ключа

Код: 404

Сообщение: Key not found
Описание: Ключ с таким id не найден

Код: 409

Сообщение: Key is revoked
Описание: Ключ был удалён

Код: 404

Сообщение: Key secret not found
Описание: Cекретный ключ API ключа отсутствует

Код: 404

Сообщение: Account not found
Описание: Аккаунт ключа не найден

Код: 402

Сообщение: Payment required
Описание: На аккаунте недостаточно средств

Код: 401

Сообщение: Unauthorized
Описание: Процесс авторизации завершился с ошибкой

Код: 405

Сообщение: Vendor not supported
Описание: Вендор ключа не поддерживает запросы через API

Код: 400

Сообщение: Model not available
Описание: Данная модель не поддерживается сервисом F5AI

СПИСОК МОДЕЛЕЙ

Получить список доступных моделей

🚩 Чтобы отправлять авторизованные запросы нужно получить API ключ, как это сделать написано в разделе «Начало работы»

Запрос списка моделей

GET

https://api.f5ai.ru/v1/models

Возвращает список всех доступных моделей

X-Auth-Token*

string

API ключ

Пример запроса

{
    "status": true,
    "response": {
        "models": [
            {
                "code": "whisper-1",
                "type": "audio",
                "available": true,
                "vision": false
            },
            {
                "code": "gpt-3.5-turbo",
                "max_tokens": 4096,
                "type": "text",
                "available": true,
                "vision": false
            },
            {
                "code": "gpt-4-turbo",
                "max_tokens": 4096,
                "type": "text",
                "available": true,
                "vision": false
            },
            {
                "code": "gpt-4o",
                "max_tokens": 4096,
                "type": "text",
                "available": true,
                "vision": true
            },
            {
                "code": "gpt-4o-mini",
                "max_tokens": 16383,
                "type": "text",
                "available": true,
                "vision": true
            },
            {
                "code": "dall-e-3",
                "type": "image",
                "available": false
            },
            {
                "code": "o1-mini",
                "type": "text",
                "available": false,
                "vision": false
            }
        ]
    }
}

Возможные ошибки

{
 "error": {
   "message": "Unauthorized",
   "type": "unauthorized_request_error",
   "param": null,
   "code": null,
 }
}

КОЛЛЕКЦИЯ ЗАПРОСОВ POSTMAN

С F5AI API можно работать с помощью подготовленной коллекции запросов Postman.

Для использования коллекции запросов Postman:

1

Войдите в свою учетную запись Postman

2

Нажмите кнопку → ^{▶ Run in Postman}

3

Нажмите Fork Collection, чтобы скопировать коллекцию запросов в свое рабочее пространство в Postman.

В открывшемся окне укажите название копии и рабочего пространства, в котором будет создана копия коллекции. Установите флажок Watch original collection, если хотите получать уведомления об изменении в оригинальной коллекции запросов.

4

Нажмите Fork Collection.

СОЗДАНИЕ ПРОМПТОВ

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

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

Способы улучшения промптов

Из-за архитектурных особенностей нейросетевые модели создают ответы, которые не точно удовлетворяют запросы, а только с наибольшей вероятностью. Создавайте промпты с учетом приведенных рекомендаций и вы значительно повысите вероятность получить подходящий ответ.

Детализация указаний

Чем более подробную инструкцию вы дадите сервису, тем выше вероятность получить ожидаемый результат. Убедитесь в этом на примере арифметической задачи.

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

Промпт:
10*10?
 
Ответ F5AI:
10

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

Промпт:
Используй десятичную систему исчисления.
Убедись, что ответ математически верен.
10*10
 
Ответ F5AI:
10 × 10 = 100

Присвоение роли

Если вы хотите изменить стиль или формулировку ответов сервиса, то добавьте в промпт ролевую модель. Так, ответы модели с ролью академика и пятилетнего ребенка будут заметно отличаться. Роли помогут модели вести разговор в заданном ключе или получить ответ, предназначенный для определенной аудитории.

Промпт:
Ты кандидат физикоматематических наук.
 
Расскажи первый закон термодинамики своими словами
 
Ответ F5AI:
Первый закон термодинамики утверждает, что энергия не может быть создана или уничтожена, она может только переходить из одной формы в другую. Это означает, что невозможно создать энергию из ничего или уничтожить ее.
 
Промпт:
Ты первоклассник.
 
Расскажи первый закон термодинамики своими словами
 
Ответ F5AI:
Первый закон термодинамики говорит о том, что теплота не может быть создана или уничтожена, она может только переходить от одного тела к другому. Это означает, что тепло всегда передается от более теплого тела к менее теплому.

Примеры в промпте

Примеры показывают модели, какой результат вы ожидаете.

Промпт без примера ответа:
 
Какой город является столицей России?

Ответ F5AI: 
Столицей России является Москва

Промпт с примерами ответов:
 
Какой город является столицей России?
Москва
Какой город является столицей Венгрии?
Будапешт
 
Какой город является столицей Пакистана?

Ответ F5AI:

Исламаба́д

Структурированный промпт

Используйте советы по улучшению ответов модели и вместе, и по отдельности.

В общем случае промпт, который использует сразу все советы, будет выглядеть так:

Если у Вас остались вопросы, пожалуйста, напишите нам на info@comf5.ru