Antarmuka API
Backend menggunakan pendekatan API-first. Client HTTP seperti aplikasi frontend, dashboard, dan tool unggah batch terintegrasi melalui API HTTP dan SSE yang terdokumentasi. Backend mitra Kafka/DMS dirancang untuk terintegrasi melalui permukaan event ingestion mitra yang terpisah. Tidak satu pun jenis client menyematkan logika pemrosesan dokumen, pencarian, memori, atau pembuatan jawaban.
Kontrak wire HTTP, bentuk request dan response, urutan event streaming, header autentikasi, kode status, dan payload error tersedia dalam referensi API. Kontrak event mitra tersedia di sampingnya:
Halaman ini hanya mendefinisikan batas arsitektur.
Batas saat ini
Platform saat ini menyediakan API HTTP/SSE dan mengimplementasikan permukaan ingestion mitra Kafka/DMS yang terpisah, tetapi kontrak produsennya belum kompatibel. Rute data HTTP memerlukan header API key yang dikonfigurasi. /healthz, /readyz, /openapi.json, serta /docs dan /docs/oauth2-redirect di luar production dikecualikan. Rute data yang membawa principal juga dapat mengandalkan header identitas tepercaya ketika autentikasi terverifikasi diaktifkan. Infrastruktur harus menghapus header identitas yang diberikan caller dan menyuntikkan klaim tepercaya sebelum traffic mencapai API. Client browser tidak boleh menyematkan API key bersama atau mengizinkan pengguna memalsukan identitas tepercaya; gunakan backend-for-frontend dengan origin yang sama atau lapisan injeksi gateway.
Permukaan HTTP/SSE mencakup health dan discovery, query/search, memori percakapan, ingestion, siklus hidup dokumen, dan streaming jawaban. Kode event mitra mencakup handoff ingestion Kafka/DMS dan publikasi status tahap setelah kontraknya direkonsiliasi. Perlakukan referensi API sebagai acuan otoritatif untuk setiap field HTTP, endpoint, event stream, event mitra, dan kasus error.
Tanggung jawab frontend
Client frontend bertanggung jawab atas presentasi, interaksi pengguna, form unggah, konsumsi polling atau stream, serta tampilan sitasi dan error yang aman. Backend bertanggung jawab atas pencarian, ingestion, persistensi memori, pembuatan sitasi, pengamanan kebijakan, dan orkestrasi model. Header identitas tepercaya dan penegakan RBAC/ABAC untuk pencarian dikendalikan oleh konfigurasi. Ketika autentikasi terverifikasi dinonaktifkan, pemfilteran akses pencarian mengizinkan semua akses.
Client sebaiknya menemukan dokumen OpenAPI saat ini dari /openapi.json di environment target. Swagger UI tersedia di /docs di luar production untuk eksplorasi interaktif.
Entitlement dan roadmap
Saat ini, OCR, embedding, pencarian, memori, dan generasi terhubung bersama untuk platform Aceh RAG + OCR. Semua kemampuan tersebut belum diekspos sebagai produk API yang dapat dipilih secara independen, dan satu aplikasi belum dapat berlangganan hanya ke OCR sementara aplikasi lain berlangganan OCR plus pencarian dan generasi.
Lapisan entitlement service-gateway di masa mendatang dapat menambahkan identitas per aplikasi, akses kemampuan à-la-carte, kuota, pengukuran penggunaan, dan tata kelola seragam di atas fondasi API-first yang sama. Di Huawei Cloud, lapisan tersebut akan memperluas gateway APIG yang sudah ada dalam stack, bukan mengubah kontrak integrasi frontend yang dijelaskan dalam referensi API.