WebApiSkill interface

Pakiet:

@azure/search-documents

Umiejętność, która może wywołać punkt końcowy internetowego interfejsu API, umożliwiając rozszerzenie zestawu umiejętności przez wywołanie kodu niestandardowego.

Rozszerzenie

BaseSearchIndexerSkill

Właściwości

authIdentity	Tożsamość zarządzana przypisana przez użytkownika używana na potrzeby połączeń wychodzących. Jeśli podano identyfikator authResourceId i nie zostanie określony, zostanie użyta tożsamość zarządzana przypisana przez system. W przypadku aktualizacji indeksatora, jeśli tożsamość jest nieokreślona, wartość pozostaje niezmieniona. Jeśli niezdefiniowane, wartość tej właściwości zostanie wyczyszczone.
authResourceId	Dotyczy umiejętności niestandardowych łączących się z kodem zewnętrznym w funkcji platformy Azure lub inną aplikacją, która udostępnia przekształcenia. Ta wartość powinna być identyfikatorem aplikacji utworzonym dla funkcji lub aplikacji, gdy została zarejestrowana w usłudze Azure Active Directory. Po określeniu niestandardowa umiejętność łączy się z funkcją lub aplikacją przy użyciu identyfikatora zarządzanego (systemu lub przypisanego przez użytkownika) usługi wyszukiwania oraz tokenu dostępu funkcji lub aplikacji przy użyciu tej wartości jako identyfikatora zasobu do utworzenia zakresu tokenu dostępu.
batchSize	Żądany rozmiar partii, który wskazuje liczbę dokumentów.
degreeOfParallelism	W przypadku ustawienia liczba wywołań równoległych, które można wykonać w internetowym interfejsie API.
httpHeaders	Nagłówki wymagane do wykonania żądania HTTP.
httpMethod	Metoda żądania HTTP.
odatatype	Dyskryminujący polimorficzny, który określa różne typy tego obiektu może być
timeout	Żądany limit czasu żądania. Wartość domyślna to 30 sekund.
uri	Adres URL internetowego interfejsu API.

Właściwości dziedziczone

context	Reprezentuje poziom, na którym odbywają się operacje, takie jak zawartość katalogu głównego lub dokumentu dokumentu (na przykład /document lub /document/content). Wartość domyślna to /document.
description	Opis umiejętności opisujący dane wejściowe, dane wyjściowe i użycie umiejętności.
inputs	Dane wejściowe umiejętności mogą być kolumną w zestawie danych źródłowych lub danymi wyjściowymi umiejętności nadrzędnych.
name	Nazwa umiejętności, która jednoznacznie identyfikuje ją w zestawie umiejętności. Umiejętność bez zdefiniowanej nazwy będzie mieć domyślną nazwę swojego 1-opartego na indeksie w tablicy umiejętności, poprzedzoną znakiem "#".
outputs	Dane wyjściowe umiejętności to pole w indeksie wyszukiwania lub wartość, która może być zużywana jako dane wejściowe przez inną umiejętność.

Szczegóły właściwości

authIdentity

Tożsamość zarządzana przypisana przez użytkownika używana na potrzeby połączeń wychodzących. Jeśli podano identyfikator authResourceId i nie zostanie określony, zostanie użyta tożsamość zarządzana przypisana przez system. W przypadku aktualizacji indeksatora, jeśli tożsamość jest nieokreślona, wartość pozostaje niezmieniona. Jeśli niezdefiniowane, wartość tej właściwości zostanie wyczyszczone.

authIdentity?: SearchIndexerDataIdentity

Wartość właściwości

SearchIndexerDataIdentity

authResourceId

Dotyczy umiejętności niestandardowych łączących się z kodem zewnętrznym w funkcji platformy Azure lub inną aplikacją, która udostępnia przekształcenia. Ta wartość powinna być identyfikatorem aplikacji utworzonym dla funkcji lub aplikacji, gdy została zarejestrowana w usłudze Azure Active Directory. Po określeniu niestandardowa umiejętność łączy się z funkcją lub aplikacją przy użyciu identyfikatora zarządzanego (systemu lub przypisanego przez użytkownika) usługi wyszukiwania oraz tokenu dostępu funkcji lub aplikacji przy użyciu tej wartości jako identyfikatora zasobu do utworzenia zakresu tokenu dostępu.

authResourceId?: string

Wartość właściwości

string

batchSize

Żądany rozmiar partii, który wskazuje liczbę dokumentów.

batchSize?: number

Wartość właściwości

number

degreeOfParallelism

W przypadku ustawienia liczba wywołań równoległych, które można wykonać w internetowym interfejsie API.

degreeOfParallelism?: number

Wartość właściwości

number

httpHeaders

Nagłówki wymagane do wykonania żądania HTTP.

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

Wartość właściwości

{[propertyName: string]: string}

httpMethod

Metoda żądania HTTP.

httpMethod?: string

Wartość właściwości

string

odatatype

Dyskryminujący polimorficzny, który określa różne typy tego obiektu może być

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

Wartość właściwości

"#Microsoft.Skills.Custom.WebApiSkill"

timeout

Żądany limit czasu żądania. Wartość domyślna to 30 sekund.

timeout?: string

Wartość właściwości

string

uri

Adres URL internetowego interfejsu API.

uri: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

context

Reprezentuje poziom, na którym odbywają się operacje, takie jak zawartość katalogu głównego lub dokumentu dokumentu (na przykład /document lub /document/content). Wartość domyślna to /document.

context?: string

Wartość właściwości

string

dziedziczone zBaseSearchIndexerSkill.context

description

Opis umiejętności opisujący dane wejściowe, dane wyjściowe i użycie umiejętności.

description?: string

Wartość właściwości

string

dziedziczone zBaseSearchIndexerSkill.description

inputs

Dane wejściowe umiejętności mogą być kolumną w zestawie danych źródłowych lub danymi wyjściowymi umiejętności nadrzędnych.

inputs: InputFieldMappingEntry[]

Wartość właściwości

InputFieldMappingEntry[]

dziedziczone zBaseSearchIndexerSkill.inputs

name

Nazwa umiejętności, która jednoznacznie identyfikuje ją w zestawie umiejętności. Umiejętność bez zdefiniowanej nazwy będzie mieć domyślną nazwę swojego 1-opartego na indeksie w tablicy umiejętności, poprzedzoną znakiem "#".

name?: string

Wartość właściwości

string

dziedziczone zBaseSearchIndexerSkill.name

outputs

Dane wyjściowe umiejętności to pole w indeksie wyszukiwania lub wartość, która może być zużywana jako dane wejściowe przez inną umiejętność.

outputs: OutputFieldMappingEntry[]

Wartość właściwości

OutputFieldMappingEntry[]

dziedziczone zBaseSearchIndexerSkill.outputs