Skip to main content

spp model get

Retrieves information about a document understanding model

Usage​

m365 spp model get [options]

Options​

-u, --siteUrl <siteUrl>

The URL of the content center site.

-i, --id [id]

The unique ID of the model to retrieve. Specify id or title but not both.

-t, --title [title]

The display name of the model to retrieve. Specify id or title but not both.

--withPublications

Retrieves information about the library where it has been applied.

-h, --help [help]

Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, response, full. Default is options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Examples​

Retrieve information about a SharePoint Premium document understanding model, using model UniqueId.

m365 spp model get --siteUrl "https://contoso.sharepoint.com/sites/ContentCenter" --id "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc"

Retrieve information about a SharePoint Premium document understanding model, using model Title

m365 spp model get --siteUrl "https://contoso.sharepoint.com/sites/ContentCenter" --title "climicrosoft365Model"

Response​

Standard response​

{
  "AIBuilderHybridModelType": null,
  "AzureCognitivePrebuiltModelName": null,
  "BaseContentTypeName": null,
  "ConfidenceScore": {
    "trainingStatus": {
      "kind": "original",
      "ClassifierStatus": {
        "TrainingStatus": "success",
        "TimeStamp": 1604429035541
      },
      "ExtractorsStatus": [
        {
          "TimeStamp": 1604429033385,
          "ExtractorName": "Contributor",
          "TrainingStatus": "success"
        }
      ]
    },
    "modelAccuracy": {
      "Classifier": 1,
      "Extractors": {
        "Contributor": 1
      }
    },
    "perSampleAccuracy": {
      "43": {
        "Classifier": 1,
        "Extractors": {
          "Contributor": 1
        }
      }
    },
    "perSamplePrediction": {
      "43": {
        "Extractors": {
          "Contributor": [
            "Benefit Change Notice"
          ]
        }
      }
    },
    "trainingFailures": {}
  },
  "ContentTypeGroup": "Intelligent Document Content Types",
  "ContentTypeId": "0x010100B992472522B7C04E9101F1CFD07E4ADC",
  "ContentTypeName": "BenefitsChangeNotice",
  "Created": "2020-11-03T12:30:55Z",
  "CreatedBy": "i:0#.w|sharepoint\\system",
  "DriveId": "b!7w273MPU8kiqSKc6SWaUkQ3wyRgeHbxDh-e6ShP9X-cXa2m8jDdHQ7UJXVLMbzgj",
  "Explanations": {
    "Classifier": [
      {
        "id": "24f0b71f-87c6-4f7d-9797-88e9eab00cb6",
        "kind": "dictionaryFeature",
        "name": "Contains ",
        "active": true,
        "nGrams": [
          "Benefit Change Notice"
        ],
        "caseSensitive": true,
        "ignoreDigitIdentity": false,
        "ignoreLetterIdentity": false
      }
    ],
    "Extractors": {
      "Contributor": [
        {
          "id": "9abdbfc9-6425-4e03-a344-305d3e60ad7f",
          "kind": "dictionaryFeature",
          "name": "text",
          "active": true,
          "nGrams": [
            "Benefit Change Notice"
          ],
          "caseSensitive": false,
          "ignoreDigitIdentity": false,
          "ignoreLetterIdentity": false
        }
      ]
    }
  },
  "ID": 3,
  "LastTrained": "2020-11-03T18:43:53Z",
  "ListID": "bc696b17-378c-4347-b509-5d52cc6f3823",
  "ModelSettings": null,
  "ModelType": 2,
  "Modified": "2024-06-27T02:45:32Z",
  "ModifiedBy": "i:0#.w|sharepoint\\system",
  "ObjectId": "01XHOXSCXFBUHLC2OA7FDJB52PXCWAAE3S",
  "PublicationType": 0,
  "Schemas": {
    "Extractors": {
      "Contributor": {
        "concepts": {
          "6af8ef33-4bf1-49ca-93d3-7a2358746747": {
            "name": "Contributor"
          }
        },
        "relationships": []
      }
    }
  },
  "SourceSiteUrl": "https://contoso.sharepoint.com/sites/ContentCenter",
  "SourceUrl": null,
  "SourceWebServerRelativeUrl": "/sites/ContentCenter",
  "UniqueId": "b10e0de5-c069-46f9-90f7-4fb8ac001372"
}

withPublications response​

When we make use of the option withPublications, the response will differ.

