`qcs_api_client.models`#

Contains all the data models used in inputs/outputs

Submodules#

Package Contents#

Classes#

`AccountBalance`	Balance of QCS account in billing system. Note, a negative balance signifies that the account has QCS credits to
`AccountType`	str(object='') -> str
`AddGroupUserRequest`	Must provide either userId or userEmail and groupId or groupName.
`Architecture`	Represents the logical underlying architecture of a quantum processor.
`AuthEmailPasswordResetTokenRequest`	qcs_api_client.models.email#
`AuthResetPasswordRequest`	qcs_api_client.models.new_password#
`AuthResetPasswordWithTokenRequest`	Token may be requested with AuthEmailPasswordResetToken.
`AvailableReservation`	qcs_api_client.models.duration#
`BillingCustomer`	A representation of a QCS's account billing customer. Note, balance does not account for the upcoming invoice.
`BillingInvoice`	A finalized billing invoice.
`BillingInvoiceLine`	A line item on an invoice representing a particular purchase (such as a reservation) or aggregate usage for the
`BillingInvoiceLineLineItemType`	str(object='') -> str
`BillingInvoiceLineMetadata`
`BillingInvoiceStatus`	str(object='') -> str
`BillingPrice`	The price schedule for a particular service applied to an invoice line item.
`BillingPriceObject`	str(object='') -> str
`BillingPricePriceType`	str(object='') -> str
`BillingPriceRecurrence`	The recurring components of a price such as interval and usageType.
`BillingPriceRecurrenceAggregateUsage`	str(object='') -> str
`BillingPriceRecurrenceInterval`	str(object='') -> str
`BillingPriceRecurrenceUsageType`	str(object='') -> str
`BillingPriceScheme`	str(object='') -> str
`BillingPriceTiersMode`	str(object='') -> str
`BillingProduct`	A QCS service product. This may represent one time (such as reservations) or metered services.
`BillingProductObject`	str(object='') -> str
`BillingUpcomingInvoice`	An unfinalized billing invoice.
`Characteristic`	A measured characteristic of an operation.
`CheckClientApplicationRequest`	qcs_api_client.models.name#
`CheckClientApplicationResponse`	qcs_api_client.models.is_latest_version#
`ChecksumDescription`	qcs_api_client.models.header_name#
`ChecksumDescriptionType`	str(object='') -> str
`ClientApplication`	qcs_api_client.models.latest_version#
`ClientApplicationsDownloadLink`	qcs_api_client.models.url#
`CreateEndpointParameters`	A publicly available set of parameters for defining an endpoint.
`CreateEngagementRequest`	qcs_api_client.models.account_id#
`CreateReservationRequest`	qcs_api_client.models.end_time#
`Dictionary`	Generic, arbitrary Dictionary
`Edge`	A degree-two logical connection in the quantum processor's architecture.
`Endpoint`	An Endpoint is the entry point for remote access to a QuantumProcessor.
`EndpointAddresses`	Addresses at which an endpoint is reachable over the network.
`EngagementCredentials`	Credentials are the ZeroMQ CURVE Keys used to encrypt the connection with the Quantum Processor
`EngagementWithCredentials`	An engagement is the authorization of a user to execute work on a Quantum Processor Endpoint.
`Error`	qcs_api_client.models.code#
`Family`	str(object='') -> str
`FindAvailableReservationsResponse`	qcs_api_client.models.available_reservations#
`GetQuiltCalibrationsResponse`	qcs_api_client.models.quilt#
`Group`	qcs_api_client.models.created_time#
`Health`	qcs_api_client.models.status#
`InstructionSetArchitecture`	The native instruction set architecture of a quantum processor, annotated with characteristics.
`InviteUserRequest`	qcs_api_client.models.email#
`ListAccountBillingInvoiceLinesResponse`	qcs_api_client.models.billing_invoice_lines#
`ListAccountBillingInvoicesResponse`	qcs_api_client.models.billing_invoices#
`ListClientApplicationsResponse`	qcs_api_client.models.client_applications#
`ListEndpointsResponse`	qcs_api_client.models.endpoints#
`ListGroupUsersResponse`	qcs_api_client.models.users#
`ListGroupsResponse`	qcs_api_client.models.groups#
`ListQuantumProcessorAccessorsResponse`	qcs_api_client.models.accessors#
`ListQuantumProcessorsResponse`	qcs_api_client.models.quantum_processors#
`ListReservationsResponse`	qcs_api_client.models.next_page_token#
`Node`	A logical node in the quantum processor's architecture.
`NomadJobDatacenters`	str(object='') -> str
`Operation`	An operation, with its sites and site-independent characteristics.
`OperationSite`	A site for an operation, with its site-dependent characteristics.
`Parameter`	A parameter to an operation.
`ParameterSpec`	qcs_api_client.models.length#
`QuantumProcessor`	qcs_api_client.models.id#
`QuantumProcessorAccessor`	Method of accessing an available QPU.
`QuantumProcessorAccessorType`	str(object='') -> str
`RemoveGroupUserRequest`	Must provide either userId or userEmail and groupId or groupName.
`Reservation`	qcs_api_client.models.account_id#
`RestartEndpointRequest`	qcs_api_client.models.component_name#
`Tier`	qcs_api_client.models.up_to#
`TranslateNativeQuilToEncryptedBinaryRequest`	qcs_api_client.models.num_shots#
`TranslateNativeQuilToEncryptedBinaryResponse`	qcs_api_client.models.program#
`TranslateNativeQuilToEncryptedBinaryResponseMemoryDescriptors`
`User`	qcs_api_client.models.created_time#
`UserCredentials`	qcs_api_client.models.password#
`UserCredentialsPassword`	qcs_api_client.models.value#
`UserProfile`	qcs_api_client.models.email#
`ValidationError`	qcs_api_client.models.in_#
`ValidationErrorIn`	str(object='') -> str

