WebApiSkill interface

Paquete:

@azure/search-documents

Una aptitud que puede llamar a un punto de conexión de API web, lo que le permite ampliar un conjunto de aptitudes haciendo que llame al código personalizado.

Extends

BaseSearchIndexerSkill

Propiedades

authIdentity	La identidad administrada asignada por el usuario que se usa para las conexiones salientes. Si se proporciona un authResourceId y no se especifica, se usa la identidad administrada asignada por el sistema. En las actualizaciones del indexador, si la identidad no está especificada, el valor permanece sin cambios. Si no está definido, se borra el valor de esta propiedad.
authResourceId	Se aplica a las aptitudes personalizadas que se conectan al código externo en una función de Azure o a otra aplicación que proporciona las transformaciones. Este valor debe ser el identificador de aplicación creado para la función o la aplicación cuando se registró con Azure Active Directory. Cuando se especifica, la aptitud personalizada se conecta a la función o aplicación mediante un identificador administrado (ya sea del sistema o asignado por el usuario) del servicio de búsqueda y el token de acceso de la función o aplicación, usando este valor como identificador de recurso para crear el ámbito del token de acceso.
batchSize	Tamaño de lote deseado que indica el número de documentos.
degreeOfParallelism	Si se establece, el número de llamadas paralelas que se pueden realizar en la API web.
httpHeaders	Encabezados necesarios para realizar la solicitud http.
httpMethod	Método para la solicitud http.
odatatype	Discriminador polimórfico, que especifica los distintos tipos que puede ser este objeto.
timeout	Tiempo de espera deseado para la solicitud. El valor predeterminado es de 30 segundos.
uri	Dirección URL de la API web.

Propiedades heredadas

context	Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document.
description	Descripción de la aptitud que describe las entradas, salidas y uso de la aptitud.
inputs	Las entradas de las aptitudes podrían ser una columna del conjunto de datos de origen o la salida de una aptitud ascendente.
name	Nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una aptitud sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de aptitudes, con el prefijo "#".
outputs	La salida de una aptitud es un campo en un índice de búsqueda o un valor que otra aptitud puede consumir como entrada.

Detalles de las propiedades

authIdentity

La identidad administrada asignada por el usuario que se usa para las conexiones salientes. Si se proporciona un authResourceId y no se especifica, se usa la identidad administrada asignada por el sistema. En las actualizaciones del indexador, si la identidad no está especificada, el valor permanece sin cambios. Si no está definido, se borra el valor de esta propiedad.

authIdentity?: SearchIndexerDataIdentity

Valor de propiedad

SearchIndexerDataIdentity

authResourceId

Se aplica a las aptitudes personalizadas que se conectan al código externo en una función de Azure o a otra aplicación que proporciona las transformaciones. Este valor debe ser el identificador de aplicación creado para la función o la aplicación cuando se registró con Azure Active Directory. Cuando se especifica, la aptitud personalizada se conecta a la función o aplicación mediante un identificador administrado (ya sea del sistema o asignado por el usuario) del servicio de búsqueda y el token de acceso de la función o aplicación, usando este valor como identificador de recurso para crear el ámbito del token de acceso.

authResourceId?: string

Valor de propiedad

string

batchSize

Tamaño de lote deseado que indica el número de documentos.

batchSize?: number

Valor de propiedad

number

degreeOfParallelism

Si se establece, el número de llamadas paralelas que se pueden realizar en la API web.

degreeOfParallelism?: number

Valor de propiedad

number

httpHeaders

Encabezados necesarios para realizar la solicitud http.

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

Valor de propiedad

{[propertyName: string]: string}

httpMethod

Método para la solicitud http.

httpMethod?: string

Valor de propiedad

string

odatatype

Discriminador polimórfico, que especifica los distintos tipos que puede ser este objeto.

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

Valor de propiedad

"#Microsoft.Skills.Custom.WebApiSkill"

timeout

Tiempo de espera deseado para la solicitud. El valor predeterminado es de 30 segundos.

timeout?: string

Valor de propiedad

string

uri

Dirección URL de la API web.

uri: string

Valor de propiedad

string

Detalles de las propiedades heredadas

context

Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document.

context?: string

Valor de propiedad

string

heredado debaseSearchIndexerSkill.context

description

Descripción de la aptitud que describe las entradas, salidas y uso de la aptitud.

description?: string

Valor de propiedad

string

heredado deBaseSearchIndexerSkill.description

inputs

Las entradas de las aptitudes podrían ser una columna del conjunto de datos de origen o la salida de una aptitud ascendente.

inputs: InputFieldMappingEntry[]

Valor de propiedad

InputFieldMappingEntry[]

heredado debaseSearchIndexerSkill.inputs

name

Nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una aptitud sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de aptitudes, con el prefijo "#".

name?: string

Valor de propiedad

string

heredado deBaseSearchIndexerSkill.name

outputs

La salida de una aptitud es un campo en un índice de búsqueda o un valor que otra aptitud puede consumir como entrada.

outputs: OutputFieldMappingEntry[]

Valor de propiedad

OutputFieldMappingEntry[]

heredado debaseSearchIndexerSkill.outputs