Package version:

Interface IndexingParametersConfiguration

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

interface IndexingParametersConfiguration {
    allowSkillsetToReadFileData?: boolean;
    dataToExtract?: "storageMetadata" | "allMetadata" | "contentAndMetadata";
    delimitedTextDelimiter?: string;
    delimitedTextHeaders?: string;
    documentRoot?: string;
    excludedFileNameExtensions?: string;
    executionEnvironment?: "standard" | "private";
    failOnUnprocessableDocument?: boolean;
    failOnUnsupportedContentType?: boolean;
    firstLineContainsHeaders?: boolean;
    imageAction?: "none" | "generateNormalizedImages" | "generateNormalizedImagePerPage";
    indexedFileNameExtensions?: string;
    indexStorageMetadataOnlyForOversizedDocuments?: boolean;
    markdownHeaderDepth?: string;
    markdownParsingSubmode?: string;
    parsingMode?:
        | "text"
        | "default"
        | "delimitedText"
        | "json"
        | "jsonArray"
        | "jsonLines"
        | "markdown";
    pdfTextRotationAlgorithm?: "none" | "detectAngles";
    queryTimeout?: string;
    [property: string]: any;
}

Indexable

  • [property: string]: any

    Describes unknown properties. The value of an unknown property can be of "any" type.

Properties

allowSkillsetToReadFileData? dataToExtract? delimitedTextDelimiter? delimitedTextHeaders? documentRoot? excludedFileNameExtensions? executionEnvironment? failOnUnprocessableDocument? failOnUnsupportedContentType? firstLineContainsHeaders? imageAction? indexedFileNameExtensions? indexStorageMetadataOnlyForOversizedDocuments? markdownHeaderDepth? markdownParsingSubmode? parsingMode? pdfTextRotationAlgorithm? queryTimeout?

Properties

OptionalallowSkillsetToReadFileData

allowSkillsetToReadFileData?: 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.

OptionaldataToExtract

dataToExtract?: "storageMetadata" | "allMetadata" | "contentAndMetadata"

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.

OptionaldelimitedTextDelimiter

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, "|").

OptionaldelimitedTextHeaders

delimitedTextHeaders?: string

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

OptionaldocumentRoot

documentRoot?: string

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

OptionalexcludedFileNameExtensions

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.

OptionalexecutionEnvironment

executionEnvironment?: "standard" | "private"

Specifies the environment in which the indexer should execute.

OptionalfailOnUnprocessableDocument

failOnUnprocessableDocument?: boolean

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

OptionalfailOnUnsupportedContentType

failOnUnsupportedContentType?: 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.

OptionalfirstLineContainsHeaders

firstLineContainsHeaders?: boolean

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

OptionalimageAction

imageAction?: "none" | "generateNormalizedImages" | "generateNormalizedImagePerPage"

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.

OptionalindexedFileNameExtensions

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.

OptionalindexStorageMetadataOnlyForOversizedDocuments

indexStorageMetadataOnlyForOversizedDocuments?: 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.

OptionalmarkdownHeaderDepth

markdownHeaderDepth?: string

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

OptionalmarkdownParsingSubmode

markdownParsingSubmode?: string

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.

OptionalparsingMode

parsingMode?:
    | "text"
    | "default"
    | "delimitedText"
    | "json"
    | "jsonArray"
    | "jsonLines"
    | "markdown"

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

OptionalpdfTextRotationAlgorithm

pdfTextRotationAlgorithm?: "none" | "detectAngles"

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

OptionalqueryTimeout

queryTimeout?: string

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

Settings

Member Visibility