9个版本

0.2.1	2022年8月9日
0.2.0	2022年8月9日
0.0.7	2022年7月28日
0.0.6	2022年6月16日
0.0.2	2021年10月19日

#6 in #rigetti

2,740 每月下载量
用于 qcs

Apache-2.0

380KB
4K SLoC

Rust API客户端用于openapi

简介

这是Rigetti QCS HTTP API的文档。

您可以在https://rigetti.com了解更多关于Rigetti的信息，还可以通过https://qcs.rigetti.com在网页上与QCS交互。

该API以OpenAPI格式进行文档编写，因此与此处和网上其他地方提供的数十种语言特定的客户端生成器兼容。

原则

该API在适当的情况下遵循REST设计原则，否则采用HTTP RPC范例。我们遵循Google API改进提案，以提供一致、直观的开发者体验。HTTP响应代码符合其规范，错误消息符合通用格式。

身份验证

所有对QCS API的访问都需要由Okta提供的OAuth2身份验证。您可以在此处请求访问。一旦您拥有用户账户，您就可以从QCS 此处下载您的访问令牌。

该访问令牌自签发之日起有效期为24小时。JSON文件中access_token的值是用于身份验证的令牌（不要使用整个JSON文件）。

使用带有Authorization头和Bearer前缀的身份验证请求

curl --header \"Authorization: Bearer eyJraW...Iow\"

量子处理器访问

通过此HTTP API直接提供对量子处理器的访问尚未提供，而是通过ZeroMQ/rpcq执行。在发生变化之前，我们建议使用pyquil通过Legacy API构建和执行量子程序。

Legacy API

我们的Legacy HTTP API仍然可在https://forest-server.qcs.rigetti.com访问，并且它与该API的服务共享同一数据源。您可以使用这两个服务，使用相同的用户账户和身份验证方式。我们强烈建议使用此处记录的API，因为Legacy API正在走向弃用。

有关更多信息，请访问https://rigetti.zendesk.com

概述

此API客户端是由OpenAPI Generator项目生成的。通过使用远程服务器上的openapi-spec，您可以轻松生成API客户端。

API版本：2020-07-31
包版本：2020-07-31
构建包：org.openapitools.codegen.languages.RustClientCodegen

安装

将包放入项目文件夹中名为openapi的目录下，并在Cargo.toml中添加以下内容到[dependencies]

openapi = { path = "./openapi" }

API端点文档

所有URI都是相对于https://api.qcs.rigetti.com

类	方法	HTTP请求	描述
AccountApi	add_group_user	POST /v1/groups:addUser	将用户添加到组中
AccountApi	get_group_balance	GET /v1/groups/{groupName}/balance	获取组余额
AccountApi	get_group_billing_customer	GET /v1/groups/{groupName}/billingCustomer
AccountApi	获取即将到来的账单	GET /v1/groups/{groupName}/billingInvoices:getUpcoming
AccountApi	get_user_balance	GET /v1/users/{userId}/balance	获取用户余额
AccountApi	get_user_billing_customer	GET /v1/users/{userId}/billingCustomer
AccountApi	获取即将到来的账单	GET /v1/users/{userId}/billingInvoices:getUpcoming
AccountApi	list_group_billing_invoice_lines	GET /v1/groups/{groupName}/billingInvoices/{billingInvoiceId}/lines
AccountApi	list_group_billing_invoices	GET /v1/groups/{groupName}/billingInvoices
AccountApi	list_group_upcoming_billing_invoice_lines	GET /v1/groups/{groupName}/billingInvoices:listUpcomingLines
AccountApi	list_group_users	GET /v1/groups/{groupName}/users	列出属于组的用户
AccountApi	list_user_billing_invoice_lines	GET /v1/users/{userId}/billingInvoices/{billingInvoiceId}/lines
AccountApi	list_user_billing_invoices	GET /v1/users/{userId}/billingInvoices
AccountApi	list_user_groups	GET /v1/users/{userId}/groups	列出请求用户的QCS组
AccountApi	list_user_upcoming_billing_invoice_lines	GET /v1/users/{userId}/billingInvoices:listUpcomingLines
AccountApi	remove_group_user	POST /v1/groups:removeUser	从组中删除用户。
AuthenticationApi	auth_email_password_reset_token	POST /v1/auth:emailPasswordResetToken	电子邮件密码重置令牌
AuthenticationApi	auth_get_user	GET /v1/auth:getUser	获取用户
AuthenticationApi	auth_reset_password	POST /v1/auth:resetPassword	重置密码
AuthenticationApi	auth_reset_password_with_token	POST /v1/auth:resetPasswordWithToken	使用令牌重置密码
ClientApplicationsApi	check_client_application	POST /v1/clientApplications:check	检查客户端应用程序
ClientApplicationsApi	get_client_application	GET /v1/clientApplications/{clientApplicationName}	获取客户端应用程序
ClientApplicationsApi	list_client_applications	GET /v1/clientApplications	列出客户端应用程序
DefaultApi	get_health	GET /
DefaultApi	health_check	GET /v1/	健康检查
EndpointsApi	create_endpoint	POST /v1/endpoints	创建端点
EndpointsApi	delete_endpoint	DELETE /v1/endpoints/{endpointId}	删除端点
EndpointsApi	get_default_endpoint	GET /v1/quantumProcessors/{quantumProcessorId}/endpoints:getDefault	获取默认端点
EndpointsApi	get_endpoint	GET /v1/endpoints/{endpointId}	获取端点
EndpointsApi	list_endpoints	GET /v1/endpoints	列出端点
EndpointsApi	restart_endpoint	POST /v1/endpoints/{endpointId}:restart	重启端点
EngagementsApi	create_engagement	POST /v1/engagements	创建参与
QuantumProcessorsApi	get_instruction_set_architecture	GET /v1/quantumProcessors/{quantumProcessorId}/instructionSetArchitecture	获取指令集架构
QuantumProcessorsApi	get_quantum_processor	GET /v1/quantumProcessors/{quantumProcessorId}	获取量子处理器
QuantumProcessorsApi	量子处理器列表	GET /v1/quantumProcessors	列出量子处理器
ReservationsApi	创建预约	POST /v1/reservations	创建预约
ReservationsApi	删除预约	DELETE /v1/reservations/{reservationId}	删除预约
ReservationsApi	查找可用预约	GET /v1/reservations:findAvailable	查找可用预约
ReservationsApi	列出分组预约	GET /v1/groups/{groupName}/reservations	列出分组预约
ReservationsApi	列出预约	GET /v1/reservations	列出预约
TranslationApi	获取绗缝校准	GET /v1/quantumProcessors/{quantumProcessorId}/quiltCalibrations	获取绗缝校准
TranslationApi	将本地Quil转换为加密二进制文件	POST /v1/quantumProcessors/{quantumProcessorId}:translateNativeQuilToEncryptedBinary	将本地Quil转换为加密二进制文件

模型文档

要获取生成文档的访问权限，请使用

cargo doc --open

作者

[email protected]

依赖关系

~4-15MB
~231K SLoC