Method with_inputs

dspy/primitives/example.py:223–247

Mark which fields are inputs and return a new `Example`. Fields not listed here are treated as labels (expected outputs). DSPy optimizers and evaluators use this split: they pass `example.inputs()` to your program and compare the output against `example.labels()`.

(self, *keys)

        return self._store.get(key, default)

    def with_inputs(self, *keys):
        """Mark which fields are inputs and return a new `Example`.

        Fields not listed here are treated as labels (expected outputs).
        DSPy optimizers and evaluators use this split: they pass
        `example.inputs()` to your program and compare the output against
        `example.labels()`.

        Args:
            *keys: Names of the input fields.

        Returns:
            A copy of this `Example` with the input keys set.

        Examples:
            >>> import dspy
            >>> ex = dspy.Example(question="Why?", answer="Because.").with_inputs("question")
            >>> ex.inputs().keys()
            ['question']
            >>> ex.labels().keys()
            ['answer']
        """
        copied = self.copy()
        copied._input_keys = set(keys)
        return copied

    def inputs(self):
        """Return a new `Example` containing only the input fields.