Недавно компания Postman выпустила подробный контрольный список и руководство для разработчиков по созданию API, готовых к работе с ИИ. В нём подчёркивается простая истина: даже самые мощные модели ИИ настолько хороши, насколько хороши данные, которые они получают, а эти данные поступают через ваши API. Если ваши конечные точки (endpoints) непоследовательны, неясны или ненадёжны, модели тратят время на исправление неверных входных данных вместо того, чтобы выдавать ценную информацию.
План действий от Postman
План действий от Postman основан на многолетнем опыте и содержит практические шаги, которые помогают командам сделать свои API предсказуемыми, машиночитаемыми и надёжными для рабочих нагрузок ИИ.
Почему это важно?
В мире, где покупки, сравнение опций и взаимодействие со службами будут осуществлять не люди, а агенты, API должны развиваться. В отличие от разработчиков, агенты не могут компенсировать недостатки в документации или неоднозначность поведения. Они полагаются на стандартизированные шаблоны и автоматически генерируемую документацию, которая синхронизируется со схемой.
Цель проста: создать API, которые люди и агенты ИИ могли бы понимать мгновенно, чтобы ваши системы могли масштабироваться эффективнее и полностью раскрыть свой потенциал.
Машиночитаемые метаданные
Люди могут вывести недостающие детали из расплывчатых документов API, но агенты ИИ не могут — они полностью полагаются на явные, машиночитаемые метаданные. Вместо того чтобы сказать «эта конечная точка возвращает предпочтения пользователя», API, готовый к работе с ИИ, должен определить всё: тип запроса, схему параметров, структуру ответа и определения объектов.
Богатая семантика ошибок
Разработчики могут интерпретировать расплывчатые ошибки вроде «Что-то пошло не так», но агенты ИИ не могут — им нужны точные, структурированные указания. API, готовые к работе с ИИ, должны чётко указывать, что, почему и как исправить.
Возможности самоанализа
Чтобы быть готовыми к работе с ИИ, API должны выйти за рамки ориентированной на человека расплывчатой документации. В отличие от разработчиков, которые могут вывести недостающие детали, используя контекст и соглашения RESTful, агенты ИИ полагаются исключительно на структурированные данные для планирования и выполнения.
Согласованные шаблоны именования
Системы ИИ полагаются на согласованные шаблоны, поэтому предсказуемые соглашения об именах значительно упрощают понимание и навигацию по вашему API. Когда конечные точки и поля следуют чётким, единообразным структурам, ИИ может вывести отношения и поведение без догадок.
Предсказуемое поведение
Агентам ИИ нужна строгая согласованность — одни и те же входные данные должны всегда давать одинаковые структуры, форматы и поля. Люди могут устранять неполадки в несогласованных ответах, используя интуицию, но ИИ может только учиться на предоставленных вами шаблонах.
Надлежащая документация
Хорошая документация — это не просто опция для API, готовых к работе с ИИ, это единственный способ, с помощью которого агенты могут учиться и надёжно взаимодействовать с вашей системой.
Надёжность и скорость
Агенты ИИ действуют как организаторы, делая быстрые и часто параллельные вызовы API. Поэтому скорость и надёжность вашего API напрямую влияют на их производительность.
Обнаруживаемость
Люди могут отслеживать недостающие API через вики, чаты, код или интуицию, но агенты ИИ не могут. Если API не опубликован чётко со структурированными, доступными для поиска метаданными, для них он просто не существует.
Статья «How to Create AI-ready APIs?» впервые появилась на сайте MarkTechPost.
1. Какие основные проблемы могут возникнуть при работе с API, которые не готовы к использованию с ИИ?
Ответ: основные проблемы включают непоследовательность, неясность и ненадёжность конечных точек API. Это приводит к тому, что модели ИИ тратят время на исправление неверных входных данных вместо того, чтобы выдавать ценную информацию.
2. Почему машиночитаемые метаданные важны для работы с ИИ?
Ответ: машиночитаемые метаданные важны, потому что агенты ИИ не могут вывести недостающие детали из расплывчатых документов API. Они полагаются на явные, структурированные данные для планирования и выполнения задач.
3. Какие аспекты API необходимо учитывать для обеспечения согласованности и предсказуемости при работе с ИИ?
Ответ: для обеспечения согласованности и предсказуемости необходимо учитывать следующие аспекты:
* согласованные шаблоны именования;
* предсказуемое поведение (одни и те же входные данные должны всегда давать одинаковые структуры, форматы и поля);
* надёжная и быстрая работа API.
4. Почему хорошая документация важна для API, готовых к работе с ИИ?
Ответ: хорошая документация важна, потому что агенты ИИ полагаются на структурированные данные для обучения и взаимодействия с системой. Чёткая и понятная документация помогает агентам ИИ лучше понимать и использовать API.
5. Почему скорость и надёжность API важны для агентов ИИ?
Ответ: скорость и надёжность API важны, потому что агенты ИИ действуют как организаторы, делая быстрые и часто параллельные вызовы API. Если API работает медленно или нестабильно, это может снизить производительность агентов ИИ.