WebApiSkill Class

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

All required parameters must be populated in order to send to Azure.

Inheritance

azure.search.documents.indexes._generated.models._models_py3.SearchIndexerSkill

WebApiSkill

Constructor

WebApiSkill(*, inputs: List[azure.search.documents.indexes._generated.models._models_py3.InputFieldMappingEntry], outputs: List[azure.search.documents.indexes._generated.models._models_py3.OutputFieldMappingEntry], uri: str, name: Optional[str] = None, description: Optional[str] = None, context: Optional[str] = None, http_headers: Optional[Dict[str, str]] = None, http_method: Optional[str] = None, timeout: Optional[datetime.timedelta] = None, batch_size: Optional[int] = None, degree_of_parallelism: Optional[int] = None, **kwargs)

Parameters

odata_type

str

Required

Required. Identifies the concrete type of the skill.Constant filled by server.

name

str

Required

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

str

Required

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

context

str

Required

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

list[InputFieldMappingEntry]

Required

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

outputs

list[OutputFieldMappingEntry]

Required

Required. 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

str

Required

Required. The url for the Web API.

http_headers

dict[str, str]

Required

The headers required to make the http request.

http_method

str

Required

The method for the http request.

timeout

timedelta

Required

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

batch_size

int

Required

The desired batch size which indicates number of documents.

degree_of_parallelism

int

Required

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