Todos os produtos
Search

Este produto

    Qoder CN Series:Listar bases de conhecimento

    Central de documentação

    Qoder CN Series:Listar bases de conhecimento

    Última atualização: Jun 29, 2026

    Recupera uma lista de bases de conhecimento do Lingma.

    Lingma

    Edições compatíveis

    Enterprise Dedicated Edition

    Endpoints de serviço

    Obtenha o endpoint de serviço e substitua {domain} na sintaxe da solicitação de API pelo seu endpoint.

    Autorização

    Produto

    Recurso

    Permissão necessária

    Lingma

    base de conhecimento

    Somente leitura

    Sintaxe da solicitação

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

    Solicitação

    Todas as bases de conhecimento

    curl -X 'GET' \
      'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/lingma/organizations/6826e1d0516a9f85a08c****/knowledgeBases' \
      -H 'Content-Type: application/json' \
      -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

    Pesquisar por nome

    curl -X 'GET' \
      'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/lingma/organizations/6826e1d0516a9f85a08c****/knowledgeBases?query=t' \
      -H 'Content-Type: application/json' \
      -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

    Filtrar por tipo de cenário

    curl -X 'GET' \
      'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/lingma/organizations/6826e1d0516a9f85a08c****/knowledgeBases?sceneType=chat' \
      -H 'Content-Type: application/json' \
      -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

    Cabeçalhos da solicitação

    x-yunxiao-token string (Obrigatório)

    O token de acesso. Consulte Token de acesso para obter mais detalhes.

    Exemplo: pt-0fh3****0fbG_35af****0484.

    Parâmetros da solicitação

    organizationId string (Obrigatório)

    ID da organização. Obtenha o ID da organização na página Basic Information do Admin Console.

    query string (Opcional)

    Palavra-chave para pesquisa aproximada pelo nome da base de conhecimento.

    sceneType string (Opcional)

    Tipo de cenário. Valores válidos:

    • chat: cenário de chat.

    • complement: cenário de conclusão de código. Se você não especificar o parâmetro sceneType, a API retornará bases de conhecimento de todos os tipos de cenário.

    orderBy string (Opcional)

    Campo usado para ordenar os resultados. Valores válidos:

    • name: nome da base de conhecimento.

    • sceneType: tipo de cenário da base de conhecimento.

    • size: tamanho da base de conhecimento.

    • fileCount: número de arquivos na base de conhecimento.

    • lastActivityTime: hora da última atividade.

    • gmtCreate: data de criação.

    sort string (Opcional)

    Ordem de classificação. Valores válidos:

    • desc: ordem decrescente.

    • asc: ordem crescente.

    userId string (Opcional)

    Especifique um ID de usuário para retornar apenas as bases de conhecimento acessíveis a esse usuário. Se omitido, todas as bases de conhecimento da organização serão retornadas.

    page integer (Opcional) Padrão: 1

    Número da página.

    perPage integer (Opcional) Padrão: 20

    Número de itens a serem retornados por página. Valores válidos: de 1 a 20.

    Parâmetros de resposta

    Exemplo de resposta

    [
    {
        "accessLevel": 10,
        "creator": {
            "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/113iaf62a4481af4cd44ad46d8c3e9b55851/w/100/h/100",
            "displayName": "fangqian_testcloud_com",
            "id": "66a6f60e368d88cff5a513fc",
            "userName": "test"
        },
        "description": "",
        "fileCount": 0,
        "gmtCreate": 1749712990396,
        "gmtModified": 1749712990396,
        "id": "7d9800958eabaa982de687c8",
        "lastActivityTime": 1749712990396,
        "memberCount": 1,
        "name": "test",
        "organizationId": "6826e1d0516a9f85a08cb522",
        "sceneType": "chat",
        "size": "0 B",
        "state": "disable"
    }
]

    accessLevel integer

    Visibilidade da base de conhecimento. Valores válidos:

    • 0: base de conhecimento privada.

    • 10: base de conhecimento pública.

    creator object

    Usuário que criou a base de conhecimento.

    Propriedades

    avatarUrl string

    URL do avatar do criador.

    displayName string

    Nome de exibição do criador.

    id string

    ID do criador.

    userName string

    Nome de usuário do criador.

    description string

    Descrição da base de conhecimento.

    fileCount integer

    Número de arquivos na base de conhecimento.

    gmtCreate integer

    Data de criação, representada como um timestamp UNIX em milissegundos.

    gmtModified integer

    Data de modificação, representada como um timestamp UNIX em milissegundos.

    id string

    ID da base de conhecimento.

    lastActivityTime integer

    Hora da última atividade, representada como um timestamp UNIX em milissegundos.

    memberCount integer

    Número de membros na base de conhecimento.

    name string

    Nome da base de conhecimento.

    organizationId string

    ID da organização à qual a base de conhecimento pertence.

    sceneType string

    Tipo de cenário da base de conhecimento. Valores válidos:

    • chat: cenário de chat.

    • complement: cenário de conclusão de código.

    size string

    Tamanho da base de conhecimento.

    state string

    Status da base de conhecimento. Valores válidos:

    • enable: a base de conhecimento está ativa.

    • disable: a base de conhecimento está inativa.

    Cabeçalhos de resposta

    Parâmetro

    Descrição

    Exemplo

    x-next-page

    Número da próxima página.

    1

    x-page

    Número da página atual.

    1

    x-per-page

    Número de itens por página.

    20

    x-prev-page

    Número da página anterior.

    1

    x-total

    Total de itens.

    9

    x-total-pages

    Total de páginas.

    1

    Códigos de erro

    Para obter mais informações, consulte a Central de códigos de erro.