AI Coding Assistant Lingma:Bangun dan kelola basis pengetahuan sebagai konteks untuk obrolan

Siapa yang dapat menggunakan fitur ini?

• Edisi: Lingma Enterprise Dedicated

• Peran: Administrator Lingma dan administrator global di sebuah organisasi

Anda dapat mengubah file yang diunggah menjadi data pengetahuan yang ditingkatkan dengan pengambilan. Sebelum memulai, Anda harus mengikuti prinsip dan metode persiapan data pengetahuan berbasis file.

Format file

• Anda dapat mengunggah hingga 10 file sekaligus.

• Format yang didukung termasuk pdf, docx, txt, markdown, dan csv.

• Setiap file harus berukuran 5 MB atau lebih kecil.

• Nama file harus 200 karakter atau kurang. Hanya file yang dikodekan dalam UTF-8 dan GBK yang didukung.

• Gunakan dokumen terstruktur untuk memastikan informasi mudah ditemukan.

File tunggal

Jika Anda mengunggah file tunggal, periksa apakah file tersebut mengikuti aturan untuk nama file, judul, format, dan konten. Lihat lebih banyak detail dan contoh di bawah.

Tipe file dan penamaan

• Tipe: Format Markdown lebih disarankan. Dibandingkan dengan Word dan PDF, format Markdown lebih cocok untuk pemrosesan file.

• Pengkodean: Gunakan UTF-8 untuk kompatibilitas karakter terbaik.

• Penamaan file: Buat nama pendek dan jelas, dan pastikan model dapat dengan mudah memahaminya. Jangan gunakan singkatan, angka, atau simbol yang tidak jelas. Berikut beberapa contohnya:

  Jangan	Dos
  Jangan gunakan nama yang terlalu umum, terlalu mirip, atau dapat menyebabkan kebingungan: Spesifikasi Pemrograman Spesifikasi Keamanan 1 Spesifikasi Keamanan 2 SR3	Gunakan nama yang menentukan isi dan tujuan file: Spesifikasi Pemrograman Bahasa Java Spesifikasi Manajemen Keamanan Data API Spesifikasi Manajemen Keamanan Akun Cloud

Struktur file

• Struktur hierarkis: Gunakan heading untuk mengatur konten dalam file. Tulis setiap kata benda yang tepat pada barisnya sendiri untuk memudahkan pemahaman.

