SearchModelFactory.WebApiSkill Method
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 static Azure.Search.Documents.Indexes.Models.WebApiSkill WebApiSkill(string name = default, string description = default, string context = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> inputs = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> outputs = default, string uri = default, System.Collections.Generic.IDictionary<string,string> httpHeaders = default, string httpMethod = default, TimeSpan? timeout = default, int? batchSize = default, int? degreeOfParallelism = default, Azure.Core.ResourceIdentifier authResourceId = default, Azure.Search.Documents.Indexes.Models.SearchIndexerDataIdentity authIdentity = default);static member WebApiSkill : string * string * string * seq<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> * seq<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> * string * System.Collections.Generic.IDictionary<string, string> * string * Nullable<TimeSpan> * Nullable<int> * Nullable<int> * Azure.Core.ResourceIdentifier * Azure.Search.Documents.Indexes.Models.SearchIndexerDataIdentity -> Azure.Search.Documents.Indexes.Models.WebApiSkillPublic Shared Function WebApiSkill (Optional name As String = Nothing, Optional description As String = Nothing, Optional context As String = Nothing, Optional inputs As IEnumerable(Of InputFieldMappingEntry) = Nothing, Optional outputs As IEnumerable(Of OutputFieldMappingEntry) = Nothing, Optional uri As String = Nothing, Optional httpHeaders As IDictionary(Of String, String) = Nothing, Optional httpMethod As String = Nothing, Optional timeout As Nullable(Of TimeSpan) = Nothing, Optional batchSize As Nullable(Of Integer) = Nothing, Optional degreeOfParallelism As Nullable(Of Integer) = Nothing, Optional authResourceId As ResourceIdentifier = Nothing, Optional authIdentity As SearchIndexerDataIdentity = Nothing) As WebApiSkillParameters
- name
- String
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 '#'.
- description
- String
The description of the skill which describes the inputs, outputs, and usage of the skill.
- context
- String
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.
- inputs
- IEnumerable<InputFieldMappingEntry>
Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
- outputs
- IEnumerable<OutputFieldMappingEntry>
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.
- uri
- String
The url for the Web API.
- httpHeaders
- IDictionary<String,String>
The headers required to make the http request.
- httpMethod
- String
The method for the http request.
If set, the number of parallel calls that can be made to the Web API.
- authResourceId
- ResourceIdentifier
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.
- authIdentity
- SearchIndexerDataIdentity
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.
Returns
A new WebApiSkill instance for mocking.
