Extractors

Retrieve extraction results

Retrieves extraction results produced by this extractor. If job_id is specified, returns results for that specific extraction run. If job_id is omitted, returns all results produced by this extractor across all runs.

get/extractors/{extractor_id}/results

Request

Base URL
https://h2ogpte.genai.h2o.ai/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/h2o/apis/h2ogpte-rest-api/docs/extractors/:extractor_id/results/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

extractor_idstring required

ID of the extractor

Query parameters

job_idstring

Optional job ID to retrieve results for a specific extraction run. If omitted, returns all results for this extractor.

offsetinteger

How many extraction results to skip before returning.

limitinteger

How many extraction results to return.

Response

Extraction results retrieved successfully. Returns an array of extraction results.

idstring required

ID of the document extraction result

document_idstring nullable

ID of the document that was processed. Null when the extraction was run on uploaded files without a collection.

document_namestring required

Name of the document that was processed

contentunknown required

errorstring required

Contains error in case extraction failed for this document. Otherwise empty.

Changes

No recorded changes to this operation across all 1 revision of this API.