Lib.rs

› Web编程 › qcs-api
#quantum #qcs #rigetti #api-client #http-client #api-bindings #http-api

qcs-api-client-openapi

自动生成的QCS OpenAPI绑定

所有者 rigetti-githubbot.

39个版本

新 0.9.8-rc.0 2024年8月7日
0.9.7 2024年7月18日
0.8.15 2024年5月9日
0.8.13 2024年3月21日
0.3.8 2022年11月30日

#150 in Web编程

Download history 507/week @ 2024-04-20 1221/week @ 2024-04-27 792/week @ 2024-05-04 935/week @ 2024-05-11 415/week @ 2024-05-18 292/week @ 2024-05-25 448/week @ 2024-06-01 620/week @ 2024-06-08 810/week @ 2024-06-15 832/week @ 2024-06-22 696/week @ 2024-06-29 1289/week @ 2024-07-06 819/week @ 2024-07-13 870/week @ 2024-07-20 1448/week @ 2024-07-27 1063/week @ 2024-08-03

4,504 每月下载
用于 qcs

Apache-2.0

720KB
10K SLoC

Rust开放API客户端

简介

这是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中的以下部分添加以下内容：

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_group_upcoming_billing_invoice 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_user_event_billing_price POST /v1/users/{userId}/eventBillingPrices:get
AccountApi get_user_upcoming_billing_invoice 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/healthcheck 健康检查
DefaultApi health_check_deprecated 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 list_quantum_processor_accessors GET /v1/quantumProcessors/{quantumProcessorId}/accessors 列出量子处理器访问器
QuantumProcessorsApi list_quantum_processors GET /v1/quantumProcessors 列出量子处理器
ReservationsApi create_reservation POST /v1/reservations 创建预约
ReservationsApi delete_reservation DELETE /v1/reservations/{reservationId} 删除预约
ReservationsApi find_available_reservations GET /v1/reservations:findAvailable 查找可用的预约
ReservationsApi list_group_reservations GET /v1/groups/{groupName}/reservations 列出分组预约
ReservationsApi list_reservations GET /v1/reservations 列出预约
TranslationApi get_quilt_calibrations GET /v1/quantumProcessors/{quantumProcessorId}/quiltCalibrations 获取拼布校准
TranslationApi translate_native_quil_to_encrypted_binary POST /v1/quantumProcessors/{quantumProcessorId}:translateNativeQuilToEncryptedBinary 将本地Quil转换为加密二进制文件

模型文档

要获取生成的文档，请使用

cargo doc --open

作者

[email protected]

依赖项

~8–22MB
~357K SLoC