Share via

AzureMachineLearningSkill interface

Package:
@azure/search-documents

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.

Extends
BaseSearchIndexerSkill

Properties

authenticationKey

(Required for key authentication) The key for the AML service.
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.
odatatype

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

(Optional for token authentication). The region the AML service is deployed in.
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.

Inherited Properties

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

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

Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
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 '#'.
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.

Property Details

authenticationKey

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

authenticationKey?: string

Property Value

string

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.

degreeOfParallelism?: number

Property Value

number

odatatype

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

odatatype: "#Microsoft.Skills.Custom.AmlSkill"

Property Value

"#Microsoft.Skills.Custom.AmlSkill"

region

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

region?: string

Property Value

string

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

resourceId?: string

Property Value

string

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.

scoringUri?: string

Property Value

string

timeout

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

timeout?: string

Property Value

string

Inherited Property Details

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.

context?: string

Property Value

string

Inherited From SearchIndexerSkill.context

description

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

description?: string

Property Value

string

Inherited From SearchIndexerSkill.description

inputs

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

inputs: InputFieldMappingEntry[]

Property Value

InputFieldMappingEntry[]

Inherited From SearchIndexerSkill.inputs

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

name?: string

Property Value

string

Inherited From SearchIndexerSkill.name

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.

outputs: OutputFieldMappingEntry[]

Property Value

OutputFieldMappingEntry[]

Inherited From SearchIndexerSkill.outputs