WebApiSkill Class

Reference

Definition

Namespace:: Microsoft.Azure.Search.Models

Assembly:: Microsoft.Azure.Search.Service.dll

Package:: Microsoft.Azure.Search.Service v10.1.0

Source:: WebApiSkill.cs

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. https://docs.microsoft.com/azure/search/cognitive-search-custom-skill-web-api

[Newtonsoft.Json.JsonObject("#Microsoft.Skills.Custom.WebApiSkill")]
public class WebApiSkill : Microsoft.Azure.Search.Models.Skill

[<Newtonsoft.Json.JsonObject("#Microsoft.Skills.Custom.WebApiSkill")>]
type WebApiSkill = class
    inherit Skill

Public Class WebApiSkill
Inherits Skill

Inheritance: Object

Skill
WebApiSkill

Attributes: Newtonsoft.Json.JsonObjectAttribute

Constructors

WebApiSkill()	Initializes a new instance of the WebApiSkill class.
WebApiSkill(IList<InputFieldMappingEntry>, IList<OutputFieldMappingEntry>, String, String, String, String, IDictionary<String,String>, String, Nullable<TimeSpan>, Nullable<Int32>, Nullable<Int32>)	Initializes a new instance of the WebApiSkill class.

Properties

BatchSize	Gets or sets the desired batch size which indicates number of documents.
Context	Gets or sets 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 Skill)
DegreeOfParallelism	Gets or sets if set, the number of parallel calls that can be made to the Web API.
Description	Gets or sets the description of the skill which describes the inputs, outputs, and usage of the skill. (Inherited from Skill)
HttpHeaders	Gets or sets the headers required to make the http request.
HttpMethod	Gets or sets the method for the http request.
Inputs	Gets or sets inputs of the skills could be a column in the source data set, or the output of an upstream skill. (Inherited from Skill)
Name	Gets or sets 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 Skill)
Outputs	Gets or sets 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 Skill)
Timeout	Gets or sets the desired timeout for the request. Default is 30 seconds.
Uri	Gets or sets the url for the Web API.

Methods

Validate()

Validate the object.

Applies to

Share via