Aller au contenu principal
Découvrez le cloud d'infrastructure quantique En savoir plus

DéveloppeursHiQ / L'utiliser

API et CLI

Les programmes HiQ sont vérifiés, synthétisés, compilés et publiés via l'API QCOS. La ligne de commande softqcos appelle les mêmes routes. Cette page liste chacune d'elles et ce que la production répond aujourd'hui pour elle.

Authentification

Chaque route prend une clé d'API de votre espace de travail sur la Softquantus Research Platform dans l'en-tête X-API-Key. La CLI lit la clé depuis QCOS_API_KEY. L'URL de base est https://api.softquantus.com.

Routes

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

    Disponible aujourd'hui
    Entrée
    source, language (qcos/0 par défaut), include_ir
    Sortie
    ok, diagnostics avec ligne et colonne, capabilities, target_requirements, declared_qubits, peak_qubits, expanded_ops, gate_counts, depth, subroutines, et ir sur demande
  • POST/api/v1/runtime/lang/synthesize

    Disponible aujourd'hui
    Entrée
    source (C), entry, strategy (scoped, bennett ou per_output), include_ir
    Sortie
    ok, diagnostics, qcos_source, report, parameters, result, proof, et ir sur demande. Rien n'est exécuté
  • POST/api/v1/runtime/compile/program

    Disponible aujourd'hui
    Entrée
    program (le document ir sous forme de texte JSON), targets, optimization_level de 0 à 3, include_artifact
    Sortie
    Un résultat par cible. Une cible qui ne peut pas accepter le programme est refusée, avec son nom. Rien n'est exécuté
  • POST/api/v1/runtime/programs

    Disponible aujourd'hui
    Entrée
    name, language, source, backend_id, shots, max_shot_budget
    Sortie
    Publie un programme vérifié dans cet espace de travail ; 422 avec les diagnostics en cas d'erreurs. Rien n'est exécuté
  • GET/api/v1/runtime/programs

    Disponible aujourd'hui
    Entrée
    aucun (également GET et DELETE /programs/{id})
    Sortie
    Les programmes publiés de cet espace de travail ; l'identifiant d'un autre espace de travail donne 404
  • POST/api/v1/runtime/run/program

    Pas encore ouvert
    Entrée
    program, backend_id, shots, max_shot_budget
    Sortie
    Le résultat d'une exécution sur un simulateur Softquantus Cloud, et ses preuves
  • POST/api/v1/runtime/programs/{id}/invoke

    Pas encore ouvert
    Entrée
    reservation_ref (facultatif)
    Sortie
    Exécute exactement ce qui a été publié, à travers toutes les barrières de run/program

Ligne de commande

Installez le client avec pip install softqcos. Chaque commande ci-dessous est une sous-commande de softqcos lang.

  • softqcos lang check FILE [--json]Disponible aujourd'hui

    Vérifier un programme. Se termine avec le code 1 s'il contient des erreurs. Rien n'est compilé ni exécuté.

  • softqcos lang synthesize FILE.c [--entry NAME] [--strategy scoped|bennett|per_output] [-o OUT.qcos]Disponible aujourd'hui

    Transformer une fonction C en oracle réversible. Se termine avec le code 1 si elle est refusée.

  • softqcos lang compile FILE --target ID [--target ID] [-O 0-3] [--artifact]Disponible aujourd'hui

    Vérifier un programme, puis le compiler pour des profils matériels. Rien n'est exécuté.

  • softqcos lang publish FILE --name NAME --backend ID --shots N --max-shot-budget NDisponible aujourd'hui

    Publier un programme pour que toute clé de cet espace de travail puisse le retrouver par son identifiant. Rien n'est exécuté.

  • softqcos lang programsDisponible aujourd'hui

    Lister les programmes publiés de cet espace de travail.

  • softqcos lang run FILE --backend ID --shots N --max-shot-budget NPas encore ouvert

    Vérifier un programme, puis l'exécuter sur un simulateur Softquantus Cloud. Refusé en production aujourd'hui.

  • softqcos lang invoke IDPas encore ouvert

    Exécuter un programme publié. Refusé en production aujourd'hui.

Une première requête

La même vérification que dans le démarrage rapide, envoyée directement à l'API :

Terminal
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"}'

La réponse contient ok, les diagnostics avec ligne et colonne, et les comptes : declared_qubits, peak_qubits, expanded_ops, depth et gate_counts. Ajoutez "include_ir": true pour obtenir le document qcos-ir/2 que prend compile/program.