メインコンテンツへスキップ
量子インフラストラクチャ・クラウドのご紹介 詳しく見る

開発者HiQ / 使い方

APIとCLI

HiQプログラムは、QCOS APIを通じて検査、合成、コンパイル、公開されます。softqcosコマンドラインも同じルートを呼び出します。このページでは各ルートと、現在の本番環境での応答を一覧にしています。

認証

各ルートは、Softquantus Research Platformのワークスペースで発行したAPIキーを、X-API-Keyヘッダーで受け取ります。CLIは、QCOS_API_KEYからキーを読み込みます。ベースURLはhttps://api.softquantus.comです。

ルート

  • POST/api/v1/runtime/lang/check

    現在利用可能
    入力
    source、language(デフォルトはqcos/0)、include_ir
    戻り値
    ok、行と列付きのdiagnostics、capabilities、target_requirements、declared_qubits、peak_qubits、expanded_ops、gate_counts、depth、subroutines、指定時のir
  • POST/api/v1/runtime/lang/synthesize

    現在利用可能
    入力
    source(C)、entry、strategy(scoped、bennett、per_outputのいずれか)、include_ir
    戻り値
    ok、diagnostics、qcos_source、report、parameters、result、proof、指定時のir。実行は行いません
  • POST/api/v1/runtime/compile/program

    現在利用可能
    入力
    program(JSONテキストのirドキュメント)、targets、optimization_level(0から3)、include_artifact
    戻り値
    ターゲットごとに1つの結果を返します。プログラムを受け付けられないターゲットは、名前を挙げて拒否されます。実行は行いません
  • POST/api/v1/runtime/programs

    現在利用可能
    入力
    name, language, source, backend_id, shots, max_shot_budget
    戻り値
    検査済みのプログラムをこのワークスペースに公開します。エラーがある場合は、診断付きの422を返します。実行は行いません
  • GET/api/v1/runtime/programs

    現在利用可能
    入力
    なし(GETおよびDELETE /programs/{id}も同様)
    戻り値
    このワークスペースの公開済みプログラム。別のワークスペースのIDは404になります
  • POST/api/v1/runtime/run/program

    まだ利用できません
    入力
    program, backend_id, shots, max_shot_budget
    戻り値
    Softquantus Cloudシミュレーターでの実行結果と、その証拠
  • POST/api/v1/runtime/programs/{id}/invoke

    まだ利用できません
    入力
    reservation_ref(省略可)
    戻り値
    公開されたものをそのまま、run/programのすべてのゲートを通して実行します

コマンドライン

pip install softqcosでクライアントをインストールします。以下のコマンドはすべてsoftqcos langのサブコマンドです。

  • softqcos lang check FILE [--json]現在利用可能

    プログラムを検査します。エラーがあると終了コード1で終了します。コンパイルも実行も行いません。

  • softqcos lang synthesize FILE.c [--entry NAME] [--strategy scoped|bennett|per_output] [-o OUT.qcos]現在利用可能

    C関数1つを可逆オラクルに変換します。拒否された場合は終了コード1で終了します。

  • softqcos lang compile FILE --target ID [--target ID] [-O 0-3] [--artifact]現在利用可能

    プログラムを検査してから、ハードウェアプロファイル向けにコンパイルします。実行は行いません。

  • softqcos lang publish FILE --name NAME --backend ID --shots N --max-shot-budget N現在利用可能

    このワークスペースのどのキーからでもIDで見つけられるよう、プログラムを公開します。実行は行いません。

  • softqcos lang programs現在利用可能

    このワークスペースの公開済みプログラムを一覧表示します。

  • softqcos lang run FILE --backend ID --shots N --max-shot-budget Nまだ利用できません

    プログラムを検査してから、Softquantus Cloudシミュレーターで実行します。現在、本番環境では拒否されます。

  • softqcos lang invoke IDまだ利用できません

    公開済みのプログラムを実行します。現在、本番環境では拒否されます。

最初のリクエスト

クイックスタートと同じ検査を、APIに直接送ります:

ターミナル
curl -X POST https://api.softquantus.com/api/v1/runtime/lang/check \
  -H "X-API-Key: $QCOS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"language": "qcos/0", "source": "program bell\nqubits a, b\nbits m0, m1\nh a\ncx a, b\nmeasure a -> m0\nmeasure b -> m1"}'

応答には、ok、行と列付きのdiagnostics、そしてdeclared_qubits、peak_qubits、expanded_ops、depth、gate_countsの各カウントが含まれます。"include_ir": trueを追加すると、qcos-ir/2ドキュメントが得られます。これはcompile/programが受け付けるものです。