Saya Membangun Agen AI yang Memungkinkan Anda Menjelajahi API dalam Bahasa Inggris Sederhana

Produk saya saat ini memiliki ratusan API. Setiap kali saya perlu merujuk ke spesifikasi API, saya harus menavigasi ke tautan Swagger, menggulir tanpa henti, atau menggunakan pencarian browser untuk menemukan yang saya butuhkan—dan kemudian memfilter hal-hal secara manual. Ini membuat frustrasi dan sangat lambat. Lebih buruk lagi, setiap pengembang yang perlu berintegrasi dengan API harus melalui pengalaman yang sama.

Frustrasi ini membuat saya mengeksplorasi bagaimana AI dapat meningkatkan proses tersebut. Postingan ini adalah penjelasan mendalam tentang perjalanan itu dan bagaimana hal itu berkembang menjadi sesuatu yang sederhana, kuat, dan efektif.

Persiapan

Dokumentasi API yang Kaya

Sebagai langkah pertama, saya meninjau seluruh dokumentasi api untuk memastikan bahwa dokumentasi tersebut memiliki ringkasan yang jelas dan detail deskripsi dalam dokumen swagger. Ini adalah langkah penting untuk penemuan yang lebih baik di tahap selanjutnya. Saya juga memastikan bahwa ringkasan dan deskripsi unik untuk setiap api.

paths": {     "/users/accounts/{account-id}": {       "put": {         "tags": [           "Account API"         ],         "summary": "Update Test suite by test-suite-id",         "externalDocs": {           "description": "Robust get account details description",           "url": "https://mydocs.com/description"         },

\

Kategorisasi API

Dengan ratusan API yang tersedia, dapat menjadi tantangan untuk mengidentifikasi mana yang terkait. Mengkategorikan API membuat pengelolaan lebih efisien dan kemudian menyederhanakan pemilihan API yang tepat berdasarkan input bahasa alami. Kategorisasi ini diimplementasikan menggunakan konsep penandaan yang didefinisikan dalam spesifikasi OpenAPI.

\

"paths": {     "/users/accounts/{account-id}": {       "put": {         "tags": [           "Account API"         ],         "summary": "Update Test suite by test-suite-id",         "externalDocs": {           "description": "Robust get account details description",           "url": "https://mydocs.com/description"         },

\

Membangun Pencarian Bahasa Alami

Input Pengguna

Pengguna akan memasukkan pertanyaan bahasa alami terkait dengan API.

Contoh: Bagaimana cara mengambil detail akun?

Klasifikasi Kategori

Pada tahap ini, pertanyaan dan semua kategori yang tersedia dikirim ke LLM. LLM ditugaskan untuk mengembalikan kategori tingkat tinggi yang sesuai dengan pertanyaan tersebut. Output dari langkah ini adalah salah satu dari kategori tersebut.

Klasifikasi API Spesifik

Berdasarkan kategori yang diidentifikasi oleh LLM, sistem mengirimkan permintaan lain ke model dengan pertanyaan yang sama — tetapi kali ini, termasuk semua detail API dalam kategori spesifik yang terdeteksi pada langkah sebelumnya.

Inilah saat persiapan sebelumnya membuahkan hasil: semakin deskriptif dan terstruktur dengan baik dokumentasi API, semakin baik hasilnya. Deskripsi yang jelas membantu LLM menentukan dengan akurat API mana yang diminta informasinya oleh pengguna.

Output dari langkah ini adalah satu API spesifik.

Memperkaya Detail Respons API

Spesifikasi OpenAPI dari API kemudian diberikan kepada LLM untuk menghasilkan deskripsi terperinci dan kaya konteks tentang API bersama dengan pertanyaan asli.

Misalnya, jika pengguna bertanya, "Bagaimana cara mengambil detail akun menggunakan ID akun?", respons akan menyertakan detail spesifikasi yang relevan dari API Akun.

Ekstensi

Dengan kemampuan sistem yang ditingkatkan untuk mendeteksi API yang sesuai dengan akurat, pengguna sekarang dapat melangkah lebih jauh — menghasilkan cuplikan kode untuk berinteraksi dengan berbagai API secara langsung.

Misalnya:

• "Bagikan kode Python untuk memanggil API Get Account Details untuk ID tertentu."

• "Berikan perintah cURL untuk mengambil detail akun berdasarkan ID."

• "Hasilkan klien Go untuk mengambil detail akun untuk ID tertentu."

\

Pelajaran dan Wawasan yang Diperoleh

• Dokumentasi yang kaya sangat penting untuk akurasi yang lebih baik saat bekerja dengan sistem AI. Dokumentasi yang tepat, jelas, dan langsung ke pokok permasalahan sangat penting untuk kekokohan. Bonus: Kami juga menggunakan LLM untuk menghasilkan ringkasan dan deskripsi untuk setiap API, yang sangat membantu.
• Kategorikan Terlebih Dahulu
• Mengapa: Dengan ratusan API, kategorisasi mengurangi beban kognitif dan meningkatkan pengambilan.
• Bagaimana: Kelompokkan API terkait ke dalam serangkaian kategori yang jelas dan kecil. Sistem AI berkinerja lebih baik ketika ruang label terbatas.
• Tip skala: Jika katalog sangat besar, tambahkan sub-kategori untuk perutean yang lebih halus.
• Bangun Secara Iteratif
• Mulai kecil: Ambil subset dari spesifikasi dan latih/validasi router yang dapat diandalkan untuk memilih API yang benar.
• Perluas secara bertahap: Tambahkan lebih banyak API seiring waktu, ukur akurasi, dan prioritaskan area dengan kesalahan klasifikasi.
• Fokus: Optimalkan presisi/recall daripada keluasan pada awalnya.
• Tutup Loop dengan Pengguna
• Kumpulkan umpan balik: Tangkap kasus di mana sistem memilih API yang salah.
• Bertindak berdasarkan sinyal: Perbaiki deskripsi, ringkasan, dan tag API yang salah diidentifikasi; perjelas cakupan yang tumpang tindih.
• Ulangi: Evaluasi ulang setelah setiap perubahan untuk mengonfirmasi bahwa akurasi meningkat dan regresi dihindari.

Kesimpulan

Seiring dengan pertumbuhan jumlah API yang tersedia, mengeksplorasi dan mengelolanya membutuhkan pendekatan baru. Dengan munculnya agen AI yang didukung oleh model bahasa besar (LLM), pengembang sekarang memiliki cara yang lebih intuitif dan efisien untuk menemukan dan berinteraksi dengan API—menghemat banyak waktu yang sebelumnya dihabiskan untuk mencari endpoint yang tepat.

Potensinya tidak berhenti di situ. Konsep ini dapat berkembang menjadi produk mandiri yang mampu menyerap spesifikasi OpenAPI secara mulus saat runtime dan mengeksposnya melalui antarmuka bahasa alami—menawarkan kepada pengguna solusi siap pakai untuk eksplorasi API.

Semoga artikel ini telah mengilustrasikan bagaimana memanfaatkan LLM secara efektif dan bagaimana dokumentasi API yang terstruktur dengan baik dapat menciptakan pengalaman penemuan yang lebih lancar dan lebih cerdas.

\n \n

\n \n