WebApiSkill interface

Pakket:

@azure/search-documents

Een vaardigheid die een web-API-eindpunt kan aanroepen, zodat u een vaardighedenset kunt uitbreiden door uw aangepaste code aan te roepen.

Uitbreiding

BaseSearchIndexerSkill

Eigenschappen

authIdentity	De door de gebruiker toegewezen beheerde identiteit die wordt gebruikt voor uitgaande verbindingen. Als er een authResourceId is opgegeven en deze niet is opgegeven, wordt de door het systeem toegewezen beheerde identiteit gebruikt. Bij updates van de indexeerfunctie blijft de waarde ongewijzigd als de identiteit niet is opgegeven. Als deze eigenschap niet is gedefinieerd, wordt de waarde van deze eigenschap gewist.
authResourceId	Is van toepassing op aangepaste vaardigheden die verbinding maken met externe code in een Azure-functie of een andere toepassing die de transformaties biedt. Deze waarde moet de toepassings-id zijn die is gemaakt voor de functie of app wanneer deze is geregistreerd bij Azure Active Directory. Wanneer deze is opgegeven, maakt de aangepaste vaardigheid verbinding met de functie of app met behulp van een beheerde id (systeem of door de gebruiker toegewezen) van de zoekservice en het toegangstoken van de functie of app, waarbij deze waarde wordt gebruikt als de resource-id voor het maken van het bereik van het toegangstoken.
batchSize	De gewenste batchgrootte die het aantal documenten aangeeft.
degreeOfParallelism	Als deze optie is ingesteld, kan het aantal parallelle aanroepen naar de web-API worden uitgevoerd.
httpHeaders	De headers die nodig zijn om de HTTP-aanvraag te maken.
httpMethod	De methode voor de HTTP-aanvraag.
odatatype	Polymorf discriminator, waarmee de verschillende typen dit object kunnen worden opgegeven
timeout	De gewenste time-out voor de aanvraag. De standaardwaarde is 30 seconden.
uri	De URL voor de web-API.

Overgenomen eigenschappen

context	Vertegenwoordigt het niveau waarop bewerkingen plaatsvinden, zoals de hoofdmap van het document of de inhoud van het document (bijvoorbeeld /document of /document/inhoud). De standaardwaarde is /document.
description	De beschrijving van de vaardigheid die de invoer, uitvoer en het gebruik van de vaardigheid beschrijft.
inputs	Invoer van de vaardigheden kan een kolom zijn in de brongegevensset of de uitvoer van een upstream-vaardigheid.
name	De naam van de vaardigheid die deze uniek identificeert in de vaardighedenset. Een vaardigheid zonder gedefinieerde naam krijgt een standaardnaam van de op 1 gebaseerde index in de vaardighedenmatrix, voorafgegaan door het teken '#'.
outputs	De uitvoer van een vaardigheid is een veld in een zoekindex of een waarde die kan worden gebruikt als invoer door een andere vaardigheid.

Eigenschapdetails

authIdentity

De door de gebruiker toegewezen beheerde identiteit die wordt gebruikt voor uitgaande verbindingen. Als er een authResourceId is opgegeven en deze niet is opgegeven, wordt de door het systeem toegewezen beheerde identiteit gebruikt. Bij updates van de indexeerfunctie blijft de waarde ongewijzigd als de identiteit niet is opgegeven. Als deze eigenschap niet is gedefinieerd, wordt de waarde van deze eigenschap gewist.

authIdentity?: SearchIndexerDataIdentity

Waarde van eigenschap

SearchIndexerDataIdentity

authResourceId

Is van toepassing op aangepaste vaardigheden die verbinding maken met externe code in een Azure-functie of een andere toepassing die de transformaties biedt. Deze waarde moet de toepassings-id zijn die is gemaakt voor de functie of app wanneer deze is geregistreerd bij Azure Active Directory. Wanneer deze is opgegeven, maakt de aangepaste vaardigheid verbinding met de functie of app met behulp van een beheerde id (systeem of door de gebruiker toegewezen) van de zoekservice en het toegangstoken van de functie of app, waarbij deze waarde wordt gebruikt als de resource-id voor het maken van het bereik van het toegangstoken.

authResourceId?: string

Waarde van eigenschap

string

batchSize

De gewenste batchgrootte die het aantal documenten aangeeft.

batchSize?: number

Waarde van eigenschap

number

degreeOfParallelism

Als deze optie is ingesteld, kan het aantal parallelle aanroepen naar de web-API worden uitgevoerd.

degreeOfParallelism?: number

Waarde van eigenschap

number

httpHeaders

De headers die nodig zijn om de HTTP-aanvraag te maken.

httpHeaders?: {[propertyName: string]: string}

Waarde van eigenschap

{[propertyName: string]: string}

httpMethod

De methode voor de HTTP-aanvraag.

httpMethod?: string

Waarde van eigenschap

string

odatatype

Polymorf discriminator, waarmee de verschillende typen dit object kunnen worden opgegeven

odatatype: "#Microsoft.Skills.Custom.WebApiSkill"

Waarde van eigenschap

"#Microsoft.Skills.Custom.WebApiSkill"

timeout

De gewenste time-out voor de aanvraag. De standaardwaarde is 30 seconden.

timeout?: string

Waarde van eigenschap

string

uri

De URL voor de web-API.

uri: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

context

Vertegenwoordigt het niveau waarop bewerkingen plaatsvinden, zoals de hoofdmap van het document of de inhoud van het document (bijvoorbeeld /document of /document/inhoud). De standaardwaarde is /document.

context?: string

Waarde van eigenschap

string

overgenomen vanBaseSearchIndexerSkill.context

description

De beschrijving van de vaardigheid die de invoer, uitvoer en het gebruik van de vaardigheid beschrijft.

description?: string

Waarde van eigenschap

string

overgenomen vanBaseSearchIndexerSkill.description

inputs

Invoer van de vaardigheden kan een kolom zijn in de brongegevensset of de uitvoer van een upstream-vaardigheid.

inputs: InputFieldMappingEntry[]

Waarde van eigenschap

InputFieldMappingEntry[]

overgenomen vanBaseSearchIndexerSkill.inputs

name

De naam van de vaardigheid die deze uniek identificeert in de vaardighedenset. Een vaardigheid zonder gedefinieerde naam krijgt een standaardnaam van de op 1 gebaseerde index in de vaardighedenmatrix, voorafgegaan door het teken '#'.

name?: string

Waarde van eigenschap

string

overgenomen vanBaseSearchIndexerSkill.name

outputs

De uitvoer van een vaardigheid is een veld in een zoekindex of een waarde die kan worden gebruikt als invoer door een andere vaardigheid.

outputs: OutputFieldMappingEntry[]

Waarde van eigenschap

OutputFieldMappingEntry[]

overgenomen vanBaseSearchIndexerSkill.outputs