Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
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 v12.1.0-beta.1
- Source:
- KnowledgeBase.cs
- Source:
- KnowledgeBase.cs
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
-
KnowledgeBase
- Implements
Constructors
| Name | Description |
|---|---|
| KnowledgeBase(String, IEnumerable<KnowledgeSourceReference>) |
Initializes a new instance of KnowledgeBase. |
Properties
| Name | Description |
|---|---|
| AnswerInstructions |
Instructions considered by the knowledge base when generating answers. |
| CorsOptions |
Options to control Cross-Origin Resource Sharing (CORS) for the knowledge base. |
| 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 mode for the knowledge base. |
| RetrievalInstructions |
Instructions considered by the knowledge base when developing query plan. |
| RetrievalReasoningEffort |
The retrieval reasoning effort configuration. |
Methods
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
Azure SDK for .NET
Feedback
Was this page helpful?