SearchModelFactory.IndexingParametersConfiguration Method

Definition

Namespace:: Azure.Search.Documents.Models

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v12.0.0

Source:: SearchModelFactory.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.

public static Azure.Search.Documents.Indexes.Models.IndexingParametersConfiguration IndexingParametersConfiguration(Azure.Search.Documents.Indexes.Models.BlobIndexerParsingMode? parsingMode = default, string excludedFileNameExtensions = default, string indexedFileNameExtensions = default, bool? failOnUnsupportedContentType = default, bool? failOnUnprocessableDocument = default, bool? indexStorageMetadataOnlyForOversizedDocuments = default, string delimitedTextHeaders = default, string delimitedTextDelimiter = default, bool? firstLineContainsHeaders = default, Azure.Search.Documents.Indexes.Models.MarkdownParsingSubmode? markdownParsingSubmode = default, Azure.Search.Documents.Indexes.Models.MarkdownHeaderDepth? markdownHeaderDepth = default, string documentRoot = default, Azure.Search.Documents.Indexes.Models.BlobIndexerDataToExtract? dataToExtract = default, Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction? imageAction = default, bool? allowSkillsetToReadFileData = default, Azure.Search.Documents.Indexes.Models.BlobIndexerPdfTextRotationAlgorithm? pdfTextRotationAlgorithm = default, Azure.Search.Documents.Indexes.Models.IndexerExecutionEnvironment? executionEnvironment = default, string queryTimeout = default, System.Collections.Generic.IDictionary<string,BinaryData> additionalProperties = default);

static member IndexingParametersConfiguration : Nullable<Azure.Search.Documents.Indexes.Models.BlobIndexerParsingMode> * string * string * Nullable<bool> * Nullable<bool> * Nullable<bool> * string * string * Nullable<bool> * Nullable<Azure.Search.Documents.Indexes.Models.MarkdownParsingSubmode> * Nullable<Azure.Search.Documents.Indexes.Models.MarkdownHeaderDepth> * string * Nullable<Azure.Search.Documents.Indexes.Models.BlobIndexerDataToExtract> * Nullable<Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction> * Nullable<bool> * Nullable<Azure.Search.Documents.Indexes.Models.BlobIndexerPdfTextRotationAlgorithm> * Nullable<Azure.Search.Documents.Indexes.Models.IndexerExecutionEnvironment> * string * System.Collections.Generic.IDictionary<string, BinaryData> -> Azure.Search.Documents.Indexes.Models.IndexingParametersConfiguration

Public Shared Function IndexingParametersConfiguration (Optional parsingMode As Nullable(Of BlobIndexerParsingMode) = Nothing, Optional excludedFileNameExtensions As String = Nothing, Optional indexedFileNameExtensions As String = Nothing, Optional failOnUnsupportedContentType As Nullable(Of Boolean) = Nothing, Optional failOnUnprocessableDocument As Nullable(Of Boolean) = Nothing, Optional indexStorageMetadataOnlyForOversizedDocuments As Nullable(Of Boolean) = Nothing, Optional delimitedTextHeaders As String = Nothing, Optional delimitedTextDelimiter As String = Nothing, Optional firstLineContainsHeaders As Nullable(Of Boolean) = Nothing, Optional markdownParsingSubmode As Nullable(Of MarkdownParsingSubmode) = Nothing, Optional markdownHeaderDepth As Nullable(Of MarkdownHeaderDepth) = Nothing, Optional documentRoot As String = Nothing, Optional dataToExtract As Nullable(Of BlobIndexerDataToExtract) = Nothing, Optional imageAction As Nullable(Of BlobIndexerImageAction) = Nothing, Optional allowSkillsetToReadFileData As Nullable(Of Boolean) = Nothing, Optional pdfTextRotationAlgorithm As Nullable(Of BlobIndexerPdfTextRotationAlgorithm) = Nothing, Optional executionEnvironment As Nullable(Of IndexerExecutionEnvironment) = Nothing, Optional queryTimeout As String = Nothing, Optional additionalProperties As IDictionary(Of String, BinaryData) = Nothing) As IndexingParametersConfiguration

Parameters

parsingMode: Nullable<BlobIndexerParsingMode>

Represents the parsing mode for indexing from an Azure blob data source.

excludedFileNameExtensions: String

Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude ".png, .mp4" to skip over those files during indexing.

indexedFileNameExtensions: String

Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files ".docx, .pptx, .msg" to specifically include those file types.

failOnUnsupportedContentType: Nullable<Boolean>

For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance.

failOnUnprocessableDocument: Nullable<Boolean>

For Azure blobs, set to false if you want to continue indexing if a document fails indexing.

indexStorageMetadataOnlyForOversizedDocuments: Nullable<Boolean>

For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://learn.microsoft.com/azure/search/search-limits-quotas-capacity.

delimitedTextHeaders: String

For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index.

delimitedTextDelimiter: String

For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, "|").

firstLineContainsHeaders: Nullable<Boolean>

For CSV blobs, indicates that the first (non-blank) line of each blob contains headers.

markdownParsingSubmode: Nullable<MarkdownParsingSubmode>

Specifies the submode that will determine whether a markdown file will be parsed into exactly one search document or multiple search documents. Default is oneToMany.

markdownHeaderDepth: Nullable<MarkdownHeaderDepth>

Specifies the max header depth that will be considered while grouping markdown content. Default is h6.

documentRoot: String

For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property.

dataToExtract: Nullable<BlobIndexerDataToExtract>

Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when "imageAction" is set to a value other than "none". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs.

imageAction: Nullable<BlobIndexerImageAction>

Determines how to process embedded images and image files in Azure blob storage. Setting the "imageAction" configuration to any value other than "none" requires that a skillset also be attached to that indexer.

allowSkillsetToReadFileData: Nullable<Boolean>

If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill.

pdfTextRotationAlgorithm: Nullable<BlobIndexerPdfTextRotationAlgorithm>

Determines algorithm for text extraction from PDF files in Azure blob storage.

executionEnvironment: Nullable<IndexerExecutionEnvironment>

Specifies the environment in which the indexer should execute.

queryTimeout: String

Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format "hh:mm:ss".

additionalProperties: IDictionary<String,BinaryData>

Returns

IndexingParametersConfiguration

A new IndexingParametersConfiguration instance for mocking.

Applies to

Feedback

Was this page helpful?