extract method

Future<DynamiteResponse<ReferenceApiExtractResponseApplicationJson, void>> extract({
  1. required String text,
  2. ReferenceApiExtractResolve? resolve,
  3. int? limit,
  4. bool? oCSAPIRequest,
})

Extract references from a text.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • text Text to extract from.
  • resolve Resolve the references. Defaults to 0.
  • limit Maximum amount of references to extract. Defaults to 1.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: References returned

See:

  • extractRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<ReferenceApiExtractResponseApplicationJson, void>> extract({
  required String text,
  ReferenceApiExtractResolve? resolve,
  int? limit,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = extractRaw(
    text: text,
    resolve: resolve,
    limit: limit,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}