Partager via


BeginBuildDocumentModelOptions interface

Options de l’opération de génération de modèle.

Extends

Propriétés héritées

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

description

Description textuelle du modèle (il peut s’agir de n’importe quel texte).

onProgress

Gestionnaire de progression initial facultatif qui sera appelé lorsque l’état de l’polleur est mis à jour. Ce gestionnaire est appelé une fois immédiatement après l’initialisation de l’état de l’polleur.

onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.

requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.

resumeFrom

État du polleur sérialisé. Si elle est fournie, l’opération d’interrogation reprend à partir de l’état donné au lieu de démarrer comme s’il s’agissait d’une nouvelle opération.

serializerOptions

Options permettant de remplacer le comportement de sérialisation/de désérialisation.

tags

Des paires clé-valeur spécifiées par l’utilisateur supplémentaires à associer au modèle en tant que métadonnées persistantes.

tracingOptions

Options utilisées lorsque le suivi est activé.

updateIntervalInMs

Durée d’attente (en millisecondes) entre les requêtes suivantes relatives à la même opération.

Détails de la propriété héritée

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

héritée deCreateDocumentModelOptions.abortSignal

description

Description textuelle du modèle (il peut s’agir de n’importe quel texte).

description?: string

Valeur de propriété

string

héritée deCreateDocumentModelOptions.description

onProgress

Gestionnaire de progression initial facultatif qui sera appelé lorsque l’état de l’polleur est mis à jour. Ce gestionnaire est appelé une fois immédiatement après l’initialisation de l’état de l’polleur.

onProgress?: (state: DocumentModelOperationState) => void

Valeur de propriété

(state: DocumentModelOperationState) => void

héritée deCreateDocumentModelOptions.onProgress

onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.

onResponse?: RawResponseCallback

Valeur de propriété

héritée deCreateDocumentModelOptions.onResponse

requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.

requestOptions?: OperationRequestOptions

Valeur de propriété

héritée deCreateDocumentModelOptions.requestOptions

resumeFrom

État du polleur sérialisé. Si elle est fournie, l’opération d’interrogation reprend à partir de l’état donné au lieu de démarrer comme s’il s’agissait d’une nouvelle opération.

resumeFrom?: string

Valeur de propriété

string

héritée deCreateDocumentModelOptions.resumeFrom

serializerOptions

Options permettant de remplacer le comportement de sérialisation/de désérialisation.

serializerOptions?: SerializerOptions

Valeur de propriété

héritée deCreateDocumentModelOptions.serializerOptions

tags

Des paires clé-valeur spécifiées par l’utilisateur supplémentaires à associer au modèle en tant que métadonnées persistantes.

tags?: Record<string, string>

Valeur de propriété

Record<string, string>

héritée deCreateDocumentModelOptions.tags

tracingOptions

Options utilisées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

héritée deCreateDocumentModelOptions.tracingOptions

updateIntervalInMs

Durée d’attente (en millisecondes) entre les requêtes suivantes relatives à la même opération.

updateIntervalInMs?: number

Valeur de propriété

number

héritée deCreateDocumentModelOptions.updateIntervalInMs