WebApiSkill interface

  • Reference
Package:
@azure/search-documents

A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code.

Extends
BaseSearchIndexerSkill

Properties

authIdentity

The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If undefined, the value of this property is cleared.
authResourceId

Applies to custom skills that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the custom skill connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token.
batchSize

The desired batch size which indicates number of documents.
degreeOfParallelism

If set, the number of parallel calls that can be made to the Web API.
httpHeaders

The headers required to make the http request.
httpMethod

The method for the http request.
odatatype

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

The desired timeout for the request. Default is 30 seconds.
uri

The url for the Web API.

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

authIdentity

The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If undefined, the value of this property is cleared.

authIdentity?: SearchIndexerDataIdentity

Property Value

SearchIndexerDataIdentity

authResourceId

Applies to custom skills that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the custom skill connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token.

authResourceId?: string

Property Value

string

batchSize

The desired batch size which indicates number of documents.

batchSize?: number

Property Value

number

degreeOfParallelism

If set, the number of parallel calls that can be made to the Web API.

degreeOfParallelism?: number

Property Value

number

httpHeaders

The headers required to make the http request.

httpHeaders?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

httpMethod

The method for the http request.

httpMethod?: string

Property Value

string

odatatype

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

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

Property Value

"#Microsoft.Skills.Custom.WebApiSkill"

timeout

The desired timeout for the request. Default is 30 seconds.

timeout?: string

Property Value

string

uri

The url for the Web API.

uri: 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 BaseSearchIndexerSkill.context

description

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

description?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.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 BaseSearchIndexerSkill.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 BaseSearchIndexerSkill.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 BaseSearchIndexerSkill.outputs