SearchModelFactory.KnowledgeSourceParams Method

Definition

Base type for knowledge source runtime parameters. Please note this is the abstract base class. The derived classes available for instantiation are: SearchIndexKnowledgeSourceParams, AzureBlobKnowledgeSourceParams, IndexedOneLakeKnowledgeSourceParams, and WebKnowledgeSourceParams.

public static Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceParams KnowledgeSourceParams(string knowledgeSourceName = default, bool? includeReferences = default, bool? includeReferenceSourceData = default, float? rerankerThreshold = default, string kind = default);
static member KnowledgeSourceParams : string * Nullable<bool> * Nullable<bool> * Nullable<single> * string -> Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceParams
Public Shared Function KnowledgeSourceParams (Optional knowledgeSourceName As String = Nothing, Optional includeReferences As Nullable(Of Boolean) = Nothing, Optional includeReferenceSourceData As Nullable(Of Boolean) = Nothing, Optional rerankerThreshold As Nullable(Of Single) = Nothing, Optional kind As String = Nothing) As KnowledgeSourceParams

Parameters

knowledgeSourceName
String

The name of the index the params apply to.

includeReferences
Nullable<Boolean>

Indicates whether references should be included for data retrieved from this source.

includeReferenceSourceData
Nullable<Boolean>

Indicates whether references should include the structured data obtained during retrieval in their payload.

rerankerThreshold
Nullable<Single>

The reranker threshold all retrieved documents must meet to be included in the response.

kind
String

The type of the knowledge source.

Returns

A new KnowledgeSourceParams instance for mocking.

Applies to