Interface ISyntexModel

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Syntex model

public interface ISyntexModel

Properties

Description

Model description

string Description { get; }

Property Value

string

Id

Id of a model (= id of the list item)

int Id { get; }

Property Value

int

ListItem

File holding the classifier

IListItem ListItem { get; }

Property Value

IListItem

ModelLastTrained

Date when the model was trained for the last time

DateTime ModelLastTrained { get; }

Property Value

DateTime

Name

Name of the model

string Name { get; }

Property Value

string

UniqueId

Unique id of the model (= unique id of the model file)

Guid UniqueId { get; }

Property Value

Guid

Methods

GetModelPublications()

Gets a list of libraries to which this model is published

List<ISyntexModelPublication> GetModelPublications()

Returns

List<ISyntexModelPublication>

The list of libraries to which this model is published

GetModelPublicationsAsync()

Gets a list of libraries to which this model is published

Task<List<ISyntexModelPublication>> GetModelPublicationsAsync()

Returns

Task<List<ISyntexModelPublication>>

The list of libraries to which this model is published

GetModelPublicationsBatch()

Gets a list of libraries to which this model is published

IEnumerableBatchResult<ISyntexModelPublication> GetModelPublicationsBatch()

Returns

IEnumerableBatchResult<ISyntexModelPublication>

The list of libraries to which this model is published

GetModelPublicationsBatch(Batch)

Gets a list of libraries to which this model is published

IEnumerableBatchResult<ISyntexModelPublication> GetModelPublicationsBatch(Batch batch)

Parameters

batch Batch

Batch to add this request to

Returns

IEnumerableBatchResult<ISyntexModelPublication>

The list of libraries to which this model is published

GetModelPublicationsBatchAsync()

Gets a list of libraries to which this model is published

Task<IEnumerableBatchResult<ISyntexModelPublication>> GetModelPublicationsBatchAsync()

Returns

Task<IEnumerableBatchResult<ISyntexModelPublication>>

The list of libraries to which this model is published

GetModelPublicationsBatchAsync(Batch)

Gets a list of libraries to which this model is published

Task<IEnumerableBatchResult<ISyntexModelPublication>> GetModelPublicationsBatchAsync(Batch batch)

Parameters

batch Batch

Batch to add this request to

Returns

Task<IEnumerableBatchResult<ISyntexModelPublication>>

The list of libraries to which this model is published

PublishModel(IList, MachineLearningPublicationViewOption)

Publish this model to a library

ISyntexModelPublicationResult PublishModel(IList library, MachineLearningPublicationViewOption viewOption = MachineLearningPublicationViewOption.NewViewAsDefault)

Parameters

library IList

Library to publish this model to

viewOption MachineLearningPublicationViewOption

Determines how adding the model changes the library's views

Returns

ISyntexModelPublicationResult

Information about the model publication

PublishModel(SyntexModelPublishOptions)

Publish this model to a library

ISyntexModelPublicationResult PublishModel(SyntexModelPublishOptions publicationOptions)

Parameters

publicationOptions SyntexModelPublishOptions

Information defining the model publication

Returns

ISyntexModelPublicationResult

Information about the model publication

PublishModel(List<IList>, MachineLearningPublicationViewOption)

Publish this model to a list of libraries

List<ISyntexModelPublicationResult> PublishModel(List<IList> libraries, MachineLearningPublicationViewOption viewOption = MachineLearningPublicationViewOption.NewViewAsDefault)

Parameters

libraries List<IList>

List of libraries to publish this model to

viewOption MachineLearningPublicationViewOption

Determines how adding the model changes the library's views

Returns

List<ISyntexModelPublicationResult>

Information about the model publication

PublishModel(List<SyntexModelPublishOptions>)

Publish this model to a list of libraries

List<ISyntexModelPublicationResult> PublishModel(List<SyntexModelPublishOptions> publicationOptions)

Parameters

