WebApiSkill Class

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
WebApiSkill.cs
Source:
WebApiSkill.cs

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

public class WebApiSkill : Azure.Search.Documents.Indexes.Models.SearchIndexerSkill
type WebApiSkill = class
    inherit SearchIndexerSkill
Public Class WebApiSkill
Inherits SearchIndexerSkill
Inheritance
Object
SearchIndexerSkill
WebApiSkill

Constructors

WebApiSkill(IEnumerable<InputFieldMappingEntry>, IEnumerable<OutputFieldMappingEntry>, String)

Initializes a new instance of WebApiSkill.

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 set to "none", the value of this property is cleared. Please note SearchIndexerDataIdentity is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SearchIndexerDataNoneIdentity and SearchIndexerDataUserAssignedIdentity.
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.
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

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

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

(Inherited from SearchIndexerSkill)
HttpHeaders

The headers required to make the http request.
HttpMethod

The method for the http request.
Inputs

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

(Inherited from SearchIndexerSkill)
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 prefaced with the character "#" in debug sessions and error messages.

(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)
Timeout

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

The URI of the Web API providing the vectorizer.

Applies to