.. _auto_keyvalue_get_value_as_text:

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

Extracts the value associated with a named key from a KeyValue input and returns it as plain text. Use this worker when a downstream step requires a scalar string pulled from a structured key-value response.

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

Classification: **process**.

Tagged: ``extract``, ``keyvalue``, ``response``, ``scalar``, ``text``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Response To Extract From
     - responsetoextractfrom
     - keyvalue
     - —
     - 
     - The KeyValue pair object to query; supply the structured key-value response from which the target value should be extracted (optional — leave unconnected if the value will be injected at runtime).

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - keyvalue_get_value_as_text_output_1
     - keyvalue_get_value_as_text_output_1
     - text
     - The extracted value returned as a plain-text string corresponding to the requested key in the input KeyValue object.

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

- cae.postprocessing.response
- 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_get_value_as_text <https://www.d3view.com/api/workflow/example?id=keyvalue_get_value_as_text>`_

.. 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_get_value_as_text</code>. Schema hash: <code>94bc1f312415</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>