Package version:

Interface KnowledgeBase

interface KnowledgeBase {
    answerInstructions?: string;
    description?: string;
    encryptionKey?: SearchResourceEncryptionKey;
    etag?: string;
    knowledgeSources: KnowledgeSourceReference[];
    models: KnowledgeBaseAzureOpenAIModel[];
    name: string;
    outputMode?: string;
    retrievalInstructions?: string;
    retrievalReasoningEffort?: KnowledgeRetrievalReasoningEffort;
}

Properties

answerInstructions? description? encryptionKey? etag? knowledgeSources models name outputMode? retrievalInstructions? retrievalReasoningEffort?

Properties

OptionalanswerInstructions

answerInstructions?: string

Instructions considered by the knowledge base when generating answers.

Optionaldescription

description?: string

The description of the knowledge base.

OptionalencryptionKey

encryptionKey?: SearchResourceEncryptionKey

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.

Optionaletag

etag?: string

The ETag of the knowledge base.

knowledgeSources

knowledgeSources: KnowledgeSourceReference[]

models

models: KnowledgeBaseAzureOpenAIModel[]

Contains configuration options on how to connect to AI models.

name

name: string

The name of the knowledge base.

OptionaloutputMode

outputMode?: string

OptionalretrievalInstructions

retrievalInstructions?: string

Instructions considered by the knowledge base when developing query plan.

OptionalretrievalReasoningEffort

retrievalReasoningEffort?: KnowledgeRetrievalReasoningEffort

Settings

Member Visibility