Azure Connectors Node.js SDK
    Preparing search index...

    Interface UploadDocumentsStreamOptions

    Options for the uploadDocumentsStream operation.

    interface UploadDocumentsStreamOptions {
        abortSignal?: AbortSignalLike;
        onResponse?: ConnectorRawResponseCallback;
        tracingOptions?: OperationTracingOptions;
        xConvertDocument?: string;
        xFileName?: string;
        xSource?: string;
    }

    Hierarchy (View Summary)

    Index
    abortSignal?: AbortSignalLike

    Signal used to cancel the operation.

    Callback invoked with the complete response before the operation returns or throws.

    tracingOptions?: OperationTracingOptions

    Context used to parent the operation's tracing span.

    xConvertDocument?: string

    This identifies whether to convert the document to a PDF or if it should be retained in its original format. Note the only original format supported is currently Word & XML. All other document types will result in an error if this header value is set to "false". If uploading a PDF document this Header can be omitted.

    xFileName?: string

    It's the name of file with extension.

    xSource?: string

    This is the identification of the source of the document from where the document is uploaded, e.g. "My App".