WebApiSkill interface

Pacote:

@azure/search-documents

Uma habilidade que pode chamar um ponto de extremidade de API Web, permitindo que você estenda um conjunto de habilidades fazendo com que ele chame seu código personalizado.

Extends

BaseSearchIndexerSkill

Propriedades

authIdentity	A identidade gerenciada atribuída pelo usuário usada para conexões de saída. Se um authResourceId for fornecido e não for especificado, a identidade gerenciada atribuída pelo sistema será usada. Em atualizações para o indexador, se a identidade não for especificada, o valor permanecerá inalterado. Se indefinido, o valor dessa propriedade será limpo.
authResourceId	Aplica-se a habilidades personalizadas que se conectam ao código externo em uma função do Azure ou em algum outro aplicativo que fornece as transformações. Esse valor deve ser a ID do aplicativo criada para a função ou aplicativo quando ela foi registrada no Azure Active Directory. Quando especificado, a habilidade personalizada se conecta à função ou aplicativo usando uma ID gerenciada (sistema ou atribuído pelo usuário) do serviço de pesquisa e o token de acesso da função ou aplicativo, usando esse valor como a ID do recurso para criar o escopo do token de acesso.
batchSize	O tamanho do lote desejado que indica o número de documentos.
degreeOfParallelism	Se definido, o número de chamadas paralelas que podem ser feitas na API Web.
httpHeaders	Os cabeçalhos necessários para fazer a solicitação http.
httpMethod	O método para a solicitação http.
odatatype	Discriminatório polimórfico, que especifica os diferentes tipos que esse objeto pode ser
timeout	O tempo limite desejado para a solicitação. O padrão é 30 segundos.
uri	A URL da API Web.

Propriedades herdadas

context	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
description	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
inputs	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
name	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.

Detalhes da propriedade

authIdentity

A identidade gerenciada atribuída pelo usuário usada para conexões de saída. Se um authResourceId for fornecido e não for especificado, a identidade gerenciada atribuída pelo sistema será usada. Em atualizações para o indexador, se a identidade não for especificada, o valor permanecerá inalterado. Se indefinido, o valor dessa propriedade será limpo.

authIdentity?: SearchIndexerDataIdentity

Valor da propriedade

SearchIndexerDataIdentity

authResourceId

Aplica-se a habilidades personalizadas que se conectam ao código externo em uma função do Azure ou em algum outro aplicativo que fornece as transformações. Esse valor deve ser a ID do aplicativo criada para a função ou aplicativo quando ela foi registrada no Azure Active Directory. Quando especificado, a habilidade personalizada se conecta à função ou aplicativo usando uma ID gerenciada (sistema ou atribuído pelo usuário) do serviço de pesquisa e o token de acesso da função ou aplicativo, usando esse valor como a ID do recurso para criar o escopo do token de acesso.

authResourceId?: string

Valor da propriedade

string

batchSize

O tamanho do lote desejado que indica o número de documentos.

batchSize?: number

Valor da propriedade

number

degreeOfParallelism

Se definido, o número de chamadas paralelas que podem ser feitas na API Web.

degreeOfParallelism?: number

Valor da propriedade

number

httpHeaders

Os cabeçalhos necessários para fazer a solicitação http.

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

Valor da propriedade

{[propertyName: string]: string}

httpMethod

O método para a solicitação http.

httpMethod?: string

Valor da propriedade

string

odatatype

Discriminatório polimórfico, que especifica os diferentes tipos que esse objeto pode ser

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

Valor da propriedade

"#Microsoft.Skills.Custom.WebApiSkill"

timeout

O tempo limite desejado para a solicitação. O padrão é 30 segundos.

timeout?: string

Valor da propriedade

string

uri

A URL da API Web.

uri: string

Valor da propriedade

string

Detalhes das propriedades herdadas

context

Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

context?: string

Valor da propriedade

string

Herdado deBaseSearchIndexerSkill.context

description

A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.

description?: string

Valor da propriedade

string

Herdado deBaseSearchIndexerSkill.description

inputs

As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.

inputs: InputFieldMappingEntry[]

Valor da propriedade

InputFieldMappingEntry[]

Herdado deBaseSearchIndexerSkill.inputs

name

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.

name?: string

Valor da propriedade

string

herdado deBaseSearchIndexerSkill.name

outputs

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.

outputs: OutputFieldMappingEntry[]

Valor da propriedade

OutputFieldMappingEntry[]

Herdado deBaseSearchIndexerSkill.outputs