• Judul di semua level: Judul di semua level harus jelas dan ringkas, serta mudah dibedakan. Jangan gunakan singkatan, angka, atau simbol yang tidak jelas. Jangan cantumkan kata kunci dari file, karena ini dapat menyebabkan masalah.

  Jangan

  Dos

  Spesifikasi Penggunaan Aman Pasangan AccessKey [Isi] Kata Kunci: AK, spesifikasi keamanan, AccessKey I. Definisi Pasangan AccessKey adalah pasangan kunci yang digunakan untuk otentikasi. Setiap pasangan AccessKey terdiri dari ID AccessKey dan rahasia AccessKey. Pasangan AccessKey memungkinkan Anda mengakses layanan sistem secara aman dengan mengirimkan permintaan API. File ini bertujuan untuk menjelaskan aturan penggunaan pasangan AccessKey dan memastikan keamanan dan stabilitas sistem. ID AccessKey digunakan untuk memverifikasi identitas pengguna. Rahasia AccessKey digunakan untuk mengenkripsi string tanda tangan Anda dan memastikan keunikan dan non-penyangkalan permintaan Anda. 2. Catatan penggunaan Pastikan kerahasiaan rahasia AccessKey dan jangan mengungkapkannya kepada pihak ketiga yang tidak berwenang. Ikuti prinsip hak istimewa minimal untuk memberikan izin pada operasi API, dan berikan hanya izin yang diperlukan untuk menyelesaikan tugas. Ubah rahasia AccessKey setiap 90 hari. Catat penggunaan pasangan AccessKey dan tinjau log penggunaan secara berkala untuk menghilangkan perilaku abnormal dan mencabut izin yang tidak diperlukan. 3. Praktik keamanan Untuk memastikan keamanan pasangan AccessKey, kami menerapkan praktik keamanan berikut yang disederhanakan: Di lingkungan produksi, kami lebih memilih menggunakan variabel lingkungan untuk menyimpan pasangan AccessKey untuk mencegah hard coding. Kami mengelola pasangan AccessKey dengan menggunakan sistem manajemen konfigurasi secara seragam untuk mencegah paparan langsung di kode. Pada saat yang sama, kami menyaring log untuk memastikan bahwa tidak ada rahasia AccessKey yang dicatat. Kami secara berkala meninjau izin untuk memastikan bahwa pasangan AccessKey hanya memiliki izin minimum yang diperlukan untuk melakukan operasi yang diperlukan. Selain itu, kami menetapkan mekanisme deteksi anomali untuk dengan cepat mengidentifikasi dan merespons aktivitas penggunaan AccessKey yang mencurigakan. Langkah-langkah ini bersama-sama menjamin penggunaan pasangan AccessKey yang aman dan wajar. 4. Contoh pemanggilan API ● Contoh 1 Gunakan pasangan AccessKey untuk pemanggilan API di Node.js: Di Node.js, Anda dapat menggunakan pustaka Axios untuk mengirim permintaan API dan menyertakan pasangan AccessKey di header permintaan. Contoh kode berikut menunjukkan permintaan API yang menggunakan pasangan AccessKey untuk autentikasi tanda tangan. [Contoh blok kode] ● Contoh 2 Gunakan pasangan AccessKey untuk pemanggilan API di Python: Di Python, Anda dapat menggunakan pustaka requests untuk mengirim permintaan API dengan pasangan AccessKey. Contoh kode berikut menunjukkan cara membuat permintaan dan menambahkan tanda tangan: [Contoh blok kode]

  Spesifikasi Penggunaan Aman Pasangan AccessKey /* Hapus elemen yang mengganggu: Hapus informasi yang tidak perlu diingat, seperti konten dan kata kunci di awal file. Penjelasan istilah profesional: Cantumkan istilah profesional dan penjelasannya dalam bentuk entri agar lebih mudah dicari dan dipahami oleh model. */ I. Definisi ● Pasangan AccessKey: Pasangan AccessKey adalah pasangan kunci yang digunakan untuk otentikasi. Setiap pasangan AccessKey terdiri dari ID AccessKey dan rahasia AccessKey. Pasangan AccessKey memungkinkan Anda mengakses layanan sistem secara aman dengan mengirimkan permintaan API. ● ID AccessKey: ID AccessKey digunakan untuk memverifikasi identitas pengguna. ● Rahasia AccessKey: Rahasia AccessKey digunakan untuk mengenkripsi string tanda tangan Anda dan memastikan keunikan dan non-penyangkalan permintaan Anda. /* Jangan gunakan pernyataan paragraf besar. Gunakan pernyataan berpoin, yang lebih mudah dipahami oleh model. */ 2. Catatan penggunaan ● Kerahasiaan: Jaga kerahasiaan rahasia AccessKey dan jangan mengungkapkannya kepada pihak ketiga yang tidak berwenang. ● Prinsip hak istimewa minimal: Ikuti prinsip hak istimewa minimal untuk memberikan izin pada operasi API, dan berikan hanya izin yang diperlukan untuk menyelesaikan tugas. ● Rotasi rutin: Kami merekomendasikan Anda mengubah rahasia AccessKey setiap 90 hari. ● Pemantauan dan audit: Catat penggunaan pasangan AccessKey dan tinjau log penggunaan secara berkala untuk menghilangkan perilaku abnormal. ● Pencabutan tepat waktu: Jika Anda tidak lagi perlu menggunakan pasangan AccessKey, cabut izinnya secara tepat waktu. 3. Praktik keamanan ● Variabel lingkungan: Di lingkungan produksi, simpan pasangan AccessKey dengan menggunakan variabel lingkungan alih-alih hard coding. ● Manajemen konfigurasi: Kelola pasangan AccessKey dengan menggunakan sistem manajemen konfigurasi untuk mencegah paparan langsung di kode. ● Penyaringan log: Pastikan bahwa tidak ada rahasia AccessKey yang muncul di entri log. ● Tinjauan izin: Secara berkala periksa pengaturan izin pasangan AccessKey untuk memastikan kepatuhan terhadap prinsip hak istimewa minimal. ● Deteksi anomali: Tetapkan mekanisme deteksi anomali untuk mendeteksi dan menangani aktivitas mencurigakan secara tepat waktu. /* Judul dalam contoh pemanggilan API tidak jelas. Ubah Contoh 1 dan Contoh 2 menjadi nama yang lebih spesifik. */ 4. Contoh pemanggilan API ● Contoh menggunakan pasangan AccessKey untuk pemanggilan API di Node.js Di Node.js, Anda dapat menggunakan pustaka Axios untuk mengirim permintaan API dan menyertakan pasangan AccessKey di header permintaan. Contoh kode berikut menunjukkan permintaan API yang menggunakan pasangan AccessKey untuk autentikasi tanda tangan. [Contoh blok kode] ● Contoh menggunakan pasangan AccessKey untuk pemanggilan API di Python Di Python, Anda dapat menggunakan pustaka requests untuk mengirim permintaan API dengan pasangan AccessKey. Contoh kode berikut menunjukkan cara membuat permintaan dan menambahkan tanda tangan: [Contoh blok kode]

