SearchModelFactory.KnowledgeBase Method
Definition
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.
public static Azure.Search.Documents.Indexes.Models.KnowledgeBase KnowledgeBase(string name = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.KnowledgeSourceReference> knowledgeSources = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.KnowledgeBaseModel> models = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalReasoningEffort retrievalReasoningEffort = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalOutputMode? outputMode = default, string eTag = default, Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey encryptionKey = default, string description = default, string retrievalInstructions = default, string answerInstructions = default, System.Collections.Generic.IDictionary<string,BinaryData> serializedAdditionalRawData = default);static member KnowledgeBase : string * seq<Azure.Search.Documents.Indexes.Models.KnowledgeSourceReference> * seq<Azure.Search.Documents.Indexes.Models.KnowledgeBaseModel> * Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalReasoningEffort * Nullable<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalOutputMode> * string * Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey * string * string * string * System.Collections.Generic.IDictionary<string, BinaryData> -> Azure.Search.Documents.Indexes.Models.KnowledgeBasePublic Shared Function KnowledgeBase (Optional name As String = Nothing, Optional knowledgeSources As IEnumerable(Of KnowledgeSourceReference) = Nothing, Optional models As IEnumerable(Of KnowledgeBaseModel) = Nothing, Optional retrievalReasoningEffort As KnowledgeRetrievalReasoningEffort = Nothing, Optional outputMode As Nullable(Of KnowledgeRetrievalOutputMode) = Nothing, Optional eTag As String = Nothing, Optional encryptionKey As SearchResourceEncryptionKey = Nothing, Optional description As String = Nothing, Optional retrievalInstructions As String = Nothing, Optional answerInstructions As String = Nothing, Optional serializedAdditionalRawData As IDictionary(Of String, BinaryData) = Nothing) As KnowledgeBaseParameters
- name
- String
The name of the knowledge knowledge base.
- knowledgeSources
- IEnumerable<KnowledgeSourceReference>
- models
- IEnumerable<KnowledgeBaseModel>
Contains configuration options on how to connect to AI models. Please note KnowledgeBaseModel 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 KnowledgeBaseAzureOpenAIModel.
- retrievalReasoningEffort
- KnowledgeRetrievalReasoningEffort
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.
- outputMode
- Nullable<KnowledgeRetrievalOutputMode>
The output configuration for this retrieval.
- eTag
- String
The ETag of the knowledge base.
- 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.
- description
- String
The description of the knowledge base.
- retrievalInstructions
- String
Instructions considered by the knowledge knowledge base when developing query plan.
- answerInstructions
- String
Instructions considered by the knowledge knowledge base when generating answers.
- serializedAdditionalRawData
- IDictionary<String,BinaryData>
Keeps track of any properties unknown to the library.