publicationOptions List<SyntexModelPublishOptions>

Information defining the model publications

Returns

List<ISyntexModelPublicationResult>

Information about the model publications

PublishModelAsync(IList, MachineLearningPublicationViewOption)

Publish this model to a library

Task<ISyntexModelPublicationResult> PublishModelAsync(IList library, MachineLearningPublicationViewOption viewOption = MachineLearningPublicationViewOption.NewViewAsDefault)

Parameters

library IList

Library to publish this model to

viewOption MachineLearningPublicationViewOption

Determines how adding the model changes the library's views

Returns

Task<ISyntexModelPublicationResult>

Information about the model publication

PublishModelAsync(SyntexModelPublishOptions)

Publish this model to a library

Task<ISyntexModelPublicationResult> PublishModelAsync(SyntexModelPublishOptions publicationOptions)

Parameters

publicationOptions SyntexModelPublishOptions

Information defining the model publication

Returns

Task<ISyntexModelPublicationResult>

Information about the model publication

PublishModelAsync(List<IList>, MachineLearningPublicationViewOption)

Publish this model to a list of libraries

Task<List<ISyntexModelPublicationResult>> PublishModelAsync(List<IList> libraries, MachineLearningPublicationViewOption viewOption = MachineLearningPublicationViewOption.NewViewAsDefault)

Parameters

libraries List<IList>

List of libraries to publish this model to

viewOption MachineLearningPublicationViewOption

Determines how adding the model changes the library's views

Returns

Task<List<ISyntexModelPublicationResult>>

Information about the model publication

PublishModelAsync(List<SyntexModelPublishOptions>)

Publish this model to a list of libraries

Task<List<ISyntexModelPublicationResult>> PublishModelAsync(List<SyntexModelPublishOptions> publicationOptions)

Parameters

publicationOptions List<SyntexModelPublishOptions>

Information defining the model publications

Returns

Task<List<ISyntexModelPublicationResult>>

Information about the model publications

PublishModelBatch(IList, MachineLearningPublicationViewOption)

Publish this model to a library

IBatchSingleResult<ISyntexModelPublicationResult> PublishModelBatch(IList library, MachineLearningPublicationViewOption viewOption = MachineLearningPublicationViewOption.NewViewAsDefault)

Parameters

library IList

Library to publish this model to

viewOption MachineLearningPublicationViewOption

Determines how adding the model changes the library's views

Returns

IBatchSingleResult<ISyntexModelPublicationResult>

Information about the model publication

PublishModelBatch(SyntexModelPublishOptions)

Publish this model to a library

IBatchSingleResult<ISyntexModelPublicationResult> PublishModelBatch(SyntexModelPublishOptions publicationOptions)

Parameters

publicationOptions SyntexModelPublishOptions

Information defining the model publication

Returns

IBatchSingleResult<ISyntexModelPublicationResult>

Information about the model publication

PublishModelBatch(Batch, IList, MachineLearningPublicationViewOption)

Publish this model to a library

IBatchSingleResult<ISyntexModelPublicationResult> PublishModelBatch(Batch batch, IList library, MachineLearningPublicationViewOption viewOption = MachineLearningPublicationViewOption.NewViewAsDefault)

Parameters

batch Batch

Batch to add this request to

library IList

Library to publish this model to

viewOption MachineLearningPublicationViewOption

Determines how adding the model changes the library's views

Returns

IBatchSingleResult<ISyntexModelPublicationResult>

Information about the model publication

PublishModelBatch(Batch, SyntexModelPublishOptions)

Publish this model to a library

IBatchSingleResult<ISyntexModelPublicationResult> PublishModelBatch(Batch batch, SyntexModelPublishOptions publicationOptions)

Parameters

batch Batch

Batch to add this request to

publicationOptions SyntexModelPublishOptions

Information defining the model publication

Returns

IBatchSingleResult<ISyntexModelPublicationResult>

Information about the model publication

