次の方法で共有

バッチ適用モデル

  • [アーティクル]

トレーニング済みのドキュメント理解モデルを 1 つ以上のライブラリに適用 (または同期) します ( 例を参照)。

HTTP 要求

POST /_api/machinelearning/publications HTTP/1.1

URI パラメーター

なし

要求ヘッダー

ヘッダー 値
Accept application/json;odata=verbose
Content-Type application/json;odata=verbose;charset=utf-8
x-requestdigest 現在のサイトの適切なダイジェスト。

要求本文

名前 必須 型 説明
__metadata ○ 文字列 SPO でオブジェクト メタを設定します。 常に値 {"type": "Microsoft.Office.Server.ContentCenter.SPMachineLearningPublicationsEntityData"} を使用します。
発行元 ○ MachineLearningPublicationEntityData[] それぞれがモデルとターゲット ドキュメント ライブラリを指定する MachineLearningPublicationEntityData のコレクション。

MachineLearningPublicationEntityData

名前 必須 型 説明
ModelUniqueId ○ 文字列 モデル ファイルの一意の ID。
TargetSiteUrl ○ 文字列 ターゲット ライブラリ サイトの完全な URL。
TargetWebServerRelativeUrl ○ 文字列 ターゲット ライブラリの Web のサーバー相対 URL。
TargetLibraryServerRelativeUrl ○ 文字列 ターゲット ライブラリのサーバー相対 URL。
ViewOption いいえ string 新しいモデル ビューをライブラリの既定値として設定するかどうかを指定します。

応答

名前 型 説明
201 Created これは、複数のドキュメント ライブラリへのモデルの適用をサポートするためにカスタマイズされた API です。 部分的に成功した場合でも、作成された 201 が返される可能性があり、呼び出し元は応答本文を調べて、モデルがドキュメント ライブラリに正常に適用されたかどうかを理解する必要があります。

応答本文

名前 型 説明
TotalSuccesses 整数 ドキュメント ライブラリに正常に適用されたモデルの総数。
TotalFailures 整数 ドキュメント ライブラリへの適用に失敗したモデルの総数。
詳細 MachineLearningPublicationResult[] MachineLearningPublicationResult のコレクション。それぞれが、ドキュメント ライブラリにモデルを適用した詳細な結果を指定します。

MachineLearningPublicationResult

名前 型 説明
StatusCode 整数 HTTP 状態コード。
ErrorMessage 文字列 モデルをドキュメント ライブラリに適用するときに何が問題になっているのかを示すエラー メッセージ。
発行元 MachineLearningPublicationEntityData モデル情報とターゲット ドキュメント ライブラリを指定します。

MachineLearningPublicationEntityData

名前 型 説明
ModelUniqueId 文字列 モデル ファイルの一意の ID。
TargetSiteUrl 文字列 ターゲット ライブラリ サイトの完全な URL。
TargetWebServerRelativeUrl 文字列 ターゲット ライブラリの Web のサーバー相対 URL。
TargetLibraryServerRelativeUrl 文字列 ターゲット ライブラリのサーバー相対 URL。

例

リポジトリ サイトの契約書ドキュメント ライブラリにモデルを適用する

このサンプルでは、Contoso 契約書ドキュメント理解モデルの ID は 7645e69d-21fb-4a24-a17a-9bdfa7cb63dcです。

要求のサンプル

{
    "__metadata": {
        "type": "Microsoft.Office.Server.ContentCenter.SPMachineLearningPublicationsEntityData"
    },
    "Publications": {
        "results": [
            {
                "ModelUniqueId": "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc",
                "TargetSiteUrl": "https://contoso.sharepoint.com/sites/repository/",
                "TargetWebServerRelativeUrl": "/sites/repository",
                "TargetLibraryServerRelativeUrl": "/sites/repository/contracts",
                "ViewOption": "NewViewAsDefault"
            }
        ]
    }
}

応答のサンプル

応答では、TotalFailures と TotalSuccinstalls は、指定されたライブラリに適用されるモデルの失敗と成功の数を示します。

状態コード : 201

{
    "Details": [
        {
            "ErrorMessage": null,
            "Publication": {
                "ModelUniqueId": "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc",
                "TargetSiteUrl": "https://contoso.sharepoint.com/sites/repository/",
                "TargetWebServerRelativeUrl": "/sites/repository",
                "TargetLibraryServerRelativeUrl": "/sites/repository/contracts",
                "ViewOption": "NewViewAsDefault"
            },
            "StatusCode": 201
        }
    ],
    "TotalFailures": 0,
    "TotalSuccesses": 1
}

関連項目

Syntex 文書理解モデル REST API