Share via


IndexingParametersConfiguration Class

Definition

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 class IndexingParametersConfiguration : System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<string,object>>, System.Collections.Generic.IDictionary<string,object>, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object>>
type IndexingParametersConfiguration = class
    interface IDictionary<string, obj>
    interface ICollection<KeyValuePair<string, obj>>
    interface seq<KeyValuePair<string, obj>>
    interface IEnumerable
Public Class IndexingParametersConfiguration
Implements ICollection(Of KeyValuePair(Of String, Object)), IDictionary(Of String, Object), IEnumerable(Of KeyValuePair(Of String, Object))
Inheritance
IndexingParametersConfiguration
Implements

Constructors

IndexingParametersConfiguration()

Initializes a new instance of IndexingParametersConfiguration.

Properties

AllowSkillsetToReadFileData

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.

DataToExtract

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.

DelimitedTextDelimiter

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

DelimitedTextHeaders

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

DocumentRoot

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

ExcludedFileNameExtensions

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.

ExecutionEnvironment

Specifies the environment in which the indexer should execute.

FailOnUnprocessableDocument

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

FailOnUnsupportedContentType

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.

FirstLineContainsHeaders

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

ImageAction

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.

IndexedFileNameExtensions

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.

IndexStorageMetadataOnlyForOversizedDocuments

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.

Item[String]

Gets or sets the element with the specified key.

Keys

Gets an ICollection<T> containing the keys of the IDictionary<TKey,TValue>.

ParsingMode

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

PdfTextRotationAlgorithm

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

QueryTimeout

Increases the timeout beyond the 5-minute default for Azure SQL database data sources.

Values

Gets an ICollection<T> containing the values in the IDictionary<TKey,TValue>.

Methods

Add(String, Object)

Adds an element with the provided key and value to the IDictionary<TKey,TValue>.

ContainsKey(String)

Determines whether the IDictionary<TKey,TValue> contains an element with the specified key.

GetEnumerator()

Returns an enumerator that iterates through the collection.

Remove(String)

Removes the element with the specified key from the IDictionary<TKey,TValue>.

TryGetValue(String, Object)

Gets the value associated with the specified key.

Explicit Interface Implementations

ICollection<KeyValuePair<String,Object>>.Add(KeyValuePair<String,Object>)

Adds an item to the ICollection<T>.

ICollection<KeyValuePair<String,Object>>.Clear()

Removes all items from the ICollection<T>.

ICollection<KeyValuePair<String,Object>>.Contains(KeyValuePair<String,Object>)

Determines whether the ICollection<T> contains a specific value.

ICollection<KeyValuePair<String,Object>>.CopyTo(KeyValuePair<String,Object>[], Int32)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

ICollection<KeyValuePair<String,Object>>.Count

Gets the number of elements contained in the ICollection<T>.

ICollection<KeyValuePair<String,Object>>.IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

ICollection<KeyValuePair<String,Object>>.Remove(KeyValuePair<String,Object>)

Removes the first occurrence of a specific object from the ICollection<T>.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

Extension Methods

GetValueOrAdd<TKey,TValue>(IDictionary<TKey,TValue>, TKey, Func<TKey,TValue>)

Gets or adds the value associated with specified key.

GetValueOrDefault<TKey,TValue>(IDictionary<TKey,TValue>, TKey, TValue)

Gets the value associated with specified key.

AsFormattedString<TKey,TValue>(IDictionary<TKey,TValue>)

Applies to