class qcs_api_client.models.AccountBalance#

Balance of QCS account in billing system. Note, a negative balance signifies that the account has QCS credits to spend. A positive account balance signifies that the account has no additional QCS credits to spend. The QCS UI may display these quantities in absolute or negative value and provide a clear meaning to the significance.

Attributes:
balance (int): The balance in cents USD.

balance :int#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.AccountType#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

Initialize self. See help(type(self)) for accurate signature.

GROUP = group#

USER = user#

__str__() → str#: Return str(self).

class qcs_api_client.models.AddGroupUserRequest#

Must provide either userId or userEmail and groupId or groupName.

group_id#

Type: Union[Unset, str]

group_name#

Type: Union[Unset, str]

user_email#

Type: Union[Unset, str]

user_id#

Type: Union[Unset, str]

group_id :Union[qcs_api_client.types.Unset, str]#

group_name :Union[qcs_api_client.types.Unset, str]#

user_email :Union[qcs_api_client.types.Unset, str]#

user_id :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.Architecture#

Represents the logical underlying architecture of a quantum processor.

The architecture is defined in detail by the nodes and edges that constitute the quantum processor. This defines the set of all nodes that could be operated upon, and indicates to some approximation their physical layout. The main purpose of this is to support geometry calculations that are independent of the available operations, and rendering ISA-based information. Architecture layouts are defined by the family, as follows.

The “Aspen” family of quantum processor indicates a 2D planar grid layout of octagon unit cells. The node_id in this architecture is computed as \(100 p_y + 10 p_x + p_u\) where \(p_y\) is the zero-based Y position in the unit cell grid, \(p_x\) is the zero-based X position in the unit cell grid, and \(p_u\) is the zero-based position in the octagon unit cell and always ranges from 0 to 7. This scheme has a natural size limit of a 10x10 unit cell grid, which permits the architecture to scale up to 800 nodes.

Note that the operations that are actually available are defined entirely by Operation instances. The presence of a node or edge in the Architecture model provides no guarantee that any 1Q or 2Q operation will be available to users writing QUIL programs.

Attributes:
edges (List[Edge]): A list of all computational edges in the instruction set architecture. family (Family): Family identifier.

Value ‘None’ implies the architecture has no specific layout topology. Value ‘Full’ implies that each node is connected to every other (a fully-connected architecture)

For other values based on deployed architecture layouts (e.g. Aspen and Ankaa), refer to the architecture classes themselves for more details.

nodes (List[Node]): A list of all computational nodes in the instruction set architecture.

edges :List[qcs_api_client.models.edge.Edge]#

family :qcs_api_client.models.family.Family#

nodes :List[qcs_api_client.models.node.Node]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

class qcs_api_client.models.AuthEmailPasswordResetTokenRequest#

email#

Type: str

email :str#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.AuthResetPasswordRequest#

new_password#

Type: str

old_password#

Type: str

new_password :str#

old_password :str#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.AuthResetPasswordWithTokenRequest#

Token may be requested with AuthEmailPasswordResetToken.

new_password#

Type: str

token#

Type: str

new_password :str#

token :str#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.AvailableReservation#

duration#

Type: str

end_time#

Type: datetime.datetime

price#

Type: int

quantum_processor_id#

Type: str

start_time#

Type: datetime.datetime

duration :str#

end_time :datetime.datetime#

price :int#

quantum_processor_id :str#

start_time :datetime.datetime#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.BillingCustomer#

A representation of a QCS’s account billing customer. Note, balance does not account for the upcoming invoice.

email#

Type: str

id#

Type: str

email :str#

id :str#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.BillingInvoice#

A finalized billing invoice.

period_end#

Type: datetime.datetime

period_start#

Type: datetime.datetime

starting_balance#

Type: int

status#

Type: BillingInvoiceStatus

subtotal#

Type: int

tax#

Type: int

total#

Type: int

id#

Type: str

period_end :datetime.datetime#

period_start :datetime.datetime#

starting_balance :int#

status :qcs_api_client.models.billing_invoice_status.BillingInvoiceStatus#

subtotal :int#

tax :int#

total :int#

id :str#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.BillingInvoiceLine#

A line item on an invoice representing a particular purchase (such as a reservation) or aggregate usage for the invoice period.

Attributes:
amount (int): description (str): id (str): line_item_type (BillingInvoiceLineLineItemType): metadata (BillingInvoiceLineMetadata): quantity (int): invoice_item (Union[Unset, str]): price (Union[Unset, BillingPrice]): The price schedule for a particular service applied to an invoice line item. subscription (Union[Unset, str]): subscription_item (Union[Unset, str]):

