extractFileText method

Future<ExtractTextResult?> extractFileText(
  1. String id, {
  2. String? accountId,
  3. String? xWorkspaceID,
  4. int? pageStart,
  5. int? pageEnd,
  6. int? maxChars,
})

Extract text content from a PDF (or other supported file).

Parameters:

  • String id (required): File id.

  • String accountId: Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with provider. If omitted on a list endpoint the call fans out across every connected account.

  • String xWorkspaceID: Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

  • int pageStart:

  • int pageEnd:

  • int maxChars: Truncation limit; sets truncated: true when hit.

Implementation

Future<ExtractTextResult?> extractFileText(String id, { String? accountId, String? xWorkspaceID, int? pageStart, int? pageEnd, int? maxChars, }) async {
  final response = await extractFileTextWithHttpInfo(id,  accountId: accountId, xWorkspaceID: xWorkspaceID, pageStart: pageStart, pageEnd: pageEnd, maxChars: maxChars, );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'ExtractTextResult',) as ExtractTextResult;

  }
  return null;
}