demo/enrich
Built-in enrich adapter for person records: its manifest, needs, provides, config keys, cost, and an example step
What you'll learn
You're about to put demo/enrich in a step and want its keys, fields, credentials, and cost before plan tells you.
- what the adapter needs and provides
- every
with:key it accepts - what it costs and which credential it demands
A built-in enrich adapter for person records: it needs any of email or full_name and provides 2 fields. Plan estimates $0.0100 per record, and it demands no credential.
Manifest
| Key | Value |
|---|---|
| id | demo/enrich |
| version | 1 |
| role | enrich |
| entity type | person |
| credentials | none |
| cost estimate per record | $0.0100 |
| freshness | 30 days (the default cache: window) |
Needs
{
"anyOf": [
{
"required": [
"email"
]
},
{
"required": [
"full_name"
]
}
],
"properties": {
"email": {
"type": "string"
},
"full_name": {
"type": "string"
}
},
"type": "object"
}
Provides
{
"additionalProperties": false,
"properties": {
"demo.note": {
"type": "string"
},
"demo.score": {
"maximum": 100,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
Config keys
The keys with: accepts. Plan rejects any other key.
| Key | Type | Required | What it sets |
|---|---|---|---|
cost_per_record_usd | number | The pretend price of one enrichment, for the receipt's arithmetic (default 0.01) |
Example
From A pipeline is a YAML file:
- id: score
use: demo/enrich # $0.01 per record, pretend; cached for 30 days
with:
cost_per_record_usd: 0.01