ListKbFiles_Lingma_AI Coding Assistant - AI Coding Assistant Lingma

Gunakan API ini untuk mendapatkan daftar file basis pengetahuan di Lingma.

Edisi yang didukung

Enterprise Dedicated Edition

Titik akhir layanan dan informasi otorisasi

Dapatkan titik akhir layanan untuk mengganti <domain> dalam sintaks permintaan API dengan endpoint Anda.
Peroleh token akses.
Peroleh organizationId. Buka konsol Lingma dan lihat ID organisasi pada halaman Basic Information di bawah Enterprise settings > > Organization.

Sintaks permintaan

GET https://{domain}/oapi/v1/lingma/organizations/{organizationId}/knowledgeBases/{kbId}/files

Header permintaan

Parameter	Tipe	Wajib	Deskripsi	Contoh
`x-yunxiao-token`	string	Ya	Token akses.	pt-0fh3**0fbG_35af**0484

Parameter permintaan

Parameter	Tipe	Posisi	Wajib	Deskripsi	Contoh
`organizationId`	string	path	Ya	ID organisasi.	99d1****71d4
`kbId`	string	path	Ya	ID basis pengetahuan.	3a41****3eca
`query`	string	query	Tidak	Kueri fuzzy untuk nama file.
`orderBy`	string	query	Tidak	Kolom pengurutan. Nilai valid: `gmt_added` `kb_id` `file_state`
`sort`	string	query	Tidak	Urutan pengurutan. Nilai valid: `desc` `asc`
`page`	integer	query	Tidak	Nomor halaman. Nilai default: 1.
`perPage`	integer	query	Tidak	Jumlah entri yang dikembalikan per halaman. Nilai default: 20.

Contoh permintaan

curl -X 'GET' \
  'https://{domain}/oapi/v1/lingma/organizations/{organizationId}/knowledgeBases/{kbId}/files?query={query}&orderBy={orderBy}&sort={sort}&page={page}&perPage={perPage}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Parameter respons

Parameter	Tipe	Deskripsi	Contoh
-	array
-	object
`gmtCreated`	integer	Waktu pembuatan file.	1722149052460
`gmtModified`	integer	Waktu modifikasi file.	1722149055731
`gmtAdded`	integer	Waktu penambahan file.	1722149052515
`fileId`	string	ID file.	30d4****aca4
`filename`	string	Nama file.	history.txt
`fileSize`	string	Ukuran file.	5 B
`filePath`	string	Path ke file.	lingma/rag_kb/9a2b**5ef1/3a413eca/30d4**aca4/history.txt
`fileState`	string	Status file.	PROCESSED
`kdId`	string	ID basis pengetahuan.	3a41****3eca
`organizationId`	string	ID organisasi.	9a2****5ef1
`uploadUser`	object	Pengguna yang menambahkan file.
`id`	string	ID pengguna yang menambahkan file.	d402****9ae6
`displayName`	string	Nama login pembuat anggota (`username`).	lingma
`userName`	string	Nama panggilan pembuat anggota (`nickName`).	lingma004
`avatarUrl`	string	Avatar pengguna yang menambahkan file.	/objects/ajax/default/avatars/bGluZ21h

Contoh respons

[
    {
        "fileId": "30d4****aca4",
        "filePath": "lingma/rag_kb/9a2b****5ef1/3a41****3eca/30d4****aca4/history.txt",
        "fileSize": "5 B",
        "fileState": "PROCESSED",
        "filename": "history.txt",
        "gmtAdded": 1722149052515,
        "gmtCreated": 1722149052460,
        "gmtModified": 1722149055731,
        "kbId": "3a41****3eca",
        "organizationId": "9a2b****5ef1",
        "uploadUser": {
            "avatarUrl": "/objects/ajax/default/avatars/bGluZ21h",
            "displayName": "lingma",
            "id": "d402****9ae6",
            "userName": "lingma004"
        }
    }
]

Header respons

Parameter	Deskripsi	Contoh
`x-next-page`	Halaman berikutnya.	1
`x-per-page`	Jumlah entri per halaman.	100
`x-prev-page`	Halaman sebelumnya.	1
`x-total`	Jumlah total entri.	1
`x-total-pages`	Jumlah total halaman.	1

Contoh header respons

 connection: keep-alive 
 content-length: 481 
 content-type: application/json; charset=UTF-8 
 date: Thu,04 Jul 2024 13:44:21 GMT 
 x-next-page: 1 
 x-per-page: 100  // Jumlah entri per halaman. 
 x-prev-page: 1 
 x-total: 1   // Jumlah total entri yang dikembalikan.
 x-total-pages: 1  // Jumlah total halaman.

Kode kesalahan

Untuk informasi lebih lanjut, lihat Kode kesalahan.