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.
Represents a knowledge base definition.
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, Azure.ETag? eTag = default, Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey encryptionKey = default, string description = default, System.Collections.Generic.IDictionary<string,string> tags = default, string retrievalInstructions = default, string answerInstructions = default, Azure.Search.Documents.Indexes.Models.CorsOptions corsOptions = default, Azure.Search.Documents.Indexes.Models.KnowledgeBaseRetrieveDefaults retrieveDefaults = 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> * Nullable<Azure.ETag> * Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey * string * System.Collections.Generic.IDictionary<string, string> * string * string * Azure.Search.Documents.Indexes.Models.CorsOptions * Azure.Search.Documents.Indexes.Models.KnowledgeBaseRetrieveDefaults -> 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 Nullable(Of ETag) = Nothing, Optional encryptionKey As SearchResourceEncryptionKey = Nothing, Optional description As String = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional retrievalInstructions As String = Nothing, Optional answerInstructions As String = Nothing, Optional corsOptions As CorsOptions = Nothing, Optional retrieveDefaults As KnowledgeBaseRetrieveDefaults = Nothing) As KnowledgeBaseParameters
- name
- String
The name of the knowledge base.
- knowledgeSources
- IEnumerable<KnowledgeSourceReference>
Knowledge sources referenced by this knowledge base.
- models
- IEnumerable<KnowledgeBaseModel>
Contains configuration options on how to connect to AI models.
- retrievalReasoningEffort
- KnowledgeRetrievalReasoningEffort
The retrieval reasoning effort configuration.
- outputMode
- Nullable<KnowledgeRetrievalOutputMode>
The output mode for the knowledge base.
- encryptionKey
- SearchResourceEncryptionKey
A description of an encryption key that you create in Azure Key Vault.
- description
- String
The description of the knowledge base.
- tags
- IDictionary<String,String>
User-defined key-value pairs for categorizing the knowledge base and attributing its usage and costs.
- retrievalInstructions
- String
Instructions considered by the knowledge base when developing query plan.
- answerInstructions
- String
Instructions considered by the knowledge base when generating answers.
- corsOptions
- CorsOptions
Options to control Cross-Origin Resource Sharing (CORS) for the knowledge base.
- retrieveDefaults
- KnowledgeBaseRetrieveDefaults
Persisted request-wide retrieve defaults for this knowledge base. These values apply to retrieve requests that omit the corresponding fields; request-time values take precedence when present.
Returns
A new KnowledgeBase instance for mocking.
