WebApiSkill Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.WebApiSkill>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.WebApiSkill>type WebApiSkill = class
inherit SearchIndexerSkill
interface IJsonModel<WebApiSkill>
interface IPersistableModel<WebApiSkill>Public Class WebApiSkill
Inherits SearchIndexerSkill
Implements IJsonModel(Of WebApiSkill), IPersistableModel(Of WebApiSkill)- Inheritance
- Derived
- Implements
Constructors
| Name | Description |
|---|---|
| WebApiSkill(IEnumerable<InputFieldMappingEntry>, IEnumerable<OutputFieldMappingEntry>, String) |
Initializes a new instance of WebApiSkill. |
Properties
| Name | Description |
|---|---|
| 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. |
| 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, prefixed with the character '#'. (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 url for the Web API. |
