Exclui permanentemente arquivos de uma base de conhecimento especificada.
Descrição da operação
- Esta operação não oferece suporte à exclusão de dados de bases de conhecimento de consulta de dados ou de perguntas e respostas com imagens. Em vez disso, use o console do Model Studio.
- Os usuários do Resource Access Management (RAM) devem primeiro obter as permissões de API para o Model Studio (requer AliyunBailianDataFullAccess, que inclui a permissão sfm:DeleteIndexDocument) antes de chamar esta operação. As contas da Alibaba Cloud podem chamar esta operação diretamente sem autorização. Use a versão mais recente do Model Studio SDK para chamar esta operação.
- Antes de chamar 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).
- Você só pode excluir arquivos cujo status seja falha na importação (INSERT_ERROR) ou importação bem-sucedida (FINISH) na base de conhecimento. Para consultar o status do arquivo em uma base de conhecimento especificada, chame a operação ListIndexDocuments.
- A exclusão é irreversível. O conteúdo dos arquivos excluídos não pode ser recuperado, e a operação Retrieve não poderá mais recuperar informações relacionadas. Prossiga com cautela.
- Chamar esta operação não exclui documentos que foram importados para Dados do Aplicativo.
- Esta operação é idempotente.
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
Actiondas 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
Resourceda política. - Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento
Resourceda política.
- 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
- 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:DeleteIndexDocument | delete | *All Resource
| Nenhuma | Nenhuma |
Sintaxe da solicitação
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-3z7uw7fwz0vxxxx |
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 |
| DocumentIds | array | Sim | A lista de IDs de arquivo. | |
string | Não | O ID do arquivo, que é o FileId retornado pela operação AddFile. Você também pode obter o ID do arquivo clicando no ícone de ID ao lado do nome do arquivo na guia Dados do Aplicativo - Arquivos. | file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx |
Elementos de resposta
Elemento | Tipo | Descrição | Exemplo |
|---|---|---|---|
object | Esquema da resposta. | ||
| RequestId | string | O ID da solicitação. | 17204B98-xxxx-4F9A-8464-2446A84821CA |
| Code | string | O código de erro. | Index.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 |
| Data | object | O campo de dados de negócios retornado pela operação. | |
| DeletedDocument | array | A lista de IDs de arquivos excluídos com êxito. | |
string | O ID do arquivo. | file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx | |
| Status | string | O código de status retornado pela operação. | 200 |
Exemplos
Resposta de sucesso
JSON formato