WebApiSkill interface

Pacote:

@azure/search-documents

Uma competência que pode chamar um ponto final da API Web, permitindo-lhe expandir um conjunto de competências ao fazer com que este chame o seu código personalizado.

Extends

BaseSearchIndexerSkill

Propriedades

batchSize	O tamanho do lote pretendido que indica o número de documentos.
degreeOfParallelism	Se estiver definido, o número de chamadas paralelas que podem ser feitas à API Web.
httpHeaders	Os cabeçalhos necessários para fazer o pedido http.
httpMethod	O método para o pedido http.
odatatype	Discriminador polimórfico, que especifica os diferentes tipos que este objeto pode ser
timeout	O tempo limite pretendido para o pedido. A predefinição é de 30 segundos.
uri	O 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, /documento ou /documento/conteúdo). A predefinição é /document.
description	A descrição da competência que descreve as entradas, saídas e utilização da competência.
inputs	As entradas das competências podem ser uma coluna no conjunto de dados de origem ou a saída de uma competência a montante.
name	O nome da competência que a identifica exclusivamente no conjunto de competências. Uma competência sem nome definido receberá um nome predefinido do respetivo índice baseado em 1 na matriz de competências, com o prefixo com o caráter #.
outputs	A saída de uma competência é um campo num índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra competência.

Detalhes de Propriedade

batchSize

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

batchSize?: number

Valor de Propriedade

number

degreeOfParallelism

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

degreeOfParallelism?: number

Valor de Propriedade

number

httpHeaders

Os cabeçalhos necessários para fazer o pedido http.

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

Valor de Propriedade

{[propertyName: string]: string}

httpMethod

O método para o pedido 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 pretendido para o pedido. A predefinição é de 30 segundos.

timeout?: string

Valor de Propriedade

string

uri

O URL da API Web.

uri: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

context

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

context?: string

Valor de Propriedade

string

Herdado deBaseSearchIndexerSkill.context

description

A descrição da competência que descreve as entradas, saídas e utilização da competência.

description?: string

Valor de Propriedade

string

Herdado deBaseSearchIndexerSkill.description

inputs

As entradas das competências podem ser uma coluna no conjunto de dados de origem ou a saída de uma competência a montante.

inputs: InputFieldMappingEntry[]

Valor de Propriedade

InputFieldMappingEntry[]

Herdado deBaseSearchIndexerSkill.inputs

name

O nome da competência que a identifica exclusivamente no conjunto de competências. Uma competência sem nome definido receberá um nome predefinido do respetivo índice baseado em 1 na matriz de competências, com o prefixo com o caráter #.

name?: string

Valor de Propriedade

string

Herdado deBaseSearchIndexerSkill.name

outputs

A saída de uma competência é um campo num índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra competência.

outputs: OutputFieldMappingEntry[]

Valor de Propriedade

OutputFieldMappingEntry[]

Herdado deBaseSearchIndexerSkill.outputs