Share via

SearchIndexKnowledgeSource interface

Package:
@azure/search-documents

Knowledge Source targeting a search index.

Extends
BaseKnowledgeSource

Properties

kind

Polymorphic discriminator, which specifies the different types this object can be
searchIndexParameters

The parameters for the knowledge source.

Inherited Properties

description

Optional user-defined description.
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 knowledge base definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your knowledge base definition, it will always remain encrypted. The search service 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 knowledge base 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 knowledge base.
name

The name of the knowledge source.

Property Details

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "searchIndex"

Property Value

"searchIndex"

searchIndexParameters

The parameters for the knowledge source.

searchIndexParameters: SearchIndexKnowledgeSourceParameters

Property Value

SearchIndexKnowledgeSourceParameters

Inherited Property Details

description

Optional user-defined description.

description?: string

Property Value

string

Inherited From BaseKnowledgeSource.description

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 knowledge base definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your knowledge base definition, it will always remain encrypted. The search service 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 knowledge base 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

Inherited From BaseKnowledgeSource.encryptionKey

etag

The ETag of the knowledge base.

etag?: string

Property Value

string

Inherited From BaseKnowledgeSource.etag

name

The name of the knowledge source.

name: string

Property Value

string

Inherited From BaseKnowledgeSource.name