amount :int#

description :str#

id :str#

line_item_type :qcs_api_client.models.billing_invoice_line_line_item_type.BillingInvoiceLineLineItemType#

metadata :qcs_api_client.models.billing_invoice_line_metadata.BillingInvoiceLineMetadata#

quantity :int#

invoice_item :Union[qcs_api_client.types.Unset, str]#

price :Union[qcs_api_client.types.Unset, qcs_api_client.models.billing_price.BillingPrice]#

subscription :Union[qcs_api_client.types.Unset, str]#

subscription_item :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.BillingInvoiceLineLineItemType#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Initialize self. See help(type(self)) for accurate signature.

INVOICEITEM = invoiceitem#

SUBSCRIPTION = subscription#

__str__() → str#: Return str(self).

class qcs_api_client.models.BillingInvoiceLineMetadata#

additional_properties :Dict[str, str]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → str#

__setitem__(key: str, value: str) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.BillingInvoiceStatus#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Initialize self. See help(type(self)) for accurate signature.

DRAFT = draft#

OPEN = open#

PAID = paid#

UNCOLLECTIBLE = uncollectible#

VOID = void#

__str__() → str#: Return str(self).

class qcs_api_client.models.BillingPrice#

The price schedule for a particular service applied to an invoice line item.

id#

Unique identifier for the object.

Type: str

active#

Whether the price can be used for new purchases.

Type: Union[Unset, bool]

