Lingua

SearchModelFactory.FileKnowledgeSourceParams Method

Definition

Namespace:
Azure.Search.Documents.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.1.0-beta.2
Source:
SearchModelFactory.cs

Specifies runtime parameters for a File knowledge source.

public static Azure.Search.Documents.KnowledgeBases.Models.FileKnowledgeSourceParams FileKnowledgeSourceParams(string knowledgeSourceName = default, bool? includeReferences = default, bool? includeReferenceSourceData = default, bool? alwaysQuerySource = default, bool? neverQuerySource = default, bool? failOnError = default, float? rerankerThreshold = default, Azure.Search.Documents.Indexes.Models.KnowledgeSourceResultsProcessing? resultsProcessing = default, int? maxOutputDocuments = default, bool? enableImageServing = default, Azure.Search.Documents.Indexes.Models.SearchIndexKnowledgeSourceQueryHints queryHintOverrides = default);
static member FileKnowledgeSourceParams : string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<single> * Nullable<Azure.Search.Documents.Indexes.Models.KnowledgeSourceResultsProcessing> * Nullable<int> * Nullable<bool> * Azure.Search.Documents.Indexes.Models.SearchIndexKnowledgeSourceQueryHints -> Azure.Search.Documents.KnowledgeBases.Models.FileKnowledgeSourceParams
Public Shared Function FileKnowledgeSourceParams (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 neverQuerySource As Nullable(Of Boolean) = Nothing, Optional failOnError As Nullable(Of Boolean) = Nothing, Optional rerankerThreshold As Nullable(Of Single) = Nothing, Optional resultsProcessing As Nullable(Of KnowledgeSourceResultsProcessing) = Nothing, Optional maxOutputDocuments As Nullable(Of Integer) = Nothing, Optional enableImageServing As Nullable(Of Boolean) = Nothing, Optional queryHintOverrides As SearchIndexKnowledgeSourceQueryHints = Nothing) As FileKnowledgeSourceParams

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.

neverQuerySource
Nullable<Boolean>

Indicates that this knowledge source should be excluded from the request's candidate set and never queried at retrieval time. The exclusion is request-local and does not modify knowledge base membership. Cannot be combined with alwaysQuerySource on the same knowledge source.

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.

resultsProcessing
Nullable<KnowledgeSourceResultsProcessing>

Overrides the knowledge source's stored resultsProcessing for this retrieve call only. When omitted, the stored knowledge source value applies.

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.

queryHintOverrides
SearchIndexKnowledgeSourceQueryHints

Hints that guide query planning toward useful filters and boosts. If specified, this object replaces the complete set of query hints configured on the knowledge source.

Returns

FileKnowledgeSourceParams

A new FileKnowledgeSourceParams instance for mocking.

Applies to