IndexingParameters | @azure/search

Represents parameters for indexer execution.

Hierarchy

IndexingParameters

Index

Properties

Optional base64EncodeKeys

base64EncodeKeys: undefined | false | true

Whether indexer will base64-encode all values that are inserted into key field of the target index. This is needed if keys can contain characters that are invalid in keys (such as dot '.'). Default is false. Default value: false.

Optional batchSize

batchSize: undefined | number

The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type.

Optional configuration

configuration: undefined | {}

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

Optional maxFailedItems

maxFailedItems: undefined | number

The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. Default value: 0.

Optional maxFailedItemsPerBatch

maxFailedItemsPerBatch: undefined | number

The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. Default value: 0.