SearchModelFactory.SearchIndexKnowledgeSourceParams Method

Definition

Namespace:

Azure.Search.Documents.Models

Assembly:

Azure.Search.Documents.dll

Package:

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

Source:

SearchModelFactory.cs

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, bool? alwaysQuerySource = default, bool? failOnError = default, float? rerankerThreshold = default, int? maxOutputDocuments = default, bool? enableImageServing = default, string filterAddOn = default);

static member SearchIndexKnowledgeSourceParams : string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<single> * Nullable<int> * Nullable<bool> * 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 alwaysQuerySource As Nullable(Of Boolean) = Nothing, Optional failOnError As Nullable(Of Boolean) = Nothing, Optional rerankerThreshold As Nullable(Of Single) = Nothing, Optional maxOutputDocuments As Nullable(Of Integer) = Nothing, Optional enableImageServing As Nullable(Of Boolean) = 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.

alwaysQuerySource

Nullable<Boolean>

Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.

failOnError

Nullable<Boolean>

Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.

rerankerThreshold

Nullable<Single>

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

maxOutputDocuments

Nullable<Int32>

Limits the maximum number of documents returned from this knowledge source.

enableImageServing

Nullable<Boolean>

Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.

filterAddOn

String

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

Returns

SearchIndexKnowledgeSourceParams

A new SearchIndexKnowledgeSourceParams instance for mocking.