.. _auto_keyvalue_extract:

*EXTRACT THE VALUE OF A RESPONSE NAME FROM A KEYVALUE*
======================================================

Extracts a single scalar value from a KeyValue object by matching a named key, with optional comparison operators and linear scaling. Use this worker when you need to retrieve and optionally transform one named response from a key-value pair collection in a workflow.

When to use
-----------

Classification: **process**.

Tagged: ``extract``, ``filter``, ``keyvalue``, ``lookup``, ``offset``, ``operator``, ``process``, ``scalar``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Kv1
     - kv1
     - keyvalue
     - —
     - 
     - The source KeyValue object from which a value will be extracted; connect the upstream key-value pair output here.
   * - Key Name
     - key_name
     - scalar
     - Unknown
     - 
     - Case-sensitive name of the key whose value should be extracted (e.g. "Peak_Force"); default is "Unknown".
   * - Operator
     - operator
     - scalar
     - eq
     - 
     - Comparison operator used when matching the key value — choose from eq, contains, gt, gte, lte, starts_with, ends_with, or excludes; default is "eq" (exact match).
   * - Scale
     - scale
     - scalar
     - 1
     - 
     - Multiplicative scale factor applied to the extracted numeric value before output; default is 1 (no scaling).
   * - Offset
     - offset
     - scalar
     - 0
     - 
     - Additive offset applied to the extracted numeric value after scaling; default is 0 (no offset).

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - keyvalue_extract_output_1
     - keyvalue_extract_output_1
     - scalar
     - The scalar value extracted from the KeyValue object for the specified key, after applying the scale and offset transformations.

Disciplines
-----------

- data.dataset.transform

Runnable example
----------------

A runnable example is registered for this worker. Open the example workflow on the d3VIEW canvas: `/api/workflow/example?id=keyvalue_extract <https://www.d3view.com/api/workflow/example?id=keyvalue_extract>`_

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>transformation</code> schema. Worker id: <code>keyvalue_extract</code>. Schema hash: <code>0c83458b9bd8</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>