SearchModelFactory.KnowledgeSourceIngestionParameters Method

Definition

Namespace:

Azure.Search.Documents.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.1.0-beta.1

Source:

SearchModelFactory.cs

Consolidates all general ingestion settings for knowledge sources.

public static Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceIngestionParameters KnowledgeSourceIngestionParameters(Azure.Search.Documents.Indexes.Models.SearchIndexerDataIdentity identity = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceVectorizer embeddingModel = default, Azure.Search.Documents.Indexes.Models.KnowledgeBaseModel chatCompletionModel = default, bool? disableImageVerbalization = default, Azure.Search.Documents.Indexes.Models.IndexingSchedule ingestionSchedule = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.KnowledgeSourceIngestionPermissionOption> ingestionPermissionOptions = default, Azure.Search.Documents.Indexes.Models.KnowledgeSourceContentExtractionMode? contentExtractionMode = default, Azure.Search.Documents.KnowledgeBases.Models.AIServices aiServices = default, Azure.Search.Documents.KnowledgeBases.Models.AssetStore assetStore = default, Azure.Search.Documents.KnowledgeBases.Models.FreshnessPolicy freshnessPolicy = default);

static member KnowledgeSourceIngestionParameters : Azure.Search.Documents.Indexes.Models.SearchIndexerDataIdentity * Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceVectorizer * Azure.Search.Documents.Indexes.Models.KnowledgeBaseModel * Nullable<bool> * Azure.Search.Documents.Indexes.Models.IndexingSchedule * seq<Azure.Search.Documents.Indexes.Models.KnowledgeSourceIngestionPermissionOption> * Nullable<Azure.Search.Documents.Indexes.Models.KnowledgeSourceContentExtractionMode> * Azure.Search.Documents.KnowledgeBases.Models.AIServices * Azure.Search.Documents.KnowledgeBases.Models.AssetStore * Azure.Search.Documents.KnowledgeBases.Models.FreshnessPolicy -> Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceIngestionParameters

Public Shared Function KnowledgeSourceIngestionParameters (Optional identity As SearchIndexerDataIdentity = Nothing, Optional embeddingModel As KnowledgeSourceVectorizer = Nothing, Optional chatCompletionModel As KnowledgeBaseModel = Nothing, Optional disableImageVerbalization As Nullable(Of Boolean) = Nothing, Optional ingestionSchedule As IndexingSchedule = Nothing, Optional ingestionPermissionOptions As IEnumerable(Of KnowledgeSourceIngestionPermissionOption) = Nothing, Optional contentExtractionMode As Nullable(Of KnowledgeSourceContentExtractionMode) = Nothing, Optional aiServices As AIServices = Nothing, Optional assetStore As AssetStore = Nothing, Optional freshnessPolicy As FreshnessPolicy = Nothing) As KnowledgeSourceIngestionParameters

Parameters

identity

SearchIndexerDataIdentity

An explicit identity to use for this knowledge source.

embeddingModel

KnowledgeSourceVectorizer

Optional vectorizer configuration for vectorizing content.

chatCompletionModel

KnowledgeBaseModel

Optional chat completion model for image verbalization or context extraction.

disableImageVerbalization

Nullable<Boolean>

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

ingestionSchedule

IndexingSchedule

Optional schedule for data ingestion.

ingestionPermissionOptions

IEnumerable<KnowledgeSourceIngestionPermissionOption>

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

contentExtractionMode

Nullable<KnowledgeSourceContentExtractionMode>

Optional content extraction mode. Default is 'minimal'.

aiServices

AIServices

Optional AI Services configuration for content processing.

assetStore

AssetStore

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

freshnessPolicy

FreshnessPolicy

Optional freshness policy for biasing retrieval toward newer documents.

Returns

KnowledgeSourceIngestionParameters

A new KnowledgeSourceIngestionParameters instance for mocking.