SamplerV2

class SamplerV2(mode=None, backend=None, session=None, options=None)

Class for interacting with Qiskit Runtime Sampler primitive service.

This class supports version 2 of the Sampler interface, which uses different input and output formats than version 1.

Qiskit Runtime Sampler primitive returns the sampled result according to the specified output type. For example, it returns a bitstring for each shot if measurement level 2 (bits) is requested.

The run() method can be used to submit circuits and parameters to the Sampler primitive.

Initializes the Sampler primitive.

Parameters

• mode (Union[BackendV1, BackendV2, Session, Batch, str, None]) –

  The execution mode used to make the primitive query. It can be:

  • A Backend if you are using job mode.
  • A Session if you are using session execution mode.
  • A Batch if you are using batch execution mode.

  Refer to the Qiskit Runtime documentation. for more information about the Execution modes.

• backend (Union[str, BackendV1, BackendV2, None]) – Backend to run the primitive. This can be a backend name or an IBMBackend instance. If a name is specified, the default account (e.g. QiskitRuntimeService()) is used.

• session (Optional[Session]) –

  Session in which to call the primitive.

  If both session and backend are specified, session takes precedence. If neither is specified, and the primitive is created inside a qiskit_ibm_runtime.Session context manager, then the session is used. Otherwise if IBM Cloud channel is used, a default backend is selected.

• options (Union[Dict, SamplerOptions, None]) – Sampler options, see SamplerOptions for detailed description.

Raises

NotImplementedError – If “q-ctrl” channel strategy is used.

Attributes

mode

options

session

version

Methods

run