Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BeginBuildDocumentModelOptions

Package version

Options for the model build operation.

Hierarchy

Index

Properties

Optional description

description: undefined | string

A textual description of the model (can be any text).

Optional onProgress

onProgress: undefined | ((state: DocumentModelOperationState) => void)

An optional initial progress handler that will be called when the poller state updates. This handler will be called once immediately after the poller state is initialized.

Optional resumeFrom

resumeFrom: undefined | string

A serialized poller state. If provided, the polling operation will be resumed from the given state instead of started as if it were a new operation.

Optional tags

tags: Record<string, string>

Additional, user-specified key-value pairs to associate with the model as persistent metadata.

Optional updateIntervalInMs

updateIntervalInMs: undefined | number

The amount of time to wait (in milliseconds) between subsequent requests relating to the same operation.

Generated using TypeDoc