Interface UnstructuredLoaderOptions

interface UnstructuredLoaderOptions {
    apiKey?: string;
    chunkingStrategy?: null | ChunkingStrategyOpen;
    client?: UnstructuredClient;
    combineUnderNChars?: null | number;
    coordinates?: boolean;
    enableLogs?: boolean;
    encoding?: null | string;
    extractImageBlockTypes?: string[];
    gzUncompressedContentType?: null | string;
    hiResModelName?: null | string;
    httpClient?: HTTPClient;
    includeOrigElements?: null | boolean;
    includePageBreaks?: boolean;
    languages?: string[];
    maxCharacters?: null | number;
    multipageSections?: boolean;
    newAfterNChars?: null | number;
    ocrLanguages?: string[];
    outputFormat?: OutputFormatOpen;
    overlap?: number;
    overlapAll?: boolean;
    partitionViaApi?: boolean;
    pdfInferTableStructure?: boolean;
    postProcessors?: ((str: string) => string)[];
    retryConfig?: RetryConfig;
    security?: Security | (() => Promise<Security>);
    server?: "free-api" | "development";
    serverURL?: string;
    similarityThreshold?: null | number;
    skipInferTableTypes?: string[];
    splitPdfConcurrencyLevel?: number;
    splitPdfPage?: boolean;
    startingPageNumber?: null | number;
    strategy?: UnstructuredLoaderStrategy;
    timeoutMs?: number;
    uniqueElementIds?: boolean;
    xmlKeepTags?: boolean;
}

Hierarchy

  • SDKOptions
  • Omit<PartitionParameters, "files" | "strategy">
    • UnstructuredLoaderOptions

Properties

apiKey? chunkingStrategy? client? combineUnderNChars? coordinates? enableLogs? encoding? extractImageBlockTypes? gzUncompressedContentType? hiResModelName? httpClient? includeOrigElements? includePageBreaks? languages? maxCharacters? multipageSections? newAfterNChars? ocrLanguages? outputFormat? overlap? overlapAll? partitionViaApi? pdfInferTableStructure? postProcessors? retryConfig? security? server? serverURL? similarityThreshold? skipInferTableTypes? splitPdfConcurrencyLevel? splitPdfPage? startingPageNumber? strategy? timeoutMs? uniqueElementIds? xmlKeepTags?

Properties

OptionalapiKey

apiKey?: string

OptionalchunkingStrategy

chunkingStrategy?: null | ChunkingStrategyOpen

Use one of the supported strategies to chunk the returned elements after partitioning. When 'chunking_strategy' is not specified, no chunking is performed and any other chunking parameters provided are ignored. Supported strategies: 'basic', 'by_page', 'by_similarity', or 'by_title'

Optionalclient

client?: UnstructuredClient

OptionalcombineUnderNChars

combineUnderNChars?: null | number

If chunking strategy is set, combine elements until a section reaches a length of n chars. Default: 500

Optionalcoordinates

coordinates?: boolean

If True, return coordinates for each element extracted via OCR. Default: False

OptionalenableLogs

enableLogs?: boolean

The Unstructured SDK has logs they call console.info to log at request time. Passing true will log these messages. The default of false will overwrite the console.info function so that it does not log.

Default

false

Optionalencoding

encoding?: null | string

The encoding method used to decode the text input. Default: utf-8

OptionalextractImageBlockTypes

extractImageBlockTypes?: string[]

The types of elements to extract, for use in extracting image blocks as base64 encoded data stored in metadata fields.

OptionalgzUncompressedContentType

gzUncompressedContentType?: null | string

If file is gzipped, use this content type after unzipping.

OptionalhiResModelName

hiResModelName?: null | string

The name of the inference model used when strategy is hi_res

OptionalhttpClient

httpClient?: HTTPClient

OptionalincludeOrigElements

includeOrigElements?: null | boolean