PublishModelBatch(Batch, List<IList>, MachineLearningPublicationViewOption)

Publish this model to a list of libraries

IEnumerableBatchResult<ISyntexModelPublicationResult> PublishModelBatch(Batch batch, List<IList> libraries, MachineLearningPublicationViewOption viewOption = MachineLearningPublicationViewOption.NewViewAsDefault)

Parameters

batch Batch

Batch to add this request to

libraries List<IList>

List of libraries to publish this model to

viewOption MachineLearningPublicationViewOption

Determines how adding the model changes the library's views

Returns

IEnumerableBatchResult<ISyntexModelPublicationResult>

Information about the model publication

PublishModelBatch(Batch, List<SyntexModelPublishOptions>)

Publish this model to a list of libraries

IEnumerableBatchResult<ISyntexModelPublicationResult> PublishModelBatch(Batch batch, List<SyntexModelPublishOptions> publicationOptions)

Parameters

batch Batch

Batch to add this request to

publicationOptions List<SyntexModelPublishOptions>

Information defining the model publications

Returns

IEnumerableBatchResult<ISyntexModelPublicationResult>

Information about the model publications

PublishModelBatch(List<IList>, MachineLearningPublicationViewOption)

Publish this model to a list of libraries

IEnumerableBatchResult<ISyntexModelPublicationResult> PublishModelBatch(List<IList> libraries, MachineLearningPublicationViewOption viewOption = MachineLearningPublicationViewOption.NewViewAsDefault)

Parameters

libraries List<IList>

List of libraries to publish this model to

viewOption MachineLearningPublicationViewOption

Determines how adding the model changes the library's views

Returns

IEnumerableBatchResult<ISyntexModelPublicationResult>

Information about the model publication

PublishModelBatch(List<SyntexModelPublishOptions>)

Publish this model to a list of libraries

IEnumerableBatchResult<ISyntexModelPublicationResult> PublishModelBatch(List<SyntexModelPublishOptions> publicationOptions)

Parameters

publicationOptions List<SyntexModelPublishOptions>

Information defining the model publications

Returns

IEnumerableBatchResult<ISyntexModelPublicationResult>

Information about the model publications

PublishModelBatchAsync(IList, MachineLearningPublicationViewOption)

Publish this model to a library

Task<IBatchSingleResult<ISyntexModelPublicationResult>> PublishModelBatchAsync(IList library, MachineLearningPublicationViewOption viewOption = MachineLearningPublicationViewOption.NewViewAsDefault)

Parameters

library IList

Library to publish this model to

viewOption MachineLearningPublicationViewOption

Determines how adding the model changes the library's views

Returns

Task<IBatchSingleResult<ISyntexModelPublicationResult>>

Information about the model publication

PublishModelBatchAsync(SyntexModelPublishOptions)

Publish this model to a library

Task<IBatchSingleResult<ISyntexModelPublicationResult>> PublishModelBatchAsync(SyntexModelPublishOptions publicationOptions)

Parameters

publicationOptions SyntexModelPublishOptions

Information defining the model publication

Returns

Task<IBatchSingleResult<ISyntexModelPublicationResult>>

Information about the model publication

PublishModelBatchAsync(Batch, IList, MachineLearningPublicationViewOption)

Publish this model to a library

Task<IBatchSingleResult<ISyntexModelPublicationResult>> PublishModelBatchAsync(Batch batch, IList library, MachineLearningPublicationViewOption viewOption = MachineLearningPublicationViewOption.NewViewAsDefault)

Parameters

batch Batch

Batch to add this request to

library IList

Library to publish this model to

viewOption MachineLearningPublicationViewOption

Determines how adding the model changes the library's views

Returns

Task<IBatchSingleResult<ISyntexModelPublicationResult>>

Information about the model publication

PublishModelBatchAsync(Batch, SyntexModelPublishOptions)

Publish this model to a library

