Share via

KnowledgeBase interface

Package:
@azure/search-documents

Properties

answerInstructions

Instructions considered by the knowledge base when generating answers.
description

The description of the knowledge base.
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.
knowledgeSources
models

Contains configuration options on how to connect to AI models.
name

The name of the knowledge base.
outputMode
retrievalInstructions

Instructions considered by the knowledge base when developing query plan.
retrievalReasoningEffort

Property Details

answerInstructions

Instructions considered by the knowledge base when generating answers.

answerInstructions?: string

Property Value

string

description

The description of the knowledge base.

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 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

etag

The ETag of the knowledge base.

etag?: string

Property Value

string

knowledgeSources 

knowledgeSources: KnowledgeSourceReference[]

Property Value

KnowledgeSourceReference[]

models

Contains configuration options on how to connect to AI models.

models: KnowledgeBaseAzureOpenAIModel[]

Property Value

KnowledgeBaseAzureOpenAIModel[]

name

The name of the knowledge base.

name: string

Property Value

string

outputMode 

outputMode?: string

Property Value

string

retrievalInstructions

Instructions considered by the knowledge base when developing query plan.

retrievalInstructions?: string

Property Value

string

retrievalReasoningEffort 

retrievalReasoningEffort?: KnowledgeRetrievalReasoningEffort

Property Value

KnowledgeRetrievalReasoningEffort