SearchModelFactory.KnowledgeBase Method

Definition

Namespace:

Azure.Search.Documents.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.1.0-beta.1

Source:

SearchModelFactory.cs

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, string retrievalInstructions = default, string answerInstructions = default, Azure.Search.Documents.Indexes.Models.CorsOptions corsOptions = 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 * string * string * Azure.Search.Documents.Indexes.Models.CorsOptions -> Azure.Search.Documents.Indexes.Models.KnowledgeBase

Public 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 retrievalInstructions As String = Nothing, Optional answerInstructions As String = Nothing, Optional corsOptions As CorsOptions = Nothing) As KnowledgeBase

Parameters

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.

eTag

Nullable<ETag>

The ETag of 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.

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.

Returns

KnowledgeBase

A new KnowledgeBase instance for mocking.