Bagian file dan paragraf

• Kumpulkan konten yang relevan dalam paragraf atau bagian yang sama untuk menjaga informasi tetap jelas dan terhubung.

• Jangan mempersingkat atau menggunakan singkatan untuk detail penting. Jika kontennya sama, ulangi daripada mengatakan "sama seperti di atas." Jelaskan konten spesifiknya.

• Jangan gunakan baris kosong yang tidak menambah makna.

• Gunakan poin-poin dan indentasi yang tepat untuk membuat konten lebih mudah dipahami.

  Jangan	Dos
  Hindari baris kosong yang tidak bermakna 6.3 Penerima metode Kami sarankan Anda menamai penerima setelah huruf pertama nama kelas dalam huruf kecil. Jika fungsi melebihi 20 baris, jangan gunakan satu karakter sebagai nama penerima. Jangan gunakan nama yang membingungkan seperti 'me', 'this', dan 'self'.	Hapus baris kosong yang tidak bermakna 6.3 Penerima metode ● Kami sarankan Anda menamai penerima setelah huruf pertama nama kelas dalam huruf kecil. ● Jika fungsi melebihi 20 baris, jangan gunakan satu karakter sebagai nama penerima. ● Jangan gunakan nama yang membingungkan seperti 'me', 'this', dan 'self'.
  Jangan gunakan "sama seperti di atas," singkatan, atau kata ganti. 4.6 Konvensi penamaan antarmuka di Go Konvensi penamaan sama dengan yang digunakan untuk struktur. atau Sama seperti Bab 3.2 Konvensi Penamaan dan Konvensi Penamaan Struktur	Jelaskan dan jelaskan konten spesifik dengan jelas. 4.6 Konvensi penamaan antarmuka di Go ● Gunakan metode penamaan CamelCase. Gunakan huruf besar atau kecil untuk huruf pertama sesuai dengan persyaratan kontrol akses. ● Gunakan kata benda atau frasa kata benda sebagai nama struktur, seperti Customer, WikiPage, Account, dan AddressParser. Jangan gunakan kata kerja. ● Jangan gunakan nama struktur dengan arti terlalu luas, seperti Data dan Info.

Gambar, tabel, dan konten multimedia

Jika Anda menggunakan gambar dan tabel dalam paragraf file, berikut beberapa tips:

• Pemrosesan tabel dalam file:

  • Persyaratan untuk format tabel:

    • Gunakan baris pertama untuk header tabel.

    • Jangan letakkan nama tabel di baris pertama.

  • Deskripsi struktur tabel: Tidak ada aturan khusus untuk struktur tabel. Anda dapat merancang kolom dan baris berdasarkan konten Anda.

  • Jaga gaya tetap ringkas: Hapus pemformatan tambahan, seperti warna latar belakang dan gaya font. Gunakan garis tabel yang jelas dan gaya default.

  • Catatan tambahan:

    • Di Edisi Enterprise Dedicated, Lingma memiliki fitur canggih untuk menjaga keakuratan data tabel.

• Pemrosesan Gambar dalam File:

  • Gunakan teks alih-alih gambar: Gunakan teks untuk berbagi informasi. Jika gambar memiliki sedikit teks dan berisi detail penting, tuliskan informasi tersebut sebagai teks.

  • Tambahkan ilustrasi: Sertakan ilustrasi yang jelas untuk semua diagram penting untuk membantu menjelaskan materi pelajaran.