billing_scheme#

Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unitAmount or unitAmountDecimal) will be charged per unit in quantity (for prices with usageType=licensed), or per unit of total usage (for prices with usageType=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiersMode attributes.

Type: Union[Unset, BillingPriceScheme]

object_#

String representing the object’s type. Objects of the same type share the same value.

Type: Union[Unset, BillingPriceObject]

price_type#

One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.

Type: Union[Unset, BillingPricePriceType]

product#

A QCS service product. This may represent one time (such as reservations) or metered services.

Type: Union[Unset, BillingProduct]

recurring#

The recurring components of a price such as interval and usageType.

Type: Union[Unset, BillingPriceRecurrence]

tiers#

Each element represents a pricing tier. This parameter requires billingScheme to be set to tiered. See also the documentation for billingScheme.

Type: Union[Unset, List[Tier]]

tiers_mode#

Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price, in graduated tiering pricing can successively change as the quantity grows.

Type: Union[Unset, BillingPriceTiersMode]

unit_amount_decimal#

The unit amount in currency to be charged. Only set if billingScheme=per_unit.

Type: Union[Unset, float]

id :str#

active :Union[qcs_api_client.types.Unset, bool]#

billing_scheme :Union[qcs_api_client.types.Unset, qcs_api_client.models.billing_price_scheme.BillingPriceScheme]#

object_ :Union[qcs_api_client.types.Unset, qcs_api_client.models.billing_price_object.BillingPriceObject]#

price_type :Union[qcs_api_client.types.Unset, qcs_api_client.models.billing_price_price_type.BillingPricePriceType]#

product :Union[qcs_api_client.types.Unset, qcs_api_client.models.billing_product.BillingProduct]#

recurring :Union[qcs_api_client.types.Unset, qcs_api_client.models.billing_price_recurrence.BillingPriceRecurrence]#

tiers :Union[qcs_api_client.types.Unset, List[qcs_api_client.models.tier.Tier]]#

tiers_mode :Union[qcs_api_client.types.Unset, qcs_api_client.models.billing_price_tiers_mode.BillingPriceTiersMode]#

unit_amount_decimal :Union[qcs_api_client.types.Unset, float]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.BillingPriceObject#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Initialize self. See help(type(self)) for accurate signature.

PRICE = price#

__str__() → str#: Return str(self).

class qcs_api_client.models.BillingPricePriceType#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Initialize self. See help(type(self)) for accurate signature.

ONE_TIME = one_time#

RECURRING = recurring#

__str__() → str#: Return str(self).

class qcs_api_client.models.BillingPriceRecurrence#

The recurring components of a price such as interval and usageType.

interval#

Type: BillingPriceRecurrenceInterval

aggregate_usage#

Type: Union[Unset, BillingPriceRecurrenceAggregateUsage]

interval_count#

Type: Union[Unset, int]

usage_type#

Type: Union[Unset, BillingPriceRecurrenceUsageType]

interval :qcs_api_client.models.billing_price_recurrence_interval.BillingPriceRecurrenceInterval#

aggregate_usage :Union[qcs_api_client.types.Unset, qcs_api_client.models.billing_price_recurrence_aggregate_usage.BillingPriceRecurrenceAggregateUsage]#

interval_count :Union[qcs_api_client.types.Unset, int]#

usage_type :Union[qcs_api_client.types.Unset, qcs_api_client.models.billing_price_recurrence_usage_type.BillingPriceRecurrenceUsageType]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.BillingPriceRecurrenceAggregateUsage#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Initialize self. See help(type(self)) for accurate signature.

LAST_DURING_PERIOD = last_during_period#

LAST_EVER = last_ever#

MAX = max#

SUM = sum#

__str__() → str#: Return str(self).

class qcs_api_client.models.BillingPriceRecurrenceInterval#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Initialize self. See help(type(self)) for accurate signature.

DAY = day#

MONTH = month#

WEEK = week#

YEAR = year#

__str__() → str#: Return str(self).

class qcs_api_client.models.BillingPriceRecurrenceUsageType#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Initialize self. See help(type(self)) for accurate signature.

LICENSED = licensed#

METERED = metered#

__str__() → str#: Return str(self).

class qcs_api_client.models.BillingPriceScheme#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Initialize self. See help(type(self)) for accurate signature.

PER_UNIT = per_unit#

TIERED = tiered#

__str__() → str#: Return str(self).

class qcs_api_client.models.BillingPriceTiersMode#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Initialize self. See help(type(self)) for accurate signature.

GRADUATED = graduated#

VOLUME = volume#

__str__() → str#: Return str(self).

class qcs_api_client.models.BillingProduct#

A QCS service product. This may represent one time (such as reservations) or metered services.

id#

Unique identifier for the object.

Type: str

name#

This name will show up on associated invoice line item descriptions.

Type: str

object_#

String representing the object’s type. Objects of the same type share the same value.

Type: BillingProductObject

description#

Type: Union[Unset, str]

unit_label#

A label that represents units of this product. When set, this will be included in associated invoice line item descriptions.

Type: Union[Unset, str]

id :str#

name :str#

object_ :qcs_api_client.models.billing_product_object.BillingProductObject#

description :Union[qcs_api_client.types.Unset, str]#

unit_label :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.BillingProductObject#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Initialize self. See help(type(self)) for accurate signature.

PRODUCT = product#

__str__() → str#: Return str(self).

class qcs_api_client.models.BillingUpcomingInvoice#

An unfinalized billing invoice.

period_end#

Type: datetime.datetime

period_start#

Type: datetime.datetime

starting_balance#

Type: int

status#

Type: BillingInvoiceStatus

subtotal#

Type: int

tax#

Type: int

total#

Type: int

period_end :datetime.datetime#

period_start :datetime.datetime#

starting_balance :int#

status :qcs_api_client.models.billing_invoice_status.BillingInvoiceStatus#

subtotal :int#

tax :int#

total :int#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.Characteristic#

A measured characteristic of an operation.

name#

The name of the characteristic.

Type: str

timestamp#

The date and time at which the characteristic was measured.

Type: datetime.datetime

value#

The characteristic value measured.

Type: float

error#

The error in the characteristic value, or None otherwise.

Type: Union[Unset, float]

node_ids#

The list of architecture node ids for the site where the characteristic is measured, if that is different from the site of the enclosing operation. None if it is the same. The order of this or the enclosing node ids obey the definition of node symmetry from the enclosing operation.

Type: Union[Unset, List[int]]

parameter_values#

The optional ordered list of parameter values used to generate the characteristic. The order matches the parameters in the enclosing operation, and so the lengths of these two lists must match.

Type: Union[Unset, List[float]]

name :str#

timestamp :datetime.datetime#

value :float#

error :Union[qcs_api_client.types.Unset, float]#

node_ids :Union[qcs_api_client.types.Unset, List[int]]#

parameter_values :Union[qcs_api_client.types.Unset, List[float]]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

class qcs_api_client.models.CheckClientApplicationRequest#

name#

Name of component

Type: str

version#

Semantic version of component.

Type: str

name :str#

version :str#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.CheckClientApplicationResponse#

is_latest_version#

Type: bool

is_update_required#

Set to true if component is not at latest version.

Type: bool

message#

Type: str

is_latest_version :bool#

is_update_required :bool#

message :str#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.ChecksumDescription#

header_name#

Type: str

type#

Type: ChecksumDescriptionType

header_name :str#

type :qcs_api_client.models.checksum_description_type.ChecksumDescriptionType#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.ChecksumDescriptionType#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Initialize self. See help(type(self)) for accurate signature.

MD5 = md5#

__str__() → str#: Return str(self).

class qcs_api_client.models.ClientApplication#

latest_version#

Semantic version

Type: str

name#

Type: str

supported#

Type: bool

details_uri#

Type: Union[Unset, str]

links#

Type: Union[Unset, List[ClientApplicationsDownloadLink]]

minimum_version#

Semantic version

Type: Union[Unset, str]

latest_version :str#

name :str#

supported :bool#

details_uri :Union[qcs_api_client.types.Unset, str]#

links :Union[qcs_api_client.types.Unset, List[qcs_api_client.models.client_applications_download_link.ClientApplicationsDownloadLink]]#

minimum_version :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.ClientApplicationsDownloadLink#

url#

Type: str

checksum_description#

Type: Union[Unset, ChecksumDescription]

platform#

Type: Union[Unset, str]

url :str#

checksum_description :Union[qcs_api_client.types.Unset, qcs_api_client.models.checksum_description.ChecksumDescription]#

platform :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.CreateEndpointParameters#

A publicly available set of parameters for defining an endpoint.

datacenters#

Which datacenters are available for endpoint placement. Defaults to berkeley-775

Type: Union[Unset, List[NomadJobDatacenters]]

quantum_processor_ids#

Public identifiers for quantum processors served by this endpoint.

Type: Union[Unset, List[str]]

datacenters :Union[qcs_api_client.types.Unset, List[qcs_api_client.models.nomad_job_datacenters.NomadJobDatacenters]]#

quantum_processor_ids :Union[qcs_api_client.types.Unset, List[str]]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.CreateEngagementRequest#

account_id#

Either the client’s user ID or the name of a group on behalf of which the client wishes to engage. This value will override any values set in the headers.

Type: Union[Unset, str]

account_type#

There are two types of accounts within QCS: user (representing a single user in Okta) and group (representing one or more users in Okta).

Type: Union[Unset, AccountType]

endpoint_id#

Unique, opaque identifier for the endpoint

Type: Union[Unset, str]

quantum_processor_id#

Public identifier for a quantum processor [example: Aspen-1]

Type: Union[Unset, str]

tags#

Tags recorded on QPU requests, which reporting services may later use for querying usage records.

Type: Union[Unset, List[str]]

account_id :Union[qcs_api_client.types.Unset, str]#

account_type :Union[qcs_api_client.types.Unset, qcs_api_client.models.account_type.AccountType]#

endpoint_id :Union[qcs_api_client.types.Unset, str]#

quantum_processor_id :Union[qcs_api_client.types.Unset, str]#

tags :Union[qcs_api_client.types.Unset, List[str]]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.CreateReservationRequest#

end_time#

Type: datetime.datetime

quantum_processor_id#

Type: str

start_time#

Type: datetime.datetime

account_id#

userId for accountType “user”, group name for accountType “group”.

Type: Union[Unset, str]

account_type#

There are two types of accounts within QCS: user (representing a single user in Okta) and group (representing one or more users in Okta).

Type: Union[Unset, AccountType]

notes#

Type: Union[Unset, str]

end_time :datetime.datetime#

quantum_processor_id :str#

start_time :datetime.datetime#

account_id :Union[qcs_api_client.types.Unset, str]#

account_type :Union[qcs_api_client.types.Unset, qcs_api_client.models.account_type.AccountType]#

notes :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.Dictionary#

Generic, arbitrary Dictionary

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.Edge#

A degree-two logical connection in the quantum processor’s architecture.

The existence of an edge in the ISA Architecture does not necessarily mean that a given 2Q operation will be available on the edge. This information is conveyed by the presence of the two node_id values in instances of Instruction.

Note that edges are undirected in this model. Thus edge \((a, b)\) is equivalent to edge \((b, a)\).

Attributes:

node_ids (List[int]): The integer ids of the computational nodes at the two ends of the edge. Order is not
important; an architecture edge is treated as undirected.

node_ids :List[int]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

class qcs_api_client.models.Endpoint#

An Endpoint is the entry point for remote access to a QuantumProcessor.

addresses#

Addresses at which an endpoint is reachable over the network.

Type: EndpointAddresses

healthy#

Whether the endpoint is operating as intended

Type: bool

id#

Unique, opaque identifier for the endpoint

Type: str

mock#

Whether the endpoint serves simulated or substituted data for testing purposes

Type: bool

address#

Network address at which the endpoint is locally reachable

Type: Union[Unset, None, str]

datacenter#

Datacenter within which the endpoint is deployed

Type: Union[Unset, str]

quantum_processor_ids#

Public identifiers for quantum processors served by this endpoint.

Type: Union[Unset, List[str]]

addresses :qcs_api_client.models.endpoint_addresses.EndpointAddresses#

healthy :bool#

id :str#

mock :bool#

address :Union[qcs_api_client.types.Unset, None, str]#

datacenter :Union[qcs_api_client.types.Unset, str]#

quantum_processor_ids :Union[qcs_api_client.types.Unset, List[str]]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.EndpointAddresses#

Addresses at which an endpoint is reachable over the network.

grpc#

Type: Union[Unset, str]

rpcq#

Type: Union[Unset, str]

grpc :Union[qcs_api_client.types.Unset, str]#

rpcq :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.EngagementCredentials#

Credentials are the ZeroMQ CURVE Keys used to encrypt the connection with the Quantum Processor Endpoint.

Attributes:
client_public (str): client_secret (str): server_public (str):

client_public :str#

client_secret :str#

server_public :str#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.EngagementWithCredentials#

An engagement is the authorization of a user to execute work on a Quantum Processor Endpoint.

address#

The network address of the endpoint to which this engagement grants access

Type: str

credentials#

Credentials are the ZeroMQ CURVE Keys used to encrypt the connection with the Quantum Processor Endpoint.

Type: EngagementCredentials

endpoint_id#

The ID of the endpoint to which this engagement grants access

Type: str

expires_at#

Time after which the engagement is no longer valid. Given in RFC3339 format.

Type: str

user_id#

Type: str

account_id#

User ID or group name on behalf of which the engagement is made.

Type: Union[Unset, str]

account_type#

There are two types of accounts within QCS: user (representing a single user in Okta) and group (representing one or more users in Okta).

Type: Union[Unset, AccountType]

minimum_priority#

The minimum priority value allowed for execution

Type: Union[Unset, int]

quantum_processor_ids#

The quantum processors for which this engagement enables access and execution

Type: Union[Unset, List[str]]

tags#

Tags recorded on QPU requests and recorded on usage records.

Type: Union[Unset, List[str]]

address :str#

credentials :qcs_api_client.models.engagement_credentials.EngagementCredentials#

endpoint_id :str#

expires_at :str#

user_id :str#

account_id :Union[qcs_api_client.types.Unset, str]#

account_type :Union[qcs_api_client.types.Unset, qcs_api_client.models.account_type.AccountType]#

minimum_priority :Union[qcs_api_client.types.Unset, int]#

quantum_processor_ids :Union[qcs_api_client.types.Unset, List[str]]#

tags :Union[qcs_api_client.types.Unset, List[str]]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.Error#

code#

Type: str

message#

Type: str

request_id#

Type: str

validation_errors#

Type: Union[Unset, List[ValidationError]]

code :str#

message :str#

request_id :str#

validation_errors :Union[qcs_api_client.types.Unset, List[qcs_api_client.models.validation_error.ValidationError]]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.Family#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Initialize self. See help(type(self)) for accurate signature.

NONE = None#

FULL = Full#

ASPEN = Aspen#

ANKAA = Ankaa#

__str__() → str#: Return str(self).

class qcs_api_client.models.FindAvailableReservationsResponse#

available_reservations#

Type: List[AvailableReservation]

next_page_token#

Type: Union[Unset, str]

available_reservations :List[qcs_api_client.models.available_reservation.AvailableReservation]#

next_page_token :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.GetQuiltCalibrationsResponse#

quilt#

Calibrations suitable for use in a Quil-T program

Type: str

settings_timestamp#

ISO8601 timestamp of the settings used to generate these calibrations

Type: Union[Unset, str]

quilt :str#

settings_timestamp :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.Group#

created_time#

Type: datetime.datetime

description#

Type: str

id#

Type: str

last_membership_updated_time#

Type: datetime.datetime

name#

Type: str

updated_time#

Type: datetime.datetime

created_time :datetime.datetime#

description :str#

id :str#

last_membership_updated_time :datetime.datetime#

name :str#

updated_time :datetime.datetime#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.Health#

status#

Example: PASS.

Type: str

status :str#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.InstructionSetArchitecture#

The native instruction set architecture of a quantum processor, annotated with characteristics.

The operations described by the instructions field are named by their QUIL instruction name, while the operation described by the benchmarks field are named by their benchmark routine and are a future extension point that will be populated in future iterations.

The characteristics that annotate both instructions and benchmarks assist the user to generate the best native QUIL program for a desired task, and so are provided as part of the native ISA.

Attributes:
architecture (Architecture): Represents the logical underlying architecture of a quantum processor.

The architecture is defined in detail by the nodes and edges that constitute the quantum processor. This defines the set of all nodes that could be operated upon, and indicates to some approximation their physical layout. The main purpose of this is to support geometry calculations that are independent of the available operations, and rendering ISA-based information. Architecture layouts are defined by the family, as follows.

The “Aspen” family of quantum processor indicates a 2D planar grid layout of octagon unit cells. The node_id in this architecture is computed as \(100 p_y + 10 p_x + p_u\) where \(p_y\) is the zero-based Y position in the unit cell grid, \(p_x\) is the zero-based X position in the unit cell grid, and \(p_u\) is the zero-based position in the octagon unit cell and always ranges from 0 to 7. This scheme has a natural size limit of a 10x10 unit cell grid, which permits the architecture to scale up to 800 nodes.

Note that the operations that are actually available are defined entirely by Operation instances. The presence of a node or edge in the Architecture model provides no guarantee that any 1Q or 2Q operation will be available to users writing QUIL programs.

benchmarks (List[Operation]): The list of benchmarks that have characterized the quantum processor. instructions (List[Operation]): The list of native QUIL instructions supported by the quantum processor. name (str): The name of the quantum processor.

architecture :qcs_api_client.models.architecture.Architecture#

benchmarks :List[qcs_api_client.models.operation.Operation]#

instructions :List[qcs_api_client.models.operation.Operation]#

name :str#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

class qcs_api_client.models.InviteUserRequest#

email#

Type: str

group_name#

Type: Union[Unset, str]

email :str#

group_name :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.ListAccountBillingInvoiceLinesResponse#

billing_invoice_lines#

Type: List[BillingInvoiceLine]

next_page_token#

Type: Union[Unset, str]

billing_invoice_lines :List[qcs_api_client.models.billing_invoice_line.BillingInvoiceLine]#

next_page_token :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.ListAccountBillingInvoicesResponse#

billing_invoices#

Type: List[BillingInvoice]

next_page_token#

Type: Union[Unset, str]

billing_invoices :List[qcs_api_client.models.billing_invoice.BillingInvoice]#

next_page_token :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.ListClientApplicationsResponse#

client_applications#

Type: List[ClientApplication]

client_applications :List[qcs_api_client.models.client_application.ClientApplication]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.ListEndpointsResponse#

endpoints#

Type: List[Endpoint]

next_page_token#

Opaque token indicating the start of the next page of results to return; do not decode

Type: Union[Unset, str]

endpoints :List[qcs_api_client.models.endpoint.Endpoint]#

next_page_token :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.ListGroupUsersResponse#

users#

Type: List[User]

next_page_token#

Type: Union[Unset, str]

users :List[qcs_api_client.models.user.User]#

next_page_token :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.ListGroupsResponse#

groups#

Type: List[Group]

next_page_token#

Type: Union[Unset, str]

groups :List[qcs_api_client.models.group.Group]#

next_page_token :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.ListQuantumProcessorAccessorsResponse#

accessors#

Methods of accessing the relevant Quantum Processor

Type: List[QuantumProcessorAccessor]

next_page_token#

Opaque token indicating the start of the next page of results to return; do not decode

Type: Union[Unset, str]

accessors :List[qcs_api_client.models.quantum_processor_accessor.QuantumProcessorAccessor]#

next_page_token :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.ListQuantumProcessorsResponse#

quantum_processors#

Type: List[QuantumProcessor]

next_page_token#

Opaque token indicating the start of the next page of results to return; do not decode

Type: Union[Unset, str]

quantum_processors :List[qcs_api_client.models.quantum_processor.QuantumProcessor]#

next_page_token :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.ListReservationsResponse#

next_page_token#

Type: str

reservations#

Type: List[Reservation]

next_page_token :str#

reservations :List[qcs_api_client.models.reservation.Reservation]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.Node#

A logical node in the quantum processor’s architecture.

The existence of a node in the ISA Architecture does not necessarily mean that a given 1Q operation will be available on the node. This information is conveyed by the presence of the specific node_id in instances of Instruction.

Attributes:

node_id (int): An integer id assigned to the computational node. The ids may not be contiguous and will be
assigned based on the architecture family.

node_id :int#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

class qcs_api_client.models.NomadJobDatacenters#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Initialize self. See help(type(self)) for accurate signature.

BERKELEY_775 = berkeley-775#

FREMONT_FAB = fremont-fab#

OXFORD_INSTRUMENTS = oxford-instruments#

__str__() → str#: Return str(self).

class qcs_api_client.models.Operation#

An operation, with its sites and site-independent characteristics.

characteristics#

The list of site-independent characteristics of this operation.

Type: List[Characteristic]

name#

The name of the operation.

Type: str

parameters#

The list of parameters. Each parameter must be uniquely named. May be empty.

Type: List[Parameter]

sites#

The list of sites at which this operation can be applied, together with its site- dependent characteristics.

Type: List[OperationSite]

node_count#

The number of nodes that this operation applies to. None if unspecified.

Type: Union[Unset, int]

characteristics :List[qcs_api_client.models.characteristic.Characteristic]#

name :str#

parameters :List[qcs_api_client.models.parameter.Parameter]#

sites :List[qcs_api_client.models.operation_site.OperationSite]#

node_count :Union[qcs_api_client.types.Unset, int]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

class qcs_api_client.models.OperationSite#

A site for an operation, with its site-dependent characteristics.

characteristics#

The list of site-dependent characteristics of this operation.

Type: List[Characteristic]

node_ids#

The list of architecture node ids for the site. The order of these node ids obey the definition of node symmetry from the enclosing operation.

Type: List[int]

characteristics :List[qcs_api_client.models.characteristic.Characteristic]#

node_ids :List[int]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

class qcs_api_client.models.Parameter#

A parameter to an operation.

name#

The name of the parameter, such as the name of a mathematical symbol.

Type: str

name :str#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

class qcs_api_client.models.ParameterSpec#

length#

Type: Union[Unset, int]

length :Union[qcs_api_client.types.Unset, int]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.QuantumProcessor#

id#

Immutable, unique identifier for a quantum processor [example: Aspen-1]

Type: str

id :str#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.QuantumProcessorAccessor#

Method of accessing an available QPU.

access_type#

Types of access mechanisms for a QPU. Each accessor type has its own access characteristics, benefits, and drawbacks.

Type: QuantumProcessorAccessorType

live#

Whether an accessor represents access to a physical, live quantum processor. When false, this accessor provides access instead to a simulated or test QPU.

Type: bool

url#

Address used to connect to the accessor.

Type: str

id#

Unique identifier for the accessor.

Type: Union[Unset, str]

rank#

Rank of this accessor against others for the same QPU. If two accessors both serve a client’s purposes, that with the lower rank value should be used for access.

Type: Union[Unset, int]

access_type :qcs_api_client.models.quantum_processor_accessor_type.QuantumProcessorAccessorType#

live :bool#

url :str#

id :Union[qcs_api_client.types.Unset, str]#

rank :Union[qcs_api_client.types.Unset, int]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.QuantumProcessorAccessorType#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Initialize self. See help(type(self)) for accurate signature.

GATEWAY_V1 = gateway.v1#

__str__() → str#: Return str(self).

class qcs_api_client.models.RemoveGroupUserRequest#

Must provide either userId or userEmail and groupId or groupName.

group_id#

Type: Union[Unset, str]

group_name#

Type: Union[Unset, str]

user_email#

Type: Union[Unset, str]

user_id#

Type: Union[Unset, str]

group_id :Union[qcs_api_client.types.Unset, str]#

group_name :Union[qcs_api_client.types.Unset, str]#

user_email :Union[qcs_api_client.types.Unset, str]#

user_id :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.Reservation#

account_id#

userId for accountType “user”, group name for accountType “group”.

Type: str

account_type#

There are two types of accounts within QCS: user (representing a single user in Okta) and group (representing one or more users in Okta).

Type: AccountType

created_time#

Type: datetime.datetime

end_time#

Type: datetime.datetime

id#

Type: int

price#

Type: int

quantum_processor_id#

Type: str

start_time#

Type: datetime.datetime

user_id#

Deprecated in favor of accountId.

Type: str

cancellation_billing_invoice_item_id#

Type: Union[Unset, str]

cancelled#

Type: Union[Unset, bool]

creation_billing_invoice_item_id#

Type: Union[Unset, str]

notes#

Type: Union[Unset, str]

updated_time#

Type: Union[Unset, datetime.datetime]

account_id :str#

account_type :qcs_api_client.models.account_type.AccountType#

created_time :datetime.datetime#

end_time :datetime.datetime#

id :int#

price :int#

quantum_processor_id :str#

start_time :datetime.datetime#

user_id :str#

cancellation_billing_invoice_item_id :Union[qcs_api_client.types.Unset, str]#

cancelled :Union[qcs_api_client.types.Unset, bool]#

creation_billing_invoice_item_id :Union[qcs_api_client.types.Unset, str]#

notes :Union[qcs_api_client.types.Unset, str]#

updated_time :Union[qcs_api_client.types.Unset, datetime.datetime]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.RestartEndpointRequest#

component_name#

Individual component to restart

Type: Union[Unset, str]

component_name :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.Tier#

up_to#

A value of -1 will imply that this tier is up to Infinity.

Type: int

flat_amount#

Type: Union[Unset, int]

flat_amount_decimal#

Type: Union[Unset, float]

unit_amount#

Type: Union[Unset, int]

unit_amount_decimal#

Type: Union[Unset, float]

up_to :int#

flat_amount :Union[qcs_api_client.types.Unset, int]#

flat_amount_decimal :Union[qcs_api_client.types.Unset, float]#

unit_amount :Union[qcs_api_client.types.Unset, int]#

unit_amount_decimal :Union[qcs_api_client.types.Unset, float]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.TranslateNativeQuilToEncryptedBinaryRequest#

num_shots#

Number of iterations to execute on the control hardware

Type: int

quil#

The native Quil program to be translated for execution

Type: str

settings_timestamp#

ISO8601 timestamp of the latest settings to be used in translation. If omitted, latest settings will be used.

Type: Union[Unset, str]

num_shots :int#

quil :str#

settings_timestamp :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.TranslateNativeQuilToEncryptedBinaryResponse#

program#

Encrypted binary built for execution on the target quantum processor

Type: str

memory_descriptors#

Type: Union[Unset, TranslateNativeQuilToEncryptedBinaryResponseMemoryDescriptors]

ro_sources#

Type: Union[Unset, List[List[str]]]

settings_timestamp#

ISO8601 timestamp of the settings used to translate the program. Translation is deterministic; a program translated twice with the same settings by the same version of the service will have identical output.

Type: Union[Unset, str]

program :str#

memory_descriptors :Union[qcs_api_client.types.Unset, qcs_api_client.models.translate_native_quil_to_encrypted_binary_response_memory_descriptors.TranslateNativeQuilToEncryptedBinaryResponseMemoryDescriptors]#

ro_sources :Union[qcs_api_client.types.Unset, List[List[str]]]#

settings_timestamp :Union[qcs_api_client.types.Unset, str]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.TranslateNativeQuilToEncryptedBinaryResponseMemoryDescriptors#

additional_properties :Dict[str, qcs_api_client.models.parameter_spec.ParameterSpec]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → qcs_api_client.models.parameter_spec.ParameterSpec#

__setitem__(key: str, value: qcs_api_client.models.parameter_spec.ParameterSpec) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.User#

created_time#

Type: datetime.datetime

id#

Type: int

idp_id#

Type: str

profile#

Type: Union[Unset, UserProfile]

created_time :datetime.datetime#

id :int#

idp_id :str#

profile :Union[qcs_api_client.types.Unset, qcs_api_client.models.user_profile.UserProfile]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.UserCredentials#

password#

Type: UserCredentialsPassword

password :qcs_api_client.models.user_credentials_password.UserCredentialsPassword#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.UserCredentialsPassword#

value#

Type: str

value :str#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.UserProfile#

email#

Type: str

first_name#

Type: str

last_name#

Type: str

organization#

Type: str

email :str#

first_name :str#

last_name :str#

organization :str#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.ValidationError#

in_#

Type: ValidationErrorIn

message#

Type: str

path#

Type: Union[Unset, List[str]]

in_ :qcs_api_client.models.validation_error_in.ValidationErrorIn#

message :str#

path :Union[qcs_api_client.types.Unset, List[str]]#

additional_properties :Dict[str, Any]#

to_dict(pick_by_predicate: Optional[Callable[[Any], bool]] = is_not_none) → Dict[str, Any]#

classmethod from_dict(src_dict: Dict[str, Any]) → T#

property additional_keys → List[str]#

__getitem__(key: str) → Any#

__setitem__(key: str, value: Any) → None#

__delitem__(key: str) → None#

__contains__(key: str) → bool#

class qcs_api_client.models.ValidationErrorIn#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Initialize self. See help(type(self)) for accurate signature.

HEADER = header#

QUERY = query#

PATH = path#

BODY = body#

__str__() → str#: Return str(self).

qcs_api_client.models#

Submodules#

Package Contents#

Classes#

`qcs_api_client.models`#