iqm.iqm_client.models.Metadata

class iqm.iqm_client.models.Metadata(*, calibration_set_id: UUID | None = None, request: RunRequest | None = None, parameters: JobParameters | None = None, circuits_batch: list[Circuit] | None = None, cocos_version: str | None = None, timestamps: dict[str, str] | None = None)

Bases: BaseModel

Metadata describing a circuit execution job.

Attributes

circuits	Return the circuits in the job.
heralding_mode	Return the heralding mode requested with the job.
model_computed_fields	A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_fields	Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.
shots	Return the number of shots in the job.
calibration_set_id	ID of the calibration set used
request	optional copy of the original RunRequest sent to the server
parameters	job-specific parameters extracted from the original request
circuits_batch	circuits batch submitted for execution
cocos_version	CoCoS version used to execute the job
timestamps	Timestamps of execution progress

Methods

Parameters:

• calibration_set_id (UUID | None) –

• request (RunRequest | None) –

• parameters (JobParameters | None) –

• circuits_batch (list[Circuit] | None) –

• cocos_version (str | None) –

• timestamps (dict[str, str] | None) –

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'calibration_set_id': FieldInfo(annotation=Union[UUID, NoneType], required=False, default=None), 'circuits_batch': FieldInfo(annotation=Union[list[Circuit], NoneType], required=False, default=None), 'cocos_version': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'parameters': FieldInfo(annotation=Union[JobParameters, NoneType], required=False, default=None), 'request': FieldInfo(annotation=Union[RunRequest, NoneType], required=False, default=None), 'timestamps': FieldInfo(annotation=Union[dict[str, str], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

calibration_set_id: UUID | None

ID of the calibration set used

request: RunRequest | None

optional copy of the original RunRequest sent to the server

parameters: JobParameters | None

job-specific parameters extracted from the original request

circuits_batch: CircuitBatch | None

circuits batch submitted for execution

cocos_version: str | None

CoCoS version used to execute the job

timestamps: dict[str, str] | None

Timestamps of execution progress

property shots: int

Return the number of shots in the job.

property circuits: list[Circuit]

Return the circuits in the job.

property heralding_mode: HeraldingMode

Return the heralding mode requested with the job.