@affinda/affinda / Exports / GetDocumentOptionalParams
Optional parameters.
-
OperationOptions↳
GetDocumentOptionalParams
• Optional abortSignal: AbortSignalLike
The signal which can be used to abort requests.
coreClient.OperationOptions.abortSignal
• Optional compact: boolean
If "true", the response is compacted to annotations' parsed data. Annotations' meta data are excluded. Default is "false".
• Optional format: string
Specify which format you want the response to be. Default is "json"
• Optional onResponse: RawResponseCallback
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
coreClient.OperationOptions.onResponse
• Optional requestOptions: OperationRequestOptions
Options used when creating and sending HTTP requests for this operation.
coreClient.OperationOptions.requestOptions
• Optional serializerOptions: SerializerOptions
Options to override serialization/de-serialization behavior.
coreClient.OperationOptions.serializerOptions
• Optional tracingOptions: OperationTracingOptions
Options used when tracing is enabled.
coreClient.OperationOptions.tracingOptions