Task<IBatchSingleResult<ISyntexModelPublicationResult>> PublishModelBatchAsync(Batch batch, SyntexModelPublishOptions publicationOptions)

Parameters

batch Batch

Batch to add this request to

publicationOptions SyntexModelPublishOptions

Information defining the model publication

Returns

Task<IBatchSingleResult<ISyntexModelPublicationResult>>

Information about the model publication

PublishModelBatchAsync(Batch, List<IList>, MachineLearningPublicationViewOption)

Publish this model to a list of libraries

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>> PublishModelBatchAsync(Batch batch, List<IList> libraries, MachineLearningPublicationViewOption viewOption = MachineLearningPublicationViewOption.NewViewAsDefault)

Parameters

batch Batch

Batch to add this request to

libraries List<IList>

List of libraries to publish this model to

viewOption MachineLearningPublicationViewOption

Determines how adding the model changes the library's views

Returns

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>>

Information about the model publication

PublishModelBatchAsync(Batch, List<SyntexModelPublishOptions>)

Publish this model to a list of libraries

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>> PublishModelBatchAsync(Batch batch, List<SyntexModelPublishOptions> publicationOptions)

Parameters

batch Batch

Batch to add this request to

publicationOptions List<SyntexModelPublishOptions>

Information defining the model publications

Returns

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>>

Information about the model publications

PublishModelBatchAsync(List<IList>, MachineLearningPublicationViewOption)

Publish this model to a list of libraries

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>> PublishModelBatchAsync(List<IList> libraries, MachineLearningPublicationViewOption viewOption = MachineLearningPublicationViewOption.NewViewAsDefault)

Parameters

libraries List<IList>

List of libraries to publish this model to

viewOption MachineLearningPublicationViewOption

Determines how adding the model changes the library's views

Returns

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>>

Information about the model publication

PublishModelBatchAsync(List<SyntexModelPublishOptions>)

Publish this model to a list of libraries

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>> PublishModelBatchAsync(List<SyntexModelPublishOptions> publicationOptions)

Parameters

publicationOptions List<SyntexModelPublishOptions>

Information defining the model publications

Returns

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>>

Information about the model publications

UnPublishModel(IList)

Unpublish this model from the library

ISyntexModelPublicationResult UnPublishModel(IList library)

Parameters

library IList

Library to unpublish this model from

Returns

ISyntexModelPublicationResult

Information about the model unpublication

UnPublishModel(SyntexModelUnPublishOptions)

Unpublish this model from the library

ISyntexModelPublicationResult UnPublishModel(SyntexModelUnPublishOptions unPublicationOptions)

Parameters

unPublicationOptions SyntexModelUnPublishOptions

Information defining the model unpublication

Returns

ISyntexModelPublicationResult

Information about the model unpublication

UnPublishModel(List<IList>)

Unpublish this model from the list of libraries

List<ISyntexModelPublicationResult> UnPublishModel(List<IList> libraries)

Parameters

libraries List<IList>

List of libraries to unpublish this model from

Returns

List<ISyntexModelPublicationResult>

Information about the model unpublication

UnPublishModel(List<SyntexModelUnPublishOptions>)

Unpublish this model from a list of libraries

List<ISyntexModelPublicationResult> UnPublishModel(List<SyntexModelUnPublishOptions> unPublicationOptions)

Parameters

unPublicationOptions List<SyntexModelUnPublishOptions>

Information defining the model unpublications

Returns

List<ISyntexModelPublicationResult>

Information about the model unpublications

UnPublishModelAsync(IList)

Unpublish this model from the library

Task<ISyntexModelPublicationResult> UnPublishModelAsync(IList library)

Parameters

library IList

Library to unpublish this model from

Returns

Task<ISyntexModelPublicationResult>

Information about the model unpublication

UnPublishModelAsync(SyntexModelUnPublishOptions)

Unpublish this model from the library

Task<ISyntexModelPublicationResult> UnPublishModelAsync(SyntexModelUnPublishOptions unPublicationOptions)

