KnowledgeBase Class

Definition

Namespace:
Azure.Search.Documents.Indexes.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Package:
Azure.Search.Documents v11.8.0-beta.1
Source:
KnowledgeBase.cs
Source:
KnowledgeBase.cs

Represents a knowledge base definition.

public class KnowledgeBase : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.KnowledgeBase>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.KnowledgeBase>
type KnowledgeBase = class
    interface IJsonModel<KnowledgeBase>
    interface IPersistableModel<KnowledgeBase>
Public Class KnowledgeBase
Implements IJsonModel(Of KnowledgeBase), IPersistableModel(Of KnowledgeBase)
Inheritance
Object
KnowledgeBase
Implements
IJsonModel<KnowledgeBase> IPersistableModel<KnowledgeBase> IPersistableModel<T>

Constructors

Name Description
KnowledgeBase(String, IEnumerable<KnowledgeSourceReference>)

Initializes a new instance of KnowledgeBase.

Properties

Name Description
AnswerInstructions

Instructions considered by the knowledge 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.
ETag

The ETag of the knowledge base.
KnowledgeSources

Knowledge sources referenced by this knowledge base.
Models

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

The name of the knowledge base.
OutputMode

The output configuration for this retrieval.
RetrievalInstructions

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

Gets or sets the retrieval reasoning effort Please note KnowledgeRetrievalReasoningEffort is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include KnowledgeRetrievalLowReasoningEffort, KnowledgeRetrievalMediumReasoningEffort and KnowledgeRetrievalMinimalReasoningEffort.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Operators

Name Description
Explicit(Response to KnowledgeBase)
Implicit(KnowledgeBase to RequestContent)

Explicit Interface Implementations

Name Description
IJsonModel<KnowledgeBase>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<KnowledgeBase>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<KnowledgeBase>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<KnowledgeBase>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<KnowledgeBase>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to