AzureMachineLearningSkill Class

Definition

The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model. Once an AML model is trained and deployed, an AML skill integrates it into AI enrichment.

public class AzureMachineLearningSkill : Azure.Search.Documents.Indexes.Models.SearchIndexerSkill, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.AzureMachineLearningSkill>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.AzureMachineLearningSkill>
type AzureMachineLearningSkill = class
    inherit SearchIndexerSkill
    interface IJsonModel<AzureMachineLearningSkill>
    interface IPersistableModel<AzureMachineLearningSkill>
Public Class AzureMachineLearningSkill
Inherits SearchIndexerSkill
Implements IJsonModel(Of AzureMachineLearningSkill), IPersistableModel(Of AzureMachineLearningSkill)
Inheritance
AzureMachineLearningSkill
Implements

Constructors

Name Description
AzureMachineLearningSkill(IEnumerable<InputFieldMappingEntry>, IEnumerable<OutputFieldMappingEntry>)

Initializes a new instance of AzureMachineLearningSkill.

Properties

Name Description
AuthenticationKey

(Required for key authentication) The key for the AML service.

Context

Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.

(Inherited from SearchIndexerSkill)
DegreeOfParallelism

(Optional) When specified, indicates the number of calls the indexer will make in parallel to the endpoint you have provided. You can decrease this value if your endpoint is failing under too high of a request load, or raise it if your endpoint is able to accept more requests and you would like an increase in the performance of the indexer. If not set, a default value of 5 is used. The degreeOfParallelism can be set to a maximum of 10 and a minimum of 1.

Description

The description of the skill which describes the inputs, outputs, and usage of the skill.

(Inherited from SearchIndexerSkill)
Inputs

Inputs of the skills could be a column in the source data set, or the output of an upstream skill.

(Inherited from SearchIndexerSkill)
Location

(Optional for token authentication). The region the AML service is deployed in.

Name

The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.

(Inherited from SearchIndexerSkill)
Outputs

The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.

(Inherited from SearchIndexerSkill)
ResourceId

(Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}.

ScoringUri

(Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed.

Timeout

(Optional) When specified, indicates the timeout for the http client making the API call.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<AzureMachineLearningSkill>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<AzureMachineLearningSkill>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<SearchIndexerSkill>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from SearchIndexerSkill)
IJsonModel<SearchIndexerSkill>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from SearchIndexerSkill)
IPersistableModel<AzureMachineLearningSkill>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AzureMachineLearningSkill>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<AzureMachineLearningSkill>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<SearchIndexerSkill>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from SearchIndexerSkill)
IPersistableModel<SearchIndexerSkill>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from SearchIndexerSkill)
IPersistableModel<SearchIndexerSkill>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from SearchIndexerSkill)

Applies to