Alibaba Cloud Model Studio:ListFile

Obtém os detalhes de um ou mais documentos em uma categoria especificada.

Descrição da operação

• Os usuários do Resource Access Management (RAM) devem primeiro obter as permissões de API para o Alibaba Cloud Model Studio (requer AliyunBailianDataFullAccess, que inclui a permissão sfm:ListFile) e ingressar em um workspace antes de invocar esta operação. As contas Alibaba Cloud podem invocar esta operação diretamente sem autorização. Invoque esta operação usando o SDK do Alibaba Cloud Model Studio mais recente.
• Para paginação na primeira página, defina apenas MaxResults para limitar o número de entradas retornadas. O NextToken na resposta serve como credencial para consultar as páginas subsequentes. Ao consultar as páginas subsequentes, defina o parâmetro NextToken com o valor NextToken obtido da resposta anterior (se NextToken estiver vazio, todos os resultados foram retornados e nenhuma solicitação adicional é necessária) e defina MaxResults para limitar o número de entradas retornadas.
• Esta operação é idempotente.

Limite de taxa: Esta operação sofre limitação de taxa se chamada com muita frequência. Não exceda 5 chamadas por segundo. Em caso de limitação, 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:ListFile	list	*All Resource *	Nenhuma	Nenhuma

Sintaxe da solicitação

GET /{WorkspaceId}/datacenter/files 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 categoria pertence. Para obter informações sobre como obter o ID do workspace, consulte Como usar um workspace.	llm-3shx2gu255oqxxxx

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
CategoryId	string	Sim	O ID da categoria, que é o CategoryId retornado pela operação AddCategory. Você também pode obtê-lo na guia Dados do aplicativo - Arquivos, clicando no ícone de ID ao lado do nome da categoria. .	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
NextToken	string	Não	O token de paginação. Defina este valor como o valor NextToken retornado pela chamada de API anterior.	AAAAAdH70eOCSCKtacdomNzak4U=
MaxResults	integer	Não	O número de entradas por página para paginação. Valores válidos: 1 a 200. Valor padrão: Se nenhum valor for definido ou se o valor for menor que 1, o valor padrão será 20. Se o valor for definido como maior que 200, o valor padrão será 200.	20
FileName	string	Não	O nome do arquivo (sem extensão). Apenas a correspondência exata é suportada. A pesquisa aproximada não é suportada.	product-overview
FileIds	array	Não	A lista de IDs de arquivos a serem consultados. No máximo 20 arquivos podem ser consultados por vez.
	string	Não	O ID do arquivo.	file_xxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
Code	string	O código de erro.	success
Data	object	O campo de dados retornado pela operação.
FileList	array<object>	A lista de arquivos na categoria.
	object	O objeto de arquivo.
CategoryId	string	The ID of the category to which the file belongs.	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
CreateTime	string	The timestamp when the file was added to Alibaba Cloud Model Studio. Format: yyyy-MM-dd HH:mm:ss. Time zone: UTC+8.	2024-09-09 11:03:35
FileId	string	The file ID, which is the FileId returned by the AddFile operation. You can also obtain it on the Application Data page by clicking the icon next to the file name.	file_5ff599b3455a45db8c41b0054b361518_xxxxxxxx
FileName	string	The file name.	product-overview.pdf
FileType	string	The file format type. Valid values: pdf, docx, doc, txt, md, pptx, ppt, xlsx, xls, html, png, jpg, jpeg, bmp, and gif.	docx
Parser	string	The document parser. Valid values: DASHSCOPE_DOCMIND: Alibaba Cloud intelligent document parsing.	DASHSCOPE_DOCMIND
SizeInBytes	integer	The file size in bytes.	512
Status	string	The file parsing status. Valid values: INIT: Initialization state. Waiting to be scheduled. PARSING: Parsing in progress. PARSE_SUCCESS: Parsing completed. PARSE_FAILED: Parsing failed.	PARSE_SUCCESS
ParseErrorMessage	string	The reason for parsing failure.	Error Message
Tags	array	The list of tags associated with the file. A document can be associated with multiple tags.
	string	The file tag.	tag-A
HasNext	boolean	Indica se há uma próxima página de dados da categoria que corresponde às condições da consulta. Valores válidos: true: Sim. false: Não.	true
MaxResults	integer	O número de entradas por página para paginação.	20
NextToken	string	O token de paginação retornado por esta chamada.	4jzbJk9J6lNeuXD9hP0viA==
TotalCount	integer	O número total de entradas nos resultados retornados.	48
Message	string	A mensagem de erro.	Requests throttling triggered.
RequestId	string	O ID da solicitação.	8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1
Status	string	O código de status retornado pela operação.	200
Success	boolean	Indica se a operação foi bem-sucedida. Valores válidos: true: Bem-sucedida. false: Falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "success",
  "Data": {
    "FileList": [
      {
        "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx",
        "CreateTime": "2024-09-09 11:03:35",
        "FileId": "file_5ff599b3455a45db8c41b0054b361518_xxxxxxxx",
        "FileName": "product-overview.pdf",
        "FileType": "docx",
        "Parser": "DASHSCOPE_DOCMIND",
        "SizeInBytes": 512,
        "Status": "PARSE_SUCCESS",
        "ParseErrorMessage": "Error Message",
        "Tags": [
          "tag-A"
        ]
      }
    ],
    "HasNext": true,
    "MaxResults": 20,
    "NextToken": "4jzbJk9J6lNeuXD9hP0viA==",
    "TotalCount": 48
  },
  "Message": "Requests throttling triggered.",
  "RequestId": "8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1",
  "Status": "200",
  "Success": true
}

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.