Microsoft Syntex API REST del modelo de procesamiento de documentos no estructurado

  • Artículo

Puede usar la interfaz REST de SharePoint para crear un modelo de procesamiento de documentos no estructurado, aplicar o quitar el modelo a una o varias bibliotecas y obtener o actualizar información sobre el modelo.

El servicio REST de SharePoint Online (y SharePoint 2016 o versiones posteriores locales) admite la combinación de varias solicitudes en una sola llamada al servicio mediante el uso de la opción de consulta $batch de OData.

Para obtener información detallada y vínculos a los ejemplos de código, vea Realizar solicitudes de lote con las API de REST.

Requisitos previos

Antes de empezar, asegúrese de que está familiarizado con lo siguiente:

Comandos de REST

Los siguientes comandos REST están disponibles para trabajar con modelos de procesamiento de documentos no estructurados de Syntex:

  • Crear modelo: Crea un modelo y su tipo de contenido asociado.
  • GetByUniqueId : obtiene o actualiza información sobre un modelo de procesamiento de documentos no estructurados de Syntex.
  • GetByTitle : obtiene o actualiza información sobre un modelo de procesamiento de documentos no estructurado de Syntex mediante el título del modelo.
  • Aplicar modelo : aplica (o sincroniza) un modelo de procesamiento de documentos no estructurado entrenado a una o varias bibliotecas.
  • Obtener información de modelo y biblioteca: Obtiene información sobre un modelo y la biblioteca donde se ha aplicado.
  • UpdateModelSettings: Novedades configuración de modelos disponibles (etiqueta de retención asociada y descripción del modelo) para un modelo de procesamiento de documentos no estructurados de Syntex.
  • BatchDelete : quita un modelo de procesamiento de documentos no estructurado aplicado de una o varias bibliotecas.
  • Crear solicitud de clasificación de archivos: Crea una solicitud para clasificar un archivo o archivos especificados con el modelo aplicado.
  • Crear solicitud de clasificación de carpetas: Crea una solicitud para clasificar una carpeta completa con el modelo aplicado.

Escenarios

Tenga en cuenta los ejemplos de escenarios siguientes que no son intuitivos a partir del nombre del método. Para obtener más información, consulte todos los artículos.

El método de creación de modelo solo crea el objeto de modelo y su tipo de contenido asociado. Primero debe entrenar el modelo en el centro de contenido para que se pueda aplicar en una biblioteca.

El método de "aplicar modelo" se usa para configurar el modelo en la biblioteca de destino para clasificar documentos y, de manera opcional, extraer información adicional. Esta API también es compatible con la aplicación por lotes del modelo a varias bibliotecas.

El método de "eliminar modelo" solo quita el modelo de una o más bibliotecas donde se haya aplicado anteriormente. Si quiere eliminar el modelo, primero debe quitarse de todas las bibliotecas donde se ha aplicado.

Ver también

Introducción al procesamiento de documentos no estructurados