SearchIndexerSkillset interface

Package:

@azure/search-documents

A list of skills.

Properties

cognitiveServicesAccount	Details about cognitive services to be used when running skills.
description	The description of the skillset.
encryptionKey	A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition in Azure Cognitive Search. Once you have encrypted your skillset definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.
etag	The ETag of the skillset.
indexProjection	Definition of additional projections to secondary search index(es).
knowledgeStore	Definition of additional projections to azure blob, table, or files, of enriched data.
name	The name of the skillset.
skills	A list of skills in the skillset.

Property Details

cognitiveServicesAccount

Details about cognitive services to be used when running skills.

cognitiveServicesAccount?: CognitiveServicesAccount

Property Value

CognitiveServicesAccount

description

The description of the skillset.

description?: string

Property Value

string

encryptionKey

A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition in Azure Cognitive Search. Once you have encrypted your skillset definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.

encryptionKey?: SearchResourceEncryptionKey

Property Value

SearchResourceEncryptionKey

etag

The ETag of the skillset.

etag?: string

Property Value

string

indexProjection

Definition of additional projections to secondary search index(es).

indexProjection?: SearchIndexerIndexProjection

Property Value

SearchIndexerIndexProjection

knowledgeStore

Definition of additional projections to azure blob, table, or files, of enriched data.

knowledgeStore?: SearchIndexerKnowledgeStore

Property Value

SearchIndexerKnowledgeStore

name

The name of the skillset.

name: string

Property Value

string

skills

A list of skills in the skillset.

skills: SearchIndexerSkill[]

Property Value

SearchIndexerSkill[]