KnowledgeSourceIngestionParameters interface

Package:

@azure/search-documents

Consolidates all general ingestion settings for knowledge sources.

Properties

aiServices	Optional AI Services configuration for content processing.
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.
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.

Property Details

aiServices

Optional AI Services configuration for content processing.

aiServices?: AIServices

Property Value

AIServices

chatCompletionModel

Optional chat completion model for image verbalization or context extraction.

chatCompletionModel?: KnowledgeBaseAzureOpenAIModel

Property Value

KnowledgeBaseAzureOpenAIModel

contentExtractionMode

Optional content extraction mode. Default is 'minimal'.

contentExtractionMode?: string

Property Value

string

disableImageVerbalization

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

disableImageVerbalization?: boolean

Property Value

boolean

embeddingModel

Optional vectorizer configuration for vectorizing content.

embeddingModel?: KnowledgeSourceAzureOpenAIVectorizer

Property Value

KnowledgeSourceAzureOpenAIVectorizer

identity

An explicit identity to use for this knowledge source.

identity?: SearchIndexerDataIdentity

Property Value

SearchIndexerDataIdentity

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.

ingestionPermissionOptions?: string[]

Property Value

string[]

ingestionSchedule

Optional schedule for data ingestion.

ingestionSchedule?: IndexingSchedule

Property Value

IndexingSchedule