KnowledgeSource Class

Definition

Represents a knowledge source definition. Please note this is the abstract base class. The derived classes available for instantiation are: SearchIndexKnowledgeSource, AzureBlobKnowledgeSource, IndexedOneLakeKnowledgeSource, and WebKnowledgeSource.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Indexes.Models.UnknownKnowledgeSource))]
public abstract class KnowledgeSource : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.KnowledgeSource>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.KnowledgeSource>
[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Models.UnknownKnowledgeSource))]
public abstract class KnowledgeSource : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.KnowledgeSource>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.KnowledgeSource>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Indexes.Models.UnknownKnowledgeSource))>]
type KnowledgeSource = class
    interface IJsonModel<KnowledgeSource>
    interface IPersistableModel<KnowledgeSource>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Models.UnknownKnowledgeSource))>]
type KnowledgeSource = class
    interface IJsonModel<KnowledgeSource>
    interface IPersistableModel<KnowledgeSource>
Public MustInherit Class KnowledgeSource
Implements IJsonModel(Of KnowledgeSource), IPersistableModel(Of KnowledgeSource)
Inheritance
KnowledgeSource
Derived
Attributes
Implements

Constructors

Name Description
KnowledgeSource(String)

Initializes a new instance of KnowledgeSource.

Properties

Name Description
Description

Optional user-defined description.

EncryptionKey

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.

ETag

The ETag of the knowledge source.

Name

The name of the knowledge source.

Methods

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

Operators

Name Description
Explicit(Response to KnowledgeSource)
Implicit(KnowledgeSource to RequestContent)

Explicit Interface Implementations

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

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

IJsonModel<KnowledgeSource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<KnowledgeSource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<KnowledgeSource>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<KnowledgeSource>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to