Skip to main content
Base de conhecimento

ListIndexDocuments

Obtém arquivos e suas informações resumidas de uma base de conhecimento especificada.

Descrição da operação

  • Os usuários do Resource Access Management (RAM) devem primeiro obter permissões de API para o Model Studio (requer AliyunBailianDataFullAccess, que inclui a permissão sfm:ListIndexFiles) e ingressar em um workspace antes de invocar esta operação. As contas da Alibaba Cloud podem invocar esta operação diretamente sem autorização. Use a versão mais recente do SDK do Model Studio para invocar esta operação.
  • Antes de invocar esta operação, certifique-se de que sua base de conhecimento foi criada e não foi excluída (ou seja, o ID da base de conhecimento IndexId é válido).
  • Esta operação possui idempotência.
Limitação de taxa: Esta operação é limitada se chamada com muita frequência. Não exceda 15 chamadas por segundo. Se for limitado, tente novamente mais tarde.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:
  • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
  • API: A API que você pode chamar para executar a ação.
  • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
  • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
    • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
    • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
  • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
  • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

sfm:ListIndexFiles

list

*全部资源

*

NenhumaNenhuma

Sintaxe da solicitação 

GET /{WorkspaceId}/index/list_index_documents HTTP/1.1

Parâmetros de caminho

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

WorkspaceId

string

Sim

O ID do workspace da base de conhecimento. Para obter informações sobre como obter o ID do workspace, consulte Como usar um workspace.

llm-3z7uw7fwz0vexxxx

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

IndexId

string

Sim

O ID da base de conhecimento, que é o Data.Id retornado pela operação CreateIndex.

79c0alxxxx

DocumentStatus

string

Não

Filtra a lista de arquivos retornada pelo status de importação do arquivo. Valores válidos:

  • INSERT_ERROR: falha ao importar para o índice.

  • RUNNING: criação do índice em andamento.

  • DELETED: excluído.

  • FINISH: criação do índice bem-sucedida.

  • PARSE_FAILED: falha na análise.

  • DOC_PARSING: análise em andamento.

Valor padrão: vazio, o que significa nenhuma filtragem pelo status de importação do arquivo.

Valores válidos:

  • INSERT_ERROR :

    Falha na importação do arquivo.

  • RUNNING :

    Importação do arquivo em andamento.

  • DELETED :

    Arquivo excluído.

  • FINISH :

    Importação do arquivo bem-sucedida.

FINISH

DocumentName

string

Não

Filtra a lista de arquivos retornada pelo nome do arquivo (sem a extensão do arquivo). Valor padrão: vazio, o que significa nenhuma filtragem pelo nome do arquivo.

product-overview

EnableNameLike

string

Não

Especifica se a correspondência aproximada para nomes de arquivos deve ser ativada. Este parâmetro é usado em conjunto com o parâmetro DocumentName. Valores válidos:

  • true: Realiza correspondência aproximada na lista de arquivos retornada com base no nome do arquivo.

  • false: Realiza correspondência exata na lista de arquivos retornada com base no nome do arquivo.

Valor padrão: false.

Valores válidos:

  • true :

    ativado.

  • false :

    desativado.

false

PageNumber

integer

Não

O número da página. Valor mínimo: 1. Valor padrão: 1.

1

PageSize

integer

Não

O número de arquivos a serem exibidos por página em uma consulta paginada. Sem limite máximo. Valor padrão: 10.

10

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Esquema da resposta.

RequestId

string

O ID da solicitação.

35A267BF-xxxx-54DB-8394-AA3B0742D833

Code

string

O código de status do erro.

InvalidParameter

Message

string

A mensagem de erro.

Required parameter(%s) missing or invalid, please check the request parameters.

Success

boolean

Indica se a operação foi bem-sucedida. Valores válidos:

  • true: Bem-sucedida.

  • false: Falhou.

true

Data

object

O campo de dados retornado pela operação.

Documents

array<object>

A lista de arquivos na base de conhecimento, classificada pela hora de importação do documento em ordem decrescente (consistente com o console).

object

O objeto de arquivo.

SourceId

string

Para bases de conhecimento de pesquisa de documentos, este parâmetro especifica o ID da categoria, que é o CategoryId retornado pela operação AddCategory. Você também pode obtê-lo clicando no ícone de ID ao lado do nome da categoria na guia Arquivos de Dados do aplicativo.

Para bases de conhecimento de consulta de dados ou perguntas e respostas de imagens, este parâmetro especifica o ID da tabela de dados. Você pode obtê-lo clicando no ícone de ID ao lado do nome da tabela de dados na guia Tabelas de Dados do aplicativo.

cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx

Id

string

O ID do arquivo.

doc_c134aa2073204a5d936d870bf960f56axxxxxxxx

Name

string

O nome do arquivo.

product-overview

Size

integer

O tamanho do arquivo, em bytes.

996765

DocumentType

string

O tipo de formato do arquivo. Valores válidos: pdf, docx, doc, txt, md, pptx, ppt, png, jpg, jpeg, bmp, gif e EXCEL.

pdf

Status

string

O status de importação do arquivo. Valores válidos:

  • INSERT_ERROR: Falha na importação do arquivo.

  • RUNNING: Importação do arquivo em andamento.

  • DELETED: Arquivo excluído.

  • FINISH: Importação do arquivo bem-sucedida.

Valores válidos:

  • INSERT_ERROR :

    Falha na importação do arquivo.

  • RUNNING :

    Importação do arquivo em andamento.

  • DELETED :

    Arquivo excluído.

  • FINISH :

    Importação do arquivo bem-sucedida.

RUNNING

Code

string

O código de status do erro para a importação do arquivo.

110002

Message

string

A mensagem de erro para a importação do arquivo.

check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid

GmtModified

integer

A hora em que o arquivo foi importado para a base de conhecimento, no formato de carimbo de data/hora UNIX.

1744856423000

IndexId

string

O ID da base de conhecimento.

pno97txxxx

TotalCount

integer

O número total de resultados retornados.

2437

PageNumber

integer

O número da página retornada.

1

PageSize

integer

O número de entradas retornadas por página.

10

Status

string

O código de status retornado pela operação.

200

Exemplos

Resposta de sucesso JSON formato 
{
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
  "Code": "InvalidParameter",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Success": true,
  "Data": {
    "Documents": [
      {
        "SourceId": "cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx",
        "Id": "doc_c134aa2073204a5d936d870bf960f56axxxxxxxx",
        "Name": "product-overview",
        "Size": 996765,
        "DocumentType": "pdf",
        "Status": "RUNNING",
        "Code": "110002",
        "Message": "check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid",
        "GmtModified": 1744856423000
      }
    ],
    "IndexId": "pno97txxxx",
    "TotalCount": 2437,
    "PageNumber": 1,
    "PageSize": 10
  },
  "Status": "200"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.
Chamada de Aplicação
Componentes do aplicativo
Assistant API (Deprecated)
Mais