Parameters

unPublicationOptions SyntexModelUnPublishOptions

Information defining the model unpublication

Returns

Task<ISyntexModelPublicationResult>

Information about the model unpublication

UnPublishModelAsync(List<IList>)

Unpublish this model from the list of libraries

Task<List<ISyntexModelPublicationResult>> UnPublishModelAsync(List<IList> libraries)

Parameters

libraries List<IList>

List of libraries to unpublish this model from

Returns

Task<List<ISyntexModelPublicationResult>>

Information about the model unpublication

UnPublishModelAsync(List<SyntexModelUnPublishOptions>)

Unpublish this model from a list of libraries

Task<List<ISyntexModelPublicationResult>> UnPublishModelAsync(List<SyntexModelUnPublishOptions> unPublicationOptions)

Parameters

unPublicationOptions List<SyntexModelUnPublishOptions>

Information defining the model unpublications

Returns

Task<List<ISyntexModelPublicationResult>>

Information about the model unpublications

UnPublishModelBatch(IList)

Unpublish this model from the library

IBatchSingleResult<ISyntexModelPublicationResult> UnPublishModelBatch(IList library)

Parameters

library IList

Library to unpublish this model from

Returns

IBatchSingleResult<ISyntexModelPublicationResult>

Information about the model unpublication

UnPublishModelBatch(SyntexModelUnPublishOptions)

Unpublish this model from the library

IBatchSingleResult<ISyntexModelPublicationResult> UnPublishModelBatch(SyntexModelUnPublishOptions unPublicationOptions)

Parameters

unPublicationOptions SyntexModelUnPublishOptions

Information defining the model unpublication

Returns

IBatchSingleResult<ISyntexModelPublicationResult>

Information about the model unpublication

UnPublishModelBatch(Batch, IList)

Unpublish this model from the library

IBatchSingleResult<ISyntexModelPublicationResult> UnPublishModelBatch(Batch batch, IList library)

Parameters

batch Batch

Batch to add this request to

library IList

Library to unpublish this model from

Returns

IBatchSingleResult<ISyntexModelPublicationResult>

Information about the model unpublication

UnPublishModelBatch(Batch, SyntexModelUnPublishOptions)

Unpublish this model from the library

IBatchSingleResult<ISyntexModelPublicationResult> UnPublishModelBatch(Batch batch, SyntexModelUnPublishOptions unPublicationOptions)

Parameters

batch Batch

Batch to add this request to

unPublicationOptions SyntexModelUnPublishOptions

Information defining the model unpublication

Returns

IBatchSingleResult<ISyntexModelPublicationResult>

Information about the model unpublication

UnPublishModelBatch(Batch, List<IList>)

Unpublish this model from the list of libraries

IEnumerableBatchResult<ISyntexModelPublicationResult> UnPublishModelBatch(Batch batch, List<IList> libraries)

Parameters

batch Batch

Batch to add this request to

libraries List<IList>

List of libraries to unpublish this model from

Returns

IEnumerableBatchResult<ISyntexModelPublicationResult>

Information about the model unpublication

UnPublishModelBatch(Batch, List<SyntexModelUnPublishOptions>)

Unpublish this model from a list of libraries

IEnumerableBatchResult<ISyntexModelPublicationResult> UnPublishModelBatch(Batch batch, List<SyntexModelUnPublishOptions> unPublicationOptions)

Parameters

batch Batch

Batch to add this request to

unPublicationOptions List<SyntexModelUnPublishOptions>

Information defining the model unpublications

Returns

IEnumerableBatchResult<ISyntexModelPublicationResult>

Information about the model unpublications

UnPublishModelBatch(List<IList>)

Unpublish this model from the list of libraries

IEnumerableBatchResult<ISyntexModelPublicationResult> UnPublishModelBatch(List<IList> libraries)

Parameters

libraries List<IList>