When a chunking strategy is specified, each returned chunk will include the elements consolidated to form that chunk as .metadata.orig_elements. Default: true.

OptionalincludePageBreaks

includePageBreaks?: boolean

If true, the output will include page breaks if the filetype supports it. Default: false

Optionallanguages

languages?: string[]

The languages present in the document, for use in partitioning and/or OCR. See the Tesseract documentation for a full list of languages.

OptionalmaxCharacters

maxCharacters?: null | number

If chunking strategy is set, cut off new sections after reaching a length of n chars (hard max). Default: 500

OptionalmultipageSections

multipageSections?: boolean

If chunking strategy is set, determines if sections can span multiple sections. Default: true

OptionalnewAfterNChars

newAfterNChars?: null | number

If chunking strategy is set, cut off new sections after reaching a length of n chars (soft max). Default: 1500

OptionalocrLanguages

ocrLanguages?: string[]

Deprecated! The languages present in the document, for use in partitioning and/or OCR

OptionaloutputFormat

outputFormat?: OutputFormatOpen

The format of the response. Supported formats are application/json and text/csv. Default: application/json.

Optionaloverlap

overlap?: number

Specifies the length of a string ('tail') to be drawn from each chunk and prefixed to the next chunk as a context-preserving mechanism. By default, this only applies to split-chunks where an oversized element is divided into multiple chunks by text-splitting. Default: 0

OptionaloverlapAll

overlapAll?: boolean

When True, apply overlap between 'normal' chunks formed from whole elements and not subject to text-splitting. Use this with caution as it entails a certain level of 'pollution' of otherwise clean semantic chunk boundaries. Default: False

OptionalpartitionViaApi

partitionViaApi?: boolean

OptionalpdfInferTableStructure

pdfInferTableStructure?: boolean

Deprecated! Use skip_infer_table_types to opt out of table extraction for any file type. If False and strategy=hi_res, no Table Elements will be extracted from pdf files regardless of skip_infer_table_types contents.

OptionalpostProcessors

postProcessors?: ((str: string) => string)[]

OptionalretryConfig

retryConfig?: RetryConfig

Allows overriding the default retry config used by the SDK

Optionalsecurity

security?: Security | (() => Promise<Security>)

The security details required to authenticate the SDK

Optionalserver

server?: "free-api" | "development"

Allows overriding the default server used by the SDK

OptionalserverURL

serverURL?: string

Allows overriding the default server URL used by the SDK

OptionalsimilarityThreshold

similarityThreshold?: null | number

A value between 0.0 and 1.0 describing the minimum similarity two elements must have to be included in the same chunk. Note that similar elements may be separated to meet chunk-size criteria; this value can only guarantees that two elements with similarity below the threshold will appear in separate chunks.

OptionalskipInferTableTypes

skipInferTableTypes?: string[]

The document types that you want to skip table extraction with. Default: []

OptionalsplitPdfConcurrencyLevel

splitPdfConcurrencyLevel?: number

Number of maximum concurrent requests made when splitting PDF. Ignored on backend.

OptionalsplitPdfPage

splitPdfPage?: boolean

Should the pdf file be split at client. Ignored on backend.

OptionalstartingPageNumber

startingPageNumber?: null | number

When PDF is split into pages before sending it into the API, providing this information will allow the page number to be assigned correctly. Introduced in 1.0.27.

Optionalstrategy

strategy?: UnstructuredLoaderStrategy

OptionaltimeoutMs

timeoutMs?: number

OptionaluniqueElementIds

uniqueElementIds?: boolean

When True, assign UUIDs to element IDs, which guarantees their uniqueness (useful when using them as primary keys in database). Otherwise a SHA-256 of element text is used. Default: False

OptionalxmlKeepTags

xmlKeepTags?: boolean

If True, will retain the XML tags in the output. Otherwise it will simply extract the text from within the tags. Only applies to XML documents.

Settings

Member Visibility

On This Page

Properties