Alibaba Cloud Model Studio:DeleteIndexDocument

Elimina permanentemente archivos de una base de conocimientos especificada.

Descripción de la operación

• Esta operación no admite la eliminación de datos de bases de conocimientos de consulta de datos o de preguntas y respuestas con imágenes. Utilice la consola de Model Studio en su lugar.
• Los usuarios de Resource Access Management (RAM) deben obtener primero los permisos de API para Model Studio (lo cual requiere AliyunBailianDataFullAccess, que incluye el permiso sfm:DeleteIndexDocument), antes de llamar a esta operación. Las cuentas de Alibaba Cloud pueden llamar a esta operación directamente sin autorización. Utilice el SDK de Model Studio más reciente para llamar a esta operación.
• Antes de llamar a esta operación, asegúrese de que su base de conocimientos se ha creado y no se ha eliminado (es decir, que el ID de la base de conocimientos IndexId es válido).
• Solo puede eliminar archivos cuyo estado sea error de importación (INSERT_ERROR) o importación exitosa (FINISH) en la base de conocimientos. Para consultar el estado del archivo en una base de conocimientos especificada, llame a la operación ListIndexDocuments.
• La eliminación es irreversible. El contenido de los archivos eliminados no se puede recuperar y la operación Retrieve ya no podrá recuperar la información relacionada. Proceda con precaución.
• Llamar a esta operación no elimina los documentos que se han importado a Datos de la aplicación.
• Esta operación es idempotente.

Limitación de velocidad: Esta operación se limita si se llama con demasiada frecuencia. No exceda las 10 llamadas por segundo. Si se aplica la limitación, reinténtelo más tarde.

Probar ahora

Pruebe esta API en OpenAPI Explorer; no es necesaria la firma manual. Las llamadas exitosas generan automáticamente código SDK que coincide con sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Prueba

Autorización de RAM

La siguiente tabla describe la autorización necesaria para llamar a esta API. Puede definirla en una política de Resource Access Management (RAM). Las columnas de la tabla se detallan a continuación:

• Action: Las acciones se pueden utilizar en el elemento Action de las declaraciones de políticas de permisos de RAM para otorgar permisos para realizar la operación.

• API: La API que puede llamar para realizar la acción.

• Nivel de acceso: El nivel de acceso predefinido otorgado para cada API. Valores válidos: create, list, get, update y delete.

• Tipo de recurso: El tipo de recurso que admite la autorización para realizar la acción. Indica si la acción admite permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción. De lo contrario, la política será ineficaz.

  • Para las API con permisos a nivel de recurso, los tipos de recursos requeridos están marcados con un asterisco (*). Especifique el Nombre de recurso de Alibaba Cloud (ARN) correspondiente en el elemento Resource de la política.
  • Para las API sin permisos a nivel de recurso, se muestra como Todos los recursos. Utilice un asterisco (*) en el elemento Resource de la política.

• Clave de condición: Las claves de condición definidas por el servicio. La clave permite un control granular, aplicándose ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de claves de condición comunes aplicables a todos los servicios compatibles con RAM.

• Acción dependiente: Las acciones dependientes necesarias para ejecutar la acción. Para completar la acción, el usuario de RAM o el rol de RAM debe tener los permisos para realizar todas las acciones dependientes.

Acción	Nivel de acceso	Tipo de recurso	Clave de condición	Acción dependiente
sfm:DeleteIndexDocument	eliminar	*Todos los recursos *	None	None

Sintaxis de la solicitud

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

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
WorkspaceId	string	Sí	El ID del espacio de trabajo al que pertenece la base de conocimientos. Para obtener información sobre cómo conseguir el ID del espacio de trabajo, consulte Cómo usar un espacio de trabajo.	llm-3z7uw7fwz0vxxxx

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
IndexId	string	Sí	El ID de la base de conocimientos, que es el Data.Id devuelto por la operación CreateIndex.	79c0alxxxx
DocumentIds	array	Sí	La lista de IDs de archivos.
	string	No	El ID del archivo, que es el FileId devuelto por la operación AddFile. También puede obtener el ID del archivo haciendo clic en el icono de ID junto al nombre del archivo en la pestaña Datos de la aplicación - Archivos.	file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx

Elementos de respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta
RequestId	string	El ID de la solicitud.	17204B98-xxxx-4F9A-8464-2446A84821CA
Code	string	El código de error.	Index.InvalidParameter
Message	string	El mensaje de error.	Falta el parámetro obligatorio (%s) o no es válido; compruebe los parámetros de la solicitud.
Success	boolean	Indica si la operación fue exitosa. Valores válidos: true: La operación fue exitosa. false: La operación falló.	true
Data	object	El campo de datos comerciales devuelto por la operación.
DeletedDocument	array	La lista de IDs de archivos eliminados correctamente.
	string	El ID del archivo.	file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx
Status	string	El código de estado devuelto por la operación.	200

Ejemplos

Respuesta exitosa

Formato JSON

{
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Code": "Index.InvalidParameter",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Success": true,
  "Data": {
    "DeletedDocument": [
      "file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx"
    ]
  },
  "Status": "200"
}

Códigos de error

Consulte Códigos de error para obtener una lista completa.

Notas de lanzamiento

Consulte Notas de lanzamiento para obtener una lista completa.