非構造化ドキュメント処理モデル REST API のMicrosoft Syntex
SharePoint REST インターフェイスを使用して、非構造化ドキュメント処理モデルを作成したり、モデルを 1 つ以上のライブラリに適用または削除したり、モデルに関する情報を取得または更新したりできます。
SharePoint Online (および SharePoint 2016 以降のオンプレミス) REST サービスでは、OData $batch クエリ オプションを使って、サービスに対する複数の要求を 1 つの呼び出しに統合できます。
詳細とコード サンプルへのリンクについては、「REST API によりバッチ要求を発行する」を参照してください。
前提条件
作業の開始前に、次に示す事項について十分に理解しておいてください。
REST コマンド
Syntex 非構造化ドキュメント処理モデルを操作するには、次の REST コマンドを使用できます。
- モデルの作成 – モデルとそれに関連付けられたコンテンツ タイプを作成します。
- GetByUniqueId – Syntex 非構造化ドキュメント処理モデルに関する情報を取得または更新します。
- GetByTitle – モデル タイトルを使用して Syntex 非構造化ドキュメント処理モデルに関する情報を取得または更新します。
- モデルの適用 – トレーニング済みの非構造化ドキュメント処理モデルを 1 つ以上のライブラリに適用 (または同期) します。
- モデルとライブラリの情報を取得 – モデルと、それが適用されているライブラリに関する情報を取得します。
- UpdateModelSettings – Syntex 非構造化ドキュメント処理モデルで使用可能なモデル設定 (関連する保持ラベルとモデルの説明) を更新します。
- BatchDelete – 適用された非構造化ドキュメント処理モデルを 1 つ以上のライブラリから削除します。
- ファイル分類要求の作成 – 適用されたモデルを使用して、指定したファイルを分類する要求を作成します。
- フォルダー分類要求の作成 – 適用されたモデルを使用して、フォルダー全体を分類する要求を作成します。
シナリオ
メソッドの名前からは直感的に理解できないような、次に示すシナリオ例にご注意ください。 詳細については、各手順を参照してください。
[モデル作成] メソッドは、モデル オブジェクトとそれに関連付けられたコンテンツ タイプのみを作成します。 ライブラリに適用する前に、まずコンテンツ センターでモデルをトレーニングする必要があります。
[モデル適用] メソッドを使用して、ドキュメントを分類し、必要に応じて追加情報を抽出するようにターゲット ライブラリのモデルを構成します。 この API では、モデルを複数のライブラリにバッチ適用することもできます。
[モデル削除] メソッドは、以前に適用された 1 つ以上のライブラリからモデルを削除するだけです。 モデルを削除する場合は、まず、モデルが適用されたすべてのライブラリから削除する必要があります。