SearchModelFactory.SearchIndexKnowledgeSourceParams Method

Definition

Specifies runtime parameters for a search index knowledge source.

public static Azure.Search.Documents.KnowledgeBases.Models.SearchIndexKnowledgeSourceParams SearchIndexKnowledgeSourceParams(string knowledgeSourceName = default, bool? includeReferences = default, bool? includeReferenceSourceData = default, float? rerankerThreshold = default, string filterAddOn = default);
static member SearchIndexKnowledgeSourceParams : string * Nullable<bool> * Nullable<bool> * Nullable<single> * string -> Azure.Search.Documents.KnowledgeBases.Models.SearchIndexKnowledgeSourceParams
Public Shared Function SearchIndexKnowledgeSourceParams (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 filterAddOn As String = Nothing) As SearchIndexKnowledgeSourceParams

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.

filterAddOn
String

A filter condition applied to the index (e.g., 'State eq VA').

Returns

A new SearchIndexKnowledgeSourceParams instance for mocking.

Applies to