ListKnowledgeBases_Lingma_AI Coding Assistant - AI Coding Assistant Lingma

Gunakan API ini untuk mendapatkan daftar basis pengetahuan 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 di halaman Basic Information di bawah Enterprise settings > > Organization.

Sintaks permintaan

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

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
`query`	string	query	Tidak	Nama basis pengetahuan. Mendukung pencocokan kabur.
`sceneType`	string	query	Tidak	Tipe skenario dari basis pengetahuan. Nilai valid: `answer`: Obrolan `complement`: Penyelesaian kode Jika parameter ini kosong, basis pengetahuan dari semua tipe skenario akan diperiksa.
`orderBy`	string	query	Tidak	Kolom pengurutan. Nilai valid: `name` `scene_type` `size` `file_count` `last_activity_time` `gmt_created`
`sort`	string	query	Tidak	Urutan pengurutan. Nilai valid: `desc` `asc`
`userId`	string	query	Tidak	ID pengguna. Jika Anda menentukan ID pengguna, hanya basis pengetahuan yang dapat diakses oleh pengguna tersebut yang akan diperiksa. Jika parameter ini kosong, semua basis pengetahuan akan diperiksa.
`page`	integer	query	Tidak	Nomor halaman.
`perPage`	integer	query	Tidak	Jumlah entri per halaman.

Contoh permintaan

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

Parameter respons

Parameter	Tipe	Deskripsi	Contoh
`id`	string	ID basis pengetahuan.	3a41****3eca
`name`	string	Nama basis pengetahuan.	Basis Pengetahuan Perusahaan
`description`	string	Deskripsi basis pengetahuan.	ini adalah tes
`size`	string	Ukuran basis pengetahuan.	5 B
`fileCount`	integer	Jumlah file dalam basis pengetahuan.	1
`sceneType`	string	Tipe skenario dari basis pengetahuan. Nilai valid: `answer`: Obrolan `complement`: Penyelesaian kode	answer
`accessLevel`	integer	Kontrol akses basis pengetahuan. Nilai valid: `0`: basis pengetahuan pribadi. `10`: basis pengetahuan publik.	0
`state`	string	Status basis pengetahuan. Nilai valid: `enable` `disable`	disable
`creator`	object	Pembuat basis pengetahuan.
`id`	string	ID pembuat basis pengetahuan.	d402****9ae6
`displayName`	string	Nama login pembuat.	lingma
`userName`	string	Nama panggilan pembuat.	lingma
`avatarUrl`	string	Foto profil pembuat.	/objects/ajax/default/avatars/bGluZ21h
`organizationId`	string	ID organisasi tempat basis pengetahuan berada.	9a2b****5ef1
`gmtCreate`	integer	Waktu pembuatan basis pengetahuan.	1722147833968
`gmtModified`	integer	Waktu terakhir pembaruan basis pengetahuan.	1722149054399
`lastActivityTime`	integer	Waktu terakhir aktivitas basis pengetahuan.	1722149052564
`memberCount`	integer	Jumlah anggota yang memiliki izin untuk mengakses basis pengetahuan.	3

Contoh respons

[
  {
        "accessLevel": 0,
        "creator": {
            "avatarUrl": "/objects/ajax/default/avatars/bGluZ21h",
            "displayName": "lingma",
            "id": "d402****9ae6",
            "userName": "lingma"
        },
        "description": "ini adalah tes",
        "fileCount": 1,
        "gmtCreate": 1722147833968,
        "gmtModified": 1722149054399,
        "id": "3a41****3eca",
        "lastActivityTime": 1722149052564,
        "memberCount": 3,
        "name": "Basis Pengetahuan Perusahaan",
        "organizationId": "9a2b****5ef1",
        "sceneType": "answer",
        "size": "5 B",
        "state": "disable"
    },
    {
        "accessLevel": 0,
        "creator": {
            "avatarUrl": "/objects/ajax/default/avatars/bGluZ21h",
            "displayName": "lingma",
            "id": "d402****9ae6",
            "userName": "lingma"
        },
        "description": "",
        "fileCount": 0,
        "gmtCreate": 1722147486046,
        "gmtModified": 1722147486046,
        "id": "2660****27f5",
        "lastActivityTime": 1722147486046,
        "memberCount": 1,
        "name": "Basis Pengetahuan Khusus-Tes",
        "organizationId": "9a2b****5ef1",
        "sceneType": "answer",
        "size": "0 B",
        "state": "disable"
    }
]

Header respons

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

Kode kesalahan

Untuk informasi lebih lanjut, lihat Kode kesalahan.