Skip to main content

Field Autocomplete

Autocomplete extracted field names from the registry, ranked by relevance and occurrence count. Power field pickers and type-ahead search UIs.

The Talonic API lets you search and filter documents by their extracted field values: field autocomplete resolves field names, document filtering applies composable conditions, and global omnisearch queries every entity type at once. The field autocomplete endpoint is the entry point: it performs type-ahead search over the field registry, the deduplicated catalog of every field Talonic has extracted from your documents.

Results are ranked by a combination of name relevance and occurrence count, so frequently seen fields surface first. Use this to power field picker dropdowns and search-as-you-type UIs, or to resolve a field ID before calling the field values or filter endpoints.

GET/v1/search/autocomplete

Query parameters

qstringSearch text to match against field names.
source_idstringScope results to fields seen in a specific source.
limitintegerMaximum number of results to return (up to 100). Default: 20

Request

Response

Response fields

dataarrayArray of matching field objects ranked by relevance.
data[].fieldIdstringUnique field registry ID.
data[].canonicalNamestringCanonical field name (lowercase, underscore-separated).
data[].displayNamestringHuman-readable display name.
data[].dataTypestringField data type (string, number, date, boolean).
data[].tierintegerRegistry maturity tier: 1 = Canonical, 2 = Established, 3 = Provisional.
data[].occurrenceCountintegerNumber of documents containing this field.
data[].matchSourcestringHow the field matched the query: `canonical`, `display`, or `variant`.
data[].sampleValuesstring[]Up to 3 representative values from the field.

Response

{
  "data": [
    {
      "fieldId": "fld_a1b2c3d4",
      "canonicalName": "supplier_name",
      "displayName": "Supplier Name",
      "dataType": "string",
      "tier": 1,
      "occurrenceCount": 1842,
      "matchSource": "canonical",
      "sampleValues": ["Acme Corp", "Globex Inc", "Initech"]
    }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Field Values
Filter Documents
Query the Registry