Dela via

WebApiSkill interface

  • Referens
Paket:
@azure/search-documents

En färdighet som kan anropa en webb-API-slutpunkt, så att du kan utöka en kompetensuppsättning genom att låta den anropa din anpassade kod.

Extends
BaseSearchIndexerSkill

Egenskaper

authIdentity

Den användartilldelade hanterade identiteten som används för utgående anslutningar. Om ett authResourceId har angetts och det inte har angetts används den systemtilldelade hanterade identiteten. Vid uppdateringar av indexeraren, om identiteten är ospecificerad, förblir värdet oförändrat. Om det är odefinierat rensas värdet för den här egenskapen.
authResourceId

Gäller för anpassade kunskaper som ansluter till extern kod i en Azure-funktion eller något annat program som tillhandahåller transformeringarna. Det här värdet ska vara det program-ID som skapades för funktionen eller appen när den registrerades med Azure Active Directory. När den har angetts ansluter den anpassade färdigheten till funktionen eller appen med hjälp av ett hanterat ID (antingen system eller användartilldelat) för söktjänsten och åtkomsttoken för funktionen eller appen, med det här värdet som resurs-ID för att skapa åtkomsttokens omfång.
batchSize

Önskad batchstorlek som anger antalet dokument.
degreeOfParallelism

Om det anges, antalet parallella anrop som kan göras till webb-API:et.
httpHeaders

De rubriker som krävs för att göra http-begäran.
httpMethod

Metoden för http-begäran.
odatatype

Polymorft diskriminerande, vilket anger de olika typer som det här objektet kan vara
timeout

Önskad timeout för begäran. Standardvärdet är 30 sekunder.
uri

Url:en för webb-API:et.

Ärvda egenskaper

context

Representerar den nivå där åtgärder utförs, till exempel dokumentroten eller dokumentinnehållet (till exempel /document eller /document/content). Standardvärdet är /document.
description

Beskrivningen av den färdighet som beskriver indata, utdata och användning av färdigheten.
inputs

Indata för färdigheterna kan vara en kolumn i källdatauppsättningen eller utdata från en överordnad färdighet.
name

Namnet på den färdighet som unikt identifierar den inom kompetensuppsättningen. En färdighet utan definierat namn får ett standardnamn för sitt 1-baserade index i kunskapsmatrisen, prefixet med tecknet '#'.
outputs

Utdata från en färdighet är antingen ett fält i ett sökindex eller ett värde som kan användas som indata av en annan färdighet.

Egenskapsinformation

authIdentity

Den användartilldelade hanterade identiteten som används för utgående anslutningar. Om ett authResourceId har angetts och det inte har angetts används den systemtilldelade hanterade identiteten. Vid uppdateringar av indexeraren, om identiteten är ospecificerad, förblir värdet oförändrat. Om det är odefinierat rensas värdet för den här egenskapen.

authIdentity?: SearchIndexerDataIdentity

Egenskapsvärde

SearchIndexerDataIdentity

authResourceId

Gäller för anpassade kunskaper som ansluter till extern kod i en Azure-funktion eller något annat program som tillhandahåller transformeringarna. Det här värdet ska vara det program-ID som skapades för funktionen eller appen när den registrerades med Azure Active Directory. När den har angetts ansluter den anpassade färdigheten till funktionen eller appen med hjälp av ett hanterat ID (antingen system eller användartilldelat) för söktjänsten och åtkomsttoken för funktionen eller appen, med det här värdet som resurs-ID för att skapa åtkomsttokens omfång.

authResourceId?: string

Egenskapsvärde

string

batchSize

Önskad batchstorlek som anger antalet dokument.

batchSize?: number

Egenskapsvärde

number

degreeOfParallelism

Om det anges, antalet parallella anrop som kan göras till webb-API:et.

degreeOfParallelism?: number

Egenskapsvärde

number

httpHeaders

De rubriker som krävs för att göra http-begäran.

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

Egenskapsvärde

{[propertyName: string]: string}

httpMethod

Metoden för http-begäran.

httpMethod?: string

Egenskapsvärde

string

odatatype

Polymorft diskriminerande, vilket anger de olika typer som det här objektet kan vara

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

Egenskapsvärde

"#Microsoft.Skills.Custom.WebApiSkill"

timeout

Önskad timeout för begäran. Standardvärdet är 30 sekunder.

timeout?: string

Egenskapsvärde

string

uri

Url:en för webb-API:et.

uri: string

Egenskapsvärde

string

Information om ärvda egenskaper

context

Representerar den nivå där åtgärder utförs, till exempel dokumentroten eller dokumentinnehållet (till exempel /document eller /document/content). Standardvärdet är /document.

context?: string

Egenskapsvärde

string

ärvs frånBaseSearchIndexerSkill.context

description

Beskrivningen av den färdighet som beskriver indata, utdata och användning av färdigheten.

description?: string

Egenskapsvärde

string

ärvd frånBaseSearchIndexerSkill.description

inputs

Indata för färdigheterna kan vara en kolumn i källdatauppsättningen eller utdata från en överordnad färdighet.

inputs: InputFieldMappingEntry[]

Egenskapsvärde

InputFieldMappingEntry[]

ärvs frånBaseSearchIndexerSkill.inputs

name

Namnet på den färdighet som unikt identifierar den inom kompetensuppsättningen. En färdighet utan definierat namn får ett standardnamn för sitt 1-baserade index i kunskapsmatrisen, prefixet med tecknet '#'.

name?: string

Egenskapsvärde

string

ärvd frånBaseSearchIndexerSkill.name

outputs

Utdata från en färdighet är antingen ett fält i ett sökindex eller ett värde som kan användas som indata av en annan färdighet.

outputs: OutputFieldMappingEntry[]

Egenskapsvärde

OutputFieldMappingEntry[]

ärvda frånBaseSearchIndexerSkill.outputs