{
  "AIBuilderHybridModelType": null,
  "AzureCognitivePrebuiltModelName": null,
  "BaseContentTypeName": null,
  "ConfidenceScore": {
    "trainingStatus": {
      "kind": "original",
      "ClassifierStatus": {
        "TrainingStatus": "success",
        "TimeStamp": 1604429035541
      },
      "ExtractorsStatus": [
        {
          "TimeStamp": 1604429033385,
          "ExtractorName": "Contributor",
          "TrainingStatus": "success"
        }
      ]
    },
    "modelAccuracy": {
      "Classifier": 1,
      "Extractors": {
        "Contributor": 1
      }
    },
    "perSampleAccuracy": {
      "43": {
        "Classifier": 1,
        "Extractors": {
          "Contributor": 1
        }
      }
    },
    "perSamplePrediction": {
      "43": {
        "Extractors": {
          "Contributor": [
            "Benefit Change Notice"
          ]
        }
      }
    },
    "trainingFailures": {}
  },
  "ContentTypeGroup": "Intelligent Document Content Types",
  "ContentTypeId": "0x010100B992472522B7C04E9101F1CFD07E4ADC",
  "ContentTypeName": "BenefitsChangeNotice",
  "Created": "2020-11-03T12:30:55Z",
  "CreatedBy": "i:0#.w|sharepoint\\system",
  "DriveId": "b!7w273MPU8kiqSKc6SWaUkQ3wyRgeHbxDh-e6ShP9X-cXa2m8jDdHQ7UJXVLMbzgj",
  "Explanations": {
    "Classifier": [
      {
        "id": "24f0b71f-87c6-4f7d-9797-88e9eab00cb6",
        "kind": "dictionaryFeature",
        "name": "Contains Benefit Change Notice",
        "active": true,
        "nGrams": [
          "Benefit Change Notice"
        ],
        "caseSensitive": true,
        "ignoreDigitIdentity": false,
        "ignoreLetterIdentity": false
      }
    ],
    "Extractors": {
      "Contributor": [
        {
          "id": "9abdbfc9-6425-4e03-a344-305d3e60ad7f",
          "kind": "dictionaryFeature",
          "name": "text",
          "active": true,
          "nGrams": [
            "Benefit Change Notice"
          ],
          "caseSensitive": false,
          "ignoreDigitIdentity": false,
          "ignoreLetterIdentity": false
        }
      ]
    }
  },
  "ID": 3,
  "LastTrained": "2020-11-03T18:43:53Z",
  "ListID": "bc696b17-378c-4347-b509-5d52cc6f3823",
  "ModelSettings": null,
  "ModelType": 2,
  "Modified": "2024-06-27T02:45:32Z",
  "ModifiedBy": "i:0#.w|sharepoint\\system",
  "ObjectId": "01XHOXSCXFBUHLC2OA7FDJB52PXCWAAE3S",
  "PublicationType": 0,
  "Schemas": {
    "Extractors": {
      "Contributor": {
        "concepts": {
          "6af8ef33-4bf1-49ca-93d3-7a2358746747": {
            "name": "Contributor"
          }
        },
        "relationships": []
      }
    }
  },
  "SourceSiteUrl": "https://contoso.sharepoint.com/sites/ContentCenter",
  "SourceUrl": null,
  "SourceWebServerRelativeUrl": "/sites/ContentCenter",
  "UniqueId": "b10e0de5-c069-46f9-90f7-4fb8ac001372",
  "Publications": [
    {
      "Created": "2020-11-03T12:52:12Z",
      "CreatedBy": "i:0#.f|membership|user@contoso.onmicrosoft.com",
      "DriveId": "b!7w273MPU8kiqSKc6SWaUkQ3wyRgeHbxDh-e6ShP9X-e-6B-bO36LRI87VfSrxwy9",
      "HasTargetSitePermission": true,
      "ID": 1,
      "ModelId": 3,
      "ModelName": "BenefitsChangeNotice.classifier",
      "ModelType": 0,
      "ModelUniqueId": "b10e0de5-c069-46f9-90f7-4fb8ac001372",
      "ModelVersion": "2.0",
      "Modified": "2020-11-03T18:45:18Z",
      "ModifiedBy": "i:0#.f|membership|user@contoso.onmicrosoft.com",
      "ObjectId": "01XHOXSCVXVZCQAAQWCNGK6NGADKKZUMW7",
      "PublicationType": 1,
      "TargetLibraryId": "7eb6c306-1680-4ba9-9bbe-6b5b7efb27be",
      "TargetLibraryName": "Documents",
      "TargetLibraryRemoved": false,
      "TargetLibraryServerRelativeUrl": "/sites/Spaces/Shared%20Documents",
      "TargetLibraryUrl": "https://contoso.sharepoint.com/sites/Spaces/Shared%20Documents",
      "TargetSiteId": "7e44de0a-30e3-45ab-a601-057298c9068f",
      "TargetSiteUrl": "https://contoso.sharepoint.com/sites/Spaces",
      "TargetTableListId": "00000000-0000-0000-0000-000000000000",
      "TargetTableListName": null,
      "TargetTableListRemoved": false,
      "TargetTableListServerRelativeUrl": null,
      "TargetTableListUrl": null,
      "TargetWebId": "9166df43-8e45-43b8-94ef-3a22826346de",
      "TargetWebName": "Spaces",
      "TargetWebServerRelativeUrl": "/sites/Spaces",
      "UniqueId": "0045aeb7-1602-4c13-af34-c01a959a32df",
      "ViewOption": "NewViewAsDefault"
    }
  ]
}
CTRL + M