Добавьте AI-чат в свое приложение с помощью одного вызова API

TL;DR: Публичный API-интерфейс бота aiSTAFF предоставляет разработчикам тот же механизм чата, который обеспечивает работу социальных каналов, посредством вызова REST. Вы отправляете сообщение и идентификатор пользователя, получаете ответ AI, а сервер обрабатывает за вас состояние разговора, историю и контекст.

Почему API, а не еще один виджет

Виджет веб-сайта и каналы социальных сетей охватывают большинство компаний. Разработчику, создающему продукт, нужно кое-что еще: программный доступ. API aiSTAFF Bot предоставляет доступ к движку платформы aiSTAFF, поэтому вы можете разместить AI-чат в своем собственном приложении, портале или внутреннем инструменте. Наша служба автоматизации помогает подключить ее к пользовательской сборке.

Дело в том, что вам не обязательно строить. Никакого оперативного проектирования, никакого механизма состояний диалога, никакого манипулирования контекстными окнами, никакой конфигурации поставщика модели, никакой обработки ограничений токенов. Вы вызываете конечную точку, и вам возвращается ответ.

Что предоставляет API

Поверхность специально маленькая:

• Боты. Создавайте и управляйте ИИ-ботами, каждый из которых имеет собственное описание бизнеса, базу знаний, тон, язык, а также приветствие или резервные сообщения.
• Чат. Отправьте сообщение и получите ответ в виде одного ответа в формате JSON или в потоковом режиме. Передайте идентификатор пользователя, и сервер возобновит разговор с этим пользователем, или передайте идентификатор разговора в явном виде.
• Разговоры. Создавайте, перечисляйте, сохраняйте историю или удаляйте. Сервер сохраняет и удаляет историю сообщений.
• Использование. Прочитайте использованные сообщения с учетом вашего лимита, израсходованных токенов и текущего периода.
• Ключи. Генерируйте и меняйте ключи API, которые отображаются один раз и могут быть отозваны.

Сервер поддерживает разговор

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

Потоковая передача или одиночный ответ

Для интерфейса чата ответы, которые транслируются слово за словом, кажутся живыми. API поддерживает потоковый режим через ту же конечную точку, как и виджет веб-сайта, описанный в потоковом чате AI на вашем сайте. Для серверной задачи, требующей сразу всего ответа, лучше подходит один ответ JSON. Вы выбираете за звонок.

Одна квота, один механизм

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

Кто использует API

Его используют три типа строителей. Агентство, которое хочет предложить своим клиентам чат с искусственным интеллектом под белой этикеткой. Продукт SaaS, для которого требуется помощник по поддержке внутри приложения. Компания с собственным порталом, которая хочет, чтобы ее клиенты имели тот же мозг, что и в Instagram. В каждом случае API рассматривается как еще один канал для того же AI Brain, модель описана в разделе один AI Brain, пять каналов.

Ключи и безопасность

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

С чего начать

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

Читать по теме

• aiSTAFF: один искусственный интеллект для каждого канала
• Потоковое чат AI на вашем сайте
• Добавьте представителя отдела продаж ИИ с помощью одной строки кода
• Одна квота сообщений для всех каналов
• Сравнение платформ чат-ботов с искусственным интеллектом

Часто задаваемые вопросы

Нужно ли мне самому управлять историей разговоров?

Может ли поток API отвечать?

Да. Конечная точка чата поддерживает потоковый режим для живых интерфейсов и один ответ JSON для серверной части.

Используется ли API отдельно от моих каналов?

Как аутентифицируется запрос?

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