Package version:

Interface AzureMachineLearningSkill

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.

interface AzureMachineLearningSkill {
    authenticationKey?: string;
    context?: string;
    degreeOfParallelism?: number;
    description?: string;
    inputs: InputFieldMappingEntry[];
    name?: string;
    odatatype: "#Microsoft.Skills.Custom.AmlSkill";
    outputs: OutputFieldMappingEntry[];
    region?: string;
    resourceId?: string;
    scoringUri?: string;
    timeout?: string;
}

Hierarchy (view full)

Properties

authenticationKey?: string

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

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.

degreeOfParallelism?: number

(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?: string

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

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

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

odatatype

Polymorphic discriminator, which specifies the different types this object can be

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.

region?: string

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

resourceId?: string

(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?: string

(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?: string

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