Pengetahuan

API Otorisasi

NOTE

• Untuk memperoleh AUTH_TOKEN, lihat Peroleh AUTH_TOKEN.
• Harap pastikan bahwa semua permintaan API menyertakan AUTH_TOKEN dalam header permintaan, seperti yang ditunjukkan di bawah ini:

SDK Otorisasi

NOTE

• Sebelum mengintegrasikan SDK, harap pastikan bahwa Anda telah memperoleh APP_ID dan APP_KEY.
• Untuk memperoleh kredensial Anda, lihat Peroleh APP_ID dan APP_KEY.

Basis Pengetahuan

API Permintaan

• Contoh

• Deskripsi kolom

Nama Parameter	Tipe	Diperlukan	Deskripsi
page	Integer	N	Nomor halaman, mulai dari 0.
size	Integer	N	Jumlah catatan yang dikembalikan per halaman.
keyword	String	N	Kata kunci untuk dicari.

API Respon

• Contoh

• Deskripsi kolom

Nama Parameter	Tipe	Diperlukan	Deskripsi
pageNum	Integer	Y	Nomor halaman, mulai dari 0.
pageSize	Integer	Y	Jumlah catatan yang dikembalikan per halaman.
total	Integer	Y	Jumlah total catatan.
pages	Integer	Y	Jumlah total halaman.
currentPageTotal	Integer	Y	Jumlah catatan yang dikembalikan pada halaman saat ini.
content	Array<Object>	Y	Konten daftar basis pengetahuan.
content.id	Integer	Y	Pengidentifikasi unik untuk basis pengetahuan.
content.name	String	Y	Nama basis pengetahuan.
content.description	String	Y	Deskripsi basis pengetahuan.
content.status	String	Y	Status dari basis pengetahuan. ENABLED/DISABLED
content.totalDoc	Integer	Y	Jumlah total dokumen dalam basis pengetahuan.
content.totalRecord	Integer	Y	Jumlah total catatan dalam basis pengetahuan.
content.createDatetime	Timestamp	Y	Waktu pembuatan basis pengetahuan.
content.updateDatetime	Timestamp	Y	Waktu pembaruan basis pengetahuan.

Dokumen Pengetahuan

API Permintaan

• Contoh

• Deskripsi kolom

Nama Parameter	Tipe	Diperlukan	Deskripsi
page	Integer	N	Nomor halaman, mulai dari 0.
size	Integer	N	Jumlah catatan yang dikembalikan per halaman.
keyword	String	N	Kata kunci untuk dicari.
knowledgeBaseId	Integer	Y	Pengidentifikasi unik untuk basis pengetahuan.

API Respon

• Contoh

• Deskripsi kolom

Nama Parameter	Tipe	Diperlukan	Deskripsi
pageNum	Integer	Y	Nomor halaman, mulai dari 0.
pageSize	Integer	Y	Jumlah catatan yang dikembalikan per halaman.
total	Integer	Y	Jumlah total catatan.
pages	Integer	Y	Jumlah total halaman.
currentPageTotal	Integer	Y	Jumlah catatan yang dikembalikan pada halaman saat ini.
content	Array<Object>	Y	Isi dari dokumen basis pengetahuan
content.id	Integer	Y	Pengidentifikasi unik untuk dokumen basis pengetahuan.
content.name	String	Y	Nama dokumen basis pengetahuan.
content.type	String	Y	Jenis dokumen basis pengetahuan. TEXT_PLAIN/MARKDOWN/ APPLICATION_PDF/DOCX
content.source	String	Y	Sumber dokumen basis pengetahuan. LOCAL/ONLINE
content.status	String	Y	Status dokumen basis pengetahuan. UN_PROCESS/PROCESSING/ PROCESSING_FAILED/PROCESSED
content.totalRecord	Integer	Y	Jumlah total catatan dalam dokumen basis pengetahuan.
content.createDatetime	Timestamp	Y	Waktu pembuatan dokumen basis pengetahuan.
content.updateDatetime	Timestamp	Y	Waktu pembaruan dokumen basis pengetahuan.