List of libraries to unpublish this model from

Returns

IEnumerableBatchResult<ISyntexModelPublicationResult>

Information about the model unpublication

UnPublishModelBatch(List<SyntexModelUnPublishOptions>)

Unpublish this model from a list of libraries

IEnumerableBatchResult<ISyntexModelPublicationResult> UnPublishModelBatch(List<SyntexModelUnPublishOptions> unPublicationOptions)

Parameters

unPublicationOptions List<SyntexModelUnPublishOptions>

Information defining the model unpublications

Returns

IEnumerableBatchResult<ISyntexModelPublicationResult>

Information about the model unpublications

UnPublishModelBatchAsync(IList)

Unpublish this model from the library

Task<IBatchSingleResult<ISyntexModelPublicationResult>> UnPublishModelBatchAsync(IList library)

Parameters

library IList

Library to unpublish this model from

Returns

Task<IBatchSingleResult<ISyntexModelPublicationResult>>

Information about the model unpublication

UnPublishModelBatchAsync(SyntexModelUnPublishOptions)

Unpublish this model from the library

Task<IBatchSingleResult<ISyntexModelPublicationResult>> UnPublishModelBatchAsync(SyntexModelUnPublishOptions unPublicationOptions)

Parameters

unPublicationOptions SyntexModelUnPublishOptions

Information defining the model unpublication

Returns

Task<IBatchSingleResult<ISyntexModelPublicationResult>>

Information about the model unpublication

UnPublishModelBatchAsync(Batch, IList)

Unpublish this model from the library

Task<IBatchSingleResult<ISyntexModelPublicationResult>> UnPublishModelBatchAsync(Batch batch, IList library)

Parameters

batch Batch

Batch to add this request to

library IList

Library to unpublish this model from

Returns

Task<IBatchSingleResult<ISyntexModelPublicationResult>>

Information about the model unpublication

UnPublishModelBatchAsync(Batch, SyntexModelUnPublishOptions)

Unpublish this model from the library

Task<IBatchSingleResult<ISyntexModelPublicationResult>> UnPublishModelBatchAsync(Batch batch, SyntexModelUnPublishOptions unPublicationOptions)

Parameters

batch Batch

Batch to add this request to

unPublicationOptions SyntexModelUnPublishOptions

Information defining the model unpublication

Returns

Task<IBatchSingleResult<ISyntexModelPublicationResult>>

Information about the model unpublication

UnPublishModelBatchAsync(Batch, List<IList>)

Unpublish this model from the list of libraries

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>> UnPublishModelBatchAsync(Batch batch, List<IList> libraries)

Parameters

batch Batch

Batch to add this request to

libraries List<IList>

List of libraries to unpublish this model from

Returns

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>>

Information about the model unpublication

UnPublishModelBatchAsync(Batch, List<SyntexModelUnPublishOptions>)

Unpublish this model from a list of libraries

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>> UnPublishModelBatchAsync(Batch batch, List<SyntexModelUnPublishOptions> unPublicationOptions)

Parameters

batch Batch

Batch to add this request to

unPublicationOptions List<SyntexModelUnPublishOptions>

Information defining the model unpublications

Returns

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>>

Information about the model unpublications

UnPublishModelBatchAsync(List<IList>)

Unpublish this model from the list of libraries

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>> UnPublishModelBatchAsync(List<IList> libraries)

Parameters

libraries List<IList>

List of libraries to unpublish this model from

Returns

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>>

Information about the model unpublication

UnPublishModelBatchAsync(List<SyntexModelUnPublishOptions>)

Unpublish this model from a list of libraries

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>> UnPublishModelBatchAsync(List<SyntexModelUnPublishOptions> unPublicationOptions)

Parameters

unPublicationOptions List<SyntexModelUnPublishOptions>

Information defining the model unpublications

Returns

Task<IEnumerableBatchResult<ISyntexModelPublicationResult>>

Information about the model unpublications