extract method
Future<DynamiteResponse<ReferenceApiExtractResponseApplicationJson, void> >
extract({
- required String text,
- ReferenceApiExtractResolve? resolve,
- int? limit,
- 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 to0
.limit
Maximum amount of references to extract. Defaults to1
.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: References returned
See:
- $extract_Request for the request send by this method.
- $extract_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<ReferenceApiExtractResponseApplicationJson, void>> extract({
required String text,
ReferenceApiExtractResolve? resolve,
int? limit,
bool? oCSAPIRequest,
}) async {
final _request = $extract_Request(
text: text,
resolve: resolve,
limit: limit,
oCSAPIRequest: oCSAPIRequest,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $extract_Serializer();
final _rawResponse =
await _i1.ResponseConverter<ReferenceApiExtractResponseApplicationJson, void>(_serializer).convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}