Unggah Dokumen Pengetahuan

API Permintaan

• Contoh

• Deskripsi kolom

Nama Parameter	Tipe	Diperlukan	Deskripsi
knowledgeBaseId	Integer	Y	Pengidentifikasi unik untuk basis pengetahuan.
document	File	Y	Dokumen yang akan diunggah.

API Respon

• Contoh

• Deskripsi kolom

Nama Parameter	Tipe	Diperlukan	Deskripsi
id	String	Y	ID sementara dari dokumen yang diunggah.

Ekstrak Dokumen Pengetahuan

Pemicu proses

API Permintaan

• Contoh

• Deskripsi kolom

Nama Parameter	Tipe	Diperlukan	Deskripsi
id	Integer	Y	ID sementara dari dokumen yang diunggah.
knowledgeBaseId	Integer	Y	Pengidentifikasi unik untuk repositori pengetahuan.
source	String	Y	Sumber dari dokumen.
ragStatus	String	N	Apakah akan mengaktifkan Peningkatan Pencarian (RAG). ENABLED/DISABLED
segmentIdentifier	String	N	Pengenal segmen. LINE_BREAK/LINE_BREAK_2
segmentSize	Integer	N	Batas ukuran segmen (0-2000)

API Respon

• Contoh

• Deskripsi kolom

Nama Parameter	Tipe	Diperlukan	Deskripsi
taskId	Integer	Y	ID dari tugas.
status	String	Y	Status dari tugas. CREATED/IN_PROCESS/FAILED/FINISHED
totalNum	Integer	Y	Jumlah total item dalam tugas.
successNum	Integer	Y	Jumlah item yang berhasil diproses dalam tugas.
failureNum	Integer	Y	Jumlah item yang gagal diproses dalam tugas.

Detail Proses

API Permintaan

• Contoh

• Deskripsi kolom

Nama Parameter	Tipe	Diperlukan	Deskripsi
id	Integer	Y	ID dari tugas.

API Respon

• Contoh

• Deskripsi kolom

Nama Parameter	Tipe	Diperlukan	Deskripsi
taskId	Integer	Y	ID dari tugas.
status	String	Y	Status dari tugas. CREATED/IN_PROCESS/FAILED/FINISHED
totalNum	Integer	Y	Jumlah total item dalam tugas.
successNum	Integer	Y	Jumlah item yang berhasil diproses dalam tugas.
failureNum	Integer	Y	Jumlah item yang gagal diproses dalam tugas.
data	Object	Y	Progres tugas dan informasi tambahan.

Pratinjau Dokumen Pengetahuan

API Permintaan

• Contoh

• Deskripsi kolom

Nama Parameter	Tipe	Apakah wajib diisi	Deskripsi
page	Integer	N	Nomor halaman (nilai awal adalah 0)
size	Integer	N	Jumlah catatan yang dikembalikan per halaman
knowledgeBaseId	Integer	Y	Identifikasi unik basis pengetahuan
knowledgeDocId	Integer	Y	Identifikasi unik dokumen basis pengetahuan

API Respon

• Contoh

• Deskripsi kolom

Nama Parameter	Tipe	Diperlukan	Deskripsi
id	Integer	Y	Identifikasi unik dari dokumen.
hasMore	Boolean	Y	Menunjukkan apakah ada konten yang lebih banyak tersegmentasi.
segments	Array<Object>	Y	Daftar konten yang dibagi.
segments.number	Integer	Y	Nomor segmen dokumen (dimulai dari 0).
segments.tokens	Integer	Y	Perkiraan token untuk segmen dokumen.
segments.raw	String	Y	Data mentah untuk segmen dokumen.

Tanya-Jawab Dokumen Pengetahuan