WorkIQKnowledgeSourceParams Class

Definition

Specifies runtime parameters for a WorkIQ knowledge source.

public class WorkIQKnowledgeSourceParams : Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceParams, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.WorkIQKnowledgeSourceParams>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.WorkIQKnowledgeSourceParams>
type WorkIQKnowledgeSourceParams = class
    inherit KnowledgeSourceParams
    interface IJsonModel<WorkIQKnowledgeSourceParams>
    interface IPersistableModel<WorkIQKnowledgeSourceParams>
Public Class WorkIQKnowledgeSourceParams
Inherits KnowledgeSourceParams
Implements IJsonModel(Of WorkIQKnowledgeSourceParams), IPersistableModel(Of WorkIQKnowledgeSourceParams)
Inheritance
WorkIQKnowledgeSourceParams
Implements

Constructors

Name Description
WorkIQKnowledgeSourceParams(String)

Initializes a new instance of WorkIQKnowledgeSourceParams.

Properties

Name Description
AlwaysQuerySource

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

(Inherited from KnowledgeSourceParams)
EnableImageServing

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.

(Inherited from KnowledgeSourceParams)
FailOnError

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

(Inherited from KnowledgeSourceParams)
IncludeReferences

Indicates whether references should be included for data retrieved from this source.

(Inherited from KnowledgeSourceParams)
IncludeReferenceSourceData

Indicates whether references should include the structured data obtained during retrieval in their payload.

(Inherited from KnowledgeSourceParams)
KnowledgeSourceName

The name of the index the params apply to.

(Inherited from KnowledgeSourceParams)
MaxOutputDocuments

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

(Inherited from KnowledgeSourceParams)
RerankerThreshold

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

(Inherited from KnowledgeSourceParams)

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<KnowledgeSourceParams>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from KnowledgeSourceParams)
IJsonModel<KnowledgeSourceParams>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from KnowledgeSourceParams)
IJsonModel<WorkIQKnowledgeSourceParams>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<WorkIQKnowledgeSourceParams>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<KnowledgeSourceParams>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from KnowledgeSourceParams)
IPersistableModel<KnowledgeSourceParams>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from KnowledgeSourceParams)
IPersistableModel<KnowledgeSourceParams>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from KnowledgeSourceParams)
IPersistableModel<WorkIQKnowledgeSourceParams>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<WorkIQKnowledgeSourceParams>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<WorkIQKnowledgeSourceParams>.Write(ModelReaderWriterOptions)

Applies to