SearchModelFactory.AzureMachineLearningSkill Method

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 static Azure.Search.Documents.Indexes.Models.AzureMachineLearningSkill AzureMachineLearningSkill(string name = default, string description = default, string context = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> inputs = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> outputs = default, Uri scoringUri = default, string authenticationKey = default, Azure.Core.ResourceIdentifier resourceId = default, TimeSpan? timeout = default, Azure.Core.AzureLocation? location = default, int? degreeOfParallelism = default);
static member AzureMachineLearningSkill : string * string * string * seq<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> * seq<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> * Uri * string * Azure.Core.ResourceIdentifier * Nullable<TimeSpan> * Nullable<Azure.Core.AzureLocation> * Nullable<int> -> Azure.Search.Documents.Indexes.Models.AzureMachineLearningSkill
Public Shared Function AzureMachineLearningSkill (Optional name As String = Nothing, Optional description As String = Nothing, Optional context As String = Nothing, Optional inputs As IEnumerable(Of InputFieldMappingEntry) = Nothing, Optional outputs As IEnumerable(Of OutputFieldMappingEntry) = Nothing, Optional scoringUri As Uri = Nothing, Optional authenticationKey As String = Nothing, Optional resourceId As ResourceIdentifier = Nothing, Optional timeout As Nullable(Of TimeSpan) = Nothing, Optional location As Nullable(Of AzureLocation) = Nothing, Optional degreeOfParallelism As Nullable(Of Integer) = Nothing) As AzureMachineLearningSkill

Parameters

name
String

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 '#'.

description
String

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

context
String

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.

inputs
IEnumerable<InputFieldMappingEntry>

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

outputs
IEnumerable<OutputFieldMappingEntry>

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.

scoringUri
Uri

(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.

authenticationKey
String

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

resourceId
ResourceIdentifier

(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}.

timeout
Nullable<TimeSpan>

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

location
Nullable<AzureLocation>

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

degreeOfParallelism
Nullable<Int32>

(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.

Returns

A new AzureMachineLearningSkill instance for mocking.

Applies to