• Lainnya:

  • Karakter khusus: Jangan gunakan emoji atau karakter khusus lainnya, untuk menghindari masalah penguraian.

  • Header, footer, watermark, dan anotasi: Jangan gunakan ini, karena dapat menghalangi visibilitas.

  • Latar belakang file: Jangan gunakan latar belakang, karena dapat menyebabkan masalah dengan pengalaman pengguna.

  • Orientasi teks seragam: Pastikan semua teks menghadap ke arah yang sama.

  • Audio dan video: Jangan sertakan audio atau video.

File dalam format berbeda

• Markdown: Kami sarankan menggunakan format Markdown.

• Word:

  • Gunakan format terbaru: Gunakan versi Word 2007 atau yang lebih baru.

  • Gunakan gaya global: Gunakan gaya heading dan paragraf global.

  • Jangan gunakan gaya karakter, seperti pemformatan font khusus, batas, dan bayangan.

  • Gunakan gaya paragraf: Gunakan gaya paragraf untuk pemformatan yang konsisten.

• PDF:

  • Jangan gunakan gambar: Jangan mengonversi gambar langsung ke file PDF. Tuliskan informasi penting dari gambar sebagai teks, dan ikuti persyaratan file yang dijelaskan dalam topik ini.

  • Jangan sertakan file terkompresi: Pastikan file tidak menyertakan file terkompresi.

  • Jaga tata letak satu kolom: Gunakan tata letak satu kolom untuk memastikan konten dapat diurai dengan benar.

• CSV:

  • Jangan gunakan gambar: Ini memastikan teks dapat dicari.

  • Jangan sematkan file terkompresi: Jangan sematkan file terkompresi dalam file.

  • Gunakan baris pertama sebagai header tabel: Gunakan baris pertama sebagai header tabel. Jangan letakkan nama tabel di baris pertama tabel.

    Catatan:

    • Disarankan: Simpan pasangan pertanyaan-jawaban dalam pertanyaan yang sering diajukan (FAQ). Untuk meningkatkan akurasi pengambilan, pastikan:

      • Pertanyaan dinyatakan dengan jelas.

      • Jawaban ringkas dan mudah dipahami.

      • Istilah sudah dikenal oleh pengguna.

      • Kata kunci ditekankan.

    • Jangan unggah tabel data kompleks dalam CSV. Mungkin memerlukan waktu sangat lama untuk diproses, dan mungkin gagal.

Beberapa file

Saat menulis dokumen, pastikan dokumen tersebut dapat dipahami secara mandiri, dan bahwa dokumen tersebut terkumpul, konsisten, dan komprehensif. Ini membantu pengguna menemukan apa yang mereka butuhkan dengan cepat, dan membuat dokumen lebih berguna. Berikut beberapa tips untuk menjaga dokumen Anda tetap terorganisir dan mudah ditangani:

Mandiri: Setiap dokumen harus memiliki semua informasi yang diperlukan secara mandiri.

• Jangan mengulangi informasi di dokumen yang berbeda.

• Pastikan setiap file merupakan unit pengetahuan mandiri yang memberikan informasi lengkap dan akurat secara mandiri.

Terkumpul: Kumpulkan semua informasi yang relevan ke topik yang sama.

• Ini menjaga topik terkait tetap bersama dan memudahkan pemahaman.

Konsisten: Pastikan informasi serupa di file yang berbeda konsisten dan distandardisasi.

• Gunakan gaya dan kata yang sama di semua dokumen.

• Buat dan ikuti panduan gaya dan glosarium untuk memastikan konsistensi.

Komprehensif: Pastikan semua dokumen lengkap, mutakhir, dan akurat.

• Pastikan basis pengetahuan dapat menjawab semua pertanyaan umum dengan jelas. Saat Anda menulis tentang API, sertakan semua bagian dan detail yang penting.

• Secara berkala periksa dan perbarui untuk menambahkan informasi yang hilang dan menghapus konten lama.

Panduan sebelumnya dapat membantu administrator basis pengetahuan perusahaan membuat dokumentasi produk berkualitas tinggi, dan meningkatkan kepuasan dan pengalaman pengguna. Pendekatan sistematis untuk mengatur dan mengelola dokumen memastikan keakuratan, kemudahan penggunaan, dan integritas informasi, memberikan pengguna sumber daya pengetahuan yang lebih andal.