Lingua

SearchModelFactory.WorkIQKnowledgeSource Method

Definition

Configuration for WorkIQ knowledge source.

public static Azure.Search.Documents.Indexes.Models.WorkIQKnowledgeSource WorkIQKnowledgeSource(string name = default, string description = default, Azure.Search.Documents.Indexes.Models.KnowledgeSourceResultsProcessing? resultsProcessing = default, Azure.ETag? eTag = default, Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey encryptionKey = default, Azure.Search.Documents.Indexes.Models.WorkIQKnowledgeSourceParameters workIQParameters = default);
static member WorkIQKnowledgeSource : string * string * Nullable<Azure.Search.Documents.Indexes.Models.KnowledgeSourceResultsProcessing> * Nullable<Azure.ETag> * Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey * Azure.Search.Documents.Indexes.Models.WorkIQKnowledgeSourceParameters -> Azure.Search.Documents.Indexes.Models.WorkIQKnowledgeSource
Public Shared Function WorkIQKnowledgeSource (Optional name As String = Nothing, Optional description As String = Nothing, Optional resultsProcessing As Nullable(Of KnowledgeSourceResultsProcessing) = Nothing, Optional eTag As Nullable(Of ETag) = Nothing, Optional encryptionKey As SearchResourceEncryptionKey = Nothing, Optional workIQParameters As WorkIQKnowledgeSourceParameters = Nothing) As WorkIQKnowledgeSource

Parameters

name
String

The name of the knowledge source.

description
String

Optional user-defined description.

resultsProcessing
Nullable<KnowledgeSourceResultsProcessing>

Controls whether results from this knowledge source are reranked before they are included in the final result set. Defaults to 'rerank' when not specified.

eTag
Nullable<ETag>

The ETag of the knowledge source.

encryptionKey
SearchResourceEncryptionKey

A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your knowledge source definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your knowledge source definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your knowledge source definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.

workIQParameters
WorkIQKnowledgeSourceParameters

The parameters for the WorkIQ knowledge source, including the customer-owned Entra app configuration used for on-behalf-of authentication.

Returns

A new WorkIQKnowledgeSource instance for mocking.

Applies to