Todos os produtos
Search

Este produto

    Alibaba Cloud Model Studio:ListIndexFileDetails

    Central de documentação

    Alibaba Cloud Model Studio:ListIndexFileDetails

    Última atualização: Sep 02, 2026

    Obtém arquivos e seus detalhes 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 Alibaba Cloud Model Studio (requer AliyunBailianDataFullAccess, que inclui a permissão sfm:ListIndexFiles), antes de invocar esta operação. As contas Alibaba Cloud podem invocar esta operação diretamente sem autorização. Invoque esta operação através da versão mais recente do SDK do Alibaba Cloud Model Studio.
    • 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.

    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:ListIndexFileDetails

    list

    *Todos os recursos.

    *

    		NenhumaNenhuma

    Sintaxe da solicitação 

    POST /{WorkspaceId}/index/list_index_file_detail HTTP/1.1

    Parâmetros de caminho

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo

    WorkspaceId

    string

    Sim

    O ID do workspace ao qual a base de conhecimento pertence. 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

    Não

    O ID da base de conhecimento, que corresponde ao 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 na importação para o índice.

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

    • DELETED: Excluído.

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

    • PARSE_FAILED: Falha na análise.

    • DOC_PARSING: Análise em andamento.

    Valor padrão: vazio, o que significa que não há filtragem por status de importação de arquivo.

    FINISH.

    DocumentName

    string

    Não

    Filtra a lista de detalhes de arquivos retornada pelo nome do arquivo. Valor padrão: vazio, o que significa que não há filtragem por nome de arquivo.

    TranslationPlatformO&MDocument.

    PageNumber

    integer

    Não

    O número da página a ser consultado. 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. Valor máximo: 10.

    10

    EnableNameLike

    string

    Não

    Especifica se a correspondência difusa 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 difusa 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.

    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 de 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-sucedido.

    • false: Falha.

    true.

    Data

    object

    O campo de dados de negócio da operação.

    Documents

    array<object>

    A lista de arquivos na base de conhecimento, ordenada em ordem decrescente pelo horário de importação do arquivo (consistente com o console).

    object

    O objeto de arquivo.

    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.

    RUNNING.

    EnableHeaders

    string

    Indica se os cabeçalhos de arquivos Excel suportam concatenação.

    true.

    Message

    string

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

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

    Size

    integer

    O tamanho do arquivo, em bytes.

    996764

    SourceId

    string

    O ID da categoria.

    cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx.

    DocumentType

    string

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

    pdf.

    Id

    string

    O ID do arquivo.

    doc_c134aa2073204a5d936d870bf960f56axxxxxxxx.

    Code

    string

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

    110002

    Name

    string

    O nome do arquivo.

    TranslationPlatformO&MDocument.

    ChunkSize

    string

    O comprimento do fragmento, que é o número de caracteres em um fragmento de texto.

    600

    OverlapSize

    string

    O comprimento de sobreposição do fragmento.

    100

    ChunkMode

    string

    O modo de fragmentação personalizado.

    DashSplitter.

    GmtModified

    integer

    A hora em que o arquivo foi importado para a base de conhecimento, no formato de timestamp Unix.

    1744856423000

    separator

    string

    O separador de sentenças.

    " "

    MetaExtractInfo

    string

    { "doc_summary": ["Example 1."], "health_rule": ["Example 2"] }

    IndexId

    string

    O ID da base de conhecimento.

    79c0alxxxx.

    TotalCount

    integer

    O número total de resultados retornados.

    2437

    PageNumber

    integer

    O número da página retornado.

    1

    PageSize

    integer

    O número de itens por página retornado.

    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": [
      {
        "Status": "RUNNING.",
        "EnableHeaders": "true.",
        "Message": "check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid.",
        "Size": 996764,
        "SourceId": "cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx.",
        "DocumentType": "pdf.",
        "Id": "doc_c134aa2073204a5d936d870bf960f56axxxxxxxx.",
        "Code": "110002",
        "Name": "TranslationPlatformO&MDocument.",
        "ChunkSize": "600",
        "OverlapSize": "100",
        "ChunkMode": "DashSplitter.",
        "GmtModified": 1744856423000,
        "separator": "\" \"",
        "MetaExtractInfo": "{\n  \"doc_summary\": [\"Example 1.\"],\n  \"health_rule\": [\"Example 2\"]\n}"
      }
    ],
    "IndexId": "79c0alxxxx.",
    "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.