@affinda/affinda / Exports / CreateDocumentOptionalParams
Optional parameters.
-
OperationOptions↳
CreateDocumentOptionalParams
- abortSignal
- collection
- compact
- customIdentifier
- data
- deleteAfterParse
- enableValidationTool
- expiryTime
- file
- fileName
- identifier
- language
- lowPriority
- onResponse
- regionBias
- rejectDuplicates
- requestOptions
- serializerOptions
- tracingOptions
- url
- wait
- workspace
• Optional abortSignal: AbortSignalLike
The signal which can be used to abort requests.
coreClient.OperationOptions.abortSignal
• Optional collection: string
Uniquely identify a collection.
• Optional compact: boolean
If true, the returned parse result (assuming wait is also true) will be a compact version of the full result.
• Optional customIdentifier: string
Specify a custom identifier for the document if you need one, not required to be unique.
• Optional data: DocumentCreateData
Create resume or job description directly from data.
• Optional deleteAfterParse: boolean
If true, no data will be stored after parsing. Only compatible with requests where wait: True.
• Optional enableValidationTool: boolean
If true, the document will be viewable in the Affinda Validation Tool. Set to False to optimize parsing speed.
• Optional expiryTime: string
The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
• Optional file: RequestBodyType
File as binary data blob. Supported formats: PDF, DOC, DOCX, TXT, RTF, HTML, PNG, JPG, TIFF, ODT, XLS, XLSX, ZIP
• Optional fileName: string
Optional filename of the file
• Optional identifier: string
Deprecated in favor of customIdentifier.
• Optional language: string
Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.
• Optional lowPriority: boolean
Explicitly mark this document as low priority.
• 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 regionBias: string
A JSON representation of the RegionBias object.
• Optional rejectDuplicates: boolean
If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.
• 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
• Optional url: string
URL to download the document.
• Optional wait: string
If "true" (default), will return a response only after processing has completed. If "false", will return an empty data object which can be polled at the GET endpoint until processing is complete.
• Optional workspace: string
Uniquely identify a workspace.