Header Ads Widget

Ticker

6/recent/ticker-posts

Hacer que los portales de desarrolladores sean parlanchines con el bot OpenAPI

Los chatbots impulsados ​​por IA están ganando popularidad en todos los ámbitos. No solo son más asequibles que los agentes humanos, sino que también están presentes cuando los necesita. Afortunadamente, las cosas han avanzado mucho desde los días de Clippy, BonziBuddy y otros asistentes virtuales. Ahora, los chatbots pueden comprender y responder a las consultas mejor que nunca.
Entonces, ¿por qué no crear un chatbot que pueda responder preguntas sobre casi cualquier API? Técnicamente, todo lo que se necesitaría es colocar una capa de procesamiento de lenguaje natural sobre una especificación de OpenAPI. Bueno, eso es precisamente lo que ha hecho un equipo de investigadores. El resultado es OpenAPI Bot , y en este artículo lo revisaremos.

¿Qué es OpenAPI Bot?

OpenAPI Bot es una herramienta novedosa que permite a los desarrolladores aprender sobre las API web hablando con un chatbot. El proyecto de código abierto, creado por tres investigadores de la Universidad Abierta de Cataluña, se lanzó por primera vez en Github en julio de 2019.
OpenAPI Bot funciona consumiendo un archivo de especificación de OpenAPI para la API en cuestión. Dado que muchas API web síncronas ya usan este lenguaje para describirse a sí mismas, OpenAPI Bot es otra opción en la larga lista de herramientas basadas en especificaciones para permitir la adopción de API.

Cómo utilizar OpenAPI Bot

La página de inicio del proyecto presenta una implementación en vivo de OpenAPI Bot: haga clic en "¡Pruébelo!" y aparecerá un pequeño cuadro de chat en la esquina inferior derecha de su navegador. Esta versión del bot le permite proporcionar la especificación para cualquier API de su elección, aunque el objetivo final probablemente sea que los propietarios de API proporcionen bots personalizados específicos para sus portales de desarrollo. En cualquier caso, esto es lo que implica.

Carga de una especificación

Lo primero es lo primero, el bot le pedirá que proporcione la especificación de OpenAPI para su API elegida. Simplemente ingrese la URL de la especificación, en forma de archivo JSON o YAML, y presione regresar. Para mantener las cosas familiares, optaremos por la infame API Petstore de Swagger, que está disponible en https://petstore.swagger.io/v2/swagger.json :

Hacer preguntas sencillas

Después de un breve retraso, el bot debería informarle que ha cargado la especificación elegida. En este punto, comenzará a escuchar sus preguntas:

Pero, ¿qué le puedes preguntar al bot? Según los desarrolladores, OpenAPI Bot admite un puñado de preguntas (y solicitudes) simples, como:
  • ¿Cómo me comunico con el desarrollador de la API?
  • Dame un resumen de esta API
  • Muéstrame una lista de rutas en la API
  • Háblame del camino / pet
  • Muéstrame las definiciones del esquema
  • ¿Qué operaciones devuelven una mascota?
Hasta ahora todo va bien: el bot puede localizar y extraer información básica de la especificación. Dicho esto, si sabe dónde buscar, puede encontrar esta información con la misma facilidad si profundiza en la especificación misma ...

Hacer preguntas complejas

Donde OpenAPI Bot realmente brilla como prueba de concepto es en su capacidad para procesar preguntas complejas. Aquí, los desarrolladores proporcionan los siguientes tres ejemplos:
  • ¿Existen operaciones que utilicen las propiedades de Pet?
  • ¿Existen vínculos entre mascota y otras definiciones?
  • ¿Qué operaciones necesito cambiar si cambio el esquema Pet?
A menos que desee presionar Ctrl + F a través de cada instancia de "Mascota" en el archivo de especificación, e incluso entonces, es posible que eso no sea suficiente, puede ser difícil saber qué objetos están interconectados. OpenAPI Bot lo comprueba rápida y fácilmente:

Construyendo su propio Chatbot API

Si se siente inspirado por OpenAPI Bot, la buena noticia es que puede crear su propio chatbot API con relativa facilidad. El propio OpenAPI Bot está construido sobre Xatkit , con todo el código disponible en el repositorio de GitHub. Como resultado, todo lo que realmente necesita hacer es instalar Xatkit y clonar el repositorio en su dispositivo local.
Para los ajustes, probablemente desee codificar la URL de la especificación de su API en el bot. Luego, además de agregar preguntas más sofisticadas (y más), es posible que desee integrar el bot con otras partes de su ecosistema de desarrolladores, para distribuir claves API o abrir tickets de soporte, entre otras extensiones creativas.

El potencial de los chatbots API

Aunque es solo una prueba de concepto, OpenAPI Bot demuestra otra forma de usar su especificación API existente: chatbots. Sin embargo, ¿los chatbots de API (basados ​​en archivos de especificación) realmente aportan algo a la mesa, o son solo un truco divertido para su portal de desarrolladores?

Beneficios

Los chatbots basados ​​en especificaciones definitivamente tienen sus beneficios. Pueden ser una forma divertida e interactiva de extraer información de una especificación de API, es decir, si logran comprender las consultas del desarrollador. Además, si pueden procesar consultas relacionales más complejas, podrían ahorrarle al desarrollador algo de tiempo rastreando la especificación manualmente. Finalmente, para una experiencia de desarrollador más unificada, los chatbots también se pueden ampliar con una clave API, ticket de seguridad u otra funcionalidad, creando una ventanilla única para la asistencia API automatizada.
Es importante tener en cuenta que los chatbots de IA ya han demostrado su eficacia en el mundo de SaaS. Por lo general, están equipados con funciones de soporte y, en última instancia, reducen la necesidad de personal humano, lo que genera una experiencia de soporte más rápida (para el usuario final) y más asequible (para el proveedor).

Limitaciones

Por supuesto, los chatbots API basados ​​en especificaciones tienen sus limitaciones. Además de poder identificar la intención a partir de las palabras exactas utilizadas en la consulta (que es un desafío al que se enfrenta todo chatbot), deben estar programados para cumplir con estas intenciones. Como resultado, para que un chatbot de API sea útil, el creador tiene que dedicar una buena cantidad de tiempo a pensar en las preguntas del desarrollador y escribir algoritmos para extraer esa información de la especificación.

Pensamientos finales

OpenAPI Bot es una fascinante prueba de concepto. Al consumir un archivo de especificación de OpenAPI existente, la herramienta puede responder una variedad de preguntas, tanto simples como complejas, sobre una API. Si bien la idea aún se encuentra en sus inicios, definitivamente existe la posibilidad de que una herramienta como esta proporcione un valor significativo a los desarrolladores, especialmente cuando se integra con otras funcionalidades del portal de desarrolladores.

Publicar un comentario

0 Comentarios