Поделиться через

WebApiSkill interface

  • Ссылка
Пакет:
@azure/search-documents

Навык, который может вызывать конечную точку веб-API, позволяя расширить набор навыков, вызывая пользовательский код.

Extends
BaseSearchIndexerSkill

Свойства

authIdentity

Назначаемое пользователем управляемое удостоверение, используемое для исходящих подключений. Если указан идентификатор authResourceId и он не указан, используется управляемое удостоверение, назначаемое системой. При обновлении индексатора, если удостоверение не указано, значение остается неизменным. Если не определено, значение этого свойства очищается.
authResourceId

Применяется к пользовательским навыкам, которые подключаются к внешнему коду в функции Azure или другом приложении, которое предоставляет преобразования. Это значение должно быть идентификатором приложения, созданным для функции или приложения при регистрации в Azure Active Directory. При указании пользовательский навык подключается к функции или приложению с помощью управляемого идентификатора (назначаемого системой или пользователем) службы поиска и маркера доступа функции или приложения, используя это значение в качестве идентификатора ресурса для создания области маркера доступа.
batchSize

Требуемый размер пакета, указывающий количество документов.
degreeOfParallelism

Если задано, количество параллельных вызовов, которые можно выполнить в веб-API.
httpHeaders

Заголовки, необходимые для выполнения http-запроса.
httpMethod

Метод http-запроса.
odatatype

Полиморфная дискриминация, указывающая различные типы этого объекта, может быть
timeout

Требуемое время ожидания запроса. Значение по умолчанию — 30 секунд.
uri

URL-адрес веб-API.

Унаследованные свойства

context

Представляет уровень, на котором выполняются операции, такие как корневой каталог документа или содержимое документа (например, /document или /document/content). Значение по умолчанию — /document.
description

Описание навыка, описывающего входные данные, выходные данные и использование навыка.
inputs

Входные данные навыков могут быть столбцом в исходном наборе данных или выходными данными вышестоящего навыка.
name

Имя навыка, который однозначно идентифицирует его в наборе навыков. Навык без определенного имени будет указан по умолчанию для его 1-го индекса в массиве навыков, префиксированного символом "#".
outputs

Выходные данные навыка — это поле в индексе поиска или значение, которое можно использовать в качестве входных данных другим навыком.

Сведения о свойстве

authIdentity

Назначаемое пользователем управляемое удостоверение, используемое для исходящих подключений. Если указан идентификатор authResourceId и он не указан, используется управляемое удостоверение, назначаемое системой. При обновлении индексатора, если удостоверение не указано, значение остается неизменным. Если не определено, значение этого свойства очищается.

authIdentity?: SearchIndexerDataIdentity

Значение свойства

SearchIndexerDataIdentity

authResourceId

Применяется к пользовательским навыкам, которые подключаются к внешнему коду в функции Azure или другом приложении, которое предоставляет преобразования. Это значение должно быть идентификатором приложения, созданным для функции или приложения при регистрации в Azure Active Directory. При указании пользовательский навык подключается к функции или приложению с помощью управляемого идентификатора (назначаемого системой или пользователем) службы поиска и маркера доступа функции или приложения, используя это значение в качестве идентификатора ресурса для создания области маркера доступа.

authResourceId?: string

Значение свойства

string

batchSize

Требуемый размер пакета, указывающий количество документов.

batchSize?: number

Значение свойства

number

degreeOfParallelism

Если задано, количество параллельных вызовов, которые можно выполнить в веб-API.

degreeOfParallelism?: number

Значение свойства

number

httpHeaders

Заголовки, необходимые для выполнения http-запроса.

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

Значение свойства

{[propertyName: string]: string}

httpMethod

Метод http-запроса.

httpMethod?: string

Значение свойства

string

odatatype

Полиморфная дискриминация, указывающая различные типы этого объекта, может быть

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

Значение свойства

"#Microsoft.Skills.Custom.WebApiSkill"

timeout

Требуемое время ожидания запроса. Значение по умолчанию — 30 секунд.

timeout?: string

Значение свойства

string

uri

URL-адрес веб-API.

uri: string

Значение свойства

string

Сведения об унаследованном свойстве

context

Представляет уровень, на котором выполняются операции, такие как корневой каталог документа или содержимое документа (например, /document или /document/content). Значение по умолчанию — /document.

context?: string

Значение свойства

string

Унаследовано отBaseSearchIndexerSkill.context

description

Описание навыка, описывающего входные данные, выходные данные и использование навыка.

description?: string

Значение свойства

string

наследуется отBaseSearchIndexerSkill.description

inputs

Входные данные навыков могут быть столбцом в исходном наборе данных или выходными данными вышестоящего навыка.

inputs: InputFieldMappingEntry[]

Значение свойства

InputFieldMappingEntry[]

наследуется отBaseSearchIndexerSkill.inputs

name

Имя навыка, который однозначно идентифицирует его в наборе навыков. Навык без определенного имени будет указан по умолчанию для его 1-го индекса в массиве навыков, префиксированного символом "#".

name?: string

Значение свойства

string

наследуется отBaseSearchIndexerSkill.name

outputs

Выходные данные навыка — это поле в индексе поиска или значение, которое можно использовать в качестве входных данных другим навыком.

outputs: OutputFieldMappingEntry[]

Значение свойства

OutputFieldMappingEntry[]

унаследовано отBaseSearchIndexerSkill.outputs