Skip to content
Console(opens in a new tab)

enrich

Starts a background task that enriches an input file for a list materialization.

Intent. This intent is a read. It returns data and changes nothing.

Starts a background task that enriches an input file for a list materialization. The response lists the new task under extensions.backgroundTasks, and backgroundTask reports its progress.

enrich(enrichmentInput: EnrichmentInput!): [SearchUnion]

Returns SearchUnion.

Field Type Part Description
s3Path String! File The S3 path of the input file to enrich.
entityType EntityType Subject One of BRAND, OPERATING_LOCATION, LEGAL_ENTITY, PERSON, ADDRESS.
output OutputSpec! File The output file of the enrichment.
sourceId String! File The ID of the list materialization to enrich. The list materialization must belong to your organization.
provider EnrichmentProvider Engine The source of the enrichment data. If you omit it, the API picks a source from the type of your API key. One of SEARCH.
scoreThreshold Float Match The lowest match score that a result must reach, as with matchThreshold in a search. It applies to the SEARCH provider only.

This intent needs a list materialization and an input file from earlier steps, so the reference does not run it. No response is shown.

query {
enrich(enrichmentInput: {
sourceId: "00000000-0000-4000-8000-000000000001"
s3Path: "s3://example-bucket/input.parquet"
entityType: BRAND
output: { filename: "enriched-brands", format: CSV }
}) {
... on Brand { id }
}
}