SearchModelFactory.WebKnowledgeSourceParams 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 web knowledge source.

public static Azure.Search.Documents.KnowledgeBases.Models.WebKnowledgeSourceParams WebKnowledgeSourceParams(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 language = default, string market = default, int? count = default, string freshness = default);

static member WebKnowledgeSourceParams : string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<single> * Nullable<int> * Nullable<bool> * string * string * Nullable<int> * string -> Azure.Search.Documents.KnowledgeBases.Models.WebKnowledgeSourceParams

Public Shared Function WebKnowledgeSourceParams (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 language As String = Nothing, Optional market As String = Nothing, Optional count As Nullable(Of Integer) = Nothing, Optional freshness As String = Nothing) As WebKnowledgeSourceParams

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.

language

String

The language of the web results.

market

String

The market of the web results.

count

Nullable<Int32>

The number of web results to return.

freshness

String

The freshness of web results.

Returns

WebKnowledgeSourceParams

A new WebKnowledgeSourceParams instance for mocking.