KnowledgeSourceIngestionParameters Class

Definition

Consolidates all general ingestion settings for knowledge sources.

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

Constructors

Name Description
KnowledgeSourceIngestionParameters()

Initializes a new instance of KnowledgeSourceIngestionParameters.

Properties

Name Description
AiServices

Optional AI Services configuration for content processing.

AssetStore

Optional asset store configuration for storing extracted assets such as images.

ChatCompletionModel

Optional chat completion model for image verbalization or context extraction.

ContentExtractionMode

Optional content extraction mode. Default is 'minimal'.

DisableImageVerbalization

Indicates whether image verbalization should be disabled. Default is false.

EmbeddingModel

Optional vectorizer configuration for vectorizing content.

FreshnessPolicy

Optional freshness policy for biasing retrieval toward newer documents.

Identity

An explicit identity to use for this knowledge source.

IngestionPermissionOptions

Optional list of permission types to ingest together with document content. If specified, it will set the indexer permission options for the data source.

IngestionSchedule

Optional schedule for data ingestion.

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<KnowledgeSourceIngestionParameters>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<KnowledgeSourceIngestionParameters>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<KnowledgeSourceIngestionParameters>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<KnowledgeSourceIngestionParameters>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<KnowledgeSourceIngestionParameters>.Write(ModelReaderWriterOptions)

Applies to