Partilhar via

WebApiSkill interface

Pacote:
@azure/search-documents

Uma habilidade que pode chamar um ponto de extremidade de API da 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 ao sistema será usada. Nas atualizações do 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 a 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 Ative Directory. Quando especificada, a habilidade personalizada se conecta à função ou aplicativo usando uma ID gerenciada (atribuída pelo sistema ou 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 de lote desejado que indica o número de documentos.
degreeOfParallelism

Se definido, o número de chamadas paralelas que podem ser feitas para a API da Web.
httpHeaders

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

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

Discriminador polimórfico, que especifica os diferentes tipos que este objeto pode ser
timeout

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

A url para a API da Web.

Propriedades Herdadas

context

Representa o nível no qual 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, saídas e 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 a montante.
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, prefixada 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 uma entrada por outra habilidade.

Detalhes de 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 ao sistema será usada. Nas atualizações do indexador, se a identidade não for especificada, o valor permanecerá inalterado. Se indefinido, o valor dessa propriedade será limpo.

authIdentity?: SearchIndexerDataIdentity

Valor de Propriedade

SearchIndexerDataIdentity

authResourceId

Aplica-se a habilidades personalizadas que se conectam a 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 Ative Directory. Quando especificada, a habilidade personalizada se conecta à função ou aplicativo usando uma ID gerenciada (atribuída pelo sistema ou 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 de Propriedade

string

batchSize

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

batchSize?: number

Valor de Propriedade

number

degreeOfParallelism

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

degreeOfParallelism?: number

Valor de Propriedade

number

httpHeaders

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

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

Valor de Propriedade

{[propertyName: string]: string}

httpMethod

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

httpMethod?: string

Valor de Propriedade

string

odatatype

Discriminador polimórfico, que especifica os diferentes tipos que este objeto pode ser

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

Valor de Propriedade

"#Microsoft.Skills.Custom.WebApiSkill"

timeout

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

timeout?: string

Valor de Propriedade

string

uri

A url para a API da Web.

uri: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

context

Representa o nível no qual 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 de Propriedade

string

herdado de BaseSearchIndexerSkill.context

description

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

description?: string

Valor de 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 a montante.

inputs: InputFieldMappingEntry[]

Valor de 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, prefixada com o caractere '#'.

name?: string

Valor de Propriedade

string

herdada deBaseSearchIndexerSkill.name

outputs

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

outputs: OutputFieldMappingEntry[]

Valor de Propriedade

OutputFieldMappingEntry[]

herdado deBaseSearchIndexerSkill.outputs