BeginBuildDocumentModelOptions interface
Opties voor de buildbewerking van het model.
- Uitbreiding
Overgenomen eigenschappen
abort |
Het signaal dat kan worden gebruikt om aanvragen af te breken. |
description | Een tekstuele beschrijving van het model (kan elke tekst zijn). |
on |
Een optionele initiële voortgangshandler die wordt aangeroepen wanneer de pollerstatus wordt bijgewerkt. Deze handler wordt eenmaal aangeroepen nadat de pollerstatus is geïnitialiseerd. |
on |
Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen. |
request |
Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking. |
resume |
Een geserialiseerde pollerstatus. Indien opgegeven, wordt de pollingbewerking hervat vanuit de opgegeven status in plaats van te worden gestart alsof het een nieuwe bewerking was. |
serializer |
Opties voor het overschrijven van serialisatie/deserialisatiegedrag. |
tags | Aanvullende door de gebruiker opgegeven sleutel-waardeparen die als permanente metagegevens aan het model moeten worden gekoppeld. |
tracing |
Opties die worden gebruikt wanneer tracering is ingeschakeld. |
update |
De hoeveelheid tijd die moet worden gewacht (in milliseconden) tussen volgende aanvragen met betrekking tot dezelfde bewerking. |
Details van overgenomen eigenschap
abortSignal
Het signaal dat kan worden gebruikt om aanvragen af te breken.
abortSignal?: AbortSignalLike
Waarde van eigenschap
overgenomen vanCreateDocumentModelOptions.abortSignal-
description
Een tekstuele beschrijving van het model (kan elke tekst zijn).
description?: string
Waarde van eigenschap
string
overgenomen vanCreateDocumentModelOptions.description
onProgress
Een optionele initiële voortgangshandler die wordt aangeroepen wanneer de pollerstatus wordt bijgewerkt. Deze handler wordt eenmaal aangeroepen nadat de pollerstatus is geïnitialiseerd.
onProgress?: (state: DocumentModelOperationState) => void
Waarde van eigenschap
(state: DocumentModelOperationState) => void
overgenomen vanCreateDocumentModelOptions.onProgress-
onResponse
Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.
onResponse?: RawResponseCallback
Waarde van eigenschap
overgenomen vanCreateDocumentModelOptions.onResponse-
requestOptions
Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.
requestOptions?: OperationRequestOptions
Waarde van eigenschap
overgenomen vanCreateDocumentModelOptions.requestOptions-
resumeFrom
Een geserialiseerde pollerstatus. Indien opgegeven, wordt de pollingbewerking hervat vanuit de opgegeven status in plaats van te worden gestart alsof het een nieuwe bewerking was.
resumeFrom?: string
Waarde van eigenschap
string
overgenomen vanCreateDocumentModelOptions.resumeFrom
serializerOptions
Opties voor het overschrijven van serialisatie/deserialisatiegedrag.
serializerOptions?: SerializerOptions
Waarde van eigenschap
overgenomen vanCreateDocumentModelOptions.serializerOptions-
tags
Aanvullende door de gebruiker opgegeven sleutel-waardeparen die als permanente metagegevens aan het model moeten worden gekoppeld.
tags?: Record<string, string>
Waarde van eigenschap
Record<string, string>
overgenomen vanCreateDocumentModelOptions.tags
tracingOptions
Opties die worden gebruikt wanneer tracering is ingeschakeld.
tracingOptions?: OperationTracingOptions
Waarde van eigenschap
overgenomen vanCreateDocumentModelOptions.tracingOptions-
updateIntervalInMs
De hoeveelheid tijd die moet worden gewacht (in milliseconden) tussen volgende aanvragen met betrekking tot dezelfde bewerking.
updateIntervalInMs?: number
Waarde van eigenschap
number
overgenomen vanCreateDocumentModelOptions.updateIntervalInMs