Alibaba Cloud Model Studio:DeleteFile

Exclui permanentemente um arquivo especificado dos dados da aplicação. A exclusão de tabelas de dados via API não é suportada. Para obter mais detalhes, consulte o Guia da API abaixo.

Descrição da operação

• A exclusão de tabelas de dados via API não é suportada. Para excluir uma tabela de dados ou dados específicos dentro de uma tabela, acesse Dados da aplicação para realizar a operação.
• Esta API é usada para excluir arquivos em Dados da aplicação e não afeta nenhuma base de conhecimento que já tenha sido criada. Para excluir um arquivo de uma base de conhecimento, invoque a API DeleteIndexDocument.
• Um usuário RAM deve primeiro obter as permissões de API para o Alibaba Cloud Model Studio (requer AliyunBailianDataFullAccess, que inclui o ponto de permissão sfm:DeleteFile) e entrar em um workspace antes de invocar esta API. Uma conta Alibaba Cloud pode invocar esta API diretamente sem autorização. Recomendamos que você use a versão mais recente do SDK do Alibaba Cloud Model Studio para invocar esta API.
• Esta API pode excluir apenas arquivos cujo status seja Falha na análise (PARSE_FAILED) ou Análise bem-sucedida (PARSE_SUCCESS).
• Esta API é idempotente.

Aviso de limitação de taxa:
A invocação frequente desta API acionará a limitação de taxa. Não exceda 10 solicitações por segundo. Em caso de limitação de taxa, tente novamente após uma breve espera.

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:DeleteFile	delete	*All Resource *	Nenhuma	Nenhuma

Sintaxe da solicitação

DELETE /{WorkspaceId}/datacenter/file/{FileId}/ HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
FileId	string	Sim	O ID do arquivo, que é o FileId retornado pela API AddFile. Você também pode obtê-lo na página Dados da aplicação clicando no ícone de ID ao lado do nome do arquivo.	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
WorkspaceId	string	Sim	O ID do workspace ao qual o arquivo pertence. Para obter informações sobre como obter o ID, consulte Como usar workspaces.	llm-3shx2gu255oxxxx

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
Code	string	O código de status do erro.	InvalidParameter
Data	object	O campo de dados de negócios da resposta da API.
FileId	string	O ID do arquivo.	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
Message	string	A mensagem de erro.	Current file status does not support delete.
RequestId	string	O ID da solicitação.	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	O código de status retornado pela API.	200
Success	boolean	Indica se a chamada da API foi bem-sucedida. Valores válidos: true: Bem-sucedida. false: Falha.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "InvalidParameter",
  "Data": {
    "FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx"
  },
  "Message": "Current file status does not support delete.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "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.